aws_signature_v4 library

HTTP request signer for AWS (Version 4).

Classes

AWSAlgorithm
Defines the interface for an algorithm used in signing.
AWSCredentials
A set of credentials used for accessing AWS services.
AWSCredentialScope
The scope for an AWS request.
AWSCredentialsProvider
A utility for retrieving AWS credentials at runtime.
AWSCredentialsProviderChain
Attempts to load AWS credentials from a chain of credentials providers, in order.
AWSDateTime
A utility class which wraps DateTime objects.
AWSSignedRequest
A signed AWSStreamedHttpRequest.
AWSSigV4Signer
The main class for signing requests made to AWS services.
BaseServiceConfiguration
The base service configuration for AWS services.
CanonicalHeaders
A map of canonicalized headers.
CanonicalPath
Helper methods for canonicalizing paths of a CanonicalRequest.
CanonicalQueryParameters
A map of canonicalized query parameters.
CanonicalRequest
A canonicalized request, used for signing via the SigV4 signing process.
DartEnvironmentCredentialsProvider
Creates an AWSCredentialsProvider for credentials injected via the Dart environment.
DefaultCredentialsProviderChain
Uses the default chain to try loading credentials from the following sources, in order:
EnvironmentCredentialsProvider
Creates an AWSCredentialsProvider for credentials injected via the platform-specific environment.
ProfileCredentialsProvider
Creates an AWSCredentialsProvider for credentials from an AWS shared credentials file.
S3ServiceConfiguration
The base service configuration for AWS S3 requests.
ServiceConfiguration
A description of an AWSSigV4Signer configuration.
SignedHeaders
The signed headers for a canonical request.
StaticCredentialsProvider
Creates an AWSCredentialsProvider for a set of static, compile-time AWS credentials.

Enums

S3PayloadEncoding
Payload encoding for S3 requests.

Constants

emptyPayloadHash → const String
The SHA-256/Hex-encoded hash for empty requests.
payloadEncoder → const _CanonicalPayloadEncoder
Hashes payload bytes using SHA-256 and encodes using hex.
zAccessKeyId → const String
The AWS_ACCESS_KEY_ID identifier, used for locating credentials in the environment.
zSecretAccessKey → const String
The AWS_SECRET_ACCESS_KEY identifier, used for locating credentials in the environment.
zSessionToken → const String
The AWS_SESSION_TOKEN identifier, used for locating credentials in the environment.
zSigningTest → const Symbol
Zone value flag for signer tests, used to determine behavior of header inclusion on Web, for example.

Functions

signZoned<R>(R signFn()) → R
Runs the given sign function in a Zone where print only works in debug mode in order to prevent accidental exposure of secrets.

Exceptions / Errors

InvalidCredentialsException
Exception thrown when AWS credentials are either unavailable or invalid.