Neugliederung Dokumentation - Zwischensicherung

git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/trunk@149 d688527b-c9ab-4aba-bd8d-4036d912da1d

2 files changed, 331 insertions, 0 deletions

diff --git a/spss.server/doc/handbook/config/MOA-SPSS.config.xsd b/spss.server/doc/handbook/config/MOA-SPSS.config.xsd
new file mode 100644
index 000000000..922c6957f
--- /dev/null
+++ b/spss.server/doc/handbook/config/MOA-SPSS.config.xsd
@@ -0,0 +1,210 @@
+<?xml version="1.0" encoding="UTF-8"?>

+<!-- Schema für die zentrale Konfigurationsdatei von MOA SP/SS. 

+     Gültig für die Versionen 1.0, 1.1 und 1.2.

+     (c) Stabsstelle IKT-Strategie des Bundes im Bundeskanzleramt, österreich -->

+<xs:schema targetNamespace="http://reference.e-government.gv.at/namespace/moaconfig/20021122#" xmlns:config="http://reference.e-government.gv.at/namespace/moaconfig/20021122#" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">

+	<xs:import namespace="http://www.w3.org/2000/09/xmldsig#" schemaLocation="http://www.w3.org/TR/xmldsig-core/xmldsig-core-schema.xsd"/>

+	<xs:element name="MOAConfiguration">

+		<xs:complexType>

+			<xs:sequence>

+				<xs:element name="CanonicalizationAlgorithm" minOccurs="0">

+					<xs:complexType>

+						<xs:attribute name="name" type="xs:anyURI" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="DigestMethodAlgorithm" minOccurs="0">

+					<xs:complexType>

+						<xs:attribute name="name" type="xs:anyURI" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="SignatureAlgorithm" minOccurs="0">

+					<xs:complexType>

+						<xs:attribute name="name" type="xs:anyURI" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="GenericConfiguration" minOccurs="0" maxOccurs="unbounded">

+					<xs:complexType>

+						<xs:attribute name="name" type="xs:string" use="required"/>

+						<xs:attribute name="value" type="xs:string" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="HardwareCryptoModule" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>dient zum Konfigurieren von HW Crypto-Module via PKCS#11 (s. iaik.server.modules.crypto.HarwwareCryptoModuleConfiguration)</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:attribute name="name" type="xs:string" use="required"/>

+						<xs:attribute name="slotID" type="xs:string" use="optional"/>

+						<xs:attribute name="userPIN" type="xs:string" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="HardwareKeyModule" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>dient zum Konfigurieren von HW Key-Module via PKCS#11 (s. iaik.server. modules.crypto.HardwareKeyModuleConfiguration</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:attribute name="id" type="xs:token" use="required"/>

+						<xs:attribute name="name" type="xs:string" use="required"/>

+						<xs:attribute name="slotID" type="xs:string" use="optional"/>

+						<xs:attribute name="userPIN" type="xs:string" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="SoftwareKeyModule" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>dient zum Konfigurieren von SW Key-Module via PKCS#12 Dateien (s. iaik. server.modules.crypto.SoftwareKeyModuleConfiguration</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:attribute name="id" type="xs:token" use="required"/>

+						<xs:attribute name="filename" type="xs:string" use="required"/>

+						<xs:attribute name="password" type="xs:string" use="optional"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="KeyGroup" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>definiert eine Gruppe von Keys</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:sequence maxOccurs="unbounded">

+							<xs:element name="Key">

+								<xs:annotation>

+									<xs:documentation>Ein Schlüssel wird bezeichnet durch ein Tripel bestehend aus der ID des KeyModules (siehe z.B. SoftwareKeyModule/@id), sowie Issuer und Seriennummer des zum Schlüssel gehörigen Zertifikats</xs:documentation>

+								</xs:annotation>

+								<xs:complexType>

+									<xs:sequence>

+										<xs:element name="KeyModuleID" type="xs:token"/>

+										<xs:element name="KeyCertIssuerSerial" type="dsig:X509IssuerSerialType"/>

+									</xs:sequence>

+								</xs:complexType>

+							</xs:element>

+						</xs:sequence>

+						<xs:attribute name="id" type="xs:token" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="KeyGroupMapping" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>ordnet oben definierte KeyGroups Online-Applikationen zu, die diese KeyGroups verwenden dürfen</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:sequence>

+							<xs:element name="X509IssuerSerial" type="dsig:X509IssuerSerialType" minOccurs="0">

+								<xs:annotation>

+									<xs:documentation>wenn das Element nicht auftritt, dann können die zugeordneten KeyGroups von allen Online-Applikationen verwendet werden</xs:documentation>

+								</xs:annotation>

+							</xs:element>

+							<xs:element name="KeyGroup" maxOccurs="unbounded">

+								<xs:complexType>

+									<xs:attribute name="id" type="xs:token" use="required"/>

+								</xs:complexType>

+							</xs:element>

+						</xs:sequence>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="ChainingModes" minOccurs="0">

+					<xs:annotation>

+						<xs:documentation>spezifiziert den Algorithmus ("pkix" oder "chaining") für die Zertifikatspfadvalidierung</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:sequence minOccurs="0" maxOccurs="unbounded">

+							<xs:element name="TrustAnchor">

+								<xs:annotation>

+									<xs:documentation>ein vom SystemDefaultMode abweichender ChiningMode kann für jeden TrustAnchor gesetzt werden</xs:documentation>

+								</xs:annotation>

+								<xs:complexType>

+									<xs:complexContent>

+										<xs:extension base="dsig:X509IssuerSerialType">

+											<xs:attribute name="mode" type="config:ChainingModeType" use="required"/>

+										</xs:extension>

+									</xs:complexContent>

+								</xs:complexType>

+							</xs:element>

+						</xs:sequence>

+						<xs:attribute name="systemDefaultMode" type="config:ChainingModeType" use="optional" default="pkix"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="CRLArchive" minOccurs="0">

+					<xs:annotation>

+						<xs:documentation>spezifiziert die Dauer, die Revozierungsinformation archiviert werden muss in Tagen</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:attribute name="duration" type="xs:nonNegativeInteger" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="CRLDistributionPoint" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>spezifiziert  CRL Distribution Points</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:sequence>

+							<xs:element name="CAIssuerDN" type="xs:string">

+								<xs:annotation>

+									<xs:documentation>spezifiziert die CA, für die der u.a. DP verwendet werden soll</xs:documentation>

+								</xs:annotation>

+							</xs:element>

+							<xs:element name="DistributionPoint" maxOccurs="unbounded">

+								<xs:annotation>

+									<xs:documentation>das Attribut reasonCodes enthält eine Liste von möglichen reasonCodes lt. RFC 3280: unspecified, keyCompromise, cACompromise, affiliationChanged, superseded, cessationOfOperation, certificateHold, removeFromCRL, privilegeWithdrawn, aACompromise

+</xs:documentation>

+								</xs:annotation>

+								<xs:complexType>

+									<xs:attribute name="reasonCodes" type="xs:NMTOKENS" use="optional"/>

+									<xs:attribute name="uri" type="xs:anyURI" use="required"/>

+								</xs:complexType>

+							</xs:element>

+						</xs:sequence>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="CreateTransformsInfoProfile" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>ordnet eine Datei, die ein CreateTransformsInfoProfile-Element enthält, einer id zu</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:attribute name="id" type="xs:token" use="required"/>

+						<xs:attribute name="filename" type="xs:string" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="CreateSignatureEnvironmentProfile" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>ordnet eine Datei, die ein CreateSignatureEnvironmentProfile-Element enthält, einer id zu</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:attribute name="id" type="xs:token" use="required"/>

+						<xs:attribute name="filename" type="xs:string" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="VerifyTransformsInfoProfile" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>ordnet eine Datei, die ein VerifyTransformsInfoProfile-Element enthält, einer id zu</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:attribute name="id" type="xs:token" use="required"/>

+						<xs:attribute name="filename" type="xs:string" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="SupplementProfile" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>ordnet eine Datei, die ein SupplementProfile-Element enthält, einer id zu</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:attribute name="id" type="xs:token" use="required"/>

+						<xs:attribute name="filename" type="xs:string" use="required"/>

+					</xs:complexType>

+				</xs:element>

+				<xs:element name="TrustProfile" minOccurs="0" maxOccurs="unbounded">

+					<xs:annotation>

+						<xs:documentation>ordnet ein Verzeichnis, das vertrauenswürdige Zertifikate enthält einer id zu</xs:documentation>

+					</xs:annotation>

+					<xs:complexType>

+						<xs:attribute name="id" type="xs:token" use="required"/>

+						<xs:attribute name="uri" type="xs:anyURI" use="required"/>

+					</xs:complexType>

+				</xs:element>

+			</xs:sequence>

+		</xs:complexType>

+	</xs:element>

+	<xs:simpleType name="ChainingModeType">

+		<xs:restriction base="xs:string">

+			<xs:enumeration value="chaining"/>

+			<xs:enumeration value="pkix"/>

+		</xs:restriction>

+	</xs:simpleType>

+</xs:schema>

diff --git a/spss.server/doc/handbook/config/config.html b/spss.server/doc/handbook/config/config.html
new file mode 100644
index 000000000..4bd90a527
--- /dev/null
+++ b/spss.server/doc/handbook/config/config.html
@@ -0,0 +1,121 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
+  <title>Die &ouml;sterreichische B&uuml;rgerkarte - Einf&uuml;hrung</title>
+  <link rel="stylesheet" href="../common/MOA.css" type="text/css">
+</head>
+<body bgcolor="white" text="#000000" link="#990000" vlink="#666666" alink="#cc9966"> 
+  <table class="logoTable" width="100%" border="0" cellspacing="0" cellpadding="10"> 
+    <tr> 
+      <td align="center" width="30%"><img src="../common/LogoBKA.png" width="267" height="36" alt="Logo BKA"></td> 
+      <td align="center" class="logoTitle"><div align="right">Open Source  
+        f&uuml;r das E-Government</div></td> 
+    </tr> 
+  </table> 
+  <hr/> 
+  <p class="title"><a href="../index.html">MOA: Serversignatur (SS) und Signaturpr&uuml;fung (SP), V 1.2 </a></p> 
+  <p class="subtitle">Konfiguration</p> 
+  <hr/>
+  <h1>Inhalt</h1>
+  <ol>
+    <li>
+      <p><a href="#&#252;bersicht">&Uuml;bersicht</a></p>
+      <ol>
+        <li><a href="#&#252;bersicht_zentraledatei">Zentrale Konfigurationsdatei</a></li>
+        <li><a href="#&#252;bersicht_bekanntmachung">Bekanntmachung der Konfigurationsdatei
+          </a>
+          <ol>
+            <li><a href="#&#252;bersicht_bekanntmachung_laufenderbetrieb">Aktualisierung der Konfiguration im laufenden Betrieb</a></li>
+          </ol>
+        </li>
+		<li><a href="#&#252;bersicht_logging">Konfiguration des Loggings</a></li>
+      </ol>
+    </li>
+  <li><a href="#konfigurationsparameter">Konfigurationsparameter</a></li>
+  <li><a href="#beispielkonfigurationen">Beispielkonfigurationen</a></li>
+  <li>Typische Konfigurationsaufgaben </li>
+  </ol>
+  <hr/>
+  <h1><a name="übersicht" id="übersicht"></a>1 &Uuml;bersicht </h1>
+  <p>Dieses Handbuch beschreibt detailliert die Konfigurationsm&ouml;glichkeiten f&uuml;r MOA SP/SS. Wenn nicht anders angegeben, beziehen sich die Erl&auml;uterungen sowohl auf die Konfiguration des Webservices als auch auf die Konfiguration von MOA SP/SS f&uuml;r den Einsatz als Klassenbibliothek.</p>
+  <h2><a name="übersicht_zentraledatei" id="übersicht_zentraledatei"></a>1.1 Zentrale Konfigurationsdatei</h2>
+  <p>Die Konfiguration von MOA SP/SS erfolgt zentral &uuml;ber eine einzige Konfigurationsdatei. Das Format der Konfigurationsdatei ist XML und muss dem Schema <a href="./MOA-SPSS.config.xsd">MOA-SPSS.config.xsd</a> entsprechen. <a href="#konfigurationsparameter">Abschnitt 2</a> erl&auml;utert die Konfigurationsm&ouml;glichkeiten im Einzelnen.</p>
+  <h2><a name="übersicht_bekanntmachung" id="übersicht_bekanntmachung"></a>1.2 Bekanntmachung der Konfigurationsdatei</h2>
+  <p>Die zentrale Konfigurationsdatei von MOA SP/SS wird der <span class="term">Java Virtual Machine</span>, in der MOA SP/SS l&auml;uft, durch ein <span class="term">VM Argument</span> mitgeteilt. Der Name des <span class="term">VM Argument</span> lautet <code>moa.spss.server.configuration</code>; als Wert des Parameters ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.</p>
+  <pre>moa.spss.server.configuration=C:/Programme/apache/tomcat-4.1.30/conf/moa-spss/moa-spss.config.xml 
+</pre>
+<p>Weitere Informationen zum Bekanntmachen der zentralen Konfigurationsdatei MOA SP/SS erhalten Sie in <span class="comment">Abschnitt TBD des Installationshandbuchs</span>.</p>
+<h3><a name="übersicht_bekanntmachung_laufenderbetrieb" id="übersicht_bekanntmachung_laufenderbetrieb"></a>1.2.1 Aktualisierung der Konfiguration im laufenden Betrieb</h3>
+<p>Wird MOA SP/SS als Webservice eingesetzt, kann durch Aufrufen einer speziellen URL des Webservice ein erneutes Einlesen der Konfigurationsdatei erzwungen werden. Damit ist es m&ouml;glich, &Auml;nderungen an der Konfigurationsdatei vorzunehmen, und diese &Auml;nderungen ohne Neustart des zu Grunde liegenden Servlet Containers in den Betrieb zu &uuml;bernehmen.</p>
+<p>Weitere Informationen zum erneuten Einlesen der Konfigurationsdatei im Webservice-Betrieb erhalten Sie in <span class="comment">Abschnitt TBD des Installationshandbuchs</span>.</p>
+<h2><a name="übersicht_logging" id="übersicht_logging"></a>1.3 Konfiguration des Loggings</h2>
+  <p>MOA SP/SS verwendet als Framework f&uuml;r Logging-Information die Open Source Software <code>log4j</code>. Die Konfiguration der Logging-Information erfolgt  nicht direkt durch MOA SP/SS, sondern &uuml;ber eine eigene Konfigurationsdatei, die der <span class="term">Java Virtual Machine</span> durch ein <span class="term">VM Argument</span> mitgeteilt wird. Der Name des <span class="term">VM Argument</span> lautet <code>log4j.configuration</code>; als Wert des Parameters ist eine URL anzugeben, die auf die <code>log4j</code>-Konfigurationsdatei verweist, z.B.</p>
+  <p>
+  <pre>log4j.configuration=file:/C:/Programme/apache/tomcat-4.1.30/conf/moa-spss/log4j.properties</pre>
+  Weitere Informationen zur Konfiguration des Loggings erhalten Sie in <span class="comment">Abschnitt TBD des Installationshandbuchs</span>. </p>
+  <h1><a name="konfigurationsparameter"></a>2 Konfigurationsparameter</h1>
+  <p>Nachfolgend werden die verf&uuml;gbaren Konfigurationsparameter der zentralen Konfigurationsdatei im Detail erl&auml;utert. Die Reihenfolge der Abhandlung entspricht der Reihenfolge des vorgeschriebenen Auftretens in der Konfigurationsdatei. F&uuml;r beispielhafte Konfigurationsdateien siehe <a href="#beispielkonfigurationen">Abschnitt 3</a>. </p>
+  <p>Muss der Wert eines Konfigurationsparameters eine URL oder eine Pfadangabe sein, und wird als konkreter Wert eine relative URL bzw. ein relativer Pfad angegeben, so wird diese Angabe relativ zum Pfad jenes Verzeichnisses interpretiert, in dem die zentrale Konfigurationsdatei gespeichert ist.</p>
+  <p>Pr&auml;fixe f&uuml;r Namenr&auml;ume von XML-Elementen werden wie folgt verwendet:</p>
+  <table class="fixedWidth"  border="1" cellpadding="2">
+    <tr>
+      <th scope="col">Pr&auml;fix</th>
+      <th scope="col">Namenraum</th>
+    </tr>
+    <tr>
+      <td><code>cfg</code></td>
+      <td><code>http://reference.e-government.gv.at/namespace/moaconfig/20021122#</code></td>
+    </tr>
+    <tr>
+      <td><code>dsig</code></td>
+      <td><code>http://www.w3.org/2000/09/xmldsig#</code></td>
+    </tr>
+  </table>
+  <h2><a name="konfigurationsparameter_kanonisierungsalgorithmus" id="konfigurationsparameter_kanonisierungsalgorithmus"></a>2.1 Kanonisierungs-Algorithmus</h2>
+  <table class="fixedWidth"  border="1" cellpadding="2">
+    <tr>
+      <td>Name</td>
+      <td><code>cfg:CanonicalizationAlgorithm</code></td>
+    </tr>
+    <tr>
+      <td>Gebrauch</td>
+      <td>optional</td>
+    </tr>
+    <tr>
+      <td>Erl&auml;uterung</td>
+      <td><p> Als Inhalt des Elements  kann der Kanonisierungs-Algorithmus, der f&uuml;r das Erstellen von XML-Signaturen verwendet werden soll und in der Signatur als Inhalt von <code>dsig:Signature/dsig:SignedInfo/dsig:CanonicalizationMethod</code> aufscheint, spezifiziert werden. Folgende Werte d&uuml;rfen verwendet werden:</p>
+        <p>
+        <pre>http://www.w3.org/TR/2001/REC-xml-c14n-20010315 <br>http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments <br>http://www.w3.org/2001/10/xml-exc-c14n# <br>http://www.w3.org/2001/10/xml-exc-c14n#WithComments  </pre>
+        </p>        <p>Wird das Element nicht angegeben, wird folgender Wert als Default-Wert verwendet:</p>
+      <pre>http://www.w3.org/TR/2001/REC-xml-c14n-20010315  </pre>
+	  <p>Für die genaue Bedeutung der Werte siehe die <a href="http://www.w3.org/TR/xmldsig-core/" target="_blank">Spezifikation für XML-Signaturen</a>.</p></td>
+    </tr>
+  </table>
+  <h2><a name="konfigurationsparameter_digestsalgorithmus" id="konfigurationsparameter_digestsalgorithmus"></a>2.2 Digest-Algorithmus</h2>
+  <table class="fixedWidth"  border="1" cellpadding="2">
+    <tr>
+      <td>Name</td>
+      <td><code>cfg:DigestAlgorithm</code></td>
+    </tr>
+    <tr>
+      <td>Gebrauch</td>
+      <td>optional</td>
+    </tr>
+    <tr>
+      <td>Erl&auml;uterung</td>
+      <td><p> Als Inhalt des Elements kann der Digest-Algorithmus, der f&uuml;r das Erstellen von XML-Signaturen verwendet werden soll und in der Signatur als Inhalt von <code>dsig:Signature/dsig:SignedInfo/dsig:Reference/dsig:DigestMethod</code> aufscheint, spezifiziert werden. Folgende Werte d&uuml;rfen verwendet werden:</p>
+          <p>
+          <pre>http://www.w3.org/2000/09/xmldsig#sha1
+</pre>
+          <p></p>
+          <p>Wird das Element nicht angegeben, wird folgender Wert als Default-Wert verwendet:</p>
+          <pre>http://www.w3.org/2000/09/xmldsig#sha1</pre>
+          <p>F&uuml;r die genaue Bedeutung der Werte siehe die <a href="http://www.w3.org/TR/xmldsig-core/" target="_blank">Spezifikation f&uuml;r XML-Signaturen</a>.</p></td>
+    </tr>
+  </table>
+  <h2>&nbsp;</h2>
+  <h1><a name="beispielkonfigurationen"></a>3 Beispielkonfigurationen </h1>
+  <p>&nbsp; </p>
+</body>
+</html>