Verifica Firma CRYPTO

Fonte template redazione documento: https://www.makeareadme.com/.

Descrizione

Microservizio realizzato per effettuare verifica e validazione di documenti con firma digitale.
Realizzato attraverso framework Spring Boot (versione 3.x) e OpenJDK 17, utilizza la libreria proprietaria Cryptolibray con la quale sono realizzate le logiche di validazione e verifica della firma digitale.

Installazione

Di seguito verranno riportati sotto alcuni paragrafi, le modalità possibili con cui è possibile rendere operativo il microservizio.

Rilascio su RedHat Openshift

Vedere specifica guida per il rilascio OKD.md.

Openshift template

Per la creazione dell'applicazione con risorse necessarie correlate sotto Openshift (https://www.redhat.com/it/technologies/cloud-computing/openshift) viene fornito un apposito template (la solzuzione, modificabile, è basata su Oracle DB) template.

Installazione applicazione come servizio/demone

Vedere guida all'installazione INSTALL.md.

Utilizzo

Basandosi su spring boot, il seguente progetto è dotato di una sorta di "launcher" ossia, una semplice classe Java con main che ne permette l'esecuzione. Inoltre il progetto permette una gestione "profilata" delle configurazioni con il quale eseguire in locale l'applicazione, come previsto dalla dinamiche di spring boot stesso:

• default : è il profilo "standard" di spring boot quello con cui normalmente viene eseguito il processo applicativo;
• h2: profilo legato al db h2 (è quello di riferimento) del progetto, con db in memoria (vedi application-h2.yaml);
• oracle: profilo legato al db oracle (vedi application-oracle.yaml); in particolare username e password dovranno essere fornite allo start dell'applicazione in una delle possibili modalità previste vedi https://www.baeldung.com/spring-boot-command-line-arguments; nel caso specifico, attraverso l'IDE utilizzato con la modalità -Ddbusername=user -Ddbpassword=password

Le configurazioni sono legate ai file yaml che sono gestiti come previsto dai meccanismi di overrinding messi a disposizione, vedi https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config.

Esempio override configurazioni

Nel seguente esempio, si riporta una casistica di esecuzione dell'applicazione (attraverso apposito jar) con override delle configurazioni base:

$ java -jar myproject.jar --spring.config.location=\
    optional:classpath:/default.properties,\
    optional:classpath:/override.properties

Nota: nell'esempio sopra riportato, si utilizzano file di tipo properties (default previsto da spring boot), mentre in questo caso si è scelto lo standard YAML, non cambiano le dinamiche descritte ma semplicemente l'estenzione (.yaml).

Migrazione OpenJDK 17

Nei seguenti paragrafi vengono riportate alcune note importanti legate al passaggio alla versione 17 della OpenJDK.

Risoluzione java.base unnamede module

Nel passaggio alla versione 17 della OpenJDK runtime si è presentata la seguente eccezione:

java.lang.IllegalAccessError: class es.mityc.firmaJava.libreria.utilidades.URIEncoder (in unnamed module @0x3b2c72c2)
cannot access class sun.security.action.GetPropertyAction (in module java.base) because module java.base does not export sun.security.action to unnamed module @0x3b2c72c2

Tale problematica deriva dalla recente introduzione (a partire dalla versione 9 della OpenJDK) di un sistema così detto a "moduli" (vedere documentazione ufficiale) per cui, l'applicazione non può avere accesso, se non esplicitamente indicato, al modulo java.base/sun.security.action. Per tale motivo all'interno dell'artifact prodotto (jar eseguibile) occorre esplicitare l'export di tale modulo:

--add-exports java.base/sun.security.action=ALL-UNNAMED

la modifica viene attraverso i plugin maven:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <configuration>
        <target>17</target>
        <source>17</source>
        <compilerArgs>
                <compilerArg>--add-exports</compilerArg>
                <compilerArg>java.base/sun.security.action=ALL-UNNAMED</compilerArg>
            </compilerArgs>
    </configuration>
</plugin>
[...]
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <configuration>
        <archive>
            <manifest>
                <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
                <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
            </manifest>
            <!-- export legacy module -->
            <!-- @see java.lang.IllegalAccessError: class
            es.mityc.firmaJava.libreria.utilidades.URIEncoder (in unnamed module @0x3b2c72c2) -->
            <!-- cannot access class sun.security.action.GetPropertyAction (in module java.base)
            because module java.base does not export sun.security.action to unnamed module
            @0x3b2c72c2 -->
            <manifestEntries>
                <Add-Exports>java.base/sun.security.action</Add-Exports>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>

Maven plugin Jacoco/Surefire

Come riportato nel paragrafo precedete [Risoluzione java.base unnamede module](#### Risoluzione java.base unnamede module), a seguito dell'introduzione del comando "--add-exports" che permette all'applicazione di accedere al modulo desiderato, è necessaria la modifica per l'esecuzione del profiler jacoco.exe introducendo la seguente property su pom.xml:

<argLine>--add-exports java.base/sun.security.action=ALL-UNNAMED</argLine>

utilizzata dai plugin Jacoco e Surefire (https://www.eclemma.org/jacoco/trunk/doc/prepare-agent-mojo.html#propertyName) per la produzione del site con il risultato della coverage dei test di unità.

Console amministratori

Presente pagina per amministratori /admin.

Ambiente di sviluppo / localhost

• User: admin
• Password: admin

Docker build

Per effettuare una build del progetto via Docker è stato predisposto lo standard Dockerfile e una directory docker_build con all'interno i file da integrare all'immagine base registry.access.redhat.com/ubi8/openjdk-11. La directory docker_build è strutturata come segue:

|____README.md
|____certs
| |____README.md

al fine di integrare certificati non presenti di default nell'immagine principale è stata introdotta la sotto-directory docker_build/certs in cui dovranno essere inseriti gli appositi certificati che verranno "trustati" in fase di build dell'immagine. La compilazione dell'immagine può essere eseguita con il comando:

docker build -t <registry> -f ./Dockerfile --build-arg EXTRA_CA_CERTS_DIR=docker_build/certs .

Requisiti e librerie utilizzate

Requisiti minimi per installazione:

• Sistema operativo : consigliato Linux server (in alternativa compatibilità con Windows server)
• Java versione 17 (OpenJDK / Oracle)
• Kubernetes / Docker : se rilasciato attraverso container oppure si esegue una build del progetto attraverso il profilo maven uber-jar per ottenere il JAR eseguibile (vedi paragrafi precendeti)

Librerie utilizzate

GroupId	ArtifactId	Version	Type	Licenses
com.google.guava	guava	32.1.1-jre	jar	Apache License, Version 2.0
com.h2database	h2	2.1.214	jar	MPL 2.0EPL 1.0
com.oracle.database.jdbc	ojdbc11	21.7.0.0	jar	Oracle Free Use Terms and Conditions (FUTC)
it.eng.parer	cryptolibrary	1.12.7	jar	-
it.eng.parer	verificafirma-crypto-beans	1.3.0	jar	-
net.logstash.logback	logstash-logback-encoder	7.2	jar	Apache License, Version 2.0MIT License
org.apache.taglibs	taglibs-standard-jstlel	1.2.5	jar	The Apache Software License, Version 2.0
org.apache.tika	tika-core	1.7	jar	The Apache Software License, Version 2.0
org.apache.tika	tika-parsers	1.7	jar	The Apache Software License, Version 2.0
org.springdoc	springdoc-openapi-starter-webmvc-ui	2.1.0	jar	The Apache License, Version 2.0
org.springframework.boot	spring-boot-starter-actuator	3.0.9	jar	Apache License, Version 2.0
org.springframework.boot	spring-boot-starter-data-jpa	3.0.9	jar	Apache License, Version 2.0
org.springframework.boot	spring-boot-starter-security	3.0.9	jar	Apache License, Version 2.0
org.springframework.boot	spring-boot-starter-thymeleaf	3.0.9	jar	Apache License, Version 2.0
org.springframework.boot	spring-boot-starter-validation	3.0.9	jar	Apache License, Version 2.0
org.springframework.boot	spring-boot-starter-web	3.0.9	jar	Apache License, Version 2.0
org.springframework.boot	spring-boot-starter-webflux	3.0.9	jar	Apache License, Version 2.0
org.springframework.ws	spring-ws-core	4.0.5	jar	Apache License, Version 2.0
org.thymeleaf.extras	thymeleaf-extras-springsecurity6	3.1.1.RELEASE	jar	The Apache Software License, Version 2.0
org.webjars	bootstrap	3.4.1	jar	Apache License, Version 2.0
org.webjars	jquery	3.6.4	jar	MIT License
org.webjars.bower	google-code-prettify	1.0.5	jar	MIT
org.yaml	snakeyaml	1.33	jar	Apache License, Version 2.0
xalan	xalan	2.7.2	jar	The Apache Software License, Version 2.0

Supporto

Mantainer del progetto è Engineering Ingegneria Informatica S.p.A..

Contributi

Se interessati a crontribuire alla crescita del progetto potete scrivere all'indirizzo email areasviluppoparer@regione.emilia-romagna.it.

Credits

Progetto di proprietà di Regione Emilia-Romagna sviluppato a cura di Engineering Ingegneria Informatica S.p.A..

Licenza

Questo progetto è rilasciato sotto licenza GNU Affero General Public License v3.0 or later (LICENSE.txt).

Appendice

Spring Boot 3.x

Alcuni riferimenti:

• Migrazione Spring boot versione 3 https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.0-Migration-Guide