DE4A SSI Authority and Edge Agent - Revision history

Martina.sestak at 07:41, 8 January 2022

2022-01-08T07:41:17Z

Martina.sestak at 07:40, 8 January 2022

2022-01-08T07:40:32Z

Martina.sestak at 07:40, 8 January 2022

2022-01-08T07:40:01Z

Martina.sestak: Added information about Authority Agent configuration and running.

2022-01-08T07:39:20Z

Added information about Authority Agent configuration and running.

Martina.sestak: Added logging information. Added installation description for the Authority Agent.

2022-01-07T10:16:56Z

Added logging information. Added installation description for the Authority Agent.

Show changes

Martina.sestak at 13:56, 6 January 2022

2022-01-06T13:56:13Z

Martina.sestak: Modified Error handling section for AA.

2022-01-06T13:37:47Z

Modified Error handling section for AA.

Javier.presa: /* Installation */

2021-12-14T16:11:56Z

Installation

Javier.presa: /* Edge Agent */

2021-12-14T16:08:51Z

Edge Agent

Javier.presa: /* Requirements */

2021-12-14T15:35:33Z

Requirements

@@ Line 142: / Line 142: @@
 bearer.token=<INSERT session token>
 </pre>From now on, we will explain the main and most critical configuration.
 ===== System configuration =====
 The basic system configuration necessary for successful communication between Authority Agent components is listed in the <code>.env</code> file. Among others, there is a definition of necessary Docker images and the URL of the EBSI DID resolver. As an additional configuration, it is necessary to specify the public domain of the server where the Authority Agent is going to be deployed as well as database configuration properties by editing the following properties:
@@ Line 161: / Line 152: @@
 COUCHDB_USER=<INSERT_COUCHDB_USER_HERE>
 COUCHDB_PASSWORD=<INSERT_COUCHDB_PASSWORD_HERE></pre>
 ===== Authority Agent REST API application.properties =====

@@ Line 151: / Line 151: @@
 </pre>
-====== '''System configuration''' ======
+===== System configuration =====
 The basic system configuration necessary for successful communication between Authority Agent components is listed in the <code>.env</code> file. Among others, there is a definition of necessary Docker images and the URL of the EBSI DID resolver. As an additional configuration, it is necessary to specify the public domain of the server where the Authority Agent is going to be deployed as well as database configuration properties by editing the following properties:
@@ Line 162: / Line 162: @@
 COUCHDB_PASSWORD=<INSERT_COUCHDB_PASSWORD_HERE></pre>
-====== '''Authority Agent REST API application.properties''' ======
+===== Authority Agent REST API application.properties =====
 Besides the general system and database configurations, you must also specify the following properties to successfully run the REST API:
 *<code>alias</code> of your Authority Agent, which will be displayed to the user when sending invitations for connecting agents (e.g. MIZŠ Slovenia).

@@ Line 151: / Line 151: @@
 </pre>
-*'''System configuration'''
+====== '''System configuration''' ======
 The basic system configuration necessary for successful communication between Authority Agent components is listed in the <code>.env</code> file. Among others, there is a definition of necessary Docker images and the URL of the EBSI DID resolver. As an additional configuration, it is necessary to specify the public domain of the server where the Authority Agent is going to be deployed as well as database configuration properties by editing the following properties:
@@ Line 162: / Line 162: @@
 COUCHDB_PASSWORD=<INSERT_COUCHDB_PASSWORD_HERE></pre>
-*'''Authority Agent REST API application.properties'''
+====== '''Authority Agent REST API application.properties''' ======
 Besides the general system and database configurations, you must also specify the following properties to successfully run the REST API:
 *<code>alias</code> of your Authority Agent, which will be displayed to the user when sending invitations for connecting agents (e.g. MIZŠ Slovenia).

@@ Line 143: / Line 143: @@
 </pre>From now on, we will explain the main and most critical configuration.
 =====Database properties=====
-Regarding database configuration and structure, the component creates an in-memory database through an H2 DB Engine, which will be created and deleted on each execution.
+Regarding database configuration and structure, the component creates a CouchDB database, which name is specified in the <code>app.properties</code> configuration file:
 <pre>
-spring.datasource.url=jdbc:h2:mem:testdb
+db.ip.address=http://couchdb.de4a.eu:5984/
-spring.datasource.driverClassName=org.h2.Driver
+db.username=<INSERT DB administrator username>
-spring.datasource.username=sa
+db.password=<INSERT DB administrator password>
-spring.datasource.password=password
+db.name=<INSERT DB name>
-spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
+</pre>
-<code>h2.console.port=21080</code>
+*'''System configuration'''
-By default, even if you do not define the property (non-empty), port will be 21080, so you will be able to access through the following direction pattern:
+<pre>DOMAIN=<INSERT_PUBLIC_DOMAIN_HERE>
-<code>http://<host-endpoint>:<portH2Console></code>
+*'''Authority Agent REST API application.properties'''
-=====SSL Context (not for AS4) application.properties=====
 ====Starting up the SSI Authority Agent====
-Once you have all configuration parameters well configured (if not, check the logs to find out the problem), it is time to deploy the component into an applications server. Once you have deployed the <code>war</code> file or the docker image, there are several checks to ensure that the deployment was successful:
+Once you have all configuration parameters well configured, you can start the Docker containers by running the <code>docker-compose.yml</code> file.
-*Open Swagger UI browsing: <code><nowiki>http://host:port/swagger-ui/</nowiki></code>
-     E.g.:
+The CouchDB database GUI will be available at <code>http://<IP ADDRESS:5984>/_utils</code>.
-*DE4A Connector index page will be at root path: <code><nowiki>http://host:port/</nowiki></code>
-     E.g.:
+Once started, you can test if the Authority Agent is working properly by checking the current DID connection status for a random user ID (note: replace IP ADDRESS:PORT with your Authority Agent server address). The following request is made:
-*The Connector will be able to process requests through the following interfaces:
+ curl -X 'GET' \
+   'http://<IP ADDRESS:PORT>/v1/did-conn-status/alice' \
-*Accessing to CouchDB database: <code><nowiki>http://host:h2.console.port/</nowiki></code>
+   -H 'accept: application/json'
-=== Edge Agent ===
+===Edge Agent===
 ====Installation====
@@ Line 192: / Line 205: @@
 To install the Edge Agent, it is necessary to install the DE4A Mobile App in a mobile device.
-===== Requirements =====
+=====Requirements=====
 To install the DE4A Mobile app in a mobile device, these are the requirements needed:
-* Android Operating System installed (version android 9.0 or superior)
+*Android Operating System installed (version android 9.0 or superior)
-* Recommended 2Gb RAM and 1Ghz processor
+*Recommended 2Gb RAM and 1Ghz processor
-* Fingerprint reader
+*Fingerprint reader
-===== Steps =====
+=====Steps=====
 *'''Download''' The apk is available here: https://github.com/de4a-wp5/de4a-mobile-app
 *'''Set-up''' Once the app is downloaded, tap on the apk file to open it. The Android device will prompt for allowing apps from an unknown sources to be installed.<gallery>
@@ Line 205: / Line 218: @@
 </gallery>The user has to tap on “Settings” button and the settings menu will appear with the following option for allowing the apps installation from this source, and to turn off this setting after the installation: [[File:Edge agent install 2.png|thumb|185x185px|Install apps from unknown sources setting|alt=|none]]
-==== User guide ====
+====User guide====
 The user manual can be found here: https://github.com/de4a-wp5/de4a-mobile-app/blob/master/DE4A%20Mobile%20App%20Manual%20v0.2.pdf

@@ Line 37: / Line 37: @@
 ===Error handling===
-The Authority Agent includes methods monitoring the communication between the REST API and the Aries agent and internal database, and it records produced log messages into an internal log file for easier metric monitoring (the ''de4a-metrics-log.txt'' file is automatically created in the ''/usr/local/tomcat/logs'' in the AA API Docker container). The Authority Agent records both success and failure messages to the log file along with the information about the component that generated the message, the internal code and description of the message.
+The Authority Agent includes methods monitoring the communication between the REST API and the Aries agent and internal database, and it records produced log messages into an internal log file for easier metric monitoring (the ''de4a-metrics-log.txt'' file is automatically created in the ''/usr/local/tomcat/logs'' in the AA API Docker container). During each API request, the Authority Agent records error messages to the log file along with the information about the component that generated the message, the internal code and description of the message.
 ===Logging messages===
 ====TODO: Message types====
-The Connector implements a Kafka message producer through the de4a-kafka-client library of the de4a-commons package. This producer provides several types of messages or severity levels:
+The Authority Agent implements a custom DE4A Logger, which is responsible for producing a pre-defined format of the log message. The Logger provides the following types of messages:
 *'''Info'''
 *'''Error'''
-*'''Fatal error'''
+Those basic message categories are used to record success or failure of individual operations executed within each API method call.
 ====List of messages====
-The messages currently sent from the Connector to the Kafka server are as follows:
+The messages currently logged by the Authority Agent are as follows:
 '''Services''' – ''(Info level)''

← Older revision		Revision as of 16:11, 14 December 2021
Line 309:		Line 309:
	File:Mobile insta 1.png\|Allow apps from unknown source		File:Mobile insta 1.png\|Allow apps from unknown source
	</gallery>The user has to tap on “Settings” button and the settings menu will appear with the following option for allowing the apps installation from this source, and to turn off this setting after the installation: [[File:Edge agent install 2.png\|thumb\|185x185px\|Install apps from unknown sources setting\|alt=\|none]]		</gallery>The user has to tap on “Settings” button and the settings menu will appear with the following option for allowing the apps installation from this source, and to turn off this setting after the installation: [[File:Edge agent install 2.png\|thumb\|185x185px\|Install apps from unknown sources setting\|alt=\|none]]
		+
		+	==== User guide ====
		+	The user manual can be found here: https://github.com/de4a-wp5/de4a-mobile-app/blob/master/DE4A%20Mobile%20App%20Manual%20v0.2.pdf

@@ Line 106: / Line 106: @@
 *'''In-house solutions'''
 The Connector project includes some utilities that allow the data processing and internal tools to perform all the Connector tasks. Those utilities are within the Connector project as a module called ''de4a-commons.''
 ==Installation and configuration==
@@ Line 303: / Line 309: @@
 File:Mobile insta 1.png|Allow apps from unknown source
 </gallery>The user has to tap on “Settings” button and the settings menu will appear with the following option for allowing the apps installation from this source, and to turn off this setting after the installation: [[File:Edge agent install 2.png|thumb|185x185px|Install apps from unknown sources setting|alt=|none]]