Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/erlef/oidcc_plug

Plug Integration for the oidcc OpenID Connect Library
https://github.com/erlef/oidcc_plug

client elixir openid openid-client openid-connect plug security-wg

Last synced: about 1 month ago
JSON representation

Plug Integration for the oidcc OpenID Connect Library

Host: GitHub
URL: https://github.com/erlef/oidcc_plug
Owner: erlef
License: apache-2.0
Created: 2023-09-11T13:52:55.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-11-10T21:39:17.000Z (about 2 months ago)
Last Synced: 2024-11-10T22:30:10.140Z (about 2 months ago)
Topics: client, elixir, openid, openid-client, openid-connect, plug, security-wg
Language: Elixir
Homepage: https://hexdocs.pm/oidcc_plug
Size: 102 KB
Stars: 7
Watchers: 6
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md

Awesome Lists containing this project

README

        


  



# Oidcc.Plug

Plug Integration for [`oidcc`](https://hex.pm/packages/oidcc) library.

[![EEF Security WG project](https://img.shields.io/badge/EEF-Security-black)](https://github.com/erlef/security-wg)

[![Main Branch](https://github.com/erlef/oidcc_plug/actions/workflows/branch_main.yml/badge.svg?branch=main)](https://github.com/erlef/oidcc_plug/actions/workflows/branch_main.yml)

[![Module Version](https://img.shields.io/hexpm/v/oidcc_plug.svg)](https://hex.pm/packages/oidcc_plug)

[![Total Download](https://img.shields.io/hexpm/dt/oidcc_plug.svg)](https://hex.pm/packages/oidcc_plug)

[![License](https://img.shields.io/hexpm/l/oidcc_plug.svg)](https://github.com/erlef/oidcc_plug/blob/main/LICENSE)

[![Last Updated](https://img.shields.io/github/last-commit/erlef/oidcc_plug.svg)](https://github.com/erlef/oidcc_plug/commits/master)

[![Coverage Status](https://coveralls.io/repos/github/erlef/oidcc_plug/badge.svg?branch=main)](https://coveralls.io/github/erlef/oidcc_plug?branch=main)




  

  

  

OpenID Certified by [Jonatan Männchen](https://github.com/maennchen) at the

[Erlang Ecosystem Foundation](https://github.com/erlef) of multiple Relaying

Party conformance profiles of the OpenID Connect protocol:

For details, check the

[Conformance Test Suite](https://github.com/erlef/oidcc_conformance).




  

  

  

The development of the library and the certification is funded as an

[Erlang Ecosystem Foundation](https://erlef.org/) stipend entered by the

[Security Working Group](https://erlef.org/wg/security).




## Installation

The package can be installed by adding `oidcc_plug` to your list of dependencies

in `mix.exs`:

```elixir

def deps do

  [

    {:oidcc_plug, "~> 0.1.0"}

  ]

end

```

## Usage

### Setup

```elixir

defmodule SampleApp.Application do

  # ...

  @impl true

  def start(_type, _args) do

    children = [

      # ...

      {Oidcc.ProviderConfiguration.Worker, %{

        issuer: "https://accounts.google.com",

        name: SampleApp.GoogleOpenIdConfigurationProvider

      }},

      # Start the Endpoint (http/https)

      SampleAppWeb.Endpoint

    ]

    # See https://hexdocs.pm/elixir/Supervisor.html

    # for other strategies and supported options

    opts = [strategy: :one_for_one, name: SampleApp.Supervisor]

    Supervisor.start_link(children, opts)

  end

  # ...

end

```

### Authorization Flow

```elixir

defmodule SampleAppWeb.OidccController do

  use SampleAppWeb, :controller

  plug Oidcc.Plug.Authorize,

    [

      provider: TestWorks.OpenIdConfigurationProvider,

      client_id: "client_id",

      client_secret: "client_secret",

      redirect_uri: &__MODULE__.callback_uri/0

    ]

    when action in [:authorize]

  plug Oidcc.Plug.AuthorizationCallback,

    [

      provider: TestWorks.OpenIdConfigurationProvider,

      client_id: "client_id",

      client_secret: "client_secret",

      redirect_uri: &__MODULE__.callback_uri/0

    ]

    when action in [:callback]

  @doc false

  def callback_uri, do: url(~p"/oidcc/callback")

  def authorize(conn, _params), do: conn

  def callback(%Plug.Conn{private: %{

    Oidcc.Plug.AuthorizationCallback => {:ok, {_token, userinfo}}}

  } = conn, params) do

    conn

    |> put_session("oidcc_claims", userinfo)

    |> redirect(to: "/")

  end

  def callback(%Plug.Conn{private: %{

    Oidcc.Plug.AuthorizationCallback => {:error, reason}

  }} = conn, _params) do

    conn

    |> put_status(400)

    |> render(:error, reason: reason)

  end

end

```

### API (Check access token header)

```elixir

defmodule SampleAppWeb.Endpoint do

  use Phoenix.Endpoint, otp_app: :sample_app

  # ...

  plug Oidcc.Plug.ExtractAuthorization

  @client_id Application.compile_env!(:sample_app, [:openid_credentials, :client_id])

  @client_secret Application.compile_env!(:sample_app, [:openid_credentials, :client_secret])

  # Ensure Authorization Token provided

  plug Oidcc.Plug.RequireAuthorization

  # Check Token via Introspection

  plug Oidcc.Plug.IntrospectToken,

    provider: SampleApp.GoogleOpenIdConfigurationProvider,

    client_id: @client_id,

    client_secret: @client_secret

  # OR: Check Token via Userinfo

  plug Oidcc.Plug.LoadUserinfo,

    provider: SampleApp.GoogleOpenIdConfigurationProvider,

    client_id: @client_id,

    client_secret: @client_secret

  # OR: Check Token via JWT validation

  plug Oidcc.Plug.ValidateJwtToken,

    provider: SampleApp.GoogleOpenIdConfigurationProvider,

    client_id: @client_id,

    client_secret: @client_secret

  plug SampleAppWeb.Router

end

```