net.rim.device.api.crypto.RC2Key
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public final class RC2Key
Creates an RC2 key.
For information on cryptographic algorithms, see Crypto Algorithms.
| Constructor Summary | ||
|---|---|---|
|
RC2Key()
Create a new random 128 (actual/effective) bit key. |
|
|
RC2Key(byte[] data)
Creates an RC2Key object using existing data. |
|
|
RC2Key(byte[] data,
int effectiveBitLength)
Creates a key using existing data and the specified effective bit length. |
|
|
RC2Key(byte[] data,
int offset,
int bitLength)
Creates an RC2Key object using existing data. |
|
|
RC2Key(byte[] data,
int offset,
int bitLength,
int effectiveBitLength)
Creates an RC2Key object using existing data and the specified effective bit length. |
|
|
RC2Key(int bitLength)
Creates a new random RC2Key object of the specified actual/effective bit length. |
|
|
RC2Key(int bitLength,
int effectiveBitLength)
Creates a new random RC2Key object based on the specified actual and effective bit lengths. |
|
|
RC2Key(RC2CryptoToken cryptoToken,
byte[] data,
int offset,
int bitLength,
int effectiveBitLength)
Creates an RC2Key object using existing data and the specified effective bit length. |
|
|
RC2Key(RC2CryptoToken cryptoToken,
int bitLength,
int effectiveBitLength)
Creates a new random RC2Key object based on the specified actual and effective bit lengths. |
|
|
RC2Key(RC2CryptoToken cryptoToken,
CryptoTokenSymmetricKeyData cryptoTokenData)
Creates an RC2Key object. |
|
| Method Summary | ||
|---|---|---|
|
static int |
decodeEffectiveBitLength(int encodedEffectiveBitLength)
Decodes an encoded effective bit length as specified in RFC 2268. |
|
static int |
encodeEffectiveBitLength(int effectiveBitLength)
Encodes an effective bit length as specified in RFC 2268. |
|
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
|
String |
getAlgorithm()
Returns a string containing the name of the algorithm associated with this key ("RC2"). |
|
int |
getBitLength()
Returns the number of bits that make up the actual keying material ( for example parity bits are not counted ). |
|
CryptoTokenSymmetricKeyData |
getCryptoTokenData()
Returns the data associated with the crypto token. |
|
byte[] |
getData()
Returns a copy of the byte array representing the key. |
|
int |
getEffectiveBitLength()
Returns the effective bit length. |
|
int |
getLength()
Returns the length of the key in bytes. |
|
RC2CryptoToken |
getRC2CryptoToken()
Returns the crypto token used to create the key. |
|
SymmetricCryptoToken |
getSymmetricCryptoToken()
Returns the crypto token associated with this key. |
|
int |
hashCode()
Returns a hash code value for the object. |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public RC2Key()
public RC2Key(int bitLength)
RC2Key object of the specified actual/effective bit length.
bitLength - The length of the key in bits (must be between 8 and 1024, and a multiple of 8).
public RC2Key(int bitLength,
int effectiveBitLength)
RC2Key object based on the specified actual and effective bit lengths.
bitLength - The length of the key in bits (must be between 8 and 1024, and a multiple of 8).effectiveBitLength - The effective length of the key in bits (must be between 1 and 1024).
public RC2Key(RC2CryptoToken cryptoToken,
int bitLength,
int effectiveBitLength)
throws CryptoTokenException,
CryptoUnsupportedOperationException
RC2Key object based on the specified actual and effective bit lengths.
cryptoToken - The token that protects the key.bitLength - The length of the key in bits (must be between 8 and 1024, and a multiple of 8).effectiveBitLength - The effective length of the key in bits (must
be between 1 and 1024).
CryptoTokenException - Thrown when an error occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to
an unsupported operation.public RC2Key(byte[] data)
RC2Key object using existing data. The effective bit length will match the actual bit length.
data - A byte array containing the bytes to use as the key (data.length must be between 1 and 128).
public RC2Key(byte[] data,
int effectiveBitLength)
data - A byte array containing the bytes to use as the key (data.length must be between 1 and 128).effectiveBitLength - The effective length of the key in bits (must be between 1 and 1024).
public RC2Key(byte[] data,
int offset,
int bitLength)
RC2Key object using existing data. The effective bit length will match the actual bit length.
data - A byte array containing the bytes to use as the key.offset - The starting offset, or initial position, of the key data
within the array.bitLength - The length of the key in bits (must be between 8 and 1024, and a multiple of 8).
public RC2Key(byte[] data,
int offset,
int bitLength,
int effectiveBitLength)
RC2Key object using existing data and the specified effective bit length.
data - A byte array containing the bytes to use as the key.offset - The starting offset, or initial position, of the key data
within the array.bitLength - The length of the key in bits (must be between 8 and 1024, and a multiple of 8).effectiveBitLength - The effective length of the key in bits (must be between 1 and 1024).
public RC2Key(RC2CryptoToken cryptoToken,
byte[] data,
int offset,
int bitLength,
int effectiveBitLength)
throws CryptoTokenException,
CryptoUnsupportedOperationException
RC2Key object using existing data and the specified effective bit length.
cryptoToken - The token that protects the key.data - A byte array containing the bytes to use as the key.offset - The starting offset, or initial position, of the key data
within the array.bitLength - The length of the key in bits (must be between 8 and 1024, and a multiple of 8).effectiveBitLength - The effective length of the key in bits (must
be between 1 and 1024).
CryptoTokenException - Thrown when an error occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to
an unsupported operation.
public RC2Key(RC2CryptoToken cryptoToken,
CryptoTokenSymmetricKeyData cryptoTokenData)
RC2Key object.
cryptoToken - The crypto token that protects the key.cryptoTokenData - The data associated with the crypto token.| Method Detail |
|---|
public SymmetricCryptoToken getSymmetricCryptoToken()
getSymmetricCryptoToken in interface SymmetricKeypublic RC2CryptoToken getRC2CryptoToken()
public CryptoTokenSymmetricKeyData getCryptoTokenData()
public String getAlgorithm()
This method will always return the String "RC2".
getAlgorithm in interface Key
public int getLength()
throws CryptoTokenException,
CryptoUnsupportedOperationException
SymmetricKey
getLength in interface SymmetricKeyCryptoTokenException - Thrown when a problem occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to an
unsupported operation.
public int getBitLength()
throws CryptoTokenException,
CryptoUnsupportedOperationException
SymmetricKey
getBitLength in interface SymmetricKeyCryptoTokenException - Thrown when a problem occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to an
unsupported operation.
public byte[] getData()
throws CryptoTokenException,
CryptoUnsupportedOperationException
SymmetricKey
getData in interface SymmetricKeyCryptoTokenException - Thrown when a problem occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to
an unsupported operation.
public int getEffectiveBitLength()
throws CryptoTokenException,
CryptoUnsupportedOperationException
CryptoTokenException - Thrown when an error occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to
an unsupported operation.public int hashCode()
Objectjava.util.Hashtable.
The general contract of hashCode is:
hashCode method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hashtables.
As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)
hashCode in class ObjectObject.equals(java.lang.Object),
Hashtablepublic boolean equals(Object obj)
Object
The equals method implements an equivalence relation:
x,
x.equals(x) should return true.
x and
y, x.equals(y) should return
true if and only if y.equals(x) returns
true.
x,
y, and z, if x.equals(y)
returns true and y.equals(z) returns
true, then x.equals(z) should return
true.
x
and y, multiple invocations of x.equals(y)
consistently return true or consistently return
false, provided no information used in
equals comparisons on the object is modified.
x,
x.equals(null) should return false.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any reference values x and y,
this method returns true if and only if x and
y refer to the same object (x==y has the
value true).
equals in class Objectobj - the reference object with which to compare.
true if this object is the same as the obj
argument; false otherwise.Boolean.hashCode(),
Hashtablepublic static int decodeEffectiveBitLength(int encodedEffectiveBitLength)
encodedEffectiveBitLength - The encoded effective bit length to be decoded.
public static int encodeEffectiveBitLength(int effectiveBitLength)
effectiveBitLength - The effective bit length to be encoded.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal