diff options
Diffstat (limited to 'id/server/doc/proxy/handbook/id-admin_1.htm')
| -rw-r--r-- | id/server/doc/proxy/handbook/id-admin_1.htm | 549 |
1 files changed, 549 insertions, 0 deletions
diff --git a/id/server/doc/proxy/handbook/id-admin_1.htm b/id/server/doc/proxy/handbook/id-admin_1.htm new file mode 100644 index 000000000..08a1acc73 --- /dev/null +++ b/id/server/doc/proxy/handbook/id-admin_1.htm @@ -0,0 +1,549 @@ +<html> +<head> + <title>MOA ID-Administration</title> + <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> + <meta content="heinz.rosenkranz@brz.gv.at" name="author"/> + +<style type="text/css"> + body { font-family:"Verdana", "Arial"; font-size:10pt; color:#505060; } + td { font-family:"Verdana", "Arial"; font-size:10pt; color:#505060; } + th { font-family:"Verdana", "Arial"; font-size:10pt; font-weight:bold; color:#d8d8d8; background:#505050} + li { font-family:"Verdana", "Arial"; font-size:10pt; color:#505060; margin-top:3px } + ul { font-family:"Verdana", "Arial"; font-size:10pt; color:#505060; margin-top:3px } + tt { font-size:9pt; color:#505060; } + pre { font-size:9pt; color:#505060; } + #titel { font-family:"Verdana", "Arial"; font-size:18pt; color:#505060; } + #subtitel { font-family:"Verdana", "Arial"; font-size:12pt; font-weight:bold; color:#505060; } + #slogan { font-family:"Verdana", "Arial"; font-size:8pt; color:#808090; text-align:justify; width:160px } + #block { font-family:"Verdana", "Arial"; font-size:10pt; color:#505060; text-align:justify } + #klein { font-family:"Verdana", "Arial"; font-size:9pt; color:#505060; margin-top:3px } + #info { font-family:"Verdana", "Arial"; font-size:8pt; color:#505060; padding:3px; border:solid 1px #c0c0c0 } + #infolist { font-family:"Verdana", "Arial"; font-size:8pt; color:#505060; } + a:link {color:#000090} + a:visited {color:#000090} + a:hover {color:#c03030} + a {text-decoration: none} +</style> + +<script language="JavaScript"> +<!-- +function goWin(url) { + Fenster=window.open(url,"smallWin","toolbar=0,location=0,directories=0,status=0,menubar=0,resizable=yes,scrollbars=yes,width=500,height=480,top=20,screenY=0,left=20,screenX=0"); + window.setTimeout("showWin()",300); +} +function showWin() { Fenster.focus(); } +// --> +</script> +</head> + +<body bgcolor="#FFFFFF" > +<div style="width:650px"> + +<!-- Projekt-Logo --> +<div style="height:42px; font-size:16pt; color:#b0b8c0; background:#003050"> + Module für Online-Applikationen +</div> +<div style="margin-left:8px; margin-top:3px; font-size:8pt; color:#707070; "> +<!-- Development Center der BRZ GmbH, A-Trust und IAIK Graz -->  +</div> +<div style="margin-top:-65px; text-align:right; font-size:8pt; font-weight:bold; color:#d04040;" > +Projekt <span style="font-size:48pt; ">moa</span>  +</div> +<br /> + +<!-- First Section with Navigation --> +<table width="650" border="0" cellpadding="10" cellspacing="0"> +<tr> +<td width="170" valign="top"> +<div style="font-weight:bold; margin-top:12px">MOA-ID</div><br /> +<div id="klein"><a href="id-admin.htm"><img src="../moa_images/idle.gif" border="0" width="13" height="14" /> + <b> Übersicht</b></a></div> +<div id="klein"><img src="../moa_images/select.gif" border="0" width="13" height="14" /> + <b> Basis-Installation</b></div> +<div id="klein"><a href="id-admin_2.htm"><img src="../moa_images/idle.gif" border="0" width="13" height="14" /> + <b> Konfiguration </b></a></div> +<div id="klein"><a href="id-admin_3.htm"><img src="../moa_images/idle.gif" border="0" width="13" height="14" /> + <b> Optionale<br />    Komponenten</b></a></div> +<br /> +<div id="klein"><a href="moa.htm"><img src="../moa_images/west.gif" border="0" width="13" height="14" /> + <b> Zurück</b></a></div> +<br /> +<div id="slogan"> +<b>Installationsschritte: </b> +<br /> +<a href="#vorbereitung"><b>Vorbereitung</b></a><br /> +<a href="#Tomcat"><b>Tomcat Konfiguration</b></a><br /> +<a href="#deployment_ak"><b>Deployment<br/>MOA-ID-AUTH</b></a><br /> +<a href="#deployment_pk"><b>Deployment<br/>MOA-ID-PROXY</b></a><br /> +<a href="#Tomcat_Start"><b>Tomcat Start/Stop</b></a><br /> +<a href="#Logging"><b>Logging</b></a><br /> +</div> +</td> + +<td valign="top"> +<p id="titel">Basis-Installation v.1.5</p> +Bei der Basis-Installation von MOA-ID-AUTH und von MOA-ID-PROXY ist grundsätzlich gleichartig vorzugehen. +Unterschiede sind in der Installationsanweisung angeführt. +<div id="vorbereitung" /> +<p id="subtitel">Vorbereitung</p> +<div id="block"> + <p><b>Installation des JDK</b><br /> + Installieren Sie das JDK in ein + beliebiges Verzeichnis. Das Wurzelverzeichnis der JDK-Installation + wird im weiteren Verlauf als $JAVA_HOME bezeichnet. <br /> + <br /> + <b>Installation von Tomcat</b><br /> + Installieren Sie Tomcat in ein Verzeichnis, das <b>keine Leer- und + Sonderzeichen</b> im Pfadnamen enthält. Am Besten verwenden + die referenzierte Version von Tomcat im zip-Format. (Hinweis f. + Windows: nicht die selbstinstallierende exe Version verwenden.) + Das Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf + als $CATALINA_HOME bezeichnet.<br /> + <br /> + <b>Entpacken der MOA ID Webapplikation</b><br /> + Entpacken Sie die ausgelieferten Dateien der Webapplikation (moa-id-auth-x.y.zip + oder moa-id-proxy-x.y.zip; ersetzen Sie x.y durch die Releasenummer + von MOA-ID-AUTH bzw. MOA-ID-PROXY) in ein beliebiges Verzeichnis. + Diese Verzeichnisse werden im weiteren Verlauf als $MOA_ID_INST_AUTH + bzw. $MOA_ID_INST_PROXY bezeichnet. <br /> + <br /> + <b>Installation der IAIK JCE und des IAIK LDAP Protocol Handlers</b><br /> + Die Dateien aus dem Verzeichnis $MOA_ID_INST_AUTH/ext (oder $MOA_ID_INST_PROXY/ext) + müssen in das Verzeichnis $JAVA_HOME/jre/lib/ext kopiert werden. + Anschließend steht eine Unterstützung für Kryptographie + und SSL jeder Java-Anwendung die dieses JDK verwendet zur Verfügung.<br> + <br /> + Zusätzlich müssen die so genannten Unlimited Strength + Jurisdiction Policy Files heruntergeladen, entpackt + und ins Verzeichnis $JAVA_HOME/jre/lib/security kopiert werden. </p> + <p>Der Download für diese Dateien findet sich am unteren Ende + der Download-Seite des jeweiligen JDK in der Sektion "Other + Downloads". D.h. JDK <a href="http://java.sun.com/j2se/1.4.0/download.html"> + hier für 1.4.0</a>, das JDK <a href="http://java.sun.com/j2se/1.4.2/download.html">hier + für 1.4.2</a>, das JDK <a href="http://java.sun.com/j2se/1.5.0/download.html">hier + für 1.5.0</a> bzw. das JDK <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">hier + für 1.6.0</a></p> + </div> + +</td></tr></table> + +<div id="Tomcat" /> +<table width="650" border="0" cellpadding="10" cellspacing="0"> +<td width="170" valign="top" id="klein"> +<p id="subtitel"> </p> +<div id="slogan"> +<br /><br /> +</div> +</td> +<td valign="top"> +<p id="subtitel">Konfiguration von Tomcat</p> +<div id="block"> +<b>Minimale Konfiguration</b> <br /> +Die zentrale Konfigurations-Datei von Tomcat ist $CATALINA_HOME/conf/server.xml. Tomcat wird grundsätzlich mit +einer funktionierenden Default-Konfiguration ausgeliefert, die jedoch einiges an Ballast enthält und viele Ports +offen lässt. Die Datei server.xml im Verzeichnis mit der Versionsnummer des verwendeten Tomcats unter $MOA_ID_INST_AUTH/tomcat (bzw. $MOA_ID_INST_PROXY/tomcat) enthält eine minimale +Tomcat-Konfiguration, die je einen Connector für HTTP und für HTTPS freischaltet. Die jeweilige Datei server.mod_jk.xml schaltet zusätzlich den AJP Connector Port für den Apache Webserver frei (falls diese Datei verwendet werden soll ist sie zuvor noch auf server.xml umzubenennen).<br /><br /> +<b>SSL</b><br /> +Für den sicheren Betrieb von MOA-ID-AUTH ist die Verwendung von SSL Voraussetzung, sofern nicht ein vorgelagerter WebServer (Apache oder IIS) das SSL-Handling übernimmt. +Ebenso kann SSL auch für MOA-ID-PROXY verwendet werden. +Das Dokument <a href="http://jakarta.apache.org/tomcat/tomcat-4.1-doc/ssl-howto.html" target="_new">Tomcat SSL Configuration HOW-TO</a> gibt einen guten Überblick über die Konfiguration von SSL in Tomcat. Da die für SSL notwendigen Bibliotheken bereits im Abschnitt "Vorbereitung" eingebunden wurden, sind nur noch folgende Schritte notwendig: +</div> +<ul> +<li>Erstellung eines Server-Keystores, welches den privaten Schlüssel des Servers sowie das Server-Zertifikat enthält, +z.B. mit dem <a href="http://java.sun.com/j2se/1.3/docs/tooldocs/win32/keytool.html" target="_new"> Java Keytool</a>. <br /> +<b>Hinweis:</b> Standardmäßig wird beim Erzeugen eines neuen Keystores im Home-Verzeichnis des Benutzers die Datei ".keystore" angelegt. Möchte man den Dateinamen und Pfad ändern, kann man das dem SSL-Connector in $CATALINA_HOME/conf/server.xml durch hinzufügen des Attributes <i>keystoreFile="NAME DES KEYSTORES"</i> im Element <Factory> bekannt machen. Das zum Keystore gehörende Passwort übergibt man Tomcat mittels des Attributes <i>keystorePass= "PASSWORT DES KEYSTORES"</i> im Element <Factory>. </li> +<li>Erstellung eines Keystores mit vertrauenswürdigen Client-Zertifikaten, z.B. mit dem <a href="http://java.sun.com/j2se/1.3/docs/tooldocs/win32/keytool.html" target="_new"> Java Keytool</a> (nur, wenn SSL Client-Authentisierung verwendet werden soll) </li> +<li>Falls eine Client-Authentisierung gewünscht ist, muss die Konfiguration des SSL-Connectors in $CATALINA_HOME/conf/server.xml angepasst werden.</li> +</ul> + +<div id="block"> +<b>MOA Administrator</b><br /> +Der Aufruf der URL für die dynamische Konfiguration von MOA-ID-AUTH ist durch eine Passwort-Abfrage geschützt, und kann nur von Benutzern aufgerufen werden, die der Benutzer-Rolle <tt>moa-admin</tt> zugeordnet werden können.<br /> +Um diese Benutzer-Rolle und einen oder mehrere Benutzer einzurichten, müssen in der Datei $CATALINA_HOME/conf/tomcat-users.xml unter dem Element <tt><tomcat-users></tt> sinngemäß folgende Einträge hinzugefügt werden: +<pre> +<role rolename="moa-admin"/> +<user username="moa" password="moa" roles="moa-admin"/> +</pre> +</div> +</td></tr></table> + +<div id="deployment_ak" /> +<table width="650" border="0" cellpadding="10" cellspacing="0"> +<td width="170" valign="top" id="klein"> +<p id="subtitel"> </p> +<div id="slogan"> +<br /><br /> +</div> +</td> +<td valign="top"> +<p id="subtitel">Deployment von MOA-ID-AUTH in Tomcat</p> +<div id="block"> +Um MOA-ID-AUTH in Tomcat für den Ablauf vorzubereiten, sind folgende Schritte notwendig: <br /> + <ul> + <li>Die Datei $MOA_ID_INST_AUTH/moa-id-auth.war wird ins Verzeichnis + $CATALINA_HOME/webapps kopiert. Dort wird sie beim ersten Start + von Tomcat automatisch ins Verzeichnis $CATALINA_HOME/webapps/moa-id-auth + entpackt. </li> + <li>Die MOA-ID Konfigurationsdatei und die zugehörigen Verzeichnisse + "certs" und "transforms" werden in ein beliebiges Verzeichnis + im Filesystem kopiert (z.B. $CATALINA_HOME/conf/moa-id). <br /> + Im Verzeichnis $MOA_ID_INST_AUTH/conf/moa-id befinden sich + acht verschiedene Beispielkonfigurationen, die als Ausgangspunkte + für die Konfiguration von MOA-ID-AUTH dienen können: + <ul> + <li>SampleMOAIDConfiguration.xml: Konfiguration von MOA-ID für + eine Anwendung aus dem öffentlichen Bereich. + <br>Karte: Bürgerkarte + <br>Konfiguration ohne Proxykomponente</li> + <li>SampleMOAIDConfiguration_withTestBKs.xml: Konfiguration von MOA-ID + für eine Anwendung aus dem öffentlichen Bereich. + <br>Karte: Bürgerkarte und Testkarte + <br>Konfiguration ohne Proxykomponente</li> + <li>SampleMOAWIDConfiguration.xml: Konfiguration von MOA-ID für + eine Anwendung aus dem privatwirtschaftlichen Bereich (MOA-WID Modus). + <br>Karte: Bürgerkarte + <br>Konfiguration ohne Proxykomponente</li> + <li>SampleMOAWIDConfiguration_withTestBKs.xml: Konfiguration von MOA-ID für + eine Anwendung aus dem privatwirtschaftlichen Bereich (MOA-WID Modus). + <br>Karte: Bürgerkarte und Testkarte + <br>Konfiguration ohne Proxykomponente</li> + <li id="sampleProxyConfig">SampleMOAIDConfigurationProxy.xml: Konfiguration von MOA-ID für + eine Anwendung aus dem öffentlichen Bereich. + <br>Karte: Bürgerkarte + <br>Konfiguration mit <a href="#deployment_pk">Proxykomponente</a>.</li> + <li>SampleMOAIDConfiguration_withTestBKsProxy.xml: Konfiguration von MOA-ID + für eine Anwendung aus dem öffentlichen Bereich. + <br>Karte: Bürgerkarte und Testkarte + <br>Konfiguration mit <a href="#deployment_pk">Proxykomponente</a></li> + <li>SampleMOAWIDConfigurationProxy.xml: Konfiguration von MOA-ID für + eine Anwendung aus dem privatwirtschaftlichen Bereich (MOA-WID Modus). + <br>Karte: Bürgerkarte + <br>Konfiguration mit <a href="#deployment_pk">Proxykomponente</a></li> + <li>SampleMOAWIDConfiguration_withTestBKsProxy.xml: Konfiguration von MOA-ID für + eine Anwendung aus dem privatwirtschaftlichen Bereich (MOA-WID Modus). + <br>Karte: Bürgerkarte und Testkarte + <br>Konfiguration mit <a href="#deployment_pk">Proxykomponente</a></li> + </ul> + </li> + <li>Die endorsed Libraries für Tomcat müssen aus dem + Verzeichnis $MOA_ID_INST_AUTH/endorsed in das Tomcat-Verzeichnis + $CATALINA_HOME/common/endorsed kopieren werden. Für Tomcat 6 müssen die Dateien in das Verzeichnis $CATALINA_HOME/endorsed kopiert werden (das Verzeichnis endorsed ist dabei im Allgemein erst anzulegen). Folgende Libraries + sind für das Deployment im endorsed Verzeichnis vorgesehen: + <ul> + <li>xalan.jar</li> + <li>serializer.jar (für Xalan benötigt)</li> + <li>xml-apis.jar</li> + <li id="klein">xercesImpl.jar</li> + </ul> + Eventuell vorhandene Dateien mit dem gleichen Namen müssen + ersetzt werden. Die ggf. in diesem Verzeichnis vorhandene Datei + <code>xmlParserAPIs.jar</code> muss gelöscht werden.</li> + <li>Folgende Java System Properties sind zu setzen: <br /> + <ul id="klein"> + <li id="klein">moa.id.configuration=Name der MOA ID Konfigurationsdatei. + Eine beispielhafte MOA ID Konfiguration ist in $MOA_ID_INST_AUTH/conf/moa-id/ + SampleMOAIDConfiguration.xml enthalten.</li> + <li id="klein">log4j.configuration=URL der Log4j Konfigurationsdatei. + Eine beispielhafte Log4j-Konfiguration ist in $MOA_ID_INST_AUTH/conf/moa-id/log4j.properties + enthalten. </li> + <li id="klein">javax.net.ssl.trustStore=Name des Truststores + für vertrauenswürdige SSL Client-Zertifikate (optional; + nur, wenn SSL Client-Authentisierung durchgeführt werden + soll). <br> + </li> + </ul> + Diese Java System-Properties werden Tomcat über die Umgebungsvariable + CATALINA_OPTS mitgeteilt (Beispiel-Skripte zum Setzen dieser + Properties für <b>Windows</b> und für <b>Unix bzw. + Linux</b> finden sie unter $MOA_ID_INST_AUTH/tomcat/win32 bzw. + $MOA_ID_INST_AUTH/tomcat/unix). Diese Skripte können sie nach $CATALINA_HOME kopieren und in Folge von dort starten nachdem die Variablen CATALINA_HOME sowie JAVA_HOME in den Skripten entsprechend den Pfaden der Installation gesetzt wurden. + </ul> +</div> +</td></tr></table> + + +<div id="deployment_pk" /> +<table width="650" border="0" cellpadding="10" cellspacing="0"> +<td width="170" valign="top" id="klein"> +<p id="subtitel"> </p> +<div id="slogan"> +<br /><br /> +</div> +</td> +<td valign="top"> +<p id="subtitel">Deployment von MOA-ID-PROXY in Tomcat</p> +<div id="block"> +Um MOA-ID-PROXY in Tomcat für den Ablauf vorzubereiten, sind folgende Schritte notwendig: +<br /> + <ul> + <li> + <b>Für Tomcat 4.1.31:</b> + <ul> + <li>Die Datei $MOA_ID_INST_PROXY/moa-id-proxy.war wird in ein + beliebiges Verzeichnis (bspw. $CATALINA_HOME/webappsProxy) kopiert. <b>HINWEIS: + Das Verzeichnis darf sich NICHT unterhalb $CATALINA_HOME/webapps befinden!</b><br/> + </li> + <li>Anschließend muss in der Datei <tt>$CATALINA_HOME/conf/server.xml</tt> der + Tomcat-Root-Context auf diese Datei gesetzt werden: wenn + das war-file sich in $CATALINA_HOME/webappsProxy befindet, geschieht dies + mit dem Einfügen von folgendem Element innerhalb von + <tt><Server>...<Service>...<Engine>...<Host></tt>: + <pre><Context path="" + docBase="../webappsProxy/moa-id-proxy.war" + debug="0"/></pre> + Anmerkung: Der Root-Context von Tomcat ist normalerweise auskommentiert. + </li> + </ul> + </li> + <li> + <b>Für Tomcat 5.0.28:</b> + <ul> + <li>Die Datei $MOA_ID_INST_PROXY/moa-id-proxy.war ist in ein + beliebiges Verzeichnis (bspw. $CATALINA_HOME/webappsProxy) <b>zu entpacken</b> + (diese Datei ist mittels ZIP Algorithmus komprimiert und kann mit jedem Tool, + das mit .ZIP-Dateien umgehen kann, geöffnet werden). <b>HINWEIS: + Das Verzeichnis darf sich NICHT unterhalb $CATALINA_HOME/webapps befinden!</b><br/> + </li> + <li>Anschließend muss in der Datei <tt>$CATALINA_HOME/conf/server.xml</tt> der + Tomcat-Root-Context auf diese Datei gesetzt werden: wenn die Proxy Web-Applikation + nach $CATALINA_HOME\webappsProxy entpackt wurde, geschieht dies mit dem Einfügen + von folgendem Element innerhalb von + <tt><Server>...<Service>...<Engine>...<Host></tt>: </li> + <pre><Context path="" docBase="../webappsProxy" + debug="0"/></pre> + Alternativ kann statt die Datei server.xml zu ändern in <tt>$CATALINA_HOME\conf\Catalina\localhost</tt> eine Datei moa-id-proxy.xml mit vorhin angegebenen Inhalt erstellt werden. + </ul> + </li> + </ul> + + <br /> + <b>Tomcat Konfiguration:</b> + <ul> + <li>Die MOA-ID Konfigurationsdatei und die zugehörigen + Verzeichnisse "certs" und "oa" werden in ein beliebiges Verzeichnis + im Filesystem kopiert (z.B. $CATALINA_HOME/ conf/moa-id). + <br /> + Im Verzeichnis $MOA_ID_INST_PROXY/conf/moa-id befinden sich + vier verschiedene <a href="#sampleProxyConfig">Beispielkonfigurationen</a>, + die als Ausgangspunkte für die Konfiguration von MOA-ID-PROXY + dienen können. + </li> + <li>Die endorsed Libraries für Tomcat müssen aus dem + Verzeichnis $MOA_ID_INST_PROXY/endorsed in das Tomcat-Verzeichnis + $CATALINA_HOME/common/endorsed kopiert werden. Folgende Libraries + sind für das Deployment im endorsed Verzeichnis vorgesehen: + <ul> + <li id="klein">Xerces-J-2.4.0 (bestehend aus xercesImpl.jar + und xmlParserAPIs.jar)</li> + </ul> + Eventuell vorhandene Dateien mit dem gleichen Namen müssen + ersetzt werden. + </li> + <li>Folgende Java System Properties sind zu setzen: <br /> + <ul id="klein"> + <li id="klein">moa.id.configuration=Name der MOA ID Konfigurationsdatei. + Eine beispielhafte MOA ID Konfiguration ist in $MOA_ID_INST_AUTH/conf/moa-id/ + SampleMOAIDConfiguration.xml enthalten.</li> + <li id="klein">log4j.configuration=URL der Log4j Konfigurationsdatei. + Eine beispielhafte Log4j-Konfiguration ist in $MOA_ID_INST_AUTH/conf/moa-id/log4j.properties + enthalten. </li> + <li id="klein">javax.net.ssl.trustStore=Name des Truststores + für vertrauenswürdige SSL Client-Zertifikate + (optional; nur, wenn SSL Client-Authentisierung durchgeführt + werden soll). </li> + </ul> + </li> + Diese Java System-Properties werden Tomcat über die Umgebungsvariable + CATALINA_OPTS mitgeteilt (siehe Deployment von MOA-ID-AUTH <a href="examples/moa-id-env.sh.txt">moa-id-env.sh.txt</a>). + <br> + <br> + Beispiel-Skripts zum Setzen von CATALINA_OPTS und zum Starten + von Tomcat sind in $MOA_ID_INST_AUTH\tomcat\ zu finden - Sie + können diese für Ihre Zwecke adaptieren (JAVA_HOME + und $CATALINA_HOME setzen) und nach $CATALINA_HOME kopieren. + </ul> +</div> +</td></tr></table> + +<div id="Tomcat_Start" /> +<table width="650" border="0" cellpadding="10" cellspacing="0"> +<td width="170" valign="top" id="klein"> +<p id="subtitel"> </p> +<div id="slogan"> +<br /><br /> +</div> +</td> +<td valign="top"> +<p id="subtitel">Starten und Stoppen von Tomcat </p> + <div id="block"> Nach dem Deployment und der Konfiguration kann + Tomcat aus seinem Wurzelverzeichnis ($CATALINA_HOME) mit <br /> + <pre> + startTomcat (unter Windows) oder + moa-id-env.sh + bin/catalina.sh start (unter Unix/Linux) +</pre> +gestartet werden. Das Stoppen von Tomcat erfolgt analog mit <br /> +<pre> + bin\catalina stop (unter Windows) oder + bin/catalina.sh stop (unter Unix/Linux) +</pre> +Ein erfolgreicher Startvorgang von MOA-ID-AUTH ist an folgender Log-Meldung ersichtlich: <br /> +<pre> + INFO | 08 13:33:38,497 | main | + MOA ID Authentisierung wurde + erfolgreich gestartet +</pre> +Analog bei MOA-ID-PROXY: <br/> +<pre> + INFO | 08 13:35:49,876 | main | + MOA ID Proxy wurde erfolgreich gestartet +</pre> + +Nach dem erfolgreichen Starten von Tomcat steht MOA-ID-AUTH unter der URL +<pre> +http(s)://host:port/moa-id-auth/StartAuthentication +</pre> +zur Verfügung. Der WebService ist unter +<pre> +http(s)://host:port/moa-id-auth/services/GetAuthenticationData +</pre> +<p>erreichbar. Die Verfügbarkeit der Anwendung kann überprüft werden, indem die URLs mit einem Web-Browser aufgerufen werden.</p> +<p><strong>Musterseite (MOA-Template zur Bürgerkartenauswahl)</strong><br /> +Nach dem erfolgreichen Starten von Tomcat steht eine Musterseite unter der URL</p> +<pre> +http(s)://host:port/moa-id-auth/index.html</pre> +<p>zur Verfügung. Diese Musterseite bietet eine integrierte Darstellung der Bürgerkartenauswahl bei MOA-ID. Die Musterseite stellt dabei beispielhaft dar, wie eine Bürgerkartenauswahl möglichst nahtlos in MOA-ID integriert werde kann. Sie umfaßt dabei vorkonfigurierte Loginmöglichkeiten mittels Online-BKU, lokaler BKU und Handy-BKU. <em>Anmerkung</em>: Um sich über die Musterseite einloggen zu können, müssen noch die Parameter für den MOA-ID Aufruf angegeben werden - siehe Dokumentation der Musterseite, die über die Musterseite verlinkt ist bzw. über folgende URL abgerufen werden kann</p> +<pre> +http(s)://host:port/moa-id-auth/BKAuswahl-MOA-Template-Howto.pdf </pre> +<p><b>Dynamische Konfigurations-Updates</b><br /> + Dynamische Konfigurations-Updates können für MOA-ID-AUTH durch den Aufruf der URL http://hostname:port/moa-id-auth/ConfigurationUpdate (z.B. durch Eingabe in einem Browser) durchgeführt werden. Analog wird die Konfiguration von MOA-ID-PROXY mittels http://hostname:port/ConfigurationUpdate aktualisiert.<br /> + <br /> + <b>Hinweis: </b>Konfigurationsänderungen für die Online-Applikationen betreffen grundsätzlich sowohl die Auth- als auch die Proxy-Komponente. +Wenn bspw. das <tt>publicURLPrefix</tt> der OA geändert wird, muss sowohl für die Auth- als auch für die Proxy-Komponente ein ConfigurationUpdate durchgeführt werden. <br /> +<br /> +Konnte MOA-ID-AUTH bzw. MOA-ID-PROXY nicht ordnungsgemäß konfiguriert und gestartet werden, geht das aus der Log-Meldung hervor: <br /> +</p> +<pre> +FATAL | 03 13:19:06,924 | main | Fehler + beim Starten des Service MOA ID Authentisierung +</pre> +bzw. +<pre> +FATAL | 03 13:19:06,924 | main | Fehler + beim Starten des Service MOA ID Proxy +</pre> +In diesem Fall geben die WARN bzw. ERROR Log-Meldungen unmittelbar davor Aufschluss über den genaueren Grund. <br /> +</div> +</td></tr></table> + + +<div id="Logging" /> +<table width="650" border="0" cellpadding="10" cellspacing="0"> +<td width="170" valign="top" id="klein"> +<p id="subtitel"> </p> +<div id="slogan"> +<br /><br /> +</div> +</td> +<td valign="top"> +<div id="Logging" /> +<p id="subtitel">Logging</p> +<div id="block"> +Die MOA ID Webapplikation verwendet Jakarta Log4j für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Log4j bietet zahlreiche Konfigurationsmöglichkeiten, die ausführlich im <a href="http://jakarta.apache.org/log4j/docs/manual.html" target="_new">Log4j Handbuch</a> beschrieben sind. Unter anderem gibt es die Möglichkeit, folgende Einstellungen vorzunehmen: <br /> +<ul> +<li id="klein">Das verwendete Log-Level (DEBUG, INFO, WARN, ERROR, FATAL).</li> +<li id="klein">Name und maximale Größe der Log-Datei(en).</li> +<li id="klein">Das Aussehen der Log-Einträge.</li> +</ul> +Es werden folgende Log-Hierarchien verwendet: +</div> +<ul> +<li>moa.id.auth für alle Log-Meldungen aus dem MOA-ID-AUTH Modul </li> +<li>moa.id.proxy für alle Log-Meldungen aus dem MOA-ID-PROXY Modul </li> +<li>moa.spss.server für alle Log-Meldungen aus dem MOA-SPSS Modul </li> +<li>iaik.server für alle Log-Meldungen aus den IAIK Kryptographie-Modulen </li> +</ul> +<div id="block"> +Als Ausgangspunkt für die Logging-Konfiguration liegt die Datei $MOA_ID_INST_AUTH/conf/moa-id/log4j.properties (bzw. $MOA_ID_INST_PROXY/conf/moa-id/log4j.properties) bei. +Wird diese Datei als Logging-Konfiguration verwendet, so werden alle Log-Meldungen sowohl in die Konsole, als auch in die Datei <tt>$CATALINA_HOME/logs/moa-id.log</tt> geschrieben. +<br /><br /> +<b>Format der Log-Meldungen</b><br /> +Anhand einer konkreten Log-Meldung wird das Format der MOA ID Log-Meldungen erläutert: +<pre> + INFO | 09 08:23:59,385 | Thread-8 | + Anmeldedaten zu MOASession -5468974113772848113 + angelegt, SAML Artifakt + AAF/BrdRfnMaQVGIbP/Gf9OwDUwwsXChb7nuT+VXQzOoHbV +</pre> + +Der Wert <tt>INFO</tt> besagt, dass die Log-Meldung im Log-Level <tt>INFO</tt> entstanden ist. Folgende Log-Levels existieren:<br /> +<ul> +<li id="klein"><tt>DEBUG:</tt> Log-Meldungen im Log-Level <tt>DEBUG</tt> geben Auskunft über die innere Arbeitsweise des Systems. Sie sind hauptsächlich für Entwickler interessant.</li> +<li id="klein"><tt>INFO:</tt> Diese Log-Meldungen geben informative Status-Informationen über den Ablauf der Webapplikation, wie z.B., dass eine neue Anfrage eingelangt ist.</li> +<li id="klein"><tt>WARN:</tt> Bei der Ausführung einer Operation sind leichte Fehler aufgetreten. Der Ablauf der Webapplikation ist nicht weiter beeinträchtigt.</li> +<li id="klein"><tt>ERROR:</tt> Die Ausführung einer Operation musste abgebrochen werden. Die Webapplikation ist davon nicht beeinträchtigt. </li> +<li id="klein"><tt>FATAL:</tt> Es ist ein Fehler aufgetreten, der den weiteren Betrieb der Webapplikation nicht mehr sinnvoll macht.</li> +</ul> +Der nächste Wert <tt>09 08:23:59,385</tt>, gibt den Zeitpunkt an, an dem die Log-Meldung generiert wurde (in diesem Fall den 9. Tag im aktuellen Monat, sowie die genaue Uhrzeit). <br /> +Der Rest der Zeile einer Log-Meldung ist der eigentliche Text, mit dem das System bestimmte Informationen anzeigt. Im Fehlerfall ist häufig ein Java Stack-Trace angefügt, der eine genauere Ursachen-Forschung ermöglicht. +<br /><br /> + + +<b>Wichtige Log-Meldungen</b><br /> +Neben den im Abschnitt "Starten und Stoppen von Tomcat" beschriebenen Log-Meldungen, die anzeigen, ob die Webapplikation +ordnungsgemäß gestartet wurde, geben nachfolgenden Log-Meldungen Aufschluss über die Abarbeitung von Anfragen. +Die Annahme einer Anfrage wird beispielsweise angezeigt durch: +</div> +<pre> + INFO | 09 08:37:17,663 | Thread-9 | + MOASession 6576509775379152205 angelegt + + INFO | 09 08:37:20,828 | Thread-9 | + Anmeldedaten zu MOASession 6576509775379152205 + angelegt, SAML Artifakt + AAF/BrdRfnMaQVGIbP/Gf9OwDUwwsXChb7nuT+VXQzOoHbV + +</pre> + +<div id="block"> +Die 1. Log-Meldung besagt, dass sich ein Benutzer an MOA-ID-AUTH angemeldet und eine eindeutige SessionID zugewiesen bekommen hat. <br /> +Die 2. Log-Meldung informiert darüber, dass die Anmeldedaten des Benutzers unter dem angezeigten SAML Artifakt abgeholt werden können.<br /> +</div> +Wenn nun versucht wird, eine Transaktion mit einer ungültigen SessionID fortzusetzen erhält man folgende Log-Meldung:<br /> +<pre> + ERROR | 09 09:34:27,105 | Thread-8 | + at.gv.egovernment.moa.id.AuthenticationException: + MOASessionID ist unbekannt + (MOASessionID=-8650403497547200032) +</pre><div id="block"> + <p>In diesem Fall gibt der mitgeloggte Stacktrace Auskunft + über die Art des Fehlers. Der Aufrufer der MOA ID + Webapplikation bekommt einen Fehlercode sowie eine kurze + Beschreibung des Fehlers als Antwort zurück. <br /> + <br /> + Die Tatsächlich übertragenen Anfragen bzw. Antworten + werden aus Effizienzgründen nur im Log-Level DEBUG + angezeigt. </p> + <hr /> + <p> + </div> + </p> + +</td></tr></table> +<br /><br /> + + + +<table width="650" border="0" cellpadding="10" cellspacing="0"> +<tr> +<td width="170" valign="top"><br /></td> +<td valign="top"> +<hr /> +<div style="font-size:8pt; color:#909090">© 2012</div> +</td></tr></table> +<br /> + + +</div> +</div></div></div></div></div></body> +</html> |