Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface CryptoToken
CryptoManager
Field Summary | |
static int |
|
static int |
|
static int |
|
Method Summary | |
abstract void |
|
SymmetricKey |
|
boolean |
|
boolean |
|
abstract String |
|
abstract Cipher |
|
abstract CryptoStore |
|
abstract JSSMessageDigest |
|
abstract KeyGenerator |
|
abstract KeyPairGenerator |
|
abstract KeyWrapper |
|
abstract int |
|
abstract int |
|
abstract String |
|
abstract Signature |
|
abstract void |
|
boolean |
|
boolean |
|
abstract void |
|
abstract void |
|
boolean |
|
abstract boolean |
|
abstract void |
|
abstract void |
|
public static final int EVERY_TIME
Need to provide a password before each crypto operation.
- Field Value:
- 2
public static final int ONE_TIME
Login once, never need to re-enter the password until you log out.
- Field Value:
- 0
public static final int TIMEOUT
Need to re-login after a period of time.
- Field Value:
- 1
- See Also:
setLoginTimeoutMinutes(int)
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.
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.
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.
public boolean equals(Object object)
Deep comparison operation. Use this, rather than ==, to determine whether two CryptoTokens are the same.
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 certificatekeysize
- size of the keykeyType
- "rsa" or "dsa"P
- The DSA prime parameterQ
- The DSA sub-prime parameterG
- The DSA base parameter
- Returns:
- base64 encoded pkcs10 certificate request with Begin/end brackets
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.
public abstract CryptoStore getCryptoStore()
Get the CryptoStore interface to this token's objects.
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.
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.
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.)
public abstract KeyWrapper getKeyWrapper(KeyWrapAlgorithm algorithm) throws java.security.NoSuchAlgorithmException, TokenException
Deprecated. Use the JCA interface instead (
javax.crypto.Cipher
)
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.
- See Also:
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.
- See Also:
getLoginMode()
public abstract String getName() throws TokenException
Obtain the nickname, or label, of this token.
- Throws:
TokenException
- If an error occurs on the token.
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.
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.
public boolean isLoggedIn() throws TokenException
Find out if the token is currently logged in.
- See Also:
login(PasswordCallback)
,logout()
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.
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.
public boolean needsLogin() throws TokenException
returns true if this token needs to be logged into before it can be used.
- See Also:
login(PasswordCallback)
,logout()
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.
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.
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.
- See Also:
setLoginMode(int)