Skip to content

Latest commit

 

History

History
168 lines (125 loc) · 15 KB

README.md

File metadata and controls

168 lines (125 loc) · 15 KB

Contributors Stargazers Apache 2.0 License CC-BY-4.0 Latest Release

Digital Product Pass App Logo

Digital Product Pass Application

Description

The digital product passport application provides a consumer user interface to request a battery passport from a battery manufacturer using the standardized components and technologies in a Catena-X network. The passport will be displayed in a human-readable from any browser. The data exchange standards given by Catena-X are used to provide the battery passport to different personas (roles) in the network.

In particular, the application is used to access the battery passport data provided by battery manufacturer. By scanning QR-code or knowing the manufacturer and battery-ID, a user can request the passport through Eclipse Dataspace Connectors (EDCs) over the Catena-X network. The passport provider will provide data attributes that is only visible to a permitted signed-in user.

Software Version

Helm Chart Version

4.0.1

Application Version

v4.0.1

Application Preview

Here is a preview from the DPP App UI, where we visualize a test Digital Product Pass in this case.

General Info View

Note: For more information check the documentation section

Getting Started

To get started you can have a look into our documentation:

Name Description
Arc42 Main Architecture Document (Arc42) of Digital Product Pass Application
Interoperability Interoperability document of Digital Product Pass Application
Data Sovereignty Data Sovereignty document of Digital Product Pass Application
Administration Guide Administration Guide explaining the infrastructure and how to configure the application
Data Retrieval Guide Guide on how to retrieve data from the Catena-X Network as the Digital Product Pass
Backend Documentation Backend documentation Product Passport App
Docker Overview Overview on general docker commands
Keycloak Overview This guide describes how to setup a keycloak instance in local docker forcontainer and import existing realm.json file.
Short Introduction into the project Digital Product Pass App infrastructure, helm installation guide, technical usage guide
Code Scaning with Kics and Trivy Infrastructure As Code (IaC) with KICS intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github
Release Guidelines Digital Product Pass App Release Guide
Secret Management Secrets management to store client credentials, database passwords, access tokens
End User Manual End User Manual Product Viewer App
Postman Overview Technical guide depicts the battery pass end-to-end API calls through the postman REST client
Changelog Changelog
Helm Charts Project's Helm Charts

Digital Product Pass Verification Add-on

The Digital Product Pass Verification Add-on aims to create a second layer of trust over the EDC data exchanges between consumers and data providers. It enables auditors to verify specific attributes or complete aspect models for data providers and allowing consumers to retrieve and verify the "validity" of the verification done. Using a wallet, a Data Provider is able to certify its attributes or the complete semantic models from Catena-X and include it in a Verifiable Credential, which can then be verified on the Data Consumer side.

This concept is the First Aspect Model Verification/Certification Concept in Catena-X! Therefore, it aims to provide a "lighthouse" for any other aspect model verification/certification that MUST be done in Catena-X using SAMM Aspect Models.

It provides a generic concept for Attribute Verification/Certification by external/internal auditors, and also provides a Self-Testification option for Data Providers to certify their data while still maintaining data sovereighty at all costs. By using the EDC connector for the data exchanges this concept uses the current Catena-X Architecture.

Furthermore, it gives guidance and ready to use components for verifying the data received from their Data Providers. The Digital Product Pass Add-on offers the consumers components like the simple-wallet, an MVP decentral wallet able to issue and verify aspect model Verifiable Credential Documents. It also provides a proof of concept (PoC) in the dpp-backend and dpp-frontend components for complete data payloads to be verified.

Verification Add-on

Name Description
DPP Verification Docs The main documentation of the Digital Product Pass Verification Add-on contains the complete architecture blueprint and details about implementation in the application.
DPP Simple Wallet Docs This documentation contains the description of the simple wallet functionality, API specification and how to configure it.

Base Images

Language Container Base Image
Java / JVM based Eclipse Temurin
JS frontends Node.JS
Nginx

Installation

For installing the Digital Product Pass Application please consult our Intallation Guide.

Licenses

Notice for Docker Images

DockerHub:

Eclipse Tractus-X product(s) installed within the image:

Used base image

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.