Skip to main content

Implements the "Resource Owner Password Credentials Grant" from Oauth v2.

Project description

Basic OAuth v2
==============

What is it?
-----------

The Oauth v2 spec defines several authorization grant. This library implements
the "Resource Owner Password Credentials Grant" as described in
<http://tools.ietf.org/html/draft-ietf-oauth-v2-31#section-4.3>

Requirements:

* [Flask](http://flask.pocoo.org/)
* [Redis](http://redis.io/)

Why using it?
-------------

The goal of this Grant is to replace the classic "HTTP Basic over SSL" widely
used. With Oauth, you exchange your crendentials against a token.

This mechanism has several advantages:

* The client does not pass the full credentials for each request.
* The server does not check the username and password each time, it will
only check the access token, this will reduce the database lookups.

Basic Oauth uses Redis to store the sessions.

Is it secure?
-------------

__It would be stupid to use this mechanism without SSL__. Even if the token is
passed instead of the credentials, the credentials needs to be passed in clear
text during the Authentication phase. Also, it can be problematic to lose the
token.

To limit the risk of losing the token, every single token generated is signed
using the User-Agent and the client IP address. If an attacker tries to re-use
a stolen token, he will have to connect to the same IP and using the same
User-Agent (browser version, OS, architecture) to get access. A wrong try will
result in destroying the session.

How to use it?
--------------

import flask
import basic_oauth

app = flask.Flask(__name__)

oauth = basic_oauth.BasicOauth(app)
oauth.mount_endpoint('login', '/login')
oauth.mount_endpoint('script', '/js/oauth_client.js')
oauth.credentials.append(('johndoe', 'foobar42'))

@app.route('/')
@oauth.require
def hello():
return 'Hello World!'

if __name__ == '__main__':
app.debug = True
app.run()

Checkout the "example" directory for a complete server/client example.

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

basic_oauth-0.1.1.tar.gz (5.0 kB view details)

Uploaded Source

File details

Details for the file basic_oauth-0.1.1.tar.gz.

File metadata

File hashes

Hashes for basic_oauth-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f3708cecd811c652f54e6c94251c180f7c208e2ab45addcdd805683fc92cb865
MD5 c82636666d21dcf67b4ca3bac05358d5
BLAKE2b-256 f4e8182bf767a630bbb0bacbfd7d23111518ed265a172ff6a32e2d332167caaa

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