Skip to content

OAuth 2: support scope aliases in rabbitmq.conf #12439

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.

Sign up for GitHub

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

Merged
merged 9 commits into from
Oct 9, 2024
Merged

OAuth 2: support scope aliases in rabbitmq.conf #12439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cd46b40
Modify schema to include scope_aliases
MarcialRosales Oct 2, 2024
5841e37
Fix schema translation for
MarcialRosales Oct 2, 2024
dcb5263
Minor refactoring
MarcialRosales Oct 2, 2024
a30c829
Test translation function of scope_aliases
MarcialRosales Oct 2, 2024
48670a0
Support two modes of configuring
MarcialRosales Oct 3, 2024
3e81cfa
Handle wrong scope_aliases configuration
MarcialRosales Oct 3, 2024
b966ab7
Configure scope_aliases also per resource_server
MarcialRosales Oct 3, 2024
ebc3dea
Minor formatting improvement
MarcialRosales Oct 3, 2024
423b591
Fix failing test cases
MarcialRosales Oct 9, 2024
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
35 changes: 35 additions & 0 deletions deps/rabbitmq_auth_backend_oauth2/priv/schema/rabbitmq_auth_backend_oauth2.schema
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,26 @@
list_to_binary(cuttlefish:conf_get("auth_oauth2.additional_scopes_key", Conf))
end}.

{mapping,
"auth_oauth2.scope_aliases.$alias",
"rabbitmq_auth_backend_oauth2.scope_aliases",
[{datatype, string}]}.

{mapping,
"auth_oauth2.scope_aliases.$index.alias",
"rabbitmq_auth_backend_oauth2.scope_aliases",
[{datatype, string}]}.

{mapping,
"auth_oauth2.scope_aliases.$index.scope",
"rabbitmq_auth_backend_oauth2.scope_aliases",
[{datatype, string}]}.

{translation,
"rabbitmq_auth_backend_oauth2.scope_aliases",
fun(Conf) ->
rabbit_oauth2_schema:translate_scope_aliases(Conf)
end}.

%% Configure the plugin to skip validation of the aud field
%%
Expand Down Expand Up @@ -355,6 +375,21 @@
[{datatype, string}]
}.

{mapping,
"auth_oauth2.resource_servers.$name.scope_aliases.$alias",
"rabbitmq_auth_backend_oauth2.resource_servers",
[{datatype, string}]}.

{mapping,
"auth_oauth2.resource_servers.$name.scope_aliases.$index.alias",
"rabbitmq_auth_backend_oauth2.resource_servers",
[{datatype, string}]}.

{mapping,
"auth_oauth2.resource_servers.$name.scope_aliases.$index.scope",
"rabbitmq_auth_backend_oauth2.resource_servers",
[{datatype, string}]}.

{mapping,
"auth_oauth2.resource_servers.$name.oauth_provider_id",
"rabbitmq_auth_backend_oauth2.resource_servers",
Expand Down
161 changes: 134 additions & 27 deletions deps/rabbitmq_auth_backend_oauth2/src/rabbit_oauth2_schema.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,145 @@

-module(rabbit_oauth2_schema).

-define(AUTH_OAUTH2, "auth_oauth2").
-define(SCOPE_ALIASES, "scope_aliases").
-define(RESOURCE_SERVERS, "resource_servers").
-define(OAUTH_PROVIDERS, "oauth_providers").
-define(SIGNING_KEYS, "signing_keys").
-define(AUTH_OAUTH2_SCOPE_ALIASES, ?AUTH_OAUTH2 ++ "." ++ ?SCOPE_ALIASES).
-define(AUTH_OAUTH2_RESOURCE_SERVERS, ?AUTH_OAUTH2 ++ "." ++ ?RESOURCE_SERVERS).
-define(AUTH_OAUTH2_OAUTH_PROVIDERS, ?AUTH_OAUTH2 ++ "." ++ ?OAUTH_PROVIDERS).
-define(AUTH_OAUTH2_SIGNING_KEYS, ?AUTH_OAUTH2 ++ "." ++ ?SIGNING_KEYS).

-export([
translate_oauth_providers/1,
translate_resource_servers/1,
translate_signing_keys/1,
translate_endpoint_params/2
translate_endpoint_params/2,
translate_scope_aliases/1
]).

extract_key_as_binary({Name,_}) -> list_to_binary(Name).
extract_value({_Name,V}) -> V.

-spec translate_scope_aliases([{list(), binary()}]) -> map().
translate_scope_aliases(Conf) ->
Settings = cuttlefish_variable:filter_by_prefix(
?AUTH_OAUTH2_SCOPE_ALIASES, Conf),
maps:merge(extract_scope_alias_as_map(Settings),
extract_scope_aliases_as_list_of_alias_scope_props(Settings)).

convert_space_separated_string_to_list_of_binaries(String) ->
[ list_to_binary(V) || V <- string:tokens(String, " ")].

extract_scope_alias_as_map(Settings) ->
maps:from_list([{
list_to_binary(Alias),
convert_space_separated_string_to_list_of_binaries(Scope)
}
|| {[?AUTH_OAUTH2, ?SCOPE_ALIASES, Alias], Scope} <- Settings ]).

extract_scope_aliases_as_list_of_alias_scope_props(Settings) ->
KeyFun = fun extract_key_as_binary/1,
ValueFun = fun extract_value/1,

List0 = [{Index, {list_to_atom(Attr), V}}
|| {[?AUTH_OAUTH2, ?SCOPE_ALIASES, Index, Attr], V} <- Settings ],
List1 = maps:to_list(maps:groups_from_list(KeyFun, ValueFun, List0)),
List2 = [extract_scope_alias_mapping(Proplist) || {_, Proplist} <- List1],
maps:from_list([ V || V <- List2, V =/= {}]).

extract_scope_alias_mapping(Proplist) ->
Alias =
case proplists:get_value(alias, Proplist) of
undefined -> {error, missing_alias_attribute};
A -> list_to_binary(A)
end,
Scope =
case proplists:get_value(scope, Proplist) of
undefined -> {error, missing_scope_attribute};
S -> convert_space_separated_string_to_list_of_binaries(S)
end,
case {Alias, Scope} of
{{error, _}, _} ->
cuttlefish:warn(
"Skipped scope_aliases due to missing alias attribute"),
{};
{_, {error, _}} ->
cuttlefish:warn(
"Skipped scope_aliases due to missing scope attribute"),
{};
_ = V -> V
end.

extract_resource_server_scope_aliases_as_list_of_props(Settings) ->
KeyFun = fun extract_key_as_binary/1,
ValueFun = fun extract_value/1,

List0 = [
{
Name,
{Index, {list_to_atom(Attr), V}}
} ||
{[
?AUTH_OAUTH2, ?RESOURCE_SERVERS, Name, ?SCOPE_ALIASES,
Index, Attr
], V
} <- Settings ],
Map0 = maps:groups_from_list(KeyFun, ValueFun, List0),

Map4 = maps:map(fun (_, L) ->
Map2 = maps:map(fun (_, L2) -> extract_scope_alias_mapping(L2) end,
maps:groups_from_list(KeyFun, ValueFun, L)),
Map3 = maps:filter(fun (_,V) -> V =/= {} end, Map2),
[{scope_aliases, maps:from_list([ V || {_, V} <- maps:to_list(Map3)])}]
end, Map0),

Map4.

extract_resource_server_scope_aliases_as_map(Settings) ->
KeyFun = fun extract_key_as_binary/1,
ValueFun = fun extract_value/1,

List0 = [
{
Name,
{
list_to_binary(Alias),
convert_space_separated_string_to_list_of_binaries(Scope)
}
} ||
{[
?AUTH_OAUTH2, ?RESOURCE_SERVERS, Name, ?SCOPE_ALIASES,
Alias
], Scope
} <- Settings ],
Map0 = maps:groups_from_list(KeyFun, ValueFun, List0),
maps:map(fun (_, L) -> [{scope_aliases, maps:from_list(L)}] end, Map0).

-spec translate_resource_servers([{list(), binary()}]) -> map().
translate_resource_servers(Conf) ->
Settings = cuttlefish_variable:filter_by_prefix("auth_oauth2.resource_servers",
Conf),
Settings = cuttlefish_variable:filter_by_prefix(
?AUTH_OAUTH2_RESOURCE_SERVERS, Conf),
Map = merge_list_of_maps([
extract_resource_server_properties(Settings),
extract_resource_server_preferred_username_claims(Settings)
extract_resource_server_preferred_username_claims(Settings),
extract_resource_server_scope_aliases_as_list_of_props(Settings),
extract_resource_server_scope_aliases_as_map(Settings)
]),
Map0 = maps:map(fun(K,V) ->
case proplists:get_value(id, V) of
undefined -> V ++ [{id, K}];
_ -> V
end end, Map),
ResourceServers = maps:values(Map0),
lists:foldl(fun(Elem,AccMap) ->
maps:put(proplists:get_value(id, Elem), Elem, AccMap) end, #{},
ResourceServers).
lists:foldl(fun(Elem,AccMap)-> maps:put(proplists:get_value(id, Elem),
Elem, AccMap) end, #{}, ResourceServers).

-spec translate_oauth_providers([{list(), binary()}]) -> map().
translate_oauth_providers(Conf) ->
Settings = cuttlefish_variable:filter_by_prefix("auth_oauth2.oauth_providers",
Conf),
Settings = cuttlefish_variable:filter_by_prefix(
?AUTH_OAUTH2_OAUTH_PROVIDERS, Conf),

merge_list_of_maps([
extract_oauth_providers_properties(Settings),
Expand All @@ -52,8 +158,8 @@ translate_oauth_providers(Conf) ->

-spec translate_signing_keys([{list(), binary()}]) -> map().
translate_signing_keys(Conf) ->
Settings = cuttlefish_variable:filter_by_prefix("auth_oauth2.signing_keys",
Conf),
Settings = cuttlefish_variable:filter_by_prefix(
?AUTH_OAUTH2_SIGNING_KEYS, Conf),
ListOfKidPath = lists:map(fun({Id, Path}) -> {
list_to_binary(lists:last(Id)), Path} end, Settings),
translate_list_of_signing_keys(ListOfKidPath).
Expand All @@ -66,9 +172,9 @@ translate_list_of_signing_keys(ListOfKidPath) ->
{ok, Bin} ->
string:trim(Bin, trailing, "\n");
_Error ->
%% this throws and makes Cuttlefish treak the key as invalid
cuttlefish:invalid("file does not exist or cannot be " ++
"read by the node")
cuttlefish:invalid(io_lib:format(
"File ~p does not exist or cannot be read by the node",
[Path]))
end
end,
maps:map(fun(_K, Path) -> {pem, TryReadingFileFun(Path)} end,
Expand All @@ -87,7 +193,6 @@ validator_file_exists(Attr, Filename) ->
{ok, _} ->
Filename;
_Error ->
%% this throws and makes Cuttlefish treak the key as invalid
cuttlefish:invalid(io_lib:format(
"Invalid attribute (~p) value: file ~p does not exist or " ++
"cannot be read by the node", [Attr, Filename]))
Expand All @@ -111,21 +216,23 @@ validator_https_uri(Attr, Uri) when is_list(Uri) ->
true -> Uri;
false ->
cuttlefish:invalid(io_lib:format(
"Invalid attribute (~p) value: uri ~p must be a valid https uri",
[Attr, Uri]))
"Invalid attribute (~p) value: uri ~p must be a valid " ++
"https uri", [Attr, Uri]))
end.

merge_list_of_maps(ListOfMaps) ->
lists:foldl(fun(Elem, AccIn) -> maps:merge_with(fun(_K,V1,V2) -> V1 ++ V2 end,
Elem, AccIn) end, #{}, ListOfMaps).
lists:foldl(fun(Elem, AccIn) -> maps:merge_with(
fun(_K,V1,V2) -> V1 ++ V2 end, Elem, AccIn) end, #{}, ListOfMaps).

extract_oauth_providers_properties(Settings) ->
KeyFun = fun extract_key_as_binary/1,
ValueFun = fun extract_value/1,

OAuthProviders = [
{Name, mapOauthProviderProperty({list_to_atom(Key), list_to_binary(V)})}
|| {["auth_oauth2", "oauth_providers", Name, Key], V} <- Settings],
OAuthProviders = [{Name, mapOauthProviderProperty(
{
list_to_atom(Key),
list_to_binary(V)})
} || {[?AUTH_OAUTH2, ?OAUTH_PROVIDERS, Name, Key], V} <- Settings ],
maps:groups_from_list(KeyFun, ValueFun, OAuthProviders).


Expand All @@ -134,7 +241,7 @@ extract_resource_server_properties(Settings) ->
ValueFun = fun extract_value/1,

OAuthProviders = [{Name, {list_to_atom(Key), list_to_binary(V)}}
|| {["auth_oauth2","resource_servers", Name, Key], V} <- Settings ],
|| {[?AUTH_OAUTH2, ?RESOURCE_SERVERS, Name, Key], V} <- Settings ],
maps:groups_from_list(KeyFun, ValueFun, OAuthProviders).

mapOauthProviderProperty({Key, Value}) ->
Expand All @@ -156,7 +263,7 @@ extract_oauth_providers_https(Settings) ->
ExtractProviderNameFun = fun extract_key_as_binary/1,

AttributesPerProvider = [{Name, mapHttpProperty({list_to_atom(Key), V})} ||
{["auth_oauth2","oauth_providers", Name, "https", Key], V} <- Settings ],
{[?AUTH_OAUTH2, ?OAUTH_PROVIDERS, Name, "https", Key], V} <- Settings ],

maps:map(fun(_K,V)-> [{https, V}] end,
maps:groups_from_list(ExtractProviderNameFun, fun({_, V}) -> V end,
Expand All @@ -172,7 +279,7 @@ extract_oauth_providers_algorithm(Settings) ->
KeyFun = fun extract_key_as_binary/1,

IndexedAlgorithms = [{Name, {Index, list_to_binary(V)}} ||
{["auth_oauth2","oauth_providers", Name, "algorithms", Index], V}
{[?AUTH_OAUTH2, ?OAUTH_PROVIDERS, Name, "algorithms", Index], V}
<- Settings ],
SortedAlgorithms = lists:sort(fun({_,{AI,_}},{_,{BI,_}}) -> AI < BI end,
IndexedAlgorithms),
Expand All @@ -184,7 +291,7 @@ extract_resource_server_preferred_username_claims(Settings) ->
KeyFun = fun extract_key_as_binary/1,

IndexedClaims = [{Name, {Index, list_to_binary(V)}} ||
{["auth_oauth2","resource_servers", Name, "preferred_username_claims",
{[?AUTH_OAUTH2, ?RESOURCE_SERVERS, Name, "preferred_username_claims",
Index], V} <- Settings ],
SortedClaims = lists:sort(fun({_,{AI,_}},{_,{BI,_}}) -> AI < BI end,
IndexedClaims),
Expand All @@ -205,7 +312,7 @@ extract_oauth_providers_signing_keys(Settings) ->
KeyFun = fun extract_key_as_binary/1,

IndexedSigningKeys = [{Name, {list_to_binary(Kid), list_to_binary(V)}} ||
{["auth_oauth2","oauth_providers", Name, "signing_keys", Kid], V}
{[?AUTH_OAUTH2, ?OAUTH_PROVIDERS, Name, ?SIGNING_KEYS, Kid], V}
<- Settings ],
maps:map(fun(_K,V)-> [{signing_keys, translate_list_of_signing_keys(V)}] end,
maps:groups_from_list(KeyFun, fun({_, V}) -> V end, IndexedSigningKeys)).
Loading
Loading