Struct SigV4Authenticator 

pub struct SigV4Authenticator { /* private fields */ }

Available on crate feature unstable only.

Low-level structure for performing AWS SigV4 authentication after a canonical request has been generated.

Implementations

impl SigV4Authenticator

pub fn builder() -> SigV4AuthenticatorBuilder

Create a builder for SigV4Authenticator.

pub fn canonical_request_sha256(&self) -> [u8; 32]

Retrieve the SHA-256 hash of the canonical request.

pub fn credential(&self) -> &str

Retrieve the credential passed into the request, in the form of keyid/date/region/service/aws4_request.

pub fn session_token(&self) -> Option<&str>

Retrieve the optional session token.

pub fn signature(&self) -> &str

Retrieve the signature passed into the request.

pub fn request_timestamp(&self) -> DateTime<Utc>

Retrieve the timestamp of the request.

pub fn prevalidate( &self, region: &str, service: &str, server_timestamp: DateTime<Utc>, allowed_mismatch: Duration, ) -> Result<(), SignatureError>

Verify the request parameters make sense for the region, service, and specified timestamp. This must be called successfully before calling validate_signature.

pub async fn get_signing_key<S, F>( &self, region: &str, service: &str, get_signing_key: &mut S, ) -> Result<GetSigningKeyResponse, SignatureError>

where S: Service<GetSigningKeyRequest, Response = GetSigningKeyResponse, Error = BoxError, Future = F> + Send, F: Future<Output = Result<GetSigningKeyResponse, BoxError>> + Send,

Return the signing key (kSigning from the AWS documentation) for the request.

pub fn get_string_to_sign(&self) -> Vec<u8>

Return the string to sign for the request.

pub async fn validate_signature<S, F>( &self, region: &str, service: &str, server_timestamp: DateTime<Utc>, allowed_mismatch: Duration, get_signing_key: &mut S, ) -> Result<SigV4AuthenticatorResponse, SignatureError>

where S: Service<GetSigningKeyRequest, Response = GetSigningKeyResponse, Error = BoxError, Future = F> + Send, F: Future<Output = Result<GetSigningKeyResponse, BoxError>> + Send,

Validate the request signature.

Trait Implementations

impl Clone for SigV4Authenticator

fn clone(&self) -> SigV4Authenticator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SigV4Authenticator

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

Formats the value using the given formatter.

impl Default for SigV4Authenticator

fn default() -> SigV4Authenticator

Returns the “default value” for a type.