rabbitmq-server/deps/rabbitmq_auth_backend_oauth2/test/unit_SUITE.erl

1550 lines
60 KiB
Erlang

%% This Source Code Form is subject to the terms of the Mozilla Public
%% License, v. 2.0. If a copy of the MPL was not distributed with this
%% file, You can obtain one at https://mozilla.org/MPL/2.0/.
%%
%% Copyright (c) 2007-2025 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
%%
-module(unit_SUITE).
-compile(export_all).
-include_lib("rabbit_common/include/rabbit.hrl").
-include_lib("common_test/include/ct.hrl").
-include_lib("eunit/include/eunit.hrl").
-include("oauth2.hrl").
-import(rabbit_auth_backend_oauth2, [
user_login_authentication/2,
user_login_authorization/2,
normalize_token_scope/2,
check_vhost_access/3,
extract_token_value/4,
extract_scope_list_from_token_value/2]).
-import(rabbit_oauth2_resource_server, [
new_resource_server/1
]).
all() ->
[
test_extract_scope_from_path_expression,
filter_matching_scope_prefix_and_drop_it,
normalize_token_scopes_with_scope_prefix,
normalize_token_scope_from_space_separated_list_in_scope_claim,
normalize_token_scope_without_scope_claim,
unsuccessful_access_without_scopes,
successful_access_with_a_token_with_variables_in_scopes,
successful_access_with_a_parsed_token,
test_successful_access_with_a_token_that_has_tag_scopes,
test_unsuccessful_access_with_a_bogus_token,
test_restricted_vhost_access_with_a_valid_token,
test_insufficient_permissions_in_a_valid_token,
test_token_expiration,
test_invalid_signature,
test_incorrect_kid,
normalize_token_scope_using_multiple_scopes_key,
normalize_token_scope_with_requesting_party_token_scopes,
normalize_token_scope_with_rich_auth_request,
normalize_token_scope_with_rich_auth_request_using_regular_expression_with_cluster,
test_unsuccessful_access_with_a_token_that_uses_missing_scope_alias_in_scope_field,
test_unsuccessful_access_with_a_token_that_uses_missing_scope_alias_in_extra_scope_source_field,
test_username_from,
{group, with_rabbitmq_node},
{group, with_resource_server_id}
].
groups() ->
[
{with_rabbitmq_node, [], [
test_command_json,
test_command_pem,
test_command_pem_no_kid
]
},
{with_resource_server_id, [], [
test_successful_access_with_a_token,
test_successful_access_with_a_token_that_uses_single_scope_alias_in_scope_field,
test_successful_access_with_a_token_that_uses_multiple_scope_aliases_in_scope_field,
test_successful_authorization_without_scopes,
test_successful_authentication_without_scopes,
test_successful_access_with_a_token_that_uses_single_scope_alias_with_var_expansion,
test_successful_access_with_a_token_that_uses_single_scope_alias_in_extra_scope_source_field,
test_successful_access_with_a_token_that_uses_multiple_scope_aliases_in_extra_scope_source_field,
normalize_token_scope_with_additional_scopes_complex_claims,
test_successful_access_with_a_token_that_uses_single_scope_alias_in_scope_field_and_custom_scope_prefix
]}
].
init_per_suite(Config) ->
application:load(rabbitmq_auth_backend_oauth2),
Env = application:get_all_env(rabbitmq_auth_backend_oauth2),
lists:foreach(fun({K, _V}) -> unset_env(K) end, Env),
rabbit_ct_helpers:run_setup_steps(Config, []).
end_per_suite(Config) ->
rabbit_ct_helpers:run_teardown_steps(Config).
init_per_group(with_rabbitmq_node, Config) ->
Config1 = rabbit_ct_helpers:set_config(Config, [
{rmq_nodename_suffix, signing_key_group},
{rmq_nodes_count, 1}
]),
Config2 = rabbit_ct_helpers:merge_app_env(
Config1, {rabbitmq_auth_backend_oauth2, [
{resource_server_id, <<"rabbitmq">>},
{key_config, [{default_key, <<"token-key">>}]}
]}),
rabbit_ct_helpers:run_steps(Config2, rabbit_ct_broker_helpers:setup_steps());
init_per_group(with_resource_server_id, Config) ->
set_env(resource_server_id, <<"rabbitmq">>),
Config;
init_per_group(_, Config) ->
Config.
end_per_group(with_rabbitmq_node, Config) ->
rabbit_ct_helpers:run_steps(Config, rabbit_ct_broker_helpers:teardown_steps());
end_per_group(_, Config) ->
application:unset_env(rabbitmq_auth_backend_oauth2, resource_server_id),
Config.
%%
%% Test Cases
%%
-define(UTIL_MOD, rabbit_auth_backend_oauth2_test_util).
-define(RESOURCE_SERVER_ID, <<"rabbitmq">>).
-define(RESOURCE_SERVER_TYPE, <<"rabbitmq-type">>).
-define(DEFAULT_SCOPE_PREFIX, <<"rabbitmq.">>).
normalize_token_scope_using_multiple_scopes_key(_) ->
Pairs = [
%% common case
{
"keycloak format 1, i.e. requesting party token",
#{<<"authorization">> =>
#{<<"permissions">> =>
[#{<<"rsid">> => <<"2c390fe4-02ad-41c7-98a2-cebb8c60ccf1">>,
<<"rsname">> => <<"allvhost">>,
<<"scopes">> => [<<"rabbitmq-resource.read:*/*">>]},
#{<<"rsid">> => <<"e7f12e94-4c34-43d8-b2b1-c516af644cee">>,
<<"rsname">> => <<"vhost1">>,
<<"scopes">> => [<<"rabbitmq-resource.write:vhost1/*">>]},
#{<<"rsid">> => <<"12ac3d1c-28c2-4521-8e33-0952eff10bd9">>,
<<"rsname">> => <<"Default Resource">>,
<<"scopes">> => [<<"unknown-resource.write:vhost1/*">>]}
]
}
},
[<<"read:*/*">>, <<"write:vhost1/*">>]
},
{
"keycloak format 2 using realm_access",
#{<<"realm_access">> =>
#{<<"roles">> => [<<"rabbitmq-resource.read:format2/*">>]}
},
[<<"read:format2/*">>]
},
{
"keycloak format 2 using resource_access",
#{<<"resource_access">> =>
#{<<"account">> => #{<<"roles">> => [<<"rabbitmq-resource.read:format2bis/*">>]} }
},
[<<"read:format2bis/*">>]
},
{
"both formats",
#{<<"authorization">> =>
#{<<"permissions">> =>
[#{<<"rsid">> => <<"2c390fe4-02ad-41c7-98a2-cebb8c60ccf1">>,
<<"rsname">> => <<"allvhost">>,
<<"scopes">> => [<<"rabbitmq-resource.read:*/*">>]},
#{<<"rsid">> => <<"e7f12e94-4c34-43d8-b2b1-c516af644cee">>,
<<"rsname">> => <<"vhost1">>,
<<"scopes">> => [<<"rabbitmq-resource.write:vhost1/*">>]},
#{<<"rsid">> => <<"12ac3d1c-28c2-4521-8e33-0952eff10bd9">>,
<<"rsname">> => <<"Default Resource">>,
<<"scopes">> => [<<"unknown-resource.write:vhost1/*">>]}
]
},
<<"realm_access">> =>
#{<<"roles">> => [<<"rabbitmq-resource.read:format2/*">>]},
<<"resource_access">> =>
#{<<"account">> => #{<<"roles">> => [<<"rabbitmq-resource.read:format2bis/*">>]} }
},
[<<"read:*/*">>, <<"write:vhost1/*">>, <<"read:format2/*">>, <<"read:format2bis/*">>]
}
],
lists:foreach(fun({Case, Token0, ExpectedScope}) ->
ResourceServer0 = new_resource_server(<<"rabbitmq-resource">>),
ResourceServer = ResourceServer0#resource_server{
additional_scopes_key = <<"authorization.permissions.scopes realm_access.roles resource_access.account.roles">>
},
Token = normalize_token_scope(ResourceServer, Token0),
?assertEqual(lists:sort(ExpectedScope), lists:sort(uaa_jwt:get_scope(Token)), Case)
end, Pairs).
normalize_token_scope_with_requesting_party_token_scopes(_) ->
Pairs = [
%% common case
{
"common case",
#{<<"permissions">> =>
[#{<<"rsid">> => <<"2c390fe4-02ad-41c7-98a2-cebb8c60ccf1">>,
<<"rsname">> => <<"allvhost">>,
<<"scopes">> => [<<"rabbitmq-resource.read:*/*">>]},
#{<<"rsid">> => <<"e7f12e94-4c34-43d8-b2b1-c516af644cee">>,
<<"rsname">> => <<"vhost1">>,
<<"scopes">> => [<<"rabbitmq-resource.write:vhost1/*">>]},
#{<<"rsid">> => <<"12ac3d1c-28c2-4521-8e33-0952eff10bd9">>,
<<"rsname">> => <<"Default Resource">>,
<<"scopes">> => [<<"unknown-resource.write:vhost1/*">>]}
]
},
[<<"read:*/*">>, <<"write:vhost1/*">>]
},
{
"one scopes field with a string instead of an array",
#{<<"permissions">> =>
[#{<<"rsid">> => <<"2c390fe4-02ad-41c7-98a2-cebb8c60ccf1">>,
<<"rsname">> => <<"allvhost">>,
<<"scopes">> => <<"rabbitmq-resource.read:*/*">>},
#{<<"rsid">> => <<"e7f12e94-4c34-43d8-b2b1-c516af644cee">>,
<<"rsname">> => <<"vhost1">>,
<<"scopes">> => [<<"unknown-resource-read">>]},
#{<<"rsid">> => <<"12ac3d1c-28c2-4521-8e33-0952eff10bd9">>,
<<"rsname">> => <<"Default Resource">>}]},
[<<"read:*/*">>]
},
{
"no scopes field in permissions",
#{<<"permissions">> =>
[#{<<"rsid">> => <<"2c390fe4-02ad-41c7-98a2-cebb8c60ccf1">>,
<<"rsname">> => <<"allvhost">>},
#{<<"rsid">> => <<"e7f12e94-4c34-43d8-b2b1-c516af644cee">>,
<<"rsname">> => <<"vhost1">>},
#{<<"rsid">> => <<"12ac3d1c-28c2-4521-8e33-0952eff10bd9">>,
<<"rsname">> => <<"Default Resource">>}]},
[]
},
{
"no permissions",
#{<<"permissions">> => []},
[]
},
{"missing permissions key", #{}, []}
],
lists:foreach(fun({Case, Authorization, ExpectedScope}) ->
ResourceServer0 = new_resource_server(<<"rabbitmq-resource">>),
Token0 = #{<<"authorization">> => Authorization},
Token = normalize_token_scope(ResourceServer0, Token0),
?assertEqual(ExpectedScope, uaa_jwt:get_scope(Token), Case)
end, Pairs).
normalize_token_scope_with_rich_auth_request_using_regular_expression_with_cluster(_) ->
Pairs = [
{ "should filter out those permisions whose locations do not refer to cluster : {resource_server_id}",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq-test">>],
<<"actions">> => [<<"read">>]
},
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq-other">>],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*/*">> ]
},
{ "can use regular expression on any location's attribute ",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq-*/vhost:^finance-*">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:^finance-*/*/*">> ]
},
{ "should filter out any location which does not match the cluster's pattern ",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq-t-*/vhost:^finance-*">>,
<<"cluster:^rabbitmq$/vhost:^finance-*">> ],
<<"actions">> => [<<"read">>]
}
],
[]
}
],
lists:foreach(
fun({Case, Permissions, ExpectedScope}) ->
ResourceServer0 = new_resource_server(<<"rabbitmq-test">>),
ResourceServer = ResourceServer0#resource_server{
resource_server_type = ?RESOURCE_SERVER_TYPE
},
Token0 = #{<<"authorization_details">> => Permissions},
Token = normalize_token_scope(ResourceServer, Token0),
?assertEqual(lists:sort(ExpectedScope),
lists:sort(uaa_jwt:get_scope(Token)), Case)
end, Pairs).
normalize_token_scope_with_rich_auth_request(_) ->
Pairs = [
{ "should merge all permissions for the current cluster",
[
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:finance/vhost:primary-*">>],
<<"actions">> => [<<"configure">>]
},
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq">>],
<<"actions">> => [<<"management">> ]
},
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq">>],
<<"actions">> => [<<"administrator">> ]
}
],
[ <<"tag:management">>, <<"tag:administrator">> ]
},
{ "should filter out those permisions whose type does not match <resource_server_type>",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq">>],
<<"actions">> => [<<"read">>]
},
#{<<"type">> => <<"unknown">>,
<<"locations">> => [<<"cluster:rabbitmq">>],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*/*">> ]
},
{ "should filter out those permisions whose type is the empty string",
[
#{<<"type">> => <<>>,
<<"locations">> => [<<"cluster:rabbitmq">>],
<<"actions">> => [<<"read">>]
}
],
[ ]
},
{ "should filter out those permisions with empty string action",
[
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq">>],
<<"actions">> => <<>>
}
],
[ ]
},
{ "should filter out those permisions whose locations do not refer to cluster : {resource_server_id}",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq">>],
<<"actions">> => [<<"read">>]
},
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq-other">>],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*/*">> ]
},
{ "should filter out those permisions whose locations' regexpr do not match the cluster : {resource_server_id} ",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbit*">>],
<<"actions">> => [<<"read">>]
},
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:*">>],
<<"actions">> => [<<"write">>]
},
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq-other">>],
<<"actions">> => [<<"configure">>]
}
],
[<<"read:*/*/*">>, <<"write:*/*/*">> ]
},
{ "should ignore permissions without actions",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq">>]
},
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbit*">>],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*/*">>]
},
{ "should ignore permissions without locations",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"actions">> => [<<"read">>]
}
],
[]
},
{ "should ignore unknown actions",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq">>],
<<"actions">> => [<<"read2">>, <<"read">>]
}
],
[<<"read:*/*/*">> ]
},
{ "should filter out locations with permissions not meant for {resource_server_id}",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq">>, <<"cluster:unknown">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*/*">> ]
},
{ "should produce a scope for every (action, location) permutation for all locations meant for {resource_server_id}",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [
<<"cluster:rabbitmq/vhost:a">>,
<<"cluster:rabbitmq/vhost:b">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:a/*/*">>, <<"read:b/*/*">> ]
},
{ "should support all known user tags ",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [
<<"cluster:rabbitmq/vhost:a">>, <<"cluster:rabbitmq/vhost:b">>,
<<"cluster:other">> ],
<<"actions">> => [
<<"management">>, <<"policymaker">>, <<"management">>,
<<"monitoring">>]
}
],
[<<"tag:management">>, <<"tag:policymaker">>,
<<"tag:monitoring">> ]
},
{ "should produce a scope for every user tag action but only for the clusters that match {resource_server_id}",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [
<<"cluster:rabbitmq/vhost:a">>, <<"cluster:rabbitmq/vhost:b">>,
<<"cluster:other">> ],
<<"actions">> => [<<"management">>, <<"policymaker">>]
}
],
[<<"tag:management">>, <<"tag:policymaker">> ]
},
{ "should produce as scope for every location meant for {resource_server_id} multiplied by actions",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [
<<"cluster:rabbitmq/vhost:a">>, <<"cluster:rabbitmq/vhost:b">> ],
<<"actions">> => [<<"read">>, <<"write">>]
}
],
[<<"read:a/*/*">>, <<"read:b/*/*">>, <<"write:a/*/*">>, <<"write:b/*/*">> ]
},
{ "should accept single value locations",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => <<"cluster:rabbitmq">>,
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*/*">> ]
},
{ "should accept single value actions",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => <<"cluster:rabbitmq">>,
<<"actions">> => <<"read">>
}
],
[<<"read:*/*/*">> ]
},
{ "should merge all scopes produced by each permission",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq/vhost:a">> ],
<<"actions">> => [<<"read">>]
},
#{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq/vhost:b">> ],
<<"actions">> => [<<"write">>]
}
],
[<<"read:a/*/*">>, <<"write:b/*/*">> ]
},
{ "can grant permission to a queue in any virtual host",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq/queue:b">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/b/*">> ]
},
{ "can grant permission to an exchange in any virtual host",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq/exchange:b">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/b/*">> ]
},
{ "cannot specify both exchange and queue unless they have the same value",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq/queue:b/exchange:c">> ],
<<"actions">> => [<<"read">>]
}
],
[]
},
{ "can specify exchange and queue when have same value",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq/queue:*/exchange:*">> ],
<<"actions">> => [<<"read">>]
}
],
[ <<"read:*/*/*">> ]
},
{ "can specify routing-key only -> on any vhost and on any queue if that makes sense ",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq/routing-key:b">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*/b">> ]
},
{ "can specify vhost, queue or exchange and routing-key that combine fixed values and wildcards",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [
<<"cluster:rabbitmq/vhost:finance-*/queue:*-invoice/routing-key:r-*">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:finance-*/*-invoice/r-*">> ]
},
{ "should ignore any location's attribute other than the supported ones",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [
<<"cluster:rabbitmq/unknown:finance-*/queue:*-invoice/routing-key:r-*">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*-invoice/r-*">> ]
},
{ "should not matter the location's attributes order",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq/queue:invoices/vhost:finance/routing-key:r-*">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:finance/invoices/r-*">> ]
},
{ "should ignore locations like //",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq//routing-key:r-*">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*/r-*">> ]
},
{ "should default to wildcard those attributes with empty value",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [
<<"cluster:rabbitmq/queue:/vhost:/routing-key:r-*">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:*/*/r-*">> ]
},
{ "should ignore any location path element which is not compliant with <key>:<value> format",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [
<<"some-prefix-value/cluster:rabbitmq/vhost:finance-*/queue:*-invoice/routing-key:r-*">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:finance-*/*-invoice/r-*">> ]
},
{ "can use regular expression on any location's attribute",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => [<<"cluster:rabbitmq/vhost:^finance-*">> ],
<<"actions">> => [<<"read">>]
}
],
[<<"read:^finance-*/*/*">> ]
},
{ "can use single string value for location",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => <<"cluster:rabbitmq/vhost:^finance-*">>,
<<"actions">> => [<<"read">>]
}
],
[<<"read:^finance-*/*/*">> ]
},
{ "can use single string value for action",
[ #{<<"type">> => ?RESOURCE_SERVER_TYPE,
<<"locations">> => <<"cluster:rabbitmq/vhost:^finance-*">>,
<<"actions">> => <<"read">>
}
],
[<<"read:^finance-*/*/*">> ]
},
{ "should ignore empty permission lists",
[],
[]
}
],
lists:foreach(fun({Case, Permissions, ExpectedScope0}) ->
ResourceServer0 = new_resource_server(?RESOURCE_SERVER_ID),
ResourceServer = ResourceServer0#resource_server{
resource_server_type = ?RESOURCE_SERVER_TYPE
},
Token0 = #{<<"authorization_details">> => Permissions},
Token = normalize_token_scope(ResourceServer, Token0),
ExpectedScopes = lists:sort(ExpectedScope0),
ActualScopes = lists:sort(uaa_jwt:get_scope(Token)),
?assertEqual(ExpectedScopes, ActualScopes, Case)
end, Pairs).
normalize_token_scope_with_additional_scopes_complex_claims(_) ->
Pairs = [
{
"claims in form of binary",
<<"rabbitmq.rabbitmq-resource.read:*/* rabbitmq.rabbitmq-resource-read">>,
[<<"read:*/*">>]
},
{"claims in form of binary - empty result", <<>>, []},
{
"claims in form of list",
[<<"rabbitmq.rabbitmq-resource.read:*/*">>,
<<"rabbitmq2.rabbitmq-resource-read">>],
[<<"read:*/*">>]
},
{"claims in form of list - empty result", [], []},
{
"claims are map with list content",
#{<<"rabbitmq">> =>
[<<"rabbitmq-resource.read:*/*">>,
<<"rabbitmq-resource-read">>],
<<"rabbitmq3">> =>
[<<"rabbitmq-resource.write:*/*">>,
<<"rabbitmq-resource-write">>]},
[<<"read:*/*">>]
},
{
"claims are map with list content - empty result",
#{<<"rabbitmq2">> =>
[<<"rabbitmq-resource.read:*/*">>,
<<"rabbitmq-resource-read">>]},
[]
},
{
"claims are map with binary content",
#{ <<"rabbitmq">> => <<"rabbitmq-resource.read:*/* rabbitmq-resource-read">>,
<<"rabbitmq3">> => <<"rabbitmq-resource.write:*/* rabbitmq-resource-write">>},
[<<"read:*/*">>]
},
{
"claims are map with binary content - empty result",
#{<<"rabbitmq2">> => <<"rabbitmq-resource.read:*/* rabbitmq-resource-read">>}, []
},
{
"claims are map with empty binary content - empty result",
#{<<"rabbitmq">> => <<>>}, []
},
{
"claims are map with empty list content - empty result",
#{<<"rabbitmq">> => []}, []
},
{
"no extra claims provided",
[], []
},
{
"no extra claims provided", #{}, []
}],
lists:foreach(fun({Case, Authorization, ExpectedScope0}) ->
ResourceServer0 = new_resource_server(?RESOURCE_SERVER_ID),
ResourceServer = ResourceServer0#resource_server{
scope_prefix = <<"rabbitmq.rabbitmq-resource.">>,
additional_scopes_key = <<"custom-key">>
},
Token0 = #{<<"custom-key">> => Authorization},
Token = normalize_token_scope(ResourceServer, Token0),
ExpectedScopes = lists:sort(ExpectedScope0),
ActualScopes = lists:sort(uaa_jwt:get_scope(Token)),
?assertEqual(ExpectedScopes, ActualScopes, Case)
end, Pairs).
test_successful_authentication_without_scopes(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
application:set_env(rabbitmq_auth_backend_oauth2, key_config, UaaEnv),
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:fixture_token(), Username), Jwk),
{ok, #auth_user{username = Username} } =
user_login_authentication(Username, [{password, Token}]).
test_successful_authorization_without_scopes(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:fixture_token(), Username), Jwk),
{ok, _ } = user_login_authorization(Username, [{password, Token}]).
test_successful_access_with_a_token(_) ->
%% Generate a token with JOSE
%% Check authorization with the token
%% Check user access granted by token
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
VHost = <<"vhost">>,
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(
?UTIL_MOD:token_with_sub(?UTIL_MOD:fixture_token(), Username), Jwk),
{ok, #auth_user{username = Username} = User} =
user_login_authentication(Username, [{password, Token}]),
?assertEqual(true, check_vhost_access(User, <<"vhost">>, none)),
assert_resource_access_granted(User, VHost, <<"foo">>, configure),
assert_resource_access_granted(User, VHost, <<"foo">>, write),
assert_resource_access_granted(User, VHost, <<"bar">>, read),
assert_resource_access_granted(User, VHost, custom, <<"bar">>, read),
assert_topic_access_granted(User, VHost, <<"bar">>, read,
#{routing_key => <<"#/foo">>}).
successful_access_with_a_token_with_variables_in_scopes(_) ->
%% Generate a token with JOSE
%% Check authorization with the token
%% Check user access granted by token
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
VHost = <<"my-vhost">>,
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(
?UTIL_MOD:token_with_sub(?UTIL_MOD:fixture_token(
[<<"rabbitmq.read:{vhost}/*/{sub}">>]), Username),
Jwk),
{ok, #auth_user{username = Username} = User} =
user_login_authentication(Username, #{password => Token}),
assert_topic_access_granted(User, VHost, <<"bar">>, read,
#{routing_key => Username}).
successful_access_with_a_parsed_token(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(
?UTIL_MOD:token_with_sub(?UTIL_MOD:fixture_token(), Username), Jwk),
{ok, #auth_user{impl = Impl} } =
user_login_authentication(Username, [{password, Token}]),
{ok, _ } =
user_login_authentication(Username, [{rabbit_auth_backend_oauth2, Impl}]).
test_successful_access_with_a_token_that_has_tag_scopes(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(
?UTIL_MOD:token_with_sub(?UTIL_MOD:fixture_token(
[<<"rabbitmq.tag:management">>, <<"rabbitmq.tag:policymaker">>]),
Username), Jwk),
{ok, #auth_user{username = Username, tags = [management, policymaker]}} =
user_login_authentication(Username, [{password, Token}]).
test_successful_access_with_a_token_that_uses_single_scope_alias_with_var_expansion(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
Alias = <<"client-alias-1">>,
set_env(scope_aliases, #{
Alias => [
<<"rabbitmq.configure:{vhost}/q-{sub}/rk-{client_id}**">>
]
}),
VHost = <<"vhost">>,
Username = <<"bob">>,
ClientId = <<"rmq">>,
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:token_with_claim(
?UTIL_MOD:token_with_scope_alias_in_scope_field(Alias), <<"client_id">>, ClientId),
Username), Jwk),
{ok, #auth_user{username = Username} = AuthUser} =
user_login_authentication(Username, [{password, Token}]),
%% vhost access
assert_vhost_access_granted(AuthUser, ClientId),
%% resource access
assert_resource_access_denied(AuthUser, VHost, <<"none">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"q-bob">>, configure),
%% topic access
assert_topic_access_refused(AuthUser, VHost, <<"q-bob">>, configure,
#{routing_key => <<"rk-r2mq/#">>}),
assert_topic_access_granted(AuthUser, VHost, <<"q-bob">>, configure,
#{routing_key => <<"rk-rmq/#">>}),
application:unset_env(rabbitmq_auth_backend_oauth2, scope_aliases),
application:unset_env(rabbitmq_auth_backend_oauth2, key_config).
test_successful_access_with_a_token_that_uses_single_scope_alias_in_scope_field(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
Alias = <<"client-alias-1">>,
set_env(scope_aliases, #{
Alias => [
<<"rabbitmq.configure:vhost/one">>,
<<"rabbitmq.write:vhost/two">>,
<<"rabbitmq.read:vhost/one">>,
<<"rabbitmq.read:vhost/two">>,
<<"rabbitmq.read:vhost/two/abc">>,
<<"rabbitmq.tag:management">>,
<<"rabbitmq.tag:custom">>
]
}),
VHost = <<"vhost">>,
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:token_with_scope_alias_in_scope_field(Alias), Username), Jwk),
{ok, #auth_user{username = Username} = AuthUser} =
user_login_authentication(Username, [{password, Token}]),
assert_vhost_access_granted(AuthUser, VHost),
assert_vhost_access_denied(AuthUser, <<"some-other-vhost">>),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, configure),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, write),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, configure),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, write),
application:unset_env(rabbitmq_auth_backend_oauth2, scope_aliases),
application:unset_env(rabbitmq_auth_backend_oauth2, key_config).
test_successful_access_with_a_token_that_uses_single_scope_alias_in_scope_field_and_custom_scope_prefix(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
set_env(scope_prefix, <<>>),
Alias = <<"client-alias-1">>,
set_env(scope_aliases, #{
Alias => [
<<"configure:vhost/one">>,
<<"write:vhost/two">>,
<<"read:vhost/one">>,
<<"read:vhost/two">>,
<<"read:vhost/two/abc">>,
<<"tag:management">>,
<<"tag:custom">>
]
}),
VHost = <<"vhost">>,
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:token_with_scope_alias_in_scope_field(Alias), Username), Jwk),
{ok, #auth_user{username = Username} = AuthUser} =
user_login_authentication(Username, [{password, Token}]),
assert_vhost_access_granted(AuthUser, VHost),
assert_vhost_access_denied(AuthUser, <<"some-other-vhost">>),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, configure),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, write),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, configure),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, write),
application:unset_env(rabbitmq_auth_backend_oauth2, scope_aliases),
application:unset_env(rabbitmq_auth_backend_oauth2, key_config),
application:unset_env(rabbitmq_auth_backend_oauth2, scope_prefix).
test_successful_access_with_a_token_that_uses_multiple_scope_aliases_in_scope_field(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
Role1 = <<"client-aliases-1">>,
Role2 = <<"client-aliases-2">>,
Role3 = <<"client-aliases-3">>,
set_env(scope_aliases, #{
Role1 => [
<<"rabbitmq.configure:vhost/one">>,
<<"rabbitmq.tag:management">>
],
Role2 => [
<<"rabbitmq.write:vhost/two">>
],
Role3 => [
<<"rabbitmq.read:vhost/one">>,
<<"rabbitmq.read:vhost/two">>,
<<"rabbitmq.read:vhost/two/abc">>,
<<"rabbitmq.tag:custom">>
]
}),
VHost = <<"vhost">>,
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:token_with_scope_alias_in_scope_field([Role1, Role2, Role3]),
Username), Jwk),
{ok, #auth_user{username = Username} = AuthUser} =
user_login_authentication(Username, [{password, Token}]),
assert_vhost_access_granted(AuthUser, VHost),
assert_vhost_access_denied(AuthUser, <<"some-other-vhost">>),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, configure),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, write),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, configure),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, write),
application:unset_env(rabbitmq_auth_backend_oauth2, scope_aliases),
application:unset_env(rabbitmq_auth_backend_oauth2, key_config).
test_unsuccessful_access_with_a_token_that_uses_missing_scope_alias_in_scope_field(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
set_env(resource_server_id, <<"rabbitmq">>),
Alias = <<"client-alias-33">>,
set_env(scope_aliases, #{
<<"non-existent-alias-23948sdkfjsdof8">> => [
<<"rabbitmq.configure:vhost/one">>,
<<"rabbitmq.write:vhost/two">>,
<<"rabbitmq.read:vhost/one">>,
<<"rabbitmq.read:vhost/two">>,
<<"rabbitmq.read:vhost/two/abc">>
]
}),
VHost = <<"vhost">>,
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:token_with_scope_alias_in_scope_field(Alias), Username), Jwk),
{ok, AuthUser} = user_login_authentication(Username, [{password, Token}]),
assert_vhost_access_denied(AuthUser, VHost),
assert_vhost_access_denied(AuthUser, <<"some-other-vhost">>),
assert_resource_access_denied(AuthUser, VHost, <<"one">>, configure),
assert_resource_access_denied(AuthUser, VHost, <<"one">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"two">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"two">>, write),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, configure),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, write),
application:unset_env(rabbitmq_auth_backend_oauth2, scope_aliases),
application:unset_env(rabbitmq_auth_backend_oauth2, key_config),
application:unset_env(rabbitmq_auth_backend_oauth2, resource_server_id).
test_successful_access_with_a_token_that_uses_single_scope_alias_in_extra_scope_source_field(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
set_env(extra_scopes_source, <<"claims">>),
Alias = <<"client-alias-1">>,
set_env(scope_aliases, #{
Alias => [
<<"rabbitmq.configure:vhost/one">>,
<<"rabbitmq.write:vhost/two">>,
<<"rabbitmq.read:vhost/one">>,
<<"rabbitmq.read:vhost/two">>,
<<"rabbitmq.read:vhost/two/abc">>
]
}),
VHost = <<"vhost">>,
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:token_with_scope_alias_in_claim_field(Alias, [<<"unrelated">>]),
Username), Jwk),
{ok, AuthUser} = user_login_authentication(Username, [{password, Token}]),
assert_vhost_access_granted(AuthUser, VHost),
assert_vhost_access_denied(AuthUser, <<"some-other-vhost">>),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, configure),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, write),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, configure),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, write),
application:unset_env(rabbitmq_auth_backend_oauth2, scope_aliases),
application:unset_env(rabbitmq_auth_backend_oauth2, key_config).
test_successful_access_with_a_token_that_uses_multiple_scope_aliases_in_extra_scope_source_field(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
set_env(extra_scopes_source, <<"claims">>),
Role1 = <<"client-aliases-1">>,
Role2 = <<"client-aliases-2">>,
Role3 = <<"client-aliases-3">>,
set_env(scope_aliases, #{
Role1 => [
<<"rabbitmq.configure:vhost/one">>
],
Role2 => [
<<"rabbitmq.write:vhost/two">>
],
Role3 => [
<<"rabbitmq.read:vhost/one">>,
<<"rabbitmq.read:vhost/two">>,
<<"rabbitmq.read:vhost/two/abc">>
]
}),
VHost = <<"vhost">>,
Username = <<"username">>,
Claims = [Role1, Role2, Role3],
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:token_with_scope_alias_in_claim_field(Claims, [<<"unrelated">>]),
Username), Jwk),
{ok, AuthUser} = user_login_authentication(Username, [{password, Token}]),
assert_vhost_access_granted(AuthUser, VHost),
assert_vhost_access_denied(AuthUser, <<"some-other-vhost">>),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, configure),
assert_resource_access_granted(AuthUser, VHost, <<"one">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, read),
assert_resource_access_granted(AuthUser, VHost, <<"two">>, write),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, configure),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, write),
application:unset_env(rabbitmq_auth_backend_oauth2, scope_aliases),
application:unset_env(rabbitmq_auth_backend_oauth2, key_config).
test_unsuccessful_access_with_a_token_that_uses_missing_scope_alias_in_extra_scope_source_field(_) ->
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
set_env(extra_scopes_source, <<"claims">>),
set_env(resource_server_id, <<"rabbitmq">>),
Alias = <<"client-alias-11">>,
set_env(scope_aliases, #{
<<"non-existent-client-alias-9238923789">> => [
<<"rabbitmq.configure:vhost/one">>,
<<"rabbitmq.write:vhost/two">>,
<<"rabbitmq.read:vhost/one">>,
<<"rabbitmq.read:vhost/two">>,
<<"rabbitmq.read:vhost/two/abc">>
]
}),
VHost = <<"vhost">>,
Username = <<"username">>,
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:token_with_scope_alias_in_claim_field(Alias, [<<"unrelated">>]),
Username), Jwk),
{ok, AuthUser} = user_login_authentication(Username, [{password, Token}]),
assert_vhost_access_denied(AuthUser, VHost),
assert_vhost_access_denied(AuthUser, <<"some-other-vhost">>),
assert_resource_access_denied(AuthUser, VHost, <<"one">>, configure),
assert_resource_access_denied(AuthUser, VHost, <<"one">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"two">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"two">>, write),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, configure),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, read),
assert_resource_access_denied(AuthUser, VHost, <<"three">>, write),
application:unset_env(rabbitmq_auth_backend_oauth2, scope_aliases),
application:unset_env(rabbitmq_auth_backend_oauth2, key_config),
application:unset_env(rabbitmq_auth_backend_oauth2, resource_server_id).
test_unsuccessful_access_with_a_bogus_token(_) ->
Username = <<"username">>,
set_env(resource_server_id, <<"rabbitmq">>),
Jwk0 = ?UTIL_MOD:fixture_jwk(),
Jwk = Jwk0#{<<"k">> => <<"bm90b2tlbmtleQ">>},
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
?assertMatch({refused, _, _}, user_login_authentication(Username,
[{password, <<"not a token">>}])).
unsuccessful_access_without_scopes(_) ->
Username = <<"username">>,
set_env(resource_server_id, <<"rabbitmq">>),
Jwk = ?UTIL_MOD:fixture_jwk(),
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:token_without_scopes(), Username), Jwk),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
{ok, #auth_user{username = Username, tags = [], impl = _CredentialsFun }
= AuthUser} = user_login_authentication(Username, [{password, Token}]),
assert_vhost_access_denied(AuthUser, <<"vhost">>).
test_restricted_vhost_access_with_a_valid_token(_) ->
Username = <<"username">>,
set_env(resource_server_id, <<"rabbitmq">>),
Jwk = ?UTIL_MOD:fixture_jwk(),
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:fixture_token(), Username), Jwk),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
%% this user can authenticate successfully and access certain vhosts
{ok, #auth_user{username = Username, tags = []} = User} =
user_login_authentication(Username, [{password, Token}]),
%% access to a different vhost
?assertEqual(false, check_vhost_access(User, <<"different vhost">>, none)).
test_insufficient_permissions_in_a_valid_token(_) ->
VHost = <<"vhost">>,
Username = <<"username">>,
set_env(resource_server_id, <<"rabbitmq">>),
Jwk = ?UTIL_MOD:fixture_jwk(),
Token = ?UTIL_MOD:sign_token_hs(?UTIL_MOD:token_with_sub(
?UTIL_MOD:fixture_token(), Username), Jwk),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
{ok, #auth_user{username = Username} = User} =
user_login_authentication(Username, [{password, Token}]),
%% access to these resources is not granted
assert_resource_access_denied(User, VHost, <<"foo1">>, configure),
assert_resource_access_denied(User, VHost, <<"bar">>, write),
assert_topic_access_refused(User, VHost, <<"bar">>, read,
#{routing_key => <<"foo/#">>}).
test_invalid_signature(_) ->
Username = <<"username">>,
Jwk = ?UTIL_MOD:fixture_jwk(),
WrongJwk = ?UTIL_MOD:fixture_jwk("wrong", <<"GawgguFyGrWKav7AX4VKUg">>),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, WrongJwk}}}],
set_env(key_config, UaaEnv),
set_env(resource_server_id, <<"rabbitmq">>),
TokenData = ?UTIL_MOD:token_with_sub(?UTIL_MOD:expirable_token(), Username),
Token = ?UTIL_MOD:sign_token_hs(TokenData, Jwk),
?assertMatch({refused, _, [signature_invalid]},
user_login_authentication(Username, [{password, Token}])).
test_token_expiration(_) ->
VHost = <<"vhost">>,
Username = <<"username">>,
Jwk = ?UTIL_MOD:fixture_jwk(),
UaaEnv = [{signing_keys, #{<<"token-key">> => {map, Jwk}}}],
set_env(key_config, UaaEnv),
set_env(resource_server_id, <<"rabbitmq">>),
TokenData = ?UTIL_MOD:token_with_sub(?UTIL_MOD:expirable_token(), Username),
Token = ?UTIL_MOD:sign_token_hs(TokenData, Jwk),
{ok, #auth_user{username = Username} = User} =
user_login_authentication(Username, [{password, Token}]),
assert_resource_access_granted(User, VHost, <<"foo">>, configure),
assert_resource_access_granted(User, VHost, <<"foo">>, write),
Now = os:system_time(seconds),
ExpiryTs = rabbit_auth_backend_oauth2:expiry_timestamp(User),
?assert(ExpiryTs > (Now - 10)),
?assert(ExpiryTs < (Now + 10)),
?UTIL_MOD:wait_for_token_to_expire(),
#{<<"exp">> := Exp} = TokenData,
ExpectedError = "Provided JWT token has expired at timestamp " ++
integer_to_list(Exp) ++ " (validated at " ++ integer_to_list(Exp) ++ ")",
assert_resource_access_errors(ExpectedError, User, VHost, <<"foo">>, configure),
?assertMatch({refused, _, _},
user_login_authentication(Username, [{password, Token}])).
test_incorrect_kid(_) ->
AltKid = <<"other-token-key">>,
Username = <<"username">>,
Jwk = ?UTIL_MOD:fixture_jwk(),
unset_env(key_config),
set_env(resource_server_id, <<"rabbitmq">>),
Token = ?UTIL_MOD:sign_token_hs(
?UTIL_MOD:token_with_sub(?UTIL_MOD:fixture_token(), Username), Jwk,
AltKid, true),
?assertMatch(
{refused, "Authentication using an OAuth 2/JWT token failed: ~tp",
[{error,{missing_oauth_provider_attributes, [issuer]}}]},
user_login_authentication(Username, #{password => Token})).
login_and_check_vhost_access(Username, Token, Vhost) ->
{ok, #auth_user{username = Username} = User} =
user_login_authentication(Username, #{password => Token}),
?assertEqual(true, check_vhost_access(User, <<"vhost">>, Vhost)).
test_command_json(Config) ->
Username = <<"username">>,
Jwk = ?UTIL_MOD:fixture_jwk(),
Json = rabbit_json:encode(Jwk),
'Elixir.RabbitMQ.CLI.Ctl.Commands.AddUaaKeyCommand':run(
[<<"token-key">>],
#{node => rabbit_ct_broker_helpers:get_node_config(Config, 0, nodename),
json => Json}),
Token = ?UTIL_MOD:sign_token_hs(
?UTIL_MOD:token_with_sub(?UTIL_MOD:fixture_token(), Username), Jwk),
rabbit_ct_broker_helpers:rpc(Config, 0, unit_SUITE,
login_and_check_vhost_access, [Username, Token, none]).
test_username_from(_) ->
Pairs = [
{ <<"resolve username from 1st claim in the array of configured claims ">>,
[<<"user_name">>, <<"email">>],
#{
<<"user_name">> => <<"rabbit_user">>,
<<"email">> => <<"rabbit_user@">>
},
<<"rabbit_user">>
},
{ <<"resolve username from 2nd claim in the array of configured claims">>,
[<<"user_name">>, <<"email">>],
#{
<<"email">> => <<"rabbit_user">>
},
<<"rabbit_user">>
},
{ <<"resolve username from configured string claim ">>,
[<<"email">>],
#{
<<"email">> => <<"rabbit_user">>
},
<<"rabbit_user">>
},
{ <<"unresolve username">>,
[<<"user_name">>, <<"email">>],
#{
<<"email2">> => <<"rabbit_user">>
},
<<"unknown">>
}
],
lists:foreach(
fun(
{Comment, PreferredUsernameClaims, Token, ExpectedUsername}) ->
ActualUsername = rabbit_auth_backend_oauth2:username_from(
PreferredUsernameClaims, Token),
?assertEqual(ExpectedUsername, ActualUsername, Comment)
end,
Pairs).
test_command_pem_file(Config) ->
Username = <<"username">>,
CertsDir = ?config(rmq_certsdir, Config),
Keyfile = filename:join([CertsDir, "client", "key.pem"]),
Jwk = jose_jwk:from_pem_file(Keyfile),
PublicJwk = jose_jwk:to_public(Jwk),
PublicKeyFile = filename:join([CertsDir, "client", "public.pem"]),
jose_jwk:to_pem_file(PublicKeyFile, PublicJwk),
'Elixir.RabbitMQ.CLI.Ctl.Commands.AddUaaKeyCommand':run(
[<<"token-key">>],
#{node => rabbit_ct_broker_helpers:get_node_config(
Config, 0, nodename), pem_file => PublicKeyFile}),
Token = ?UTIL_MOD:sign_token_rsa(?UTIL_MOD:fixture_token(),
Jwk, <<"token-key">>),
rabbit_ct_broker_helpers:rpc(Config, 0, unit_SUITE,
login_and_check_vhost_access, [Username, Token, none]).
test_command_pem(Config) ->
Username = <<"username">>,
CertsDir = ?config(rmq_certsdir, Config),
Keyfile = filename:join([CertsDir, "client", "key.pem"]),
Jwk = jose_jwk:from_pem_file(Keyfile),
Pem = jose_jwk:to_pem(jose_jwk:to_public(Jwk)),
'Elixir.RabbitMQ.CLI.Ctl.Commands.AddUaaKeyCommand':run(
[<<"token-key">>],
#{node => rabbit_ct_broker_helpers:get_node_config(
Config, 0, nodename), pem => Pem}),
Token = ?UTIL_MOD:sign_token_rsa(?UTIL_MOD:token_with_sub(
?UTIL_MOD:fixture_token(), Username), Jwk, <<"token-key">>),
rabbit_ct_broker_helpers:rpc(Config, 0, unit_SUITE,
login_and_check_vhost_access, [Username, Token, none]).
test_command_pem_no_kid(Config) ->
Username = <<"username">>,
CertsDir = ?config(rmq_certsdir, Config),
Keyfile = filename:join([CertsDir, "client", "key.pem"]),
Jwk = jose_jwk:from_pem_file(Keyfile),
Pem = jose_jwk:to_pem(jose_jwk:to_public(Jwk)),
'Elixir.RabbitMQ.CLI.Ctl.Commands.AddUaaKeyCommand':run(
[<<"token-key">>],
#{node => rabbit_ct_broker_helpers:get_node_config(Config, 0, nodename),
pem => Pem}),
Token = ?UTIL_MOD:sign_token_no_kid(?UTIL_MOD:token_with_sub(
?UTIL_MOD:fixture_token(), Username), Jwk),
rabbit_ct_broker_helpers:rpc(Config, 0, unit_SUITE,
login_and_check_vhost_access, [Username, Token, none]).
filter_matching_scope_prefix_and_drop_it(_) ->
Examples = [
{<<"foo.">>, [<<"foo">>, <<"foo.bar">>, <<"bar.foo">>,
<<"one.two">>, <<"foobar">>, <<"foo.other.third">>],
[<<"bar">>, <<"other.third">>]},
{<<"foo.">>, [], []},
{<<"foo.">>, [<<"foo">>, <<"other.foo.bar">>], []},
{<<"">>, [<<"foo">>, <<"bar">>], [<<"foo">>, <<"bar">>]}
],
lists:map(
fun({ScopePrefix, Src, Dest}) ->
Dest = rabbit_oauth2_scope:filter_matching_scope_prefix_and_drop_it(
Src, ScopePrefix)
end,
Examples).
normalize_token_scopes_with_scope_prefix(_) ->
Scenarios = [
{
<<"">>,
#{
?SCOPE_JWT_FIELD => [<<"foo">>, <<"foo.bar">>, <<"foo.other.third">> ]
},
[<<"foo">>, <<"foo.bar">>, <<"foo.other.third">> ]
},
{
<<"some-prefix::">>,
#{
?SCOPE_JWT_FIELD => [
<<"some-prefix::foo">>, <<"foo.bar">>,
<<"some-prefix::other.third">> ]
},
[<<"foo">>, <<"other.third">>]
}
],
lists:map(fun({ ScopePrefix, Token0, ExpectedScopes}) ->
ResourceServer0 = new_resource_server(?RESOURCE_SERVER_ID),
ResourceServer = ResourceServer0#resource_server {
scope_prefix = ScopePrefix
},
Token = normalize_token_scope(ResourceServer, Token0),
?assertEqual(ExpectedScopes, uaa_jwt:get_scope(Token))
end, Scenarios).
normalize_token_scope_from_space_separated_list_in_scope_claim(_) ->
ResourceServer = new_resource_server(?RESOURCE_SERVER_ID),
Token0 = #{
?SCOPE_JWT_FIELD => <<"foo rabbitmq.bar bar.foo one.two foobar rabbitmq.other.third">>
},
Token = normalize_token_scope(ResourceServer, Token0),
?assertEqual([<<"bar">>, <<"other.third">>], uaa_jwt:get_scope(Token)).
normalize_token_scope_without_scope_claim(_) ->
ResourceServer = new_resource_server(?RESOURCE_SERVER_ID),
Token0 = #{ },
?assertEqual([], uaa_jwt:get_scope(normalize_token_scope(ResourceServer, Token0))).
test_extract_scope_from_path_expression(_) ->
M = fun rabbit_auth_backend_oauth2:extract_scope_list_from_token_value/2,
R = #resource_server{id = <<"rabbitmq">>},
[<<"role1">>] = extract_token_value(R,
#{ <<"auth">> => #{ <<"permission">> => <<"role1">> }},
<<"auth.permission">>, M),
[<<"role1">>,<<"role2">>] = extract_token_value(R,
#{ <<"auth">> => #{ <<"permission">> => [<<"role1">>,<<"role2">>] }},
<<"auth.permission">>, M),
[<<"role1">>,<<"role2">>] = extract_token_value(R,
#{ <<"auth">> => #{ <<"permission">> => <<"role1 role2">> }},
<<"auth.permission">>, M),
[<<"rabbitmq.role1">>,<<"rabbitmq.role2">>] = extract_token_value(R,
#{ <<"auth">> => #{
<<"rabbitmq">> => [<<"role1">>,<<"role2">>]
}},
<<"auth">>, M),
[<<"rabbitmq.role1">>,<<"rabbitmq.role2">>] = extract_token_value(R,
#{ <<"auth">> => #{
<<"rabbitmq">> => <<"role1 role2">>
}},
<<"auth">>, M),
%% this is the old keycloak format
[<<"role1">>,<<"role2">>] = extract_token_value(R,
#{ <<"auth">> => #{
<<"permission">> => [
#{ <<"scopes">> => <<"role1">>},
#{ <<"scopes">> => <<"role2">>}
]
}},
<<"auth.permission.scopes">>, M),
[<<"role1">>,<<"role2">>] = extract_token_value(R,
#{ <<"auth">> => #{
<<"permission">> => [
#{ <<"scopes">> => [<<"role1">>]},
#{ <<"scopes">> => [<<"role2">>]}
]
}},
<<"auth.permission.scopes">>, M),
[<<"role1">>,<<"role2">>] = extract_token_value(R,
#{ <<"auth">> => [
#{ <<"permission">> => [
#{ <<"scopes">> => [<<"role1">>]}
]},
#{ <<"permission">> => [
#{ <<"scopes">> => [<<"role2">>]}
]}
]},
<<"auth.permission.scopes">>, M),
[<<"role1">>] = extract_token_value(R,
#{ <<"auth">> => #{ <<"permission">> => [<<"role1">>] }},
<<"auth.permission">>, M),
[] = extract_token_value(R,
#{ <<"auth">> => #{ <<"permission">> => [<<"role1">>] }},
<<"auth.permission2">>, M),
[] = extract_token_value(R,
#{ <<"auth">> => #{ <<"permission">> => [<<"role1">>] }},
<<"auth2.permission">>, M),
[] = extract_token_value(R,
#{ <<"auth">> => #{ <<"permission">> => [<<"role1">>] }},
<<"auth.permission2">>, M).
%%
%% Helpers
%%
set_env(Par, Var) ->
application:set_env(rabbitmq_auth_backend_oauth2, Par, Var).
unset_env(Par) ->
application:unset_env(rabbitmq_auth_backend_oauth2, Par).
assert_vhost_access_granted(AuthUser, VHost) ->
assert_vhost_access_response(true, AuthUser, VHost).
assert_vhost_access_denied(AuthUser, VHost) ->
assert_vhost_access_response(false, AuthUser, VHost).
assert_vhost_access_response(ExpectedResult, AuthUser, VHost) ->
?assertEqual(ExpectedResult,
check_vhost_access(AuthUser, VHost, none)).
assert_resource_access_granted(AuthUser, VHost, ResourceName, PermissionKind) ->
assert_resource_access_response(true, AuthUser, VHost, ResourceName,
PermissionKind).
assert_resource_access_denied(AuthUser, VHost, ResourceName, PermissionKind) ->
assert_resource_access_response(false, AuthUser, VHost, ResourceName,
PermissionKind).
assert_resource_access_errors(ExpectedError, AuthUser, VHost, ResourceName,
PermissionKind) ->
assert_resource_access_response({error, ExpectedError}, AuthUser, VHost,
ResourceName, PermissionKind).
assert_resource_access_response(ExpectedResult, AuthUser, VHost, ResourceName,
PermissionKind) ->
?assertEqual(ExpectedResult,
rabbit_auth_backend_oauth2:check_resource_access(
AuthUser,
rabbit_misc:r(VHost, queue, ResourceName),
PermissionKind, #{})).
assert_resource_access_granted(AuthUser, VHost, ResourceKind, ResourceName,
PermissionKind) ->
assert_resource_access_response(true, AuthUser, VHost, ResourceKind,
ResourceName, PermissionKind).
assert_resource_access_denied(AuthUser, VHost, ResourceKind, ResourceName,
PermissionKind) ->
assert_resource_access_response(false, AuthUser, VHost, ResourceKind,
ResourceName, PermissionKind).
assert_resource_access_errors(ExpectedError, AuthUser, VHost, ResourceKind,
ResourceName, PermissionKind) ->
assert_resource_access_response({error, ExpectedError}, AuthUser, VHost,
ResourceKind, ResourceName, PermissionKind).
assert_resource_access_response(ExpectedResult, AuthUser, VHost, ResourceKind,
ResourceName, PermissionKind) ->
?assertEqual(ExpectedResult,
rabbit_auth_backend_oauth2:check_resource_access(
AuthUser,
rabbit_misc:r(VHost, ResourceKind, ResourceName),
PermissionKind, #{})).
assert_topic_access_granted(AuthUser, VHost, ResourceName, PermissionKind,
AuthContext) ->
assert_topic_access_response(true, AuthUser, VHost, ResourceName,
PermissionKind, AuthContext).
assert_topic_access_refused(AuthUser, VHost, ResourceName, PermissionKind,
AuthContext) ->
assert_topic_access_response(false, AuthUser, VHost, ResourceName,
PermissionKind, AuthContext).
assert_topic_access_response(ExpectedResult, AuthUser, VHost, ResourceName,
PermissionKind, AuthContext) ->
?assertEqual(ExpectedResult,
rabbit_auth_backend_oauth2:check_topic_access(
AuthUser,
#resource{virtual_host = VHost,
kind = topic,
name = ResourceName},
PermissionKind,
AuthContext)).