iaik.smime

Class SMimeParameters

java.lang.Object

iaik.smime.SMimeParameters

public class SMimeParameters
extends java.lang.Object

Class for deciding whether to use old or new S/MIME content types and defining a specific canonicalization scheme. For switching between old/new content types use method useNewContentTypes(boolean newType). Calling this method only is meaningful when creating a new message. If newType is set to false the old types are used (application/x-pkcs7-signature respectively application/x-pkcs7-mime). If newType is set to false the new types are used (application/pkcs7-signature respectively application/pkcs7-mime).

Per default the new types are used. For changing the types, useNewContentTypes has to be called before creating a SignedContent or EncryptedContent object, e.g.:

 //switch to new content types
 SMimeParameters.useNewContentTypes(true);
 //create a SignedContent
 boolean implicit = ...;
 SignedContent sc = new SignedContent(implicit, SignedContent.SIGNED_DATA);
 

For telling JAF the data content handlers for the supported S/MIME types, a RFC1524 mailcap file with the following contents has to be put in the lib directory of your JDK (/lib):

 # Default mailcap file for the JavaMail System
 #
 # for our content-handlers
 #
 text/plain;;   x-java-content-handler=com.sun.mail.handlers.text_plain
 multipart/*;;  x-java-content-handler=com.sun.mail.handlers.multipart_mixed
 message/*;;    x-java-content-handler=com.sun.mail.handlers.message_rfc822
 #
 # IAIK 'mailcap' file
 #
 multipart/signed;;               x-java-content-handler=iaik.smime.signed_content
 application/x-pkcs7-signature;;  x-java-content-handler=iaik.smime.signed_content
 application/x-pkcs7-mime;;       x-java-content-handler=iaik.smime.encrypted_content
 application/x-pkcs10;;           x-java-content-handler=iaik.smime.pkcs10_content
 application/pkcs7-signature;;    x-java-content-handler=iaik.smime.signed_content
 application/pkcs7-mime;;         x-java-content-handler=iaik.smime.encrypted_content
 application/pkcs10;;             x-java-content-handler=iaik.smime.pkcs10_content
 

The class provides the ability to control the SMIME canonicalization scheme. The SMIME canonicalization scheme can be set globally using setCanonicalizer(Canonicalizer), and on a per thread basis using registerCanonicalizer(Canonicalizer). When a canonicalization scheme has been registered for a given thread, that scheme is used. When a canonicalization scheme has not been registered for a given thread, the global canonicalization scheme is used.

By default, the global canonicalization scheme is set. This scheme is defined in DefaultCanonicalizer; it ensures that <CR> and <LF> always occurs together as <CR><LF> except when binary content transfer encoding is used.

Note that for outging messages the canonicalization scheme is only used when modelling body parts and multiparts using classes SMimeBodyPart and SMimeMultipart, or when supplying a text message by means of method setText for a multipart/signed SignedContent object. When parsing an incoming message the canonicalization scheme is only used for the contents part of a multipart/signed message.

Method Summary

Methods

Modifier and Type	Method and Description
static void	deregisterCanonicalizer() Deregisters the SMIME canonicalization scheme for the current thread of execution.
static boolean	getNewContentTypes() Returns whether new or old content types are used when creating a new S/Mime message.
static void	registerCanonicalizer(Canonicalizer canonicalizer) Registers an SMIME canonicalization scheme for the current thread of execution.
static void	setCanonicalizer(Canonicalizer canonicalizer) Sets the global SMIME canonicalization scheme.
static void	useNewContentTypes(boolean newType) Decides whether to use old or new S/MIME content types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

useNewContentTypes

public static void useNewContentTypes(boolean newType)

Decides whether to use old or new S/MIME content types. This method only is meaningful when creating a new message. If newType is set to false the old types are used (application/x-pkcs7-signature respectively application/x-pkcs7-mime). If newType is set to false the new types are used (application/pkcs7-signature respectively application/pkcs7-mime). Per default the new types are used.

Parameters:

newType - true for using new types, false if not

getNewContentTypes

public static boolean getNewContentTypes()

Returns whether new or old content types are used when creating a new S/Mime message.

Returns:

true if new types (application/pkcs7-signature respectively application/pkcs7-mime), and false if the old types (application/x-pkcs7-signature respectively application/x-pkcs7-mime) are used

setCanonicalizer

public static void setCanonicalizer(Canonicalizer canonicalizer)

Sets the global SMIME canonicalization scheme.

Parameters:

canonicalizer - the SMIME canonicalization scheme

registerCanonicalizer

public static void registerCanonicalizer(Canonicalizer canonicalizer)

Registers an SMIME canonicalization scheme for the current thread of execution.

Only call this method if you wish to use a canonicalization scheme other than the default DefaultCanonicalizer.

The registered canonicalization scheme will be used for all canonicalization required during SMIME operations done by the current thread of execution.

Parameters:

canonicalizer - the SMIME canonicalization scheme

Since:

Entrust 7.0

deregisterCanonicalizer

public static void deregisterCanonicalizer()

Deregisters the SMIME canonicalization scheme for the current thread of execution.

This should be called when the current thread of execution has a registered SMIME canonicalization scheme, but no longer needs to perform any SMIME operations. It simply reclaims the space in the internal registration table; it is good practice to use this API, but not essential.

Parameters:

canonicalizer - the SMIME canonicalization scheme

Since:

Entrust 7.0