net.rim.device.api.crypto.EncryptorFactory
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public abstract class EncryptorFactory
Provides the user with a high-level means to encrypt data. The factory
classes allow you to encrypt (see the DecryptorFactory class)
and decrypt data without worrying about most of the minute details of the
implementation. This class is suitable for developers with little
cryptographic experience or, for encrypting data where the details of the implementation are not as important as the result.
The low-level alternative to using the EncryptorFactory class is the
encryptor engine, such as the DESEncryptorEngine.
Note: When requesting a a block cipher in CFB mode you can specify the number of bits to be processed at a time. In our API there are two options allowed for CFB mode. You can either have 8bit mode (denoted by "CFB8") or full CFB mode (denoted simply by "CFB") which will process the full block length.
Note: When calling the getEncryptorOutputStream functions, if you specify the algorithm as just "RSA", or just pass in an RSAPublicKey, then what will be created is "RSA/PKCS1". This is because there are alot of problems with using RSA, by itself, with block encryption/decryption. To use the basic RSA function by itself, use the engine directly.
Note: When using the ElGamal Encryption algorithm it will automatically create an ephemeral localKeyPair for you and append that public key encoding to the front of the returned ciphertext according to the MPI format described in PGP. If you wish to use another format for ElGamal encryption use the engine directly.
For more information on the cryptographic algorithms supported by this factory, see Crypto Algorithms.
RSAEncryptorEngine,
ElGamalEncryptorEngine,
DecryptorFactory,
EncryptorOutputStream| Constructor Summary | ||
|---|---|---|
|
protected |
EncryptorFactory()
Creates an EncryptorFactory object. |
| Method Summary | ||
|---|---|---|
|
protected abstract Object |
create(String algorithm,
String nextAlgorithm,
Key key,
OutputStream stream,
InitializationVector iv)
Creates an instance of the EncryptorFactory class given the
specified parameters. |
|
static Enumeration |
getAlgorithms()
Returns an Enumeration of String representing all of the
registered algorithms with this factory. |
|
static BlockEncryptorEngine |
getBlockEncryptorEngine(Key key)
Returns the block encryptor engine used to encrypt the data. |
|
static BlockEncryptorEngine |
getBlockEncryptorEngine(Key key,
String algorithm)
Returns the block encryptor engine using the specified key and algorithm. |
|
static BlockEncryptorEngine |
getBlockEncryptorEngine(Key key,
String algorithm,
InitializationVector iv)
Returns the block encryptor engine using the specified key, algorithm and initialization vector. |
|
static EncryptorOutputStream |
getEncryptorOutputStream(Key key,
OutputStream stream)
Encrypts the data and returns the encrypted output stream given the specified key and output stream. |
|
static EncryptorOutputStream |
getEncryptorOutputStream(Key key,
OutputStream stream,
String algorithm)
Encrypts the data and returns the encrypted output stream given the specified key, outputstream and algorithm name. |
|
static EncryptorOutputStream |
getEncryptorOutputStream(Key key,
OutputStream stream,
String algorithm,
InitializationVector iv)
Encrypts the data and returns the encrypted output stream given the specified key, outputstream, algorithm name and initialization vector. |
|
protected abstract String[] |
getFactoryAlgorithms()
Returns a String containing the names of all algorithms supported by the encryptor factory. |
|
static void |
register(EncryptorFactory factory)
Registers the specified object. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected EncryptorFactory()
EncryptorFactory object.
| Method Detail |
|---|
public static EncryptorOutputStream getEncryptorOutputStream(Key key,
OutputStream stream)
throws NoSuchAlgorithmException,
CryptoTokenException,
CryptoUnsupportedOperationException,
CryptoException,
IOException
key - The key used to encrypt the data.stream - The output stream containing the plaintext to be encrypted.
NoSuchAlgorithmException - Thrown if the specified symmetric key is
improperly formatted or invalid.
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.
CryptoException
IOException
public static EncryptorOutputStream getEncryptorOutputStream(Key key,
OutputStream stream,
String algorithm)
throws NoSuchAlgorithmException,
CryptoTokenException,
CryptoUnsupportedOperationException,
CryptoException,
IOException
key - The key used to encrypt the data.stream - The output stream containing the plaintext to be encrypted.algorithm - A string that represents the algorithm along with the
details of the encryption. eg, "RC5_64_64" ("RC5_" + keyBitLength + "_" +
blockBitLength).
The string, consisting of one or more substrings, is read from right to
left with the left-most sub-string representing the name of the
algorithm. The two substrings to the right of the algorithm specify the
length of the key in bits and the block length of the data in bits.
If a substring is not defined, the default value is substituted instead.
NoSuchAlgorithmException - Thrown if the specified symmetric key is
improperly formatted or invalid.
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.
CryptoException
IOException
public static EncryptorOutputStream getEncryptorOutputStream(Key key,
OutputStream stream,
String algorithm,
InitializationVector iv)
throws NoSuchAlgorithmException,
CryptoTokenException,
CryptoUnsupportedOperationException,
CryptoException,
IOException
key - The key used to encrypt the data.stream - The output stream containing the plaintext to be encrypted.algorithm - A string that represents the algorithm along with the
details of the decryption. eg, "RC5_64_64" ("RC5_" + keyBitLength + "_" +
blockBitLength).
The string, consisting of one or more substrings, is read from right to
left with the left-most sub-string representing the name of the
algorithm. The two substrings to the right of the algorithm specify the
length of the key in bits and the block length of the data in bits.
If a substring is not defined, the default value is substituted instead.
iv - The initialization vector used to randomize the data.
NoSuchAlgorithmException - Thrown if the specified symmetric key is
improperly formatted or invalid.
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.
CryptoException
IOException
public static BlockEncryptorEngine getBlockEncryptorEngine(Key key)
throws NoSuchAlgorithmException,
CryptoTokenException,
CryptoUnsupportedOperationException,
CryptoException
key - The key used to encrypt the data.
BlockEncryptorEngine object used to encrypt the
data.
NoSuchAlgorithmException - Thrown if the specified symmetric key is
improperly formatted or invalid.
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.
CryptoException
public static BlockEncryptorEngine getBlockEncryptorEngine(Key key,
String algorithm)
throws NoSuchAlgorithmException,
CryptoTokenException,
CryptoUnsupportedOperationException,
CryptoException
key - The key used to encrypt the data.algorithm - A string that represents the algorithm along with the
details of the decryption. eg, "RC5_64_64" ("RC5_" + keyBitLength + "_" +
blockBitLength).
The string, consisting of one or more substrings, is read from right to
left with the left-most sub-string representing the name of the
algorithm. The two substrings to the right of the algorithm specify the
length of the key in bits and the block length of the data in bits.
If a substring is not defined, the default value is substituted instead.
BlockEncryptorEngine object used to encrypt the
data.
NoSuchAlgorithmException - Thrown if the specified symmetric key is
improperly formatted or invalid.
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.
CryptoException
public static BlockEncryptorEngine getBlockEncryptorEngine(Key key,
String algorithm,
InitializationVector iv)
throws NoSuchAlgorithmException,
CryptoTokenException,
CryptoUnsupportedOperationException,
CryptoException
key - The key used to encrypt the data.algorithm - A string that represents the algorithm along with the
details of the decryption. eg, "RC5_64_64" ("RC5_" + keyBitLength + "_" +
blockBitLength).
The string, consisting of one or more substrings, is read from right to
left with the left-most sub-string representing the name of the
algorithm. The two substrings to the right of the algorithm specify the
length of the key in bits and the block length of the data in bits.
If a substring is not defined, the default value is substituted instead.
iv - The initialization vector used to randomize the data.
BlockEncryptorEngine object used to encrypt the
data.
NoSuchAlgorithmException - Thrown if the specified symmetric key is
improperly formatted or invalid.
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.
CryptoExceptionpublic static void register(EncryptorFactory factory)
If a factory with the same name already exists, then this factory will not be added.
factory - The encryptor factory to be registered.public static Enumeration getAlgorithms()
String representing all of the
registered algorithms with this factory.
protected abstract String[] getFactoryAlgorithms()
protected abstract Object create(String algorithm,
String nextAlgorithm,
Key key,
OutputStream stream,
InitializationVector iv)
throws NoSuchAlgorithmException,
ClassCastException,
CryptoTokenException,
CryptoUnsupportedOperationException,
CryptoException,
IOException
EncryptorFactory class given the
specified parameters.
algorithm - String that specifies the details of the encryption
scheme. The string is composed of three separate strings concatenated
together and delimited by forward slashes. For example
DES/CBC/OAEP represents a valid string that specifies the
cipher, the mode and the formatter engine that will be used to encrypt
the data. The algorithm parameter corresponds to the
rightmost substring. The null value is passed if an element
is not specified. The null value specifies that the default value be used.nextAlgorithm - A String that represents the next substring to the
left of the initial algorithm parameter specified above.key - The key used to encrypt the data.stream - The OutputStream that contains the ciphertext
of the initial message.iv - The initialization vector initially used by the encryptor
engine to randomize the data.
EncryptorFactory object.
NoSuchAlgorithmException - Occurs when the specified algorithm is invalid.
ClassCastException - Occurs when an object is improperly cast.
CryptoTokenException - Occurs when the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown if a call is made to
an unsupported operation.
CryptoException
IOException
|
|||||||||
| 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.