Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check Issuer on Config Load #240

Merged
merged 1 commit into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ init(_Args) ->
```elixir
{:ok, _pid} =
Oidcc.ProviderConfiguration.Worker.start_link(%{
issuer: "https://accounts.google.com/",
issuer: "https://accounts.google.com",
name: Myapp.OidccConfigProvider
})
```
Expand Down
14 changes: 7 additions & 7 deletions lib/oidcc.ex
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ defmodule Oidcc do

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

or via a supervisor

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

## Global Configuration
Expand All @@ -30,7 +30,7 @@ defmodule Oidcc do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com/"
...> issuer: "https://accounts.google.com"
...> })
...>
...> {:ok, _redirect_uri} =
Expand Down Expand Up @@ -65,7 +65,7 @@ defmodule Oidcc do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://login.yahoo.com"
...> issuer: "https://api.login.yahoo.com"
...> })
...>
...> # Get auth_code fromm redirect
Expand Down Expand Up @@ -108,7 +108,7 @@ defmodule Oidcc do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://login.yahoo.com"
...> issuer: "https://api.login.yahoo.com"
...> })
...>
...> # Get refresh_token fromm redirect
Expand Down Expand Up @@ -164,7 +164,7 @@ defmodule Oidcc do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://login.yahoo.com"
...> issuer: "https://api.login.yahoo.com"
...> })
...>
...> Oidcc.introspect_token(
Expand Down Expand Up @@ -218,7 +218,7 @@ defmodule Oidcc do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://login.yahoo.com"
...> issuer: "https://api.login.yahoo.com"
...> })
...>
...> # Get access_token from Oidcc.Token.retrieve/3
Expand Down
2 changes: 1 addition & 1 deletion lib/oidcc/authorization.ex
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ defmodule Oidcc.Authorization do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com/"
...> issuer: "https://accounts.google.com"
...> })
...>
...> {:ok, client_context} =
Expand Down
2 changes: 1 addition & 1 deletion lib/oidcc/client_context.ex
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ defmodule Oidcc.ClientContext do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com/",
...> issuer: "https://accounts.google.com",
...> name: __MODULE__.GoogleConfigProvider
...> })
...>
Expand Down
14 changes: 7 additions & 7 deletions lib/oidcc/provider_configuration/worker.ex
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ defmodule Oidcc.ProviderConfiguration.Worker do

```elixir
Supervisor.init([
{Oidcc.ProviderConfiguration.Worker, %{issuer: "https://accounts.google.com/"}}
{Oidcc.ProviderConfiguration.Worker, %{issuer: "https://accounts.google.com"}}
], strategy: :one_for_one)
```
"""
Expand All @@ -33,7 +33,7 @@ defmodule Oidcc.ProviderConfiguration.Worker do

iex> {:ok, _pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com/",
...> issuer: "https://accounts.google.com",
...> name: __MODULE__.GoogleConfigProvider
...> })
"""
Expand Down Expand Up @@ -64,7 +64,7 @@ defmodule Oidcc.ProviderConfiguration.Worker do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com/"
...> issuer: "https://accounts.google.com"
...> })
...> %Oidcc.ProviderConfiguration{issuer: "https://accounts.google.com"} =
...> Oidcc.ProviderConfiguration.Worker.get_provider_configuration(pid)
Expand All @@ -84,7 +84,7 @@ defmodule Oidcc.ProviderConfiguration.Worker do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com/"
...> issuer: "https://accounts.google.com"
...> })
...> %JOSE.JWK{} =
...> Oidcc.ProviderConfiguration.Worker.get_jwks(pid)
Expand All @@ -104,7 +104,7 @@ defmodule Oidcc.ProviderConfiguration.Worker do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com/"
...> issuer: "https://accounts.google.com"
...> })
...> :ok = Oidcc.ProviderConfiguration.Worker.refresh_configuration(pid)
"""
Expand All @@ -120,7 +120,7 @@ defmodule Oidcc.ProviderConfiguration.Worker do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com/"
...> issuer: "https://accounts.google.com"
...> })
...> :ok = Oidcc.ProviderConfiguration.Worker.refresh_jwks(pid)
"""
Expand All @@ -136,7 +136,7 @@ defmodule Oidcc.ProviderConfiguration.Worker do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com/"
...> issuer: "https://accounts.google.com"
...> })
...> :ok = Oidcc.ProviderConfiguration.Worker.refresh_jwks_for_unknown_kid(pid, "kid")
"""
Expand Down
6 changes: 3 additions & 3 deletions lib/oidcc/token.ex
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ defmodule Oidcc.Token do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://login.yahoo.com"
...> issuer: "https://api.login.yahoo.com"
...> })
...>
...> {:ok, client_context} =
Expand Down Expand Up @@ -172,7 +172,7 @@ defmodule Oidcc.Token do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://login.yahoo.com"
...> issuer: "https://api.login.yahoo.com"
...> })
...>
...> {:ok, client_context} =
Expand Down Expand Up @@ -228,7 +228,7 @@ defmodule Oidcc.Token do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://login.yahoo.com"
...> issuer: "https://api.login.yahoo.com"
...> })
...>
...> {:ok, client_context} =
Expand Down
2 changes: 1 addition & 1 deletion lib/oidcc/token_introspection.ex
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ defmodule Oidcc.TokenIntrospection do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://login.yahoo.com"
...> issuer: "https://api.login.yahoo.com"
...> })
...>
...> {:ok, client_context} =
Expand Down
2 changes: 1 addition & 1 deletion lib/oidcc/userinfo.ex
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ defmodule Oidcc.Userinfo do

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://login.yahoo.com"
...> issuer: "https://api.login.yahoo.com"
...> })
...>
...> {:ok, client_context} =
Expand Down
8 changes: 6 additions & 2 deletions src/oidcc_provider_configuration.erl
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
%% </ul>

-type t() ::
#oidcc_provider_configuration{

Check warning on line 46 in src/oidcc_provider_configuration.erl

View workflow job for this annotation

GitHub Actions / Docs / Generate

internal inconsistency, please submit bug: "uri_string:uri_string" != "'.'"

Check warning on line 46 in src/oidcc_provider_configuration.erl

View workflow job for this annotation

GitHub Actions / Docs / Generate

internal inconsistency, please submit bug: "uri_string:uri_string" != "'.'"

Check warning on line 46 in src/oidcc_provider_configuration.erl

View workflow job for this annotation

GitHub Actions / Docs / Generate

internal inconsistency, please submit bug: "uri_string:uri_string" != "'.'"

Check warning on line 46 in src/oidcc_provider_configuration.erl

View workflow job for this annotation

GitHub Actions / Docs / Generate

internal inconsistency, please submit bug: "uri_string:uri_string" != "'.'"
issuer :: uri_string:uri_string(),
authorization_endpoint :: uri_string:uri_string(),
token_endpoint :: uri_string:uri_string() | undefined,
Expand Down Expand Up @@ -119,6 +119,7 @@
| alg_no_none,
Field :: atom()
}}
| {issuer_mismatch, Issuer :: binary()}
| oidcc_http_util:error().

-define(DEFAULT_CONFIG_EXPIRY, timer:minutes(15)).
Expand Down Expand Up @@ -180,17 +181,20 @@
when
Issuer :: uri_string:uri_string(),
Opts :: opts().
load_configuration(Issuer, Opts) ->
load_configuration(Issuer0, Opts) ->
Issuer = binary:list_to_bin([Issuer0]),
TelemetryOpts = #{topic => [oidcc, load_configuration], extra_meta => #{issuer => Issuer}},
RequestOpts = maps:get(request_opts, Opts, #{}),
Request = {[Issuer, <<"/.well-known/openid-configuration">>], []},

maybe
{ok, {{json, ConfigurationMap}, Headers}} ?= oidcc_http_util:request(get, Request, TelemetryOpts, RequestOpts),
Expiry = headers_to_deadline(Headers, Opts),
{ok, Configuration} ?= decode_configuration(ConfigurationMap),
{ok, #oidcc_provider_configuration{issuer = Issuer} = Configuration}
?= decode_configuration(ConfigurationMap),
{ok, {Configuration, Expiry}}
else
{ok, #oidcc_provider_configuration{issuer = DifferentIssuer}} -> {error, {issuer_mismatch, DifferentIssuer}};
{error, Reason} -> {error, Reason};
{ok, {{_Format, _Body}, _Headers}} -> {error, invalid_content_type}
end.
Expand Down
34 changes: 30 additions & 4 deletions src/oidcc_provider_configuration_worker.erl
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,15 @@ get_jwks(Name) ->
%% @since 3.0.0
-spec refresh_configuration(Name :: gen_server:server_ref()) -> ok.
refresh_configuration(Name) ->
gen_server:cast(Name, refresh_configuration).
refresh_configuration(Name, true).

-spec refresh_configuration(Name :: gen_server:server_ref(), Synchronous :: boolean()) -> ok.
refresh_configuration(Name, false) ->
gen_server:cast(Name, refresh_configuration);
refresh_configuration(Name, true) ->
refresh_configuration(Name, false),
gen_server:call(Name, get_provider_configuration),
ok.

%% @doc Refresh JWKs
%%
Expand All @@ -239,8 +247,15 @@ refresh_configuration(Name) ->
%% @end
%% @since 3.0.0
-spec refresh_jwks(Name :: gen_server:server_ref()) -> ok.
refresh_jwks(Name) ->
gen_server:cast(Name, refresh_jwks).
refresh_jwks(Name) -> refresh_jwks(Name, true).

-spec refresh_jwks(Name :: gen_server:server_ref(), Synchronous :: boolean()) -> ok.
refresh_jwks(Name, false) ->
gen_server:cast(Name, refresh_jwks);
refresh_jwks(Name, true) ->
refresh_jwks(Name, false),
gen_server:call(Name, get_jwks),
ok.

%% @doc Refresh JWKs if the provided `Kid' is not matching any currently loaded keys
%%
Expand All @@ -259,7 +274,18 @@ refresh_jwks(Name) ->
-spec refresh_jwks_for_unknown_kid(Name :: gen_server:server_ref(), Kid :: binary()) ->
ok.
refresh_jwks_for_unknown_kid(Name, Kid) ->
gen_server:cast(Name, {refresh_jwks_for_unknown_kid, Kid}).
refresh_jwks_for_unknown_kid(Name, Kid, true).

-spec refresh_jwks_for_unknown_kid(
Name :: gen_server:server_ref(), Kid :: binary(), Synchronous :: boolean()
) ->
ok.
refresh_jwks_for_unknown_kid(Name, Kid, false) ->
gen_server:cast(Name, {refresh_jwks_for_unknown_kid, Kid});
refresh_jwks_for_unknown_kid(Name, Kid, true) ->
refresh_jwks_for_unknown_kid(Name, Kid, false),
gen_server:call(Name, get_jwks),
ok.

-spec get_issuer(Opts :: opts()) -> {ok, binary()} | {error, issuer_required}.
get_issuer(Opts) ->
Expand Down
2 changes: 1 addition & 1 deletion test/oidcc/authorization_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ defmodule Oidcc.AuthorizationTest do
test "works" do
pid =
start_supervised!(
{Oidcc.ProviderConfiguration.Worker, %{issuer: "https://accounts.google.com/"}}
{Oidcc.ProviderConfiguration.Worker, %{issuer: "https://accounts.google.com"}}
)

{:ok, client_context} =
Expand Down
2 changes: 1 addition & 1 deletion test/oidcc/client_context_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ defmodule Oidcc.ClientContextTest do
pid =
start_supervised!(
{Oidcc.ProviderConfiguration.Worker,
%{issuer: "https://accounts.google.com/", name: __MODULE__.GoogleProvider}}
%{issuer: "https://accounts.google.com", name: __MODULE__.GoogleProvider}}
)

assert {:ok, %Oidcc.ClientContext{}} =
Expand Down
12 changes: 6 additions & 6 deletions test/oidcc/provider_configuration/worker_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ defmodule Oidcc.ProviderConfiguration.WorkerTest do
describe inspect(&Worker.start_link/1) do
test "works" do
start_supervised!(
{Worker, %{issuer: "https://accounts.google.com/", name: __MODULE__.GoogleProvider}}
{Worker, %{issuer: "https://accounts.google.com", name: __MODULE__.GoogleProvider}}
)
end
end
Expand All @@ -18,7 +18,7 @@ defmodule Oidcc.ProviderConfiguration.WorkerTest do
test "works" do
pid =
start_supervised!(
{Worker, %{issuer: "https://accounts.google.com/", name: __MODULE__.GoogleProvider}}
{Worker, %{issuer: "https://accounts.google.com", name: __MODULE__.GoogleProvider}}
)

assert %ProviderConfiguration{issuer: "https://accounts.google.com"} =
Expand All @@ -29,7 +29,7 @@ defmodule Oidcc.ProviderConfiguration.WorkerTest do
describe inspect(&Worker.get_jwks/1) do
test "works" do
start_supervised!(
{Worker, %{issuer: "https://accounts.google.com/", name: __MODULE__.GoogleProvider}}
{Worker, %{issuer: "https://accounts.google.com", name: __MODULE__.GoogleProvider}}
)

assert %JOSE.JWK{} =
Expand All @@ -41,7 +41,7 @@ defmodule Oidcc.ProviderConfiguration.WorkerTest do
test "works" do
pid =
start_supervised!(
{Worker, %{issuer: "https://accounts.google.com/", name: __MODULE__.GoogleProvider}}
{Worker, %{issuer: "https://accounts.google.com", name: __MODULE__.GoogleProvider}}
)

assert :ok = Worker.refresh_configuration(pid)
Expand All @@ -52,7 +52,7 @@ defmodule Oidcc.ProviderConfiguration.WorkerTest do
test "works" do
pid =
start_supervised!(
{Worker, %{issuer: "https://accounts.google.com/", name: __MODULE__.GoogleProvider}}
{Worker, %{issuer: "https://accounts.google.com", name: __MODULE__.GoogleProvider}}
)

assert :ok = Worker.refresh_jwks(pid)
Expand All @@ -63,7 +63,7 @@ defmodule Oidcc.ProviderConfiguration.WorkerTest do
test "works" do
pid =
start_supervised!(
{Worker, %{issuer: "https://accounts.google.com/", name: __MODULE__.GoogleProvider}}
{Worker, %{issuer: "https://accounts.google.com", name: __MODULE__.GoogleProvider}}
)

assert :ok = Worker.refresh_jwks_for_unknown_kid(pid, "kid")
Expand Down
2 changes: 1 addition & 1 deletion test/oidcc_client_context_SUITE.erl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ all() ->
from_configuration_worker(_Config) ->
{ok, GoogleConfigurationPid} =
oidcc_provider_configuration_worker:start_link(#{
issuer => <<"https://accounts.google.com/">>,
issuer => <<"https://accounts.google.com">>,
name => {local, from_configuration_worker_oidcc_client_context_SUITE}
}),

Expand Down
Loading