PhoenixOauth2Provider

Get an OAuth 2 provider running in your Phoenix app with controllers, views and models in just two minutes.

This version requires Phoenix 1.3 or higher. If you use a previous Phoenix version, please use v0.2.0 instead.

Installation

Add PhoenixOauth2Provider to your list of dependencies in mix.exs:

def deps do
  [
    # ...
    {:phoenix_oauth2_provider, "~> 0.3.0"}
    # ...
  ]
end

Run mix deps.get to install it.

Add migrations and set up config/config.exs:

mix phoenix_oauth2_provider.install

Set up routes:

defmodule MyAppWeb.Router do
  use MyAppWeb, :router
  use ExOauth2Provider.Router

  # ...

  pipeline :protected do
    # Require user authentication
  end

  pipeline :oauth_public do
    plug :put_secure_browser_headers
  end

  scope "/", MyAppWeb do
    pipe_through :oauth_public
    oauth_routes :public
  end

  scope "/", MyAppWeb do
    pipe_through :protected
    oauth_routes :protected
  end

  # ...
end

That's it! The following OAuth 2.0 routes will now be available in your app:

oauth_authorize_path  GET    /oauth/authorize         AuthorizationController :new
oauth_authorize_path  POST   /oauth/authorize         AuthorizationController :create
oauth_authorize_path  GET    /oauth/authorize/:code   AuthorizationController :show
oauth_authorize_path  DELETE /oauth/authorize         AuthorizationController :delete
oauth_token_path      POST   /oauth/token             TokenController :create
oauth_token_path      POST   /oauth/revoke            TokenController :revoke

Configuration

Resource owner schema

By default MyApp.User is used as the resource_owner, you can change that in the following way:

config :phoenix_oauth2_provider, PhoenixOauth2Provider,
  repo: MyApp.Repo,
  resource_owner: MyApp.CustomUser

Resource owner

Set up what assigns in the plug that PhoenixOauth2Provider should gather the authorized user from.

config :phoenix_oauth2_provider, PhoenixOauth2Provider,
  current_resource_owner: :current_user

Acknowledgement

This library was made thanks to coherence that gave the conceptual building blocks.

LICENSE

(The MIT License)

Copyright (c) 2017 Dan Schultzer & the Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.