Added in API level 37

Summary: Nested Classes | Methods | Inherited Methods

Sender

Kotlin |Java

public class Sender
extends Object

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

A class for sending HPKE messages.

Summary

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

Public methods
`byte[]`	`export(int length, byte[] context)` Exports secret key material from this Sender as described in RFC 9180.
`byte[]`	`getEncapsulated()` Returns the encapsulated ephemeral key created for this Sender.
`Provider`	`getProvider()` Returns the `Provider` being used by this Sender.
`HpkeSpi`	`getSpi()` Returns the `HpkeSpi` being used by this Sender.
`byte[]`	`seal(byte[] plaintext, byte[] aad)` Seals a message, using the internal key schedule maintained by this Sender.

Inherited methods

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 methods

export

Added in API level 37

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

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

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

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

Throws
`IllegalArgumentException`	if the length is not valid for the Sender's KDF

getEncapsulated

Added in API level 37

public byte[] getEncapsulated ()

Returns the encapsulated ephemeral key created for this Sender.

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

getProvider

Added in API level 37

public Provider getProvider ()

Returns the Provider being used by this Sender.

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

getSpi

Added in API level 37

public HpkeSpi getSpi ()

Returns the HpkeSpi being used by this Sender.

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

seal

Added in API level 37

public byte[] seal (byte[] plaintext, 
                byte[] aad)

Seals a message, using the internal key schedule maintained by this Sender.

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

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

See also:

Opening and sealing

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Sender

Summary

Nested classes

Public methods

Inherited methods

Public methods

export

getEncapsulated

getProvider

getSpi

seal

More Android

Discover

Android Devices

Releases

Documentation and Downloads

Support