python-hmac-auth

HMAC authentication for Python client libraries.

This library makes it easy to add support for HMAC authentication in Python clients that:

1. Interface with a REST API that uses jersey-hmac-auth to implement HMAC authentication, and
2. Use the Python Requests library to make API calls.

It works by providing a custom authenticator for the Requests library that modifies outgoing API calls to encode the requests for HMAC authentication.

Getting Started

To install:

pip install python-hmac-auth

In your code, import the HmacAuth class and specify it on the auth parameter when issuing API calls:

import requests
from python_hmac_auth import HmacAuth

response = requests.get('http://example.com/api', auth=HmacAuth('your_api_key', 'your_secret_key'))

If you need to you can adjust the names of the query parameter and headers used by HMAC by passing values for:

• api_key_query_param
• signature_http_header
• timestamp_http_header
• version_http_header to the constructor as named parameters.

See the User Guide to find the default names for these headers.

Changes in the client must also be made at the server or authentication will not work.

User Guide

See the User Guide for jersey-hmac-auth for more details about HMAC authentication on the server and for clients libraries.

Contributing

To get the code:

$ git clone git@github.com:bazaarvoice/python-hmac-auth.git

To submit a new request or issue, please visit the Issues page.

Pull requests are always welcome.