You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-dev@james.apache.org by rd...@apache.org on 2008/08/23 15:24:35 UTC
svn commit: r688314 [14/15] - in /james/site/trunk/www/mailet/crypto: ./
apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/james/
apidocs/org/apache/james/security/
apidocs/org/apache/james/security/class-use/
apidocs/org/apache/james/transp...
Added: james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMECheckSignature.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMECheckSignature.html?rev=688314&view=auto
==============================================================================
--- james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMECheckSignature.html (added)
+++ james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMECheckSignature.html Sat Aug 23 06:24:31 2008
@@ -0,0 +1,245 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>SMIMECheckSignature xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/james/transport/mailets/smime/SMIMECheckSignature.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.mailets.smime;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.security.cert.X509Certificate;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a name="29" href="#29">29</a>
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.mail.Multipart;
+<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeBodyPart;
+<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMessage;
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMultipart;
+<a name="35" href="#35">35</a>
+<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.james.security.KeyStoreHolder;
+<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.james.security.SMIMESignerInfo;
+<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMailet;
+<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.MailetConfig;
+<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.bouncycastle.cms.CMSException;
+<a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.bouncycastle.mail.smime.SMIMEException;
+<a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> org.bouncycastle.mail.smime.SMIMESigned;
+<a name="44" href="#44">44</a>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Verifies the s/mime signature of a message. The s/mime signing ensure that</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * the private key owner is the real sender of the message. To be checked by</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * this mailet the s/mime signature must contain the actual signature, the</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * signer's certificate and optionally a set of certificate that can be used to</em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * create a chain of trust that starts from the signer's certificate and leads</em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * to a known trusted certificate.</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * </p></em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * This check is composed by two steps: firstly it's ensured that the signature</em>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * is valid, then it's checked if a chain of trust starting from the signer</em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * certificate and that leads to a trusted certificate can be created. The first</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * check verifies that the the message has not been modified after the signature</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * was put and that the signer's certificate was valid at the time of the</em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * signing. The latter should ensure that the signer is who he declare to be.</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * </p></em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * The results of the checks perfomed by this mailet are wrote as a mail</em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * attribute which default name is org.apache.james.SMIMECheckSignature (it can</em>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * be changed using the mailet parameter <code>mailAttribute</code>). After</em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * the check this attribute will contain a list of SMIMESignerInfo object, one</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * for each message's signer. These objects contain the signer's certificate and</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * the trust path.</em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * </p></em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Optionally, specifying the parameter <code>strip</code>, the signature of</em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * the message can be stripped after the check. The message will become a</em>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * standard message without an attached s/mime signature.</em>
+<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * </p></em>
+<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * The configuration parameter of this mailet are summerized below. The firsts</em>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * defines the location, the format and the password of the keystore containing</em>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * the certificates that are considered trusted. Note: only the trusted certificate</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * entries are read, the key ones are not.</em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * <ul></em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * <li>keyStoreType (default: jks): Certificate store format . "jks" is the</em>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * standard java certificate store format, but pkcs12 is also quite common and</em>
+<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * compatible with standard email clients like Outlook Express and Thunderbird.</em>
+<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * <li>keyStoreFileName (default: JAVA_HOME/jre/lib/security/cacert): Certificate</em>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * store path.</em>
+<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * <li>keyStorePassword (default: ""): Certificate store password.</em>
+<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * </ul></em>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * Other parameters configure the behavior of the mailet:</em>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * <ul></em>
+<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * <li>strip (default: false): Defines if the s/mime signature of the message</em>
+<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * have to be stripped after the check or not. Possible values are true and</em>
+<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * false.</em>
+<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * <li>mailAttribute (default: org.apache.james.SMIMECheckSignature):</em>
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * specifies in which attribute the check results will be written.</em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * <li>onlyTrusted (default: true): Usually a message signature to be</em>
+<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * considered by this mailet as authentic must be valid and trusted. Setting</em>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * this mailet parameter to "false" the last condition is relaxed and also</em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * "untrusted" signature are considered will be considered as authentic.</em>
+<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * </ul></em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * </p></em>
+<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * </em>
+<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> */</em>
+<a name="103" href="#103">103</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/james/transport/mailets/smime/SMIMECheckSignature.html">SMIMECheckSignature</a> <strong class="jxr_keyword">extends</strong> GenericMailet {
+<a name="104" href="#104">104</a>
+<a name="105" href="#105">105</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/james/security/KeyStoreHolder.html">KeyStoreHolder</a> trustedCertificateStore;
+<a name="106" href="#106">106</a>
+<a name="107" href="#107">107</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> stripSignature = false;
+<a name="108" href="#108">108</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onlyTrusted = <strong class="jxr_keyword">true</strong>;
+<a name="109" href="#109">109</a>
+<a name="110" href="#110">110</a> <strong class="jxr_keyword">protected</strong> String mailAttribute = <span class="jxr_string">"org.apache.james.SMIMECheckSignature"</span>;
+<a name="111" href="#111">111</a>
+<a name="112" href="#112">112</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/james/transport/mailets/smime/SMIMECheckSignature.html">SMIMECheckSignature</a>() {
+<a name="113" href="#113">113</a> <strong class="jxr_keyword">super</strong>();
+<a name="114" href="#114">114</a>
+<a name="115" href="#115">115</a> }
+<a name="116" href="#116">116</a>
+<a name="117" href="#117">117</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="118" href="#118">118</a> MailetConfig config = getMailetConfig();
+<a name="119" href="#119">119</a>
+<a name="120" href="#120">120</a> String stripSignatureConf = config.getInitParameter(<span class="jxr_string">"strip"</span>);
+<a name="121" href="#121">121</a> <strong class="jxr_keyword">if</strong> (stripSignatureConf != <strong class="jxr_keyword">null</strong>) stripSignature = Boolean.valueOf(stripSignatureConf).booleanValue();
+<a name="122" href="#122">122</a>
+<a name="123" href="#123">123</a> String onlyTrustedConf = config.getInitParameter(<span class="jxr_string">"onlyTrusted"</span>);
+<a name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> (onlyTrustedConf != <strong class="jxr_keyword">null</strong>) onlyTrusted = Boolean.valueOf(onlyTrustedConf).booleanValue();
+<a name="125" href="#125">125</a>
+<a name="126" href="#126">126</a> String mailAttributeConf = config.getInitParameter(<span class="jxr_string">"mailAttribute"</span>);
+<a name="127" href="#127">127</a> <strong class="jxr_keyword">if</strong> (mailAttributeConf != <strong class="jxr_keyword">null</strong>) mailAttribute = mailAttributeConf;
+<a name="128" href="#128">128</a>
+<a name="129" href="#129">129</a>
+<a name="130" href="#130">130</a> String type = config.getInitParameter(<span class="jxr_string">"keyStoreType"</span>);
+<a name="131" href="#131">131</a> String file = config.getInitParameter(<span class="jxr_string">"keyStoreFileName"</span>);
+<a name="132" href="#132">132</a> String password = config.getInitParameter(<span class="jxr_string">"keyStorePassword"</span>);
+<a name="133" href="#133">133</a>
+<a name="134" href="#134">134</a> <strong class="jxr_keyword">try</strong> {
+<a name="135" href="#135">135</a> <strong class="jxr_keyword">if</strong> (file != <strong class="jxr_keyword">null</strong>) trustedCertificateStore = <strong class="jxr_keyword">new</strong> KeyStoreHolder(file, password, type);
+<a name="136" href="#136">136</a> <strong class="jxr_keyword">else</strong> {
+<a name="137" href="#137">137</a> log(<span class="jxr_string">"No trusted store path specified, using default store."</span>);
+<a name="138" href="#138">138</a> trustedCertificateStore = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/james/security/KeyStoreHolder.html">KeyStoreHolder</a>(password);
+<a name="139" href="#139">139</a> }
+<a name="140" href="#140">140</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="141" href="#141">141</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Error loading the trusted certificate store"</span>, e);
+<a name="142" href="#142">142</a> }
+<a name="143" href="#143">143</a>
+<a name="144" href="#144">144</a> }
+<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">/**</em>
+<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @see org.apache.mailet.Matcher#match(org.apache.mailet.Mail)</em>
+<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em>
+<a name="148" href="#148">148</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> service(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="149" href="#149">149</a> <em class="jxr_comment">// I extract the MimeMessage from the mail object and I check if the</em>
+<a name="150" href="#150">150</a> <em class="jxr_comment">// mime type of the mail is one of the mime types that can contain a</em>
+<a name="151" href="#151">151</a> <em class="jxr_comment">// signature.</em>
+<a name="152" href="#152">152</a> MimeMessage message = mail.getMessage();
+<a name="153" href="#153">153</a>
+<a name="154" href="#154">154</a> <em class="jxr_comment">// strippedMessage will contain the signed content of the message </em>
+<a name="155" href="#155">155</a> MimeBodyPart strippedMessage =<strong class="jxr_keyword">null</strong>;
+<a name="156" href="#156">156</a>
+<a name="157" href="#157">157</a> List signers=<strong class="jxr_keyword">null</strong>;
+<a name="158" href="#158">158</a>
+<a name="159" href="#159">159</a> <strong class="jxr_keyword">try</strong> {
+<a name="160" href="#160">160</a> Object obj = message.getContent();
+<a name="161" href="#161">161</a> SMIMESigned signed;
+<a name="162" href="#162">162</a> <strong class="jxr_keyword">if</strong> (obj instanceof MimeMultipart) signed = <strong class="jxr_keyword">new</strong> SMIMESigned((MimeMultipart)message.getContent());
+<a name="163" href="#163">163</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof SMIMESigned) signed = (SMIMESigned) obj;
+<a name="164" href="#164">164</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof byte[]) signed = <strong class="jxr_keyword">new</strong> SMIMESigned(message);
+<a name="165" href="#165">165</a> <strong class="jxr_keyword">else</strong> signed = <strong class="jxr_keyword">null</strong>;
+<a name="166" href="#166">166</a>
+<a name="167" href="#167">167</a> <strong class="jxr_keyword">if</strong> (signed != <strong class="jxr_keyword">null</strong>) {
+<a name="168" href="#168">168</a> signers = trustedCertificateStore.verifySignatures(signed);
+<a name="169" href="#169">169</a> strippedMessage = signed.getContent();
+<a name="170" href="#170">170</a> } <strong class="jxr_keyword">else</strong> log(<span class="jxr_string">"Content not identified as signed"</span>);
+<a name="171" href="#171">171</a>
+<a name="172" href="#172">172</a> <em class="jxr_comment">// These errors are logged but they don't cause the </em>
+<a name="173" href="#173">173</a> <em class="jxr_comment">// message to change its state. The message </em>
+<a name="174" href="#174">174</a> <em class="jxr_comment">// is considered as not signed and the process will</em>
+<a name="175" href="#175">175</a> <em class="jxr_comment">// go on.</em>
+<a name="176" href="#176">176</a> } <strong class="jxr_keyword">catch</strong> (CMSException e) {
+<a name="177" href="#177">177</a> log(<span class="jxr_string">"Error during the analysis of the signed message"</span>, e);
+<a name="178" href="#178">178</a> signers = <strong class="jxr_keyword">null</strong>;
+<a name="179" href="#179">179</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
+<a name="180" href="#180">180</a> log(<span class="jxr_string">"IO error during the analysis of the signed message"</span>, e);
+<a name="181" href="#181">181</a> signers = <strong class="jxr_keyword">null</strong>;
+<a name="182" href="#182">182</a> } <strong class="jxr_keyword">catch</strong> (SMIMEException e) {
+<a name="183" href="#183">183</a> log(<span class="jxr_string">"Error during the analysis of the signed message"</span>, e);
+<a name="184" href="#184">184</a> signers = <strong class="jxr_keyword">null</strong>;
+<a name="185" href="#185">185</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="186" href="#186">186</a> e.printStackTrace();
+<a name="187" href="#187">187</a> log(<span class="jxr_string">"Generic error occured during the analysis of the message"</span>, e);
+<a name="188" href="#188">188</a> signers = <strong class="jxr_keyword">null</strong>;
+<a name="189" href="#189">189</a> }
+<a name="190" href="#190">190</a>
+<a name="191" href="#191">191</a> <em class="jxr_comment">// If at least one mail signer is found </em>
+<a name="192" href="#192">192</a> <em class="jxr_comment">// the mail attributes are set.</em>
+<a name="193" href="#193">193</a> <strong class="jxr_keyword">if</strong> (signers != <strong class="jxr_keyword">null</strong>) {
+<a name="194" href="#194">194</a> ArrayList signerinfolist = <strong class="jxr_keyword">new</strong> ArrayList();
+<a name="195" href="#195">195</a>
+<a name="196" href="#196">196</a> <strong class="jxr_keyword">for</strong> (Iterator iter = signers.iterator(); iter.hasNext();) {
+<a name="197" href="#197">197</a> <a href="../../../../../../org/apache/james/security/SMIMESignerInfo.html">SMIMESignerInfo</a> info = (SMIMESignerInfo) iter.next();
+<a name="198" href="#198">198</a>
+<a name="199" href="#199">199</a> <strong class="jxr_keyword">if</strong> (info.isSignValid()
+<a name="200" href="#200">200</a> && (!onlyTrusted || info.getCertPath() != <strong class="jxr_keyword">null</strong>)) {
+<a name="201" href="#201">201</a> signerinfolist.add((X509Certificate) info.getSignerCertificate());
+<a name="202" href="#202">202</a> }
+<a name="203" href="#203">203</a> }
+<a name="204" href="#204">204</a>
+<a name="205" href="#205">205</a> <strong class="jxr_keyword">if</strong> (signerinfolist.size() > 0) {
+<a name="206" href="#206">206</a> mail.setAttribute(mailAttribute, signerinfolist);
+<a name="207" href="#207">207</a> } <strong class="jxr_keyword">else</strong> {
+<a name="208" href="#208">208</a> <em class="jxr_comment">// if no valid signers are found the message is not modified.</em>
+<a name="209" href="#209">209</a> strippedMessage = <strong class="jxr_keyword">null</strong>;
+<a name="210" href="#210">210</a> }
+<a name="211" href="#211">211</a> }
+<a name="212" href="#212">212</a>
+<a name="213" href="#213">213</a> <strong class="jxr_keyword">if</strong> (stripSignature && strippedMessage != <strong class="jxr_keyword">null</strong>) {
+<a name="214" href="#214">214</a> <strong class="jxr_keyword">try</strong> {
+<a name="215" href="#215">215</a> Object obj = strippedMessage.getContent();
+<a name="216" href="#216">216</a> <strong class="jxr_keyword">if</strong> (obj instanceof Multipart) {
+<a name="217" href="#217">217</a> message.setContent((Multipart) obj);
+<a name="218" href="#218">218</a> } <strong class="jxr_keyword">else</strong> {
+<a name="219" href="#219">219</a> message.setContent(obj, strippedMessage.getContentType());
+<a name="220" href="#220">220</a> }
+<a name="221" href="#221">221</a> message.saveChanges();
+<a name="222" href="#222">222</a> mail.setMessage(message);
+<a name="223" href="#223">223</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="224" href="#224">224</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(
+<a name="225" href="#225">225</a> <span class="jxr_string">"Error during the extraction of the signed content from the message."</span>,
+<a name="226" href="#226">226</a> e);
+<a name="227" href="#227">227</a> }
+<a name="228" href="#228">228</a> }
+<a name="229" href="#229">229</a> }
+<a name="230" href="#230">230</a>
+<a name="231" href="#231">231</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMEDecrypt.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMEDecrypt.html?rev=688314&view=auto
==============================================================================
--- james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMEDecrypt.html (added)
+++ james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMEDecrypt.html Sat Aug 23 06:24:31 2008
@@ -0,0 +1,177 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>SMIMEDecrypt xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/james/transport/mailets/smime/SMIMEDecrypt.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.mailets.smime;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.security.GeneralSecurityException;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
+<a name="29" href="#29">29</a>
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.mail.Multipart;
+<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.mail.Part;
+<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeBodyPart;
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMessage;
+<a name="35" href="#35">35</a>
+<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.james.security.SMIMEKeyHolder;
+<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMailet;
+<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.MailetConfig;
+<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.bouncycastle.cms.CMSException;
+<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.bouncycastle.cms.RecipientId;
+<a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.bouncycastle.cms.RecipientInformation;
+<a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> org.bouncycastle.mail.smime.SMIMEEnveloped;
+<a name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> org.bouncycastle.mail.smime.SMIMEUtil;
+<a name="45" href="#45">45</a>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * This mailet decrypts a s/mime encrypted message. It takes as input an</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * encrypted message and it tries to dechiper it using the key specified in its</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * configuration. If the decryption is successful the mail will be changed and</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * it will contain the decrypted message. The mail attribute</em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <code>org.apache.james.SMIMEDecrypt</code> will contain the public</em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * certificate of the key used in the process. </em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * </em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * The configuration parameters of this mailet are summarized below. The firsts</em>
+<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * define the keystore where the key that will be used to decrypt messages is</em>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * saved.</em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * <ul></em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <li>keyStoreType (default: system dependent): defines the type of the store.</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Usually jks, pkcs12 or pkcs7</li></em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * <li>keyStoreFileName (mandatory): private key store path.</li></em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * <li>keyStorePassword (default: ""): private key store password</li></em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * </ul></em>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * The other parameters define which private key have to be used. (if the store</em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * contains more than one key).</em>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * <ul></em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * <li>keyAlias: private key alias.</li></em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <li>keyPass: private key password</li></em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * </ul></em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * </em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em>
+<a name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/james/transport/mailets/smime/SMIMEDecrypt.html">SMIMEDecrypt</a> <strong class="jxr_keyword">extends</strong> GenericMailet {
+<a name="72" href="#72">72</a>
+<a name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/james/security/SMIMEKeyHolder.html">SMIMEKeyHolder</a> keyHolder;
+<a name="74" href="#74">74</a> <strong class="jxr_keyword">protected</strong> String mailAttribute = <span class="jxr_string">"org.apache.james.SMIMEDecrypt"</span>;
+<a name="75" href="#75">75</a>
+<a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="77" href="#77">77</a> <strong class="jxr_keyword">super</strong>.init();
+<a name="78" href="#78">78</a>
+<a name="79" href="#79">79</a> MailetConfig config = getMailetConfig();
+<a name="80" href="#80">80</a>
+<a name="81" href="#81">81</a> String privateStoreType = config.getInitParameter(<span class="jxr_string">"keyStoreType"</span>);
+<a name="82" href="#82">82</a>
+<a name="83" href="#83">83</a> String privateStoreFile = config.getInitParameter(<span class="jxr_string">"keyStoreFileName"</span>);
+<a name="84" href="#84">84</a> <strong class="jxr_keyword">if</strong> (privateStoreFile == <strong class="jxr_keyword">null</strong>) <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"No keyStoreFileName specified"</span>);
+<a name="85" href="#85">85</a>
+<a name="86" href="#86">86</a> String privateStorePass = config.getInitParameter(<span class="jxr_string">"keyStorePassword"</span>);
+<a name="87" href="#87">87</a>
+<a name="88" href="#88">88</a> String keyAlias= config.getInitParameter(<span class="jxr_string">"keyAlias"</span>);
+<a name="89" href="#89">89</a> String keyPass = config.getInitParameter(<span class="jxr_string">"keyAliasPassword"</span>);
+<a name="90" href="#90">90</a>
+<a name="91" href="#91">91</a> String mailAttributeConf = config.getInitParameter(<span class="jxr_string">"mailAttribute"</span>);
+<a name="92" href="#92">92</a> <strong class="jxr_keyword">if</strong> (mailAttributeConf != <strong class="jxr_keyword">null</strong>) mailAttribute = mailAttributeConf;
+<a name="93" href="#93">93</a>
+<a name="94" href="#94">94</a> <strong class="jxr_keyword">try</strong> {
+<a name="95" href="#95">95</a> keyHolder = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/james/security/SMIMEKeyHolder.html">SMIMEKeyHolder</a>(privateStoreFile, privateStorePass, keyAlias, keyPass, privateStoreType);
+<a name="96" href="#96">96</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
+<a name="97" href="#97">97</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Error loading keystore"</span>, e);
+<a name="98" href="#98">98</a> } <strong class="jxr_keyword">catch</strong> (GeneralSecurityException e) {
+<a name="99" href="#99">99</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Error loading keystore"</span>, e);
+<a name="100" href="#100">100</a> }
+<a name="101" href="#101">101</a>
+<a name="102" href="#102">102</a>
+<a name="103" href="#103">103</a> }
+<a name="104" href="#104">104</a> <em class="jxr_comment">/*<em class="jxr_comment"> (non-Javadoc)</em></em>
+<a name="105" href="#105">105</a> <em class="jxr_comment"> * @see org.apache.mailet.Mailet#service(org.apache.mailet.Mail)</em>
+<a name="106" href="#106">106</a> <em class="jxr_comment"> */</em>
+<a name="107" href="#107">107</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> service(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="108" href="#108">108</a> MimeMessage message = mail.getMessage();
+<a name="109" href="#109">109</a> Part strippedMessage = <strong class="jxr_keyword">null</strong>;
+<a name="110" href="#110">110</a> log(<span class="jxr_string">"Starting message decryption.."</span>);
+<a name="111" href="#111">111</a> <strong class="jxr_keyword">if</strong> (message.isMimeType(<span class="jxr_string">"application/x-pkcs7-mime"</span>) || message.isMimeType(<span class="jxr_string">"application/pkcs7-mime"</span>)) {
+<a name="112" href="#112">112</a> <strong class="jxr_keyword">try</strong> {
+<a name="113" href="#113">113</a> SMIMEEnveloped env = <strong class="jxr_keyword">new</strong> SMIMEEnveloped(message);
+<a name="114" href="#114">114</a> Collection recipients = env.getRecipientInfos().getRecipients();
+<a name="115" href="#115">115</a> <strong class="jxr_keyword">for</strong> (Iterator iter = recipients.iterator();iter.hasNext();) {
+<a name="116" href="#116">116</a> RecipientInformation info = (RecipientInformation) iter.next();
+<a name="117" href="#117">117</a> RecipientId id = info.getRID();
+<a name="118" href="#118">118</a> <strong class="jxr_keyword">if</strong> (id.match(keyHolder.getCertificate())) {
+<a name="119" href="#119">119</a> <strong class="jxr_keyword">try</strong> {
+<a name="120" href="#120">120</a> MimeBodyPart part = SMIMEUtil.toMimeBodyPart(info.getContent(keyHolder.getPrivateKey(), <span class="jxr_string">"BC"</span>));
+<a name="121" href="#121">121</a> <em class="jxr_comment">// strippedMessage contains the decrypted message.</em>
+<a name="122" href="#122">122</a> strippedMessage = part;
+<a name="123" href="#123">123</a> log(<span class="jxr_string">"Encrypted message decrypted"</span>);
+<a name="124" href="#124">124</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="125" href="#125">125</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Error during the decryption of the message"</span>, e); }
+<a name="126" href="#126">126</a> } <strong class="jxr_keyword">else</strong> {
+<a name="127" href="#127">127</a> log(<span class="jxr_string">"Found an encrypted message but it isn't encrypted for the supplied key"</span>);
+<a name="128" href="#128">128</a> }
+<a name="129" href="#129">129</a> }
+<a name="130" href="#130">130</a> } <strong class="jxr_keyword">catch</strong> (CMSException e) { <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Error during the decryption of the message"</span>,e); }
+<a name="131" href="#131">131</a> }
+<a name="132" href="#132">132</a>
+<a name="133" href="#133">133</a> <em class="jxr_comment">// if the decryption has been successful..</em>
+<a name="134" href="#134">134</a> <strong class="jxr_keyword">if</strong> (strippedMessage != <strong class="jxr_keyword">null</strong>) {
+<a name="135" href="#135">135</a> <em class="jxr_comment">// I put the private key's public certificate as a mailattribute.</em>
+<a name="136" href="#136">136</a> <em class="jxr_comment">// I create a list of certificate because I want to minic the</em>
+<a name="137" href="#137">137</a> <em class="jxr_comment">// behavior of the SMIMEVerifySignature mailet. In that way</em>
+<a name="138" href="#138">138</a> <em class="jxr_comment">// it is possible to reuse the same matchers to analyze</em>
+<a name="139" href="#139">139</a> <em class="jxr_comment">// the result of the operation.</em>
+<a name="140" href="#140">140</a> ArrayList list = <strong class="jxr_keyword">new</strong> ArrayList(1);
+<a name="141" href="#141">141</a> list.add(keyHolder.getCertificate());
+<a name="142" href="#142">142</a> mail.setAttribute(mailAttribute, list);
+<a name="143" href="#143">143</a>
+<a name="144" href="#144">144</a> <em class="jxr_comment">// I start the message stripping.</em>
+<a name="145" href="#145">145</a> <strong class="jxr_keyword">try</strong> {
+<a name="146" href="#146">146</a> MimeMessage newmex = <strong class="jxr_keyword">new</strong> MimeMessage(message);
+<a name="147" href="#147">147</a> Object obj = strippedMessage.getContent();
+<a name="148" href="#148">148</a> <strong class="jxr_keyword">if</strong> (obj instanceof Multipart) {
+<a name="149" href="#149">149</a> log(<span class="jxr_string">"The message is multipart, content type "</span>+((Multipart)obj).getContentType());
+<a name="150" href="#150">150</a> newmex.setContent((Multipart)obj);
+<a name="151" href="#151">151</a> } <strong class="jxr_keyword">else</strong> {
+<a name="152" href="#152">152</a> newmex.setContent(obj, strippedMessage.getContentType());
+<a name="153" href="#153">153</a> newmex.setDisposition(<strong class="jxr_keyword">null</strong>);
+<a name="154" href="#154">154</a> }
+<a name="155" href="#155">155</a> newmex.saveChanges();
+<a name="156" href="#156">156</a> mail.setMessage(newmex);
+<a name="157" href="#157">157</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
+<a name="158" href="#158">158</a> log(<span class="jxr_string">"Error during the strip of the encrypted message"</span>);
+<a name="159" href="#159">159</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Error during the stripping of the encrypted message"</span>,e);
+<a name="160" href="#160">160</a> }
+<a name="161" href="#161">161</a> }
+<a name="162" href="#162">162</a> }
+<a name="163" href="#163">163</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMESign.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMESign.html?rev=688314&view=auto
==============================================================================
--- james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMESign.html (added)
+++ james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/SMIMESign.html Sat Aug 23 06:24:31 2008
@@ -0,0 +1,230 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>SMIMESign xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/james/transport/mailets/smime/SMIMESign.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.mailets.smime;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="25" href="#25">25</a>
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeBodyPart;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMessage;
+<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMultipart;
+<a name="30" href="#30">30</a>
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="32" href="#32">32</a>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <p>Puts a <I>server-side</I> SMIME signature on a message.<br></em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * It is a concrete subclass of {@link Sign}, with very few modifications to it,</em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * to specialize for SMIME.</p></em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> *</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <P>Handles the following init parameters (will comment only the differences from {@link AbstractSign}):</P></em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <ul></em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <li>&lt;debug&gt;.</li></em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <li>&lt;keyStoreFileName&gt;.</li></em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <li>&lt;keyStorePassword&gt;.</li></em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * <li>&lt;keyAlias&gt;.</li></em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <li>&lt;keyAliasPassword&gt;.</li></em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <li>&lt;keyStoreType&gt;.</li></em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <li>&lt;postmasterSigns&gt;. The default is <CODE>true</CODE>.</li></em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <li>&lt;rebuildFrom&gt;. The default is <CODE>true</CODE>.</li></em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <li>&lt;signerName&gt;.</li></em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <li>&lt;explanationText&gt;. There is a default explanation string template in English,</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * displaying also all the headers of the original message (see {@link #getExplanationText}).</li></em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * </ul></em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @version CVS $Revision: 647925 $ $Date: 2008-04-14 19:38:17 +0100 (Mon, 14 Apr 2008) $</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @since 2.3.0</em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em>
+<a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/james/transport/mailets/smime/SMIMESign.html">SMIMESign</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/james/transport/mailets/smime/Sign.html">Sign</a> {
+<a name="56" href="#56">56</a>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Return a string describing this mailet.</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> *</em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @return a string describing this mailet</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em>
+<a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> String getMailetInfo() {
+<a name="63" href="#63">63</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"SMIME Signature Mailet"</span>;
+<a name="64" href="#64">64</a> }
+<a name="65" href="#65">65</a>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> *</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
+<a name="69" href="#69">69</a> <strong class="jxr_keyword">protected</strong> String[] getAllowedInitParameters() {
+<a name="70" href="#70">70</a> String[] allowedArray = {
+<a name="71" href="#71">71</a> <span class="jxr_string">"debug"</span>,
+<a name="72" href="#72">72</a> <span class="jxr_string">"keyStoreFileName"</span>,
+<a name="73" href="#73">73</a> <span class="jxr_string">"keyStorePassword"</span>,
+<a name="74" href="#74">74</a> <span class="jxr_string">"keyStoreType"</span>,
+<a name="75" href="#75">75</a> <span class="jxr_string">"keyAlias"</span>,
+<a name="76" href="#76">76</a> <span class="jxr_string">"keyAliasPassword"</span>,
+<a name="77" href="#77">77</a> <span class="jxr_string">"signerName"</span>,
+<a name="78" href="#78">78</a> <span class="jxr_string">"postmasterSigns"</span>,
+<a name="79" href="#79">79</a> <span class="jxr_string">"rebuildFrom"</span>,
+<a name="80" href="#80">80</a> <span class="jxr_string">"explanationText"</span>
+<a name="81" href="#81">81</a> };
+<a name="82" href="#82">82</a> <strong class="jxr_keyword">return</strong> allowedArray;
+<a name="83" href="#83">83</a> }
+<a name="84" href="#84">84</a>
+<a name="85" href="#85">85</a> <em class="jxr_comment">/*<em class="jxr_comment"> ******************************************************************** */</em></em>
+<a name="86" href="#86">86</a> <em class="jxr_comment">/*<em class="jxr_comment"> ****************** Begin of setters and getters ******************** */</em></em>
+<a name="87" href="#87">87</a> <em class="jxr_comment">/*<em class="jxr_comment"> ******************************************************************** */</em> </em>
+<a name="88" href="#88">88</a>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em>
+<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * If the <CODE>&lt;explanationText&gt;</CODE> init parameter is missing</em>
+<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * returns the following default explanation template string:</em>
+<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * <pre><code></em>
+<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * The message this file is attached to has been signed on the server by</em>
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * "[signerName]" <[signerAddress]></em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * to certify that the sender is known and truly has the following address (reverse-path):</em>
+<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * [reversePath]</em>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * and that the original message has the following message headers:</em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> *</em>
+<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * [headers]</em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> *</em>
+<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * The signature envelopes this attachment too.</em>
+<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * Please check the signature integrity.</em>
+<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> *</em>
+<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * "[signerName]" <[signerAddress]></em>
+<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * </code></pre></em>
+<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em>
+<a name="107" href="#107">107</a> <strong class="jxr_keyword">public</strong> String getExplanationText() {
+<a name="108" href="#108">108</a> String explanationText = <strong class="jxr_keyword">super</strong>.getExplanationText();
+<a name="109" href="#109">109</a> <strong class="jxr_keyword">if</strong> (explanationText == <strong class="jxr_keyword">null</strong>) {
+<a name="110" href="#110">110</a> explanationText = <span class="jxr_string">"The message this file is attached to has been signed on the server by\r\n"</span>
+<a name="111" href="#111">111</a> + <span class="jxr_string">"\t\"[signerName]\" <[signerAddress]>"</span>
+<a name="112" href="#112">112</a> + <span class="jxr_string">"\r\nto certify that the sender is known and truly has the following address (reverse-path):\r\n"</span>
+<a name="113" href="#113">113</a> + <span class="jxr_string">"\t[reversePath]"</span>
+<a name="114" href="#114">114</a> + <span class="jxr_string">"\r\nand that the original message has the following message headers:\r\n"</span>
+<a name="115" href="#115">115</a> + <span class="jxr_string">"\r\n[headers]"</span>
+<a name="116" href="#116">116</a> + <span class="jxr_string">"\r\n\r\nThe signature envelopes this attachment too."</span>
+<a name="117" href="#117">117</a> + <span class="jxr_string">"\r\nPlease check the signature integrity."</span>
+<a name="118" href="#118">118</a> + <span class="jxr_string">"\r\n\r\n"</span>
+<a name="119" href="#119">119</a> + <span class="jxr_string">"\t\"[signerName]\" <[signerAddress]>"</span>;
+<a name="120" href="#120">120</a> }
+<a name="121" href="#121">121</a>
+<a name="122" href="#122">122</a> <strong class="jxr_keyword">return</strong> explanationText;
+<a name="123" href="#123">123</a> }
+<a name="124" href="#124">124</a>
+<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">/**</em>
+<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * Initializer for property keyHolderClass.</em>
+<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * Hardcodes it to {@link org.apache.james.security.SMIMEKeyHolder}.</em>
+<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em>
+<a name="129" href="#129">129</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initKeyHolderClass() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="130" href="#130">130</a> String keyHolderClassName = <span class="jxr_string">"org.apache.james.security.SMIMEKeyHolder"</span>;
+<a name="131" href="#131">131</a> <strong class="jxr_keyword">try</strong> {
+<a name="132" href="#132">132</a> setKeyHolderClass(Class.forName(keyHolderClassName));
+<a name="133" href="#133">133</a> } <strong class="jxr_keyword">catch</strong> (ClassNotFoundException cnfe) {
+<a name="134" href="#134">134</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(keyHolderClassName + <span class="jxr_string">"does not exist."</span>);
+<a name="135" href="#135">135</a> }
+<a name="136" href="#136">136</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="137" href="#137">137</a> log(<span class="jxr_string">"keyHolderClass: "</span> + getKeyHolderClass());
+<a name="138" href="#138">138</a> }
+<a name="139" href="#139">139</a> }
+<a name="140" href="#140">140</a>
+<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em>
+<a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * If the <CODE>&lt;postmasterSigns&gt;</CODE> init parameter is missing sets it to <I>true</I>.</em>
+<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> */</em>
+<a name="144" href="#144">144</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initPostmasterSigns() {
+<a name="145" href="#145">145</a> setPostmasterSigns((getInitParameter(<span class="jxr_string">"postmasterSigns"</span>) == <strong class="jxr_keyword">null</strong>) ? <strong class="jxr_keyword">true</strong> : <strong class="jxr_keyword">new</strong> Boolean(getInitParameter(<span class="jxr_string">"postmasterSigns"</span>)).booleanValue());
+<a name="146" href="#146">146</a> }
+<a name="147" href="#147">147</a>
+<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">/**</em>
+<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * If the <CODE>&lt;rebuildFrom&gt;</CODE> init parameter is missing sets it to <I>true</I>.</em>
+<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em>
+<a name="151" href="#151">151</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initRebuildFrom() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="152" href="#152">152</a> setRebuildFrom((getInitParameter(<span class="jxr_string">"rebuildFrom"</span>) == <strong class="jxr_keyword">null</strong>) ? <strong class="jxr_keyword">true</strong> : <strong class="jxr_keyword">new</strong> Boolean(getInitParameter(<span class="jxr_string">"rebuildFrom"</span>)).booleanValue());
+<a name="153" href="#153">153</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="154" href="#154">154</a> <strong class="jxr_keyword">if</strong> (isRebuildFrom()) {
+<a name="155" href="#155">155</a> log(<span class="jxr_string">"Will modify the \"From:\" header."</span>);
+<a name="156" href="#156">156</a> } <strong class="jxr_keyword">else</strong> {
+<a name="157" href="#157">157</a> log(<span class="jxr_string">"Will leave the \"From:\" header unchanged."</span>);
+<a name="158" href="#158">158</a> }
+<a name="159" href="#159">159</a> }
+<a name="160" href="#160">160</a> }
+<a name="161" href="#161">161</a>
+<a name="162" href="#162">162</a> <em class="jxr_comment">/*<em class="jxr_comment"> ******************************************************************** */</em></em>
+<a name="163" href="#163">163</a> <em class="jxr_comment">/*<em class="jxr_comment"> ****************** End of setters and getters ********************** */</em></em>
+<a name="164" href="#164">164</a> <em class="jxr_comment">/*<em class="jxr_comment"> ******************************************************************** */</em></em>
+<a name="165" href="#165">165</a>
+<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">/**</em>
+<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * A text file with the massaged contents of {@link #getExplanationText}</em>
+<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * is attached to the original message.</em>
+<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> */</em>
+<a name="170" href="#170">170</a> <strong class="jxr_keyword">protected</strong> MimeBodyPart getWrapperBodyPart(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException, IOException {
+<a name="171" href="#171">171</a>
+<a name="172" href="#172">172</a> String explanationText = getExplanationText();
+<a name="173" href="#173">173</a>
+<a name="174" href="#174">174</a> <em class="jxr_comment">// if there is no explanation text there should be no wrapping</em>
+<a name="175" href="#175">175</a> <strong class="jxr_keyword">if</strong> (explanationText == <strong class="jxr_keyword">null</strong>) {
+<a name="176" href="#176">176</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="177" href="#177">177</a> }
+<a name="178" href="#178">178</a>
+<a name="179" href="#179">179</a> MimeMessage originalMessage = mail.getMessage();
+<a name="180" href="#180">180</a>
+<a name="181" href="#181">181</a> MimeBodyPart messagePart = <strong class="jxr_keyword">new</strong> MimeBodyPart();
+<a name="182" href="#182">182</a> MimeBodyPart signatureReason = <strong class="jxr_keyword">new</strong> MimeBodyPart();
+<a name="183" href="#183">183</a>
+<a name="184" href="#184">184</a> String contentType = originalMessage.getContentType();
+<a name="185" href="#185">185</a> Object content = originalMessage.getContent();
+<a name="186" href="#186">186</a>
+<a name="187" href="#187">187</a> <strong class="jxr_keyword">if</strong> (contentType != <strong class="jxr_keyword">null</strong> && content != <strong class="jxr_keyword">null</strong>) {
+<a name="188" href="#188">188</a> messagePart.setContent(content, contentType);
+<a name="189" href="#189">189</a> } <strong class="jxr_keyword">else</strong> {
+<a name="190" href="#190">190</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Either the content type or the content is null"</span>);
+<a name="191" href="#191">191</a> }
+<a name="192" href="#192">192</a>
+<a name="193" href="#193">193</a> String headers = getMessageHeaders(originalMessage);
+<a name="194" href="#194">194</a>
+<a name="195" href="#195">195</a> signatureReason.setText(getReplacedExplanationText(getExplanationText(),
+<a name="196" href="#196">196</a> getSignerName(),
+<a name="197" href="#197">197</a> getKeyHolder().getSignerAddress(),
+<a name="198" href="#198">198</a> mail.getSender().toString(),
+<a name="199" href="#199">199</a> headers));
+<a name="200" href="#200">200</a>
+<a name="201" href="#201">201</a> signatureReason.setFileName(<span class="jxr_string">"SignatureExplanation.txt"</span>);
+<a name="202" href="#202">202</a>
+<a name="203" href="#203">203</a> MimeMultipart wrapperMultiPart = <strong class="jxr_keyword">new</strong> MimeMultipart();
+<a name="204" href="#204">204</a>
+<a name="205" href="#205">205</a> wrapperMultiPart.addBodyPart(messagePart);
+<a name="206" href="#206">206</a> wrapperMultiPart.addBodyPart(signatureReason);
+<a name="207" href="#207">207</a>
+<a name="208" href="#208">208</a> MimeBodyPart wrapperBodyPart = <strong class="jxr_keyword">new</strong> MimeBodyPart();
+<a name="209" href="#209">209</a>
+<a name="210" href="#210">210</a> wrapperBodyPart.setContent(wrapperMultiPart);
+<a name="211" href="#211">211</a>
+<a name="212" href="#212">212</a> <strong class="jxr_keyword">return</strong> wrapperBodyPart;
+<a name="213" href="#213">213</a> }
+<a name="214" href="#214">214</a>
+<a name="215" href="#215">215</a> }
+<a name="216" href="#216">216</a>
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+