Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	HPKE.AEAD
private static class	HPKE.Impl

Field Summary

Modifier and Type	Field and Description
private static final int	AFTER_FINAL
private static final byte[]	BASE_NONCE
private static final int	BEGIN
private static final int	ENCRYPT_AND_EXPORT
private static final byte[]	EXP
private static final int	EXPORT_ONLY
private static final byte[]	HPKE
private HPKE.Impl	impl
private static final byte[]	INFO_HASH
private static final byte[]	KEY
private static final byte[]	PSK_ID_HASH
private static final byte[]	SEC
private static final byte[]	SECRET
private int	state

Access	Constructor and Description
public	HPKE()

Method Summary

Modifier and Type	Method and Description
private static byte[]	concat(byte[]... inputs)
protected byte[]	engineDoFinal(byte[] input, int inputOffset, int inputLen) Implements abstract javax.crypto.CipherSpi.engineDoFinal. Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
protected int	engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) Implements abstract javax.crypto.CipherSpi.engineDoFinal. Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
protected byte[]	engineExportData(byte[] context, int length)
protected SecretKey	engineExportKey(String algorithm, byte[] context, int length)
protected int	engineGetBlockSize() Implements abstract javax.crypto.CipherSpi.engineGetBlockSize. Returns the block size (in bytes).
protected byte[]	engineGetIV() Implements abstract javax.crypto.CipherSpi.engineGetIV. Returns the initialization vector (IV) in a new buffer.
protected int	engineGetOutputSize(int inputLen) Implements abstract javax.crypto.CipherSpi.engineGetOutputSize. Returns the length in bytes that an output buffer would need to be in order to hold the result of the next `update` or `doFinal` operation, given the input length `inputLen` (in bytes).
protected AlgorithmParameters	engineGetParameters() Implements abstract javax.crypto.CipherSpi.engineGetParameters. Returns the parameters used with this cipher.
protected void	engineInit(int opmode, Key key, SecureRandom random) Implements abstract javax.crypto.CipherSpi.engineInit. Initializes this `CipherSpi` object with a key and a source of randomness.
protected void	engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random) Implements abstract javax.crypto.CipherSpi.engineInit. Initializes this `CipherSpi` object with a key, a set of algorithm parameters, and a source of randomness.
protected void	engineInit(int opmode, Key key, AlgorithmParameters params, SecureRandom random) Implements abstract javax.crypto.CipherSpi.engineInit. Initializes this `CipherSpi` object with a key, a set of algorithm parameters, and a source of randomness.
protected void	engineSetMode(String mode) Implements abstract javax.crypto.CipherSpi.engineSetMode. Sets the mode of this cipher.
protected void	engineSetPadding(String padding) Implements abstract javax.crypto.CipherSpi.engineSetPadding. Sets the padding mechanism of this cipher.
protected byte[]	engineUpdate(byte[] input, int inputOffset, int inputLen) Implements abstract javax.crypto.CipherSpi.engineUpdate. Continues a multiple-part encryption or decryption operation (depending on how this `CipherSpi` object was initialized), processing another data part.
protected int	engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) Implements abstract javax.crypto.CipherSpi.engineUpdate. Continues a multiple-part encryption or decryption operation (depending on how this `CipherSpi` object was initialized), processing another data part.
protected void	engineUpdateAAD(byte[] src, int offset, int len) Overrides javax.crypto.CipherSpi.engineUpdateAAD. Continues a multipart update of the Additional Authentication Data (AAD), using a subset of the provided buffer.
protected void	engineUpdateAAD(ByteBuffer src) Overrides javax.crypto.CipherSpi.engineUpdateAAD. Continues a multipart update of the Additional Authentication Data (AAD).
private void	maybeReinitInternalCipher()
private static boolean	usePSK(SecretKey psk)

Inherited from javax.crypto.CipherSpi:: engineDoFinal engineGetKeySize engineUnwrap engineUpdate engineWrap

Field Detail

AFTER_FINAL	back to summary
private static final int AFTER_FINAL

BASE_NONCE	back to summary
private static final byte[] BASE_NONCE

BEGIN	back to summary
private static final int BEGIN

ENCRYPT_AND_EXPORT	back to summary
private static final int ENCRYPT_AND_EXPORT

EXP	back to summary
private static final byte[] EXP

EXPORT_ONLY	back to summary
private static final int EXPORT_ONLY

HPKE	back to summary
private static final byte[] HPKE

impl	back to summary
private HPKE.Impl impl

INFO_HASH	back to summary
private static final byte[] INFO_HASH

KEY	back to summary
private static final byte[] KEY

PSK_ID_HASH	back to summary
private static final byte[] PSK_ID_HASH

SEC	back to summary
private static final byte[] SEC

SECRET	back to summary
private static final byte[] SECRET

state	back to summary
private int state

Constructor Detail

HPKE	back to summary
public HPKE()

Method Detail

concat	back to summary
private static byte[] concat(byte[]... inputs)

engineDoFinal back to summary

engineDoFinal	back to summary
protected byte[] engineDoFinal(byte[] input, int inputOffset, int inputLen) throws IllegalBlockSizeException, BadPaddingException Implements abstract javax.crypto.CipherSpi.engineDoFinal. Doc from javax.crypto.CipherSpi.engineDoFinal. Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this `CipherSpi` object was initialized. The first `inputLen` bytes in the `input` buffer, starting at `inputOffset` inclusive, and any input bytes that may have been buffered during a previous `update` operation, are processed, with padding (if requested) being applied. If an AEAD mode (such as GCM or CCM) is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in a new buffer. Upon finishing, this method resets this `CipherSpi` object to the state it was in when previously initialized via a call to `engineInit`. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to `engineInit`) more data. Note if any exception is thrown, this `CipherSpi` object may need to be reset before it can be used again. Annotations @Override Exceptions IllegalBlockSizeException: if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided BadPaddingException: if this `CipherSpi` object is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes

protected byte[] engineDoFinal(byte[] input, int inputOffset, int inputLen) throws IllegalBlockSizeException, BadPaddingException

Implements abstract javax.crypto.CipherSpi.engineDoFinal.

Doc from javax.crypto.CipherSpi.engineDoFinal.

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this CipherSpi object was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, and any input bytes that may have been buffered during a previous update operation, are processed, with padding (if requested) being applied. If an AEAD mode (such as GCM or CCM) is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in a new buffer.

Upon finishing, this method resets this CipherSpi object to the state it was in when previously initialized via a call to engineInit. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to engineInit) more data.

Note

if any exception is thrown, this CipherSpi object may need to be reset before it can be used again.

Annotations

@Override

Exceptions

IllegalBlockSizeException:: if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided
BadPaddingException:: if this CipherSpi object is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes

engineDoFinal back to summary

engineDoFinal	back to summary
protected int engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException, IllegalBlockSizeException, BadPaddingException Implements abstract javax.crypto.CipherSpi.engineDoFinal. Doc from javax.crypto.CipherSpi.engineDoFinal. Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this `CipherSpi` object was initialized. The first `inputLen` bytes in the `input` buffer, starting at `inputOffset` inclusive, and any input bytes that may have been buffered during a previous `update` operation, are processed, with padding (if requested) being applied. If an AEAD mode such as GCM or CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in the `output` buffer, starting at `outputOffset` inclusive. If the `output` buffer is too small to hold the result, a `ShortBufferException` is thrown. Upon finishing, this method resets this `CipherSpi` object to the state it was in when previously initialized via a call to `engineInit`. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to `engineInit`) more data. Note if any exception is thrown, this `CipherSpi` object may need to be reset before it can be used again. Annotations @Override Exceptions ShortBufferException: if the given output buffer is too small to hold the result IllegalBlockSizeException: if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided BadPaddingException: if this `CipherSpi` object is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes

protected int engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException, IllegalBlockSizeException, BadPaddingException

Implements abstract javax.crypto.CipherSpi.engineDoFinal.

Doc from javax.crypto.CipherSpi.engineDoFinal.

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this CipherSpi object was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, and any input bytes that may have been buffered during a previous update operation, are processed, with padding (if requested) being applied. If an AEAD mode such as GCM or CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown.

Note

if any exception is thrown, this CipherSpi object may need to be reset before it can be used again.

Annotations

@Override

Exceptions

ShortBufferException:: if the given output buffer is too small to hold the result
IllegalBlockSizeException:: if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided
BadPaddingException:: if this CipherSpi object is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes

engineExportData	back to summary
protected byte[] engineExportData(byte[] context, int length)

engineExportKey	back to summary
protected SecretKey engineExportKey(String algorithm, byte[] context, int length)

engineGetBlockSize	back to summary
protected int engineGetBlockSize() Implements abstract javax.crypto.CipherSpi.engineGetBlockSize. Doc from javax.crypto.CipherSpi.engineGetBlockSize. Returns the block size (in bytes). Annotations @Override

engineGetBlockSize

back to summary

protected int engineGetBlockSize()

Implements abstract javax.crypto.CipherSpi.engineGetBlockSize.

Doc from javax.crypto.CipherSpi.engineGetBlockSize.

Returns the block size (in bytes).

Annotations

@Override

engineGetIV	back to summary
protected byte[] engineGetIV() Implements abstract javax.crypto.CipherSpi.engineGetIV. Doc from javax.crypto.CipherSpi.engineGetIV. Returns the initialization vector (IV) in a new buffer. This is useful in the context of password-based encryption or decryption, where the IV is derived from a user-provided passphrase. Annotations @Override

engineGetIV

back to summary

protected byte[] engineGetIV()

Implements abstract javax.crypto.CipherSpi.engineGetIV.

Doc from javax.crypto.CipherSpi.engineGetIV.

Returns the initialization vector (IV) in a new buffer.

This is useful in the context of password-based encryption or decryption, where the IV is derived from a user-provided passphrase.

Annotations

@Override

engineGetOutputSize back to summary

engineGetOutputSize	back to summary
protected int engineGetOutputSize(int inputLen) Implements abstract javax.crypto.CipherSpi.engineGetOutputSize. Doc from javax.crypto.CipherSpi.engineGetOutputSize. Returns the length in bytes that an output buffer would need to be in order to hold the result of the next `update` or `doFinal` operation, given the input length `inputLen` (in bytes). This call takes into account any unprocessed (buffered) data from a previous `update` call, padding, and AEAD tagging. The actual output length of the next `update` or `doFinal` call may be smaller than the length returned by this method. Annotations @Override

protected int engineGetOutputSize(int inputLen)

Implements abstract javax.crypto.CipherSpi.engineGetOutputSize.

Doc from javax.crypto.CipherSpi.engineGetOutputSize.

Returns the length in bytes that an output buffer would need to be in order to hold the result of the next update or doFinal operation, given the input length inputLen (in bytes).

This call takes into account any unprocessed (buffered) data from a previous update call, padding, and AEAD tagging.

The actual output length of the next update or doFinal call may be smaller than the length returned by this method.

Annotations

@Override

engineGetParameters back to summary

engineGetParameters	back to summary
protected AlgorithmParameters engineGetParameters() Implements abstract javax.crypto.CipherSpi.engineGetParameters. Doc from javax.crypto.CipherSpi.engineGetParameters. Returns the parameters used with this cipher. The returned parameters may be the same that were used to initialize this cipher, or may contain additional default or random parameter values used by the underlying cipher implementation. If the required parameters were not supplied and can be generated by the cipher, the generated parameters are returned. Otherwise, `null` is returned. Annotations @Override

protected AlgorithmParameters engineGetParameters()

Implements abstract javax.crypto.CipherSpi.engineGetParameters.

Doc from javax.crypto.CipherSpi.engineGetParameters.

Returns the parameters used with this cipher.

The returned parameters may be the same that were used to initialize this cipher, or may contain additional default or random parameter values used by the underlying cipher implementation. If the required parameters were not supplied and can be generated by the cipher, the generated parameters are returned. Otherwise, null is returned.

Annotations

@Override

engineInit back to summary

engineInit	back to summary
protected void engineInit(int opmode, Key key, SecureRandom random) throws InvalidKeyException Implements abstract javax.crypto.CipherSpi.engineInit. Doc from javax.crypto.CipherSpi.engineInit. Initializes this `CipherSpi` object with a key and a source of randomness. The `CipherSpi` object is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of `opmode`. If this cipher requires any algorithm parameters that cannot be derived from the given `key`, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an `InvalidKeyException` if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using `engineGetParameters` or `engineGetIV` (if the parameter is an IV). If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail. If this cipher (including its feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from `random`. Note that when a `CipherSpi` object is initialized, it loses all previously-acquired state. In other words, initializing a `CipherSpi` object is equivalent to creating a new instance of that `CipherSpi` object and initializing it. Annotations @Override Exceptions InvalidKeyException: if the given key is inappropriate for initializing this cipher, or requires algorithm parameters that cannot be determined from the given key

protected void engineInit(int opmode, Key key, SecureRandom random) throws InvalidKeyException

Implements abstract javax.crypto.CipherSpi.engineInit.

Doc from javax.crypto.CipherSpi.engineInit.

Initializes this CipherSpi object with a key and a source of randomness.

The CipherSpi object is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters that cannot be derived from the given key, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidKeyException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using engineGetParameters or engineGetIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Note that when a CipherSpi object is initialized, it loses all previously-acquired state. In other words, initializing a CipherSpi object is equivalent to creating a new instance of that CipherSpi object and initializing it.

Annotations

@Override

Exceptions

InvalidKeyException:: if the given key is inappropriate for initializing this cipher, or requires algorithm parameters that cannot be determined from the given key

engineInit back to summary

engineInit	back to summary
protected void engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException Implements abstract javax.crypto.CipherSpi.engineInit. Doc from javax.crypto.CipherSpi.engineInit. Initializes this `CipherSpi` object with a key, a set of algorithm parameters, and a source of randomness. The `CipherSpi` object is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of `opmode`. If this cipher requires any algorithm parameters and `params` is `null`, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an `InvalidAlgorithmParameterException` if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using `engineGetParameters` or `engineGetIV` (if the parameter is an IV). If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail. If this cipher (including its feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from `random`. Note that when a `CipherSpi` object is initialized, it loses all previously-acquired state. In other words, initializing a `CipherSpi` object is equivalent to creating a new instance of that `CipherSpi` object and initializing it. Annotations @Override Exceptions InvalidKeyException: if the given key is inappropriate for initializing this cipher InvalidAlgorithmParameterException: if the given algorithm parameters are inappropriate for this cipher, or if this cipher requires algorithm parameters and `params` is `null`

protected void engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException

Implements abstract javax.crypto.CipherSpi.engineInit.

Doc from javax.crypto.CipherSpi.engineInit.

Initializes this CipherSpi object with a key, a set of algorithm parameters, and a source of randomness.

The CipherSpi object is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters and params is null, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidAlgorithmParameterException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using engineGetParameters or engineGetIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Annotations

@Override

Exceptions

InvalidKeyException:: if the given key is inappropriate for initializing this cipher
InvalidAlgorithmParameterException:: if the given algorithm parameters are inappropriate for this cipher, or if this cipher requires algorithm parameters and params is null

engineInit back to summary

engineInit	back to summary
protected void engineInit(int opmode, Key key, AlgorithmParameters params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException Implements abstract javax.crypto.CipherSpi.engineInit. Doc from javax.crypto.CipherSpi.engineInit. Initializes this `CipherSpi` object with a key, a set of algorithm parameters, and a source of randomness. The `CipherSpi` object is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of `opmode`. If this cipher requires any algorithm parameters and `params` is `null`, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an `InvalidAlgorithmParameterException` if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using `engineGetParameters` or `engineGetIV` (if the parameter is an IV). If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail. If this cipher (including its feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from `random`. Note that when a `CipherSpi` object is initialized, it loses all previously-acquired state. In other words, initializing a `CipherSpi` object is equivalent to creating a new instance of that `CipherSpi` object and initializing it. Annotations @Override Exceptions InvalidKeyException: if the given key is inappropriate for initializing this cipher InvalidAlgorithmParameterException: if the given algorithm parameters are inappropriate for this cipher, or if this cipher requires algorithm parameters and `params` is null

protected void engineInit(int opmode, Key key, AlgorithmParameters params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException

Implements abstract javax.crypto.CipherSpi.engineInit.

Doc from javax.crypto.CipherSpi.engineInit.

Initializes this CipherSpi object with a key, a set of algorithm parameters, and a source of randomness.

The CipherSpi object is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Annotations

@Override

Exceptions

InvalidKeyException:: if the given key is inappropriate for initializing this cipher
InvalidAlgorithmParameterException:: if the given algorithm parameters are inappropriate for this cipher, or if this cipher requires algorithm parameters and params is null

engineSetMode	back to summary
protected void engineSetMode(String mode) throws NoSuchAlgorithmException Implements abstract javax.crypto.CipherSpi.engineSetMode. Doc from javax.crypto.CipherSpi.engineSetMode. Sets the mode of this cipher. Annotations @Override Exceptions NoSuchAlgorithmException: if the requested cipher mode does not exist

engineSetMode

back to summary

protected void engineSetMode(String mode) throws NoSuchAlgorithmException

Implements abstract javax.crypto.CipherSpi.engineSetMode.

Doc from javax.crypto.CipherSpi.engineSetMode.

Sets the mode of this cipher.

Annotations

@Override

Exceptions

NoSuchAlgorithmException:: if the requested cipher mode does not exist

engineSetPadding	back to summary
protected void engineSetPadding(String padding) throws NoSuchPaddingException Implements abstract javax.crypto.CipherSpi.engineSetPadding. Doc from javax.crypto.CipherSpi.engineSetPadding. Sets the padding mechanism of this cipher. Annotations @Override Exceptions NoSuchPaddingException: if the requested padding mechanism does not exist

engineSetPadding

back to summary

protected void engineSetPadding(String padding) throws NoSuchPaddingException

Implements abstract javax.crypto.CipherSpi.engineSetPadding.

Doc from javax.crypto.CipherSpi.engineSetPadding.

Sets the padding mechanism of this cipher.

Annotations

@Override

Exceptions

NoSuchPaddingException:: if the requested padding mechanism does not exist

engineUpdate back to summary

engineUpdate	back to summary
protected byte[] engineUpdate(byte[] input, int inputOffset, int inputLen) Implements abstract javax.crypto.CipherSpi.engineUpdate. Doc from javax.crypto.CipherSpi.engineUpdate. Continues a multiple-part encryption or decryption operation (depending on how this `CipherSpi` object was initialized), processing another data part. The first `inputLen` bytes in the `input` buffer, starting at `inputOffset` inclusive, are processed, and the result is stored in a new buffer. Annotations @Override

protected byte[] engineUpdate(byte[] input, int inputOffset, int inputLen)

Implements abstract javax.crypto.CipherSpi.engineUpdate.

Doc from javax.crypto.CipherSpi.engineUpdate.

Continues a multiple-part encryption or decryption operation (depending on how this CipherSpi object was initialized), processing another data part.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, are processed, and the result is stored in a new buffer.

Annotations

@Override

engineUpdate back to summary

engineUpdate	back to summary
protected int engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException Implements abstract javax.crypto.CipherSpi.engineUpdate. Doc from javax.crypto.CipherSpi.engineUpdate. Continues a multiple-part encryption or decryption operation (depending on how this `CipherSpi` object was initialized), processing another data part. The first `inputLen` bytes in the `input` buffer, starting at `inputOffset` inclusive, are processed, and the result is stored in the `output` buffer, starting at `outputOffset` inclusive. If the `output` buffer is too small to hold the result, a `ShortBufferException` is thrown. Annotations @Override Exceptions ShortBufferException: if the given output buffer is too small to hold the result

protected int engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException

Implements abstract javax.crypto.CipherSpi.engineUpdate.

Doc from javax.crypto.CipherSpi.engineUpdate.

Continues a multiple-part encryption or decryption operation (depending on how this CipherSpi object was initialized), processing another data part.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, are processed, and the result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown.

Annotations

@Override

Exceptions

ShortBufferException:: if the given output buffer is too small to hold the result

engineUpdateAAD back to summary

engineUpdateAAD	back to summary
protected void engineUpdateAAD(byte[] src, int offset, int len) Overrides javax.crypto.CipherSpi.engineUpdateAAD. Doc from javax.crypto.CipherSpi.engineUpdateAAD. Continues a multipart update of the Additional Authentication Data (AAD), using a subset of the provided buffer. Calls to this method provide AAD to the cipher when operating in modes such as AEAD (GCM or CCM). If this cipher is operating in either GCM or CCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the `update` and `doFinal` methods). Annotations @Override

protected void engineUpdateAAD(byte[] src, int offset, int len)

Overrides javax.crypto.CipherSpi.engineUpdateAAD.

Doc from javax.crypto.CipherSpi.engineUpdateAAD.

Continues a multipart update of the Additional Authentication Data (AAD), using a subset of the provided buffer.

Calls to this method provide AAD to the cipher when operating in modes such as AEAD (GCM or CCM). If this cipher is operating in either GCM or CCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the update and doFinal methods).

Annotations

@Override

engineUpdateAAD back to summary

engineUpdateAAD	back to summary
protected void engineUpdateAAD(ByteBuffer src) Overrides javax.crypto.CipherSpi.engineUpdateAAD. Doc from javax.crypto.CipherSpi.engineUpdateAAD. Continues a multipart update of the Additional Authentication Data (AAD). Calls to this method provide AAD to the cipher when operating in modes such as AEAD (GCM or CCM). If this cipher is operating in either GCM or CCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the `update` and `doFinal` methods). All `src.remaining()` bytes starting at `src.position()` are processed. Upon return, the input buffer's position will be equal to its limit; its limit will not have changed. Annotations @Override

protected void engineUpdateAAD(ByteBuffer src)

Overrides javax.crypto.CipherSpi.engineUpdateAAD.

Doc from javax.crypto.CipherSpi.engineUpdateAAD.

Continues a multipart update of the Additional Authentication Data (AAD).

All src.remaining() bytes starting at src.position() are processed. Upon return, the input buffer's position will be equal to its limit; its limit will not have changed.

Annotations

@Override

maybeReinitInternalCipher	back to summary
private void maybeReinitInternalCipher()

usePSK	back to summary
private static boolean usePSK(SecretKey psk)

com.sun.crypto.provider back to summary

private Class HPKE.AEAD

Class Inheritance

extends Object

java.lang.Object
com.sun.crypto.provider.HPKE.AEAD

Field Summary

Modifier and Type	Field and Description
pack-priv final Cipher	cipher
pack-priv final int	id
pack-priv final int	nk
pack-priv final int	nn
pack-priv final int	nt

Constructor Summary

Access	Constructor and Description
public	AEAD(int id)

Method Summary

Modifier and Type	Method and Description
pack-priv void	start(int opmode, SecretKey key, byte[] nonce)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cipher	back to summary
pack-priv final Cipher cipher

id	back to summary
pack-priv final int id

nk	back to summary
pack-priv final int nk

nn	back to summary
pack-priv final int nn

nt	back to summary
pack-priv final int nt

Constructor Detail

AEAD	back to summary
public AEAD(int id) throws InvalidAlgorithmParameterException

Method Detail

start	back to summary
pack-priv void start(int opmode, SecretKey key, byte[] nonce)

com.sun.crypto.provider back to summary

private Class HPKE.Impl

Class Inheritance

extends Object

java.lang.Object
com.sun.crypto.provider.HPKE.Impl

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	HPKE.Impl.Context

Field Summary

Modifier and Type	Field and Description
pack-priv HPKE.AEAD	aead
pack-priv HPKE.Impl.Context	context
pack-priv String	kdfAlg
pack-priv int	kdfNh
pack-priv byte[]	kemEncaps
pack-priv final int	opmode
pack-priv HPKEParameterSpec	params
pack-priv byte[]	suite_id

Constructor Summary

Access	Constructor and Description
public	Impl(int opmode)

Method Summary

Modifier and Type	Method and Description
private static void	checkMatch(boolean inSpec, AsymmetricKey k, int kem_id)
public boolean	hasEncrypt()
public void	init(AsymmetricKey key, HPKEParameterSpec p, SecureRandom rand)
private KEM	kem()
private HPKE.Impl.Context	keySchedule(int mode, SecretKey shared_secret, byte[] info, SecretKey psk, byte[] psk_id)
private void	setParams(HPKEParameterSpec p)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

aead	back to summary
pack-priv HPKE.AEAD aead

context	back to summary
pack-priv HPKE.Impl.Context context

kdfAlg	back to summary
pack-priv String kdfAlg

kdfNh	back to summary
pack-priv int kdfNh

kemEncaps	back to summary
pack-priv byte[] kemEncaps

opmode	back to summary
pack-priv final int opmode

params	back to summary
pack-priv HPKEParameterSpec params

suite_id	back to summary
pack-priv byte[] suite_id

Constructor Detail

Impl	back to summary
public Impl(int opmode)

Method Detail

checkMatch	back to summary
private static void checkMatch(boolean inSpec, AsymmetricKey k, int kem_id) throws InvalidKeyException, InvalidAlgorithmParameterException

hasEncrypt	back to summary
public boolean hasEncrypt()

init	back to summary
public void init(AsymmetricKey key, HPKEParameterSpec p, SecureRandom rand) throws InvalidKeyException, InvalidAlgorithmParameterException

kem	back to summary
private KEM kem()

keySchedule	back to summary
private HPKE.Impl.Context keySchedule(int mode, SecretKey shared_secret, byte[] info, SecretKey psk, byte[] psk_id)

setParams	back to summary
private void setParams(HPKEParameterSpec p) throws InvalidAlgorithmParameterException

com.sun.crypto.provider back to summary

pack-priv Class HPKE.Impl.Context

Class Inheritance

extends Object

java.lang.Object
com.sun.crypto.provider.HPKE.Impl.Context

Field Summary

Modifier and Type	Field and Description
pack-priv final byte[]	base_nonce
pack-priv final SecretKey	exporter_secret
pack-priv final SecretKey	k
pack-priv byte[]	seq

Constructor Summary

Access	Constructor and Description
public	Context(SecretKey sk, byte[] base_nonce, SecretKey exporter_secret)

Method Summary

Modifier and Type	Method and Description
private byte[]	computeNonce()
pack-priv byte[]	exportData(byte[] exporter_context, int length)
pack-priv SecretKey	exportKey(String algorithm, byte[] exporter_context, int length)
private void	IncrementSeq()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

base_nonce	back to summary
pack-priv final byte[] base_nonce

exporter_secret	back to summary
pack-priv final SecretKey exporter_secret

k	back to summary
pack-priv final SecretKey k

seq	back to summary
pack-priv byte[] seq

Constructor Detail

Context	back to summary
public Context(SecretKey sk, byte[] base_nonce, SecretKey exporter_secret)

Method Detail

computeNonce	back to summary
private byte[] computeNonce()

exportData	back to summary
pack-priv byte[] exportData(byte[] exporter_context, int length)

exportKey	back to summary
pack-priv SecretKey exportKey(String algorithm, byte[] exporter_context, int length)

IncrementSeq	back to summary
private void IncrementSeq()

public Class HPKE

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HPKE.AEAD

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HPKE.Impl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class HPKE.Impl.Context

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail