java.io.InputStream
net.rim.device.api.crypto.cms.CMSInputStream
net.rim.device.api.crypto.cms.CMSEnvelopedDataInputStream
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public final class CMSEnvelopedDataInputStream
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.
CMSEnvelopedDataOutputStream| Field Summary |
|---|
| Fields inherited from class net.rim.device.api.crypto.cms.CMSInputStream |
|---|
_contentType, _data, _input |
| Method Summary | ||
|---|---|---|
|
boolean |
areCertificatesPresent()
Returns true if there are certificates in the message, else returns false. |
|
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. |
|
CMSAttribute |
getAttribute(OID oid)
Returns the cms attribute identified by oid. |
|
Enumeration |
getAttributes()
Returns an enumeration of all of the attributes found in this cms message ( ie. an enumeration of CMSAttributes ). |
|
X509CertificateRevocationList |
getCRL()
Returns the CRL found in the message, if present, otherwise null. |
|
Certificate |
getCertificate(CMSEntityIdentifier recipient)
Returns the certificate associated with the specified recipient. |
|
Certificate[] |
getCertificateChain(CMSEntityIdentifier recipient)
Returns the certificate chain associated with the specified recipient. |
|
Certificate[] |
getCertificates()
Returns an array of the certificates found in this message, or null if none are present. |
|
int |
getContentCipherConstant()
Returns the constant representing which symmetric algorithm that was used to encrypt the data. |
|
CMSEntityIdentifier |
getRecipient()
This function returns the CMSEntityIdentifier associated with the private key used to decrypt this message. |
|
String |
getRecipientPublicKeyAlgorithm()
Returns the name of the public key algorithm used to encrypt this message. |
|
int |
getRecipientPublicKeyBitLength()
Returns the bit length of the public key used to encrypt this message. |
|
CMSEntityIdentifier[] |
getRecipients()
Returns a list of all of the recipients found in this message. |
|
SymmetricKey |
getSessionKey()
Returns the session key used to encrypt the message. |
|
boolean |
isContentComplete()
Determines whether the entire content part ( ie. the inner CMS message ) of this stream was in this stream. |
|
boolean |
isEncrypted()
Returns true since this message isencrypted. |
|
boolean |
isSigned()
Determines if this part, or any nested part, of this CMS message is 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. |
|
void |
setData(InputStream data)
Allows the user to set where the encrypted data comes from if it is not in the message. |
|
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 |
|---|
public Certificate getCertificate(CMSEntityIdentifier 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 ).
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 ).
public Certificate[] getCertificateChain(CMSEntityIdentifier recipient)
throws CMSException,
CryptoTokenException,
CryptoUnsupportedOperationException
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 ).
recipient - The CMSEntityIdentifier identifying the certificate chain to lookup.
CMSException
CryptoTokenException
CryptoUnsupportedOperationExceptionpublic int getContentCipherConstant()
public String getRecipientPublicKeyAlgorithm()
public int getRecipientPublicKeyBitLength()
public boolean isSigned()
CMSInputStream
isSigned in class CMSInputStreampublic boolean isEncrypted()
isEncrypted in class CMSInputStreampublic Enumeration getAttributes()
public CMSAttribute getAttribute(OID oid)
oid.
If there is no match, null is returned.
oid - An oid used to identify a CMSAttribute.
CMSAttribute corresponding to the oid. May be null.
public void setData(InputStream data)
throws IOException,
CMSException,
CryptoTokenException,
KeyStoreCancelException,
CryptoUnsupportedOperationException,
UnsupportedCryptoSystemException,
InvalidCryptoSystemException,
InvalidKeyException,
InvalidKeyEncodingException
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.
setData in class CMSInputStreamdata - An InputStream specifying where the data comes
from.
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.public SymmetricKey getSessionKey()
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.
SymmetricKey corresponding to the session key. May be null.
public X509CertificateRevocationList getCRL()
throws CRLEncodingException,
CRLVerificationException,
IOException,
CryptoTokenException,
CryptoUnsupportedOperationException
X509CertificateRevocationList object or null if not present
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.
public int read(byte[] buffer,
int offset,
int length)
throws IOException
InputStreamlen 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.
read in class CMSInputStreambuffer - the buffer into which the data is read.offset - the start offset in array b
at which the data is written.length - the maximum number of bytes to read.
-1 if there is no more data because the end of
the stream has been reached.
IOException - if an I/O error occurs.InputStream.read()
public int available()
throws IOException
InputStream The available method for class InputStream
always returns 0.
This method should be overridden by subclasses.
available in class CMSInputStreamIOException - if an I/O error occurs.
public long skip(long n)
throws IOException
InputStreamn 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.
skip in class CMSInputStreamn - the number of bytes to be skipped.
IOException - if an I/O error occurs.public Certificate[] getCertificates()
public boolean areCertificatesPresent()
public CMSEntityIdentifier getRecipient()
public CMSEntityIdentifier[] getRecipients()
throws CMSParsingException
CMSParsingException - Thrown if an error occurs while parsing the
CMS input stream.public boolean isContentComplete()
CMSInputStream
isContentComplete in class CMSInputStream
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.