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.

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

Jump to bottom

fix(bridge_api): correctly deobfuscate secrets during dry run #12306

Merged
merged 1 commit into from Jan 12, 2024
Merged

fix(bridge_api): correctly deobfuscate secrets during dry run #12306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions apps/emqx_bridge/src/emqx_bridge_api.erl
View file
Open in desktop
Expand Up @@ -22,6 +22,7 @@
-include_lib("emqx/include/logger.hrl").
-include_lib("emqx_utils/include/emqx_utils_api.hrl").
-include_lib("emqx_bridge/include/emqx_bridge.hrl").
-include_lib("snabbkaffe/include/snabbkaffe.hrl").

-import(hoconsc, [mk/2, array/1, enum/1]).

Expand Down Expand Up @@ -564,6 +565,7 @@ schema("/bridges_probe") ->
{ok, #{body := #{<<"type">> := BridgeType} = Params}} ->
Params1 = maybe_deobfuscate_bridge_probe(Params),
Params2 = maps:remove(<<"type">>, Params1),
?tp(bridge_v1_api_dry_run, #{params => Params2}),
case emqx_bridge_resource:create_dry_run(BridgeType, Params2) of
ok ->
?NO_CONTENT;
Expand Down
29 changes: 27 additions & 2 deletions apps/emqx_bridge/test/emqx_bridge_api_SUITE.erl
View file
Open in desktop
Expand Up @@ -19,6 +19,7 @@
-compile(export_all).

-import(emqx_mgmt_api_test_util, [uri/1]).
-import(emqx_common_test_helpers, [on_exit/1]).

-include_lib("eunit/include/eunit.hrl").
-include_lib("common_test/include/ct.hrl").
Expand Down Expand Up @@ -882,7 +883,7 @@ start_stop_inconsistent_bridge(Type, Config) ->
)
end),

emqx_common_test_helpers:on_exit(fun() ->
on_exit(fun() ->
erpc:call(Node, fun() ->
meck:unload([emqx_bridge_resource])
end)
Expand Down Expand Up @@ -999,6 +1000,8 @@ t_reset_bridges(Config) ->
{ok, 200, []} = request_json(get, uri(["bridges"]), Config).

t_with_redact_update(Config) ->
ok = snabbkaffe:start_trace(),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to use ?check_trace macro.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll fix it in a follow up.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, we still have to call snabbkaffe:stop() when using that macro, right?

on_exit(fun() -> ok = snabbkaffe:stop() end),
Name = <<"redact_update">>,
Type = <<"mqtt">>,
Password = <<"123456">>,
Expand Down Expand Up @@ -1027,6 +1030,28 @@ t_with_redact_update(Config) ->
Password,
get_raw_config([bridges, Type, Name, password], Config)
),

%% probe with new password; should not be considered redacted
{_, {ok, #{params := UsedParams}}} =
?wait_async_action(
request(
post,
uri(["bridges_probe"]),
Template#{<<"password">> := <<"newpassword">>},
Config
),
#{?snk_kind := bridge_v1_api_dry_run},
1_000
),
UsedPassword0 = maps:get(<<"password">>, UsedParams),
%% the password field schema makes
%% `emqx_dashboard_swagger:filter_check_request_and_translate_body' wrap the password.
%% hack: this fails with `badfun' in CI only, due to cover compile, if not evaluated
%% in the original node...
PrimaryNode = ?config(node, Config),
erpc:call(PrimaryNode, fun() -> ?assertEqual(<<"newpassword">>, UsedPassword0()) end),
ok = snabbkaffe:stop(),

ok.

t_bridges_probe(Config) ->
Expand Down Expand Up @@ -1149,7 +1174,7 @@ t_bridges_probe(Config) ->
Config
),

emqx_common_test_helpers:on_exit(fun() ->
on_exit(fun() ->
delete_user_auth(Chain, AuthenticatorID, User, Config)
end),

Expand Down
6 changes: 3 additions & 3 deletions apps/emqx_utils/src/emqx_utils.erl
View file
Open in desktop
Expand Up @@ -793,9 +793,9 @@ do_is_redacted(K, ?REDACT_VAL, Fun) ->
Fun(K);
do_is_redacted(K, <<?REDACT_VAL>>, Fun) ->
Fun(K);
do_is_redacted(_K, V, _Fun) when is_function(V, 0) ->
%% already wrapped by `emqx_secret' or other module
true;
do_is_redacted(K, WrappedFun, Fun) when is_function(WrappedFun, 0) ->
%% wrapped by `emqx_secret' or other module
do_is_redacted(K, WrappedFun(), Fun);
do_is_redacted(_K, _V, _Fun) ->
false.

Expand Down
6 changes: 4 additions & 2 deletions apps/emqx_utils/test/emqx_utils_tests.erl
View file
Open in desktop
Expand Up @@ -23,6 +23,8 @@ is_redacted_test_() ->
?_assertNot(emqx_utils:is_redacted(password, <<>>)),
?_assertNot(emqx_utils:is_redacted(password, undefined)),
?_assert(emqx_utils:is_redacted(password, <<"******">>)),
?_assert(emqx_utils:is_redacted(password, fun() -> <<"secretpass">> end)),
?_assert(emqx_utils:is_redacted(password, emqx_secret:wrap(<<"secretpass">>)))
?_assertNot(emqx_utils:is_redacted(password, fun() -> <<"secretpass">> end)),
?_assertNot(emqx_utils:is_redacted(password, emqx_secret:wrap(<<"secretpass">>))),
?_assert(emqx_utils:is_redacted(password, fun() -> <<"******">> end)),
?_assert(emqx_utils:is_redacted(password, emqx_secret:wrap(<<"******">>)))
].
1 change: 1 addition & 0 deletions changes/ce/fix-12306.en.md
View file
Open in desktop
@@ -0,0 +1 @@
Fixed an issue that prevented probing a bridge from working after changing the password in the HTTP API request.