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 ba...@apache.org on 2009/10/12 16:39:35 UTC

svn commit: r824363 - in /james/jdkim/trunk: ./ mailets/ mailets/src/site/ mailets/src/site/resources/ mailets/src/site/resources/images/ mailets/src/site/xdoc/ main/ main/src/site/ main/src/site/resources/ main/src/site/resources/images/ main/src/site...

Author: bago
Date: Mon Oct 12 14:39:34 2009
New Revision: 824363

URL: http://svn.apache.org/viewvc?rev=824363&view=rev
Log:
First attempt to make a website for jDKIM, as always an M2 PITA with multimodules and inheritance (JDKIM-5)

Added:
    james/jdkim/trunk/mailets/src/site/
    james/jdkim/trunk/mailets/src/site/resources/
    james/jdkim/trunk/mailets/src/site/resources/images/
    james/jdkim/trunk/mailets/src/site/resources/images/asf-logo-reduced.gif   (with props)
    james/jdkim/trunk/mailets/src/site/resources/images/james-jdkim-logo.gif   (with props)
    james/jdkim/trunk/mailets/src/site/site.xml
    james/jdkim/trunk/mailets/src/site/xdoc/
    james/jdkim/trunk/mailets/src/site/xdoc/index.xml   (with props)
    james/jdkim/trunk/main/src/site/
    james/jdkim/trunk/main/src/site/resources/
    james/jdkim/trunk/main/src/site/resources/images/
    james/jdkim/trunk/main/src/site/resources/images/asf-logo-reduced.gif   (with props)
    james/jdkim/trunk/main/src/site/resources/images/james-jdkim-logo.gif   (with props)
    james/jdkim/trunk/main/src/site/site.xml
    james/jdkim/trunk/main/src/site/xdoc/
    james/jdkim/trunk/main/src/site/xdoc/index.xml   (with props)
Modified:
    james/jdkim/trunk/mailets/pom.xml
    james/jdkim/trunk/main/pom.xml
    james/jdkim/trunk/pom.xml
    james/jdkim/trunk/src/site/site.xml
    james/jdkim/trunk/src/site/xdoc/index.xml

Modified: james/jdkim/trunk/mailets/pom.xml
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/mailets/pom.xml?rev=824363&r1=824362&r2=824363&view=diff
==============================================================================
--- james/jdkim/trunk/mailets/pom.xml (original)
+++ james/jdkim/trunk/mailets/pom.xml Mon Oct 12 14:39:34 2009
@@ -10,7 +10,10 @@
   <artifactId>apache-jdkim-mailets</artifactId>
   <name>jDKIM Mailets for Apache James</name>
   <version>0.1-SNAPSHOT</version>
-  <description/>
+  <url>http://james.apache.org/jdkim/mailets</url>
+  <description>
+    Mailets integrating DKIM functions 
+  </description>
   
     <dependencies>
     

Added: james/jdkim/trunk/mailets/src/site/resources/images/asf-logo-reduced.gif
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/mailets/src/site/resources/images/asf-logo-reduced.gif?rev=824363&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/jdkim/trunk/mailets/src/site/resources/images/asf-logo-reduced.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/jdkim/trunk/mailets/src/site/resources/images/james-jdkim-logo.gif
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/mailets/src/site/resources/images/james-jdkim-logo.gif?rev=824363&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/jdkim/trunk/mailets/src/site/resources/images/james-jdkim-logo.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/jdkim/trunk/mailets/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/mailets/src/site/site.xml?rev=824363&view=auto
==============================================================================
--- james/jdkim/trunk/mailets/src/site/site.xml (added)
+++ james/jdkim/trunk/mailets/src/site/site.xml Mon Oct 12 14:39:34 2009
@@ -0,0 +1,40 @@
+<?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.    
+-->
+<project name="James jDKIM">
+  <bannerLeft>
+    <name>JAMES jDKIM</name>
+    <src>images/james-jdkim-logo.gif</src>
+    <href>http://james.apache.org/</href>
+  </bannerLeft>
+  <bannerRight>
+    <name>The Apache Software Foundation</name>
+    <src>images/asf-logo-reduced.gif</src>
+    <href>http://www.apache.org/index.html</href>
+  </bannerRight> 
+  <body>
+    <menu ref="jDKIM" inherit="top" />
+
+    <menu name="jDKIM Mailets">
+      <item name="Overview" href="/index.html"/>
+    </menu>
+    
+    <menu ref="reports" />
+  </body>
+</project>

Added: james/jdkim/trunk/mailets/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/mailets/src/site/xdoc/index.xml?rev=824363&view=auto
==============================================================================
--- james/jdkim/trunk/mailets/src/site/xdoc/index.xml (added)
+++ james/jdkim/trunk/mailets/src/site/xdoc/index.xml Mon Oct 12 14:39:34 2009
@@ -0,0 +1,64 @@
+<?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>jDKIM Mailets</title>
+    </properties>
+    <body>
+        <section name="Java DKIM Mailets">
+		<p>At the moment the mailet package includes 2 mailets: ConvertTo7Bit and DKIMSign</p>
+		<p>ConvertTo7Bit is simply required because when DKIM signing we have to make sure that 
+		   the MTAs involved in the delivery of our message won't alter the byte stream of our
+		   signed message and 7bit messages are more likely to be transported without 
+		   further conversions. So, make sure to use ConvertTo7Bit just before DKIMSign mailet.</p>
+		<p>DKIMSign is the signing mailet. Make sure you use this one as the last mailet before 
+		delivery otherwise further JavaMail interactions with a signed message would lead in a 
+		broken signature.</p>
+		<p>Here is a sample configuration for DKIMSign</p>
+		<p><code><pre>
+&lt;mailet match=&quot;All&quot; class=&quot;DKIMSign&quot;&gt;
+   &lt;signatureTemplate&gt;v=1; s=selector; d=example.com; h=from:to:received:received; a=rsa-sha256; bh=; b=;&lt;/signatureTemplate&gt;
+   &lt;privateKey&gt;
+   -----BEGIN RSA PRIVATE KEY-----
+   MIICXAIBAAKBgQDYDaYKXzwVYwqWbLhmuJ66aTAN8wmDR+rfHE8HfnkSOax0oIoT
+   M5zquZrTLo30870YMfYzxwfB6j/Nz3QdwrUD/t0YMYJiUKyWJnCKfZXHJBJ+yfRH
+   r7oW+UW3cVo9CG2bBfIxsInwYe175g9UjyntJpWueqdEIo1c2bhv9Mp66QIDAQAB
+   AoGBAI8XcwnZi0Sq5N89wF+gFNhnREFo3rsJDaCY8iqHdA5DDlnr3abb/yhipw0I
+   /1HlgC6fIG2oexXOXFWl+USgqRt1kTt9jXhVFExg8mNko2UelAwFtsl8CRjVcYQO
+   cedeH/WM/mXjg2wUqqZenBmlKlD6vNb70jFJeVaDJ/7n7j8BAkEA9NkH2D4Zgj/I
+   OAVYccZYH74+VgO0e7VkUjQk9wtJ2j6cGqJ6Pfj0roVIMUWzoBb8YfErR8l6JnVQ
+   bfy83gJeiQJBAOHk3ow7JjAn8XuOyZx24KcTaYWKUkAQfRWYDFFOYQF4KV9xLSEt
+   ycY0kjsdxGKDudWcsATllFzXDCQF6DTNIWECQEA52ePwTjKrVnLTfCLEG4OgHKvl
+   Zud4amthwDyJWoMEH2ChNB2je1N4JLrABOE+hk+OuoKnKAKEjWd8f3Jg/rkCQHj8
+   mQmogHqYWikgP/FSZl518jV48Tao3iXbqvU9Mo2T6yzYNCCqIoDLFWseNVnCTZ0Q
+   b+IfiEf1UeZVV5o4J+ECQDatNnS3V9qYUKjj/krNRD/U0+7eh8S2ylLqD3RlSn9K
+   tYGRMgAtUXtiOEizBH6bd/orzI9V9sw8yBz+ZqIH25Q=
+   -----END RSA PRIVATE KEY-----
+   &lt;/privateKey&gt;
+ &lt;/mailet&gt;
+ 		</pre></code></p>
+ 		<p>If your PEM file is password encrypted then you can add a privateKeyPassword argument
+ 		to the mailet</p>
+        </section>
+    </body>
+</document>

Propchange: james/jdkim/trunk/mailets/src/site/xdoc/index.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: james/jdkim/trunk/mailets/src/site/xdoc/index.xml
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Modified: james/jdkim/trunk/main/pom.xml
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/main/pom.xml?rev=824363&r1=824362&r2=824363&view=diff
==============================================================================
--- james/jdkim/trunk/main/pom.xml (original)
+++ james/jdkim/trunk/main/pom.xml Mon Oct 12 14:39:34 2009
@@ -32,7 +32,7 @@
   <description>
     A Java implementation for the DKIM specification.
   </description>
-  <url>http://james.apache.org/jdkim</url>
+  <url>http://james.apache.org/jdkim/main</url>
   <inceptionYear>2008</inceptionYear>
 
   <distributionManagement>

Added: james/jdkim/trunk/main/src/site/resources/images/asf-logo-reduced.gif
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/main/src/site/resources/images/asf-logo-reduced.gif?rev=824363&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/jdkim/trunk/main/src/site/resources/images/asf-logo-reduced.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/jdkim/trunk/main/src/site/resources/images/james-jdkim-logo.gif
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/main/src/site/resources/images/james-jdkim-logo.gif?rev=824363&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/jdkim/trunk/main/src/site/resources/images/james-jdkim-logo.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/jdkim/trunk/main/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/main/src/site/site.xml?rev=824363&view=auto
==============================================================================
--- james/jdkim/trunk/main/src/site/site.xml (added)
+++ james/jdkim/trunk/main/src/site/site.xml Mon Oct 12 14:39:34 2009
@@ -0,0 +1,40 @@
+<?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.    
+-->
+<project name="James jDKIM">
+  <bannerLeft>
+    <name>JAMES jDKIM</name>
+    <src>images/james-jdkim-logo.gif</src>
+    <href>http://james.apache.org/</href>
+  </bannerLeft>
+  <bannerRight>
+    <name>The Apache Software Foundation</name>
+    <src>images/asf-logo-reduced.gif</src>
+    <href>http://www.apache.org/index.html</href>
+  </bannerRight> 
+  <body>
+    <menu ref="jDKIM" inherit="top" />
+
+    <menu name="jDKIM library">
+      <item name="Overview" href="/index.html"/>
+    </menu>
+    
+    <menu ref="reports" />
+  </body>
+</project>

Added: james/jdkim/trunk/main/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/main/src/site/xdoc/index.xml?rev=824363&view=auto
==============================================================================
--- james/jdkim/trunk/main/src/site/xdoc/index.xml (added)
+++ james/jdkim/trunk/main/src/site/xdoc/index.xml Mon Oct 12 14:39:34 2009
@@ -0,0 +1,43 @@
+<?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>jDKIM Library</title>
+    </properties>
+    <body>
+        <section name="Java DKIM Library">
+		<p>This is a DKIM implementation library written in Java.</p>
+		<p>The architecture is interface based and pluggable. You can tweak it almost in every behaviour.</p>
+		<p>The architecture is thought to handle multiple signatures with performance in mind: body hashing
+for multiple signatures is computed concurrently in a single stream run.
+		</p>
+		<p>The whole internal verification/signing is dove via OutputStream leaving much more flexibility than
+the use of InputStream. As the InputStream approach is easier from the user side the default
+implementation simply prepare the OutputStream and copy the supplied InputStream to the OutputStream.</p>
+
+<p>In order to reduce depencencies and to not reinvent the wheel the resulting library includes a
+"shaded" version of the commons-codec 1.4 classes needed to do Base64 encoding/decoding.</p>
+		
+        </section>
+    </body>
+</document>

Propchange: james/jdkim/trunk/main/src/site/xdoc/index.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: james/jdkim/trunk/main/src/site/xdoc/index.xml
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Modified: james/jdkim/trunk/pom.xml
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/pom.xml?rev=824363&r1=824362&r2=824363&view=diff
==============================================================================
--- james/jdkim/trunk/pom.xml (original)
+++ james/jdkim/trunk/pom.xml Mon Oct 12 14:39:34 2009
@@ -32,7 +32,7 @@
     <artifactId>james-project</artifactId>
     <version>1.3</version>
   </parent>
-  <url>http://james.apache.org/jdkim/</url>
+  <url>http://james.apache.org/jdkim</url>
   <inceptionYear>2009</inceptionYear>
   
   <modules>

Modified: james/jdkim/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/src/site/site.xml?rev=824363&r1=824362&r2=824363&view=diff
==============================================================================
--- james/jdkim/trunk/src/site/site.xml (original)
+++ james/jdkim/trunk/src/site/site.xml Mon Oct 12 14:39:34 2009
@@ -33,14 +33,31 @@
       <link rel="meta" title="DOAP" href="${project.url}/doap_maven-doap-plugin.rdf" type="application/rdf+xml"/>
     </head>
     
-    <menu name="jdkim">
+    <menu name="jDKIM">
+    	<item name="Project" href="/index.html" />
+    	<item name="Library" href="/main/index.html" />
+    	<item name="Mailets" href="/mailets/index.html" />
+    	<item name="Project2" href="${project.url}/index.html" />
+    	<item name="Library2" href="${project.url}/main/index.html" />
+    	<item name="Mailets2" href="${project.url}/mailets/index.html" />
+    	<item name="Project3" href="index.html" />
+    	<item name="Library3" href="main/index.html" />
+    	<item name="Mailets3" href="mailets/index.html" />
+    	<item name="Project4" href="http://james.apache.org/jdkim/index.html" />
+    	<item name="Library4" href="http://james.apache.org/jdkim/main/index.html" />
+    	<item name="Mailets4" href="http://james.apache.org/jdkim/mailets/index.html" />
+    </menu>
+
+    <menu name="jDKIM Project">
       <item name="Overview" href="/index.html"/>
     </menu>
     
-    ${reports}
+    <menu ref="reports" />
     
     <menu name="Related Projects">
-    	<item name="jspf" href="http://james.apache.org/jspf" />
+    	<item name="jSPF" href="http://james.apache.org/jspf" />
+    	<item name="DKIM Javamail" href="http://dkim-javamail.sourceforge.net" />
+    	<item name="JavaDKIM" href="http://www.badpenguin.co.uk/dkim/" />
     </menu>
   </body>
 </project>

Modified: james/jdkim/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/jdkim/trunk/src/site/xdoc/index.xml?rev=824363&r1=824362&r2=824363&view=diff
==============================================================================
--- james/jdkim/trunk/src/site/xdoc/index.xml (original)
+++ james/jdkim/trunk/src/site/xdoc/index.xml Mon Oct 12 14:39:34 2009
@@ -1,32 +1,53 @@
 <?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.                                           *
- ****************************************************************/
-
- -->
+	/****************************************************************
+	* 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>jDKIM</title>
-    </properties>
-    <body>
-        <section name="Java DKIM Library">
-		<p>TODO</p>
-        </section>
-    </body>
+	<properties>
+		<title>jDKIM</title>
+	</properties>
+	<body>
+		<section name="Apache jDKIM Project">
+			<p>
+				jDKIM is a DKIM implementation library written in Java.
+				It provides both verification and signing and also
+				provides Mailets for the Apache JAMES project.
+			</p>
+
+			<p>
+				The 0.1 release is the first release. It requires Java
+				1.4 at runtime but for full compliance with the DKIM
+				specification the JVM running the library must support
+				SHA256withRSA cypher suite. The default Sun Java 1.4
+				does not support this suite, so either you move to Java
+				1.5+ or you install a third party cryptography provider
+				like BouncyCastle and configure it appropriately in your
+				JVM.
+			</p>
+
+			<p>
+				The product currently include a generic library module
+				called "main" and a module providing mailets for DKIM
+				signing
+			</p>
+		</section>
+	</body>
 </document>



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