Skip to main content

Secure HTTP request signing using the HTTP Signature draft specification

Project description

https://travis-ci.org/ahknight/httpsig.svg?branch=master https://travis-ci.org/ahknight/httpsig.svg?branch=develop

Sign HTTP requests with secure signatures according to the IETF HTTP Signatures specification (Draft 8). This is a fork of the original module to fully support both RSA and HMAC schemes as well as unit test both schemes to prove they work. It’s being used in production and is actively-developed.

See the original project, original Python module, original spec, and current IETF draft for more details on the signing scheme.

Requirements

Optional:

For testing:

  • tox

  • pyenv (optional, handy way to access multiple versions)

    $ for VERS in 2.7.15 3.4.9 3.5.6 3.6.7 3.7.1; do pyenv install -s $VERS; done

Usage

Real documentation is forthcoming, but for now this should get you started.

For simple raw signing:

import httpsig

secret = open('rsa_private.pem', 'rb').read()

sig_maker = httpsig.Signer(secret=secret, algorithm='rsa-sha256')
sig_maker.sign('hello world!')

For general use with web frameworks:

import httpsig

key_id = "Some Key ID"
secret = b'some big secret'

hs = httpsig.HeaderSigner(key_id, secret, algorithm="hmac-sha256", headers=['(request-target)', 'host', 'date'])
signed_headers_dict = hs.sign({"Date": "Tue, 01 Jan 2014 01:01:01 GMT", "Host": "example.com"}, method="GET", path="/api/1/object/1")

For use with requests:

import json
import requests
from httpsig.requests_auth import HTTPSignatureAuth

secret = open('rsa_private.pem', 'rb').read()

auth = HTTPSignatureAuth(key_id='Test', secret=secret)
z = requests.get('https://api.example.com/path/to/endpoint',
                         auth=auth, headers={'X-Api-Version': '~6.5'})

Class initialization parameters

Note that keys and secrets should be bytes objects. At attempt will be made to convert them, but if that fails then exceptions will be thrown.

httpsig.Signer(secret, algorithm='rsa-sha256')

secret, in the case of an RSA signature, is a string containing private RSA pem. In the case of HMAC, it is a secret password. algorithm is one of the six allowed signatures: rsa-sha1, rsa-sha256, rsa-sha512, hmac-sha1, hmac-sha256, hmac-sha512.

httpsig.requests_auth.HTTPSignatureAuth(key_id, secret, algorithm='rsa-sha256', headers=None)

key_id is the label by which the server system knows your RSA signature or password. headers is the list of HTTP headers that are concatenated and used as signing objects. By default it is the specification’s minimum, the Date HTTP header. secret and algorithm are as above.

Tests

To run tests:

python setup.py test

or:

tox

Known Limitations

  1. Multiple values for the same header are not supported. New headers with the same name will overwrite the previous header. It might be possible to replace the CaseInsensitiveDict with the collection that the email package uses for headers to overcome this limitation.

  2. Keyfiles with passwords are not supported. There has been zero vocal demand for this so if you would like it, a PR would be a good way to get it in.

  3. Draft 2 added support for ecdsa-sha256. This is available in PyCryptodome but has not been added to httpsig. PRs welcome.

License

Both this module and the original module are licensed under the MIT license.

httpsig Changes

1.3.0 (2019-Nov-28)

  • Relax pycryptodome requirements (PR#14 by cveilleux)

  • Ability to supply another signature header like Signature (PR#15 by rbignon)

  • Fixed #2; made Signer.sign() public

  • Dropped Python 3.3, added Python 3.7.

1.2.0 (2018-Mar-28)

  • Switched to pycryptodome instead of PyCrypto (PR#11 by iandouglas)

  • Updated tests with the test data from Draft 8 and verified it still passes.

  • Dropped official Python 3.2 support (pip dropped it so it can’t be properly tested)

  • Cleaned up the code to be more PEP8-like.

1.1.2 (2015-Feb-11)

  • HMAC verification is now constant-time.

1.1.1 (2015-Feb-11)

  • (pulled)

1.1.0 (2014-Jul-24)

  • Changed “(request-line)” to “(request-target)” to comply with Draft 3.

1.0.3 (2014-Jul-09)

  • Unified the default signing algo under one setting. Setting httpsig.sign.DEFAULT_SIGN_ALGORITHM changes it for all future instances.

  • Handle invalid params a little better.

1.0.2 (2014-Jul-02)

  • Ensure we treat headers as ASCII strings.

  • Handle a case in the authorization header where there’s garbage (non-keypairs) after the method name.

1.0.1 (2014-Jul-02)

  • Python 3 support (2.7 + 3.2-3.4)

  • Updated tox and Travis CI configs to test the supported Python versions.

  • Updated README.

1.0.0 (2014-Jul-01)

  • Written against http://tools.ietf.org/html/draft-cavage-http-signatures-02

  • Added “setup.py test” and tox support.

  • Added sign/verify unit tests for all currently-supported algorithms.

  • HeaderSigner and HeaderVerifier now share the same message-building logic.

  • The HTTP method in the message is now properly lower-case.

  • Resolved unit test failures.

  • Updated Verifier and HeaderVerifier to handle verifying both RSA and HMAC sigs.

  • Updated versioneer.

  • Updated contact/author info.

  • Removed stray keypair in test dir.

  • Removed SSH agent support.

  • Removed suport for reading keyfiles from disk as this is a huge security hole if this is used in a server framework like drf-httpsig.

1.0b1 (2014-Jun-23)

  • Removed HTTP version from request-line, per spec (breaks backwards compatability).

  • Removed auto-generation of missing Date header (ensures client compatability).

http-signature (previous)

0.2.0 (unreleased)

  • Update to newer spec (incompatible with prior version).

  • Handle request-line meta-header.

  • Allow secret to be a PEM encoded string.

  • Add test cases from spec.

0.1.4 (2012-10-03)

  • Account for ssh now being re-merged into paramiko: either package is acceptable (but paramiko should ideally be >= 1.8.0)

0.1.3 (2012-10-02)

  • Stop enabling allow_agent by default

  • Stop requiring ssh package by default – it is imported only when allow_agent=True

  • Changed logic around ssh-agent: if one key is available, don’t bother with any other authentication method

  • Changed logic around key file usage: if decryption fails, prompt for password

  • Bug fix: ssh-agent resulted in a nonsensical error if it found no correct keys (thanks, petervolpe)

  • Introduce versioneer.py

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

httpsig-1.3.0.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

httpsig-1.3.0-py2.py3-none-any.whl (17.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file httpsig-1.3.0.tar.gz.

File metadata

  • Download URL: httpsig-1.3.0.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for httpsig-1.3.0.tar.gz
Algorithm Hash digest
SHA256 71d6d50246129c4f7cfec20f5e57e351d2b8492d631cc2aa967914acf91f6ce6
MD5 eb5ec4c73fd84ae0a1374034d51d3256
BLAKE2b-256 b8e478a5e0c8f2a47efb7083f393655730031e711051119ccb6501396a9d50b5

See more details on using hashes here.

File details

Details for the file httpsig-1.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: httpsig-1.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for httpsig-1.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ce3ebd489a9b3325810adf0f4992718a3c931d026fe04cafc1177c24be1ec4d3
MD5 6943ea244d63ae2acad3f62ac326f492
BLAKE2b-256 16934ac4548fccfc3d530ac9dcd2c5cfec087b41004a16b85c33e670b786a565

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page