Struct SignDataRequest

pub struct SignDataRequest {
    pub mount: String,
    pub name: String,
    pub key_version: Option<u64>,
    pub hash_algorithm: Option<HashAlgorithm>,
    pub input: String,
    pub context: Option<String>,
    pub prehashed: Option<bool>,
    pub signature_algorithm: Option<SignatureAlgorithm>,
    pub marshaling_algorithm: Option<MarshalingAlgorithm>,
}

Sign Data

This endpoint returns the cryptographic signature of the given data using the named key and the specified hash algorithm. The key must be of a type that supports signing.

• Path: {self.mount}/sign/{self.name}(/{self.hash_algorithm)
• Method: POST
• Response: SignDataResponse
• Reference: https://developer.hashicorp.com/vault/api-docs/secret/transit#sign-data

Fields

mount: String

name: String

key_version: Option<u64>

Specifies the version of the key to use for the operation. If not set, uses the latest version. Must be greater than or equal to the key’s min_encryption_version, if set.

hash_algorithm: Option<HashAlgorithm>

Specifies the hash algorithm to use.

input: String

Specifies the base64 encoded input data.

context: Option<String>

Base64 encoded context for key derivation. Required if key derivation is enabled; currently only available with ed25519 keys.

prehashed: Option<bool>

Set to true when the input is already hashed. If the key type is rsa-2048, rsa-3072 or rsa-4096, then the algorithm used to hash the input should be indicated by the hash_algorithm parameter. Just as the value to sign should be the base64-encoded representation of the exact binary data you want signed, when set, input is expected to be base64-encoded binary hashed data, not hex-formatted.

signature_algorithm: Option<SignatureAlgorithm>

When using a RSA key, specifies the RSA signature algorithm to use for signing.

marshaling_algorithm: Option<MarshalingAlgorithm>

Specifies the way in which the signature should be marshaled. This currently only applies to ECDSA keys.

Implementations

impl SignDataRequest

pub fn builder() -> SignDataRequestBuilder

Trait Implementations

impl Debug for SignDataRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SignDataRequest

fn default() -> SignDataRequest

Returns the “default value” for a type.

impl Endpoint for SignDataRequest

const REQUEST_BODY_TYPE: RequestType = RequestType::JSON

The content type of the request body

const RESPONSE_BODY_TYPE: ResponseType = ResponseType::JSON

The content type of the response body

type Response = SignDataResponse

The type that the raw response from executing this endpoint will deserialized into. This type is passed on to the EndpointResult and is used to determine the type returned when the parse() method is called.

fn path(&self) -> String

The relative URL path that represents the location of this Endpoint. This is combined with the base URL from a Client instance to create the fully qualified URL.

fn method(&self) -> RequestMethod

The HTTP method to be used when executing this Endpoint.

fn body(&self) -> Result<Option<Vec<u8>>, ClientError>

Optional data to add to the body of the request.

fn query(&self) -> Result<Option<String>, ClientError>

Optional query parameters to add to the request.

fn url(&self, base: &str) -> Result<Uri, ClientError>

Returns the full URL address of the endpoint using the base address.

fn request(&self, base: &str) -> Result<Request<Vec<u8>>, ClientError>

Returns a Request containing all data necessary to execute against this endpoint.

fn exec<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 (impl Client + 'async_trait), ) -> Pin<Box<dyn Future<Output = Result<EndpointResult<Self::Response>, ClientError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Executes the Endpoint using the given Client.

fn with_middleware<M>(self, middleware: &M) -> MutatedEndpoint<'_, Self, M>

where M: MiddleWare,