Struct gotham_middleware_aws_sig_verify::AWSSigV4

pub struct AWSSigV4 {}

Re-export aws_sig_verify so users don't have to compute versions. The implementation of the standard AWS SigV4 algorithm.

Implementations

impl AWSSigV4

Re-export aws_sig_verify so users don't have to compute versions.

pub fn new() -> AWSSigV4

pub fn verify(
    &self,
    req: &Request,
    signing_key_kind: SigningKeyKind,
    signing_key_fn: fn(SigningKeyKind, &str, Option<&str>, Option<&str>, Option<&str>, Option<&str>) -> Result<(Principal, Vec<u8>), SignatureError>,
    allowed_mismatch: Option<Duration>
) -> Result<Principal, SignatureError>

Verify that the request timestamp is not beyond the allowed timestamp mismatch and that the request signature matches our expected signature.

Trait Implementations

impl AWSSigV4Algorithm for AWSSigV4

fn get_canonical_uri_path(
    &self,
    req: &Request
) -> Result<String, SignatureError>

The canonicalized URI path for a request.

fn get_canonical_query_string(
    &self,
    req: &Request
) -> Result<String, SignatureError>

The canonical query string from the query parameters.

fn get_authorization_header_parameters(
    &self,
    req: &Request
) -> Result<HashMap<String, String, RandomState>, SignatureError>

The parameters from the Authorization header (only -- not the query parameter). If the Authorization header is not present or is not an AWS SigV4 header, an Err(SignatureError) is returned.

fn get_signed_headers(
    &self,
    req: &Request
) -> Result<BTreeMap<String, Vec<Vec<u8>>>, SignatureError>

Returns a sorted dictionary containing the signed header names and their values.

fn get_request_timestamp(
    &self,
    req: &Request
) -> Result<DateTime<Utc>, SignatureError>

The timestamp of the request.

fn get_credential_scope(&self, req: &Request) -> Result<String, SignatureError>

The scope of the credentials to use, as calculated by the service's region and name, but using the timestamp of the request.

fn get_access_key(&self, req: &Request) -> Result<String, SignatureError>

The access key used to sign the request.

fn get_session_token(
    &self,
    req: &Request
) -> Result<Option<String>, SignatureError>

The session token sent with the access key.

fn get_request_signature(&self, req: &Request) -> Result<String, SignatureError>

The signature passed into the request.

fn get_canonical_request(
    &self,
    req: &Request
) -> Result<Vec<u8>, SignatureError>

The AWS SigV4 canonical request given parameters from the HTTP request, as outlined in the AWS documentation.

fn get_body_digest(&self, req: &Request) -> Result<String, SignatureError>

The SHA-256 hex digest of the body.

fn get_string_to_sign(&self, req: &Request) -> Result<Vec<u8>, SignatureError>

The string to sign for the request.

fn get_expected_signature(
    &self,
    req: &Request,
    signing_key_kind: SigningKeyKind,
    signing_key_fn: fn(SigningKeyKind, &str, Option<&str>, Option<&str>, Option<&str>, Option<&str>) -> Result<(Principal, Vec<u8>), SignatureError>
) -> Result<(Principal, String), SignatureError>

The principal and expected signature for the request.

fn verify_at(
    &self,
    req: &Request,
    signing_key_kind: SigningKeyKind,
    signing_key_fn: fn(SigningKeyKind, &str, Option<&str>, Option<&str>, Option<&str>, Option<&str>) -> Result<(Principal, Vec<u8>), SignatureError>,
    server_timestamp: &DateTime<Utc>,
    allowed_mismatch: Option<Duration>
) -> Result<Principal, SignatureError>

Verify that the request timestamp is not beyond the allowed timestamp mismatch and that the request signature matches our expected signature.

fn verify(
    &self,
    req: &Request,
    signing_key_kind: SigningKeyKind,
    signing_key_fn: fn(SigningKeyKind, &str, Option<&str>, Option<&str>, Option<&str>, Option<&str>) -> Result<(Principal, Vec<u8>), SignatureError>,
    allowed_mismatch: Option<Duration>
) -> Result<Principal, SignatureError>

Verify that the request timestamp is not beyond the allowed timestamp mismatch and that the request signature matches our expected signature.

impl Clone for AWSSigV4

fn clone(&self) -> AWSSigV4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for AWSSigV4

impl Debug for AWSSigV4

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

Formats the value using the given formatter.