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

Modifier and Type	Field and Description
private final OperatorHelper	helper

Access	Constructor and Description
public	JceAEADUtil(OperatorHelper helper)

Modifier and Type	Method and Description
pack-priv Cipher	createAEADCipher(int encAlgorithm, int aeadAlgorithm)
pack-priv PGPDataDecryptor	Returns: decryptor createOpenPgpV5DataDecryptor(AEADEncDataPacket AEAD encrypted data packet aeadEncDataPacket, PGPSessionKey session key to decrypt the data sessionKey) Create a `PGPDataDecryptor` for decrypting AEAD encrypted OpenPGP v5 data packets.
pack-priv PGPDataDecryptor	Returns: decryptor createOpenPgpV6DataDecryptor(SymmetricEncIntegrityPacket version 2 SEIPD packet seipd, PGPSessionKey session key to decrypt the data sessionKey) Create a `PGPDataDecryptor` for decrypting AEAD encrypted OpenPGP v6 data.
pack-priv static byte[][]	Returns: message key and separate IV deriveMessageKeyAndIv(int AEAD algorithm aeadAlgo, int symmetric cipher algorithm cipherAlgo, byte[] session key sessionKey, byte[] salt salt, byte[] HKDF info hkdfInfo) Derive a message key and IV from the given session key.
pack-priv static byte[]	generateHKDFBytes(byte[] sessionKey, byte[] salt, byte[] hkdfInfo, int len)
protected static long	Returns: decoded length getChunkLength(int encoded chunk size chunkSize) Calculate an actual chunk length from the encoded chunk size.
protected static byte[]	Returns: nonce getNonce(byte[] initialization vector iv, long chunk index chunkIndex) Generate a nonce by xor-ing the given iv with the chunk index.
pack-priv static byte[]	processAeadKeyData(JceAEADUtil aeadUtil, int mode, int encAlgorithm, int aeadAlgorithm, byte[] s2kKey, byte[] iv, int packetTag, int keyVersion, byte[] keyData, int keyOff, int keyLen, byte[] pubkeyData)
protected static void	xorChunkId(byte[] byte array nonce, long chunk index chunkIndex) XOR the byte array with the chunk index in-place.

helper	back to summary
private final OperatorHelper helper

JceAEADUtil	back to summary
public JceAEADUtil(OperatorHelper helper)

Method Detail

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

createOpenPgpV5DataDecryptor back to summary

createOpenPgpV5DataDecryptor	back to summary
pack-priv PGPDataDecryptor createOpenPgpV5DataDecryptor(AEADEncDataPacket aeadEncDataPacket, PGPSessionKey sessionKey) throws PGPException Create a `PGPDataDecryptor` for decrypting AEAD encrypted OpenPGP v5 data packets. Parameters aeadEncDataPacket:AEADEncDataPacket AEAD encrypted data packet sessionKey:PGPSessionKey session key to decrypt the data Returns:PGPDataDecryptor decryptor

pack-priv PGPDataDecryptor createOpenPgpV5DataDecryptor(AEADEncDataPacket aeadEncDataPacket, PGPSessionKey sessionKey) throws PGPException

Create a PGPDataDecryptor for decrypting AEAD encrypted OpenPGP v5 data packets.

Parameters

aeadEncDataPacket:AEADEncDataPacket: AEAD encrypted data packet
sessionKey:PGPSessionKey: session key to decrypt the data

Returns:PGPDataDecryptor

decryptor

createOpenPgpV6DataDecryptor back to summary

createOpenPgpV6DataDecryptor	back to summary
pack-priv PGPDataDecryptor createOpenPgpV6DataDecryptor(SymmetricEncIntegrityPacket seipd, PGPSessionKey sessionKey) throws PGPException Create a `PGPDataDecryptor` for decrypting AEAD encrypted OpenPGP v6 data. Parameters seipd:SymmetricEncIntegrityPacket version 2 SEIPD packet sessionKey:PGPSessionKey session key to decrypt the data Returns:PGPDataDecryptor decryptor

pack-priv PGPDataDecryptor createOpenPgpV6DataDecryptor(SymmetricEncIntegrityPacket seipd, PGPSessionKey sessionKey) throws PGPException

Create a PGPDataDecryptor for decrypting AEAD encrypted OpenPGP v6 data.

Parameters

seipd:SymmetricEncIntegrityPacket: version 2 SEIPD packet
sessionKey:PGPSessionKey: session key to decrypt the data

Returns:PGPDataDecryptor

decryptor

deriveMessageKeyAndIv	back to summary
pack-priv static byte[][] deriveMessageKeyAndIv(int aeadAlgo, int cipherAlgo, byte[] sessionKey, byte[] salt, byte[] hkdfInfo) throws PGPException Derive a message key and IV from the given session key. The result is two byte arrays containing the key bytes and the IV. Parameters aeadAlgo:int AEAD algorithm cipherAlgo:int symmetric cipher algorithm sessionKey:byte[] session key salt:byte[] salt hkdfInfo:byte[] HKDF info Returns:byte[][] message key and separate IV

deriveMessageKeyAndIv

back to summary

pack-priv static byte[][] deriveMessageKeyAndIv(int aeadAlgo, int cipherAlgo, byte[] sessionKey, byte[] salt, byte[] hkdfInfo) throws PGPException

Derive a message key and IV from the given session key. The result is two byte arrays containing the key bytes and the IV.

Parameters

aeadAlgo:int: AEAD algorithm
cipherAlgo:int: symmetric cipher algorithm
sessionKey:byte[]: session key
salt:byte[]: salt
hkdfInfo:byte[]: HKDF info

Returns:byte[][]

message key and separate IV

generateHKDFBytes	back to summary
pack-priv static byte[] generateHKDFBytes(byte[] sessionKey, byte[] salt, byte[] hkdfInfo, int len)

getChunkLength	back to summary
protected static long getChunkLength(int chunkSize) Calculate an actual chunk length from the encoded chunk size. Parameters chunkSize:int encoded chunk size Returns:long decoded length

getChunkLength

back to summary

protected static long getChunkLength(int chunkSize)

Calculate an actual chunk length from the encoded chunk size.

Parameters

chunkSize:int: encoded chunk size

Returns:long

decoded length

getNonce	back to summary
protected static byte[] getNonce(byte[] iv, long chunkIndex) Generate a nonce by xor-ing the given iv with the chunk index. Parameters iv:byte[] initialization vector chunkIndex:long chunk index Returns:byte[] nonce

getNonce

back to summary

protected static byte[] getNonce(byte[] iv, long chunkIndex)

Generate a nonce by xor-ing the given iv with the chunk index.

Parameters

iv:byte[]: initialization vector
chunkIndex:long: chunk index

Returns:byte[]

nonce

processAeadKeyData	back to summary
pack-priv static byte[] processAeadKeyData(JceAEADUtil aeadUtil, int mode, int encAlgorithm, int aeadAlgorithm, byte[] s2kKey, byte[] iv, int packetTag, int keyVersion, byte[] keyData, int keyOff, int keyLen, byte[] pubkeyData) throws PGPException

xorChunkId	back to summary
protected static void xorChunkId(byte[] nonce, long chunkIndex) XOR the byte array with the chunk index in-place. Parameters nonce:byte[] byte array chunkIndex:long chunk index

xorChunkId

back to summary

protected static void xorChunkId(byte[] nonce, long chunkIndex)

XOR the byte array with the chunk index in-place.

Parameters

nonce:byte[]: byte array
chunkIndex:long: chunk index

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

pack-priv Class JceAEADUtil.PGPAeadInputStream

Class Inheritance

extends InputStream

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

Field Summary

Modifier and Type	Field and Description
private final byte[]	aaData
private final int	aeadTagLength
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
private boolean	v5StyleAEAD

Constructor Summary

Access	Constructor and Description
public	PGPAeadInputStream(boolean AEAD flavour (OpenPGP v5 or v6) isV5AEAD, InputStream underlying input stream in, Cipher AEAD cipher c, SecretKey secret key secretKey, byte[] initialization vector iv, int encryption algorithm encAlgorithm, int AEAD algorithm aeadAlgorithm, int chunk size of the AEAD encryption chunkSize, byte[] associated data aaData) InputStream for decrypting AEAD encrypted data.

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

aeadTagLength	back to summary
private final int aeadTagLength

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

v5StyleAEAD	back to summary
private boolean v5StyleAEAD

Constructor Detail

PGPAeadInputStream	back to summary
public PGPAeadInputStream(boolean isV5AEAD, InputStream in, Cipher c, SecretKey secretKey, byte[] iv, int encAlgorithm, int aeadAlgorithm, int chunkSize, byte[] aaData) throws IOException InputStream for decrypting AEAD encrypted data. Parameters isV5AEAD:boolean AEAD flavour (OpenPGP v5 or v6) in:InputStream underlying input stream c:Cipher AEAD cipher secretKey:SecretKey secret key iv:byte[] initialization vector encAlgorithm:int encryption algorithm aeadAlgorithm:int AEAD algorithm chunkSize:int chunk size of the AEAD encryption aaData:byte[] associated data

PGPAeadInputStream

back to summary

public PGPAeadInputStream(boolean isV5AEAD, InputStream in, Cipher c, SecretKey secretKey, byte[] iv, int encAlgorithm, int aeadAlgorithm, int chunkSize, byte[] aaData) throws IOException

InputStream for decrypting AEAD encrypted data.

Parameters

isV5AEAD:boolean: AEAD flavour (OpenPGP v5 or v6)
in:InputStream: underlying input stream
c:Cipher: AEAD cipher
secretKey:SecretKey: secret key
iv:byte[]: initialization vector
encAlgorithm:int: encryption algorithm
aeadAlgorithm:int: AEAD algorithm
chunkSize:int: chunk size of the AEAD encryption
aaData:byte[]: associated data

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 JceAEADUtil.PGPAeadOutputStream

Class Inheritance

extends OutputStream

java.lang.Object
java.io.OutputStream
org.bouncycastle.openpgp.operator.jcajce.JceAEADUtil.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 boolean	isV5AEAD
private final byte[]	iv
private final OutputStream	out
private final SecretKey	secretKey
private long	totalBytes

Constructor Summary

Access	Constructor and Description
public	PGPAeadOutputStream(boolean isV5AEAD of AEAD (OpenPGP v5 or v6) isV5AEAD, OutputStream underlying OutputStream out, Cipher AEAD cipher c, SecretKey secret key secretKey, byte[] initialization vector iv, int encryption algorithm encAlgorithm, int AEAD algorithm aeadAlgorithm, int chunk size of the AEAD algorithm chunkSize) OutputStream for AEAD encryption.

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 byte[]	Returns: associated data createAAD(boolean true if flavour of AEAD OpenPGP v5 isV5AEAD, int symmetric encryption algorithm encAlgorithm, int AEAD algorithm aeadAlgorithm, int chunk size chunkSize) Create the associated data for the AEAD encryption.
private void	finish()
private static byte[]	getAdata(boolean isV5AEAD, byte[] aaData, long chunkIndex, long totalBytes)
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

isV5AEAD	back to summary
private final boolean isV5AEAD

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(boolean isV5AEAD, OutputStream out, Cipher c, SecretKey secretKey, byte[] iv, int encAlgorithm, int aeadAlgorithm, int chunkSize)

OutputStream for AEAD encryption.

Parameters

isV5AEAD:boolean: isV5AEAD of AEAD (OpenPGP v5 or v6)
out:OutputStream: underlying OutputStream
c:Cipher: AEAD cipher
secretKey:SecretKey: secret key
iv:byte[]: initialization vector
encAlgorithm:int: encryption algorithm
aeadAlgorithm:int: AEAD algorithm
chunkSize:int: chunk size of the AEAD algorithm

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.

createAAD

back to summary

private byte[] createAAD(boolean isV5AEAD, int encAlgorithm, int aeadAlgorithm, int chunkSize)

Create the associated data for the AEAD encryption. Since the associated data array differs between OpenPGP v5 and v6, we need to know the flavour.

Parameters

isV5AEAD:boolean: true if flavour of AEAD OpenPGP v5
encAlgorithm:int: symmetric encryption algorithm
aeadAlgorithm:int: AEAD algorithm
chunkSize:int: chunk size

Returns:byte[]

associated data

finish	back to summary
private void finish() throws IOException

getAdata	back to summary
private static byte[] getAdata(boolean isV5AEAD, byte[] aaData, long chunkIndex, long totalBytes)

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 JceAEADUtil

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class JceAEADUtil.PGPAeadInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class JceAEADUtil.PGPAeadOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail