Metadata-Version: 1.0
Name: sanction
Version: 0.1.1
Summary: A simple, lightweight OAuth2 client
Home-page: https://github.com/demianbrecht/sanction
Author: Demian Brecht
Author-email: demianbrecht@gmail.com
License: UNKNOWN
Description: .. image:: https://secure.travis-ci.org/demianbrecht/py-sanction.png?branch=master
           :target: http://travis-ci.org/#!/demianbrecht/py-sanction
        
        sanction [sangk-shuhn]: authoritative permission or approval, as for an action. 
        
        .. contents::
           :depth: 3
        
        
        Overview
        --------
        sanction is a lightweight, dead simple client implementation of the 
        OAuth2 protocol. The major goals of the library are:
        
        * Support multiple providers
         * Most providers have varying levels of diversion from the official
           spec. The goal with this library is to either handle these diversions
           natively, or expose a method to allow client code to deal with it 
           efficiently and effectively.
        * Support all server-side OAuth2 flows
         * Three of the four OAuth2 flows should be supported by this library.
           Currently, only authorization code and client credential flows have
           been tested due to lack of other (known) implementations.
        
        sanction has been tested with the following OAuth2 providers:
        
        * Facebook (include the test API)
        * Google
        * Foursquare
        
        :note: The intention of the sanction library is to not only provide accessibility
               to the OAuth2 authorization code flow, but all server-side flows. However,
               due to lack of implementations, the only tested currently teseted flows
               are authorization code and client credentials.
        
        
        Quickstart
        ----------
        
        For the quickstart, authorization code grant flow is assumed, as is the
        Bearer token type. If you're unfamiliar with these terms, chances are that 
        they're what you're looking for as it's the default in most public OAuth2
        provider implementations (Google, Facebook, Foursquare, etc.).
        
        Introducing this library should be rather trivial (in the usual basic case).
        There are three steps required in the most common use case (Google is assumed
        to be the provider throughout sample code):
        
        You can also take a look at the example code in ``/example``.
        
        Instantiation
        `````````````
        
        To access protected resources via the OAuth2 protocol, you must instantiate a 
        ``Client`` and pass it relevant endpoints for your current operation::
        
            from sanction.client import Client
        
            # instantiating a client to get the auth URI
            c = Client(auth_endpoint="https://accounts.google.com/o/oauth2/auth",
                client_id=config["google.client_id"],
                redirect_uri="http://localhost:8080/login/google")
            
            # instantiating a client to process OAuth2 response
            c = Client(token_endpoint="https://accounts.google.com/o/oauth2/token",
                resource_endpoint="https://www.googleapis.com/oauth2/v1",
                redirect_uri="http://localhost:8080/login/google",
                client_id=config["google.client_id"],
                client_secret=config["google.client_secret"])
        
        
        Of course, you may create the config ``dict`` in your preferred method, the
        above is simply for demonstration using the required config settings (the
        example project uses ``ConfigParser`` against an ``.ini`` file for settings.
        
        Authorization Request
        `````````````````````
        The next step is to redirect the user agent to the provider's authentication/
        authorization uri (continuation from previous code block)::
        
            scope_req = ("scope1","scope2",)
            my_redirect(c.auth_uri(scope_req))
        
        You can also elect to use the optional ``state`` parameter to pass a CSRF token
        that will be included if the provider's response::
        
            my_redirect(client.flow.authorization_uri(state=my_state))
        
        :note: It is **strongly** encouraged that you use the ``state`` parameter to 
               offer CSRF protection. It is also up to you to process the ``state``
               parameter and handle redirection accordingly *before* calling 
               ``request_token``.
        
        
        Access Token Request
        ````````````````````
        When the user has granted or denied resource access to your application, they
        will be redirected to the ``redirect_uri`` as specified by the value of the ``GET``
        param. In order to request an access token from the provider, you must
        request an access token from the provider::
        
            c.request_token(response_dict)
        
        If the user has granted access and your config settings are correct, you should
        then be able to access protected resources through the adapter's API::
        
            c.request("/userinfo")
        
        There are no implementations for individual OAuth2-exposed resources. This is not
        the intention of the library and will not be added.
        
        
        
Keywords: python,oauth2
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory
