SHOW Signed

net.rim.device.api.crypto
Class ElGamalEncryptorEngine

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

All Implemented Interfaces:

BlockEncryptorEngine, PublicKeyEncryptorEngine

public final class ElGamalEncryptorEngine

extends Object

implements PublicKeyEncryptorEngine

In ElGamal encryption, two parts are generated and both are required to decrypt data. The first part is the ciphertext. The ciphertext is stored in a byte array and is passed into the encryptor engine as the parameter ciphertext.

The next part is the ephemeral key. The ephemeral key is acquired by calling the getEphmeralKey() method and sent to the recipient along with the ciphertext. Without the ephemeral key the ciphertext cannot be decrypted.

The version of ElGamal that we implemented can be found in "Applied Cryptography", by Bruce Schneier, in section 19.6 ( 1996 ).

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.
Certicom: This element is part of the Certicom Cryptography APIs. The Certicom Cryptography APIs provide the tools you need, including ECC based algorithms, to integrate high performance data security into your applications, such as public key data encryption and decryption, digital signatures, and data authentication. Since the Certicom Cryptography API is already in the JDE, its use will remove the need for you to engage in time and resource intensive security integration so that you have lower development costs and a faster time to market. Use of the Certicom Cryptography API requires a license from Certicom. Please contact Certicom directly for more information on licensing fees and conditions.

Certicom Contact Information

Phone:613-254-9258

Email: sales@certicom.com

Website: http://www.certicom.com/rim

Since:

JDE 3.6.0

Constructor Summary

	ElGamalEncryptorEngine(DHPublicKey remoteKey) Creates an ElGamalEncryptorEngine object using the specified ElGamal public key.
	ElGamalEncryptorEngine(DHPublicKey remoteKey, DHKeyPair localEphemeralKeyPairPair) Creates an ElGamalEncryptorEngine object.

Method Summary

	void	encrypt(byte[] plaintext, int plaintextOffset, byte[] ciphertext, int ciphertextOffset) Encrypts the plaintext with the ElGamal algorithm.
	String	getAlgorithm() Returns the name of the algoritm used to encrypt the data.
	int	getBlockLength() Return the block length of the encrypted data.
	DHPublicKey	getEphemeralKey() Returns the ephemeral key used to encrypt the data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElGamalEncryptorEngine

public ElGamalEncryptorEngine(DHPublicKey remoteKey)
                       throws CryptoTokenException,
                              CryptoUnsupportedOperationException

Creates an ElGamalEncryptorEngine object using the specified ElGamal public key.

Parameters:

remoteKey - The remote key to use for encrypting.

Throws:

CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.

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.
Certicom: This element is part of the Certicom Cryptography APIs. The Certicom Cryptography APIs provide the tools you need, including ECC based algorithms, to integrate high performance data security into your applications, such as public key data encryption and decryption, digital signatures, and data authentication. Since the Certicom Cryptography API is already in the JDE, its use will remove the need for you to engage in time and resource intensive security integration so that you have lower development costs and a faster time to market. Use of the Certicom Cryptography API requires a license from Certicom. Please contact Certicom directly for more information on licensing fees and conditions.

Certicom Contact Information

Phone:613-254-9258

Email: sales@certicom.com

Website: http://www.certicom.com/rim

ElGamalEncryptorEngine

public ElGamalEncryptorEngine(DHPublicKey remoteKey,
                              DHKeyPair localEphemeralKeyPairPair)
                       throws CryptoTokenException,
                              CryptoUnsupportedOperationException

Creates an ElGamalEncryptorEngine object.

Parameters:

remoteKey - The key to encrypt the data with.

localPair - The local key pair to encrypt with, if null this is the same as the first constructor.

Throws:

CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.

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.
Certicom: This element is part of the Certicom Cryptography APIs. The Certicom Cryptography APIs provide the tools you need, including ECC based algorithms, to integrate high performance data security into your applications, such as public key data encryption and decryption, digital signatures, and data authentication. Since the Certicom Cryptography API is already in the JDE, its use will remove the need for you to engage in time and resource intensive security integration so that you have lower development costs and a faster time to market. Use of the Certicom Cryptography API requires a license from Certicom. Please contact Certicom directly for more information on licensing fees and conditions.

Certicom Contact Information

Phone:613-254-9258

Email: sales@certicom.com

Website: http://www.certicom.com/rim

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of the algoritm used to encrypt the data.

This method will always return the String "ElGamal".

Returns:

The name of the algorithm used, ie "ElGamal".

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.
Certicom: This element is part of the Certicom Cryptography APIs. The Certicom Cryptography APIs provide the tools you need, including ECC based algorithms, to integrate high performance data security into your applications, such as public key data encryption and decryption, digital signatures, and data authentication. Since the Certicom Cryptography API is already in the JDE, its use will remove the need for you to engage in time and resource intensive security integration so that you have lower development costs and a faster time to market. Use of the Certicom Cryptography API requires a license from Certicom. Please contact Certicom directly for more information on licensing fees and conditions.

Certicom Contact Information

Phone:613-254-9258

Email: sales@certicom.com

Website: http://www.certicom.com/rim

encrypt

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

Encrypts the plaintext with the ElGamal algorithm. Can only be called once per object

Parameters:

plaintext - The text to be encoded.

plaintextOffset - The offset, or start position of the plaintext data, within the array.

ciphertext - The byte array to hold the ciphertext.

ciphertextOffset - The offset, or start position, of the ciphertext within the array.

Throws:

CryptoTokenException - Thrown if an error occurs with the crypto token or the crypto token is invalid.

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.
Certicom: This element is part of the Certicom Cryptography APIs. The Certicom Cryptography APIs provide the tools you need, including ECC based algorithms, to integrate high performance data security into your applications, such as public key data encryption and decryption, digital signatures, and data authentication. Since the Certicom Cryptography API is already in the JDE, its use will remove the need for you to engage in time and resource intensive security integration so that you have lower development costs and a faster time to market. Use of the Certicom Cryptography API requires a license from Certicom. Please contact Certicom directly for more information on licensing fees and conditions.

Certicom Contact Information

Phone:613-254-9258

Email: sales@certicom.com

Website: http://www.certicom.com/rim

getEphemeralKey

public DHPublicKey getEphemeralKey()

Returns the ephemeral key used to encrypt the data.

Returns:

The ephemeral key required for decryption.

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.
Certicom: This element is part of the Certicom Cryptography APIs. The Certicom Cryptography APIs provide the tools you need, including ECC based algorithms, to integrate high performance data security into your applications, such as public key data encryption and decryption, digital signatures, and data authentication. Since the Certicom Cryptography API is already in the JDE, its use will remove the need for you to engage in time and resource intensive security integration so that you have lower development costs and a faster time to market. Use of the Certicom Cryptography API requires a license from Certicom. Please contact Certicom directly for more information on licensing fees and conditions.

Certicom Contact Information

Phone:613-254-9258

Email: sales@certicom.com

Website: http://www.certicom.com/rim

getBlockLength

public int getBlockLength()

Return the block length of the encrypted data.

The block length corresponds to the amount of data that is encrypted at one time.

Returns:

The required length of blocks to be passed through the encryptor.

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.
Certicom: This element is part of the Certicom Cryptography APIs. The Certicom Cryptography APIs provide the tools you need, including ECC based algorithms, to integrate high performance data security into your applications, such as public key data encryption and decryption, digital signatures, and data authentication. Since the Certicom Cryptography API is already in the JDE, its use will remove the need for you to engage in time and resource intensive security integration so that you have lower development costs and a faster time to market. Use of the Certicom Cryptography API requires a license from Certicom. Please contact Certicom directly for more information on licensing fees and conditions.

Certicom Contact Information

Phone:613-254-9258

Email: sales@certicom.com

Website: http://www.certicom.com/rim