View Source Oidcc.Plug.LoadUserinfo (Oidcc Plug v0.1.0-alpha.2)

Validate extracted authorization token using introspection.

See: https://openid.net/specs/openid-connect-core-1_0.html#UserInfo

This module should be used together with Oidcc.Plug.ExtractAuthorization.

This plug will send a userinfo request for ever request. To avoid this, provide a cache to opts/0.

defmodule SampleAppWeb.Endpoint do
  use Phoenix.Endpoint, otp_app: :sample_app

  # ...

  plug Oidcc.Plug.ExtractAuthorization

  plug Oidcc.Plug.LoadUserinfo,
    provider: SampleApp.GoogleOpenIdConfigurationProvider,
    client_id: Application.compile_env!(:sample_app, [Oidcc.Plug.LoadUserinfo, :client_id]),
    client_secret: Application.compile_env!(:sample_app, [Oidcc.Plug.LoadUserinfo, :client_secret])

  plug SampleAppWeb.Router
end

Link to this section Summary

Types

Plug Configuration Options

Link to this section Types

@type opts() :: [
  provider: GenServer.name(),
  client_id: String.t(),
  client_secret: String.t(),
  userinfo_retrieve_opts: :oidcc_userinfo.retrieve_opts(),
  send_inactive_token_response: (conn :: Plug.Conn.t() -> Plug.Conn.t()),
  cache: Oidcc.Plug.Cache.t()
]

Plug Configuration Options

options

Options

  • provider - name of the Oidcc.ProviderConfiguration.Worker
  • client_id - OAuth Client ID to use for the introspection
  • client_secret - OAuth Client Secret to use for the introspection
  • userinfo_retrieve_opts - Options to pass to userinfo loading
  • send_inactive_token_response - Customize Error Response for inactive token
  • cache - Cache userinfo response - See Oidcc.Plug.Cache