skip to navigation
skip to content

Not Logged In

djangorestframework-httpsignature 0.1.5

HTTP Signature support for Django REST framework

Latest Version: 0.2.1

Overview

Provides HTTP Signature support for Django REST framework. The HTTP Signature package provides a way to achieve origin authentication and message integrity for HTTP messages. Similar to Amazon’s HTTP Signature scheme, used by many of its services. The HTTP Signature specification is currently an IETF draft.

Installation

Installing the package via the repository:

pip install djangorestframework-httpsignature

The current implementation depends on http_signature by David Lehn, who has updated the original code to match the revised spec. This dependency is reflected in the REQUIREMENTS.txt file, and pip will pull the code from David’s repository.

Troubleshooting

It has been reported that some newer versions of pip might download the requiered package http_signature from PyPI instead of the repository listed in REQUIREMENTS.txt. If this is your case, a workaround is:

  1. git clone https://github.com/etoccalino/django-rest-framework-httpsignature.git
  2. cd django-rest-framework-httpsignature
  3. remove the whole line in REQUIREMENTS.txt that references py-http-signature
  4. pip install the entire line (including the “-e” at the beginning)
  5. pip install -r REQUIREMENTS.txt

Those steps make explicity what should be automatic. Thanks Alberto Gragera for both spotting the problem and providing a solution.

Running the tests

To run the tests for the packages, use the following command on the repository root directory:

python manage.py test

Usage

To authenticate HTTP requests via HTTP signature, you need to:

  1. Install this package in your Django project, as instructed in Installation.

  2. Add rest_framework_httpsignature to your settings.py INSTALLED_APPS.

  3. In your app code, extend the SignatureAuthentication class, as follows:

    # my_api/auth.py
    
    from rest_framework_httpsignature.authentication import SignatureAuthentication
    
    class MyAPISignatureAuthentication(SignatureAuthentication):
        # The HTTP header used to pass the consumer key ID.
        # Defaults to 'X-Api-Key'.
        API_KEY_HEADER = 'X-Api-Key'
    
        # A method to fetch (User instance, user_secret_string) from the
        # consumer key ID, or None in case it is not found.
        def fetch_user_data(self, api_key):
            # ...
            # example implementation:
            try:
                user = User.objects.get(api_key=api_key)
                return (user, user.secret)
            except User.DoesNotExist:
                return None
    
  4. Configure Django REST framework to use you authentication class; e.g.:

    # my_project/settings.py
    
    # ...
    REST_FRAMEWORK = {
        'DEFAULT_AUTHENTICATION_CLASSES': (
           'my_api.auth.MyAPISignatureAuthentication',
        ),
        'DEFAULT_PERMISSION_CLASSES': (
            'rest_framework.permissions.IsAuthenticated',
        )
    }
    # The above will force HTTP signature for all requests.
    # ...
    

Roadmap

  • Currently, the library only support HMAC SHA256 for signing.
  • The REQUIREMENTS.txt file is fairly strict. It is very possible that previous versions of Django and Django REST framework are supported.
  • Since HTTP Signature uses a HTTP header for the request date and time, the authentication class could deal with request expiry.

Example usage & session w/cURL

Assuming the setup detailed in Usage, a project running on localhost:8000 could be probed with cURL as follows:

~$ SSS=Base64(Hmac(SECRET, "Date: Mon, 17 Feb 2014 06:11:05 GMT", SHA256))
~$ curl -v -H 'Date: "Mon, 17 Feb 2014 06:11:05 GMT"' -H 'Authorization: Signature keyId="my-key",algorithm="hmac-sha256",headers="date",signature="SSS"'

And with much less pain, using the modules requests and http_signature:

import requests
from http_signature.requests_auth import HTTPSignatureAuth

API_KEY_ID = 'su-key'
SECRET = 'my secret string'

signature_headers = ['request-line', 'accept', 'date', 'host']
headers = {
    'Host': 'localhost:8000',
    'Accept': 'application/json',
    'X-Api-Key': API_KEY_ID,
}

# We omit the "Date" header, so http_signature adds it.
auth = HTTPSignatureAuth(key_id=API_KEY_ID, secret=SECRET,
                         algorithm='hmac-sha256',
                         headers=signature_headers)
req = requests.get('http://localhost:8000/resource/',
                   auth=auth, headers=headers)
print req.content
 
File Type Py Version Uploaded on Size
djangorestframework-httpsignature-0.1.5.tar.gz (md5) Source 2014-06-13 8KB
  • Downloads (All Versions):
  • 105 downloads in the last day
  • 310 downloads in the last week
  • 1106 downloads in the last month