|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.device.api.crypto.encoder.PublicKeyDecoder
public abstract class PublicKeyDecoder
Allows the developer to decode public keys using a variety of supported encoding algorithms.
The details of creating and using the appropriate algorithm are managed by PublicKeyDecoder
and are completely transparent to the developer.
Encoding a Public Key
Encoding a public key simply involves calling the public static encode()
method
with the desired public key. As the following code illustrates, encoding an RSA public key using the
X509 algorithm is straightforward:
RSAPublicKey key = new RSAPublicKey( ... ); EncodedKey encodedKey = PublicKeyEncoder.encode( key, "X509" );Of course, the RSA public key must be properly created and initialized.
Decoding a Public Key
Decoding a public key is similar to encoding one. Simply call the public static decode()
method with the encoded key data:
byte[] encodedKeyData = ...; PublicKey decodedKey = PublicKeyDecoder.decode( encodedKeyData, "X509" );This code assumes that
encodedKey
contains a properly encoded public key.
Currently, RIM provides the following public key encoding algorithms, which can be accessed with the specifed string :
Microsoft Crypto API Use the encoding string "MSCAPI". X509 encoding Use the encoding string "X509". WTLS encoding Use the encoding string "WTLS".
Supported Encoding Algorithms
The MSCAPI encoding can be found in MSDN. The X509 encoding is defined in RFC 2459. Finally, the WTLS encoding is found in WAP-199-WTLS from Feb 2000.
A complete list of the key encoding algorithms supported by the RIM crypto API can be found here.
If a developer wishes to implement a key encoding algorithm not found in this list, the PublicKeyEncoder class can be extended.
This information can be found here.
Constructor Summary | ||
---|---|---|
|
protected |
PublicKeyDecoder()
Creates a new PublicKeyDecoder object. |
Method Summary | ||
---|---|---|
|
static PublicKey |
decode(byte[] encodedKey,
String encodingAlgorithm)
Takes in the given encoded key and returns the decoded public key. |
|
static PublicKey |
decode(byte[] encodedKey,
String encodingAlgorithm,
CryptoSystem cryptoSystem,
String keyAlgorithm)
Decodes an encoded public key. |
|
static PublicKey |
decode(InputStream encodedKey,
String encodingAlgorithm)
Takes in the given encoded key and returns the decoded public key. |
|
static PublicKey |
decode(InputStream encodedKey,
String encodingAlgorithm,
CryptoSystem cryptoSystem,
String keyAlgorithm)
Decodes an encoded public key. |
|
protected abstract PublicKey |
decodeKey(InputStream encodedKey,
CryptoSystem cryptoSystem,
String keyAlgorithm)
Decodes the passed in key. |
|
protected static PublicKeyDecoder |
getDecoder(String encodingAlgorithm,
String keyAlgorithm)
Returns the class associated with the encoding algorithm and the key algorithm. |
|
protected abstract String |
getEncodingAlgorithm()
Returns the name of this encoding algorithm, such as "X509". |
|
protected abstract String[] |
getKeyAlgorithms()
Returns the name of the key algorithm that was encoded. |
|
static boolean |
register(PublicKeyDecoder decoder,
PublicKeyDecoder baseDecoder)
Registers a new PublicKeyDecoder with the framework. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected PublicKeyDecoder()
PublicKeyDecoder
object.
This is the default constructor.
Method Detail |
---|
public static PublicKey decode(InputStream encodedKey, String encodingAlgorithm, CryptoSystem cryptoSystem, String keyAlgorithm) throws NoSuchAlgorithmException, InvalidKeyEncodingException, InvalidKeyException, InvalidCryptoSystemException, UnsupportedCryptoSystemException, CryptoTokenException, CryptoUnsupportedOperationException
encodedKey
- An InputStream containing the key encoding.encodingAlgorithm
- The encoding algorithm to use to decode, such as "X509".cryptoSystem
- The crypto system to retrieve parameter information from, if necessary.keyAlgorithm
- The type of key.
NoSuchAlgorithmException
- Thrown if the specified algorithm is
invalid.
InvalidKeyEncodingException
- Thrown if the key is improperly
formatted.
InvalidKeyException
- Thrown if the specified key is invalid.
InvalidCryptoSystemException
- Thrown if the specified crypto
system is invalid.
UnsupportedCryptoSystemException
- Thrown if the specified crypto
system is unsupported.
CryptoTokenException
- Thrown if an error occurs with the crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException
- Thrown if a call is made to
an unsupported operation.public static PublicKey decode(byte[] encodedKey, String encodingAlgorithm, CryptoSystem cryptoSystem, String keyAlgorithm) throws NoSuchAlgorithmException, InvalidKeyEncodingException, InvalidKeyException, InvalidCryptoSystemException, UnsupportedCryptoSystemException, CryptoTokenException, CryptoUnsupportedOperationException
encodedKey
- A byte array containing the key encoding.encodingAlgorithm
- The encoding algorithm to use to decode, such as "X509".cryptoSystem
- The crypto system to retrieve parameter information, if necessary.keyAlgorithm
- The type of key.
NoSuchAlgorithmException
- Thrown if the specified algorithm is
invalid.
InvalidKeyEncodingException
- Thrown if the key is improperly
formatted.
InvalidKeyException
- Thrown if the specified key is invalid.
InvalidCryptoSystemException
- Thrown if the specified crypto
system is invalid.
UnsupportedCryptoSystemException
- Thrown if the specified crypto
system is unsupported.
CryptoTokenException
- Thrown if an error occurs with the crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException
- Thrown if a call is made to
an unsupported operation.protected abstract PublicKey decodeKey(InputStream encodedKey, CryptoSystem cryptoSystem, String keyAlgorithm) throws NoSuchAlgorithmException, InvalidKeyEncodingException, InvalidKeyException, InvalidCryptoSystemException, UnsupportedCryptoSystemException, CryptoTokenException, CryptoUnsupportedOperationException, IOException
encodedKey
- The public key to decode, passed in as an input stream.cryptoSystem
- A cryptoSystem containing the parameters to use in making this key.keyAlgorithm
- The type of key.
NoSuchAlgorithmException
- Thrown if the specified algorithm is
invalid.
InvalidKeyEncodingException
- Thrown if the key is improperly
formatted.
InvalidKeyException
- Thrown if the specified key is invalid.
InvalidCryptoSystemException
- Thrown if the specified crypto
system is invalid.
UnsupportedCryptoSystemException
- Thrown if the specified crypto
system is unsupported.
CryptoTokenException
- Thrown if an error occurs with the crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException
- Thrown if a call is made to
an unsupported operation.
IOException
- Thrown when an I/O error occurs.public static PublicKey decode(InputStream encodedKey, String encodingAlgorithm) throws NoSuchAlgorithmException, InvalidKeyEncodingException, InvalidKeyException, InvalidCryptoSystemException, UnsupportedCryptoSystemException, CryptoTokenException, CryptoUnsupportedOperationException
encodedKey
- An input stream containing the encoding and other relevant information.encodingAlgorithm
- The encoding algorithm to use to decode, such as "X509."
NoSuchAlgorithmException
- Thrown if the specified algorithm is
invalid.
InvalidKeyEncodingException
- Thrown if the key is improperly
formatted.
InvalidKeyException
- Thrown if the specified key is invalid.
InvalidCryptoSystemException
- Thrown if the specified crypto
system is invalid.
UnsupportedCryptoSystemException
- Thrown if the specified crypto
system is unsupported.
CryptoTokenException
- Thrown if an error occurs with the crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException
- Thrown if a call is made to
an unsupported operation.public static PublicKey decode(byte[] encodedKey, String encodingAlgorithm) throws NoSuchAlgorithmException, InvalidKeyEncodingException, InvalidKeyException, InvalidCryptoSystemException, UnsupportedCryptoSystemException, CryptoTokenException, CryptoUnsupportedOperationException
encodedKey
- A byte array containing the encoding and other relevant information.encodingAlgorithm
- The encoding algorithm to use to decode, such as "X509."
NoSuchAlgorithmException
- Thrown if the specified algorithm is
invalid.
InvalidKeyEncodingException
- Thrown if the key is improperly
formatted.
InvalidKeyException
- Thrown if the specified key is invalid.
InvalidCryptoSystemException
- Thrown if the specified crypto
system is invalid.
UnsupportedCryptoSystemException
- Thrown if the specified crypto
system is unsupported.
CryptoTokenException
- Thrown if an error occurs with the crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException
- Thrown if a call is made to
an unsupported operation.public static boolean register(PublicKeyDecoder decoder, PublicKeyDecoder baseDecoder)
PublicKeyDecoder
with the framework.
decoder
- The algorithm decoder, such as X509_RSA_PublicKeyDecoder.baseDecoder
- The encoding algorithm wrapper, such as X509_PublicKeyDecoder.
protected static PublicKeyDecoder getDecoder(String encodingAlgorithm, String keyAlgorithm) throws NoSuchAlgorithmException
encodingAlgorithm
- The encoding algorithm such as "X509".keyAlgorithm
- The key type that was encoded, such as "EC".
NoSuchAlgorithmException
- Thrown if the encoding algorithm cannot be found.protected abstract String getEncodingAlgorithm()
protected abstract String[] getKeyAlgorithms()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.