SigV4 Request Generator

View Licence Agreement

sosw - Serverless Orchestrator of Serverless Workers

The MIT License (MIT)
Copyright (C) 2024  sosw core contributors <info@sosw.app>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

class sosw.components.sigv4.AwsSigV4RequestGenerator(**kwargs)

Signature Version 4 (SigV4) is the process to add authentication information to AWS API requests sent by HTTP. For security, most requests to AWS must be signed with an access key. The access key consists of an access key ID and secret access key, which are commonly referred to as your security credentials.

How Signature Version 4 works:

1. Create a canonical request.

2. Use the canonical request and additional metadata to create a string for signing.

3. Derive a signing key from your AWS secret access key. Then use the signing key, and the string from the previous

4. Add the resulting signature to the HTTP request in a header.

get_authorization_header(canonical_request, signed_headers)

Create authorization header and add to request headers.

get_aws_sigv4_headers(request)

Returns a dictionary containing the necessary headers for Amazon’s signature version 4 signing process.

get_canonical_headers(parsed_url)

Create the canonical headers and signed headers. Header names must be trimmed and lowercase, and sorted in code point order from low to high. Note that there is a trailing \n.

static get_canonical_querystring(parsed_url)

Create the canonical query string. According to AWS, by the end of this function our query string values must be URL-encoded (space=%20) and the parameters must be sorted by name.

static get_canonical_uri(parsed_url)

Create canonical URI–the part of the URI from domain to query string (use ‘/’ if no path)

static get_headers_and_credential_date()

Create a date for headers and the credential string

static get_payload_hash(request)

Create payload hash. For GET requests, the payload is an empty string (“”)

get_signature_key()

Key derivation functions. See: http://docs.aws.amazon.com/general/latest/gr/signature-v4-examples.html#signature-v4-examples-python