SHOW Signed

net.rim.device.api.crypto
Class EncryptorFactory

java.lang.Object
  |
  +--net.rim.device.api.crypto.EncryptorFactory

public abstract class EncryptorFactory
extends Object

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.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 3.6.0
See Also:

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., DecryptorFactory, EncryptorOutputStream


Constructor Summary
 
Method Summary
 Category: Signed static Enumeration getAlgorithms()
          Returns an Enumeration of String representing all of the registered algorithms with this factory.
 Category: Signed static BlockEncryptorEngine getBlockEncryptorEngine(Key key)
          Returns the block encryptor engine used to encrypt the data.
 Category: Signed static BlockEncryptorEngine getBlockEncryptorEngine(Key key, String algorithm)
          Returns the block encryptor engine using the specified key and algorithm.
 Category: Signed static BlockEncryptorEngine getBlockEncryptorEngine(Key key, String algorithm, InitializationVector iv)
          Returns the block encryptor engine using the specified key, algorithm and initialization vector.
 Category: Signed static EncryptorOutputStream getEncryptorOutputStream(Key key, OutputStream stream)
          Encrypts the data and returns the encrypted output stream given the specified key and output stream.
 Category: Signed 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.
 Category: Signed 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.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail
Method Detail

getEncryptorOutputStream

public static EncryptorOutputStream getEncryptorOutputStream(Key key,
                                                             OutputStream stream)
                                                      throws NoSuchAlgorithmException,
                                                             CryptoTokenException,
                                                             CryptoUnsupportedOperationException,
                                                             CryptoException,
                                                             IOException
Encrypts the data and returns the encrypted output stream given the specified key and output stream.

Parameters:
key - The key used to encrypt the data.
stream - The output stream containing the plaintext to be encrypted.
Returns:
The encrypted output stream.
Throws:
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.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getEncryptorOutputStream

public static EncryptorOutputStream getEncryptorOutputStream(Key key,
                                                             OutputStream stream,
                                                             String algorithm)
                                                      throws NoSuchAlgorithmException,
                                                             CryptoTokenException,
                                                             CryptoUnsupportedOperationException,
                                                             CryptoException,
                                                             IOException
Encrypts the data and returns the encrypted output stream given the specified key, outputstream and algorithm name.

Parameters:
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.

Returns:
The output stream to contain the encrypted data.
Throws:
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.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getEncryptorOutputStream

public static EncryptorOutputStream getEncryptorOutputStream(Key key,
                                                             OutputStream stream,
                                                             String algorithm,
                                                             InitializationVector iv)
                                                      throws NoSuchAlgorithmException,
                                                             CryptoTokenException,
                                                             CryptoUnsupportedOperationException,
                                                             CryptoException,
                                                             IOException
Encrypts the data and returns the encrypted output stream given the specified key, outputstream, algorithm name and initialization vector.

Parameters:
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.
Returns:
The output stream to contain the encrypted data.
Throws:
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.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getBlockEncryptorEngine

public static BlockEncryptorEngine getBlockEncryptorEngine(Key key)
                                                    throws NoSuchAlgorithmException,
                                                           CryptoTokenException,
                                                           CryptoUnsupportedOperationException,
                                                           CryptoException
Returns the block encryptor engine used to encrypt the data.

Parameters:
key - The key used to encrypt the data.
Returns:
The BlockEncryptorEngine object used to encrypt the data.
Throws:
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.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getBlockEncryptorEngine

public static BlockEncryptorEngine getBlockEncryptorEngine(Key key,
                                                           String algorithm)
                                                    throws NoSuchAlgorithmException,
                                                           CryptoTokenException,
                                                           CryptoUnsupportedOperationException,
                                                           CryptoException
Returns the block encryptor engine using the specified key and algorithm.

Parameters:
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.

Returns:
The BlockEncryptorEngine object used to encrypt the data.
Throws:
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.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getBlockEncryptorEngine

public static BlockEncryptorEngine getBlockEncryptorEngine(Key key,
                                                           String algorithm,
                                                           InitializationVector iv)
                                                    throws NoSuchAlgorithmException,
                                                           CryptoTokenException,
                                                           CryptoUnsupportedOperationException,
                                                           CryptoException
Returns the block encryptor engine using the specified key, algorithm and initialization vector.

Parameters:
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.
Returns:
The BlockEncryptorEngine object used to encrypt the data.
Throws:
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.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getAlgorithms

public static Enumeration getAlgorithms()
Returns an Enumeration of String representing all of the registered algorithms with this factory.
Returns:
An Enumeration of Strings representing all of the registered algorithms with this factory.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2004 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.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.