You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by rd...@apache.org on 2008/04/22 23:16:06 UTC

svn commit: r650659 - in /james/mailet/crypto/trunk/src/site: site.xml xdoc/conf.xml

Author: rdonkin
Date: Tue Apr 22 14:16:05 2008
New Revision: 650659

URL: http://svn.apache.org/viewvc?rev=650659&view=rev
Log:
Added configuration examples

Added:
    james/mailet/crypto/trunk/src/site/xdoc/conf.xml
Modified:
    james/mailet/crypto/trunk/src/site/site.xml

Modified: james/mailet/crypto/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/mailet/crypto/trunk/src/site/site.xml?rev=650659&r1=650658&r2=650659&view=diff
==============================================================================
--- james/mailet/crypto/trunk/src/site/site.xml (original)
+++ james/mailet/crypto/trunk/src/site/site.xml Tue Apr 22 14:16:05 2008
@@ -34,6 +34,7 @@
 
     <menu name="Cryptography Mailets">
       <item name="Overview" href="index.html"/>
+      <item name="Configuration" href="conf.html"/>
     </menu>
 
     ${reports}

Added: james/mailet/crypto/trunk/src/site/xdoc/conf.xml
URL: http://svn.apache.org/viewvc/james/mailet/crypto/trunk/src/site/xdoc/conf.xml?rev=650659&view=auto
==============================================================================
--- james/mailet/crypto/trunk/src/site/xdoc/conf.xml (added)
+++ james/mailet/crypto/trunk/src/site/xdoc/conf.xml Tue Apr 22 14:16:05 2008
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+  
+  http://www.apache.org/licenses/LICENSE-2.0
+  
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.    
+-->
+<document>
+  <properties>
+    <title>Configuration</title>
+    <author email="server-dev@james.apache.org">
+      JAMES Project Team
+    </author>
+  </properties>
+  <body>
+    <section name="JAMES Configuration">
+      <p>
+        To use cryptography mailets, the required
+        <a href='http://www.bouncycastle.org'>Bouncy Castle</a>
+        libraries must be installed in
+        <code>james/lib</code>
+        . It is recommended that the correct versions for the JVM are
+        used.
+      </p>
+      <p>
+        Ensure that the
+        <code>org.apache.james.transport.mailets.smime</code>
+        package is available to load mailets and matchers. For example:
+      </p>
+      <source>
+        <pre>
+    &lt;mailetpackages&gt; 
+      &lt;mailetpackage&gt;org.apache.james.transport.mailets&lt;/mailetpackage&gt;
+      &lt;mailetpackage&gt;org.apache.james.transport.mailets.smime&lt;/mailetpackage&gt; 
+    &lt;/mailetpackages&gt;
+    &lt;matcherpackages&gt; 
+      &lt;matcherpackage&gt;org.apache.james.transport.matchers &lt;/matcherpackage&gt;
+      &lt;matcherpackage&gt;org.apache.james.transport.matchers.smime&lt;/matcherpackage&gt; 
+    &lt;/matcherpackages&gt;
+        </pre>
+      </source>
+      <p>Example SMIME mailet configurations:</p>
+      <source>
+        <pre>
+    &lt;mailet match="IsSMIMEEncrypted" class="SMIMEDecrypt"&gt;
+      &lt;keyStoreType&gt;pkcs12&lt;/keyStoreType&gt;
+      &lt;keyStoreFileName&gt;c:/path.pfx&lt;/keyStoreFileName&gt;
+      &lt;keyStorePassword&gt;myKeyStorePass&lt;/keyStorePassword&gt;
+      &lt;keyAlias&gt;myKeyAlias&lt;/keyAlias&gt;
+      &lt;keyAliasPassword&gt;myKeyPass&lt;/keyAliasPassword&gt;
+    &lt;/mailet&gt;
+
+    &lt;mailet match="IsSMIMESigned" class="SMIMECheckSignature"&gt;
+      &lt;keyStoreType&gt;pkcs12&lt;/keyStoreType&gt;
+      &lt;keyStoreFileName&gt;c:/path.pfx&lt;/keyStoreFileName&gt;
+      &lt;keyStorePassword&gt; myKeyStorePass
+      &lt;/keyStorePassword&gt; &lt;strip&gt;false&lt;/strip&gt;
+      &lt;onlyTrusted&gt;true&lt;/onlyTrusted&gt; 
+    &lt;/mailet&gt;
+        </pre>
+      </source>
+      <p></p>
+      Matcher example: messages signed by trusted users never are spam
+      Messages with valid signatures will never be considered spam. This
+      can be a valid policy *if* SMIMECheckSignature was invoked with
+      <onlyTrusted>true</onlyTrusted>
+      set
+      <source>
+        <pre>
+    &lt;mailet
+        match="HasMailAttribute=org.apache.james.SMIMECheckSignature"
+        class="ToProcessor"&gt;
+      &lt;processor&gt;transport&lt;/processor&gt; 
+    &lt;/mailet&gt;
+        </pre>
+      </source>
+      <p>Signing example: Add a server-side signature to all mail.</p>
+      <source>
+        <pre>
+    &lt;mailet
+        match="HasMailAttribute=org.apache.james.SMIMECheckSignature"
+        class="SetMimeHeader"&gt; 
+      &lt;name&gt;X-WasSigned&lt;/name&gt;
+      &lt;value&gt;true&lt;/value&gt; 
+    &lt;/mailet&gt; 
+    
+    &lt;mailet match="All" class="SMIMESign" onMailetException="ignore"&gt;
+      &lt;keyStoreType&gt;jks&lt;/keyStoreType&gt;
+      &lt;keyStoreFileName&gt;path.keystore&lt;/keyStoreFileName&gt; 
+      &lt;keyStorePassword&gt;myKeyStorePass&lt;/keyStorePassword&gt;
+      &lt;keyAlias&gt;myKeyAlias&lt;/keyAlias&gt;
+      &lt;keyAliasPassword&gt;myKeyPass&lt;/keyAliasPassword&gt;
+      &lt;signerName&gt;XXX Trusted Server&lt;/signerName&gt;
+      &lt;rebuildFrom&gt;true&lt;/rebuildFrom&gt;
+      &lt;postmasterSigns&gt;true&lt;/postmasterSigns&gt;
+      &lt;debug&gt;true&lt;/debug&gt; 
+    &lt;/mailet&gt;
+        </pre>
+      </source>
+    </section>
+  </body>
+</document>
\ No newline at end of file



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org