Package com.google.crypto.tink.hybrid

Class HpkePrivateKey

java.lang.Object

com.google.crypto.tink.Key

com.google.crypto.tink.hybrid.HybridPrivateKey

com.google.crypto.tink.hybrid.HpkePrivateKey

All Implemented Interfaces:

PrivateKey

@Immutable
public final class HpkePrivateKey
extends HybridPrivateKey

Representation of the decryption function for an HPKE hybrid encryption primitive.

Method Summary

Modifier and Type	Method	Description
static HpkePrivateKey	create(HpkePublicKey publicKey, SecretBytes privateKeyBytes)	Creates a new HPKE private key.
boolean	equalsKey(Key o)	Returns true if the key is guaranteed to be equal to other.
HpkeParameters	getParameters()	Returns a Parameters object containing all the information about the key which is not randomly chosen.
SecretBytes	getPrivateKeyBytes()
HpkePublicKey	getPublicKey()

Methods inherited from class com.google.crypto.tink.hybrid.HybridPrivateKey

getIdRequirementOrNull, getOutputPrefix

Methods inherited from class java.lang.Object

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

Method Detail

create

public static HpkePrivateKey create(HpkePublicKey publicKey,
                                    SecretBytes privateKeyBytes)
                             throws java.security.GeneralSecurityException

Creates a new HPKE private key.

Parameters:

publicKey - Corresponding HPKE public key for this private key

privateKeyBytes - Private key encoded according to https://www.rfc-editor.org/rfc/rfc9180.html#section-7.1.2

Throws:

java.security.GeneralSecurityException

getPrivateKeyBytes

public SecretBytes getPrivateKeyBytes()

getParameters

public HpkeParameters 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.

Overrides:

getParameters in class HybridPrivateKey

getPublicKey

public HpkePublicKey getPublicKey()

Specified by:

getPublicKey in interface PrivateKey

Specified by:

getPublicKey in class HybridPrivateKey

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