org.mozilla.jss.crypto

Interface CryptoToken

Known Implementing Classes:
PK11Token

public interface CryptoToken

A CryptoToken performs cryptographic operations and stores cryptographic items, such as keys and certs. It corresponds to a Cryptographic Service Provider (CSP) in CDSA, and to a PKCS #11 token.

Instances of CryptoToken are obtained from CryptoManager.

See Also:
CryptoManager

Field Summary

static int
EVERY_TIME
Need to provide a password before each crypto operation.
static int
ONE_TIME
Login once, never need to re-enter the password until you log out.
static int
TIMEOUT
Need to re-login after a period of time.

Method Summary

abstract void
changePassword(PasswordCallback oldpw, PasswordCallback newpw)
Change the password of this token.
SymmetricKey
cloneKey(SymmetricKey key)
Deprecated. Use the JCA interface instead (javax.crypto.SecretKeyFactory)
boolean
doesAlgorithm(Algorithm alg)
Determines whether this token supports the given algorithm.
boolean
equals(Object object)
Deep comparison operation.
abstract String
generateCertRequest(String subject, int keysize, String keyType, byte[] P, byte[] Q, byte[] G)
Generates a b64 encoded PKCS10 blob used for making cert request.
abstract Cipher
getCipherContext(EncryptionAlgorithm algorithm)
Deprecated. Use the JCA interface instead (javax.crypto.Cipher)
abstract CryptoStore
getCryptoStore()
Get the CryptoStore interface to this token's objects.
abstract JSSMessageDigest
getDigestContext(DigestAlgorithm algorithm)
Deprecated. Use the JCA interface instead (java.security.MessageDigest)
abstract KeyGenerator
getKeyGenerator(KeyGenAlgorithm algorithm)
Deprecated. Use the JCA interface instead (javax.crypto.KeyGenerator)
abstract KeyPairGenerator
getKeyPairGenerator(KeyPairAlgorithm algorithm)
Deprecated. Use the JCA interface instead (java.security.KeyPairGenerator)
abstract KeyWrapper
getKeyWrapper(KeyWrapAlgorithm algorithm)
Deprecated. Use the JCA interface instead (javax.crypto.Cipher)
abstract int
getLoginMode()
Returns the login mode of this token: ONE_TIME, TIMEOUT, or EVERY_TIME.
abstract int
getLoginTimeoutMinutes()
Returns the login timeout period.
abstract String
getName()
Obtain the nickname, or label, of this token.
abstract Signature
getSignatureContext(SignatureAlgorithm algorithm)
Deprecated. Use the JCA interface instead (java.security.Signature)
abstract void
initPassword(PasswordCallback securityOfficerPW, PasswordCallback userPW)
Initialize the password of this token.
boolean
isLoggedIn()
Find out if the token is currently logged in.
boolean
isPresent()
Determines whether this token is currently present.
abstract void
login(PasswordCallback pwcb)
Login to the token.
abstract void
logout()
Logout of the token.
boolean
needsLogin()
returns true if this token needs to be logged into before it can be used.
abstract boolean
passwordIsInitialized()
Determine whether the password has been initialized yet.
abstract void
setLoginMode(int mode)
Sets the login mode of this token.
abstract void
setLoginTimeoutMinutes(int timeoutMinutes)
Sets the timeout period for logging in.

Field Details

EVERY_TIME

public static final int EVERY_TIME
Need to provide a password before each crypto operation.
Field Value:
2

ONE_TIME

public static final int ONE_TIME
Login once, never need to re-enter the password until you log out.
Field Value:
0

TIMEOUT

public static final int TIMEOUT
Need to re-login after a period of time.
Field Value:
1

Method Details

changePassword

public abstract void changePassword(PasswordCallback oldpw,
                                    PasswordCallback newpw)
            throws IncorrectPasswordException,
                   TokenException
Change the password of this token.
Parameters:
oldpw - A callback (which could be just a Password) to retrieve the current password.
newpw - A callback (which could be just a Password) to retrieve the new password.
Throws:
IncorrectPasswordException - If the supplied old password is incorrect.

cloneKey

public SymmetricKey cloneKey(SymmetricKey key)
            throws SymmetricKey.NotExtractableException,
                   InvalidKeyException,
                   TokenException

Deprecated. Use the JCA interface instead (javax.crypto.SecretKeyFactory)

Clones a SymmetricKey from a different token onto this token.
Throws:
SymmetricKey.NotExtractableException - If the key material cannot be extracted from the current token.

doesAlgorithm

public boolean doesAlgorithm(Algorithm alg)
Determines whether this token supports the given algorithm.
Parameters:
alg - A JSS algorithm. Note that for Signature, a token may fail to support a specific SignatureAlgorithm (such as RSASignatureWithMD5Digest) even though it does support the generic algorithm (RSASignature). In this case, the signature operation will be performed on that token, but the digest operation will be performed on the internal token.
Returns:
true if the token supports the algorithm.

equals

public boolean equals(Object object)
Deep comparison operation. Use this, rather than ==, to determine whether two CryptoTokens are the same.

generateCertRequest

public abstract String generateCertRequest(String subject,
                                           int keysize,
                                           String keyType,
                                           byte[] P,
                                           byte[] Q,
                                           byte[] G)
            throws TokenException,
                   InvalidParameterException,
                   PQGParamGenException
Generates a b64 encoded PKCS10 blob used for making cert request. Begin/End brackets included.
Parameters:
subject - subject dn of the certificate
keysize - size of the key
keyType - "rsa" or "dsa"
P - The DSA prime parameter
Q - The DSA sub-prime parameter
G - The DSA base parameter
Returns:
base64 encoded pkcs10 certificate request with Begin/end brackets

getCipherContext

public abstract Cipher getCipherContext(EncryptionAlgorithm algorithm)
            throws java.security.NoSuchAlgorithmException,
                   TokenException

Deprecated. Use the JCA interface instead (javax.crypto.Cipher)

Creates a Cipher object, which can be used for encryption and decryption. Cryptographic operations will take place on this token. The keys used in the operations must be located on this token.
Parameters:
algorithm - The algorithm used for encryption/decryption.

getCryptoStore

public abstract CryptoStore getCryptoStore()
Get the CryptoStore interface to this token's objects.

getDigestContext

public abstract JSSMessageDigest getDigestContext(DigestAlgorithm algorithm)
            throws java.security.NoSuchAlgorithmException,
                   DigestException

Deprecated. Use the JCA interface instead (java.security.MessageDigest)

Creates a Digest object. Digesting cryptographic operations will take place on this token.
Parameters:
algorithm - The algorithm used for digesting.

getKeyGenerator

public abstract KeyGenerator getKeyGenerator(KeyGenAlgorithm algorithm)
            throws java.security.NoSuchAlgorithmException,
                   TokenException

Deprecated. Use the JCA interface instead (javax.crypto.KeyGenerator)

Creates a KeyGenerator object, which can be used to generate symmetric encryption keys. Any keys generated with this KeyGenerator will be generated on this token.
Parameters:
algorithm - The algorithm that the keys will be used with.

getKeyPairGenerator

public abstract KeyPairGenerator getKeyPairGenerator(KeyPairAlgorithm algorithm)
            throws java.security.NoSuchAlgorithmException,
                   TokenException

Deprecated. Use the JCA interface instead (java.security.KeyPairGenerator)

Creates a KeyPairGenerator object, which can be used to generate key pairs. Any keypairs generated with this generator will be generated on this token.
Parameters:
algorithm - The algorithm that the keys will be used with (RSA, DSA, EC, etc.)

getKeyWrapper

public abstract KeyWrapper getKeyWrapper(KeyWrapAlgorithm algorithm)
            throws java.security.NoSuchAlgorithmException,
                   TokenException

Deprecated. Use the JCA interface instead (javax.crypto.Cipher)


getLoginMode

public abstract int getLoginMode()
            throws TokenException
Returns the login mode of this token: ONE_TIME, TIMEOUT, or EVERY_TIME. The default is ONE_TIME.
Throws:
TokenException - If an error occurs on the token.

getLoginTimeoutMinutes

public abstract int getLoginTimeoutMinutes()
            throws TokenException
Returns the login timeout period. The timeout is only used if the login mode is TIMEOUT.
Throws:
TokenException - If an error occurs on the token.

getName

public abstract String getName()
            throws TokenException
Obtain the nickname, or label, of this token.
Throws:
TokenException - If an error occurs on the token.

getSignatureContext

public abstract Signature getSignatureContext(SignatureAlgorithm algorithm)
            throws java.security.NoSuchAlgorithmException,
                   TokenException

Deprecated. Use the JCA interface instead (java.security.Signature)

Creates a Signature object, which can perform signing and signature verification. Signing and verification cryptographic operations will take place on this token. The signing key must be located on this token.
Parameters:
algorithm - The algorithm used for the signing/verification.

initPassword

public abstract void initPassword(PasswordCallback securityOfficerPW,
                                  PasswordCallback userPW)
            throws IncorrectPasswordException,
                   AlreadyInitializedException,
                   TokenException
Initialize the password of this token.
Parameters:
securityOfficerPW - A callback to obtain the password of the SecurityOfficer. Pass in a NullPasswordCallback if there is no security officer password. Must not be null.
userPW - A callback to obtain the new password for this token. Must not be null.
Throws:
IncorrectPasswordException - If the supplied security officer password is incorrect.
AlreadyInitializedException - If the token only allows one password initialization, and it has already occurred.
TokenException - If an error occurs on the token.

isLoggedIn

public boolean isLoggedIn()
            throws TokenException
Find out if the token is currently logged in.

isPresent

public boolean isPresent()
Determines whether this token is currently present. This could return false if the token is a smart card that was removed from its slot.

login

public abstract void login(PasswordCallback pwcb)
            throws IncorrectPasswordException,
                   TokenException
Login to the token. If a token is logged in, it will not trigger password callbacks.
Parameters:
Throws:
IncorrectPasswordException - If the supplied password is incorrect.

logout

public abstract void logout()
            throws TokenException
Logout of the token.

needsLogin

public boolean needsLogin()
            throws TokenException
returns true if this token needs to be logged into before it can be used.

passwordIsInitialized

public abstract boolean passwordIsInitialized()
            throws TokenException
Determine whether the password has been initialized yet. Some tokens (such as the Netscape Internal Key Token) don't allow initializing the PIN more than once.
Throws:
TokenException - If an error occurs on the token.

setLoginMode

public abstract void setLoginMode(int mode)
            throws TokenException
Sets the login mode of this token.
Parameters:
mode - ONE_TIME, TIMEOUT, or EVERY_TIME
Throws:
TokenException - If this mode is not supported by this token, or an error occurs on the token.

setLoginTimeoutMinutes

public abstract void setLoginTimeoutMinutes(int timeoutMinutes)
            throws TokenException
Sets the timeout period for logging in. This will only be used if the login mode is TIMEOUT.
Throws:
TokenException - If timeouts are not supported by this token, or an error occurs on the token.