Code Monkey home page Code Monkey logo

pyramid_oauth2_provider's Introduction

pyramid_oauth2_provider README

Getting Started

In an existing pyramid project you can take advantage of pyramid_oauth2_provider by doing the following:

  • Add config.include('pyramid_oauth2_provider') to your project setup. This will configure a /oauth2/token route for the token endpoint and an authentication policy that will support oauth2. If you want to be able to use both cookie auth and oauth2 at the same time, you should use the pyramid_oauth2_provider.authentication.OauthTktAuthenticationPolicy instead of the default.
  • Define a implementation of the pyramid_oauth2_provider.interfaces.IAuthCheck interface that works against your current user authentication check mechanism.
  • In your paster configuration configure which IAuthCheck implementation to use by specifying oauth2_provider.auth_checker.
  • In your development configuration, you may also want to disable ssl enforcement by specifying oauth2_provider.require_ssl = false.
  • Generate client credentials using the create_client_credentials script, provided as part of pyramid_oauth2_provider.

Request Flow

Let's start by laying out a few ground rules when it comes to oauth2:

  1. All requests must be made via HTTPS.
  2. All data is transferred in headers and the body of messages rather than through url parameters.

The token endpoint is provided as a way to obtain and renew access_tokens.

Example initial token request:

    POST /oauth2/token HTTP/1.1
    Host: server.example.com
    Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
    Content-Type: application/x-www-form-urlencoded

    grant_type=password&username=johndoe&password=A3ddj3w
  • The basic auth header is the client_id:client_secret base64 encoded.
  • Content-Type must be application/x-www-form-urlencoded

Example refresh token request:

    POST /token HTTP/1.1
    Host: server.example.com
    Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
    Content-Type: application/x-www-form-urlencoded

    grant_type=refresh_token&refresh_token=tGzv3JOkF0XG5Qx2TlKW&user_id=1234
  • The basic auth header is the client_id:client_secret base64 encoded.
  • Content-Type must be application/x-www-form-urlencoded
  • The grant_type must be "refresh".
  • All form elements are required.

Example token response:

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    Cache-Control: no-store
    Pragma: no-cache

    {
      "access_token":"2YotnFZFEjr1zCsicMWpAA",
      "token_type":"bearer",
      "expires_in":3600,
      "refresh_token":"tGzv3JOkF0XG5Qx2TlKW",
      "user_id":1234,
    }
  • The same response is returned for both auth token and refresh token requests.
  • The token_type will always be "bearer".
  • For purposes of this example the access_token and refresh_token are shorter than normal.

pyramid_oauth2_provider's People

Contributors

elliotpeele avatar ramsay avatar troyjfarrell avatar

Watchers

Eric Hulser avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.