forked from eclipse-edc/Connector
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract fork's implementation details in fork's doc
- Loading branch information
1 parent
0420492
commit 1b8e278
Showing
2 changed files
with
90 additions
and
72 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
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,82 @@ | ||
| # Fork | ||
|
|
||
| ## Changes implemented in `0.2.1`'s fork | ||
|
|
||
| ### Fix security flaw in logging | ||
|
|
||
| Imported a security patch from `0.5` into `0.2.1` https://github.com/eclipse-edc/Connector/pull/3719/files | ||
|
|
||
| #### Compatibility | ||
|
|
||
| This only changes the log's output, removing potentially sensitive data. | ||
|
|
||
| #### Resolution plan | ||
|
|
||
| Update to Eclipse EDC `0.5+`. | ||
|
|
||
|
|
||
| ### Ass assets parametrization for provider push scenario | ||
|
|
||
| Adds a workaround to preserve the assets' parameterization feature from pre-0.1 releases in a *provider push* scenario. | ||
|
|
||
| Eclipse EDC before version `0.1` used a different communication protocol that was capable of sending the parameterization data to the provider in a *provider push* scenario. | ||
|
|
||
| This is not possible anymore due to the current IDS specification for [transfer messages](https://docs.internationaldataspaces.org/ids-knowledgebase/v/dataspace-protocol/transfer-process/transfer.process.protocol#21-transfer-request-message). | ||
|
|
||
| This feature is needed by one of our clients. | ||
|
|
||
| #### Implementation | ||
|
|
||
| The only field (as of IDS version `2024-01`) that lets us send data in the concerned message is the `DataAddress`'s properties. This is the field, in combination with specific properties, that we use in this workaround to transfer the missing information to the provider. | ||
| This extra information is extracted on the provider's side and put back where it used to be, in the `properties` of the `DataFlowRequest`. | ||
|
|
||
| The workaround happens at this location: | ||
|
|
||
| `org.eclipse.edc.connector.transfer.dataplane.flow.ProviderPushTransferDataFlowController.createRequest` | ||
|
|
||
| With this workaround, a parameterized asset can be requested with the following query: | ||
|
|
||
| ```json | ||
| { | ||
| "@type": "https://w3id.org/edc/v0.0.1/ns/TransferRequest", | ||
| "https://w3id.org/edc/v0.0.1/ns/assetId": "{{ASSET_ID}}", | ||
| "https://w3id.org/edc/v0.0.1/ns/contractId": "{{CONTRACT_ID}}", | ||
| "https://w3id.org/edc/v0.0.1/ns/connectorAddress": "https://{{PROVIDER_EDC_FQDN}}/api/dsp", | ||
| "https://w3id.org/edc/v0.0.1/ns/connectorId": "{{PROVIDER_EDC_PARTICIPANT_ID}}", | ||
| "https://w3id.org/edc/v0.0.1/ns/dataDestination": { | ||
| "https://w3id.org/edc/v0.0.1/ns/type": "HttpData", | ||
| "https://w3id.org/edc/v0.0.1/ns/baseUrl": "{{DATA_SINK_URL}}", | ||
| "https://sovity.de/workaround/proxy/param/pathSegments": "{{PARAMETERIZATION_PATH}}", | ||
| "https://sovity.de/workaround/proxy/param/method": "{{PARAMETERIZATION_METHOD}}", | ||
| "https://sovity.de/workaround/proxy/param/queryParams": "{{PARAMETERIZATION_QUERY}}", | ||
| "https://sovity.de/workaround/proxy/param/mediaType": "{{PARAMETERIZATION_CONTENTTYPE}}", | ||
| "https://sovity.de/workaround/proxy/param/body": "{{PARAMETERIZATION_BODY}}" | ||
| }, | ||
| "https://w3id.org/edc/v0.0.1/ns/privateProperties": {}, | ||
| "https://w3id.org/edc/v0.0.1/ns/protocol": "dataspace-protocol-http", | ||
| "https://w3id.org/edc/v0.0.1/ns/managedResources": false | ||
| } | ||
| ``` | ||
|
|
||
| Where the `https://sovity.de/workaround/proxy/param/*` carry the parameterization data. | ||
|
|
||
| #### Resolution plan | ||
|
|
||
| There is a ticket open on the [IDS side](https://github.com/International-Data-Spaces-Association/ids-specification/discussions/262) | ||
|
|
||
| The goal is to | ||
| * have this feature standardized | ||
| * have it implemented in core EDC | ||
| * use the new core EDC version | ||
|
|
||
| #### Compatibility | ||
|
|
||
| This change is targeting the *provider push* use-case only. The *consumer pull* use-case is not affected. | ||
|
|
||
| The parameterization feature must work between 2 EDCs that use this forked version. | ||
|
|
||
| The parameterization must work from an unpatched Consumer EDC, targeting a patched EDC provider, using the request mentioned in the Implementation section. | ||
|
|
||
| The parametrization will not work if the provider EDC is not using this patched version. | ||
|
|
||
| Expecting no other incompatibilities with core EDC 0.2.1. |