com.google.crypto.tink.signature

Class Ed25519PublicKey

java.lang.Object

com.google.crypto.tink.Key

com.google.crypto.tink.signature.SignaturePublicKey

com.google.crypto.tink.signature.Ed25519PublicKey

@Alpha
 @Immutable
public final class Ed25519PublicKey
extends SignaturePublicKey

Ed25519PublicKey represents the public portion of the Ed25519 signature primitive.

This API is annotated with Alpha because it is not yet stable and might be changed in the future.

Method Summary

Modifier and Type	Method and Description
static Ed25519PublicKey	create(Bytes publicKeyBytes)
static Ed25519PublicKey	create(Ed25519Parameters.Variant variant, Bytes publicKeyBytes, Integer idRequirement)
boolean	equalsKey(Key o) Returns true if the key is equal to the passed in key.
Integer	getIdRequirementOrNull() Returns null if this key has no id requirement, otherwise the required id.
Bytes	getOutputPrefix() Returns a Bytes instance which is prefixed to every signature.
Ed25519Parameters	getParameters() Returns the parameters of this key.
Bytes	getPublicKeyBytes()

Methods inherited from class java.lang.Object

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

Method Detail

getOutputPrefix

public Bytes getOutputPrefix()

Description copied from class: SignaturePublicKey

Returns a Bytes instance which is prefixed to every signature.

Specified by:

getOutputPrefix in class SignaturePublicKey

create

public static Ed25519PublicKey create(Bytes publicKeyBytes)
                               throws GeneralSecurityException

Throws:

GeneralSecurityException

create

public static Ed25519PublicKey create(Ed25519Parameters.Variant variant,
                                      Bytes publicKeyBytes,
                                      @Nullable
                                      Integer idRequirement)
                               throws GeneralSecurityException

Throws:

GeneralSecurityException

getPublicKeyBytes

public Bytes getPublicKeyBytes()

getParameters

public Ed25519Parameters getParameters()

Description copied from class: SignaturePublicKey

Returns the parameters of this key.

Specified by:

getParameters in class SignaturePublicKey

getIdRequirementOrNull

@Nullable
public Integer getIdRequirementOrNull()

Description copied from class: Key

Returns null if this key has no id requirement, otherwise the required id.

Some keys, when they are in a keyset, are required to have a certain ID to work properly. This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the string 0x01<id>, where the ID is encoded in big endian (see the documentation of the key type for details), in which case the key requires a certain ID.

Specified by:

getIdRequirementOrNull in class Key

equalsKey

public boolean equalsKey(Key o)

Description copied from class: Key

Returns true if the key is equal to the passed in key.

Implementations are required to do this in constant time.

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