Skip to main content

OAuth 2.0 provider for python with Stateless tokens support

Project description

# Oauth2-stateless

Oauth2-stateless is a framework that aims at making it easy to provide authentication
via [OAuth 2.0]( within an application stack.
Main difference of this library is the simplicity
and the ability to work without any database just with 'stateless'
tokens based on **JWT** [JSON Web Tokens](


# Status

[![Travis Build Status][build-badge]][build]

Oauth2-stateless has reached its beta phase. All main parts of the [OAuth 2.0 RFC]( such as the various types of Grants, Refresh Token and Scopes have been implemented.

# Installation

oauth2-stateless is [available on PyPI](

``` bash
pip install oauth2-stateless

# Usage

## Example Authorization server

``` python
from wsgiref.simple_server import make_server
import oauth2
import oauth2.grant
import oauth2.error
from import ClientStore
from import Token Store
import oauth2.tokengenerator
import oauth2.web.wsgi

# Create a SiteAdapter to interact with the user.
# This can be used to display confirmation dialogs and the like.
class ExampleSiteAdapter(oauth2.web.AuthorizationCodeGrantSiteAdapter, oauth2.web.ImplicitGrantSiteAdapter):
<a href="{url}&confirm=confirm">confirm</a>
<a href="{url}&deny=deny">deny</a>

def authenticate(self, request, environ, scopes, client):
# Check if the user has granted access
if request.post_param("confirm") == "confirm":
return {}

raise oauth2.error.UserNotAuthenticated

def render_auth_page(self, request, response, environ, scopes, client):
url = request.path + "?" + request.query_string
response.body = self.TEMPLATE.format(url=url)
return response

def user_has_denied_access(self, request):
# Check if the user has denied access
if request.post_param("deny") == "deny":
return True
return False

# Create an in-memory storage to store your client apps.
client_store = ClientStore()
# Add a client
client_store.add_client(client_id="abc", client_secret="xyz", redirect_uris=["http://localhost/callback"])

site_adapter = ExampleSiteAdapter()

# Create an in-memory storage to store issued tokens.
# LocalTokenStore can store access and auth tokens
stateless_token = oauth2.tokengenerator.StatelessTokenGenerator(secret_key='xxx')
token_store = TokenStore(stateless)

# Create the controller.
provider = oauth2.Provider(

# Add Grants you want to support

# Add refresh token capability and set expiration time of access tokens to 30 days

# Wrap the controller with the Wsgi adapter
app = oauth2.web.wsgi.Application(provider=provider)

if __name__ == "__main__":
httpd = make_server('', 8080, app)

This example only shows how to instantiate the server.
It is not a working example as a client app is missing.
Take a look at the [examples](docs/examples/) directory.

Or just run this example:

``` bash
python docs/examples/

This is already a workable example. They can work without database
because oauth token already contain all the necessary information like
a user_id, grant_type, data, scopes and client_id.
If you want to check user state like a ban, disable, etc.
You can check this param on server site from database. By adding this check to
/api/me or redefine oauth2.tokengenerator and add specific logic.

# Supported storage backends

Oauth2-stateless does not force you to use a specific database or you
can work without database with stateless token.

It currently supports these storage backends out-of-the-box:

- MongoDB
- Redis
- Memcached
- Dynamodb

However, you are not not bound to these implementations.
By adhering to the interface defined by the base classes in ****,
you can easily add an implementation of your backend.
It also is possible to mix different backends and e.g. read data of a client
from MongoDB while saving all tokens in memcached for fast access.

Take a look at the examples in the [examples](docs/examples/) directory of the project.

# Site adapter

- aiohttp
- flask
- tornado
- uwsgi

Like for storage, oauth2-stateless does not define how you identify a
user or show a confirmation dialogue.
Instead your application should use the API defined by _oauth2.web.SiteAdapter_.

# Contributors

[<img alt="DarkAnthey" src="" width="117">]( |


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

oauth2-stateless-1.1.0.tar.gz (45.8 kB view hashes)

Uploaded source

Built Distributions

oauth2_stateless-1.1.0-py3.5.egg (161.9 kB view hashes)

Uploaded 3 5

oauth2_stateless-1.1.0-py2.py3-none-any.whl (66.2 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page