net.rim.device.api.crypto
Class ECIESEncryptor

java.lang.Object
  extended by java.io.OutputStream
      extended by net.rim.device.api.crypto.CryptoOutputStream
          extended by net.rim.device.api.crypto.EncryptorOutputStream
              extended by net.rim.device.api.crypto.StreamEncryptor
                  extended by 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.

For information on cryptographic algorithms, see Crypto Algorithms.

See Also:
ECIESDecryptor
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

Field Summary
 
Fields inherited from class net.rim.device.api.crypto.CryptoOutputStream
_out
 
Constructor Summary
Category: Signed ECIESEncryptor(OutputStream out, ECPublicKey recipientPublicKey)
          Creates an ECIESEncryptor class.
Category: Signed 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
Category: Signed  void close()
          Closes the output stream.
Category: Signed protected  void encrypt(byte[] plaintext, int plaintextOffset, int plaintextLength, byte[] ciphertext)
          Encrypts data using the specific implementation of the chosen stream encryptor.
Category: Signed  String getAlgorithm()
          Returns the name of this algorithm, namely "ECIES/" + macAlgorithm.
 
Methods inherited from class net.rim.device.api.crypto.StreamEncryptor
flush, 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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
macLength - The length of the MAC to use.
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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0


Method Detail

getAlgorithm

public String getAlgorithm()
Returns the name of this algorithm, namely "ECIES/" + macAlgorithm.

Specified by:
getAlgorithm in class CryptoOutputStream
Returns:
A String that represents the name of the algorithm.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.

Specified by:
encrypt in class StreamEncryptor
Parameters:
plaintext - A byte array containing the input to the stream cipher.
plaintextOffset - The offset, or initial position within the array, of the information to encrypt.
plaintextLength - The length of the information to encrypt.
ciphertext - A byte array to hold the output of the stream cipher.
Throws:
CryptoTokenException - Thrown when a problem occurs with the crypto token or the crypto token is invalid.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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
Throws:
IOException - Thrown if an I/O error occurs.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal