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

Validate arguments to validate_jwt fn #422

Merged
merged 1 commit into from
Feb 21, 2025
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
6 changes: 5 additions & 1 deletion lib/oidcc/token.ex
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,10 @@ defmodule Oidcc.Token do
Useful if the issuer is shared between multiple applications, and the access token
generated for a user at one client is used to validate their access at another client.

Validating an arbitrary JWT token (not an ID token) is not covered by the OpenID
Connect specification. Therefore the signing / encryption algorithms are not
derieved from the provider configuration, but must be provided by the caller.

## Examples

iex> {:ok, pid} =
Expand All @@ -324,7 +328,7 @@ defmodule Oidcc.Token do
...> "client_secret"
...> )
...>
...> #Get JWT from Authorization header
...> # Get JWT from Authorization header
...> jwt = "jwt"
...>
...> opts = %{
Expand Down
18 changes: 18 additions & 0 deletions src/oidcc_token.erl
Original file line number Diff line number Diff line change
Expand Up @@ -958,6 +958,10 @@ Validates a generic JWT (such as an access token) from the given provider.
Useful if the issuer is shared between multiple applications, and the access token
generated for a user at one client is used to validate their access at another client.

Validating an arbitrary JWT token (not an ID token) is not covered by the OpenID
Connect specification. Therefore the signing / encryption algorithms are not
derieved from the provider configuration, but must be provided by the caller.

## Examples

```erlang
Expand All @@ -966,6 +970,12 @@ generated for a user at one client is used to validate their access at another c
<<"client_id">>,
<<"client_secret">>),
%% Get Jwt from Authorization header
Jwt = <<"jwt">>,

Opts = #{
signing_algs => [<<"RS256">>]
},

{ok, Claims} =
oidcc:validate_jwt(Jwt, ClientContext, Opts).
```
Expand Down Expand Up @@ -995,6 +1005,14 @@ validate_jwt(Jwt, ClientContext, Opts) when is_map(Opts) ->
SigningAlgs = maps:get(signing_algs, Opts, []),
EncryptionAlgs = maps:get(encryption_algs, Opts, []),
EncryptionEncs = maps:get(encryption_encs, Opts, []),

case {SigningAlgs, EncryptionAlgs} of
{[], []} ->
error(badarg, [Jwt, ClientContext, Opts], []);
_ ->
ok
end,

ExpClaims = [{<<"iss">>, Issuer}],
Jwks1 =
case ClientJwks of
Expand Down
24 changes: 24 additions & 0 deletions test/oidcc/token_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -227,4 +227,28 @@ defmodule Oidcc.TokenTest do
)
end
end

describe inspect(&Oidcc.validate_jwt/3) do
test "throws badarg when leaving out signing & encryption parameters" do
pid =
start_supervised!(
{ProviderConfiguration.Worker, %{issuer: "https://erlef-test-w4a8z2.zitadel.cloud"}}
)

{:ok, client_context} =
ClientContext.from_configuration_worker(
pid,
@client_credentials_client_id,
@client_credentials_client_secret
)

assert_raise ArgumentError, fn ->
Oidcc.Token.validate_jwt(
"invalidtoken",
client_context,
%{}
)
end
end
end
end
4 changes: 2 additions & 2 deletions test/oidcc_token_test.erl
Original file line number Diff line number Diff line change
Expand Up @@ -2199,8 +2199,8 @@ validate_jwt_test() ->
oidcc_token:validate_jwt(JwtFun(WrongAudience), ClientContext, Opts)
),

?assertEqual(
{error, no_matching_key},
?assertError(
badarg,
oidcc_token:validate_jwt(JwtFun(WrongAudience), ClientContext, #{})
),

Expand Down
Loading