com.google.crypto.tink.streamingaead

Class AesGcmHkdfStreamingKey

java.lang.Object

com.google.crypto.tink.Key

com.google.crypto.tink.streamingaead.StreamingAeadKey

com.google.crypto.tink.streamingaead.AesGcmHkdfStreamingKey

public final class AesGcmHkdfStreamingKey
extends StreamingAeadKey

Represents a StreamingAead functions.

See https://developers.google.com/tink/streaming-aead/aes_gcm_hkdf_streaming.

Method Summary

Modifier and Type	Method and Description
static AesGcmHkdfStreamingKey	create(AesGcmHkdfStreamingParameters parameters, SecretBytes initialKeymaterial)
boolean	equalsKey(Key o) Returns true if the key is guaranteed to be equal to other.
SecretBytes	getInitialKeyMaterial()
AesGcmHkdfStreamingParameters	getParameters() Returns a Parameters object containing all the information about the key which is not randomly chosen.

Methods inherited from class com.google.crypto.tink.streamingaead.StreamingAeadKey

getIdRequirementOrNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static AesGcmHkdfStreamingKey create(AesGcmHkdfStreamingParameters parameters,
                                            SecretBytes initialKeymaterial)
                                     throws GeneralSecurityException

Throws:

GeneralSecurityException

getInitialKeyMaterial

public SecretBytes getInitialKeyMaterial()

getParameters

public AesGcmHkdfStreamingParameters getParameters()

Description copied from class: Key

Returns a Parameters object containing all the information about the key which is not randomly chosen.

Implementations need to ensure that getParameters().hasIdRequirement() returns true if and only if getIdRequirementOrNull is non-null.

Specified by:

getParameters in class StreamingAeadKey

equalsKey

public boolean equalsKey(Key o)

Description copied from class: Key

Returns true if the key is guaranteed to be equal to other.

Implementations are required to do this in constant time.

Note: this is allowed to return false even if two keys are guaranteed to represent the same function, but are represented differently. For example, a key is allowed to internally store the number of zero-bytes used as padding when a large number is represented as a byte array, and use this in the comparison.

Note: Tink Key objects should typically not override hashCode (because it could risk leaking key material). Hence, they typically also should not override equals.

Specified by:

equalsKey in class Key