Java Doc for SMIMEAbstractSign.java in  » Net » james-2.3.1 » org » apache » james » transport » mailets » smime » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Abstract mailet providing common SMIME signature services.
It can be subclassed to make authoring signing mailets simple.
By extending it and overriding one or more of the following methods a new behaviour can be quickly created without the author having to address any issue other than the relevant one:

• SMIMEAbstractSign.initDebug , SMIMEAbstractSign.setDebug and SMIMEAbstractSign.isDebug manage the debugging mode.
• SMIMEAbstractSign.initExplanationText , SMIMEAbstractSign.setExplanationText and SMIMEAbstractSign.getExplanationText manage the text of an attachment that will be added to explain the meaning of this server-side signature.
• SMIMEAbstractSign.initKeyHolder , SMIMEAbstractSign.setKeyHolder and SMIMEAbstractSign.getKeyHolder manage the KeyHolder object that will contain the keys and certificates and will do the crypto work.
• SMIMEAbstractSign.initPostmasterSigns , SMIMEAbstractSign.setPostmasterSigns and SMIMEAbstractSign.isPostmasterSigns determines whether messages originated by the Postmaster will be signed or not.
• SMIMEAbstractSign.initRebuildFrom , SMIMEAbstractSign.setRebuildFrom and SMIMEAbstractSign.isRebuildFrom determines whether the "From:" header will be rebuilt to neutralize the wrong behaviour of some MUAs like Microsoft Outlook Express.
• SMIMEAbstractSign.initSignerName , SMIMEAbstractSign.setSignerName and SMIMEAbstractSign.getSignerName manage the name of the signer to be shown in the explanation text.
• SMIMEAbstractSign.isOkToSign controls whether the mail can be signed or not.
• The abstract method SMIMEAbstractSign.getWrapperBodyPart returns the massaged javax.mail.internet.MimeBodyPart that will be signed, or null if the message has to be signed "as is".

Handles the following init parameters:

• <debug>: if true some useful information is logged. The default is false.
• <keyStoreFileName>: the java.security.KeyStore full file name.
• <keyStorePassword>: the KeyStore password. If given, it is used to check the integrity of the keystore data, otherwise, if null, the integrity of the keystore is not checked.
• <keyAlias>: the alias name to use to search the Key using java.security.KeyStore.getKey . The default is to look for the first and only alias in the keystore; if zero or more than one is found a java.security.KeyStoreException is thrown.
• <keyAliasPassword>: the alias password. The default is to use the KeyStore password. At least one of the passwords must be provided.
• <keyStoreType>: the type of the keystore. The default will use java.security.KeyStore.getDefaultType .
• <postmasterSigns>: if true the message will be signed even if the sender is the Postmaster. The default is false.
• <rebuildFrom>: If true will modify the "From:" header. For more info see SMIMEAbstractSign.isRebuildFrom . The default is false.
• <signerName>: the name of the signer to be shown in the explanation text. The default is to use the "CN=" property of the signing certificate.
• <explanationText>: the text of an explanation of the meaning of this server-side signature. May contain the following substitution patterns (see also SMIMEAbstractSign.getReplacedExplanationText ): [signerName], [signerAddress], [reversePath], [headers]. It should be included in the signature. The actual presentation of the text depends on the specific concrete mailet subclass: see for example SMIMESign . The default is to not have any explanation text.

Checks if the mail can be signed.

Rules:

1. The reverse-path != null (it is not a bounce).
2. The sender user must have been SMTP authenticated.
3. Either:
• The reverse-path is the postmaster address and SMIMEAbstractSign.isPostmasterSigns returns true
• or the reverse-path == the authenticated user and there is at least one "From:" address == reverse-path.
.
4. The message has not already been signed (mimeType != multipart/signed and != application/pkcs7-mime).

The modification is as follows: assuming that the signer mail address in the signer certificate is trusted-server@xxx.com> and that From: "John Smith" we will get From: "John Smith" " <trusted-server@xxx.com>.

If the "ReplyTo:" header is missing or empty it will be set to the original "From:" header.

Such modification is necessary to achieve a correct behaviour with some mail clients (e.g.

Checks if the mail can be signed.

Rules:

1. The reverse-path != null (it is not a bounce).
2. The sender user must have been SMTP authenticated.
3. Either:
• The reverse-path is the postmaster address and SMIMEAbstractSign.isPostmasterSigns returns true
• or the reverse-path == the authenticated user and there is at least one "From:" address == reverse-path.
.
4. The message has not already been signed (mimeType != multipart/signed and != application/pkcs7-mime).

The modification is as follows: assuming that the signer mail address in the signer certificate is trusted-server@xxx.com> and that From: "John Smith" we will get From: "John Smith" " <trusted-server@xxx.com>.

If the "ReplyTo:" header is missing or empty it will be set to the original "From:" header.

Such modification is necessary to achieve a correct behaviour with some mail clients (e.g. Microsoft Outlook Express).