Package org.mozilla.jss.pkcs11

Class PK11Store

java.lang.Object

org.mozilla.jss.pkcs11.PK11Store

All Implemented Interfaces:

CryptoStore

public final class PK11Store
extends Object
implements CryptoStore

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	logger
protected TokenProxy	storeProxy
protected boolean	updated

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PK11Store()
	PK11Store(TokenProxy proxy)

Method Summary

Modifier and Type	Method	Description
void	deleteCert(X509Certificate cert)	Deletes the specified certificate and its associated private key from the store.
void	deleteCertOnly(X509Certificate cert)	Deletes the specified certificate from the store.
void	deletePrivateKey(PrivateKey privateKey)	Permanently deletes a private key from the token.
void	deletePublicKey(PublicKey publicKey)	Permanently deletes a public key from the token.
X509Certificate	findCert(byte[] certBytes)	Find a certificate in this token from its binary data.
X509Certificate	findCertFromDERCertItem(byte[] certBytes)
PublicKey	findPublicKey(PrivateKey privateKey)	Returns the public key corresponding to the private key.
X509Certificate[]	getCertificates()	Returns all user certificates stored on this token.
byte[]	getEncryptedPrivateKeyInfo(KeyGenerator.CharToByteConverter conv, Password pw, Algorithm alg, int n, PrivateKey k)	Get an encrypted private key, with optional password conversion.
byte[]	getEncryptedPrivateKeyInfo(X509Certificate cert, PBEAlgorithm pbeAlg, Password pw, int iteration)	Get an encrypted private key for the given cert.
PrivateKey[]	getPrivateKeys()	Returns all private keys stored on this token.
PublicKey[]	getPublicKeys()	Returns all public keys stored on this token.
SymmetricKey[]	getSymmetricKeys()	Returns all symmetric keys stored on this token.
X509Certificate	importCert(byte[] certBytes, String nickname)	Imports a certificate into this token.
void	importEncryptedPrivateKeyInfo(KeyGenerator.CharToByteConverter conv, Password pw, String nickname, PublicKey pubKey, byte[] epkiBytes)
PrivateKey	importPrivateKey(byte[] key, PrivateKey.Type type)	Imports a raw private key into this token.
PrivateKey	importPrivateKey(byte[] key, PrivateKey.Type type, boolean temporary)	Imports a raw private key into this token.
protected void	loadPrivateKeys(Collection<PrivateKey> privateKeys)
protected void	loadPublicKeys(Collection<PublicKey> privateKeys)
protected void	putCertsInVector(Vector<X509Certificate> certs)
protected void	putSymKeysInVector(Vector<SymmetricKey> symKeys)

Methods inherited from class java.lang.Object

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

Field Details

logger

public static org.slf4j.Logger logger

updated

protected boolean updated

storeProxy

protected TokenProxy storeProxy

Constructor Details

PK11Store

public PK11Store(TokenProxy proxy)

PK11Store

protected PK11Store()

Method Details

importPrivateKey

public PrivateKey importPrivateKey(byte[] key,
 PrivateKey.Type type)
                            throws TokenException,
KeyAlreadyImportedException

Imports a raw private key into this token.

Specified by:

importPrivateKey in interface CryptoStore

Parameters:

key - The private key.

Throws:

TokenException - If the key cannot be imported to this token.

KeyAlreadyImportedException - If the key already on this token.

importPrivateKey

public PrivateKey importPrivateKey(byte[] key,
 PrivateKey.Type type,
 boolean temporary)
                            throws TokenException,
KeyAlreadyImportedException

Description copied from interface: CryptoStore

Imports a raw private key into this token.

Specified by:

importPrivateKey in interface CryptoStore

Parameters:

key - The private key.

temporary - Whether the key should be temporary.

Throws:

TokenException - If the key cannot be imported to this token.

KeyAlreadyImportedException - If the key already exists on this token.

getPrivateKeys

public PrivateKey[] getPrivateKeys()
                            throws TokenException

Description copied from interface: CryptoStore

Returns all private keys stored on this token.

Specified by:

getPrivateKeys in interface CryptoStore

Returns:

An array of all private keys stored on this token.

Throws:

TokenException - If an error occurs on the token while gathering the keys.

loadPrivateKeys

protected void loadPrivateKeys(Collection<PrivateKey> privateKeys)
                        throws TokenException

Throws:

TokenException

getPublicKeys

public PublicKey[] getPublicKeys()
                          throws TokenException

Description copied from interface: CryptoStore

Returns all public keys stored on this token.

Specified by:

getPublicKeys in interface CryptoStore

Returns:

An array of all public keys stored on this token.

Throws:

TokenException - If an error occurs on the token while gathering the keys.

loadPublicKeys

protected void loadPublicKeys(Collection<PublicKey> privateKeys)
                       throws TokenException

Throws:

TokenException

findPublicKey

public PublicKey findPublicKey(PrivateKey privateKey)
                        throws TokenException,
ObjectNotFoundException

Description copied from interface: CryptoStore

Returns the public key corresponding to the private key.

Specified by:

findPublicKey in interface CryptoStore

Returns:

The corresponding public key.

Throws:

TokenException - If an error occurs on the token.

ObjectNotFoundException - If the corresponding public key is not found.

getSymmetricKeys

public SymmetricKey[] getSymmetricKeys()
                                throws TokenException

Description copied from interface: CryptoStore

Returns all symmetric keys stored on this token.

Specified by:

getSymmetricKeys in interface CryptoStore

Returns:

An array of all symmetric keys stored on this token.

Throws:

TokenException - If an error occurs on the token while gathering the keys.

putSymKeysInVector

protected void putSymKeysInVector(Vector<SymmetricKey> symKeys)
                           throws TokenException

Throws:

TokenException

deletePrivateKey

public void deletePrivateKey(PrivateKey privateKey)
                      throws NoSuchItemOnTokenException,
TokenException

Description copied from interface: CryptoStore

Permanently deletes a private key from the token.

Specified by:

deletePrivateKey in interface CryptoStore

Parameters:

privateKey - A private key to be permanently deleted.

Throws:

NoSuchItemOnTokenException - If the given private key does not reside on this token.

TokenException - If an error occurs on the token while deleting the key.

deletePublicKey

public void deletePublicKey(PublicKey publicKey)
                     throws NoSuchItemOnTokenException,
TokenException

Description copied from interface: CryptoStore

Permanently deletes a public key from the token.

Specified by:

deletePublicKey in interface CryptoStore

Parameters:

publicKey - A public key to be permanently deleted.

Throws:

NoSuchItemOnTokenException - If the given public key does not reside on this token.

TokenException - If an error occurs on the token while deleting the key.

getEncryptedPrivateKeyInfo

public byte[] getEncryptedPrivateKeyInfo(X509Certificate cert,
 PBEAlgorithm pbeAlg,
 Password pw,
 int iteration)
                                  throws NotInitializedException,
ObjectNotFoundException,
TokenException

Description copied from interface: CryptoStore

Get an encrypted private key for the given cert.

Specified by:

getEncryptedPrivateKeyInfo in interface CryptoStore

Parameters:

cert - Certificate of key to be exported

pbeAlg - The PBEAlgorithm to use

pw - The password to encrypt with

iteration - Iteration count; default of 2000 if le 0

Throws:

NotInitializedException

ObjectNotFoundException

TokenException

getEncryptedPrivateKeyInfo

public byte[] getEncryptedPrivateKeyInfo(KeyGenerator.CharToByteConverter conv,
 Password pw,
 Algorithm alg,
 int n,
 PrivateKey k)

Description copied from interface: CryptoStore

Get an encrypted private key, with optional password conversion.

Specified by:

getEncryptedPrivateKeyInfo in interface CryptoStore

Parameters:

conv - Password converter. If null, pw.getByteCopy() will be used to get password bytes.

pw - The password

alg - The encryption algorithm

n - Iteration count; default of 2000 if le 0

k - The private key

importEncryptedPrivateKeyInfo

public void importEncryptedPrivateKeyInfo(KeyGenerator.CharToByteConverter conv,
 Password pw,
 String nickname,
 PublicKey pubKey,
 byte[] epkiBytes)

Specified by:

importEncryptedPrivateKeyInfo in interface CryptoStore

Parameters:

conv - Password converter. If null, pw.getByteCopy() will be used to get password bytes.

pw - The password

nickname - Nickname to use for private key

pubKey - Public key corresponding to private key

getCertificates

public X509Certificate[] getCertificates()
                                  throws TokenException

Description copied from interface: CryptoStore

Returns all user certificates stored on this token. A user certificate is one that has a matching private key.

Specified by:

getCertificates in interface CryptoStore

Returns:

An array of all user certificates present on this token.

Throws:

TokenException - If an error occurs on the token while gathering the certificates.

putCertsInVector

protected void putCertsInVector(Vector<X509Certificate> certs)
                         throws TokenException

Throws:

TokenException

findCert

public X509Certificate findCert(byte[] certBytes)
                         throws TokenException

Description copied from interface: CryptoStore

Find a certificate in this token from its binary data.

Specified by:

findCert in interface CryptoStore

Parameters:

certBytes - Certificate binaries

Returns:

X509Certificate object

Throws:

TokenException

findCertFromDERCertItem

public X509Certificate findCertFromDERCertItem(byte[] certBytes)
                                        throws TokenException

Throws:

TokenException

importCert

public X509Certificate importCert(byte[] certBytes,
 String nickname)
                           throws TokenException

Description copied from interface: CryptoStore

Imports a certificate into this token.

Specified by:

importCert in interface CryptoStore

Parameters:

certBytes - Certificate binaries

nickname - Certificate nickname

Returns:

X509Certificate object of the imported certificate

Throws:

TokenException

deleteCert

public void deleteCert(X509Certificate cert)
                throws NoSuchItemOnTokenException,
TokenException

Deletes the specified certificate and its associated private key from the store.

Specified by:

deleteCert in interface CryptoStore

Parameters:

cert - certificate to be deleted

Throws:

NoSuchItemOnTokenException - If the certificate not found

TokenException - General token error

deleteCertOnly

public void deleteCertOnly(X509Certificate cert)
                    throws NoSuchItemOnTokenException,
TokenException

Deletes the specified certificate from the store.

Specified by:

deleteCertOnly in interface CryptoStore

Parameters:

cert - certificate to be deleted

Throws:

NoSuchItemOnTokenException - If the certificate not found

TokenException - General token error