blob: 2f31d4c70d70092284102801fab1696578e88c9f [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia at 2017-04-13 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>James jDKIM -
jDKIM</title>
<style type="text/css" media="all">
@import url("./css/james.css");
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
@import url("./js/jquery/css/custom-theme/jquery-ui-1.8.5.custom.css");
@import url("./js/jquery/css/print.css");
@import url("./js/fancybox/jquery.fancybox-1.3.4.css");
</style>
<script type="text/javascript" src="./js/jquery/js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="./js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script>
<script type="text/javascript" src="./js/fancybox/jquery.fancybox-1.3.4.js"></script>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20170413" />
<meta http-equiv="Content-Language" content="en" />
<link rel="meta" href="http://james.apache.org/jdkim//doap_maven-doap-plugin.rdf" title="DOAP" type="application/rdf+xml"/>
<!-- Google Analytics -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-1384591-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script').item(0); s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body class="composite">
<div id="banner">
<a href="../" id="bannerLeft" title="james-logo.png">
<img src="images/logos/james-logo.png" alt="JAMES jDKIM" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 2017-04-13</span>
&nbsp;| <span id="projectVersion">Version: 0.3-SNAPSHOT</span>
</div>
<div class="xright"> <a href="../index.html" title="Home">Home</a>
|
<a href="../documentation.html" title="Server">Server</a>
|
<a href="../mime4j/index.html" title="Mime4J">Mime4J</a>
|
<a href="../jsieve/index.html" title="jSieve">jSieve</a>
|
<a href="../jspf/index.html" title="jSPF">jSPF</a>
|
<a href="index.html" title="jDKIM">jDKIM</a>
|
<a href="../hupa/index.html" title="Hupa">Hupa</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>jDKIM</h5>
<ul>
<li class="none">
<strong>Overview</strong>
</li>
<li class="none">
<a href="main/index.html" title="Library">Library</a>
</li>
<li class="none">
<a href="mailets/index.html" title="Mailets">Mailets</a>
</li>
<li class="none">
<a href="https://issues.apache.org/jira/browse/JDKIM" title="Issue Tracker">Issue Tracker</a>
</li>
<li class="expanded">
<strong>Related Projects</strong>
<ul>
<li class="none">
<a href="../jspf/index.html" title="jSPF">jSPF</a>
</li>
<li class="none">
<a href="http://dkim-javamail.sourceforge.net" title="DKIM Javamail">DKIM Javamail</a>
</li>
<li class="none">
<a href="http://www.badpenguin.co.uk/dkim/" title="JavaDKIM">JavaDKIM</a>
</li>
</ul>
</li>
<li class="none">
<a href="../download.cgi#Apache_jDKIM" title="Download Releases">Download Releases</a>
</li>
</ul>
<h5>Apache Software Foundation</h5>
<ul>
<li>
<strong>
<a title="ASF" href="http://www.apache.org/">ASF</a>
</strong>
</li>
<li>
<a title="Get Involved" href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a>
</li>
<li>
<a title="FAQ" href="http://www.apache.org/foundation/faq.html">FAQ</a>
</li>
<li>
<a title="License" href="http://www.apache.org/licenses/" >License</a>
</li>
<li>
<a title="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
</li>
<li>
<a title="Thanks" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
</li>
<li>
<a title="Security" href="http://www.apache.org/security/">Security</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<!-- /****************************************************************
* 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. *
****************************************************************/ -->
<div class="section">
<h2>Apache jDKIM Project<a name="Apache_jDKIM_Project"></a></h2>
<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.2 release is the first release. It requires Java 1.5 at
runtime and it requires the JVM running the library to support
SHA256withRSA cypher suite. The default Sun Java 1.5 does support this
suite. If your JVM doesn't support it you can install a third party
cryptography provider like BouncyCastle and configure it appropriately
in your JVM.
</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 done 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>
Please make sure you use dnsjava <b>2.0.7 or greater</b>
as 2.0.6 and previous versions don't handle correctly some TXT
record escaping that are very common in DKIM public key records.
Failure to include such an updated dnsjava will prevent jDKIM
from correctly verify signatures.
</p>
<p>
The product currently include a generic library module
called &quot;main&quot; and a module providing mailets for DKIM
signing
</p>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">Copyright &#169; 2009-2017
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>