yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #11045 from zhongwencool/hide-zones-authn-in-listeners 

feat: hide zone/authn in listeners and remove listeners's authn api
This commit is contained in:
zhongwencool 2023-06-14 20:32:27 +08:00 committed by GitHub
parent fcc3a59e3e f6df52020c
commit 267053cc35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 69 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -16,7 +16,7 @@ endif
# Dashbord version # Dashbord version
# from https://github.com/emqx/emqx-dashboard5 # from https://github.com/emqx/emqx-dashboard5
export EMQX_DASHBOARD_VERSION ?= v1.2.6-beta.1 export EMQX_DASHBOARD_VERSION ?= v1.2.6-beta.1
export EMQX_EE_DASHBOARD_VERSION ?= e1.1.0-beta.4 export EMQX_EE_DASHBOARD_VERSION ?= e1.1.0-beta.5
# `:=` should be used here, otherwise the `$(shell ...)` will be executed every time when the variable is used # `:=` should be used here, otherwise the `$(shell ...)` will be executed every time when the variable is used
# In make 4.4+, for backward-compatibility the value from the original environment is used. # In make 4.4+, for backward-compatibility the value from the original environment is used.

2
apps/emqx/src/emqx_listeners.erl
View File

@ -118,7 +118,7 @@ format_raw_listeners({Type0, Conf}) ->
Bind = parse_bind(LConf0), Bind = parse_bind(LConf0),
MaxConn = maps:get(<<"max_connections">>, LConf0, default_max_conn()), MaxConn = maps:get(<<"max_connections">>, LConf0, default_max_conn()),
Running = is_running(Type, listener_id(Type, LName), LConf0#{bind => Bind}), Running = is_running(Type, listener_id(Type, LName), LConf0#{bind => Bind}),
LConf1 = maps:remove(<<"authentication">>, LConf0), LConf1 = maps:without([<<"authentication">>, <<"zone">>], LConf0),
LConf2 = maps:put(<<"running">>, Running, LConf1), LConf2 = maps:put(<<"running">>, Running, LConf1),
CurrConn = CurrConn =
case Running of case Running of

9
apps/emqx/src/emqx_schema.erl
View File

@ -209,7 +209,7 @@ roots(high) ->
map("name", ref("zone")), map("name", ref("zone")),
#{ #{
desc => ?DESC(zones), desc => ?DESC(zones),
importance => ?IMPORTANCE_LOW importance => ?IMPORTANCE_HIDDEN
} }
)}, )},
{?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME, authentication(global)}, {?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME, authentication(global)},
@ -1794,7 +1794,8 @@ base_listener(Bind) ->
atom(), atom(),
#{ #{
desc => ?DESC(base_listener_zone), desc => ?DESC(base_listener_zone),
default => 'default' default => 'default',
importance => ?IMPORTANCE_HIDDEN
} }
)}, )},
{"limiter", {"limiter",
@ -3409,7 +3410,7 @@ mqtt_general() ->
)}, )},
{"server_keepalive", {"server_keepalive",
sc( sc(
hoconsc:union([integer(), disabled]), hoconsc:union([pos_integer(), disabled]),
#{ #{
default => disabled, default => disabled,
desc => ?DESC(mqtt_server_keepalive) desc => ?DESC(mqtt_server_keepalive)
@ -3481,7 +3482,7 @@ mqtt_session() ->
)}, )},
{"max_awaiting_rel", {"max_awaiting_rel",
sc( sc(
hoconsc:union([integer(), infinity]), hoconsc:union([non_neg_integer(), infinity]),
#{ #{
default => 100, default => 100,
desc => ?DESC(mqtt_max_awaiting_rel), desc => ?DESC(mqtt_max_awaiting_rel),

15
apps/emqx_authn/src/emqx_authn_api.erl
View File

@ -103,14 +103,15 @@ paths() ->
"/authentication/:id/status", "/authentication/:id/status",
"/authentication/:id/position/:position", "/authentication/:id/position/:position",
"/authentication/:id/users", "/authentication/:id/users",
"/authentication/:id/users/:user_id", "/authentication/:id/users/:user_id"
"/listeners/:listener_id/authentication", %% hide listener authn api since 5.1.0
"/listeners/:listener_id/authentication/:id", %% "/listeners/:listener_id/authentication",
"/listeners/:listener_id/authentication/:id/status", %% "/listeners/:listener_id/authentication/:id",
"/listeners/:listener_id/authentication/:id/position/:position", %% "/listeners/:listener_id/authentication/:id/status",
"/listeners/:listener_id/authentication/:id/users", %% "/listeners/:listener_id/authentication/:id/position/:position",
"/listeners/:listener_id/authentication/:id/users/:user_id" %% "/listeners/:listener_id/authentication/:id/users",
%% "/listeners/:listener_id/authentication/:id/users/:user_id"
]. ].
roots() -> roots() ->

5
apps/emqx_authn/src/emqx_authn_user_import_api.erl
View File

@ -48,8 +48,9 @@ api_spec() ->
paths() -> paths() ->
[ [
"/authentication/:id/import_users", "/authentication/:id/import_users"
"/listeners/:listener_id/authentication/:id/import_users" %% hide the deprecated api since 5.1.0
%% "/listeners/:listener_id/authentication/:id/import_users"
]. ].
schema("/authentication/:id/import_users") -> schema("/authentication/:id/import_users") ->

28
apps/emqx_authn/test/emqx_authn_api_SUITE.erl
View File

@ -120,23 +120,23 @@ t_authenticator_position(_) ->
t_authenticator_import_users(_) -> t_authenticator_import_users(_) ->
test_authenticator_import_users([]). test_authenticator_import_users([]).
t_listener_authenticators(_) -> %t_listener_authenticators(_) ->
test_authenticators(["listeners", ?TCP_DEFAULT]). % test_authenticators(["listeners", ?TCP_DEFAULT]).
t_listener_authenticator(_) -> %t_listener_authenticator(_) ->
test_authenticator(["listeners", ?TCP_DEFAULT]). % test_authenticator(["listeners", ?TCP_DEFAULT]).
t_listener_authenticator_users(_) -> %t_listener_authenticator_users(_) ->
test_authenticator_users(["listeners", ?TCP_DEFAULT]). % test_authenticator_users(["listeners", ?TCP_DEFAULT]).
t_listener_authenticator_user(_) -> %t_listener_authenticator_user(_) ->
test_authenticator_user(["listeners", ?TCP_DEFAULT]). % test_authenticator_user(["listeners", ?TCP_DEFAULT]).
t_listener_authenticator_position(_) -> %t_listener_authenticator_position(_) ->
test_authenticator_position(["listeners", ?TCP_DEFAULT]). % test_authenticator_position(["listeners", ?TCP_DEFAULT]).
t_listener_authenticator_import_users(_) -> %t_listener_authenticator_import_users(_) ->
test_authenticator_import_users(["listeners", ?TCP_DEFAULT]). % test_authenticator_import_users(["listeners", ?TCP_DEFAULT]).
t_aggregate_metrics(_) -> t_aggregate_metrics(_) ->
Metrics = #{ Metrics = #{
@ -683,7 +683,9 @@ test_authenticator_import_users(PathPrefix) ->
{filename, "user-credentials.csv", CSVData} {filename, "user-credentials.csv", CSVData}
]). ]).
t_switch_to_global_chain(_) -> %% listener authn api is not supported since 5.1.0
%% Don't support listener switch to global chain.
ignore_switch_to_global_chain(_) ->
{ok, 200, _} = request( {ok, 200, _} = request(
post, post,
uri([?CONF_NS]), uri([?CONF_NS]),

1
apps/emqx_authn/test/emqx_authn_enable_flag_SUITE.erl
View File

@ -75,7 +75,6 @@ listener_mqtt_tcp_conf(Port, EnableAuthn) ->
PortS = integer_to_binary(Port), PortS = integer_to_binary(Port),
#{ #{
<<"acceptors">> => 16, <<"acceptors">> => 16,
<<"zone">> => <<"default">>,
<<"access_rules">> => ["allow all"], <<"access_rules">> => ["allow all"],
<<"bind">> => <<"0.0.0.0:", PortS/binary>>, <<"bind">> => <<"0.0.0.0:", PortS/binary>>,
<<"max_connections">> => 1024000, <<"max_connections">> => 1024000,

16
apps/emqx_conf/src/emqx_conf_cli.erl
View File

@ -151,7 +151,8 @@ status() ->
emqx_ctl:print("-----------------------------------------------\n"). emqx_ctl:print("-----------------------------------------------\n").
print_keys(Config) -> print_keys(Config) ->
print(lists:sort(maps:keys(Config))). Keys = lists:sort(maps:keys(Config)),
emqx_ctl:print("~1p~n", [[binary_to_existing_atom(K) || K <- Keys]]).
print(Json) -> print(Json) ->
emqx_ctl:print("~ts~n", [emqx_logger_jsonfmt:best_effort_json(Json)]). emqx_ctl:print("~ts~n", [emqx_logger_jsonfmt:best_effort_json(Json)]).
@ -166,11 +167,10 @@ get_config() ->
drop_hidden_roots(AllConf). drop_hidden_roots(AllConf).
drop_hidden_roots(Conf) -> drop_hidden_roots(Conf) ->
Hidden = hidden_roots(), lists:foldl(fun(K, Acc) -> maps:remove(K, Acc) end, Conf, hidden_roots()).
maps:without(Hidden, Conf).
hidden_roots() -> hidden_roots() ->
[trace, stats, broker]. [<<"trace">>, <<"stats">>, <<"broker">>, <<"persistent_session_store">>].
get_config(Key) -> get_config(Key) ->
case emqx:get_raw_config([Key], undefined) of case emqx:get_raw_config([Key], undefined) of
@ -212,9 +212,9 @@ load_config(Path, ReplaceOrMerge) ->
{error, bad_hocon_file} {error, bad_hocon_file}
end. end.
update_config_cluster(?EMQX_AUTHORIZATION_CONFIG_ROOT_NAME = Key, Conf, merge) -> update_config_cluster(?EMQX_AUTHORIZATION_CONFIG_ROOT_NAME_BINARY = Key, Conf, merge) ->
check_res(Key, emqx_authz:merge(Conf)); check_res(Key, emqx_authz:merge(Conf));
update_config_cluster(?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME = Key, Conf, merge) -> update_config_cluster(?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME_BINARY = Key, Conf, merge) ->
check_res(Key, emqx_authn:merge_config(Conf)); check_res(Key, emqx_authn:merge_config(Conf));
update_config_cluster(Key, NewConf, merge) -> update_config_cluster(Key, NewConf, merge) ->
Merged = merge_conf(Key, NewConf), Merged = merge_conf(Key, NewConf),
@ -223,9 +223,9 @@ update_config_cluster(Key, Value, replace) ->
check_res(Key, emqx_conf:update([Key], Value, ?OPTIONS)). check_res(Key, emqx_conf:update([Key], Value, ?OPTIONS)).
-define(LOCAL_OPTIONS, #{rawconf_with_defaults => true, persistent => false}). -define(LOCAL_OPTIONS, #{rawconf_with_defaults => true, persistent => false}).
update_config_local(?EMQX_AUTHORIZATION_CONFIG_ROOT_NAME = Key, Conf, merge) -> update_config_local(?EMQX_AUTHORIZATION_CONFIG_ROOT_NAME_BINARY = Key, Conf, merge) ->
check_res(node(), Key, emqx_authz:merge_local(Conf, ?LOCAL_OPTIONS)); check_res(node(), Key, emqx_authz:merge_local(Conf, ?LOCAL_OPTIONS));
update_config_local(?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME = Key, Conf, merge) -> update_config_local(?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME_BINARY = Key, Conf, merge) ->
check_res(node(), Key, emqx_authn:merge_config_local(Conf, ?LOCAL_OPTIONS)); check_res(node(), Key, emqx_authn:merge_config_local(Conf, ?LOCAL_OPTIONS));
update_config_local(Key, NewConf, merge) -> update_config_local(Key, NewConf, merge) ->
Merged = merge_conf(Key, NewConf), Merged = merge_conf(Key, NewConf),

12
apps/emqx_conf/test/emqx_conf_cli_SUITE.erl
View File

@ -33,14 +33,20 @@ init_per_suite(Config) ->
end_per_suite(_Config) -> end_per_suite(_Config) ->
emqx_mgmt_api_test_util:end_suite([emqx_conf, emqx_authz]). emqx_mgmt_api_test_util:end_suite([emqx_conf, emqx_authz]).
t_load_config_with(Config) -> t_load_config(Config) ->
Authz = authorization, Authz = authorization,
Conf = emqx_conf:get_raw([Authz]), Conf = emqx_conf:get_raw([Authz]),
%% set sources to [] %% set sources to []
ConfBin0 = hocon_pp:do(#{<<"authorization">> => #{<<"sources">> => []}}, #{}), ConfBin = hocon_pp:do(#{<<"authorization">> => #{<<"sources">> => []}}, #{}),
ConfFile = prepare_conf_file(?FUNCTION_NAME, ConfBin, Config),
ok = emqx_conf_cli:conf(["load", "--replace", ConfFile]),
?assertEqual(#{<<"sources">> => []}, emqx_conf:get_raw([Authz])),
ConfBin0 = hocon_pp:do(#{<<"authorization">> => Conf#{<<"sources">> => []}}, #{}),
ConfFile0 = prepare_conf_file(?FUNCTION_NAME, ConfBin0, Config), ConfFile0 = prepare_conf_file(?FUNCTION_NAME, ConfBin0, Config),
ok = emqx_conf_cli:conf(["load", "--merge", ConfFile0]), ok = emqx_conf_cli:conf(["load", "--replace", ConfFile0]),
?assertEqual(Conf#{<<"sources">> => []}, emqx_conf:get_raw([Authz])), ?assertEqual(Conf#{<<"sources">> => []}, emqx_conf:get_raw([Authz])),
%% remove sources, it will reset to default file source. %% remove sources, it will reset to default file source.
ConfBin1 = hocon_pp:do(#{<<"authorization">> => maps:remove(<<"sources">>, Conf)}, #{}), ConfBin1 = hocon_pp:do(#{<<"authorization">> => maps:remove(<<"sources">>, Conf)}, #{}),
ConfFile1 = prepare_conf_file(?FUNCTION_NAME, ConfBin1, Config), ConfFile1 = prepare_conf_file(?FUNCTION_NAME, ConfBin1, Config),

16
apps/emqx_management/src/emqx_mgmt_api_clients.erl
View File

@ -63,7 +63,6 @@
-define(CLIENT_QSCHEMA, [ -define(CLIENT_QSCHEMA, [
{<<"node">>, atom}, {<<"node">>, atom},
{<<"username">>, binary}, {<<"username">>, binary},
{<<"zone">>, atom},
{<<"ip_address">>, ip}, {<<"ip_address">>, ip},
{<<"conn_state">>, atom}, {<<"conn_state">>, atom},
{<<"clean_start">>, atom}, {<<"clean_start">>, atom},
@ -122,11 +121,6 @@ schema("/clients") ->
required => false, required => false,
desc => <<"User name">> desc => <<"User name">>
})}, })},
{zone,
hoconsc:mk(binary(), #{
in => query,
required => false
})},
{ip_address, {ip_address,
hoconsc:mk(binary(), #{ hoconsc:mk(binary(), #{
in => query, in => query,
@ -549,12 +543,7 @@ fields(client) ->
" Maximum number of subscriptions allowed by this client">> " Maximum number of subscriptions allowed by this client">>
})}, })},
{username, hoconsc:mk(binary(), #{desc => <<"User name of client when connecting">>})}, {username, hoconsc:mk(binary(), #{desc => <<"User name of client when connecting">>})},
{mountpoint, hoconsc:mk(binary(), #{desc => <<"Topic mountpoint">>})}, {mountpoint, hoconsc:mk(binary(), #{desc => <<"Topic mountpoint">>})}
{zone,
hoconsc:mk(binary(), #{
desc =>
<<"Indicate the configuration group used by the client">>
})}
]; ];
fields(authz_cache) -> fields(authz_cache) ->
[ [
@ -848,8 +837,6 @@ ms(clientid, X) ->
#{clientinfo => #{clientid => X}}; #{clientinfo => #{clientid => X}};
ms(username, X) -> ms(username, X) ->
#{clientinfo => #{username => X}}; #{clientinfo => #{username => X}};
ms(zone, X) ->
#{clientinfo => #{zone => X}};
ms(conn_state, X) -> ms(conn_state, X) ->
#{conn_state => X}; #{conn_state => X};
ms(ip_address, X) -> ms(ip_address, X) ->
@ -930,6 +917,7 @@ format_channel_info(WhichNode, {_, ClientInfo0, ClientStats}) ->
sockname, sockname,
retry_interval, retry_interval,
upgrade_qos, upgrade_qos,
zone,
%% sessionID, defined in emqx_session.erl %% sessionID, defined in emqx_session.erl
id id
], ],

5
apps/emqx_management/src/emqx_mgmt_api_configs.erl
View File

@ -43,9 +43,8 @@
<<"alarm">>, <<"alarm">>,
<<"sys_topics">>, <<"sys_topics">>,
<<"sysmon">>, <<"sysmon">>,
<<"log">>, <<"log">>
<<"persistent_session_store">>, %% <<"zones">>
<<"zones">>
]). ]).
api_spec() -> api_spec() ->

3
apps/emqx_management/src/emqx_mgmt_api_listeners.erl
View File

@ -825,8 +825,7 @@ tcp_schema_example() ->
send_timeout => <<"15s">>, send_timeout => <<"15s">>,
send_timeout_close => true send_timeout_close => true
}, },
type => tcp, type => tcp
zone => default
}. }.
create_listener(Body) -> create_listener(Body) ->

25
apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl
View File

@ -199,18 +199,19 @@ get_global_zone() ->
update_global_zone(Change) -> update_global_zone(Change) ->
update_config("global_zone", Change). update_config("global_zone", Change).
t_zones(_Config) -> %% hide /configs/zones api in 5.1.0, so we comment this test.
{ok, Zones} = get_config("zones"), %t_zones(_Config) ->
{ok, #{<<"mqtt">> := OldMqtt} = Zone1} = get_global_zone(), % {ok, Zones} = get_config("zones"),
Mqtt1 = maps:remove(<<"max_subscriptions">>, OldMqtt), % {ok, #{<<"mqtt">> := OldMqtt} = Zone1} = get_global_zone(),
{ok, #{}} = update_config("zones", Zones#{<<"new_zone">> => Zone1#{<<"mqtt">> => Mqtt1}}), % Mqtt1 = maps:remove(<<"max_subscriptions">>, OldMqtt),
NewMqtt = emqx_config:get_raw([zones, new_zone, mqtt]), % {ok, #{}} = update_config("zones", Zones#{<<"new_zone">> => Zone1#{<<"mqtt">> => Mqtt1}}),
%% we remove max_subscription from global zone, so the new zone should not have it. % NewMqtt = emqx_config:get_raw([zones, new_zone, mqtt]),
?assertEqual(Mqtt1, NewMqtt), % %% we remove max_subscription from global zone, so the new zone should not have it.
%% delete the new zones % ?assertEqual(Mqtt1, NewMqtt),
{ok, #{}} = update_config("zones", Zones), % %% delete the new zones
?assertEqual(undefined, emqx_config:get_raw([zones, new_zone], undefined)), % {ok, #{}} = update_config("zones", Zones),
ok. % ?assertEqual(undefined, emqx_config:get_raw([zones, new_zone], undefined)),
% ok.
t_dashboard(_Config) -> t_dashboard(_Config) ->
{ok, Dashboard = #{<<"listeners">> := Listeners}} = get_config("dashboard"), {ok, Dashboard = #{<<"listeners">> := Listeners}} = get_config("dashboard"),

1
changes/ce/feat-11045.en.md Normal file
View File

@ -0,0 +1 @@
The listener's authentication and zone related apis have been officially removed in version `5.1.0`.