Sign HTTP requests with secure signatures according to the IETF HTTP Signatures specification (Draft 3). 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
Python 2.7, 3.2, 3.3, 3.4
Optional:
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
License
Both this module and the original module are licensed under the MIT license.
httpsig Changes
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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file httpsig-1.1.0.tar.gz.
File metadata
- Download URL: httpsig-1.1.0.tar.gz
- Upload date:
- Size: 21.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7c399a461014e8d1b33023bfb8cc85bc996c2b02736a035a125c4ae2b59a0fac
|
|
| MD5 |
c909b4976195e6e1588b2907611e02f3
|
|
| BLAKE2b-256 |
0f6de90925e0fffbb246d51d1b9c8811751504cd327fa97ac9d860575c279a5e
|
File details
Details for the file httpsig-1.1.0-py2.py3-none-any.whl.
File metadata
- Download URL: httpsig-1.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 18.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8f27070da0c9a56a120e234566b8ebe98f3356cced93259c125e274f3db9639f
|
|
| MD5 |
df10322cffcd386ce197147d65066b87
|
|
| BLAKE2b-256 |
3620a3497c64ee67f6987fc8ac599ff572ad18b5832a6dd8ea2730c9cb48a537
|
