Changeset 3052

Timestamp:

27/11/07 09:55:19 (13 years ago)

Author:

pjkersha

Message:

python/ndg.security.server/ndg/security/server/conf/sessionMgrProperties.xml: include better documentation of elements

architecture/uml/ndg2-dews-security-beta.eap,
architecture/uml/ClassDiagrams/X509.gif: re-arrange classes diagrams for better display on A4

Location:

TI12-security/trunk

Files:

• architecture/uml/ClassDiagrams (added)
• architecture/uml/ClassDiagrams/X509.gif (added)
• architecture/uml/ndg2-dews-security-beta.eap (modified) (previous)
• python/ndg.security.server/ndg/security/server/conf/sessionMgrProperties.xml (modified) (5 diffs)

TI12-security/trunk/python/ndg.security.server/ndg/security/server/conf/sessionMgrProperties.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 <sessMgrProp>
-    <portNum></portNum> <!-- the port number the service is to run on -->
-    <useSSL>Yes</useSSL> <!-- leave blank to use http -->
+    <!-- the port number the service is to run on -->
+    <portNum></portNum> 
+    <!-- 
+    Flag for SSL - set to something to stipulate http, leave blank to use
+    http 
+    -->
+    <useSSL>Yes</useSSL>
+    <!-- X.509 certificate for SSL connections --> 
     <sslCertFile>$NDGSEC_DIR/conf/certs/hostcert.pem</sslCertFile>
+    <!-- Private key file for SSL -->
     <sslKeyFile>$NDGSEC_DIR/conf/certs/hostkey.pem</sslKeyFile>
     <!--
-    PKI settings for signature of outbound SOAP messages
+    PKI settings for WS-Security signature of outbound SOAP messages
     -->
     <useSignatureHandler>Yes</useSignatureHandler> <!-- leave blank for no signature -->
+    <!-- X.509 certificate included in SOAP header -->
     <certFile>$NDGSEC_DIR/conf/certs/sm-cert.pem</certFile>
+    <!-- corresponding private key used to sign the SOAP message -->
     <keyFile>$NDGSEC_DIR/conf/certs/sm-key.pem</keyFile>
+    <!-- Password protecting private key file - leave blank if none set -->
     <keyPwd></keyPwd>
+    <!-- 
+    X.509 certificates included in inbound messages must validate
+    against this CA Certificate 
+    -->
     <caCertFile>$NDGSEC_DIR/conf/certs/cacert.pem</caCertFile>
     <!-- 
@@ -20 +34 @@
     <clntCertFile></clntCertFile> 
     <!--
-    Following two settings may be left blank
+    Following two settings may be left blank.  These fields are likely to be
+    removed from a future version
     -->   
     <sessMgrEncrKey></sessMgrEncrKey>
@@ -26 +41 @@
     <!-- 
     Domain defaults to the server host - any more generic setting could be a 
-    a security risk
+    a security risk.  Leave blank to default to the fully qualified domain
+    name of the server.
     -->
     <cookieDomain></cookieDomain>
+    <!-- MyProxy Client properties -->
         <myProxyProp>
                 <!-- 
@@ -71 +88 @@
                 -->
                 <proxyCertLifetime>8</proxyCertLifetime> <!-- in hours -->
+                <!-- 
+                CA certificate applied to verify peer certificate against in
+                SSL connection to MyProxy server
+                -->
                 <caCertFile>$NDGSEC_DIR/conf/certs/cacert.pem</caCertFile>
         </myProxyProp>
+        <!-- 
+        Properties for a Session Manager client to a Simple CA.
+        Not currently used and likely to be removed from a future release
+        -->
         <simpleCACltProp>
             <uri></uri>
@@ -89 +114 @@
         </simpleCASrvProp>
         -->
+        <!--
+        Settings for Credential Repository plugin
+        -->
     <credReposProp>
+        <!-- 
+        File path to plugin module - may be left blank if
+        module is included in the current PYTHONPATH
+        -->
             <modFilePath></modFilePath>
+            <!--
+            Module name - the default is an empty stub
+            -->
             <modName>ndg.security.common.CredWallet</modName>
+            <!-- Name of class in module to instantiate -->
             <className>NullCredRepos</className>
+            <!-- 
+            Optional Properties file argument to Credential
+            Repository class.  This is include to enable custom
+            settings to be defined from an external configuration file
+            -->
             <propFile></propFile>
     </credReposProp>