Skip to content
develop
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

EU Regional Development Fund

Signature Verification Service

SiVa CI with Maven GitHub license

SiVa is digital signature validation web service that provides JSON and SOAP API to validate following file types:

  • Estonian DDOC containers
  • Estonian BDOC containers with TimeMark and TimeStamp signatures
  • Estonian X-Road security server ASiCE signature containers
  • Estonian ASiC-S containers with time stamp tokens
  • ETSI standard based ASiC-E and ASiC-S containers
  • ETSI standard based XAdES, CAdES and PAdES signatures
  • ETSI standard based XAdES signatures with datafiles in hashcode form

Libraries used in validation services

Below is list of Java libraries used for validation:

  • DigiDoc4J - is used to validate DDOC and BDOC digital signature containers.
  • asicverifier - is used to validate XRoad signature containers.
  • DigiDoc4J DSS fork - to validate all other digitally signed files.

Requirements

These are minimum requirements to build and develop SiVa project:

  • git - to easily download and update code. You can download git here
  • Java JDK 11 - to compile and run SiVa applications.
  • 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. 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. NB! X.X.X denotes the version you are running.

java -jar siva-parent/siva-webapp/target/siva-webapp-X.X.X-exec.jar

Second we need to start SiVa XRoad validation service. NB! X.X.X denotes the version you are running.

java -jar validation-services-parent/xroad-validation-service/target/xroad-validation-service-X.X.X-exec.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. NB! X.X.X denotes the version you are running.

java -jar siva-parent/siva-sample-application/target/siva-sample-application-X.X.X.jar

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

Sample of validation result

WAR and Tomcat setup for legacy systems

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

To build the WAR file use helper script with all the correct Maven parameters.

./war-build.sh

Copy built WAR file into Tomcat webapps directory and start the servlet container. NB! X.X.X denotes the version you are running.

cp siva-parent/siva-webapp/target/siva-webapp-X.X.X.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 validation certificates siva-keystore.jks (or test-siva-keystore.jks if test profile is used). 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 test 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 integration tests

Integration tests are disabled by default, but can be enabled with maven parameter -DrunIntegrationTests=true. Executing integration tests requires running SiVa Web application instance (and XROAD validation service instance). It is possible to run integration tests without xroad tests -DrunWithoutXroadIntegrationTests=true.

How to run load tests

Load tests are disabled by default, but can be enabled with maven parameter -DrunLoadTests=true. 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 (NB! X.X.X denotes the version you are running), for example:

java -Dspring.profiles.active=test -jar siva-parent/siva-webapp/target/siva-webapp-X.X.X-exec.jar

To run load tests after unit 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.protocol - target protocol , default is http
  • 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