com.aspose.email

Class SmimeKey

java.lang.Object

com.aspose.email.SmimeKey

public class SmimeKey
extends Object

A wrapper around a PrivateKey and a chain of X509Certificates used to sign or decrypt a MIME message.

Constructor Summary

Constructors

Constructor and Description
SmimeKey(PrivateKey privateKey, X509Certificate... certificateChain) Create a new SmimeKey with the given private key and certificate chain.
SmimeKey(X509Certificate... certificateChain) Create a new SmimeKey with the given private key and certificate chain.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAssociatedAddresses() Compiles and returns the list of email address associated with the certificate of this SmimeKey by inspecting the subjects distinguished name.
X509Certificate	getCertificate() Returns the certificate that holds the public key that corresponds to the private key of this SmimeKey.
X509Certificate[]	getCertificateChain() Returns the chain of certificates of this SmimeKey starting with the certificate that holds the public key that corresponds to the private key of this SmimeKey and ending with the trust anchor.
PrivateKey	getPrivateKey() Returns the private key of this SmimeKey.
static SmimeKey	loadCertificate(InputStream stream) Load a new SmimeKey with the given certificate from string -----CERTIFICATE-----
static SmimeKey	loadCertificate(String crtPath) Load a new SmimeKey with the given private key and certificate from string -----CERTIFICATE-----
static SmimeKey	loadPFX(InputStream stream, char[] password) Load a new SmimeKey with the given private key and certificate from PFX store
static SmimeKey	loadPFX(InputStream stream, String alias, char[] password) Load a new SmimeKey with the given private key and certificate from PFX store
static SmimeKey	loadPFX(String pfxPath, char[] password) Load a new SmimeKey with the given private key and certificate from PFX store
static SmimeKey	loadPFX(String pfxPath, String alias, char[] password) Load a new SmimeKey with the given private key and certificate from PFX store
static SmimeKey	loadPrivateKey(InputStream stream) Load a new SmimeKey with the given private key from string ---RSA PRIVATE KEY---.
static SmimeKey	loadPrivateKey(String keyPath) Load a new SmimeKey with the given private key from string -----RSA PRIVATE KEY-----

Methods inherited from class java.lang.Object

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

Constructor Detail

SmimeKey

public SmimeKey(PrivateKey privateKey,
        X509Certificate... certificateChain)

Create a new SmimeKey with the given private key and certificate chain.

Parameters:

privateKey - The PrivateKey of this SmimeKey

certificateChain - The chain of X509Certificates of this SmimeKey starting with the certificate that holds the public key that corresponds to the given private key and ending with the trust anchor.

SmimeKey

public SmimeKey(X509Certificate... certificateChain)

Create a new SmimeKey with the given private key and certificate chain.

Parameters:

certificateChain - The chain of X509Certificates of this SmimeKey starting with the certificate that holds the public key that corresponds to the given private key and ending with the trust anchor.

Method Detail

loadPrivateKey

public static SmimeKey loadPrivateKey(InputStream stream)

Load a new SmimeKey with the given private key from string ---RSA PRIVATE KEY---.

Parameters:

stream - The InputStream to read the private key from.

loadPrivateKey

public static SmimeKey loadPrivateKey(String keyPath)

Load a new SmimeKey with the given private key from string -----RSA PRIVATE KEY-----

Parameters:

keyPath - The path to the file containing the private key.

loadCertificate

public static SmimeKey loadCertificate(InputStream stream)

Load a new SmimeKey with the given certificate from string -----CERTIFICATE-----

Parameters:

stream - The InputStream to read the certificate from.

loadCertificate

public static SmimeKey loadCertificate(String crtPath)

Load a new SmimeKey with the given private key and certificate from string -----CERTIFICATE-----

Parameters:

crtPath - The path to the file containing certificate.

loadPFX

public static SmimeKey loadPFX(String pfxPath,
               char[] password)

Load a new SmimeKey with the given private key and certificate from PFX store

Parameters:

pfxPath - The path to the PFX file

password - The password to unlock the PFX store with.

loadPFX

public static SmimeKey loadPFX(String pfxPath,
               String alias,
               char[] password)

Load a new SmimeKey with the given private key and certificate from PFX store

Parameters:

pfxPath - The path to the PFX file

alias - The alias of the key entry in the PFX store.

password - The password to unlock the PFX store with.

loadPFX

public static SmimeKey loadPFX(InputStream stream,
               char[] password)

Load a new SmimeKey with the given private key and certificate from PFX store

Parameters:

stream - The InputStream to read the PFX store from.

password - The password to unlock the PFX store with.

loadPFX

public static SmimeKey loadPFX(InputStream stream,
               String alias,
               char[] password)

Load a new SmimeKey with the given private key and certificate from PFX store

Parameters:

stream - The InputStream to read the PFX store from.

alias - The alias of the key entry in the PFX store.

password - The password to unlock the PFX store with.

getPrivateKey

public PrivateKey getPrivateKey()

Returns the private key of this SmimeKey.

Returns:

The PrivateKey.

getCertificate

public X509Certificate getCertificate()

Returns the certificate that holds the public key that corresponds to the private key of this SmimeKey.

Returns:

The X509Certificate.

getCertificateChain

public X509Certificate[] getCertificateChain()

Returns the chain of certificates of this SmimeKey starting with the certificate that holds the public key that corresponds to the private key of this SmimeKey and ending with the trust anchor.

Returns:

The chain of X509Certificates.

getAssociatedAddresses

public List<String> getAssociatedAddresses()

Compiles and returns the list of email address associated with the certificate of this SmimeKey by inspecting the subjects distinguished name.

Returns:

A unmodifiable list of email addresses.