SHOW Signed

net.rim.device.api.crypto
Class RSAEncryptorEngine

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

All Implemented Interfaces:

BlockEncryptorEngine, PublicKeyEncryptorEngine

public final class RSAEncryptorEngine

extends Object

implements PublicKeyEncryptorEngine

Provides the RSA encryption functionality on a block by block basis. The block length is the size of the modulus, which must be a multiple of 8 bits.

A description of the RSA algorithm can be found in PKCS #1 version 2.1. We support this definition of RSA.

For a code sample using the RSA encryptor engine, click here.

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.

See Also:

RSADecryptorEngine

Constructor Summary

RSAEncryptorEngine(RSAPublicKey key) Creates an RSAEncryptorEngine object given a public key that will be used for encrypting the plaintext.

Method Summary

	void	encrypt(byte[] plaintext, int plaintextOffset, byte[] ciphertext, int ciphertextOffset) Encrypts a block of the given plaintext into a block of ciphertext.
	String	getAlgorithm() Returns the name of the algorithm used, ie "RSA".
	int	getBlockLength() Returns the block length of the engine in bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

RSAEncryptorEngine

public RSAEncryptorEngine(RSAPublicKey key)
                   throws CryptoTokenException,
                          CryptoUnsupportedOperationException

Creates an RSAEncryptorEngine object given a public key that will be used for encrypting the plaintext. The modulus must be a multiple of 8.

Parameters:

key - The public key associated with the private key that will be used to decrypt the data.

Throws:

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.

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.

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of the algorithm used, ie "RSA".

This method will always return the String "RSA".

Specified by:

getAlgorithm in interface BlockEncryptorEngine

Returns:

A String that represents the name of the algorithm.

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.

getBlockLength

public int getBlockLength()

Description copied from interface: BlockEncryptorEngine

Returns the block length of the engine in bytes.

Specified by:

getBlockLength in interface BlockEncryptorEngine

Following copied from interface: net.rim.device.api.crypto.BlockEncryptorEngine

Returns:

An integer that represents the number of bytes.

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.

encrypt

public void encrypt(byte[] plaintext,
                    int plaintextOffset,
                    byte[] ciphertext,
                    int ciphertextOffset)
             throws CryptoTokenException

Description copied from interface: BlockEncryptorEngine

Encrypts a block of the given plaintext into a block of ciphertext.

Specified by:

encrypt in interface BlockEncryptorEngine

Since:

JDE 3.6

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.