View Source Oidcc.ProviderConfiguration.Worker (Oidcc v3.2.0)

OIDC Config Provider Worker

Loads and continuously refreshes the OIDC configuration and JWKs

Usage in Supervisor

Supervisor.init([
  {Oidcc.ProviderConfiguration.Worker, %{issuer: "https://accounts.google.com"}}
], strategy: :one_for_one)

Summary

Types

opts()

See t:oidcc_provider_configuration_worker.opts/0

Functions

child_spec(opts)

get_jwks(name)

Get Parsed Jwks

get_provider_configuration(name)

Get Configuration

refresh_configuration(name)

Refresh Configuration

refresh_jwks(name)

Refresh JWKs

refresh_jwks_for_unknown_kid(name, kid)

Refresh JWKs if the provided Kid is not matching any currently loaded keys

start_link(opts)

Start Configuration Worker

Types

opts()

(since 3.0.0)

@type opts() :: %{
  optional(:name) => GenServer.name(),
  :issuer => :uri_string.uri_string(),
  optional(:provider_configuration_opts) => :oidcc_provider_configuration.opts()
}

See t:oidcc_provider_configuration_worker.opts/0

Functions

child_spec(opts)

(since 3.0.0)

@spec child_spec(opts :: :oidcc_provider_configuration_worker.opts()) ::
  Supervisor.child_spec()

get_jwks(name)

(since 3.0.0)

@spec get_jwks(name :: GenServer.name()) :: JOSE.JWK.t()

Get Parsed Jwks

Examples

iex> {:ok, pid} =
...>   Oidcc.ProviderConfiguration.Worker.start_link(%{
...>   issuer: "https://accounts.google.com"
...> })
...> %JOSE.JWK{} =
...>   Oidcc.ProviderConfiguration.Worker.get_jwks(pid)

get_provider_configuration(name)

(since 3.0.0)

@spec get_provider_configuration(name :: GenServer.name()) ::
  Oidcc.ProviderConfiguration.t()

Get Configuration

Examples

iex> {:ok, pid} =
...>   Oidcc.ProviderConfiguration.Worker.start_link(%{
...>   issuer: "https://accounts.google.com"
...> })
...> %Oidcc.ProviderConfiguration{issuer: "https://accounts.google.com"} =
...>   Oidcc.ProviderConfiguration.Worker.get_provider_configuration(pid)

refresh_configuration(name)

(since 3.0.0)

@spec refresh_configuration(name :: GenServer.name()) :: :ok

Refresh Configuration

Examples

iex> {:ok, pid} =
...>   Oidcc.ProviderConfiguration.Worker.start_link(%{
...>   issuer: "https://accounts.google.com"
...> })
...> :ok = Oidcc.ProviderConfiguration.Worker.refresh_configuration(pid)

refresh_jwks(name)

(since 3.0.0)

@spec refresh_jwks(name :: GenServer.name()) :: :ok

Refresh JWKs

Examples

iex> {:ok, pid} =
...>   Oidcc.ProviderConfiguration.Worker.start_link(%{
...>   issuer: "https://accounts.google.com"
...> })
...> :ok = Oidcc.ProviderConfiguration.Worker.refresh_jwks(pid)

refresh_jwks_for_unknown_kid(name, kid)

(since 3.0.0)

@spec refresh_jwks_for_unknown_kid(name :: GenServer.name(), kid :: String.t()) :: :ok

Refresh JWKs if the provided Kid is not matching any currently loaded keys

Examples

iex> {:ok, pid} =
...>   Oidcc.ProviderConfiguration.Worker.start_link(%{
...>   issuer: "https://accounts.google.com"
...> })
...> :ok = Oidcc.ProviderConfiguration.Worker.refresh_jwks_for_unknown_kid(pid, "kid")

start_link(opts)

(since 3.0.0)

@spec start_link(opts :: :oidcc_provider_configuration_worker.opts()) ::
  GenServer.on_start()

Start Configuration Worker

Examples

iex> {:ok, _pid} =
...>   Oidcc.ProviderConfiguration.Worker.start_link(%{
...>   issuer: "https://accounts.google.com",
...>   name: __MODULE__.GoogleConfigProvider
...> })