❗ Important! Before you proceed, please read the EUDI Wallet Reference Implementation project description
This project provides a REST API server implementing the Wallet-driven external SCA component of the remote Qualified Electronic Signature (rQES) for the EUDI Wallet. The Signature Creation Application (SCA) server exposes endpoints that:
- calculate the hash value of a document.
- return the signed document, given the signature value.
Currently, the server is running at "https://walletcentric.signer.eudiw.dev", but you can run it locally or use the Docker-based deployment option.
The Wallet Centric rQES Specification can be found here.
This server can be used in combination with the servers from eudi-srv-web-walletdriven-rpcentric-signer-qtsp-java to implement a remote Qualified Electronic Signature (rQES) system, as described in the previously linked specification.
The released software is an initial development release version:
- The initial development release is an early endeavor reflecting the efforts of a short timeboxed period, and by no means can be considered as the final product.
- The initial development release may be changed substantially over time, might introduce new features but also may change or remove existing ones, potentially breaking compatibility with your existing code.
- The initial development release is limited in functional scope.
- The initial development release may contain errors or design flaws and other problems that could cause system or other failures and data loss.
- The initial development release has reduced security, privacy, availability, and reliability standards relative to future releases. This could make the software slower, less reliable, or more vulnerable to attacks than mature software.
- The initial development release is not yet comprehensively documented.
- Users of the software must perform sufficient engineering and additional testing in order to properly evaluate their application and determine whether any of the open-sourced components is suitable for use in that application.
- We strongly recommend not putting this version of the software into production use.
- Only the latest version of the software will be supported
sequenceDiagram
title Document Signing
actor U as UserAgent
participant EW as EUDI Wallet
participant SCA as Signature Creation Application
participant AS as Authorization Server (QTSP)
participant RS as Resource Server (QTSP)
participant OIDV as OID4VP Verifier
U->>+EW: Chooses credential to use
U->>+EW: Request document signing
EW->>+RS: /csc/v2/credentials/info
RS->>-EW: credentials info
EW->>+SCA: "calculate hash" (certificates, document to sign)
SCA->>-EW: hash value
EW->>+AS: /oauth2/authorize?...&redirect_uri=wallet://login/oauth2/code&...
AS->>+OIDV: Authorization Request (Post dev.verifier-backend.eudiw.dev/ui/presentations?redirect_uri={oid4vp_redirect_uri})
OIDV->>-AS: Authorization Request returns
AS->>+AS: Generate link to Wallet
AS->>-EW: Redirect to link in the Wallet
EW->>-U: Request Authorization
U->>+EW: Authorize (Shares PID)
EW->>+AS: Redirect to oid4vp_redirect_uri
AS->>+OIDV: Request VP Token
OIDV->>-AS: Get and validate VP Token
AS->>-EW: Returns session token (successful authentication) & Redirects to /oauth2/authorize
EW->>+AS: GET /oauth2/authorize?...&redirect_uri=wallet://oauth2/callback&... [Cookie JSession]
AS->>-EW: Redirect to wallet://login/oauth2/code?code={code}
EW->>+EW: Get wallet://login/oauth2/code....
EW->>+AS: /oauth2/token?code={code}
AS->>-EW: access token authorizing credentials use (SAD/R)
EW->>+RS: /signatures/signHash
RS->>-EW: signature
EW->>+SCA: "obtain signed document" (certificates & document & signature value)
SCA->>-EW: signed document
- Method: POST
- URL: http://localhost:8086/signatures/calculate_hash
This endpoint calculates the digest value of a given document. The payload of this request is a JSON object with the following attributes:
- documents: a JSON array consisting of JSON objects, where each object contains a base64-encoded document content to be signed and additional request parameters.
- endEntityCertificate: the base64-encoded certificate of the user.
- certificateChain: a list of base64-encoded certificates representing the certificate chain to be used when calculating the digest value, excluding the end-entity certificate.
- hashAlgorithmOID: the OID of the hash algorithm used to generate the digest value.
The endpoint should return a JSON object with the following attributes:
- hashes: a list of strings containing one or more BASE64 URL-encoded hash values to be signed.
- signature_date: the date of the signature request, as a long integer, which will be used later when obtaining the signed document.
- Method: POST
- URL: http://localhost:8086/signatures/obtain_signed_doc
This endpoint retrieves the signed document, given the document to be signed and the signature value. The payload of this request is a JSON object with the following attributes:
- documents: a JSON array consisting of JSON objects, where each object contains a base64-encoded document content to be signed and additional request parameters.
- endEntityCertificate: the base64-encoded certificate of the user.
- certificateChain: a list of base64-encoded certificates representing the certificate chain to be used when calculating the digest value, excluding the end-entity certificate.
- hashAlgorithmOID: the OID of the hash algorithm used to generate the digest value.
- returnValidationInfo: a boolean indicating whether the server should return validation information (OCSP, CRL, or certificates).
- date: the value of 'signature_date' received in the response of 'calculate_hash' endpoint.
- signatures: the base64-encoded signature value of the document's digest.
The endpoint returns a JSON object with the following attributes:
- documentWithSignature: a base64-encoded signed document .
- signatureObject: the signature string received in the request.
- Java 17
- Apache Maven 3.6.3
For certain conformance levels, integration with a Timestamp Authority (TSA) is required. You can configure the TSA in two ways:
Option A: Use environment variables
Define the environment variables:
- TIMESTAMP_AUTHORITY_CERTIFICATE_FILEPATH: Filepath to the TSA certificate
- TIMESTAMP_AUTHORITY_URL: TSA endpoint URL
- TIMESTAMP_AUTHORITY_SUPPORTED_DIGEST_ALGS: # List of the digest algorithms supported by the TSA
These can be added to a .env file at the root of the project. To enable .env loading, ensure the following lines are uncommented in application.yml:
config:
import: file:.env[.properties]
Option B: Edit the application.yml directly
Modify the value of the following parameters in the file at src/main/resources/application.yml:
timestamp-authority:
certificate-path: # Filepath to the TSA certificate
server-url: # TSA server URL
supported-digest-algorithm:# List of supported digest algorithms TSA.
- "2.16.840.1.101.3.4.2.1" # Example
By default, logs are printed to the console. You can change this behavior by setting the SPRING_PROFILES_ACTIVE environment variable:
- If the value of the variable is docker, the logs will be saved in a file and printed in the console;
- If the value of the variable is dev, the logs will be saved in a file;
- Else the logs will be printed in the console.
Important: Avoid setting SPRING_PROFILES_ACTIVE in the .env file. Spring Boot does not reliably load this variable from .env during logging setup.
After configuring the above, navigate to the tools directory and run the script:
./deploy_sca.sh
You can also deploy the Wallet-Driven External SCA using Docker, either by:
- Pulling the GitHub package image
- Building the image locally
- Docker
To generate valid signed documents, the following TSA-related environment variables must be defined:
- TIMESTAMP_AUTHORITY_CERTIFICATE_FILEPATH: Filepath to the TSA certificate
- TIMESTAMP_AUTHORITY_URL: TSA endpoint URL
- TIMESTAMP_AUTHORITY_SUPPORTED_DIGEST_ALGS: # List of the digest algorithms supported by the TSA
These environment variables will need to be set up in a .env file presented next.
Create a .env file at the project root with the structure:
SPRING_PROFILES_ACTIVE=docker
TIMESTAMP_AUTHORITY_CERTIFICATE_FILEPATH=# Filepath to the TSA certificate, ex: /certs/tsa.crt
TIMESTAMP_AUTHORITY_URL=# TSA URL, ex: https://tsa.example.com
TIMESTAMP_AUTHORITY_SUPPORTED_DIGEST_ALGS=# Supported Digest Algorithm, ex: 2.16.840.1.101.3.4.2.1,2.16.840.1.101.3.4.2.3
Replace the placeholder values as needed.
To ensure the correct execution of the progress, you will need to update the docker-compose.yml given.
To mount the TSA certificate inside the container, update the volumes section:
volumes:
- {host_path_to_certificate}:{container_path_to_certificate}
Example:
volumes:
- ./path/to/local/certs/tsa.crt:/certs/tsa.crt
Note: Ensure the value of TIMESTAMP_AUTHORITY_CERTIFICATE_FILEPATH matches the container path.
If you wish to use the pre-built image available on GitHub instead of building the image locally, modify the docker-compose.yml by replacing the build section with an image declaration like so:
services:
wallet_driven_sca:
image: ghcr.io/eu-digital-identity-wallet/eudi-srv-web-walletdriven-signer-external-sca-java:latest
container_name: wallet_driven_sca
...
Optional: To avoid port conflicts, change the exposed port:
ports:
- "8086:8086" # Change first 8086 if the port is already used
Log behavior is controlled by the SPRING_PROFILES_ACTIVE variable:
- If the value of the variable is docker, the logs will be saved in a file and printed in the console;
- If the value of the variable is dev, the logs will be saved in a file;
- Else the logs will be printed in the console.
If using a .env file as shown above, logs will be written both to the container console and a logs directory.
From the project root, run:
docker compose up --build
We welcome contributions to this project. To ensure that the process is smooth for everyone involved, follow the guidelines found in CONTRIBUTING.md.
See licenses.md for details.
Copyright (c) 2024 European Commission
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
http://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 for the specific language governing permissions and limitations under the License.