Skip to main content

A Requests auth module for HTTP Signature

Project description

requests-http-signature is a Requests authentication plugin (requests.auth.AuthBase subclass) implementing the IETF HTTP Signatures draft RFC. It has no required dependencies outside the standard library. If you wish to use algorithms other than HMAC (namely, RSA and ECDSA algorithms specified in the RFC), there is an optional dependency on cryptography.

Installation

$ pip install requests-http-signature

Usage

import requests
from requests_http_signature import HTTPSignatureAuth

preshared_key_id = 'squirrel'
preshared_secret = 'monorail_cat'
url = 'http://example.com/path'

requests.get(url, auth=HTTPSignatureAuth(key=preshared_secret, key_id=preshared_key_id))

By default, only the Date header is signed (as per the RFC) for body-less requests such as GET. The Date header is set if it is absent. In addition, for requests with bodies (such as POST), the Digest header is set to the SHA256 of the request body and signed (an example of this appears in the RFC). To add other headers to the signature, pass an array of header names in the header keyword argument.

In addition to signing messages in the client, the class method HTTPSignatureAuth.verify() can be used to verify incoming requests:

def key_resolver(key_id, algorithm):
    return 'monorail_cat'

HTTPSignatureAuth.verify(request, key_resolver=key_resolver)

Asymmetric key algorithms (RSA and ECDSA)

For asymmetric key algorithms, you should supply the private key as the key parameter to the HTTPSignatureAuth() constructor as bytes in the PEM format:

with open('key.pem', 'rb') as fh:
    requests.get(url, auth=HTTPSignatureAuth(algorithm="rsa-sha256", key=fh.read(), key_id=preshared_key_id))

When verifying, the key_resolver() callback should provide the public key as bytes in the PEM format as well:

License

Licensed under the terms of the Apache License, Version 2.0.

https://travis-ci.org/kislyuk/requests-http-signature.png https://codecov.io/github/kislyuk/requests-http-signature/coverage.svg?branch=master https://img.shields.io/pypi/v/requests-http-signature.svg https://img.shields.io/pypi/l/requests-http-signature.svg https://readthedocs.org/projects/requests-http-signature/badge/?version=latest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

requests-http-signature-0.1.0.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

requests_http_signature-0.1.0-py2.py3-none-any.whl (4.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file requests-http-signature-0.1.0.tar.gz.

File metadata

File hashes

Hashes for requests-http-signature-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0e39d928469e6f1411e3bffca74a280ac9375d4fa5bf03552974f0ba4ff4c37a
MD5 9b56feafca4d3b99bc993f3f36ad2277
BLAKE2b-256 10183744e7bc8b846dc7f4718ad189261f2eb47a70190a2f69a877f2ab51a77c

See more details on using hashes here.

File details

Details for the file requests_http_signature-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for requests_http_signature-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f41debf21abaa8bb5ec6c367ddc6a5003d98ef4df21afb20f90f2195bd22c7d3
MD5 055d5de727d0522b8fdfc4cff486d059
BLAKE2b-256 45c2dd86e89f8f4fb6cc0028793f725bd536757b630c5734621f72b94b55ef53

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page