diff options
Diffstat (limited to 'release-infos/handbook')
| -rw-r--r-- | release-infos/handbook/conf/moa-spss/log4j.properties | 38 | ||||
| -rw-r--r-- | release-infos/handbook/conf/moa-spss/logback.xml | 53 | ||||
| -rw-r--r-- | release-infos/handbook/handbook/install/install.html | 296 |
3 files changed, 154 insertions, 233 deletions
diff --git a/release-infos/handbook/conf/moa-spss/log4j.properties b/release-infos/handbook/conf/moa-spss/log4j.properties deleted file mode 100644 index 562d450..0000000 --- a/release-infos/handbook/conf/moa-spss/log4j.properties +++ /dev/null @@ -1,38 +0,0 @@ -# -# Sample log4j configuration for the MOA-SPSS web service -# - -# commons-logging setup -org.apache.commons.logging.LogFactory=org.apache.commons.logging.impl.Log4jFactory - -# Configure root logger and loggers for moa-spss -log4j.rootLogger=info, stdout -log4j.logger.at.gv.egovernment.moa.spss=info, moaspss -log4j.logger.at.gv.egovernment.moa.sig=info, moaspss -log4j.logger.iaik.server=warn, moaspss - -# Configure the 'stdout' appender to write logging output to the console -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%5p | %d{dd HH:mm:ss,SSS} | %20c | %10t | %m%n - -# Configure the 'moaspss' appender to write moa-spss related logging output -# to the file '${catalina.base}/logs/moa-spss.log'. The file is rolled over every 1000KB, -# and a maximum history of 10 log files is being kept. -log4j.appender.moaspss=org.apache.log4j.RollingFileAppender -log4j.appender.moaspss.File=${catalina.base}/logs/moa-spss.log -log4j.appender.moaspss.MaxFileSize=1000KB -log4j.appender.moaspss.MaxBackupIndex=10 -log4j.appender.moaspss.layout=org.apache.log4j.PatternLayout -log4j.appender.moaspss.layout.ConversionPattern=%5p | %d{dd HH:mm:ss,SSS} | %20c | %10t | %m%n - -# Configure the jdbc appender 'JDBC' to write logging output -# to the given PostgreSQL database -# a suitable table called 'spss_log' must have been created in the -# database using the command: -# create table spss_log (log_time timestamp, log_level char(5), log_msg text) -#log4j.appender.JDBC=org.apache.log4j.jdbc.JDBCAppender -#log4j.appender.JDBC.driver=org.postgresql.Driver -#log4j.appender.JDBC.URL=jdbc:postgresql://10.16.46.108/moa?user=moa&password=moatest -#log4j.appender.JDBC.layout=org.apache.log4j.PatternLayout -#log4j.appender.JDBC.sql=INSERT INTO spss_log (log_time, log_level, log_msg) VALUES ('%d{ yyyy-MM-dd HH:mm:ss.SSS}', '%5p', '%m') diff --git a/release-infos/handbook/conf/moa-spss/logback.xml b/release-infos/handbook/conf/moa-spss/logback.xml new file mode 100644 index 0000000..4d0b34b --- /dev/null +++ b/release-infos/handbook/conf/moa-spss/logback.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- For assistance related to logback-translator or configuration --> +<!-- files in general, please contact the logback user mailing list --> +<!-- at http://www.qos.ch/mailman/listinfo/logback-user --> +<!-- --> +<!-- For professional support please see --> +<!-- http://www.qos.ch/shop/products/professionalSupport --> +<!-- --> +<configuration> + <appender name="moaspss" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <!--See also http://logback.qos.ch/manual/appenders.html#RollingFileAppender--> + <File>${catalina.base}/logs/moa-spss.log</File> + <encoder> + <pattern>logback | %5p | %d{dd HH:mm:ss,SSS} | %C{1} | %20c | %10t | %m%n</pattern> + </encoder> + <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> + <maxIndex>10</maxIndex> + <FileNamePattern>${catalina.base}/logs/moa-spss.log.%i</FileNamePattern> + </rollingPolicy> + <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> + <MaxFileSize>1000KB</MaxFileSize> + </triggeringPolicy> + </appender> + <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> + <encoder> + <pattern>logback | %5p | %d{dd HH:mm:ss,SSS} | %C{1} | %20c | %10t | %m%n</pattern> + </encoder> + </appender> + <logger name="moa.spss.server" level="info"> + <appender-ref ref="moaspss"/> + <appender-ref ref="stdout"/> + </logger> + <logger name="iaik.pki" level="info"> + <appender-ref ref="moaspss"/> + <appender-ref ref="stdout"/> + </logger> + <logger name="at.gv.egovernment.moa.spss" level="info"> + <appender-ref ref="moaspss"/> + <appender-ref ref="stdout"/> + </logger> + <logger name="at.gv.egovernment.moa.sig.tsl" level="info"> + <appender-ref ref="SPSS"/> + <appender-ref ref="stdout"/> + </logger> + <logger name="iaik.server" level="info"> + <appender-ref ref="moaspss"/> + <appender-ref ref="stdout"/> + </logger> + <root level="warn"> + <appender-ref ref="stdout"/> + </root> +</configuration> diff --git a/release-infos/handbook/handbook/install/install.html b/release-infos/handbook/handbook/install/install.html index 9910c80..7b74750 100644 --- a/release-infos/handbook/handbook/install/install.html +++ b/release-infos/handbook/handbook/install/install.html @@ -5,7 +5,7 @@ <title>MOA SS und SP - Installation</title> <link rel="stylesheet" href="../common/MOA.css" type="text/css"> </head> -<<body link="#990000"> +<<body link="#990000"> <table class="logoTable" width="100%" border="0" cellspacing="0" cellpadding="10"> <tr> <td align="center" class="logoTitle" width="267"><img src="../common/LogoBKA.png" alt="Logo BKA" width="267" height="37" align="left"></td> @@ -13,66 +13,66 @@ <td align="center" class="logoTitle" width="123"><img src="../common/LogoEGIZ.png" alt="Logo EGIZ" width="230" height="81" align="right"></td> </tr> </table> - <hr/> - <p class="title"><a href="../index.html">MOA: Serversignatur (SS) und Signaturprüfung (SP)</a></p> - <p class="subtitle">Installation</p> + <hr/> + <p class="title"><a href="../index.html">MOA: Serversignatur (SS) und Signaturprüfung (SP)</a></p> + <p class="subtitle">Installation</p> <hr/> <h1>Inhalt</h1> - <ol> - <li> - <p><a href="#uebersicht">Übersicht</a></p> - </li> - <li> - <p><a href="#webservice">Webservice</a></p> - <ol> - <li><a href="#webservice_basisinstallation">Basisinstallation</a> - <ol> - <li><a href="#webservice_basisinstallation_einfuehrung">Einführung</a></li> - <li><a href="#webservice_basisinstallation_installation">Installation</a> - <ol> - <li><a href="#webservice_basisinstallation_installation_vorbereitung">Vorbereitung</a></li> - <li><a href="#webservice_basisinstallation_installation_tomcatconfig">Konfiguration von Apache Tomcat</a> - <ol> - <li><a href="#webservice_basisinstallation_installation_tomcatconfig_httpconn">Konfiguration des HTTP Connectors</a></li> - <li><a href="#webservice_basisinstallation_installation_tomcatconfig_httpsconn">Konfiguration des HTTPS Connectors</a></li> - <li><a href="#webservice_basisinstallation_installation_tomcatconfig_moaadmin">Einrichten des MOA SP/SS Administrators</a></li> - </ol> - </li> - <li><a href="#webservice_basisinstallation_installation_spssdeploy">Einsatz des MOA SP/SS Webservices in Tomcat</a></li> - <li><a href="#webservice_basisinstallation_installation_tomcatstartstop">Starten und Stoppen von Tomcat</a> - <ol> - <li><a href="#webservice_basisinstallation_installation_tomcatstartstop_windows">Unter Windows</a></li> - <li><a href="#webservice_basisinstallation_installation_tomcatstartstop_unix">Unter Unix</a></li> - <li><a href="#webservice_basisinstallation_installation_tomcatstartstop_verify">Prüfen des erfolgreichen Starts</a> </li> - </ol> - </li> - <li><a href="#webservice_basisinstallation_installation_changeonthefly">Änderung der Konfiguration im laufenden Betrieb</a></li> - </ol> - </li> - <li><a href="#webservice_basisinstallation_logging">Logging</a> - <ol> - <li><a href="#webservice_basisinstallation_logging_format">Format der Log-Meldungen</a></li> - <li><a href="#webservice_basisinstallation_logging_messages">Wichtige Log-Meldungen</a></li> - </ol> - </li> - </ol> - </li> - <li><a href="#webservice_erweiterungsmoeglichkeiten">Erweiterungsmöglichkeiten</a> <ol> - <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver">Vorgeschalteter Webserver</a> <ol> - <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_iis">Microsoft Internet Information Server (MS IIS)</a> <ol> - <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_iis_jk">Konfiguration von <span class="term"> mod_jk</span> im MS IIS</a></li> - <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_iis_tomcat">Konfiguration von Tomcat</a></li> - <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_iis_ssl">Konfiguration von SSL</a></li> - </ol> - </li> - <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_apache">Apache</a> <ol> - <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_apache_jk">Konfiguration von <span class="term"> mod_jk</span> im Apache </a></li> - <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_apache_tomcat">Konfiguration von Tomcat</a></li> - <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_apache_ssl">Konfiguration von SSL mit <span class="term">mod_SSL</span></a></li> - </ol> - </li> - </ol> - </li> + <ol> + <li> + <p><a href="#uebersicht">Übersicht</a></p> + </li> + <li> + <p><a href="#webservice">Webservice</a></p> + <ol> + <li><a href="#webservice_basisinstallation">Basisinstallation</a> + <ol> + <li><a href="#webservice_basisinstallation_einfuehrung">Einführung</a></li> + <li><a href="#webservice_basisinstallation_installation">Installation</a> + <ol> + <li><a href="#webservice_basisinstallation_installation_vorbereitung">Vorbereitung</a></li> + <li><a href="#webservice_basisinstallation_installation_tomcatconfig">Konfiguration von Apache Tomcat</a> + <ol> + <li><a href="#webservice_basisinstallation_installation_tomcatconfig_httpconn">Konfiguration des HTTP Connectors</a></li> + <li><a href="#webservice_basisinstallation_installation_tomcatconfig_httpsconn">Konfiguration des HTTPS Connectors</a></li> + <li><a href="#webservice_basisinstallation_installation_tomcatconfig_moaadmin">Einrichten des MOA SP/SS Administrators</a></li> + </ol> + </li> + <li><a href="#webservice_basisinstallation_installation_spssdeploy">Einsatz des MOA SP/SS Webservices in Tomcat</a></li> + <li><a href="#webservice_basisinstallation_installation_tomcatstartstop">Starten und Stoppen von Tomcat</a> + <ol> + <li><a href="#webservice_basisinstallation_installation_tomcatstartstop_windows">Unter Windows</a></li> + <li><a href="#webservice_basisinstallation_installation_tomcatstartstop_unix">Unter Unix</a></li> + <li><a href="#webservice_basisinstallation_installation_tomcatstartstop_verify">Prüfen des erfolgreichen Starts</a> </li> + </ol> + </li> + <li><a href="#webservice_basisinstallation_installation_changeonthefly">Änderung der Konfiguration im laufenden Betrieb</a></li> + </ol> + </li> + <li><a href="#webservice_basisinstallation_logging">Logging</a> + <ol> + <li><a href="#webservice_basisinstallation_logging_format">Format der Log-Meldungen</a></li> + <li><a href="#webservice_basisinstallation_logging_messages">Wichtige Log-Meldungen</a></li> + </ol> + </li> + </ol> + </li> + <li><a href="#webservice_erweiterungsmoeglichkeiten">Erweiterungsmöglichkeiten</a> <ol> + <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver">Vorgeschalteter Webserver</a> <ol> + <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_iis">Microsoft Internet Information Server (MS IIS)</a> <ol> + <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_iis_jk">Konfiguration von <span class="term"> mod_jk</span> im MS IIS</a></li> + <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_iis_tomcat">Konfiguration von Tomcat</a></li> + <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_iis_ssl">Konfiguration von SSL</a></li> + </ol> + </li> + <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_apache">Apache</a> <ol> + <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_apache_jk">Konfiguration von <span class="term"> mod_jk</span> im Apache </a></li> + <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_apache_tomcat">Konfiguration von Tomcat</a></li> + <li><a href="#webservice_erweiterungsmoeglichkeiten_webserver_apache_ssl">Konfiguration von SSL mit <span class="term">mod_SSL</span></a></li> + </ol> + </li> + </ol> + </li> <li><a href="#webservice_erweiterungsmoeglichkeiten_datenbank">Datenbank</a> <ol> <li><a href="#webservice_erweiterungsmoeglichkeiten_datenbank_postgresql">PostgreSQL</a> <ol> <li><a href="#webservice_erweiterungsmoeglichkeiten_datenbank_postgresql_benutzer">Anlegen eines Benutzers und einer Datenbank für MOA SP/SS</a></li> @@ -83,24 +83,24 @@ <li><a href="#webservice_erweiterungsmoeglichkeiten_datenbank_andere">Andere Datenbanken</a> </li> </ol> </li> - </ol> - </li> - </ol> - <li><a href="#klassenbibliothek">Klassenbibliothek</a> - <ol> - <li><a href="#klassenbibliothek_basisinstallation">Basisinstallation</a> - <ol> - <li><a href="#klassenbibliothek_basisinstallation_einfuehrung">Einführung</a></li> - <li><a href="#klassenbibliothek_basisinstallation_vorbereitung">Vorbereitung</a></li> - <li><a href="#klassenbibliothek_basisinstallation_verwendung">Verwendung</a></li> - <li><a href="#klassenbibliothek_basisinstallation_logging">Logging</a></li> - </ol> - </li> + </ol> + </li> + </ol> + <li><a href="#klassenbibliothek">Klassenbibliothek</a> + <ol> + <li><a href="#klassenbibliothek_basisinstallation">Basisinstallation</a> + <ol> + <li><a href="#klassenbibliothek_basisinstallation_einfuehrung">Einführung</a></li> + <li><a href="#klassenbibliothek_basisinstallation_vorbereitung">Vorbereitung</a></li> + <li><a href="#klassenbibliothek_basisinstallation_verwendung">Verwendung</a></li> + <li><a href="#klassenbibliothek_basisinstallation_logging">Logging</a></li> + </ol> + </li> <li><a href="#klassenbibliothek_erweiterungsmoeglichkeiten">Erweiterungsmöglichkeiten</a></li> - </ol> - </li> + </ol> + </li> </ol> - <ol type="A"> + <ol type="A"> <li><a href="#referenzierte_software">Referenzierte Software</a></li> </ol> <hr/> @@ -121,7 +121,7 @@ <li><a href="#referenziertesoftware">Java SE / OpenJDK 8 (neuestes Update) oder Jave SE / OpenJDK 11</a></li> <li><a href="#referenziertesoftware">Apache Tomcat 8.5 oder höher</a></li> </ul> - <p>In diesem Betriebs-Szenario wird das MOA SP/SS Webservice in Tomcat zum Einsatz gebracht. Tomcat fungiert gleichzeitig als HTTP- und HTTPS-Endpunkt für das MOA SP/SS Webservice. Beide Protokolle werden direkt in Tomcat konfiguriert. Das MOA SP/SS Webservice verwendet Log4j als Logging Toolkit.</p> + <p>In diesem Betriebs-Szenario wird das MOA SP/SS Webservice in Tomcat zum Einsatz gebracht. Tomcat fungiert gleichzeitig als HTTP- und HTTPS-Endpunkt für das MOA SP/SS Webservice. Beide Protokolle werden direkt in Tomcat konfiguriert. Das MOA SP/SS Webservice verwendet LogBack als Logging Toolkit.</p> <h3><a name="webservice_basisinstallation_installation" id="webservice_basisinstallation_installation"></a>2.1.2 Installation</h3> <h4><a name="webservice_basisinstallation_installation_vorbereitung" id="webservice_basisinstallation_installation_vorbereitung"></a>2.1.2.1 Vorbereitung</h4> <p>Die folgenden Schritte dienen der Vorbereitung der Installation.</p> @@ -134,9 +134,9 @@ <dd> Entpacken Sie die Datei <code>moa-spss-3.1.x.zip</code> in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als <code>$MOA_SPSS_INST</code> bezeichnet. </dd> <dt>Installation der Kryptographiebibliotheken von SIC/IAIK</dt> <dd> - <p>Kopieren Sie alle Dateien aus dem Verzeichnis <code>$MOA_SPSS_INST/ext</code> in das Verzeichnis <code>$JAVA_HOME/jre/lib/ext</code>. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden <span class="term">Unlimited Strength - - + <p>Kopieren Sie alle Dateien aus dem Verzeichnis <code>$MOA_SPSS_INST/ext</code> in das Verzeichnis <code>$JAVA_HOME/jre/lib/ext</code>. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden <span class="term">Unlimited Strength + + Jurisdiction Policy Files</span> von der <a href="http://java.com/download" target="_blank">Java SE Downloadseite </a>und achten Sie darauf die für ihre verwendete Java SE Installation richtige Version zu nehmen. Anschließend folgen Sie der darin enthaltenen Installationsanweisung. </p> </dd> </dl> @@ -162,7 +162,7 @@ <p>Das MOA SP/SS Webservice kann <span class="term">remote</span> durch den Aufruf einer speziellen URL des Webservices dazu veranlasst werden, seine Konfiguration neu einzulesen (vergleiche Abschnitt <a href="#webservice_basisinstallation_installation_changeonthefly">2.1.2.5</a>). Der Zugriff auf diese URL ist durch eine Passwort-Abfrage geschützt, und kann nur von Tomcat-Benutzern aufgerufen werden, denen die Tomcat-Benutzer-Rolle <code>moa-admin</code> zugeordnet wurde.</p> <p> Um diese Benutzer-Rolle und einen oder mehrere Benutzer einzurichten, müssen in der Datei <code>$CATALINA_HOME/conf/tomcat-users.xml </code>unter dem Element <code><tomcat-users></code> sinngemäß folgende Einträge hinzugefügt werden: </p> <p> - <pre><role rolename="moa-admin"/> + <pre><role rolename="moa-admin"/> <user username="moa-chief" password="openSesam" roles="moa-admin"/> </pre> <p>Soll der Aufruf dieser URL niemandem ermöglicht werden, sind die oben beschriebenen Einträge einfach nicht vorzunehmen.</p> @@ -177,7 +177,7 @@ <ul> <li id="klein"><code>moa.spss.server.configuration</code>: Pfad und Name der zentralen Konfigurationsdatei für MOA SP/SS. Eine beispielhafte Konfigurationsdatei finden Sie <a href="../../../conf/moa-spss/spss.config.xml">hier</a>. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der <span class="term">Java Virtual Machine</span> interpretiert. Ist diese <span class="term">System Property</span> nicht gesetzt, wird automatisch eine im Webarchiv unter <code>WEB-INF/conf</code> enthaltene Default-Konfiguration herangezogen.</li> <li><code>iaik.esi.sva.configuration.location</code>: Pfad und Name der Konfigurationsdatei für die extendet PDF Validierung von MOA SP/SS. Eine beispielhafte Konfigurationsdatei finden Sie <a href="../../../conf/moa-spss/svaconfig.example">hier</a>. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der <span class="term">Java Virtual Machine</span> interpretiert. </li> - <li id="klein"><code>log4j.configuration</code>: URL der Log4j Konfigurationsdatei. Eine beispielhafte Log4j-Konfiguration finden Sie <a href="../../../conf/moa-spss/log4j.properties">hier</a>. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der <span class="term">Java Virtual Machine</span> interpretiert. Ist diese <span class="term">System Property</span> nicht gesetzt, wird automatisch eine im Webarchiv unter <code>WEB-INF/classes</code> enthaltene Default-Konfiguration herangezogen.</li> + <li id="klein"><code>logback.configurationFile</code>: URL der LogBack Konfigurationsdatei. Eine beispielhafte LogBack-Konfiguration finden Sie <a href="../../../conf/moa-spss/logback.xml">hier</a>. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der <span class="term">Java Virtual Machine</span> interpretiert. Ist diese <span class="term">System Property</span> nicht gesetzt, wird automatisch eine im Webarchiv unter <code>WEB-INF/classes</code> enthaltene Default-Konfiguration herangezogen.</li> <li id="klein"><code>moa.node.id</code>: Frei wählbarer Name des Rechner-Knotens, auf dem MOA SP/SS läuft. Der Name des Knotens wird bei Log-Ausgaben von MOA SP/SS angeführt und dient zur Unterscheidung mehrerer gleichzeitig betriebener MOA SP/SS Webservice-Instanzen. </li> <li id="klein"><code>javax.net.ssl.trustStore</code>: Pfad und Dateiname des <span class="term">Truststores</span> für vertrauenswürdige SSL Client-Zertifikate (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). Ein relativer Pfad werden relativ zum Startverzeichnis der <span class="term">Java Virtual Machine</span> interpretiert.</li> <li id="klein"><code>javax.net.ssl.trustStorePassword</code>: Passwort für den <span class="term">Truststore</span> (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). </li> @@ -221,7 +221,7 @@ In diesem Fall geben die <code>WARN</code> bzw. <code>ERROR</code> Log-Meldungen <pre> http://<host>:<port>/moa-spss/ConfigurationUpdate </pre> <p>Damit dies funktioniert, muss in der Konfiguration von Tomcat ein spezieller Benutzer sowie eine spezielle Benutzerrolle eingerichtet werden (vergleiche Abschnitt <a href="#webservice_basisinstallation_installation_tomcatconfig_moaadmin">2.1.2.2.3</a>). </p> <h3><a name="webservice_basisinstallation_logging" id="webservice_basisinstallation_logging"></a>2.1.3 Logging </h3> -<p>Das MOA SP/SS Webservice verwendet <a href="#referenziertesoftware">Log4j</a> für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Log4j bietet zahlreiche Konfigurationsmöglichkeiten, die ausführlich im Log4j Handbuch beschrieben sind. Unter anderem gibt es die Möglichkeit, folgende Einstellungen vorzunehmen: +<p>Das MOA SP/SS Webservice verwendet <a href="#referenziertesoftware">LogBack</a> für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. LogBack bietet zahlreiche Konfigurationsmöglichkeiten, die ausführlich im LogBack Handbuch beschrieben sind. Unter anderem gibt es die Möglichkeit, folgende Einstellungen vorzunehmen: <ul> <li id="klein"> <p>Das verwendete Log-Level (<code>DEBUG</code>, <code>INFO</code>, <code>WARN</code>, <code>ERROR</code>, <code>FATAL</code>);</p> @@ -242,10 +242,10 @@ In diesem Fall geben die <code>WARN</code> bzw. <code>ERROR</code> Log-Meldungen <p><code>iaik.server</code> für alle Log-Meldungen aus den SIC/IAIK Kryptographie-Modulen. </p> </li> </ul> - <p>Eine für MOA SP/SS passende Konfigurationsdatei für Log4j finden Sie <a href="../../../conf/moa-spss/log4j.properties">hier</a>. Wird diese Datei als Logging-Konfiguration verwendet, so werden alle Log-Meldungen sowohl in die Konsole, als auch in die Datei <code>moa-spss.log</code> geschrieben. </p> + <p>Eine für MOA SP/SS passende Konfigurationsdatei für LogBack finden Sie <a href="../../../conf/moa-spss/logback.xml">hier</a>. Wird diese Datei als Logging-Konfiguration verwendet, so werden alle Log-Meldungen sowohl in die Konsole, als auch in die Datei <code>moa-spss.log</code> geschrieben. </p> <h4><a name="webservice_basisinstallation_logging_format" id="webservice_basisinstallation_logging_format"></a>2.1.3.1 Format der Log-Meldungen</h4> <p> Anhand einer konkreten Log-Meldung wird das Format der MOA SP/SS Log-Meldungen erläutert: </p> - <pre>INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=node1 + <pre>INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=node1 MSG=Starte neue Transaktion: TID=1049225059594-100, Service=SignatureVerification </pre> <p> Der Wert <code>INFO</code> besagt, dass die Log-Meldung im Log-Level <code>INFO</code> entstanden ist. Folgende Log-Levels existieren:</p> @@ -274,24 +274,24 @@ In diesem Fall geben die <code>WARN</code> bzw. <code>ERROR</code> Log-Meldungen <h4> <a name="webservice_basisinstallation_logging_messages" id="webservice_basisinstallation_logging_messages"></a>2.1.3.2 Wichtige Log-Meldungen</h4> <p> Neben den im Abschnitt <a href="#webservice_basisinstallation_installation_tomcatstartstop_verify">2.1.2.4.3</a> beschriebenen Log-Meldungen, die anzeigen, ob das Service ordnungsgemäß gestartet wurde, geben nachfolgenden Log-Meldungen Aufschluss über die Abarbeitung von Anfragen. </p> <p>Die Entgegennahme einer Anfrage wird angezeigt durch: - + </p> - <pre>INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> + <pre>INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> MSG=Starte neue Transaktion: TID=1049225059594-100, Service=SignatureVerification -INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> +INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> MSG=Aufruf von Adresse=127.0.0.1 -INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> +INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> MSG=Client-Zertifikat nicht verfügbar</pre> - <p> Die dritte Log-Meldung besagt, dass für die Abarbeitung dieser Anfrage kein Client-Zertifikat verfügbar ist (entweder, weil die Anfrage über HTTP eingelangt ist, oder weil die SSL Client-Authentisierung nicht eingeschaltet ist). Bei erfolgreicher SSL Client-Authentisierung, gibt beispielsweise folgende Log-Meldung Informationen über das Client-Zertifikat aus: - <pre>INFO | 12 13:58:08,772 | Thread-10 | TID=1045054687159-2 NID=<null> - MSG=Client-Zertifikat: Subject=CN=Testuser, OU=MOA, O=BRZ, L=Vienna, ST=Vienna, C=AT, + <p> Die dritte Log-Meldung besagt, dass für die Abarbeitung dieser Anfrage kein Client-Zertifikat verfügbar ist (entweder, weil die Anfrage über HTTP eingelangt ist, oder weil die SSL Client-Authentisierung nicht eingeschaltet ist). Bei erfolgreicher SSL Client-Authentisierung, gibt beispielsweise folgende Log-Meldung Informationen über das Client-Zertifikat aus: + <pre>INFO | 12 13:58:08,772 | Thread-10 | TID=1045054687159-2 NID=<null> + MSG=Client-Zertifikat: Subject=CN=Testuser, OU=MOA, O=BRZ, L=Vienna, ST=Vienna, C=AT, Serial=1.039.104.204, Issuer=CN=TestCA, OU=MOA, O=BRZ, L=Vienna, ST=Vienna, C=AT</pre> <p>Eine erfolgreich abgearbeitete Anfrage wird angezeigt durch: </p> - <pre>INFO | 01 21:25:53,168 | Thread-3 | TID=1049225059594-106 NID=<null> + <pre>INFO | 01 21:25:53,168 | Thread-3 | TID=1049225059594-106 NID=<null> MSG=Anfrage erfolgreich abgearbeitet</pre> <p>Ein Fehler beim Abarbeiten der Anfrage wird angezeigt durch: </p> - <pre>INFO | 01 21:25:27,642 | Thread-3 | TID=1049225059594-100 NID=<null> + <pre>INFO | 01 21:25:27,642 | Thread-3 | TID=1049225059594-100 NID=<null> MSG=Fehler beim Abarbeiten der Anfrage</pre> <div id="block"> <p>In diesem Fall gibt der mitgeloggte Stacktrace Auskunft über die Art des Fehlers. Der Aufrufer des MOA SP/SS Webservices bekommt einen Fehlercode sowie eine kurze Beschreibung des Fehlers als Antwort zurück. </p> @@ -355,11 +355,11 @@ INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> <p>Vergleiche auch Abschnitt <a href="../config/config.html#konfigurationsparameter_sp_certificatevalidation_revocationchecking_archiving">2.3.1.3.4</a> im Konfigurationshandbuch.</p> <h5><a name="webservice_erweiterungsmoeglichkeiten_datenbank_postgresql_logging" id="webservice_erweiterungsmoeglichkeiten_datenbank_postgresql_logging"></a>2.2.2.1.3 Logging</h5> - <p>Für das Logging in eine <span class="term">PostgreSQL</span> Datenbank mittels <span class="term">Log4j</span> muss zunächst eine Tabelle für die Log-Meldungen angelegt werden. Dies kann mit folgendem SQL-Statement erreicht werden:</p> + <p>Für das Logging in eine <span class="term">PostgreSQL</span> Datenbank mittels <span class="term">LogBack</span> muss zunächst eine Tabelle für die Log-Meldungen angelegt werden. Dies kann mit folgendem SQL-Statement erreicht werden:</p> <pre> create table spss_log (log_time timestamp, log_level varchar(5), log_msg text);</pre> - <p>Damit <span class="term">Log4j</span> die Log-Meldungen in diese Datenbanktabelle schreibt, muss die <span class="term">Log4j</span>-Konfiguration adaptiert werden. Die mit MOA SP/SS mitgelieferte, beispielhafte <a href="../../../conf/moa-spss/log4j.properties">Log4j-Konfiguration</a> enthält bereits die notwendigen Einträge für das Logging in eine PostgreSQL Datenbank, die jedoch standardmäßig ausgeschaltet sind. </p> + <p>Damit <span class="term">LogBack</span> die Log-Meldungen in diese Datenbanktabelle schreibt, muss die <span class="term">LogBack</span>-Konfiguration adaptiert werden. Die mit MOA SP/SS mitgelieferte, beispielhafte <a href="../../../conf/moa-spss/logback.xml">LogBack-Konfiguration</a> enthält bereits die notwendigen Einträge für das Logging in eine PostgreSQL Datenbank, die jedoch standardmäßig ausgeschaltet sind. </p> <p>Wie beim Caching von CRLs ist auch hier die Angabe einer <span class="term">JDBC</span>-URL notwendig, damit die MOA SP/SS Module eine Verbindung zur Datenbank aufnehmen können.</p> - <p><span class="remark">Bitte beachten Sie: Bei Tests hat sich das Logging in eine Datenbank mit Log4j als Performance-Engpass herausgestellt. Es wird deshalb empfohlen, dieses Feature mit Bedacht einzusetzen.</span></p> + <p><span class="remark">Bitte beachten Sie: Bei Tests hat sich das Logging in eine Datenbank mit LogBack als Performance-Engpass herausgestellt. Es wird deshalb empfohlen, dieses Feature mit Bedacht einzusetzen.</span></p> <h4><a name="webservice_erweiterungsmoeglichkeiten_datenbank_andere" id="webservice_erweiterungsmoeglichkeiten_datenbank_andere"></a>2.2.2.2 Andere Datenbanken </h4> <p>Über die generische Anbindung JDBC können auch andere Datenbanken für die Archivierung von CRLs bzw. für die Speicherung der Log-Meldungen eingesetzt werden. Hinweise zu bestimmten Datenbanken finden Sie in den <a href="../faq/faq.html">FAQ</a>. </p> <p>Die in Abschnitt <a href="#webservice_erweiterungsmoeglichkeiten_datenbank_postgresql">2.2.2.1</a> gemachten Angaben zu Archivierung von CRLs bzw. zur Speicherung von Log-Meldungen gelten sinngemäß. </p> @@ -374,11 +374,11 @@ INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> <p>Die Basisinstallation der Klassenbibliothek stellt einerseits die minimalen Anforderungen für den Einsatz von MOA SP/SS als Klassenbibliothek dar, andererseits dient sie als Ausgangspunkt für optionale Erweiterungsmöglichkeiten.</p> <p> Die <strong>Mindestanforderungen</strong> für die Basisinstallation sind: </p> <ul> - <li><a href="#referenziertesoftware">Java SE 7 oder höher</a></li> + <li><a href="#referenziertesoftware">Java SE 8 oder höher</a></li> </ul> <p>Wir <strong>empfehlen</strong> jedoch jeweils aktuelle Version zu verwenden:</p> <ul> - <li><a href="#referenziertesoftware">Java SE Update SE 8 (neuestes Update)</a></li> + <li><a href="#referenziertesoftware">Java SE Update SE 11 (neuestes Update)</a></li> </ul> <h3><a name="klassenbibliothek_basisinstallation_vorbereitung" id="klassenbibliothek_basisinstallation_vorbereitung"></a>3.1.2 Vorbereitung </h3> <p>Die folgenden Schritte dienen der Vorbereitung der Installation.</p> @@ -389,105 +389,11 @@ INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> <dd> Entpacken Sie die Datei <code>moa-spss-3.0.x-lib.zip</code> in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als <code>$MOA_SPSS_INST</code> bezeichnet. </dd> <dt>Installation der Kryptographiebibliotheken von SIC/IAIK</dt> <dd> - <p>Kopieren Sie alle Dateien aus dem Verzeichnis <code>$MOA_SPSS_INST/ext</code> in das Verzeichnis <code>$JAVA_HOME/jre/lib/ext</code>. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden <span class="term">Unlimited Strength - - + <p>Kopieren Sie alle Dateien aus dem Verzeichnis <code>$MOA_SPSS_INST/ext</code> in das Verzeichnis <code>$JAVA_HOME/jre/lib/ext</code>. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden <span class="term">Unlimited Strength + + Jurisdiction Policy Files</span> von der <a href="http://java.com/download" target="_blank">Java SE Downloadseite </a>und achten Sie darauf die für ihre verwendete Java SE Installation richtige Version zu nehmen. Anschließend folgen Sie der darin enthaltenen Installationsanweisung.</p> </dd> </dl> -<h3><a name="klassenbibliothek_basisinstallation_verwendung" id="klassenbibliothek_basisinstallation_verwendung"></a>3.1.3 Verwendung</h3> - <p> Um die MOA SP/SS Klassenbibliothek in einer Applikation verwenden zu können, müssen die mit MOA SP/SS ausgelieferten Bibliotheken in den Java Klassenpfad der Applikation eingebunden werden. </p> - <p>Die nachfolgende Tabelle listet diese Klassenbibliotheken auf; die Einträge in der Spalte Dateien sind relativ zum Verzeichnis <code>$MOA_SPSS_INST</code> zu interpretieren.</p> -<table class="fixedWidth" border="1" cellpadding="2"> - <tbody><tr> -<th>Klassenbibliothek</th><th>Version</th><th>Dateien</th> - -</tr><tr> -<td>MOA SP/SS</td> -<td>2.0.0 </td> -<td><code>moa-spss.jar</code>, <code>moa-common.jar</code></td> -</tr><tr> -<td>MOA IAIK</td> -<td><p>1.5<strong> </strong></p></td> -<td><p><code>lib/iaik_moa-1.5.jar</code>, - <code>lib/iaik_cms-4.1.jar</code>, <code>lib/iaik_ixsil-1.2.2.5.jar</code></p> - </td> -</tr> -<tr> - <td>Mail</td> - <td>1.4 </td> - <td><code>lib/mail-1.4.jar</code></td> -</tr> -<tr> - <td>Activation</td> - <td>1.1 </td> - <td><code>lib/activation-1.1.jar</code></td> -</tr> -<tr> -<td>Xerces-J</td> -<td>2.9.0 </td> -<td><code>lib/xercesImpl.jar</code></td> -</tr><tr> -<td>Xalan-J</td> -<td>2.7.1 </td> -<td><p><code>lib/xalan.jar</code>, <code>lib/xml-apis.jar</code>, <code>lib/serializer.jar</code></p> - <p class="remark">Bitte beachten Sie: Sie müssen diese Bibliothek gegebenenfalls der Java VM als endorsed bekanntgeben. Sie können dies tun, indem Sie entweder</p> - <ul> - <li class="remark">die Bibliothek in das (ggf. vorher anzulegende) Verzeichnis <code>$JAVA_HOME/jre/lib/endorsed/</code> kopieren; oder</li> - <li class="remark">die System Property <code>java.endorsed.dirs</code> verwenden, und als Wert den Pfad zu jenem Verzeichnis angeben, in dem Sie die Bibliothek vorhalten (also z.B. <code>java.endorsed.dirs=c:/mylibdir</code>).</li> - </ul></td> -</tr><tr> -<td>Jaxen</td><td>1.0 </td> -<td><code>lib/jaxen-1.0-FCS.jar</code>, <code>lib/saxpath-1.0-FCS.jar</code></td> - -</tr><tr> -<td>Commons-Logging</td> -<td>1.0.4 </td> -<td><code>lib/commons-logging-1.0.4.jar</code></td> -</tr><tr> -<td>Log4j</td> -<td>1.2.14 </td> -<td><code>lib/log4j-1.2.14.jar</code></td> -</tr> -<tr> - <td>Commons-Discovery</td><td>0.2 </td><td><code>lib/commons-discovery-0.2.jar</code></td> -</tr> -<tr> - <td>Postgres JDBC2</td><td>7.3 </td><td><p><code>lib/postgresql-7.2.jar</code></p> - <p><span class="remark">Bitte beachten Sie: Wenn Sie keine Datenbank für MOA SP/SS verwenden (vergleiche </span><a href="#webservice_erweiterungsmoeglichkeiten_datenbank">2.2.2</a><span class="remark">), benötigen Sie diese Bibliothek nicht.</span></p></td> -</tr><tr> -</tr> -<tr> - <td>Axis</td> - <td>1.0_IAIK/1.4 </td> - <td><code>lib/axis-1.0_iaik.jar, lib/axis-jaxrpc-1.4.jar, lib/axis-saaj-1.4.jar, lib/axis-wsdl4j-1.5.1.jar</code></td> -</tr> -</tbody></table> - - <h3><a name="klassenbibliothek_basisinstallation_logging" id="klassenbibliothek_basisinstallation_logging"></a>3.1.4 Logging</h3> - <p> Die MOA SP/SS Klassenbibliothek verwendet <a href="#referenziertesoftware">Log4j</a> für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Die im Abschnitt <a href="#webservice_basisinstallation_logging">2.1.3</a> gemachten Aussagen lassen sich großteils auf den Einsatz der MOA SP/SS Klassenbibliothek übertragen. </p> - <h2><a name="klassenbibliothek_erweiterungsmoeglichkeiten" id="klassenbibliothek_erweiterungsmoeglichkeiten"></a>3.2 Erweiterungsmöglichkeiten </h2> - <p>Die im Abschnitt <a href="#webservice_erweiterungsmoeglichkeiten">2.2</a> angeführten Erweiterungsmöglichkeiten für die MOA SP/SS Webservices gelten in analoger Weise auch für die Klassenbibliothek.</p> - <h1><a name="referenzierte_software"></a>A Referenzierte Software</h1> -<p>Auf folgende Software-Pakete wird in diesem Handbuch verwiesen:</p> -<table class="fixedWidth" border="1" cellpadding="2"> - <tr> - <th scope="col">Name</th> - <th scope="col">Beschreibung</th> - </tr> - <tr> - <td><a href="http://jakarta.apache.org/tomcat/index.html" target="_blank">Apache Tomcat </a></td> - <td>Apache Tomcat Servlet-Container</td> - </tr> - <tr> - <td><a href="http://java.com/" target="_blank">Java SE</a></td> - <td>Java Standard Edition (Software Development Kit bzw. Java Runtime Environment) </td> - </tr> - <tr> - <td><a href="http://logging.apache.org/log4j/1.2/" target="_blank"> Log4J </a></td> - <td>Logging Framework </td> - </tr> -</table> - </body> </html> |