aws_auth v0.7.2 AWSAuth
Signs urls or authentication headers for use with AWS requests
Link to this section Summary
Functions
AWSAuth.sign_authorization_header(access_key, secret_key, http_method, url, region, service, headers, payload)
AWSAuth.sign_url(access_key, secret_key, http_method, url, region, service, headers)
Link to this section Functions
AWSAuth.sign_authorization_header(access_key, secret_key, http_method, url, region, service, headers, payload)
access_key
: Your AWS Access key
secret_key
: Your AWS secret key
http_method
: “GET”,”POST”,”PUT”,”DELETE”, etc
url
: The AWS url you want to sign
region
: The AWS name for the region you want to access (i.e. us-east-1). Check here for the region names
service
: The AWS service you are trying to access (i.e. s3). Check the url above for names as well.
headers
(optional. defaults to Map.new
): The headers that will be used in the request. Used for signing the request.
For signing, host is the only one required unless using any other x-amx-* headers.
If host is present here, it will override using the host in the url to attempt signing.
Same goes for the x-amz-content-sha256 headers
If only the host and x-amz-content-sha256 headers are needed, then you don’t have to supply it and the host from the url will be used and
the payload will be hashed to get the x-amz-content-sha256 header.
payload
(optional. defaults to ""
): The contents of the payload if there is one.
AWSAuth.sign_url(access_key, secret_key, http_method, url, region, service, headers)
access_key
: Your AWS Access key
secret_key
: Your AWS secret key
http_method
: “GET”,”POST”,”PUT”,”DELETE”, etc
url
: The AWS url you want to sign
region
: The AWS name for the region you want to access (i.e. us-east-1). Check here for the region names
service
: The AWS service you are trying to access (i.e. s3). Check the url above for names as well.
headers
(optional. defaults to Map.new
): The headers that will be used in the request. Used for signing the request.
For signing, host is the only one required unless using any other x-amx-* headers.
If host is present here, it will override using the host in the url to attempt signing.
If only the host is needed, then you don’t have to supply it and the host from the url will be used.