jorgenheinsoo/siva

Signature Verification Service

Signature Verification Service

SiVa is digitally signed documents validations web service with REST JSON API built with Spring Boot. Supported digitally signed document formats are: BDOC, DDOC and PDF files with at least signature level Long Term.

Main features

• SiVa REST ETSI compliant API to validate all supported signatures.
• SiVa handles files in PDF-format version 1.7 and later, signed with PadES-profile signatures.
• Service handles DDOC files starting from version 1.0 or later
• Service supports BDOC files starting from version 2.1 or later
• Signatures with PadES-LT and PadES-LTA profile are supported.
• BDOC signatures with type BDOC-TM and BDOC-TS are supported

Libraries used in validation services

Below is list of Java libraries we use and for which digitally signed document format we use it for:

• JDigiDoc - is used to validate Estonian older digital signature format called DDOC
• DigiDoc4J - is used to validate BDOC digital signature container that are compliant with ASiCE standard
• DigiDoc4J DSS fork - to validate digitally signed PDF files that comply with Estonian laws
• asicverifier is used to validate XRoad signature containers

Requirements

These are minimum requirements to build and develop SiVa project:

• git - to easily download and update code. You can download git here
• Oracle Java JDK - to compile and run SiVa applications. Download link for Oracle Java JDK
• IDE - to develop SiVa. We recommend to use JetBrains IntelliJ
• 2 GB of RAM the RAM requirement is here because when building the project the integration tests take up a lot of memory
• Optionally You can also install Maven but it is not needed because SiVa project uses Maven wrapper to install maven

How to build

Using Maven Wrapper

Recommended way of building this project is using Maven Wrapper to build it. Run following command:

./mvnw clean install

How-to run

SiVa project compiles 3 fat executable JAR files that You can run after successfully building the project by issuing below commands:

First start SiVa REST and SOAP web service

./siva-parent/siva-webapp/target/siva-webapp-3.1.0.jar

Second we need to start SiVa XRoad validation service

./validation-services-parent/xroad-validation-service/target/xroad-validation-service-3.1.0.jar

The SiVa webapp by default runs on port 8080 and XRoad validation service starts up on port 8081. Easiest way to test out validation is run SiVa demo application.

Start SiVa Demo Application

./siva-parent/siva-sample-application/target/siva-sample-application-3.1.0.jar

Now point Your browser to URL: http://localhost:9000

WAR and Tomcat setup for legacy systems

NOTE 1: We do not recommend using WAR deployment option because lack of testing done on different servlet containers also possible container application libraries conflicts

NOTE 2: Each SiVa service must be deployed to separate instance of Tomcat to avoid Java JAR library version conflicts.

First we need to download Tomcat web servlet container as of the writing latest version available in version 7 branch is 7.0.77. We will download it with wget

wget http://www-eu.apache.org/dist/tomcat/tomcat-7/v7.0.70/bin/apache-tomcat-7.0.70.tar.gz

Unpack it somewhere:

tar xf apache-tomcat-7.0.70.tar.gz

Now we should build the WAR file. We have created helper script with all the correct Maven parameters.

./war-build.sh

NOTE The script will skip running the integration tests when building WAR files

Final steps would be copying built WAR file into Tomcat webapps directory and starting the servlet container.

cp siva-parent/siva-webapp/target/siva-webapp-3.1.0.war apache-tomcat-7.0.70/webapps
./apache-tomcat-7.0.77/bin/catalina.sh run

IMPORTANT siva-webapp on startup creates etc directory where it copies the TSL validaiton certificates siva-keystore.jks. Default location for this directory is application root or $CATALINA_HOME. To change this default behavior you should set environment variable DSS_DATA_FOLDER

How-to set WAR deployed SiVa application.properties

SiVa override properties can be set using application.properties file. The file can locate anywhare in the host system. To make properties file accessible for SiVa you need to create or edit setenv.sh placed inside bin directory.

Contents of the setenv.sh file should look like:

export CATALINA_OPTS="-Dspring.config.location=file:/path/to/application.properties"

How-to run tests

Unit and integration tests are integral part of the SiVa code base. The tests are automatically executed every time the application is built. The build will fail if any of the tests fail.

To execute the tests from command line after application is built use:

./mvnw verify

How to run load tests

Load tests are disabled by default, but can be enabled with maven parameter -DrunLoadTests=true. By default all unit and integration tests will be executed prior the load tests, but it is possible to skip them. When executing the load tests, SiVa Web application has to be started before the tests are executed.

Note: PDF load test files contain test certificates. In order for PDF load tests to succeed SiVa application should be started with test certificates preloaded.

To load trusted test certificates in addition to TSL, "test" spring profile should be activated at startup, for example:

java -Dspring.profiles.active=test -jar siva-webapp-3.1.0.jar

To run load tests after unit and integration tests in non GUI mode:

./mvnw verify -DrunLoadTests=true

To run load tests only:

./mvnw verify -DskipTests=true -DrunLoadTests=true

To run load tests with JMeter GUI execute the command in Siva/siva-parent/siva-test/ folder:

mvn jmeter:gui  -DrunLoadTests=true

It is possible to configure following parameters in load test (given defaults are based on ../siva-test/pom.xml):

• jmeter.host.name - target webapp host against what the tests are executed, default is localhost
• jmeter.host.port - target port of the webapp host , default is 8080
• jmeter.host.timeout - response waiting timeout, default is 60000 (in milliseconds)
• jmeter.testfiles.dir - directory of the test files, default is ${project.basedir}/src/test/jmeter/test-files
• jmeter.load.step.duration - time how long the load is kept on each throuput level, default is 60 (in seconds)

These values can be set in three different ways:

• In JMeter test plan - these settings will be used when JMeter GUI is used to run the tests
• In ../siva-test/pom.xml file - these settings will be used when the tests are run in non GUI mode and will overwrite the default values in test plans.
• As parameters when executing the tests - These values have highest priority and will overwrite other default values.

To run the tests with modified parameters:

./mvnw verify -Drun.load.tests=true -Djmeter.host.port=9090

Test results will be available at /siva-parent/siva-test/target/jmeter/results/reports/ folder

Open source software used to build SiVa

Full list of open source Java libraries used to build SiVa can be found in our Open Source Software used page

Documentation

Read SiVa documentation