Settings UeberauthOidcc

Implementation of Ueberauth.Strategy based on the Oidcc library.

Installation

The package can be installed by adding ueberauth_oidcc to your list of dependencies in mix.exs:

def deps do
  [
    {:ueberauth_oidcc, "~> 0.1.0"}
  ]
end

Configuration

1. Add an OIDC Issuer to your Ueberauth configuration.

An issuer is a single OIDC endpoint, but it can be shared by multiple strategies.

config :ueberauth_oidcc, :issuers, [
  %{name: :oidcc_issuer, issuer: "<issuer URI>"}
]

The issuer must provide OIDC configuration at <issuer URI>/.well-known/openid-configuration.

See oidcc_provider_configuration:opts/0 for issuer parameters.

2. Add the Ueberauth strategy to your configuration.

See Ueberauth and Oidcc for a list of supported options.

```elixir
config :ueberauth, Ueberauth,
  providers: [
    oidc: { Ueberauth.Strategy.Oidcc,
      issuer: :oidcc_issuer, # matches the name above
      client_id: "client_id",
      client_secret: "123456789",
      scopes: ["openid", "profile", "email"],
      # optional
      callback_path: "/auth/oidc/callback",
      userinfo: true, # whether to pull info from the Userinfo endpoint, default: false
      uid_field: "email", # pulled from the merge of the claims and userinfo (if fetched), default: sub
      authorization_params: %{}, # additional parameters for the authorization request
      authorization_endpoint: "https://oidc-override/request" # override the initial request URI
    }
  ]
```

The core Ueberauth configuration is only read at compile time, so if you have runtime configuration you'll need to put it under the :ueberauth_oidcc :strategies config.

```elixir
config :ueberauth, Ueberauth,
  providers: [
    oidc: { Ueberauth.Strategy.Oidcc,
      issuer: :oidcc_issuer,
      client_id: "client_id"
    }
  ]

config :ueberauth_oidcc, :strategies,
  oidc: [
    client_secret: System.fetch_env!("OIDC_CLIENT_SECRET")
  ]
```

Usage

1. Include the Ueberauth plug in your controller:

    defmodule MyApp.AuthController do
      use MyApp.Web, :controller
      plug Ueberauth
      ...
    end

2. Create the request and callback routes if you haven't already:

    scope "/auth", MyApp do
      pipe_through :browser
   
      get "/:unused", AuthController, :request
      get "/:unused/callback", AuthController, :callback
    end

3. Your controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses. For an example implementation see the Ueberauth Example application.

   • Ueberauth.Auth.Credentials contains the access_token and related fields
     • The other map in Ueberauth.Auth.Credentials contains id_token
   • Ueberauth.Auth.Extra contains the raw claims, userinfo, and options

Calling

Depending on the configured url, you can initialize the request through:

/auth/oidc

Documentation

Documentation can be generated with ExDoc and or found at https://hexdocs.pm/ueberauth_oidcc.

License

Released under the MIT License. Please see LICENSE for details.