Skip to content
Open
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: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ A security audit was performed by [SAFE-Erlang-Elixir](https://github.com/SAFE-E
* [PKCE](https://oauth.net/2/pkce/)
* [Pushed Authorization Requests](https://datatracker.ietf.org/doc/html/rfc9126)
* [Authorization Server Issuer Identification](https://datatracker.ietf.org/doc/html/rfc9207)
(via `oidcc_authorization:validate_iss_parameter/2`; automatic in
[`oidcc_plug`](https://hex.pm/packages/oidcc_plug))
* Token
* Authorization: `client_secret_basic`, `client_secret_post`,
`client_secret_jwt`, and `private_key_jwt`
Expand Down
39 changes: 39 additions & 0 deletions lib/oidcc/authorization.ex
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,43 @@ defmodule Oidcc.Authorization do
client_context
|> ClientContext.struct_to_record()
|> :oidcc_authorization.create_redirect_url(opts)

@doc """
Validate the `iss` parameter of an authorization response (RFC 9207)

Call with the `iss` query parameter of the callback (`nil` if absent) before
`Oidcc.Token.retrieve/3`. See `:oidcc_authorization.validate_iss_parameter/2`
for the rules.

## Examples

iex> {:ok, pid} =
...> Oidcc.ProviderConfiguration.Worker.start_link(%{
...> issuer: "https://accounts.google.com"
...> })
...>
...> {:ok, client_context} =
...> Oidcc.ClientContext.from_configuration_worker(
...> pid,
...> "client_id",
...> "client_secret"
...> )
...>
...> Oidcc.Authorization.validate_iss_parameter(
...> "https://accounts.google.com",
...> client_context
...> )
:ok
"""
@doc since: "3.10.0"
@spec validate_iss_parameter(
iss :: String.t() | nil,
client_context :: ClientContext.t()
) :: :ok | {:error, :oidcc_authorization.iss_error()}
def validate_iss_parameter(iss, client_context) do
:oidcc_authorization.validate_iss_parameter(
iss || :undefined,
ClientContext.struct_to_record(client_context)
)
end
end
57 changes: 57 additions & 0 deletions src/oidcc_authorization.erl
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@
-include_lib("jose/include/jose_jwk.hrl").

-export([create_redirect_url/2]).
-export([validate_iss_parameter/2]).

-export_type([error/0]).
-export_type([iss_error/0]).
-export_type([opts/0]).

-doc """
Expand Down Expand Up @@ -66,6 +68,11 @@ See https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest.
| {url_extension_conflict, [binary()]}
| oidcc_http_util:error().

-doc #{since => <<"3.10.0">>}.
-type iss_error() ::
missing_iss_parameter
| {invalid_iss_parameter, Iss :: binary()}.

-telemetry_event(#{
event => [oidcc, par_request, start],
description => <<"Emitted at the start of executing a PAR request">>,
Expand Down Expand Up @@ -133,6 +140,56 @@ create_redirect_url(#oidcc_client_context{} = ClientContext, Opts) ->
{error, {grant_type_not_supported, authorization_code}}
end.

-doc """
Validate the `iss` parameter of an authorization response.

See https://datatracker.ietf.org/doc/html/rfc9207.

Call with the `iss` query parameter of the callback (`undefined` if absent)
before `oidcc_token:retrieve/3`. A present `iss` must match the provider's
issuer (or `issuer_regex`). An absent one is rejected only if the provider
advertises `authorization_response_iss_parameter_supported`.

## Examples

```erlang
{ok, ClientContext} =
oidcc_client_context:from_configuration_worker(provider_name,
<<"client_id">>,
<<"client_secret">>),

%% Get Iss from Redirect

ok = oidcc_authorization:validate_iss_parameter(Iss, ClientContext).
```
""".
-doc #{since => <<"3.10.0">>}.
-spec validate_iss_parameter(Iss, ClientContext) -> ok | {error, iss_error()} when
Iss :: binary() | undefined,
ClientContext :: oidcc_client_context:t().
validate_iss_parameter(undefined, #oidcc_client_context{
provider_configuration = #oidcc_provider_configuration{
authorization_response_iss_parameter_supported = true
}
}) ->
{error, missing_iss_parameter};
validate_iss_parameter(undefined, #oidcc_client_context{}) ->
ok;
validate_iss_parameter(Iss, #oidcc_client_context{
provider_configuration = #oidcc_provider_configuration{
issuer = Issuer, issuer_regex = IssuerRegex
}
}) when is_binary(Iss) ->
Valid =
case IssuerRegex of
undefined -> Iss =:= Issuer;
Pattern -> re:run(Iss, Pattern, [{capture, none}]) =:= match
end,
case Valid of
true -> ok;
false -> {error, {invalid_iss_parameter, Iss}}
end.

-spec redirect_params(ClientContext, Opts) -> {ok, oidcc_http_util:query_params()} when
ClientContext :: oidcc_client_context:t(),
Opts :: opts().
Expand Down
29 changes: 29 additions & 0 deletions test/oidcc/authorization_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,33 @@ defmodule Oidcc.AuthorizationTest do
)
end
end

describe inspect(&Authorization.validate_iss_parameter/2) do
test "works" do
pid =
start_supervised!(
{Oidcc.ProviderConfiguration.Worker, %{issuer: "https://accounts.google.com"}}
)

{:ok, client_context} =
Oidcc.ClientContext.from_configuration_worker(pid, "client_id", "client_secret")

assert {:error, {:invalid_iss_parameter, "https://attacker.example.com"}} =
Authorization.validate_iss_parameter(
"https://attacker.example.com",
client_context
)

required_client_context = %{
client_context
| provider_configuration: %{
client_context.provider_configuration
| authorization_response_iss_parameter_supported: true
}
}

assert {:error, :missing_iss_parameter} =
Authorization.validate_iss_parameter(nil, required_client_context)
end
end
end
76 changes: 76 additions & 0 deletions test/oidcc_authorization_test.erl
Original file line number Diff line number Diff line change
Expand Up @@ -1254,3 +1254,79 @@ parse_query_string(UriString) ->
#{query := QueryStringBinary} = uri_string:parse(UriString),
QueryList = uri_string:dissect_query(QueryStringBinary),
maps:from_list(QueryList).

validate_iss_parameter_test() ->
PrivDir = code:priv_dir(oidcc),

{ok, ValidConfigString} = file:read_file(PrivDir ++ "/test/fixtures/example-metadata.json"),
{ok, #oidcc_provider_configuration{issuer = Issuer} = Configuration} =
oidcc_provider_configuration:decode_configuration(json:decode(ValidConfigString)),
Jwks = jose_jwk:from_pem_file(PrivDir ++ "/test/fixtures/jwk.pem"),

ClientContext = oidcc_client_context:from_manual(
Configuration#oidcc_provider_configuration{
authorization_response_iss_parameter_supported = false
},
Jwks,
<<"client_id">>,
<<"client_secret">>
),
IssRequiredClientContext = oidcc_client_context:from_manual(
Configuration#oidcc_provider_configuration{
authorization_response_iss_parameter_supported = true
},
Jwks,
<<"client_id">>,
<<"client_secret">>
),
RegexClientContext = oidcc_client_context:from_manual(
Configuration#oidcc_provider_configuration{
issuer_regex = <<"^https://tenant-[a-z]+\\.example\\.com$">>
},
Jwks,
<<"client_id">>,
<<"client_secret">>
),

%% Matching issuer, advertised or not
?assertEqual(ok, oidcc_authorization:validate_iss_parameter(Issuer, ClientContext)),
?assertEqual(
ok, oidcc_authorization:validate_iss_parameter(Issuer, IssRequiredClientContext)
),

%% Mismatching issuer is rejected even when the provider does not advertise support
?assertEqual(
{error, {invalid_iss_parameter, <<"https://attacker.example.com">>}},
oidcc_authorization:validate_iss_parameter(
<<"https://attacker.example.com">>, ClientContext
)
),
?assertEqual(
{error, {invalid_iss_parameter, <<"https://attacker.example.com">>}},
oidcc_authorization:validate_iss_parameter(
<<"https://attacker.example.com">>, IssRequiredClientContext
)
),

%% Absent parameter is only rejected when the provider advertises support
?assertEqual(ok, oidcc_authorization:validate_iss_parameter(undefined, ClientContext)),
?assertEqual(
{error, missing_iss_parameter},
oidcc_authorization:validate_iss_parameter(undefined, IssRequiredClientContext)
),

%% issuer_regex quirk
?assertEqual(
ok,
oidcc_authorization:validate_iss_parameter(
<<"https://tenant-a.example.com">>, RegexClientContext
)
),
?assertEqual(
{error, {invalid_iss_parameter, <<"https://tenant-a.example.com.attacker.com">>}},
oidcc_authorization:validate_iss_parameter(
<<"https://tenant-a.example.com.attacker.com">>, RegexClientContext
)
),

ok.