Package org.springframework.vault.support

Class VaultSignRequest.VaultSignRequestBuilder

java.lang.Object

org.springframework.vault.support.VaultSignRequest.VaultSignRequestBuilder

Enclosing class:

VaultSignRequest

public static class VaultSignRequest.VaultSignRequestBuilder
extends Object

Builder to build a VaultSignRequest.

Constructor Summary

Constructors

Constructor	Description
VaultSignRequestBuilder()

Method Summary

Modifier and Type	Method	Description
VaultSignRequest.VaultSignRequestBuilder	algorithm(String algorithm)	Deprecated. since 2.4, use signatureAlgorithm(String) instead.
VaultSignRequest	build()	Build a new VaultSignRequest instance.
VaultSignRequest.VaultSignRequestBuilder	hashAlgorithm(String hashAlgorithm)	Configure the hash algorithm to be used for the operation.
VaultSignRequest.VaultSignRequestBuilder	plaintext(Plaintext input)	Configure the input to be used to create the signature.
VaultSignRequest.VaultSignRequestBuilder	prehashed(boolean prehashed)	Set to true when the input is already hashed.
VaultSignRequest.VaultSignRequestBuilder	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

VaultSignRequestBuilder

public VaultSignRequestBuilder()

Method Details

plaintext

public VaultSignRequest.VaultSignRequestBuilder plaintext(Plaintext input)

Configure the input to be used to create the signature.

Parameters:

input - base input to create the signature, must not be null.

Returns:

this builder.

hashAlgorithm

public VaultSignRequest.VaultSignRequestBuilder 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 builder.

prehashed

public VaultSignRequest.VaultSignRequestBuilder 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 builder.

Since:

3.1

signatureAlgorithm

public VaultSignRequest.VaultSignRequestBuilder 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 builder.

algorithm

@Deprecated(since="2.4")
public VaultSignRequest.VaultSignRequestBuilder 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 VaultSignRequest.VaultSignRequestBuilder.

build

public VaultSignRequest build()

Build a new VaultSignRequest instance. Requires plaintext(Plaintext) to be configured.

Returns:

a new VaultSignRequest.