net.markenwerk.utils.mail.smime

Class SmimeKeyStore

java.lang.Object

net.markenwerk.utils.mail.smime.SmimeKeyStore

public class SmimeKeyStore
extends Object

A wrapper around a KeyStore that can be initialized with a PKCS12 keystore and is used to obtain SmimeKeys.

Since:

1.0.0

Author:

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

Constructor Summary

Constructors

Constructor and Description
SmimeKeyStore(InputStream stream, char[] password) Creates a new SmimeKeyStore by loading a PKCS12 keystore from a the given input stream.
SmimeKeyStore(InputStream stream, char[] password, boolean discardPassword) Creates a new SmimeKeyStore by loading a PKCS12 keystore from a the given input stream.

Method Summary

Modifier and Type	Method and Description
boolean	containsPrivateKeyAlias(String alias) Checks if the given alias exists in the PKCS12 keystore.
SmimeKey	getPrivateKey(String alias, char[] password) Returns the S/MIME key associated with the given alias, using the given password to recover it.
SmimeKey	getPrivateKey(String alias, char[] password, boolean discardPassword) Returns the S/MIME key associated with the given alias, using the given password to recover it.
Set<String>	getPrivateKeyAliases() Returns a set containing all aliases listed in the PKCS12 keystore.
int	size() Returns the number of entries in the underlying PKCS12 keystore.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmimeKeyStore

public SmimeKeyStore(InputStream stream,
                     char[] password)

Creates a new SmimeKeyStore by loading a PKCS12 keystore from a the given input stream.

The character array holding the password is overwritten with 0s after it has been used.

Parameters:

stream - The InputStream to read the PKCS12 keystore from.

password - The password to unlock the PKCS12 keystore with.

SmimeKeyStore

public SmimeKeyStore(InputStream stream,
                     char[] password,
                     boolean discardPassword)

Creates a new SmimeKeyStore by loading a PKCS12 keystore from a the given input stream.

If discardPassword is set to true, the character array holding the password is overwritten with 0s after it has been used.

Parameters:

stream - The InputStream to read the PKCS12 keystore from.

password - The password to unlock the PKCS12 keystore with.

discardPassword - Whether to overwrite the char[] holding the password after it has been used.

Method Detail

size

public int size()

Returns the number of entries in the underlying PKCS12 keystore.

Returns:

The number of entries in the underlying KeyStore.

getPrivateKey

public SmimeKey getPrivateKey(String alias,
                              char[] password)

Returns the S/MIME key associated with the given alias, using the given password to recover it.

The character array holding the password is overwritten with 0s after it has been used.

Parameters:

alias - The alias.

password - The password to unlock the PrivateKey keystore with.

Returns:

The requested SmimeKey, or null if the given alias does not exist or does not identify a private key entry.

getPrivateKey

public SmimeKey getPrivateKey(String alias,
                              char[] password,
                              boolean discardPassword)

Returns the S/MIME key associated with the given alias, using the given password to recover it.

If discardPassword is set to true, the character array holding the password is overwritten with 0s after it has been used.

Parameters:

alias - The alias.

password - The password to unlock the PrivateKey keystore with.

discardPassword - Whether to overwrite the char[] holding the password after it has been used.

Returns:

The requested SmimeKey, or null if the given alias does not exist or does not identify a private key entry.

getPrivateKeyAliases

public Set<String> getPrivateKeyAliases()

Returns a set containing all aliases listed in the PKCS12 keystore.

Returns:

A unmodifiable set of aliases.

containsPrivateKeyAlias

public boolean containsPrivateKeyAlias(String alias)

Checks if the given alias exists in the PKCS12 keystore.

Parameters:

alias - The alias to look for.

Returns:

true if the alias exists, false otherwise.