Package org.mozilla.jss.pkcs11

Class PK11SymKey

java.lang.Object

org.mozilla.jss.pkcs11.PK11SymKey

All Implemented Interfaces:

Serializable, Key, SecretKey, Destroyable, SymmetricKey

public final class PK11SymKey
extends Object
implements SymmetricKey

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.mozilla.jss.crypto.SymmetricKey

SymmetricKey.NotExtractableException, SymmetricKey.Type, SymmetricKey.Usage

Field Summary

Fields

Modifier and Type	Field	Description
private SymKeyProxy	keyProxy
private String	nickName

Fields inherited from interface javax.crypto.SecretKey

serialVersionUID

Fields inherited from interface org.mozilla.jss.crypto.SymmetricKey

AES, DES, DES3, GENERIC_SECRET, RC2, RC4, SHA1_HMAC, SHA256_HMAC, SHA384_HMAC, SHA512_HMAC

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PK11SymKey(byte[] pointer)
protected	PK11SymKey(byte[] pointer, String nickName)

Method Summary

Modifier and Type	Method	Description
String	getAlgorithm()
byte[]	getEncoded()
String	getFormat()
byte[]	getKeyData()
KeyType	getKeyType()
int	getLength()	Returns the length of the key in bytes, as returned by PK11_GetKeyLength().
String	getNickName()
CryptoToken	getOwningToken()
int	getStrength()	Returns key strength, measured as the number of bits of secret material.
SymmetricKey.Type	getType()
void	setNickName(String nickName)
void	setNickNameNative(String nickName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Field Details

keyProxy

private SymKeyProxy keyProxy

nickName

private String nickName

Constructor Details

PK11SymKey

protected PK11SymKey(byte[] pointer)

PK11SymKey

protected PK11SymKey(byte[] pointer,
 String nickName)

Method Details

getType

public SymmetricKey.Type getType()

Specified by:

getType in interface SymmetricKey

getOwningToken

public CryptoToken getOwningToken()

Specified by:

getOwningToken in interface SymmetricKey

getStrength

public int getStrength()

Returns key strength, measured as the number of bits of secret material. NOTE: Due to a bug in the security library (333440), this may return a wrong answer for PBE keys that have embedded parity (like DES). A DES key is 56 bits of information plus 8 bits of parity, so it takes up 64 bits. For a normal DES key, this method will correctly return 56, but for a PBE-generated DES key, the security library bug causes it to return 64.

Specified by:

getStrength in interface SymmetricKey

getLength

public int getLength()

Returns the length of the key in bytes, as returned by PK11_GetKeyLength().

Specified by:

getLength in interface SymmetricKey

getKeyData

public byte[] getKeyData()
                  throws SymmetricKey.NotExtractableException

Specified by:

getKeyData in interface SymmetricKey

Throws:

SymmetricKey.NotExtractableException

getKeyType

public KeyType getKeyType()

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

Specified by:

getAlgorithm in interface SymmetricKey

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in interface Key

Specified by:

getEncoded in interface SymmetricKey

getFormat

public String getFormat()

Specified by:

getFormat in interface Key

Specified by:

getFormat in interface SymmetricKey

getNickName

public String getNickName()

Specified by:

getNickName in interface SymmetricKey

setNickName

public void setNickName(String nickName)

Specified by:

setNickName in interface SymmetricKey

setNickNameNative

public void setNickNameNative(String nickName)