Package org.springframework.vault.support

Class VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder

java.lang.Object

org.springframework.vault.support.VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder

Enclosing class:

VaultSignatureVerificationRequest

public static class VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder
extends Object

Builder to build a VaultSignatureVerificationRequest.

Constructor Summary

Constructors

Constructor	Description
VaultSignatureVerificationRequestBuilder()

Method Summary

Modifier and Type	Method	Description
VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder	algorithm(String algorithm)	Deprecated. since 2.4, use signatureAlgorithm(String) instead.
VaultSignatureVerificationRequest	build()	Build a new VaultSignatureVerificationRequest instance.
VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder	hashAlgorithm(String hashAlgorithm)	Configure the hash algorithm to be used for the operation.
VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder	hmac(Hmac hmac)	Configure the Hmac to be verified.
VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder	plaintext(Plaintext input)	Configure the Plaintext input to be used to verify the signature.
VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder	prehashed(boolean prehashed)	Set to true when the input is already hashed.
VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder	signature(Signature signature)	Configure the Signature to be verified.
VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder	signatureAlgorithm(String signatureAlgorithm)	Configure the signature algorithm to be used for the operation when using an RSA key.

Methods inherited from class java.lang.Object

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

Constructor Details

VaultSignatureVerificationRequestBuilder

public VaultSignatureVerificationRequestBuilder()

Method Details

plaintext

public VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder plaintext(Plaintext input)

Configure the Plaintext input to be used to verify the signature.

Parameters:

input - base input, must not be null.

Returns:

this VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder.

signature

public VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder signature(Signature signature)

Configure the Signature to be verified. Signature verification requires either a Signature or a hmac(Hmac) to be configured. Clears any previously configured hmac(Hmac).

Parameters:

signature - to be verified, must not be null.

Returns:

this VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder.

hmac

public VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder hmac(Hmac hmac)

Configure the Hmac to be verified. Signature verification requires either a Hmac or a signature(Signature) to be configured. Clears any previously configured Signature.

Parameters:

hmac - to be verified, must not be null.

Returns:

this VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder.

hashAlgorithm

public VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder hashAlgorithm(String hashAlgorithm)

Configure the hash algorithm to be used for the operation.

Parameters:

hashAlgorithm - Specify the hash algorithm to be used for the operation. Supported algorithms are: sha1, sha2-224, sha2-256, sha2-384, sha2-512. Defaults to sha2-256 if not set.

Returns:

this VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder.

Since:

2.4

prehashed

public VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder prehashed(boolean prehashed)

Set to true when the input is already hashed. If the key type is rsa-2048, rsa-3072, or rsa-4096 then specify the algorithm used to hash the input through hashAlgorithm(String).

Parameters:

prehashed - whether the input is already hashed.

Returns:

this VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder.

Since:

3.1

signatureAlgorithm

public VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder signatureAlgorithm(String signatureAlgorithm)

Configure the signature algorithm to be used for the operation when using an RSA key.

Parameters:

signatureAlgorithm - Specify the signature algorithm to be used for the operation. Supported algorithms are: pss, pkcs1v15. Defaults to pss if not set.

Returns:

this VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder.

Since:

2.4

algorithm

@Deprecated(since="2.4")
public VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder algorithm(String algorithm)

Deprecated.

since 2.4, use signatureAlgorithm(String) instead.

Configure the algorithm to be used for the operation.

Parameters:

algorithm - Specify the algorithm to be used for the operation. Supported algorithms are: sha2-224, sha2-256, sha2-384, sha2-512. Defaults to sha2-256 if not set.

Returns:

this VaultSignatureVerificationRequest.VaultSignatureVerificationRequestBuilder.

build

public VaultSignatureVerificationRequest build()

Build a new VaultSignatureVerificationRequest instance. Requires plaintext(Plaintext) and one of hmac(Hmac), signature(Signature) to be configured.

Returns:

a new VaultHmacRequest.