net.markenwerk.utils.mail.smime

Class SmimeUtil

java.lang.Object

net.markenwerk.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)

Method Summary

Modifier and Type	Method and Description
static boolean	checkSignature(MimeMultipart mimeMultipart) Checks the signature on a S/MIME signed MIME multipart.
static boolean	checkSignature(MimePart mimePart) Checks the signature on a S/MIME signed MIME part (i.e.
static MimeBodyPart	decrypt(MimeBodyPart mimeBodyPart, SmimeKey smimeKey) Decrypts a S/MIME encrypted MIME body part and yields a new MIME body part.
static MimeBodyPart	decrypt(MimeMultipart mimeMultipart, SmimeKey smimeKey) Decrypts a S/MIME encrypted MIME multipart and yields a new MIME body part.
static MimeMessage	decrypt(Session session, MimeMessage mimeMessage, SmimeKey smimeKey) Decrypts a S/MIME encrypted MIME message and yields a new MIME message.
static MimeBodyPart	encrypt(MimeBodyPart mimeBodyPart, X509Certificate certificate) Encrypts a MIME body part and yields a new S/MIME encrypted MIME body part.
static MimeMessage	encrypt(Session session, MimeMessage mimeMessage, X509Certificate certificate) Encrypts a MIME message and yields a new S/MIME encrypted MIME message.
static MimeBodyPart	getSignedContent(MimeMultipart mimeMultipart) Returns the signed MIME body part of a S/MIME signed MIME multipart.
static MimeBodyPart	getSignedContent(MimePart mimePart) Returns the signed MIME body part of a S/MIME signed MIME part (i.e.
static SmimeState	getStatus(MimeMultipart mimeMultipart) Returns the S/MIME state of a MIME multipart.
static SmimeState	getStatus(MimePart mimePart) Returns the S/MIME state of a MIME part (i.e.
static MimeBodyPart	sign(MimeBodyPart mimeBodyPart, SmimeKey smimeKey) Signs a MIME body part and yields a new S/MIME signed MIME body part.
static MimeMessage	sign(Session session, MimeMessage mimeMessage, SmimeKey smimeKey) Signs a MIME message and yields a new S/MIME signed MIME message.

Methods inherited from class java.lang.Object

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

Method Detail

encrypt

public static MimeMessage encrypt(Session session,
                                  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.

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 MimeBodyPart encrypt(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.

decrypt

public static MimeMessage decrypt(Session session,
                                  MimeMessage mimeMessage,
                                  SmimeKey smimeKey)

Decrypts a 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 MimeBodyPart decrypt(MimeBodyPart mimeBodyPart,
                                   SmimeKey smimeKey)

Decrypts a 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 MimeBodyPart decrypt(MimeMultipart mimeMultipart,
                                   SmimeKey smimeKey)

Decrypts a 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 MimeBodyPart sign(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 MimeMessage sign(Session session,
                               MimeMessage 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.

mimeMessage - The original MimeMessage to be signed.

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

Returns:

The new S/MIME signed MimeMessage.

checkSignature

public static boolean checkSignature(MimeMultipart mimeMultipart)

Checks the signature on a 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(MimePart mimePart)

Checks the signature on a 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.

getSignedContent

public static MimeBodyPart getSignedContent(MimeMultipart mimeMultipart)

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

Parameters:

mimeMultipart - The MimeMultipart to be stripped off.

Returns:

The signed MimeBodyPart contained in the MimeMultipart.

getSignedContent

public static MimeBodyPart getSignedContent(MimePart mimePart)

Returns the signed MIME body part of a 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(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(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.