Extension to urllib3 adding support for signing the requests with AWS Signature Version 4. It uses the Boto3 library for handling the AWS credentials and the actual signing process.
Use pip to install the package:
pip install urllib3_sigv4This library provides a drop-in replacement for two main components of urllib3,
the PoolManager
class and the top-level request
method. It adds a new optional parameter which determines if and how the
requests should be signed.
First, create an instance of the SigV4RequestSigner class which defines the
parameters for request signing:
from urllib3_sigv4 import SigV4RequestSigner
signer = SigV4RequestSigner(
"lambda",
region="eu-central-1",
access_key="AKIAIOSFODNN7EXAMPLE",
secret_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
)The first parameter is mandatory and identifies the AWS service we want to make
requests to (AWS Lambda in this case). The region, access_key and
secret_key parameters are optional and will be inferred from the environment
if not passed (via the default Boto3 session, see
here
and here
for more details).
To make signed requests to an AWS service, pass the signer instance via the
signer parameter when creating the PoolManager:
from urllib3_sigv4 import PoolManager, SigV4RequestSigner
signer = SigV4RequestSigner("lambda")
http = PoolManager(signer=signer)
response = http.request(
"POST",
"https://my-lambda-url-id.lambda-url.eu-central-1.on.aws",
json={"name": "John Doe", "age": 30}
)
print(response.json())You can also provide the signer in individual request method calls to
override the default behavior:
from urllib3_sigv4 import PoolManager, SigV4RequestSigner
signer = SigV4RequestSigner("lambda")
http = PoolManager()
# The same as when using urllib3's PoolManager.
response = http.request("GET", "https://httpbin.org/get")
print(response.json())
# This request will be signed.
response = http.request(
"POST",
"https://my-lambda-url-id.lambda-url.eu-central-1.on.aws",
json={"name": "John Doe", "age": 30},
signer=signer
)
print(response.json())You can also use a convenience top-level request method which uses a
module-global PoolManager instance:
from urllib3_sigv4 import SigV4RequestSigner, request
signer = SigV4RequestSigner("lambda")
response = request(
"POST",
"https://my-lambda-url-id.lambda-url.eu-central-1.on.aws",
json={"name": "John Doe", "age": 30},
signer=signer
)
print(response.json())