550 lines
17 KiB
Erlang
550 lines
17 KiB
Erlang
%%--------------------------------------------------------------------
|
|
%% Copyright (c) 2020-2024 EMQ Technologies Co., Ltd. All Rights Reserved.
|
|
%%
|
|
%% Licensed under the Apache License, Version 2.0 (the "License");
|
|
%% you may not use this file except in compliance with the License.
|
|
%% You may obtain a copy of the License at
|
|
%%
|
|
%% http://www.apache.org/licenses/LICENSE-2.0
|
|
%%
|
|
%% Unless required by applicable law or agreed to in writing, software
|
|
%% distributed under the License is distributed on an "AS IS" BASIS,
|
|
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
%% See the License for the specific language governing permissions and
|
|
%% limitations under the License.
|
|
%%--------------------------------------------------------------------
|
|
|
|
-module(emqx_authn_mysql_SUITE).
|
|
|
|
-compile(nowarn_export_all).
|
|
-compile(export_all).
|
|
|
|
-include_lib("emqx_connector/include/emqx_connector.hrl").
|
|
-include_lib("emqx_auth/include/emqx_authn.hrl").
|
|
-include_lib("eunit/include/eunit.hrl").
|
|
-include_lib("common_test/include/ct.hrl").
|
|
|
|
-define(MYSQL_HOST, "mysql").
|
|
-define(MYSQL_RESOURCE, <<"emqx_authn_mysql_SUITE">>).
|
|
|
|
-define(PATH, [authentication]).
|
|
-define(ResourceID, <<"password_based:mysql">>).
|
|
|
|
all() ->
|
|
[{group, require_seeds}, t_create, t_create_invalid].
|
|
|
|
groups() ->
|
|
[{require_seeds, [], [t_authenticate, t_update, t_destroy]}].
|
|
|
|
init_per_testcase(_, Config) ->
|
|
emqx_authn_test_lib:delete_authenticators(
|
|
[authentication],
|
|
?GLOBAL
|
|
),
|
|
Config.
|
|
|
|
init_per_group(require_seeds, Config) ->
|
|
ok = init_seeds(),
|
|
Config.
|
|
|
|
end_per_group(require_seeds, Config) ->
|
|
ok = drop_seeds(),
|
|
Config.
|
|
|
|
init_per_suite(Config) ->
|
|
case emqx_common_test_helpers:is_tcp_server_available(?MYSQL_HOST, ?MYSQL_DEFAULT_PORT) of
|
|
true ->
|
|
Apps = emqx_cth_suite:start([emqx, emqx_conf, emqx_auth, emqx_auth_mysql], #{
|
|
work_dir => ?config(priv_dir, Config)
|
|
}),
|
|
{ok, _} = emqx_resource:create_local(
|
|
?MYSQL_RESOURCE,
|
|
?AUTHN_RESOURCE_GROUP,
|
|
emqx_mysql,
|
|
mysql_config(),
|
|
#{}
|
|
),
|
|
[{apps, Apps} | Config];
|
|
false ->
|
|
{skip, no_mysql}
|
|
end.
|
|
|
|
end_per_suite(Config) ->
|
|
emqx_authn_test_lib:delete_authenticators(
|
|
[authentication],
|
|
?GLOBAL
|
|
),
|
|
ok = emqx_resource:remove_local(?MYSQL_RESOURCE),
|
|
ok = emqx_cth_suite:stop(?config(apps, Config)),
|
|
ok.
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% Tests
|
|
%%------------------------------------------------------------------------------
|
|
|
|
t_create(_Config) ->
|
|
AuthConfig = raw_mysql_auth_config(),
|
|
|
|
{ok, _} = emqx:update_config(
|
|
?PATH,
|
|
{create_authenticator, ?GLOBAL, AuthConfig}
|
|
),
|
|
|
|
{ok, [#{provider := emqx_authn_mysql}]} = emqx_authn_chains:list_authenticators(?GLOBAL),
|
|
emqx_authn_test_lib:delete_config(?ResourceID).
|
|
|
|
t_create_invalid(_Config) ->
|
|
AuthConfig = raw_mysql_auth_config(),
|
|
|
|
InvalidConfigs =
|
|
[
|
|
AuthConfig#{<<"server">> => <<"unknownhost:3333">>},
|
|
AuthConfig#{<<"password">> => <<"wrongpass">>},
|
|
AuthConfig#{<<"database">> => <<"wrongdatabase">>}
|
|
],
|
|
|
|
lists:foreach(
|
|
fun(Config) ->
|
|
{ok, _} = emqx:update_config(
|
|
?PATH,
|
|
{create_authenticator, ?GLOBAL, Config}
|
|
),
|
|
emqx_authn_test_lib:delete_config(?ResourceID),
|
|
?assertEqual(
|
|
{error, {not_found, {chain, ?GLOBAL}}},
|
|
emqx_authn_chains:list_authenticators(?GLOBAL)
|
|
)
|
|
end,
|
|
InvalidConfigs
|
|
).
|
|
|
|
t_authenticate(_Config) ->
|
|
ok = lists:foreach(
|
|
fun(Sample) ->
|
|
ct:pal("test_user_auth sample: ~p", [Sample]),
|
|
test_user_auth(Sample)
|
|
end,
|
|
user_seeds()
|
|
).
|
|
|
|
test_user_auth(#{
|
|
credentials := Credentials0,
|
|
config_params := SpecificConfigParams,
|
|
result := Result
|
|
}) ->
|
|
AuthConfig = maps:merge(raw_mysql_auth_config(), SpecificConfigParams),
|
|
|
|
{ok, _} = emqx:update_config(
|
|
?PATH,
|
|
{create_authenticator, ?GLOBAL, AuthConfig}
|
|
),
|
|
|
|
Credentials = Credentials0#{
|
|
listener => 'tcp:default',
|
|
protocol => mqtt
|
|
},
|
|
|
|
?assertEqual(Result, emqx_access_control:authenticate(Credentials)),
|
|
|
|
emqx_authn_test_lib:delete_authenticators(
|
|
[authentication],
|
|
?GLOBAL
|
|
).
|
|
|
|
t_destroy(_Config) ->
|
|
AuthConfig = raw_mysql_auth_config(),
|
|
|
|
{ok, _} = emqx:update_config(
|
|
?PATH,
|
|
{create_authenticator, ?GLOBAL, AuthConfig}
|
|
),
|
|
|
|
{ok, [#{provider := emqx_authn_mysql, state := State}]} =
|
|
emqx_authn_chains:list_authenticators(?GLOBAL),
|
|
|
|
{ok, _} = emqx_authn_mysql:authenticate(
|
|
#{
|
|
username => <<"plain">>,
|
|
password => <<"plain">>
|
|
},
|
|
State
|
|
),
|
|
|
|
emqx_authn_test_lib:delete_authenticators(
|
|
[authentication],
|
|
?GLOBAL
|
|
),
|
|
|
|
% Authenticator should not be usable anymore
|
|
?assertMatch(
|
|
ignore,
|
|
emqx_authn_mysql:authenticate(
|
|
#{
|
|
username => <<"plain">>,
|
|
password => <<"plain">>
|
|
},
|
|
State
|
|
)
|
|
).
|
|
|
|
t_update(_Config) ->
|
|
CorrectConfig = raw_mysql_auth_config(),
|
|
IncorrectConfig =
|
|
CorrectConfig#{
|
|
<<"query">> =>
|
|
<<
|
|
"SELECT password_hash, salt, is_superuser_str as is_superuser\n"
|
|
" FROM wrong_table where username = ${username} LIMIT 1"
|
|
>>
|
|
},
|
|
|
|
{ok, _} = emqx:update_config(
|
|
?PATH,
|
|
{create_authenticator, ?GLOBAL, IncorrectConfig}
|
|
),
|
|
|
|
{error, not_authorized} = emqx_access_control:authenticate(
|
|
#{
|
|
username => <<"plain">>,
|
|
password => <<"plain">>,
|
|
listener => 'tcp:default',
|
|
protocol => mqtt
|
|
}
|
|
),
|
|
|
|
% We update with config with correct query, provider should update and work properly
|
|
{ok, _} = emqx:update_config(
|
|
?PATH,
|
|
{update_authenticator, ?GLOBAL, <<"password_based:mysql">>, CorrectConfig}
|
|
),
|
|
|
|
{ok, _} = emqx_access_control:authenticate(
|
|
#{
|
|
username => <<"plain">>,
|
|
password => <<"plain">>,
|
|
listener => 'tcp:default',
|
|
protocol => mqtt
|
|
}
|
|
).
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% Helpers
|
|
%%------------------------------------------------------------------------------
|
|
|
|
raw_mysql_auth_config() ->
|
|
#{
|
|
<<"mechanism">> => <<"password_based">>,
|
|
<<"password_hash_algorithm">> => #{
|
|
<<"name">> => <<"plain">>,
|
|
<<"salt_position">> => <<"suffix">>
|
|
},
|
|
<<"enable">> => <<"true">>,
|
|
|
|
<<"backend">> => <<"mysql">>,
|
|
<<"database">> => <<"mqtt">>,
|
|
<<"username">> => <<"root">>,
|
|
<<"password">> => <<"public">>,
|
|
|
|
<<"query">> =>
|
|
<<
|
|
"SELECT password_hash, salt, is_superuser_str as is_superuser\n"
|
|
" FROM users where username = ${username} LIMIT 1"
|
|
>>,
|
|
<<"server">> => mysql_server()
|
|
}.
|
|
|
|
user_seeds() ->
|
|
[
|
|
#{
|
|
data => #{
|
|
username => "plain",
|
|
password_hash => "plainsalt",
|
|
salt => "salt",
|
|
is_superuser_str => "1"
|
|
},
|
|
credentials => #{
|
|
username => <<"plain">>,
|
|
password => <<"plain">>
|
|
},
|
|
config_params => #{},
|
|
result => {ok, #{is_superuser => true}}
|
|
},
|
|
|
|
#{
|
|
data => #{
|
|
username => "md5",
|
|
password_hash => "9b4d0c43d206d48279e69b9ad7132e22",
|
|
salt => "salt",
|
|
is_superuser_str => "0"
|
|
},
|
|
credentials => #{
|
|
username => <<"md5">>,
|
|
password => <<"md5">>
|
|
},
|
|
config_params => #{
|
|
<<"password_hash_algorithm">> => #{
|
|
<<"name">> => <<"md5">>,
|
|
<<"salt_position">> => <<"suffix">>
|
|
}
|
|
},
|
|
result => {ok, #{is_superuser => false}}
|
|
},
|
|
|
|
#{
|
|
data => #{
|
|
username => "sha256",
|
|
password_hash => "ac63a624e7074776d677dd61a003b8c803eb11db004d0ec6ae032a5d7c9c5caf",
|
|
salt => "salt",
|
|
is_superuser_int => 1
|
|
},
|
|
credentials => #{
|
|
clientid => <<"sha256">>,
|
|
password => <<"sha256">>
|
|
},
|
|
config_params => #{
|
|
<<"query">> =>
|
|
<<
|
|
"SELECT password_hash, salt, is_superuser_int as is_superuser\n"
|
|
" FROM users where username = ${clientid} LIMIT 1"
|
|
>>,
|
|
<<"password_hash_algorithm">> => #{
|
|
<<"name">> => <<"sha256">>,
|
|
<<"salt_position">> => <<"prefix">>
|
|
}
|
|
},
|
|
result => {ok, #{is_superuser => true}}
|
|
},
|
|
|
|
%% strip double quote support
|
|
#{
|
|
data => #{
|
|
username => "sha256",
|
|
password_hash => "ac63a624e7074776d677dd61a003b8c803eb11db004d0ec6ae032a5d7c9c5caf",
|
|
salt => "salt",
|
|
is_superuser_int => 1
|
|
},
|
|
credentials => #{
|
|
username => <<"sha256">>,
|
|
password => <<"sha256">>
|
|
},
|
|
config_params => #{
|
|
<<"query">> =>
|
|
<<
|
|
"SELECT password_hash, salt, is_superuser_int as is_superuser\n"
|
|
" FROM users where username = \"${username}\" LIMIT 1"
|
|
>>,
|
|
<<"password_hash_algorithm">> => #{
|
|
<<"name">> => <<"sha256">>,
|
|
<<"salt_position">> => <<"prefix">>
|
|
}
|
|
},
|
|
result => {ok, #{is_superuser => true}}
|
|
},
|
|
|
|
#{
|
|
data => #{
|
|
username => "sha256",
|
|
password_hash => "ac63a624e7074776d677dd61a003b8c803eb11db004d0ec6ae032a5d7c9c5caf",
|
|
cert_subject => <<"cert_subject_data">>,
|
|
cert_common_name => <<"cert_common_name_data">>,
|
|
salt => "salt",
|
|
is_superuser_int => 1
|
|
},
|
|
credentials => #{
|
|
clientid => <<"sha256">>,
|
|
password => <<"sha256">>,
|
|
cert_subject => <<"cert_subject_data">>,
|
|
cert_common_name => <<"cert_common_name_data">>
|
|
},
|
|
config_params => #{
|
|
<<"query">> =>
|
|
<<
|
|
"SELECT password_hash, salt, is_superuser_int as is_superuser\n"
|
|
" FROM users where cert_subject = ${cert_subject} AND \n"
|
|
" cert_common_name = ${cert_common_name} LIMIT 1"
|
|
>>,
|
|
<<"password_hash_algorithm">> => #{
|
|
<<"name">> => <<"sha256">>,
|
|
<<"salt_position">> => <<"prefix">>
|
|
}
|
|
},
|
|
result => {ok, #{is_superuser => true}}
|
|
},
|
|
|
|
#{
|
|
data => #{
|
|
username => <<"bcrypt">>,
|
|
password_hash => "$2b$12$wtY3h20mUjjmeaClpqZVveDWGlHzCGsvuThMlneGHA7wVeFYyns2u",
|
|
salt => "$2b$12$wtY3h20mUjjmeaClpqZVve",
|
|
is_superuser_int => 0
|
|
},
|
|
credentials => #{
|
|
username => <<"bcrypt">>,
|
|
password => <<"bcrypt">>
|
|
},
|
|
config_params => #{
|
|
<<"query">> =>
|
|
<<
|
|
"SELECT password_hash, salt, is_superuser_int as is_superuser\n"
|
|
" FROM users where username = ${username} LIMIT 1"
|
|
>>,
|
|
<<"password_hash_algorithm">> => #{<<"name">> => <<"bcrypt">>}
|
|
},
|
|
result => {ok, #{is_superuser => false}}
|
|
},
|
|
|
|
#{
|
|
data => #{
|
|
username => <<"bcrypt">>,
|
|
password_hash => "$2b$12$wtY3h20mUjjmeaClpqZVveDWGlHzCGsvuThMlneGHA7wVeFYyns2u",
|
|
salt => "$2b$12$wtY3h20mUjjmeaClpqZVve"
|
|
},
|
|
credentials => #{
|
|
username => <<"bcrypt">>,
|
|
password => <<"bcrypt">>
|
|
},
|
|
config_params => #{
|
|
<<"query">> =>
|
|
<<
|
|
"SELECT password_hash, salt, is_superuser_int as is_superuser\n"
|
|
" FROM users where username = ${username} LIMIT 1"
|
|
>>,
|
|
<<"password_hash_algorithm">> => #{<<"name">> => <<"bcrypt">>}
|
|
},
|
|
result => {ok, #{is_superuser => false}}
|
|
},
|
|
|
|
#{
|
|
data => #{
|
|
username => <<"bcrypt0">>,
|
|
password_hash => "$2b$12$wtY3h20mUjjmeaClpqZVveDWGlHzCGsvuThMlneGHA7wVeFYyns2u",
|
|
salt => "$2b$12$wtY3h20mUjjmeaClpqZVve",
|
|
is_superuser_str => "0"
|
|
},
|
|
credentials => #{
|
|
username => <<"bcrypt0">>,
|
|
password => <<"bcrypt">>
|
|
},
|
|
config_params => #{
|
|
% clientid variable & username credentials
|
|
<<"query">> =>
|
|
<<
|
|
"SELECT password_hash, salt, is_superuser_int as is_superuser\n"
|
|
" FROM users where username = ${clientid} LIMIT 1"
|
|
>>,
|
|
<<"password_hash_algorithm">> => #{<<"name">> => <<"bcrypt">>}
|
|
},
|
|
result => {error, not_authorized}
|
|
},
|
|
|
|
#{
|
|
data => #{
|
|
username => <<"bcrypt1">>,
|
|
password_hash => "$2b$12$wtY3h20mUjjmeaClpqZVveDWGlHzCGsvuThMlneGHA7wVeFYyns2u",
|
|
salt => "$2b$12$wtY3h20mUjjmeaClpqZVve",
|
|
is_superuser_str => "0"
|
|
},
|
|
credentials => #{
|
|
username => <<"bcrypt1">>,
|
|
password => <<"bcrypt">>
|
|
},
|
|
config_params => #{
|
|
% Bad keys in query
|
|
<<"query">> =>
|
|
<<
|
|
"SELECT 1 AS unknown_field\n"
|
|
" FROM users where username = ${username} LIMIT 1"
|
|
>>,
|
|
<<"password_hash_algorithm">> => #{<<"name">> => <<"bcrypt">>}
|
|
},
|
|
result => {error, not_authorized}
|
|
},
|
|
|
|
#{
|
|
data => #{
|
|
username => <<"bcrypt2">>,
|
|
password_hash => "$2b$12$wtY3h20mUjjmeaClpqZVveDWGlHzCGsvuThMlneGHA7wVeFYyns2u",
|
|
salt => "$2b$12$wtY3h20mUjjmeaClpqZVve",
|
|
is_superuser => "0"
|
|
},
|
|
credentials => #{
|
|
username => <<"bcrypt2">>,
|
|
% Wrong password
|
|
password => <<"wrongpass">>
|
|
},
|
|
config_params => #{
|
|
<<"password_hash_algorithm">> => #{<<"name">> => <<"bcrypt">>}
|
|
},
|
|
result => {error, bad_username_or_password}
|
|
}
|
|
].
|
|
|
|
init_seeds() ->
|
|
ok = drop_seeds(),
|
|
ok = q(
|
|
"CREATE TABLE users(\n"
|
|
" username VARCHAR(255),\n"
|
|
" password_hash VARCHAR(255),\n"
|
|
" salt VARCHAR(255),\n"
|
|
" cert_subject VARCHAR(255),\n"
|
|
" cert_common_name VARCHAR(255),\n"
|
|
" is_superuser_str VARCHAR(255),\n"
|
|
" is_superuser_int TINYINT)"
|
|
),
|
|
|
|
Fields = [
|
|
username,
|
|
password_hash,
|
|
salt,
|
|
cert_subject,
|
|
cert_common_name,
|
|
is_superuser_str,
|
|
is_superuser_int
|
|
],
|
|
InsertQuery =
|
|
"INSERT INTO users(username, password_hash, salt, cert_subject, cert_common_name,"
|
|
" is_superuser_str, is_superuser_int) VALUES(?, ?, ?, ?, ?, ?, ?)",
|
|
|
|
lists:foreach(
|
|
fun(#{data := Values}) ->
|
|
Params = [maps:get(F, Values, null) || F <- Fields],
|
|
ok = q(InsertQuery, Params)
|
|
end,
|
|
user_seeds()
|
|
).
|
|
|
|
q(Sql) ->
|
|
emqx_resource:simple_sync_query(
|
|
?MYSQL_RESOURCE,
|
|
{sql, Sql}
|
|
).
|
|
|
|
q(Sql, Params) ->
|
|
emqx_resource:simple_sync_query(
|
|
?MYSQL_RESOURCE,
|
|
{sql, Sql, Params}
|
|
).
|
|
|
|
drop_seeds() ->
|
|
ok = q("DROP TABLE IF EXISTS users").
|
|
|
|
mysql_server() ->
|
|
iolist_to_binary(io_lib:format("~s", [?MYSQL_HOST])).
|
|
|
|
mysql_config() ->
|
|
#{
|
|
auto_reconnect => true,
|
|
database => <<"mqtt">>,
|
|
username => <<"root">>,
|
|
password => <<"public">>,
|
|
pool_size => 8,
|
|
server => <<?MYSQL_HOST>>,
|
|
ssl => #{enable => false}
|
|
}.
|
|
|
|
start_apps(Apps) ->
|
|
lists:foreach(fun application:ensure_all_started/1, Apps).
|
|
|
|
stop_apps(Apps) ->
|
|
lists:foreach(fun application:stop/1, Apps).
|