From 93969ae009ce6581936551f0a47905b2bc2da1c0 Mon Sep 17 00:00:00 2001 From: Thomas <> Date: Wed, 24 Mar 2021 11:18:58 +0100 Subject: add new readme and release info template --- moaSig/README.md | 85 ++++++++++++++++++++++++++++++++++++++ release-infos/readme_3.1.4-RC1.txt | 85 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 170 insertions(+) create mode 100644 moaSig/README.md create mode 100644 release-infos/readme_3.1.4-RC1.txt diff --git a/moaSig/README.md b/moaSig/README.md new file mode 100644 index 0000000..eec4db2 --- /dev/null +++ b/moaSig/README.md @@ -0,0 +1,85 @@ +# MOA-Signature (MOA-SPSS) + +## Description + +MOA-Signature, which is also called MOA-SPSS provides a Web-Service interface and a library for signature creation and signature verification. This application consists of two parts + +- **Signature generation:** MOA-SS implements signature generation on sever-side for XAdES (XML) and CAdES (CMS) signatures. + +- **Signature verification:** MOA-SP implements signature verification and certificate validation on server-side for XAdES, CAdES, , PAdES, and ASiC signatures. + + + +### Building + +The application is build into a Web-application and into a set of jars that can be directly used in another application. The Web application has to be deployed into an application service, like Apache Tomcat + +The project can be build with : + +``` +./gradlew clean assemble +``` + +The resulting `war` file can be deployed into an application server + +Set Java System-Property _**-Dmoa.spss.server.configuration**=/path/to/configuration..._ to set the configuration for this application + + + +### Configuration + +A default configuration is located at _/release-infos/handbook/conf/_ + + + +## Generate a Release Package + +The full release packages for will be automatically assembled by gradle build-process. Before release build, all release related information have to added into infos folder. To add release informations follow the steps outlined below. + +Add a file with release informations to: +``` +./release-infos/readme_{version}.txt +``` + +Add, remove, or update the application description in the handbook + +``` +modify: ./release-infos/handbook/ +``` + +Generate a release package with: + + +``` +./gradlew release +``` + +The full release package will be located add +``` +./moaSig/releases/* +``` + +where + +- _moa-spss-lib-..._ is the package with the library and dependencies +- _moa-spss----_ is the Web application with configuration and additional informations + + + +## Changelog + +**v3.1.4** + +- Mindestanforderung für JAVA 8 +- Anpassungen an der TSL Implementierung + - Updates von Bibliotheken zur Stabilitätsverbesserung + - TrustStore Update in der Beispielkonfiguration + +**v3.1.3** + + - Anpassungen an der TSL Implementierung + + - Updates von Bibliotheken zur Stabilitätsverbesserung + - TrustStore Update in der Beispielkonfiguration + + \ No newline at end of file diff --git a/release-infos/readme_3.1.4-RC1.txt b/release-infos/readme_3.1.4-RC1.txt new file mode 100644 index 0000000..e48c4f9 --- /dev/null +++ b/release-infos/readme_3.1.4-RC1.txt @@ -0,0 +1,85 @@ +Releaseinfos zu MOA-SPSS Version 3.1.3 + - Änderungen: + - Anpassungen an der TSL Implementierung + - Updates von Bibliotheken zur Stabilitätsverbesserung + - TrustStore Update in der Beispielkonfiguration + +------------------------------------------------------------------------------- + Update einer bestehenden MOA-SPSS-Installation auf Version 3.1.3 +------------------------------------------------------------------------------- +Es gibt zwei Moeglichkeiten (im Folgenden als "Update Variante A" und +"Update Variante B" bezeichnet), das Update von MOA-SPSS auf Version +3.1.1 durchzufuehren. Update Variante A geht dabei den Weg ueber eine +vorangestellte Neuinstallation, waehrend Variante B direkt eine +bestehende Installation aktualisiert. + +Folgende Begriffe werden verwendet: + +JAVA_HOME bezeichnet das Wurzelverzeichnis der JDK-Installation + +CATALINA_HOME bezeichnet das Wurzelverzeichnis der Tomcat-Installation + +MOA_SPSS_WAR bezeichnet die Applikation MOA-SPSS in der Datei moa-spss-3.1.3.war + +MOA_SPSS_HANDBOOK bezeichnet das Archiv mit dem Handbuch und der Default Konfiguration + +-------------------------- +Update Variante A +-------------------------- + +1.) Erstellen Sie eine Sicherungskopie des kompletten Tomcat-Verzeichnisses + Ihrer MOA-SPSS-Installation. + +2.) Fuehren Sie eine Neuinstallation gemaess Handbuch durch. + +3.) Kopieren Sie etwaige Konfigurationsdateien, Trust-Profile und Key-Stores, + die Sie aus Ihrer alten Installation beibehalten moechten, aus Ihrer + Sicherungskopie in die entsprechenden Verzeichnisse der neuen + Installation. + + +-------------------------- +Update Variante B +-------------------------- + +1.) Erstellen Sie eine Sicherungskopie des kompletten Tomcat-Verzeichnisses + Ihrer MOA-SPSS-Installation. + +2.) Umstellung auf Java JDK 9 + Die 'JAVA_HOME\jre\lib\ext' und die 'CATALINA_HOME\endorsed' wird in Java 9 + nicht mehr unterstützt und entsprechende Referenzen müssen aus den Start-Scripts + entfernt werden. Ab MOA-SPSS 3.1.3 sind die Bibliotheken, welche früher in + den beiden Verzeichnissen hinterlegt waren, direkt in MOA-SPSS integriert. + Falls sie eine Java Version < 9 verwenden und aktuell Bibliotheken in diesen + Verzeichnissen abgelegt haben müssen diese aktualisiert werden: + + 2.1.) Erstellen Sie eine Sicherungskopie aller "*.jar"-Dateien im Verzeichnis + JAVA_HOME\jre\lib\ext und loeschen Sie diese Dateien danach. + + 2.2.) Kopieren Sie alle Dateien aus dem Verzeichnis MOA_SPSS_HANDBOOK\ext_libs in das + Verzeichnis JAVA_HOME\jre\lib\ext + + 2.3.) Erstellen Sie eine Sicherungskopie aller "*.jar"-Dateien im Verzeichnis + CATALINA_HOME\endorsed und loeschen Sie diese Dateien danach. + + 2.4.) Kopieren Sie die Dateien aus dem Verzeichnis MOA_SPSS_HANDBOOK\endorsed_libs + in das Verzeichnis CATALINA_HOME\endorsed. Ueberschreiben Sie dabei + etwaige gleichnamige Dateien. Die dort eventuell vorhandene Datei + xmlParserAPIs.jar ist zu loechen. + +7.) Loeschen Sie das Verzeichnis CATALINA_HOME\webapps\moa-spss. + +8.) Ersetzen Sie die Datei CATALINA_HOME\webapps\moa-spss.war durch die Datei + MOA_SPSS_WAR. + +9.) Loeschen Sie das Verzeichnis CATALINA_HOME\work. + +10.) Falls sie MOA-SP mit Trust-Status List (TSL) Unterstützung betreiben passen Sie + die Konfiguration entsprechend der TSL Konfiguration im Handbuch an. + +11.) Falls sie MOA-SP ohne Trust-Status List (TSL) Unterstützung betreiben gleichen Sie + nach bedarf die in der Konfiguration begelegten TrustStore für Zertifikate + MOA_SPSS_HANDBOOK/conf/moa-spss/trustProfiles/* + udnd das toBeAdded Verzeichnis des CertStores + MOA_SPSS_HANDBOOK/conf/moa-spss/certstore/toBeAdded/* + mit der von Ihnen aktuell verwendeten Konfiguration ab. \ No newline at end of file -- cgit v1.2.3