-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #360 from bci-oss/feature/352-edc-extension_2
EDC extension
- Loading branch information
Showing
8 changed files
with
601 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
163 changes: 163 additions & 0 deletions
163
...actusx/semantics/edc/dataplane/http/accesscontrol/client/DtrAccessVerificationClient.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH and others | ||
| * Copyright (c) 2024 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0. | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations | ||
| * under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| ******************************************************************************/ | ||
|
|
||
| package org.eclipse.tractusx.semantics.edc.dataplane.http.accesscontrol.client; | ||
|
|
||
| import java.io.IOException; | ||
| import java.time.Duration; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.eclipse.edc.spi.http.EdcHttpClient; | ||
| import org.eclipse.edc.spi.monitor.Monitor; | ||
| import org.eclipse.edc.spi.types.TypeManager; | ||
| import org.eclipse.tractusx.semantics.edc.dataplane.http.accesscontrol.AccessControlServiceException; | ||
| import org.eclipse.tractusx.semantics.edc.dataplane.http.accesscontrol.HttpAccessControlCheckClientConfig; | ||
| import org.eclipse.tractusx.semantics.edc.dataplane.http.accesscontrol.HttpAccessControlCheckDtrClientConfig; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| import com.github.benmanes.caffeine.cache.Cache; | ||
| import com.github.benmanes.caffeine.cache.Caffeine; | ||
| import com.github.benmanes.caffeine.cache.LoadingCache; | ||
|
|
||
| import okhttp3.MediaType; | ||
| import okhttp3.Request; | ||
| import okhttp3.RequestBody; | ||
| import okhttp3.Response; | ||
|
|
||
| public class DtrAccessVerificationClient implements HttpAccessVerificationClient { | ||
| public static final String HEADER_EDC_BPN = "Edc-Bpn"; | ||
| public static final String AUTHORIZATION = "Authorization"; | ||
| public static final String ACCEPT = "Accept"; | ||
| public static final String CONTENT_TYPE = "Content-Type"; | ||
| private static final String APPLICATION_JSON = "application/json"; | ||
| private final Monitor monitor; | ||
| private final EdcHttpClient httpClient; | ||
| private final TypeManager typeManager; | ||
| private final HttpAccessControlCheckClientConfig config; | ||
| private final HttpAccessControlCheckDtrClientConfig dtrConfig; | ||
| private final LoadingCache<String, String> tokenCache; | ||
| private final Cache<RequestKey, Boolean> accessControlDecisionCache; | ||
|
|
||
| public DtrAccessVerificationClient( | ||
| final Monitor monitor, | ||
| final EdcHttpClient httpClient, | ||
| final Oauth2TokenClient tokenClient, | ||
| final TypeManager typeManager, | ||
| final HttpAccessControlCheckClientConfig config, | ||
| final HttpAccessControlCheckDtrClientConfig dtrConfig ) { | ||
| this.monitor = monitor; | ||
| this.httpClient = httpClient; | ||
| this.typeManager = typeManager; | ||
| this.config = config; | ||
| this.dtrConfig = dtrConfig; | ||
| this.tokenCache = Caffeine.newBuilder() | ||
| .maximumSize( config.getDtrClientConfigMap().size() ) | ||
| .expireAfterWrite( Duration.ofMinutes( 5 ) ) | ||
| .refreshAfterWrite( Duration.ofMinutes( 4 ) ) | ||
| .build( tokenClient::getBearerToken ); | ||
| final long cacheDurationMinutes = dtrConfig.getDecisionCacheDurationMinutes(); | ||
| if ( cacheDurationMinutes <= 0 ) { | ||
| this.accessControlDecisionCache = null; | ||
| } else { | ||
| this.accessControlDecisionCache = Caffeine.newBuilder() | ||
| .maximumSize( 10000 ) | ||
| .expireAfterWrite( Duration.ofMinutes( cacheDurationMinutes ) ) | ||
| .build(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isAspectModelCall( final String url ) { | ||
| return urlMatchesPattern( url, dtrConfig.getAspectModelUrlPattern() ); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean shouldAllowAccess( | ||
| final String requestedUriPath, | ||
| @Nullable final String requestedQueryString, | ||
| final Map<String, String> additionalHeaders ) throws AccessControlServiceException { | ||
| final String requestedUrl = getTargetUrl( requestedUriPath, requestedQueryString ); | ||
| final String bpn = Optional.ofNullable( additionalHeaders.get( HEADER_EDC_BPN ) ) | ||
| .orElseThrow( () -> new AccessControlServiceException( "Null BPN found." ) ); | ||
| final RequestKey key = new RequestKey( bpn, requestedUrl ); | ||
| if ( accessControlDecisionCache == null ) { | ||
| return this.callDtr( key ); | ||
| } else { | ||
| return accessControlDecisionCache.get( | ||
| key, this::callDtr ); | ||
| } | ||
| } | ||
|
|
||
| private boolean callDtr( final RequestKey requestKey ) { | ||
| final Request dtrRequest = getDtrRequest( requestKey ); | ||
| try ( Response response = httpClient.execute( dtrRequest ) ) { | ||
| return response.isSuccessful(); | ||
| } catch ( final IOException exception ) { | ||
| monitor.severe( "Failed to execute DTR access verification request.", exception ); | ||
| throw new AccessControlServiceException( exception ); | ||
| } | ||
| } | ||
|
|
||
| private boolean urlMatchesPattern( final String url, final String urlPattern ) { | ||
| final Pattern pattern = Pattern.compile( urlPattern, Pattern.CASE_INSENSITIVE ); | ||
| final Matcher matcher = pattern.matcher( url ); | ||
| return matcher.find(); | ||
| } | ||
|
|
||
| @NotNull | ||
| private String getTargetUrl( | ||
| final String requestedUriPath, | ||
| final String requestedQueryString ) { | ||
| final var edcBaseUrl = config.getEdcDataPlaneBaseUrl(); | ||
| final var query = Optional.ofNullable( requestedQueryString ) | ||
| .filter( s -> !s.isBlank() ) | ||
| .map( s -> "?" + s ) | ||
| .orElse( "" ); | ||
| return edcBaseUrl + requestedUriPath + query; | ||
| } | ||
|
|
||
| @NotNull | ||
| private Request getDtrRequest( final RequestKey requestKey ) { | ||
| final String token = tokenCache.get( dtrConfig.getOauth2TokenScope() ); | ||
| if ( token == null ) { | ||
| throw new AccessControlServiceException( "Token is null." ); | ||
| } | ||
| final RequestBody body = RequestBody.create( | ||
| createRequest( requestKey ), | ||
| MediaType.get( APPLICATION_JSON ) ); | ||
| return new Request.Builder() | ||
| .url( dtrConfig.getDtrAccessVerificationUrl() ) | ||
| .addHeader( HEADER_EDC_BPN, requestKey.bpn() ) | ||
| .addHeader( AUTHORIZATION, "Bearer " + token ) | ||
| .addHeader( ACCEPT, APPLICATION_JSON ) | ||
| .addHeader( CONTENT_TYPE, APPLICATION_JSON ) | ||
| .post( body ) | ||
| .build(); | ||
| } | ||
|
|
||
| @NotNull | ||
| private String createRequest( RequestKey requestKey ) { | ||
| return typeManager.writeValueAsString( new DtrAccessVerificationRequest( requestKey.requestedUrl() ) ); | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
...ctusx/semantics/edc/dataplane/http/accesscontrol/client/DtrAccessVerificationRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH and others | ||
| * Copyright (c) 2024 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0. | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations | ||
| * under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| ******************************************************************************/ | ||
|
|
||
| package org.eclipse.tractusx.semantics.edc.dataplane.http.accesscontrol.client; | ||
|
|
||
| public record DtrAccessVerificationRequest(String submodelEndpointUrl) { | ||
| } |
34 changes: 34 additions & 0 deletions
34
...ctusx/semantics/edc/dataplane/http/accesscontrol/client/HttpAccessVerificationClient.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH and others | ||
| * Copyright (c) 2024 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0. | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations | ||
| * under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| ******************************************************************************/ | ||
|
|
||
| package org.eclipse.tractusx.semantics.edc.dataplane.http.accesscontrol.client; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import org.eclipse.tractusx.semantics.edc.dataplane.http.accesscontrol.AccessControlServiceException; | ||
|
|
||
| public interface HttpAccessVerificationClient { | ||
|
|
||
| boolean isAspectModelCall( String url ); | ||
|
|
||
| boolean shouldAllowAccess( | ||
| final String requestedUriPath, final String requestedQueryString, Map<String, String> additionalHeaders ) throws AccessControlServiceException; | ||
|
|
||
| } |
24 changes: 24 additions & 0 deletions
24
...va/org/eclipse/tractusx/semantics/edc/dataplane/http/accesscontrol/client/RequestKey.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH and others | ||
| * Copyright (c) 2024 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0. | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations | ||
| * under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| ******************************************************************************/ | ||
|
|
||
| package org.eclipse.tractusx.semantics.edc.dataplane.http.accesscontrol.client; | ||
|
|
||
| public record RequestKey(String bpn, String requestedUrl) { | ||
| } |
Oops, something went wrong.