Skip to content

Latest commit

 

History

History
114 lines (77 loc) · 4.96 KB

README.md

File metadata and controls

114 lines (77 loc) · 4.96 KB
Raw

DSS : Digital Signature Service

This is the official repository for project DSS : https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/Digital+Signature+Service+-++DSS.

Issue Tracker

Please, use the new JIRA for project is on https://ec.europa.eu/digital-building-blocks/tracker/projects/DSS/issues.

Requirements

The latest version of DSS framework has the following minimal requirements:

  • Java 8 or higher (tested up to Java 22) is required for usage;
  • Java 11 or higher is required for the build. Java 15 is the minimal requirement for a build with unit tests;
  • Maven 3.6.3 and higher (if build required);
  • Memory and Disk: see minimal requirements for the used JVM. In general the higher available is better;
  • Operating system: no specific requirements (tested on Windows and Linux).

Starting from version 6.0, DSS uses jakarta.\* namespace naming of Specification API. If your application uses javax.* namespaces, please use version 5.13.

Maven repository

The release is published on Maven Central repository :

https://central.sonatype.com/search?q=eu.europa.ec.joinup.sd-dss

<!-- Add dss-bom for easy integration -->
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>eu.europa.ec.joinup.sd-dss</groupId>
            <artifactId>dss-bom</artifactId>
            <version>6.1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<!-- Add required modules (example) -->
<dependencies>
    <dependency>
        <groupId>eu.europa.ec.joinup.sd-dss</groupId>
        <artifactId>dss-utils-apache-commons</artifactId>
    </dependency>
    <dependency>
        <groupId>eu.europa.ec.joinup.sd-dss</groupId>
        <artifactId>dss-xades</artifactId>
    </dependency>
    ...
</dependencies>

Build and usage

A simple build of the DSS Maven project can be done with the following command:

mvn clean install

This installation will run all unit tests present in the modules, which can take more than one hour to do the complete build.

In addition to the general build, the framework provides a list of custom profiles, allowing a customized behavior:

  • quick - disables unit tests and java-doc validation, in order to process the build as quick as possible (takes 1-2 minutes). This profile cannot be used for a primary DSS build (see below).
  • quick-init - is similar to the quick profile. Disables java-doc validation for all modules and unit tests excluding some modules which have dependencies on their test classes. Can be used for the primary build of DSS.
  • slow-tests - executes all tests, including time-consuming unit tests.
  • owasp - runs validation of the project and using dependencies according to the National Vulnerability Database (NVD).
  • jdk19-plus - executed automatically for JDK version 9 and higher. Provides a support of JDK 8 with newer versions.
  • spotless - used to add a licence header into project files.

In order to run a build with a specific profile, the following command must be executed:

mvn clean install -P *profile_name*

Documentation

The documentation and samples are available in the dss-cookbook module. SoapUI project and Postman project are also provided to illustrate SOAP/REST calls.

In order to build the documentation by yourself, the following command must be executed in dss-cookbook module:

mvn clean install -P asciidoctor

JavaDoc

The JavaDoc is available on https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/apidocs/index.html

Demonstration

The release is deployed on https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo

The source code of the demonstrations is available on https://github.com/esig/dss-demonstrations

Ready-to-use bundles

Bundles which contain the above demonstration can be downloaded from the Maven repository.

The code of the demonstration can be found on https://ec.europa.eu/digital-building-blocks/code/projects/ESIG/repos/dss-demos/browse

Licenses

The DSS project is delivered under the terms of the Lesser General Public License (LGPL), version 2.1

License (LGPL version 2.1)

SPDX-License-Identifier : LGPL-2.1

SonarCloud