SHOW Signed

net.rim.device.api.crypto
Class ECIESEncryptor

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--net.rim.device.api.crypto.CryptoOutputStream
              |
              +--net.rim.device.api.crypto.EncryptorOutputStream
                    |
                    +--net.rim.device.api.crypto.StreamEncryptor
                          |
                          +--net.rim.device.api.crypto.ECIESEncryptor

public final class ECIESEncryptor

extends StreamEncryptor

ECIESEncryptor is a class used to encrypt messages with the Elliptic Curve Integrated Encryption Scheme ( ECIES ). It is described in ANSI X9.63.

Elliptic Curve cryptography is defined in various standards including P1363 and ANSI X9.62.

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:

ECIESDecryptor

Fields inherited from class net.rim.device.api.crypto.CryptoOutputStream

_out

Constructor Summary

	ECIESEncryptor(OutputStream out, ECPublicKey recipientPublicKey) Creates an ECIESEncryptor class.
	ECIESEncryptor(OutputStream out, ECPublicKey recipientPublicKey, String macAlgorithm, int macKeyLength, byte[] additionalMACInfo, int macLength, byte[] additionalKDFInfo, Digest kdfDigest, boolean useCofactor) Creates an ECIESEncryptor class.

Method Summary

	void	close() Closes the output stream.
	protected void	encrypt(byte[] plaintext, int plaintextOffset, int plaintextLength, byte[] ciphertext) Encrypts data using the specific implementation of the chosen stream encryptor.
	String	getAlgorithm() Returns the name of this algorithm, namely "ECIES/" + macAlgorithm.

Methods inherited from class net.rim.device.api.crypto.StreamEncryptor

write

Methods inherited from class net.rim.device.api.crypto.CryptoOutputStream

flush, getOutputStream, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ECIESEncryptor

public ECIESEncryptor(OutputStream out,
                      ECPublicKey recipientPublicKey)
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException,
                      InvalidCryptoSystemException,
                      IOException,
                      NoSuchAlgorithmException

Creates an ECIESEncryptor class. The MAC algorithm used is HMAC with SHA1 and a 20 byte mac key. Note that the cofactor is used in the shared secret calculation and the digest used in the KDF is SHA1.

Parameters:

out - The output stream to write too.

recipientPublicKey - The public key of the person this message will go to.

Throws:

CryptoTokenException - Thrown if a crypto token error occurs.

CryptoUnsupportedOperationException - Thrown if the attempted operation is not supported.

InvalidCryptoSystemException - Thrown if the crypto system has a problem with it.

IOException - Thrown if there is a problem writing to the output stream

NoSuchAlgorithmException - Thrown if the mac algorithm is not supported

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.

ECIESEncryptor

public ECIESEncryptor(OutputStream out,
                      ECPublicKey recipientPublicKey,
                      String macAlgorithm,
                      int macKeyLength,
                      byte[] additionalMACInfo,
                      int macLength,
                      byte[] additionalKDFInfo,
                      Digest kdfDigest,
                      boolean useCofactor)
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException,
                      InvalidCryptoSystemException,
                      IOException,
                      NoSuchAlgorithmException

Creates an ECIESEncryptor class.

Parameters:

out - The output stream to write too.

recipientPublicKey - The public key of the person this message will go to.

macAlgorithm - The MAC algorithm to use. If null, then "HMAC/SHA1" is used.

macKeyLength - The length of the MAC key to use.

additionalMACInfo - Additional mac information to provided to the MAC.

additionalKDFInfo - Additional shared information to provide to the KDF.

kdfDigest - Specifies the digest to use in the KDF. If null, then SHA1 is used.

useCofactor - If this true, a the elliptic curve's cofactor is used in the calculations. If false, the cofactor is not used. Note, setting this value to TRUE is the most common usage.

Throws:

CryptoTokenException - Thrown if a crypto token error occurs.

CryptoUnsupportedOperationException - Thrown if the attempted operation is not supported.

InvalidCryptoSystemException - Thrown if the crypto system has a problem with it.

IOException - Thrown if there is a problem writing to the output stream

NoSuchAlgorithmException - Thrown if the mac algorithm is not supported

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 this algorithm, namely "ECIES/" + macAlgorithm.

Overrides:

getAlgorithm in class CryptoOutputStream

Following copied from class: net.rim.device.api.crypto.CryptoOutputStream

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.

encrypt

protected void encrypt(byte[] plaintext,
                       int plaintextOffset,
                       int plaintextLength,
                       byte[] ciphertext)
                throws CryptoTokenException

Description copied from class: StreamEncryptor

Encrypts data using the specific implementation of the chosen stream encryptor.

Overrides:

encrypt in class StreamEncryptor

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.

close

public void close()
           throws IOException

Description copied from class: CryptoOutputStream

Closes the output stream.

Before closing the stream, it flushes out all of the data that is in the output stream.

See the flush() method for more information.

Overrides:

close in class CryptoOutputStream

Following copied from class: net.rim.device.api.crypto.CryptoOutputStream

Throws:

IOException - Thrown if an I/O error occurs.

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.