/DataspaceConnector

This is an IDS Connector reference implementation.

Primary LanguageJavaApache License 2.0Apache-2.0


Logo
Dataspace Connector

ContactContributeDocsIssuesLicense

The Dataspace Connector is an implementation of an IDS connector component following the IDS Reference Architecture Model. It integrates the IDS Information Model and uses the IDS Messaging Services for IDS functionalities and message handling. The core component in this repository provides a REST API for loading, updating, and deleting resources with local or remote data enriched by its metadata. It supports IDS conform message handling with other IDS connectors and components and implements usage control for selected IDS usage policy patterns.



Quick Start

The offical Docker images of the Dataspace Connector can be found here.

For an easy deployment, make sure that you have Docker installed. Then, execute the following command:

docker run -p 8080:8080 --name connector ghcr.io/international-data-spaces-association/dataspace-connector:latest

If everything worked fine, the connector is available at https://localhost:8080/. The API can be accessed at https://localhost:8080/api. The Swagger UI can be found at https://localhost:8080/api/docs. Next, please take a look at our communication guide.

Note: For a more detailed or advanced Docker or Kubernetes deployment, as well as a full setup with the Connector and its GUI, see here. If you want to build and run locally, follow these steps.

Security and Verification

The Docker images are signed using cosign. The public key of the Dataspace Connector can be found at the root of the project structure (here).

For verifying that you have received an offical image from a trusted source, run:

cosign verify --key dsc.pub ghcr.io/international-data-spaces-association/dataspace-connector:latest

Software Bill of Material (SBoM)

The Software Bill of Material (SBoM) for every Docker image is supplied as SPDX-JSON and can be found by appending -sbom to the image tag. For example, the SBoM for ghcr.io/international-data-spaces-association/dataspace-connector:latest is ghcr.io/international-data-spaces-association/dataspace-connector:latest-sbom.

The SBoM can be pulled via tools like oras.

oras pull ghcr.io/international-data-spaces-association/dataspace-connector:latest-sbom -a

Note: Also the SBoM images can be validated using cosign as shown above.

Contributing

You are very welcome to contribute to this project when you find a bug, want to suggest an improvement, or have an idea for a useful feature. Please find a set of guidelines at the CONTRIBUTING.md and the CODE_OF_CONDUCT.md.

Developers

This is an ongoing project of the Data Business department of the Fraunhofer ISST.

The core development is driven by

with significant contributions, comments, and support by (in alphabetical order):

License

Copyright © 2020 Fraunhofer ISST. This project is licensed under the Apache License 2.0 - see the LICENSE for details.