Skip to main content

Python implementation of the Ruby Signature library (https://github.com/mloughran/signature)

Project description

ApySignature
============

Python implementation of the Ruby Signature library
(https://github.com/mloughran/signature)

Installation
------------

```
pip install apysignature
```

Examples
--------

Client example

```python
from apysignature import signature
params = {'some'='parameters'}
token = signature.Token('my_key', 'my_secret')
request = signature.Request('POST', '/api/thing', params)
auth_hash = request.sign(token)
query_params = params.update(auth_hash)

requests.post('http://myservice/api/thing', data=query_params)
```

`query_params` looks like:

```python
{
'some'='parameters',
'auth_timestamp'=1273231888,
'auth_signature'='28b6bb0f242f71064916fad6ae463fe91f5adc302222dfc02c348ae1941eaf80',
'auth_version'='1.0',
'auth_key'='my_key'
}
```

Server example (Django)

```python
from apysignature import signature
auth_request = signature.Request(request.method, str(request.path), params)
public_key = params['auth_key']
token = signature.Token(public_key, private_key)
try:
auth_request.authenticate(token)
except AuthenticationError as e:
return HttpResponse('Unauthorized', status=401)

# Do whatever you need to do
end
```

Compatibility
---------

Version > 0.2 is for Python 3
use < 0.2 for Python 2


Copyright
---------

Copyright (c) 2014 Erick Ponce. See LICENSE for details.

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

apysignature-0.2.1.tar.gz (3.9 kB view hashes)

Uploaded Source

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