Summary: Nested Classes | Methods | Inherited Methods

Recipient

Kotlin |Java

public class Recipient
extends Object

java.lang.Object
↳	android.crypto.hpke.Recipient

A class for receiving HPKE messages.

Summary

Nested classes
`class`	`Recipient.Builder` A builder for HPKE Recipient objects.

Public methods
`byte[]`	`export(int length, byte[] context)` Exports secret key material from this Recipient as described in RFC 9180.
`Provider`	`getProvider()` Returns the `Provider` being used by this Recipient.
`HpkeSpi`	`getSpi()` Returns the `HpkeSpi` being used by this Recipient.
`byte[]`	`open(byte[] ciphertext, byte[] aad)` Opens a message, using the internal key schedule maintained by this Recipient.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

public byte[] export (int length, 
                byte[] context)

Exports secret key material from this Recipient as described in RFC 9180.

Parameters
`length`	`int`: expected output length
`context`	`byte`: optional exporter context string, may be null or empty

Returns
`byte[]`	exported value. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the length is not valid for the KDF in use

public Provider getProvider ()

Returns the Provider being used by this Recipient.

Returns
`Provider`	the Provider. This value cannot be `null`.

public HpkeSpi getSpi ()

Returns the HpkeSpi being used by this Recipient.

Returns
`HpkeSpi`	the SPI. This value cannot be `null`.

public byte[] open (byte[] ciphertext, 
                byte[] aad)

Opens a message, using the internal key schedule maintained by this Recipient.

Parameters
`ciphertext`	`byte`: the ciphertext. This value cannot be `null`.
`aad`	`byte`: optional additional authenticated data, may be null or empty

Returns
`byte[]`	the plaintext. This value cannot be `null`.

Throws
`GeneralSecurityException`	on decryption failures

See also: