SHOW Signed
 

net.rim.device.api.crypto.cms
Class CMSEnvelopedDataInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--net.rim.device.api.crypto.cms.CMSInputStream
              |
              +--net.rim.device.api.crypto.cms.CMSEnvelopedDataInputStream

public final class CMSEnvelopedDataInputStream
extends CMSInputStream

Defines an input stream to parse a CMS enveloped message. The user has the option of specifying the session key to decrypt the message, in order to skip doing the key agreement/transport parts of CMS. The session key can be specified in the second getCMSInputStream factory function in CMSInputStream.

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:
JDE 4.0.0
See Also:
CMSEnvelopedDataOutputStream

Field Summary
 
Fields inherited from class net.rim.device.api.crypto.cms.CMSInputStream
_contentType, _data, _input
 
Method Summary
 Category: Signed  boolean areCertificatesPresent()
          Returns true if there are certificates in the message, else returns false.
 Category: Signed  int available()
          Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
 Category: Signed  CMSAttribute getAttribute(OID oid)
          Returns the cms attribute identified by oid.
 Category: Signed  Enumeration getAttributes()
          Returns an enumeration of all of the attributes found in this cms message ( ie. an enumeration of CMSAttributes ).
 Category: Signed  Certificate getCertificate(CMSEntityIdentifier recipient)
          Returns the certificate associated with the specified recipient.
 Category: Signed  Certificate[] getCertificateChain(CMSEntityIdentifier recipient)
          Returns the certificate chain associated with the specified recipient.
 Category: Signed  Certificate[] getCertificates()
          Returns an array of the certificates found in this message, or null if none are present.
 Category: Signed  int getContentCipherConstant()
          Returns the constant representing which symmetric algorithm that was used to encrypt the data.
 Category: Signed  X509CertificateRevocationList getCRL()
          Returns the CRL found in the message, if present, otherwise null.
 Category: Signed  CMSEntityIdentifier getRecipient()
          This function returns the CMSEntityIdentifier associated with the private key used to decrypt this message.
 Category: Signed  String getRecipientPublicKeyAlgorithm()
          Returns the name of the public key algorithm used to encrypt this message.
 Category: Signed  int getRecipientPublicKeyBitLength()
          Returns the bit length of the public key used to encrypt this message.
 Category: Signed  CMSEntityIdentifier[] getRecipients()
          Returns a list of all of the recipients found in this message.
 Category: Signed  SymmetricKey getSessionKey()
          Returns the session key used to encrypt the message.
 Category: Signed  boolean isContentComplete()
          Determines whether the entire content part ( ie. the inner CMS message ) of this stream was in this stream.
 Category: Signed  boolean isEncrypted()
          Returns true since this message isencrypted.
 Category: Signed  boolean isSigned()
          Determines if this part, or any nested part, of this CMS message is signed.
 Category: Signed  int read(byte[] buffer, int offset, int length)
          Reads up to len bytes of data from the input stream into an array of bytes.
 Category: Signed  void setData(InputStream data)
          Allows the user to set where the encrypted data comes from if it is not in the message.
 Category: Signed  long skip(long n)
          Skips over and discards n bytes of data from this input stream.
 
Methods inherited from class net.rim.device.api.crypto.cms.CMSInputStream
close, getCMSContext, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getContentType, read, read
 
Methods inherited from class java.io.InputStream
mark, markSupported, reset
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

areCertificatesPresent

public boolean areCertificatesPresent()
Returns true if there are certificates in the message, else returns false.

Returns:
A boolean which is true if certificates are present.
Since:
JDE 4.0.0
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.

available

public int available()
              throws IOException
Description copied from class: InputStream
Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or or another thread.

The available method for class InputStream always returns 0.

This method should be overridden by subclasses.

Overrides:
available in class CMSInputStream
Since:
JDE 4.0.0

Following copied from class: InputStream
Returns:
the number of bytes that can be read from this input stream without blocking.
Throws:
IOException - 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.

getAttribute

public CMSAttribute getAttribute(OID oid)
Returns the cms attribute identified by oid.

If there is no match, null is returned.

Parameters:
oid - An oid used to identify a CMSAttribute.
Returns:
A CMSAttribute corresponding to the oid. May be null.
Since:
JDE 4.0.0
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.

getAttributes

public Enumeration getAttributes()
Returns an enumeration of all of the attributes found in this cms message ( ie. an enumeration of CMSAttributes ).

Returns:
An enumeration of all of the attributes present ( ie. an enumeration of CMSAttributes ).
Since:
JDE 4.0.0
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.

getCertificate

public Certificate getCertificate(CMSEntityIdentifier recipient)
Returns the certificate associated with the specified recipient.

This could have different meanings depending on which key management algorithm was used. If a password was used, then this certificate will be null. If a public key algorithm, such as RSA, was used, this will be the receipient's certificate ( since the message was encrypted with the receipient's public key ).

Parameters:
recipient - The CMSEntityIdentifier identifying the recipient to retrieve the certificate for. May be null, in which case null will be returned ( since the recipient could be from a password ).

Returns:
The encryptor's certificate. May be null.
Since:
JDE 4.0.0
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.

getCertificateChain

public Certificate[] getCertificateChain(CMSEntityIdentifier recipient)
                                  throws CMSException,
                                         CryptoTokenException,
                                         CryptoUnsupportedOperationException
Returns the certificate chain associated with the specified recipient.

This could have different meanings depending on which key management algorithm was used. If a password was used, then this certificate will be null. If a public key algorithm, such as RSA, was used, this will be the receipient's certificate ( since the message was encrypted with the recipient's public key ). Or, if a key agreement algorithm, such as DH, was used, then this certificate will refer to the sender's public key ( which was used with the receipient's private key for the key agreement step ).

Parameters:
recipient - The CMSEntityIdentifier identifying the certificate chain to lookup.

Returns:
The encryptor's certificate chain. May be null.
Since:
JDE 4.0.0
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.

getCertificates

public Certificate[] getCertificates()
Returns an array of the certificates found in this message, or null if none are present.

Returns:
An array of all of the certificates from the message. May be null.
Since:
JDE 4.0.0
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.

getContentCipherConstant

public int getContentCipherConstant()
Returns the constant representing which symmetric algorithm that was used to encrypt the data. These constants are defined in { @link CMSEnvelopedDataConstants CMSEnvelopedDataConstants }.

Returns:
an integer constant representing the symmetric algorithm
Since:
JDE 4.0.0
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.

getCRL

public X509CertificateRevocationList getCRL()
                                     throws CRLEncodingException,
                                            CRLVerificationException,
                                            IOException,
                                            CryptoTokenException,
                                            CryptoUnsupportedOperationException
Returns the CRL found in the message, if present, otherwise null. Note: The issuer of the CRL ( the CA of the signers certificate ) must be present in the verification keystore that was passed into the constructor of this class.

Returns:
An X509CertificateRevocationList object or null if not present
Throws:
CRLEncodingException - Thrown if the crl is not encoded properly.
CRLVerificationException - Thrown if the response could not be verified. For example if the CRL issuer is not present in the verification keystore, or the verification keystore is null.
IOException - Thrown if an I/O error occurs.
CryptoTokenException - Thrown if an error occurs with a crypto token.
CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.
Since:
JDE 4.0.0
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.

getRecipient

public CMSEntityIdentifier getRecipient()
This function returns the CMSEntityIdentifier associated with the private key used to decrypt this message. If the message was encrypted with a password, then this will return null ( since there was no associated private key ).

Returns:
A CMSEntityIdentifier associated with the private key used to decrypt this message.
Since:
JDE 4.0.0
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.

getRecipientPublicKeyAlgorithm

public String getRecipientPublicKeyAlgorithm()
Returns the name of the public key algorithm used to encrypt this message.

Returns:
a string representing the public key algorithm
Since:
JDE 4.0.0
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.

getRecipientPublicKeyBitLength

public int getRecipientPublicKeyBitLength()
Returns the bit length of the public key used to encrypt this message.

Returns:
an integer representing the bit length of the public key algorithm used
Since:
JDE 4.0.0
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.

getRecipients

public CMSEntityIdentifier[] getRecipients()
                                    throws CMSParsingException
Returns a list of all of the recipients found in this message.

Returns:
An array of CMSEntityIdentifiers representing the recipients in this message. May be null.
Throws:
CMSParsingException - Thrown if an error occurs while parsing the CMS input stream.
Since:
JDE 4.0.0
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.

getSessionKey

public SymmetricKey getSessionKey()
Returns the session key used to encrypt the message.

Note that this can be used in { @link CMSInputStream#getCMSInputStream CMSInputStream.getCMSInputStream( ..., SessionKey } to specify the session key, when creating a CMSInputStream. This is a much more efficient way to process the stream, if you can do it.

Returns:
A SymmetricKey corresponding to the session key. May be null.
Since:
JDE 4.0.0
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.

isContentComplete

public boolean isContentComplete()
Description copied from class: CMSInputStream
Determines whether the entire content part ( ie. the inner CMS message ) of this stream was in this stream.
Overrides:
isContentComplete in class CMSInputStream
Since:
JDE 4.0.0

Following copied from class: CMSInputStream
Returns:
True if the content is complete within this stream, false if it was cut-off.
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.

isEncrypted

public boolean isEncrypted()
Returns true since this message isencrypted.

Overrides:
isEncrypted in class CMSInputStream
Returns:
A boolean set to true.
Since:
JDE 4.0.0
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.

isSigned

public boolean isSigned()
Description copied from class: CMSInputStream
Determines if this part, or any nested part, of this CMS message is signed.

Overrides:
isSigned in class CMSInputStream
Since:
JDE 4.0.0

Following copied from class: CMSInputStream
Returns:
A boolean that represents whether the message part is signed.
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.

read

public int read(byte[] buffer,
                int offset,
                int length)
         throws IOException
Description copied from class: InputStream
Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read, possibly zero. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.

If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed.

The read(b, off, len) method for class InputStream simply calls the method read() repeatedly. If the first such call results in an IOException, that exception is returned from the call to the read(b, off, len) method. If any subsequent call to read() results in a IOException, the exception is caught and treated as if it were end of file; the bytes read up to that point are stored into b and the number of bytes read before the exception occurred is returned. Subclasses are encouraged to provide a more efficient implementation of this method.

Overrides:
read in class CMSInputStream
Since:
JDE 4.0.0

Following copied from class: InputStream
Parameters:
b - the buffer into which the data is read.
off - the start offset in array b at which the data is written.
len - the maximum number of bytes to read.
Returns:
the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
Throws:
IOException - if an I/O error occurs.
See Also:
InputStream.read()
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.

setData

public void setData(InputStream data)
             throws IOException,
                    CMSException,
                    CryptoTokenException,
                    KeyStoreCancelException,
                    CryptoUnsupportedOperationException,
                    UnsupportedCryptoSystemException,
                    InvalidCryptoSystemException,
                    InvalidKeyException,
                    InvalidKeyEncodingException
Allows the user to set where the encrypted data comes from if it is not in the message.

You would call this function in the case that the contents of the message is detached from the actual CMS encoding. For example, in a clear signed SMIME message, the text ( what is signed ) is in a different MIME part then the CMS encoding. You could use this function to give CMS an input stream that points to the MIME part containing the text of the message.

Overrides:
setData in class CMSInputStream
Parameters:
data - An InputStream specifying where the data comes from.
Throws:
IOException - Thrown if an IO error occurs.
CMSException - Thrown if a cms error occurs.
CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.
KeyStoreCancelException - Thrown if the user fails to enter a password or the password is invalid.
CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.
UnsupportedCryptoSystemException - Thrown if the specified crypto system is invalid.
InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.
InvalidKeyException - Thrown if the specified key is invalid.
InvalidKeyEncodingException - Thrown if the key is improperly formatted.
Since:
JDE 4.0.0
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.

skip

public long skip(long n)
          throws IOException
Description copied from class: InputStream
Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, no bytes are skipped.

The skip method of InputStream creates a byte array and then repeatedly reads into it until n bytes have been read or the end of the stream has been reached. Subclasses are encouraged to provide a more efficient implementation of this method.

Overrides:
skip in class CMSInputStream
Since:
JDE 4.0.0

Following copied from class: InputStream
Parameters:
n - the number of bytes to be skipped.
Returns:
the actual number of bytes skipped.
Throws:
IOException - 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.



Copyright 1999-2009 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.