Difference between revisions of "DE4A Common Components"

From DE4A
Jump to navigation Jump to search
 
(46 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
DE4A WP5, Common Component Design & Development, designs and develops new common software components, required for the Pilot implementations and aligned with the other technical work packages.
+
This section provides an overview of the common components and specifications required for the evidence exchanges. A high-level conceptual diagram of the envisaged infrastructure, containing the main software components required for the first iteration of the pilots, is presented in the image below.
  
−
Objectives include:
+
[[File:DE4A Conceptual Schema.png|alt=DE4A Conceptual Schema|center|thumb|892x892px]]The following table describes the '''common''' components in the above diagram, leaving out those components that are developed or deployed directly by each DE4A participant, namely the Data Evaluator, the Data Owner and the eIDAS Nodes.
−
 
 
−
# Integration and consolidation of all architectural, semantic and pilot-domain features to distil common components in order to build a fully operational environment for each piloting use case;
 
−
# Specification of product commonalities and technical design of component interfaces fully aligned with the European Interoperability Framework and re-usable beyond the project;
 
−
# Development of high quality and optimized common services and components;
 
−
# Development of innovative open common components and products based on Blockchain;
 
−
# Support to pilot and national deployments with component documentation, as well as making available the common components as new building blocks in a public repository.
 
−
 
 
−
[[File:DE4A Conceptual Schema.png|alt=DE4A Conceptual Schema|center|thumb|892x892px]]  
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+
 
|+
Line 17: Line 9:
 
|[[DE4A Connector]]
 
|[[DE4A Connector]]
 
|Technical proxy that allows the final participants to send requests for evidence or responses to other final participants over an eDelivery communication environment
 
|Technical proxy that allows the final participants to send requests for evidence or responses to other final participants over an eDelivery communication environment
 +
|-
 +
|[[Usage of third party specifications and components|SML]]
 +
|The Service Metadata Locator. Reference instance in the DE4A network
 +
|-
 +
|[[Usage of third party specifications and components|SMP]]
 +
|Service Metadata Publisher
 +
|-
 +
|[[Usage of third party specifications and components|AS4 Gateway]]
 +
|AS4 protocol implementation for the message exchange
 +
|-
 +
|[[Usage of third party specifications and components|Mocked IDK]]
 +
|Testing component for the IAL definition
 
|-
 
|-
 
|[[DE4A SSI Authority Agent|SSI Authority Agent]]
 
|[[DE4A SSI Authority Agent|SSI Authority Agent]]
Line 26: Line 30:
 
== Common specifications ==
 
== Common specifications ==
 
===[[Usage of third party specifications and components|Third party specifications and components]]===
 
===[[Usage of third party specifications and components|Third party specifications and components]]===
−
The DE4A project is based on some specifications and components that allow building new software with some inherited capabilities such as security, reliability, integrity and scalability.
+
It comprises a list of elements and a description of the third-party libraries and components that have made it possible to build the DE4A components more quickly and allow them to be extended, thus increasing the stability and robustness of the system.
−
 
 
−
Some of the main technologies involved are described here.
 
  
 
===[[Description of the software interfaces|Description of common software interfaces]]===
 
===[[Description of the software interfaces|Description of common software interfaces]]===
−
This page contains a description of the different software interfaces created for the DE4A project. The information provided can be used as a reference on the development and integration process to each pilot.
+
REST APIs interfaces reference for most of the components involved in the message exchanging.  
  
 
===[[DE4A Logs and error messages]]===
 
===[[DE4A Logs and error messages]]===
−
In order to standardise the errors and logs handled by each component, some conventions have been taken, as log patterns, error codes definition or messages content.
+
Definition and reference of error coding and logs handling. Includes standardised log and error messages within the DE4A project to provide a good understanding of the different components regarding their points of failure and the different states in which each system is placed.
  
−
The information on this page should be used by each partner who develops a DE4A component, also it should be maintained to have a proper messages reference and be aware which information will include.
+
== Common Components ==
  
−
Apart from the usual reasons of the logging and error handling, in the DE4A project, there are 3 main bullet points on which the definition of messages is based:
+
===[[DE4A Connector]]===
−
 
+
The main component of the DE4A communication infrastructure for processing request and response messages from DP/DCs. The DE4A connector handles the message exchange process and obtains information from different nodes like IDK or SMP for this purpose. It implements the AS4 Gateway functionality, so it can undertake either Requestor or Transferor roles.
−
* '''Kafka tracking''': messages sent to the Kafka server which can be previewed at: <nowiki>https://de4a-dev-pt.egovlab.eu/#!detail</nowiki>
 
−
* '''Metrics logs''': messages marked with a special tag inside the common log file or logged on a separated file, which will be used to analyze and raise some metrics about each system
 
−
* '''Error convention''': standardise the error messages and codes
 
  
−
== Common Components ==
+
==== [[DE4A Installation and configuration guide|DE4A Connector installation and configuration guide]] ====
 +
Step by step guide to successful configure an instance of the DE4A Connector. Find in this section all aspects related to the different configuration scenarios and keypoints of the system.
  
−
===[[DE4A Connector]]===
 
 
=== [[DE4A SSI Authority Agent]]  ===
 
=== [[DE4A SSI Authority Agent]]  ===
 +
The enterprise-level component of the SSI infrastructure for issuing and validating diplomas in the form of Verifiable Credentials.
  
 +
==== [[Installation and configuration guide of the DE4A SSI Authority Agent]] ====
 +
Step-by-step guide for a successful configuration of an Authority Agent instance. Find in this section all aspects related to the different configuration scenarios and REST API endpoint information.
 
=== [[DE4A SSI Edge Agent]] ===
 
=== [[DE4A SSI Edge Agent]] ===
  
Line 54: Line 56:
  
 
=== [[DE4A Playground]] ===
 
=== [[DE4A Playground]] ===
−
The Playground is a set of predefined and pre-deployed components to be used as is. The “DE4A Playground” was designed to help pilot partners to onboard the DE4A network. It is essentially a temporary infrastructure with two purposes:
+
It comprises a set of components and utilities provided for pilots and partners for testing purposes. In addition it can be used to replace some components that might not yet be available or that they need to be tested in a "real" environment.
  
−
* It simulates a real scenario where the User can request data (evidence) about a subject (citizen or company). Thus, it allows testing the performance of the DE4A Connector by using mocked components and fake data.
+
===[[DE4A Playground joining stages for the first iteration]]===
 +
Besides the Playground as testbed, the final components development and deployments had yet to be accomplished. This sections describes the different stages or milestones set from the pilot perspective while they were gradually increasing their own infrastructures/deployments, and so stepping out from the Playground.
 +
[[Category:Wip]]
  
−
* It allows DE4A pilot participants to deploy their own infrastructure in an orderly manner. A three-stage process was set out for the pilot participants to deploy their software components: first their own developed entities (DE/DO), secondly the DE4A Connector, and finally the SMP of the eDelivery infrastructure. At the end of each stage, the pilot partner can test their deployment by making used of the rest of the Playground components.
+
== DE4A Member States Infrastructure ==
−
 
+
Status of the DE4A Member States infrastructure for the first iteration of the pilots.
−
===[[DE4A Playground joining stages for the first iteration]]===
+
=== [[DE4A Member States Infraestructure|DE4A Member States Infrastructure]] ===
−
the initial situation of the Playground for the first iteration of the DE4A project and the joining stages foreseen for the joining process of the pilot partners to the Playground. It also defines the information that each pilot partner needs to provide to WP5 in order to include that information in the appropriate components of the Playground so that the pilot partner can send messages via the Playground components.
 

Latest revision as of 10:12, 7 December 2022

This section provides an overview of the common components and specifications required for the evidence exchanges. A high-level conceptual diagram of the envisaged infrastructure, containing the main software components required for the first iteration of the pilots, is presented in the image below.

DE4A Conceptual Schema

The following table describes the common components in the above diagram, leaving out those components that are developed or deployed directly by each DE4A participant, namely the Data Evaluator, the Data Owner and the eIDAS Nodes.

Component Description
DE4A Connector Technical proxy that allows the final participants to send requests for evidence or responses to other final participants over an eDelivery communication environment
SML The Service Metadata Locator. Reference instance in the DE4A network
SMP Service Metadata Publisher
AS4 Gateway AS4 protocol implementation for the message exchange
Mocked IDK Testing component for the IAL definition
SSI Authority Agent Enterprise-level solution that enables issuing and submitting diplomas in the form of verifiable credentials/presentations to Issuers/Verifiers.
SSI Edge Agent Mobile digital wallet solution that enables users to manage their digital diplomas and interact with the Issuer's/Verifier's portals.

Common specifications

Third party specifications and components

It comprises a list of elements and a description of the third-party libraries and components that have made it possible to build the DE4A components more quickly and allow them to be extended, thus increasing the stability and robustness of the system.

Description of common software interfaces

REST APIs interfaces reference for most of the components involved in the message exchanging.

DE4A Logs and error messages

Definition and reference of error coding and logs handling. Includes standardised log and error messages within the DE4A project to provide a good understanding of the different components regarding their points of failure and the different states in which each system is placed.

Common Components

DE4A Connector

The main component of the DE4A communication infrastructure for processing request and response messages from DP/DCs. The DE4A connector handles the message exchange process and obtains information from different nodes like IDK or SMP for this purpose. It implements the AS4 Gateway functionality, so it can undertake either Requestor or Transferor roles.

DE4A Connector installation and configuration guide

Step by step guide to successful configure an instance of the DE4A Connector. Find in this section all aspects related to the different configuration scenarios and keypoints of the system.

DE4A SSI Authority Agent

The enterprise-level component of the SSI infrastructure for issuing and validating diplomas in the form of Verifiable Credentials.

Installation and configuration guide of the DE4A SSI Authority Agent

Step-by-step guide for a successful configuration of an Authority Agent instance. Find in this section all aspects related to the different configuration scenarios and REST API endpoint information.

DE4A SSI Edge Agent

Testing infrastructure

DE4A Playground

It comprises a set of components and utilities provided for pilots and partners for testing purposes. In addition it can be used to replace some components that might not yet be available or that they need to be tested in a "real" environment.

DE4A Playground joining stages for the first iteration

Besides the Playground as testbed, the final components development and deployments had yet to be accomplished. This sections describes the different stages or milestones set from the pilot perspective while they were gradually increasing their own infrastructures/deployments, and so stepping out from the Playground.

DE4A Member States Infrastructure

Status of the DE4A Member States infrastructure for the first iteration of the pilots.

DE4A Member States Infrastructure

Retrieved from ‘https://wiki.de4a.eu/index.php?title=DE4A_Common_Components&oldid=5655’