-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
18 changed files
with
450 additions
and
209 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,74 +1,123 @@ | ||
| <h1 align="center"> | ||
| EU Digital COVID Certificate Validation Decorator | ||
| </h1> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/eu-digital-green-certificates/dgca-validation-decorator/actions/workflows/ci-main.yml" title="ci-main.yml"> | ||
| <img src="https://github.com/eu-digital-green-certificates/dgca-validation-decorator/actions/workflows/ci-main.yml/badge.svg"> | ||
| </a> | ||
| <a href="/../../commits/" title="Last Commit"> | ||
| <img src="https://img.shields.io/github/last-commit/eu-digital-green-certificates/dgca-validation-decorator?style=flat"> | ||
| </a> | ||
| <a href="/../../issues" title="Open Issues"> | ||
| <img src="https://img.shields.io/github/issues/eu-digital-green-certificates/dgca-validation-decorator?style=flat"> | ||
| </a> | ||
| <a href="./LICENSE" title="License"> | ||
| <img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=flat"> | ||
| </a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="#about">About</a> • | ||
| <a href="#development">Development</a> • | ||
| <a href="#documentation">Documentation</a> • | ||
| <a href="#support-and-feedback">Support</a> • | ||
| <a href="#how-to-contribute">Contribute</a> • | ||
| <a href="#licensing">Licensing</a> | ||
| </p> | ||
|
|
||
| ## About | ||
|
|
||
| This repository contains the source code of the EU Digital COVID Certificate Validation Decorator. | ||
|
|
||
| - [ ] TODO: Describe Component | ||
|
|
||
| ## Development | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - [ ] TODO: Prerequisites | ||
|
|
||
| ### Build | ||
|
|
||
| - [ ] TODO: Build | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [ ] TODO: Documentation | ||
|
|
||
| ## Support and feedback | ||
|
|
||
| The following channels are available for discussions, feedback, and support requests: | ||
|
|
||
| | Type | Channel | | ||
| | ------------------------ | ------------------------------------------------------ | | ||
| | **Issues** | <a href="/../../issues" title="Open Issues"><img src="https://img.shields.io/github/issues/eu-digital-green-certificates/dgca-validation-decorator?style=flat"></a> | | ||
| | **Other requests** | <a href="mailto:[email protected]" title="Email DGC Team"><img src="https://img.shields.io/badge/email-DGC%20team-green?logo=mail.ru&style=flat-square&logoColor=white"></a> | | ||
|
|
||
| ## How to contribute | ||
|
|
||
| Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, | ||
| as well as additional contribution information, see our [Contribution Guidelines](./CONTRIBUTING.md). By participating in this | ||
| project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times. | ||
|
|
||
| ## Licensing | ||
|
|
||
| Copyright (C) 2021 T-Systems International GmbH and all other contributors | ||
|
|
||
| Licensed under the **Apache License, Version 2.0** (the "License"); you may not use this file except in compliance with the License. | ||
|
|
||
| You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0. | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" | ||
| BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the [LICENSE](./LICENSE) for the specific | ||
| language governing permissions and limitations under the License. | ||
| <h1 align="center"> | ||
| EU Digital COVID Certificate Validation Decorator | ||
| </h1> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/eu-digital-green-certificates/dgca-validation-decorator/actions/workflows/ci-main.yml" title="ci-main.yml"> | ||
| <img src="https://github.com/eu-digital-green-certificates/dgca-validation-decorator/actions/workflows/ci-main.yml/badge.svg"> | ||
| </a> | ||
| <a href="/../../commits/" title="Last Commit"> | ||
| <img src="https://img.shields.io/github/last-commit/eu-digital-green-certificates/dgca-validation-decorator?style=flat"> | ||
| </a> | ||
| <a href="/../../issues" title="Open Issues"> | ||
| <img src="https://img.shields.io/github/issues/eu-digital-green-certificates/dgca-validation-decorator?style=flat"> | ||
| </a> | ||
| <a href="./LICENSE" title="License"> | ||
| <img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=flat"> | ||
| </a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="#about">About</a> • | ||
| <a href="#development">Development</a> • | ||
| <a href="#documentation">Documentation</a> • | ||
| <a href="#support-and-feedback">Support</a> • | ||
| <a href="#how-to-contribute">Contribute</a> • | ||
| <a href="#licensing">Licensing</a> | ||
| </p> | ||
|
|
||
| ## About | ||
|
|
||
| This repository contains the source code of the EU Digital COVID Certificate Validation Decorator. | ||
|
|
||
| The Validation Decorator is an interface between the [validation service](https://github.com/eu-digital-green-certificates/dgca-validation-service) and an internal [backend system](https://github.com/eu-digital-green-certificates/dgca-booking-demo-backend) (demo) for the exchange of digital covid certificate information. | ||
|
|
||
| The validation has complex work flow that involves | ||
|
|
||
| - [dgca-validation-service](https://github.com/eu-digital-green-certificates/dgca-validation-service) - additional service on travel system | ||
| - [dgca-booking-demo](https://github.com/eu-digital-green-certificates/dgca-booking-demo) - travel system mock | ||
| - [dgca-booking-demo-frontend](https://github.com/eu-digital-green-certificates/dgca-booking-demo-frontend) | ||
| - [dgca-verifier-app-android](https://github.com/eu-digital-green-certificates/dgca-verifier-app-android) - provide dcc | ||
| - [dgca-booking-demo-backend](https://github.com/eu-digital-green-certificates/dgca-booking-demo-backend) | ||
|
|
||
| ## Development | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - [Open JDK 11](https://openjdk.java.net) | ||
| - [Maven](https://maven.apache.org) | ||
| - [Docker](https://www.docker.com) | ||
| - Authenticate to [Github Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry) | ||
|
|
||
| #### Authenticating in to GitHub Packages | ||
|
|
||
| As some of the required libraries (and/or versions are pinned/available only from GitHub Packages) You need to authenticate | ||
| to [GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry) | ||
| The following steps need to be followed | ||
|
|
||
| - Create [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with scopes: | ||
| - `read:packages` for downloading packages | ||
|
|
||
| ##### GitHub Maven | ||
|
|
||
| - Copy/Augment `~/.m2/settings.xml` with the contents of `settings.xml` present in this repository | ||
| - Replace `${app.packages.username}` with your github username | ||
| - Replace `${app.packages.password}` with the generated PAT | ||
|
|
||
| ##### GitHub Docker Registry | ||
|
|
||
| - Run `docker login docker.pkg.github.com/eu-digital-green-certificates` before running further docker commands. | ||
| - Use your GitHub username as username | ||
| - Use the generated PAT as password | ||
|
|
||
| ### Build | ||
|
|
||
| Whether you cloned or downloaded the 'zipped' sources you will either find the sources in the chosen checkout-directory or get a zip file with the source code, which you can expand to a folder of your choice. | ||
|
|
||
| In either case open a terminal pointing to the directory you put the sources in. The local build process is described afterwards depending on the way you choose. | ||
|
|
||
| ### Build with maven | ||
| * Check [settings.xml](settings.xml) in root folder and copy the servers to your own `~/.m2/settings.xml` to connect the GitHub repositories we use in our code. Provide your GitHub username and access token (see [GitHub Help](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)) under the variables suggested. | ||
| * Run `mvn clean package` from the project root folder | ||
|
|
||
| ### Run with docker | ||
| * Perform maven build as described above | ||
| * Run `docker-compose up` from the project root folder | ||
|
|
||
| After all containers have started you will be able to reach the application on your [local machine](http://localhost:8080/dgci/status) under port 8080. | ||
| ## Documentation | ||
|
|
||
| The Validation Decorator is a template. To make your own adjustments, the three interfaces `KeyProvider`, `BackendRepository` and `AccessTokenPayloadBuilder` should be implemented. | ||
|
|
||
| `KeyProvider` provides the necessary keys and certificates. Separate keys for JWT, certificates for Validation Service and others are provided. | ||
|
|
||
| `BackendRepository` provides the interface to the internal service. In this example [dgca-booking-demo-backend](https://github.com/eu-digital-green-certificates/dgca-booking-demo-backend) is connected and should demonstrate an airline. | ||
|
|
||
| `AccessTokenPayloadBuilder` basically serves as a converter to create the `AccessTokenPayload` from the given data. | ||
|
|
||
| ## Support and feedback | ||
|
|
||
| The following channels are available for discussions, feedback, and support requests: | ||
|
|
||
| | Type | Channel | | ||
| | ------------------------ | ------------------------------------------------------ | | ||
| | **Issues** | <a href="/../../issues" title="Open Issues"><img src="https://img.shields.io/github/issues/eu-digital-green-certificates/dgca-validation-decorator?style=flat"></a> | | ||
| | **Other requests** | <a href="mailto:[email protected]" title="Email DGC Team"><img src="https://img.shields.io/badge/email-DGC%20team-green?logo=mail.ru&style=flat-square&logoColor=white"></a> | | ||
|
|
||
| ## How to contribute | ||
|
|
||
| Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, | ||
| as well as additional contribution information, see our [Contribution Guidelines](./CONTRIBUTING.md). By participating in this | ||
| project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times. | ||
|
|
||
| ## Licensing | ||
|
|
||
| Copyright (C) 2021 T-Systems International GmbH and all other contributors | ||
|
|
||
| Licensed under the **Apache License, Version 2.0** (the "License"); you may not use this file except in compliance with the License. | ||
|
|
||
| You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0. | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" | ||
| BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the [LICENSE](./LICENSE) for the specific | ||
| language governing permissions and limitations under the License. |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -59,5 +59,5 @@ public static final class ResultRequest { | |
| private String type; | ||
|
|
||
| private String details; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.