Modifier and Type	Class and Description
private static class	OperatorHelper.PGPAeadInputStream
pack-priv static class	OperatorHelper.PGPAeadOutputStream

Modifier and Type	Field and Description
private JcaJceHelper	helper

Access	Constructor and Description
pack-priv	OperatorHelper(JcaJceHelper helper)

Modifier and Type	Method and Description
pack-priv Cipher	createAEADCipher(int encAlgorithm, int aeadAlgorithm)
public AlgorithmParameters	createAlgorithmParameters(String algorithm)
pack-priv Cipher	createCipher(String cipherName)
pack-priv PGPDataDecryptor	createDataDecryptor(boolean withIntegrityPacket, int encAlgorithm, byte[] key)
pack-priv PGPDataDecryptor	createDataDecryptor(final int aeadAlgorithm, final byte[] iv, final int chunkSize, final int encAlgorithm, byte[] key)
pack-priv MessageDigest	createDigest(int algorithm)
public KeyAgreement	createKeyAgreement(String algorithm)
pack-priv KeyFactory	createKeyFactory(String algorithm)
public KeyPairGenerator	createKeyPairGenerator(String algorithm)
pack-priv Cipher	createKeyWrapper(int encAlgorithm)
pack-priv Cipher	createPublicKeyCipher(int encAlgorithm)
private Signature	createSignature(String cipherName)
public Signature	createSignature(int keyAlgorithm, int hashAlgorithm)
pack-priv Cipher	createStreamCipher(int encAlgorithm, boolean withIntegrityPacket)
pack-priv static long	getChunkLength(int chunkSize)
pack-priv String	Returns: a String representation of the hash name. getDigestName(int the algorithm ID for a hash algorithm. hashAlgorithm) Return an appropriate name for the hash algorithm represented by the passed in hash algorithm ID number (JCA message digest naming convention).
pack-priv static byte[]	getNonce(byte[] iv, long chunkIndex)
pack-priv static void	xorChunkId(byte[] nonce, long chunkIndex)

helper	back to summary
private JcaJceHelper helper

OperatorHelper	back to summary
pack-priv OperatorHelper(JcaJceHelper helper)

Method Detail

createAEADCipher	back to summary
pack-priv Cipher createAEADCipher(int encAlgorithm, int aeadAlgorithm) throws PGPException

createAlgorithmParameters	back to summary
public AlgorithmParameters createAlgorithmParameters(String algorithm) throws NoSuchProviderException, NoSuchAlgorithmException

createCipher	back to summary
pack-priv Cipher createCipher(String cipherName) throws PGPException

createDataDecryptor	back to summary
pack-priv PGPDataDecryptor createDataDecryptor(boolean withIntegrityPacket, int encAlgorithm, byte[] key) throws PGPException

createDataDecryptor	back to summary
pack-priv PGPDataDecryptor createDataDecryptor(final int aeadAlgorithm, final byte[] iv, final int chunkSize, final int encAlgorithm, byte[] key) throws PGPException

createDigest	back to summary
pack-priv MessageDigest createDigest(int algorithm) throws GeneralSecurityException, PGPException

createKeyAgreement	back to summary
public KeyAgreement createKeyAgreement(String algorithm) throws GeneralSecurityException

createKeyFactory	back to summary
pack-priv KeyFactory createKeyFactory(String algorithm) throws GeneralSecurityException, PGPException

createKeyPairGenerator	back to summary
public KeyPairGenerator createKeyPairGenerator(String algorithm) throws GeneralSecurityException

createKeyWrapper	back to summary
pack-priv Cipher createKeyWrapper(int encAlgorithm) throws PGPException

createPublicKeyCipher	back to summary
pack-priv Cipher createPublicKeyCipher(int encAlgorithm) throws PGPException

createSignature	back to summary
private Signature createSignature(String cipherName) throws PGPException

createSignature	back to summary
public Signature createSignature(int keyAlgorithm, int hashAlgorithm) throws PGPException

createStreamCipher	back to summary
pack-priv Cipher createStreamCipher(int encAlgorithm, boolean withIntegrityPacket) throws PGPException

getChunkLength	back to summary
pack-priv static long getChunkLength(int chunkSize)

getDigestName	back to summary
pack-priv String getDigestName(int hashAlgorithm) throws PGPException Return an appropriate name for the hash algorithm represented by the passed in hash algorithm ID number (JCA message digest naming convention). Parameters hashAlgorithm:int the algorithm ID for a hash algorithm. Returns:String a String representation of the hash name.

getDigestName

back to summary

pack-priv String getDigestName(int hashAlgorithm) throws PGPException

Return an appropriate name for the hash algorithm represented by the passed in hash algorithm ID number (JCA message digest naming convention).

Parameters

hashAlgorithm:int: the algorithm ID for a hash algorithm.

Returns:String

a String representation of the hash name.

getNonce	back to summary
pack-priv static byte[] getNonce(byte[] iv, long chunkIndex)

xorChunkId	back to summary
pack-priv static void xorChunkId(byte[] nonce, long chunkIndex)

org.bouncycastle.openpgp.operator.jcajce back to summary

private Class OperatorHelper.PGPAeadInputStream

Class Inheritance

extends InputStream

java.lang.Object
java.io.InputStream
org.bouncycastle.openpgp.operator.jcajce.OperatorHelper.PGPAeadInputStream

Field Summary

Modifier and Type	Field and Description
private final byte[]	aaData
private final byte[]	buf
private final Cipher	c
private long	chunkIndex
private final int	chunkLength
private byte[]	data
private int	dataOff
private final InputStream	in
private final byte[]	iv
private final SecretKey	secretKey
private long	totalBytes

Constructor Summary

Access	Constructor and Description
public	PGPAeadInputStream(InputStream in, Cipher c, SecretKey secretKey, byte[] iv, int encAlgorithm, int aeadAlgorithm, int chunkSize)

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
private byte[]	readBlock()
public long	skip(long the number of bytes to be skipped. n) Overrides java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream.

Inherited from java.io.InputStream:: close mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skipNBytes transferTo

Field Detail

aaData	back to summary
private final byte[] aaData

buf	back to summary
private final byte[] buf

c	back to summary
private final Cipher c

chunkIndex	back to summary
private long chunkIndex

chunkLength	back to summary
private final int chunkLength

data	back to summary
private byte[] data

dataOff	back to summary
private int dataOff

in	back to summary
private final InputStream in

iv	back to summary
private final byte[] iv

secretKey	back to summary
private final SecretKey secretKey

totalBytes	back to summary
private long totalBytes

Constructor Detail

PGPAeadInputStream	back to summary
public PGPAeadInputStream(InputStream in, Cipher c, SecretKey secretKey, byte[] iv, int encAlgorithm, int aeadAlgorithm, int chunkSize) throws IOException

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. 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. 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 `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-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int 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. Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

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. 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 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-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

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.

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

readBlock	back to summary
private byte[] readBlock() throws IOException

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.InputStream.skip. Doc from java.io.InputStream.skip. 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, the `skip` method for class `InputStream` always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently. Parameters n:long the number of bytes to be skipped. Returns:long the actual number of bytes skipped which might be zero. Exceptions IOException: if an I/O error occurs.

public long skip(long n) throws IOException

Overrides java.io.InputStream.skip.

Doc from java.io.InputStream.skip.

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, the skip method for class InputStream always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

Parameters

n:long: the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped which might be zero.

Exceptions

IOException:: if an I/O error occurs.

org.bouncycastle.openpgp.operator.jcajce back to summary

pack-priv Class OperatorHelper.PGPAeadOutputStream

Class Inheritance

extends OutputStream

java.lang.Object
java.io.OutputStream
org.bouncycastle.openpgp.operator.jcajce.OperatorHelper.PGPAeadOutputStream

Field Summary

Modifier and Type	Field and Description
private final byte[]	aaData
private final Cipher	c
private long	chunkIndex
private final int	chunkLength
private final byte[]	data
private int	dataOff
private final byte[]	iv
private final OutputStream	out
private final SecretKey	secretKey
private long	totalBytes

Constructor Summary

Access	Constructor and Description
public	PGPAeadOutputStream(OutputStream out, Cipher c, SecretKey secretKey, int encAlgorithm, int aeadAlgorithm, int chunkSize, byte[] iv)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
private void	finish()
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
private void	writeBlock()

Inherited from java.io.OutputStream:: flush nullOutputStream write

Field Detail

aaData	back to summary
private final byte[] aaData

c	back to summary
private final Cipher c

chunkIndex	back to summary
private long chunkIndex

chunkLength	back to summary
private final int chunkLength

data	back to summary
private final byte[] data

dataOff	back to summary
private int dataOff

iv	back to summary
private final byte[] iv

out	back to summary
private final OutputStream out

secretKey	back to summary
private final SecretKey secretKey

totalBytes	back to summary
private long totalBytes

Constructor Detail

PGPAeadOutputStream	back to summary
public PGPAeadOutputStream(OutputStream out, Cipher c, SecretKey secretKey, int encAlgorithm, int aeadAlgorithm, int chunkSize, byte[] iv)

Method Detail

close back to summary

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions

IOException:: if an I/O error occurs.

finish	back to summary
private void finish() throws IOException

write back to summary

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

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.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

writeBlock	back to summary
private void writeBlock() throws IOException

pack-priv Class OperatorHelper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class OperatorHelper.PGPAeadInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class OperatorHelper.PGPAeadOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail