org.simplejavamail.utils.mail.smime

Class SmimeUtil

java.lang.Object

org.simplejavamail.utils.mail.smime.SmimeUtil

public final class SmimeUtil
extends Object

Utilities for handling S/MIME specific operations on MIME messages from JavaMail.

Since:

1.0.0

Author:

Allen Petersen (akp at sourceforge dot net), Torsten Krause (tk at markenwerk dot net)

Field Summary

Fields

Modifier and Type	Field and Description
static org.bouncycastle.asn1.ASN1ObjectIdentifier	DEFAULT_CIPHER
static KeyEncapsulationAlgorithm	DEFAULT_KEY_ENCAPSULATION_ALGORITHM
static String	DEFAULT_SIGNATURE_ALGORITHM_NAME Unfortunately, these constants are not available in the Bouncy Castle, and they have to be passed as strings.

Method Summary

Modifier and Type	Method and Description
static boolean	checkSignature(jakarta.mail.internet.MimeMultipart mimeMultipart) Checks the signature on an S/MIME signed MIME multipart.
static boolean	checkSignature(jakarta.mail.internet.MimePart mimePart) Checks the signature on an S/MIME signed MIME part (i.e.
static jakarta.mail.internet.MimeBodyPart	decrypt(jakarta.mail.internet.MimeBodyPart mimeBodyPart, SmimeKey smimeKey) Decrypts an S/MIME encrypted MIME body part and yields a new MIME body part.
static jakarta.mail.internet.MimeBodyPart	decrypt(jakarta.mail.internet.MimeMultipart mimeMultipart, SmimeKey smimeKey) Decrypts an S/MIME encrypted MIME multipart and yields a new MIME body part.
static jakarta.mail.internet.MimeMessage	decrypt(jakarta.mail.Session session, jakarta.mail.internet.MimeMessage mimeMessage, SmimeKey smimeKey) Decrypts an S/MIME encrypted MIME message and yields a new MIME message.
static jakarta.mail.internet.MimeBodyPart	encrypt(jakarta.mail.internet.MimeBodyPart mimeBodyPart, X509Certificate certificate) Encrypts a MIME body part and yields a new S/MIME encrypted MIME body part.
static jakarta.mail.internet.MimeBodyPart	encrypt(jakarta.mail.internet.MimeBodyPart mimeBodyPart, X509Certificate certificate, KeyEncapsulationAlgorithm keyEncapsulationAlgorithm, org.bouncycastle.asn1.ASN1ObjectIdentifier cmsAlgorithm) Encrypts a MIME body part and yields a new S/MIME encrypted MIME body part.
static jakarta.mail.internet.MimeMessage	encrypt(jakarta.mail.Session session, jakarta.mail.internet.MimeMessage mimeMessage, @Nullable String messageId, X509Certificate certificate, KeyEncapsulationAlgorithm keyEncapsulationAlgorithm, org.bouncycastle.asn1.ASN1ObjectIdentifier cmsAlgorithm) Encrypts a MIME message and yields a new S/MIME encrypted MIME message.
static jakarta.mail.internet.MimeMessage	encrypt(jakarta.mail.Session session, @Nullable String messageId, jakarta.mail.internet.MimeMessage mimeMessage, X509Certificate certificate) Encrypts a MIME message and yields a new S/MIME encrypted MIME message.
static String	getSignedByAddress(jakarta.mail.internet.MimeMultipart mimeMultipart)
static String	getSignedByAddress(jakarta.mail.internet.MimePart mimePart)
static jakarta.mail.internet.MimeBodyPart	getSignedContent(jakarta.mail.internet.MimeMultipart mimeMultipart) Returns the signed MIME body part of an S/MIME signed MIME multipart.
static jakarta.mail.internet.MimeBodyPart	getSignedContent(jakarta.mail.internet.MimePart mimePart) Returns the signed MIME body part of an S/MIME signed MIME part (i.e.
static SmimeState	getStatus(jakarta.mail.internet.MimeMultipart mimeMultipart) Returns the S/MIME state of a MIME multipart.
static SmimeState	getStatus(jakarta.mail.internet.MimePart mimePart) Returns the S/MIME state of a MIME part (i.e.
static jakarta.mail.internet.MimeBodyPart	sign(jakarta.mail.internet.MimeBodyPart mimeBodyPart, SmimeKey smimeKey) Signs a MIME body part and yields a new S/MIME signed MIME body part.
static jakarta.mail.internet.MimeBodyPart	sign(jakarta.mail.internet.MimeBodyPart mimeBodyPart, SmimeKey smimeKey, String algorithmName) Signs a MIME body part and yields a new S/MIME signed MIME body part.
static <T extends jakarta.mail.internet.MimeMessage> T	sign(jakarta.mail.Session session, @Nullable String messageId, T mimeMessage, SmimeKey smimeKey) Signs a MIME message and yields a new S/MIME signed MIME message.
static <T extends jakarta.mail.internet.MimeMessage> T	sign(jakarta.mail.Session session, @Nullable String messageId, T mimeMessage, SmimeKey smimeKey, String algorithmName) Signs a MIME message and yields a new S/MIME signed MIME message.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIGNATURE_ALGORITHM_NAME

public static final String DEFAULT_SIGNATURE_ALGORITHM_NAME

Unfortunately, these constants are not available in the Bouncy Castle, and they have to be passed as strings.

See Also:

for a list of supported algorithms., Constant Field Values

DEFAULT_KEY_ENCAPSULATION_ALGORITHM

public static final KeyEncapsulationAlgorithm DEFAULT_KEY_ENCAPSULATION_ALGORITHM

DEFAULT_CIPHER

public static final org.bouncycastle.asn1.ASN1ObjectIdentifier DEFAULT_CIPHER

Method Detail

encrypt

public static jakarta.mail.internet.MimeMessage encrypt(jakarta.mail.Session session,
                                                        @Nullable
                                                        @Nullable String messageId,
                                                        jakarta.mail.internet.MimeMessage mimeMessage,
                                                        X509Certificate certificate)

Encrypts a MIME message and yields a new S/MIME encrypted MIME message.

Parameters:

session - The Session that is used in conjunction with the original MimeMessage.

messageId - Optional MessageID that should be preserved on the encrypted MimeMessage result.

mimeMessage - The original MimeMessage to be encrypted.

certificate - The X509Certificate used to obtain the PublicKey to encrypt the original message with.

Returns:

The new S/MIME encrypted MimeMessage.

encrypt

public static jakarta.mail.internet.MimeMessage encrypt(jakarta.mail.Session session,
                                                        jakarta.mail.internet.MimeMessage mimeMessage,
                                                        @Nullable
                                                        @Nullable String messageId,
                                                        X509Certificate certificate,
                                                        KeyEncapsulationAlgorithm keyEncapsulationAlgorithm,
                                                        org.bouncycastle.asn1.ASN1ObjectIdentifier cmsAlgorithm)

Encrypts a MIME message and yields a new S/MIME encrypted MIME message.

Parameters:

session - The Session that is used in conjunction with the original MimeMessage.

mimeMessage - The original MimeMessage to be encrypted.

messageId - Optional MessageID that should be preserved on the encrypted MimeMessage result.

certificate - The X509Certificate used to obtain the PublicKey to encrypt the original message with.

keyEncapsulationAlgorithm - Algorithm used to encapsulate the symmetric encryption key. Currently, RSA RSA-OAEP with various SHA digest lengths are supported.

cmsAlgorithm - Encryption algorithm for symmetric content encryption.

Returns:

The new S/MIME encrypted MimeMessage.

encrypt

public static jakarta.mail.internet.MimeBodyPart encrypt(jakarta.mail.internet.MimeBodyPart mimeBodyPart,
                                                         X509Certificate certificate)

Encrypts a MIME body part and yields a new S/MIME encrypted MIME body part.

Parameters:

mimeBodyPart - The original MimeBodyPart to be encrypted.

certificate - The X509Certificate used to obtain the PublicKey to encrypt the original body part with.

Returns:

The new S/MIME encrypted MimeBodyPart.

encrypt

public static jakarta.mail.internet.MimeBodyPart encrypt(jakarta.mail.internet.MimeBodyPart mimeBodyPart,
                                                         X509Certificate certificate,
                                                         KeyEncapsulationAlgorithm keyEncapsulationAlgorithm,
                                                         org.bouncycastle.asn1.ASN1ObjectIdentifier cmsAlgorithm)

Encrypts a MIME body part and yields a new S/MIME encrypted MIME body part.

Parameters:

mimeBodyPart - The original MimeBodyPart to be encrypted.

certificate - The X509Certificate used to obtain the PublicKey to encrypt the original body part with.

keyEncapsulationAlgorithm - Algorithm used to encapsulate the symmetric encryption key. Currently, RSA RSA-OAEP with various SHA digest lengths are supported.

cmsAlgorithm - Encryption algorithm for symmetric content encryption.

Returns:

The new S/MIME encrypted MimeBodyPart.

decrypt

public static jakarta.mail.internet.MimeMessage decrypt(jakarta.mail.Session session,
                                                        jakarta.mail.internet.MimeMessage mimeMessage,
                                                        SmimeKey smimeKey)

Decrypts an S/MIME encrypted MIME message and yields a new MIME message.

Parameters:

session - The Session that is used in conjunction with the encrypted MimeMessage.

mimeMessage - The encrypted MimeMessage to be decrypted.

smimeKey - The SmimeKey used to obtain the PrivateKey to decrypt the encrypted message with.

Returns:

The new S/MIME decrypted MimeMessage.

decrypt

public static jakarta.mail.internet.MimeBodyPart decrypt(jakarta.mail.internet.MimeBodyPart mimeBodyPart,
                                                         SmimeKey smimeKey)

Decrypts an S/MIME encrypted MIME body part and yields a new MIME body part.

Parameters:

mimeBodyPart - The encrypted MimeBodyPart to be decrypted.

smimeKey - The SmimeKey used to obtain the PrivateKey to decrypt the encrypted body part with.

Returns:

The new S/MIME decrypted MimeBodyPart.

decrypt

public static jakarta.mail.internet.MimeBodyPart decrypt(jakarta.mail.internet.MimeMultipart mimeMultipart,
                                                         SmimeKey smimeKey)

Decrypts an S/MIME encrypted MIME multipart and yields a new MIME body part.

Parameters:

mimeMultipart - The encrypted MimeMultipart to be decrypted.

smimeKey - The SmimeKey used to obtain the PrivateKey to decrypt the encrypted multipart with.

Returns:

The new S/MIME decrypted MimeBodyPart.

sign

public static jakarta.mail.internet.MimeBodyPart sign(jakarta.mail.internet.MimeBodyPart mimeBodyPart,
                                                      SmimeKey smimeKey)

Signs a MIME body part and yields a new S/MIME signed MIME body part.

Parameters:

mimeBodyPart - The original MimeBodyPart to be signed.

smimeKey - The SmimeKey used to obtain the PrivateKey to sign the original body part with.

Returns:

The new S/MIME signed MimeBodyPart.

sign

public static jakarta.mail.internet.MimeBodyPart sign(jakarta.mail.internet.MimeBodyPart mimeBodyPart,
                                                      SmimeKey smimeKey,
                                                      String algorithmName)

Signs a MIME body part and yields a new S/MIME signed MIME body part.

Parameters:

mimeBodyPart - The original MimeBodyPart to be signed.

smimeKey - The SmimeKey used to obtain the PrivateKey to sign the original body part with.

algorithmName - The name of the signature algorithm to use. Must be an algorithm supported by the Bouncy Castle security provider.

Returns:

The new S/MIME signed MimeBodyPart.

sign

public static <T extends jakarta.mail.internet.MimeMessage> T sign(jakarta.mail.Session session,
                                                                   @Nullable
                                                                   @Nullable String messageId,
                                                                   T mimeMessage,
                                                                   SmimeKey smimeKey)

Signs a MIME message and yields a new S/MIME signed MIME message.

Parameters:

session - The Session that is used in conjunction with the original MimeMessage.

messageId - Optional MessageID that should be preserved on the signed MimeMessage.

mimeMessage - The original MimeMessage or SMTPMessage to be signed.

smimeKey - The SmimeKey used to obtain the PrivateKey to sign the original message with.

Returns:

The new S/MIME signed MimeMessage or SMTPMessage.

sign

public static <T extends jakarta.mail.internet.MimeMessage> T sign(jakarta.mail.Session session,
                                                                   @Nullable
                                                                   @Nullable String messageId,
                                                                   T mimeMessage,
                                                                   SmimeKey smimeKey,
                                                                   String algorithmName)

Signs a MIME message and yields a new S/MIME signed MIME message.

Parameters:

session - The Session that is used in conjunction with the original MimeMessage.

messageId - Optional MessageID that should be preserved on the signed MimeMessage.

mimeMessage - The original MimeMessage or SMTPMessage to be signed.

smimeKey - The SmimeKey used to obtain the PrivateKey to sign the original message with.

algorithmName - The name of the signature algorithm to use. Must be an algorithm supported by the Bouncy Castle security provider.

Returns:

The new S/MIME signed MimeMessage or SMTPMessage.

checkSignature

public static boolean checkSignature(jakarta.mail.internet.MimeMultipart mimeMultipart)

Checks the signature on an S/MIME signed MIME multipart.

Parameters:

mimeMultipart - The MimeMultipart to be checked.

Returns:

true if the multipart is correctly signed, false otherwise.

checkSignature

public static boolean checkSignature(jakarta.mail.internet.MimePart mimePart)

Checks the signature on an S/MIME signed MIME part (i.e. MIME message).

Parameters:

mimePart - The MimePart to be checked.

Returns:

true if the part is correctly signed, false otherwise.

getSignedByAddress

public static String getSignedByAddress(jakarta.mail.internet.MimeMultipart mimeMultipart)

Parameters:

mimeMultipart - The MimeMultipart to be checked.

Returns:

The subject / address to which the certificate was issued to. Email clients may use this to show "Signed by: <subject / address>"

getSignedByAddress

public static String getSignedByAddress(jakarta.mail.internet.MimePart mimePart)

Parameters:

mimePart - The MimePart to be checked.

Returns:

The subject / address to which the certificate was issued to. Email clients may use this to show "Signed by: <subject / address>"

getSignedContent

public static jakarta.mail.internet.MimeBodyPart getSignedContent(jakarta.mail.internet.MimeMultipart mimeMultipart)

Returns the signed MIME body part of an S/MIME signed MIME multipart.

Parameters:

mimeMultipart - The MimeMultipart to be stripped off.

Returns:

The signed MimeBodyPart contained in the MimeMultipart.

getSignedContent

public static jakarta.mail.internet.MimeBodyPart getSignedContent(jakarta.mail.internet.MimePart mimePart)

Returns the signed MIME body part of an S/MIME signed MIME part (i.e. MIME message).

Parameters:

mimePart - The MimePart to be stripped off.

Returns:

The signed MimeBodyPart contained in the MimePart .

getStatus

public static SmimeState getStatus(jakarta.mail.internet.MimeMultipart mimeMultipart)

Returns the S/MIME state of a MIME multipart.

Parameters:

mimeMultipart - The MimeMultipart to be checked.

Returns:

the SmimeState of the MimeMultipart.

getStatus

public static SmimeState getStatus(jakarta.mail.internet.MimePart mimePart)

Returns the S/MIME state of a MIME part (i.e. MIME message).

Parameters:

mimePart - The MimePart to be checked.

Returns:

the SmimeState of the MimePart.