Skip to content

Commit

Permalink
updated README.md (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
slaurenz authored May 11, 2021
1 parent ef30ab8 commit 0c5b513
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 7 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,10 @@ After all containers have started, you will be able to reach the service on your

## Documentation

See [./docs/dgca-verifier-service.md](./docs/dgca-verifier-service.md)

### Api Description
[OpenAPI Spec](https://eu-digital-green-certificates.github.io/dgca-verifier-service/)

[Service description](./docs/dgca-verifier-service.md)


## Support and feedback

Expand Down
7 changes: 7 additions & 0 deletions certs/PlaceYourGatewayAccessKeysHere.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### Note:

If you want to run the verifier service via the given docker-compose file, place your keys to access the
[DGCG](https://https://github.com/eu-digital-green-certificates/dgc-gateway) in this folder and adjust the file names
in the [docker-compose.yml](../docker-compose.yml) file.

Further information can be found in the [README](../README.md)
22 changes: 18 additions & 4 deletions docs/dgca-verifier-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,22 @@ The member state synchronises the validation certificates over the [DGCGateway](

### Purpose and functionality of the DGCA-Verifier-Service
The verifier service basically caches the public keys that are distributed through the [DGCG](https://https://github.com/eu-digital-green-certificates/dgc-gateway) to the member states backends.
The service provides the Trust List of certificates for the verifier apps. The apps can get the list to update their key store via an api.
The service provides the Trust List of certificates for the verifier apps. The apps can get the list to update their key store via an api.
To have an actual trust list the verifier service periodically polls the [DGCG](https://https://github.com/eu-digital-green-certificates/dgc-gateway)
for the actual trust list. It therefore uses the functionality provided by the [DGC-lib](https://github.com/eu-digital-green-certificates/dgc-lib).
It stores the received keys in a postgres db and removes revoked keys from it. The keys can than be requested by the verifier apps using the api described in the next section.
for the actual trust list.

In the git repository you will find two implementations of that download functionality:

- The first one ([SignerCertificateDownloadServiceImpl](../src/main/java/eu/europa/ec/dgc/verifier/service/SignerCertificateDownloadServiceImpl.java)) implements the common access two the Digital Green Certificate Gateway via the [DGC-lib](https://github.com/eu-digital-green-certificates/dgc-lib).
The DGC-lib provides a download connector, which handles the download and check of the certificates from the Digital Green Certificate Gateway.


- The second one ([SignerCertificateDownloadBtpServiceImpl](../src/main/java/eu/europa/ec/dgc/verifier/service/SignerCertificateDownloadBtpServiceImpl.java)) is a demo implementation to connect to the Digital Green Certificate Gateway on SAP's Business Technology Plattform.
This implementation serves as a reference where you already have an endpoint to the gateway provided by your runtime environment and using the connector from the dgc-lib on top would be superfluous. In this case the endpoint is fully configured via the destination API
available on BTP and the checks of the downloaded certificates must be done by the service.


In both cases the downloaded keys were stored in a postgres db and revoked keys were removed from it. The keys can than be requested by the verifier apps using the api described in the next section.



Expand All @@ -30,7 +42,9 @@ The api is described with [OpenApi v3](https://swagger.io). You can access the A
Which results in the following URL on your local machine:
http://localhost:8080/swagger

Or by downloading the OpenApi file in json format from the latest release:
From the latest release you can see the OpenApi doc online here: [OpenAPI Spec](https://eu-digital-green-certificates.github.io/dgca-verifier-service/)

It is also possible to download the OpenApi file in json format from the latest release:
* [openapi.json](https://github.com/eu-digital-green-certificates/dgca-verifier-service/releases/latest/download/openapi.json)

You can than put the file in the openapi viewer of your choice. ([editor.swagger.io](https://editor.swagger.io) for example)
Expand Down

0 comments on commit 0c5b513

Please sign in to comment.