Package org.forgerock.secrets.keys

Class VerificationKey

java.lang.Object

org.forgerock.secrets.Secret

org.forgerock.secrets.keys.CryptoKey

org.forgerock.secrets.keys.VerificationKey

public class VerificationKey
extends CryptoKey

A key used for verifying digital signatures.

Constructor Summary

Constructors

Constructor	Description
VerificationKey(SecretBuilder builder)	Initialises the key with the given secret data.

Method Summary

Modifier and Type	Method	Description
Signature	getSignature()	Returns a signature object initialised for verification using a default algorithm for this key type.
Signature	getSignature(String algorithm)	Returns a signature object initialised for verification.

Methods inherited from class org.forgerock.secrets.keys.CryptoKey

allowsAlgorithm, export, getCertificate, getCertificate, getCertificateChain, getCertificateChain, getKeyAlgorithm, getKeyType, getKeyUsages, getPublicKey, getPublicKey, isExtractable, reveal, toBuilder, toString

Methods inherited from class org.forgerock.secrets.Secret

equals, getExpiryTime, getStableId, hashCode, isExpired

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VerificationKey

public VerificationKey(SecretBuilder builder)
                throws NoSuchSecretException

Initialises the key with the given secret data.

Parameters:

builder - the builder object.

Throws:

NoSuchSecretException - if the secret could not be constructed from the builder.

Method Details

getSignature

public Signature getSignature(String algorithm)

Returns a signature object initialised for verification.

Parameters:

algorithm - the signature algorithm.

Returns:

the signature object.

getSignature

public Signature getSignature()

Returns a signature object initialised for verification using a default algorithm for this key type.

Returns:

the signature object.