427 lines
12 KiB
Erlang
427 lines
12 KiB
Erlang
%%--------------------------------------------------------------------
|
|
%% Copyright (c) 2020-2022 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_authz_schema).
|
|
|
|
-include("emqx_authz.hrl").
|
|
-include_lib("hocon/include/hoconsc.hrl").
|
|
-include_lib("emqx_connector/include/emqx_connector.hrl").
|
|
-import(hoconsc, [mk/2, ref/2]).
|
|
|
|
-reflect_type([
|
|
permission/0,
|
|
action/0
|
|
]).
|
|
|
|
-type action() :: publish | subscribe | all.
|
|
-type permission() :: allow | deny.
|
|
|
|
-export([
|
|
namespace/0,
|
|
roots/0,
|
|
fields/1,
|
|
validations/0,
|
|
desc/1
|
|
]).
|
|
|
|
-export([
|
|
headers_no_content_type/1,
|
|
headers/1
|
|
]).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Hocon Schema
|
|
%%--------------------------------------------------------------------
|
|
|
|
namespace() -> authz.
|
|
|
|
%% @doc authorization schema is not exported
|
|
%% but directly used by emqx_schema
|
|
roots() -> [].
|
|
|
|
fields("authorization") ->
|
|
[
|
|
{sources, #{
|
|
type => union_array(
|
|
[
|
|
hoconsc:ref(?MODULE, file),
|
|
hoconsc:ref(?MODULE, http_get),
|
|
hoconsc:ref(?MODULE, http_post),
|
|
hoconsc:ref(?MODULE, mnesia),
|
|
hoconsc:ref(?MODULE, mongo_single),
|
|
hoconsc:ref(?MODULE, mongo_rs),
|
|
hoconsc:ref(?MODULE, mongo_sharded),
|
|
hoconsc:ref(?MODULE, mysql),
|
|
hoconsc:ref(?MODULE, postgresql),
|
|
hoconsc:ref(?MODULE, redis_single),
|
|
hoconsc:ref(?MODULE, redis_sentinel),
|
|
hoconsc:ref(?MODULE, redis_cluster),
|
|
hoconsc:ref(?MODULE, jwt)
|
|
]
|
|
),
|
|
default => [],
|
|
desc => ?DESC(sources)
|
|
}}
|
|
];
|
|
fields(file) ->
|
|
authz_common_fields(file) ++
|
|
[{path, #{type => string(), required => true, desc => ?DESC(path)}}];
|
|
fields(http_get) ->
|
|
authz_common_fields(http) ++
|
|
http_common_fields() ++
|
|
[
|
|
{method, #{type => get, default => get, required => true, desc => ?DESC(method)}},
|
|
{headers, fun headers_no_content_type/1}
|
|
];
|
|
fields(http_post) ->
|
|
authz_common_fields(http) ++
|
|
http_common_fields() ++
|
|
[
|
|
{method, #{type => post, default => post, required => true, desc => ?DESC(method)}},
|
|
{headers, fun headers/1}
|
|
];
|
|
fields(mnesia) ->
|
|
authz_common_fields(built_in_database);
|
|
fields(mongo_single) ->
|
|
authz_common_fields(mongodb) ++
|
|
mongo_common_fields() ++
|
|
emqx_connector_mongo:fields(single);
|
|
fields(mongo_rs) ->
|
|
authz_common_fields(mongodb) ++
|
|
mongo_common_fields() ++
|
|
emqx_connector_mongo:fields(rs);
|
|
fields(mongo_sharded) ->
|
|
authz_common_fields(mongodb) ++
|
|
mongo_common_fields() ++
|
|
emqx_connector_mongo:fields(sharded);
|
|
fields(mysql) ->
|
|
authz_common_fields(mysql) ++
|
|
connector_fields(mysql) ++
|
|
[{query, query()}];
|
|
fields(postgresql) ->
|
|
authz_common_fields(postgresql) ++
|
|
emqx_connector_pgsql:fields(config) ++
|
|
[{query, query()}];
|
|
fields(redis_single) ->
|
|
authz_common_fields(redis) ++
|
|
connector_fields(redis, single) ++
|
|
[{cmd, cmd()}];
|
|
fields(redis_sentinel) ->
|
|
authz_common_fields(redis) ++
|
|
connector_fields(redis, sentinel) ++
|
|
[{cmd, cmd()}];
|
|
fields(redis_cluster) ->
|
|
authz_common_fields(redis) ++
|
|
connector_fields(redis, cluster) ++
|
|
[{cmd, cmd()}];
|
|
fields(jwt) ->
|
|
authz_common_fields(jwt) ++
|
|
[
|
|
{acl_claim_name, #{
|
|
type => binary(),
|
|
default => <<"acl">>,
|
|
desc => ?DESC(acl_claim_name)
|
|
}}
|
|
];
|
|
fields("metrics_status_fields") ->
|
|
[
|
|
{"resource_metrics", mk(ref(?MODULE, "resource_metrics"), #{desc => ?DESC("metrics")})},
|
|
{"node_resource_metrics",
|
|
mk(
|
|
hoconsc:array(ref(?MODULE, "node_resource_metrics")),
|
|
#{desc => ?DESC("node_metrics")}
|
|
)},
|
|
{"metrics", mk(ref(?MODULE, "metrics"), #{desc => ?DESC("metrics")})},
|
|
{"node_metrics",
|
|
mk(
|
|
hoconsc:array(ref(?MODULE, "node_metrics")),
|
|
#{desc => ?DESC("node_metrics")}
|
|
)},
|
|
{"status", mk(cluster_status(), #{desc => ?DESC("status")})},
|
|
{"node_status",
|
|
mk(
|
|
hoconsc:array(ref(?MODULE, "node_status")),
|
|
#{desc => ?DESC("node_status")}
|
|
)},
|
|
{"node_error",
|
|
mk(
|
|
hoconsc:array(ref(?MODULE, "node_error")),
|
|
#{desc => ?DESC("node_error")}
|
|
)}
|
|
];
|
|
fields("metrics") ->
|
|
[
|
|
{"matched", mk(integer(), #{desc => ?DESC("matched")})},
|
|
{"allow", mk(integer(), #{desc => ?DESC("allow")})},
|
|
{"deny", mk(integer(), #{desc => ?DESC("deny")})},
|
|
{"ignore", mk(float(), #{desc => ?DESC("ignore")})},
|
|
{"rate", mk(float(), #{desc => ?DESC("rate")})},
|
|
{"rate_max", mk(float(), #{desc => ?DESC("rate_max")})},
|
|
{"rate_last5m", mk(float(), #{desc => ?DESC("rate_last5m")})}
|
|
];
|
|
fields("node_metrics") ->
|
|
[
|
|
node_name(),
|
|
{"metrics", mk(ref(?MODULE, "metrics"), #{desc => ?DESC("metrics")})}
|
|
];
|
|
fields("resource_metrics") ->
|
|
common_field();
|
|
fields("node_resource_metrics") ->
|
|
[
|
|
node_name(),
|
|
{"metrics", mk(ref(?MODULE, "resource_metrics"), #{desc => ?DESC("metrics")})}
|
|
];
|
|
fields("node_status") ->
|
|
[
|
|
node_name(),
|
|
{"status", mk(status(), #{desc => ?DESC("node_status")})}
|
|
];
|
|
fields("node_error") ->
|
|
[
|
|
node_name(),
|
|
{"error", mk(string(), #{desc => ?DESC("node_error")})}
|
|
].
|
|
|
|
common_field() ->
|
|
[
|
|
{"matched", mk(integer(), #{desc => ?DESC("matched")})},
|
|
{"success", mk(integer(), #{desc => ?DESC("success")})},
|
|
{"failed", mk(integer(), #{desc => ?DESC("failed")})},
|
|
{"rate", mk(float(), #{desc => ?DESC("rate")})},
|
|
{"rate_max", mk(float(), #{desc => ?DESC("rate_max")})},
|
|
{"rate_last5m", mk(float(), #{desc => ?DESC("rate_last5m")})}
|
|
].
|
|
|
|
status() ->
|
|
hoconsc:enum([connected, disconnected, connecting]).
|
|
|
|
cluster_status() ->
|
|
hoconsc:enum([connected, disconnected, connecting, inconsistent]).
|
|
|
|
node_name() ->
|
|
{"node", mk(binary(), #{desc => ?DESC("node"), example => "emqx@127.0.0.1"})}.
|
|
|
|
desc(?CONF_NS) ->
|
|
?DESC(?CONF_NS);
|
|
desc(file) ->
|
|
?DESC(file);
|
|
desc(http_get) ->
|
|
?DESC(http_get);
|
|
desc(http_post) ->
|
|
?DESC(http_post);
|
|
desc(mnesia) ->
|
|
?DESC(mnesia);
|
|
desc(mongo_single) ->
|
|
?DESC(mongo_single);
|
|
desc(mongo_rs) ->
|
|
?DESC(mongo_rs);
|
|
desc(mongo_sharded) ->
|
|
?DESC(mongo_sharded);
|
|
desc(mysql) ->
|
|
?DESC(mysql);
|
|
desc(postgresql) ->
|
|
?DESC(postgresql);
|
|
desc(redis_single) ->
|
|
?DESC(redis_single);
|
|
desc(redis_sentinel) ->
|
|
?DESC(redis_sentinel);
|
|
desc(redis_cluster) ->
|
|
?DESC(redis_cluster);
|
|
desc(jwt) ->
|
|
?DESC(jwt);
|
|
desc(_) ->
|
|
undefined.
|
|
|
|
authz_common_fields(Type) ->
|
|
[
|
|
{type, #{type => Type, required => true, desc => ?DESC(type)}},
|
|
{enable, #{type => boolean(), default => true, desc => ?DESC(enable)}}
|
|
].
|
|
|
|
http_common_fields() ->
|
|
[
|
|
{url, fun url/1},
|
|
{request_timeout,
|
|
emqx_schema:mk_duration("Request timeout", #{
|
|
default => "30s", desc => ?DESC(request_timeout)
|
|
})},
|
|
{body, #{type => map(), required => false, desc => ?DESC(body)}}
|
|
] ++
|
|
maps:to_list(
|
|
maps:without(
|
|
[
|
|
base_url,
|
|
pool_type
|
|
],
|
|
maps:from_list(connector_fields(http))
|
|
)
|
|
).
|
|
|
|
mongo_common_fields() ->
|
|
[
|
|
{collection, #{
|
|
type => atom(),
|
|
required => true,
|
|
desc => ?DESC(collection)
|
|
}},
|
|
{filter, #{
|
|
type => map(),
|
|
required => true,
|
|
desc => ?DESC(filter)
|
|
}}
|
|
].
|
|
|
|
validations() ->
|
|
[
|
|
{check_ssl_opts, fun check_ssl_opts/1}
|
|
].
|
|
|
|
headers(type) ->
|
|
list({binary(), binary()});
|
|
headers(desc) ->
|
|
?DESC(?FUNCTION_NAME);
|
|
headers(converter) ->
|
|
fun(Headers) ->
|
|
maps:to_list(maps:merge(default_headers(), transform_header_name(Headers)))
|
|
end;
|
|
headers(default) ->
|
|
default_headers();
|
|
headers(_) ->
|
|
undefined.
|
|
|
|
headers_no_content_type(type) ->
|
|
list({binary(), binary()});
|
|
headers_no_content_type(desc) ->
|
|
?DESC(?FUNCTION_NAME);
|
|
headers_no_content_type(converter) ->
|
|
fun(Headers) ->
|
|
maps:to_list(maps:merge(default_headers_no_content_type(), transform_header_name(Headers)))
|
|
end;
|
|
headers_no_content_type(default) ->
|
|
default_headers_no_content_type();
|
|
headers_no_content_type(validator) ->
|
|
fun(Headers) ->
|
|
case lists:keyfind(<<"content-type">>, 1, Headers) of
|
|
false -> ok;
|
|
_ -> {error, do_not_include_content_type}
|
|
end
|
|
end;
|
|
headers_no_content_type(_) ->
|
|
undefined.
|
|
|
|
url(type) -> binary();
|
|
url(desc) -> ?DESC(?FUNCTION_NAME);
|
|
url(validator) -> [?NOT_EMPTY("the value of the field 'url' cannot be empty")];
|
|
url(required) -> true;
|
|
url(_) -> undefined.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Internal functions
|
|
%%--------------------------------------------------------------------
|
|
|
|
default_headers() ->
|
|
maps:put(
|
|
<<"content-type">>,
|
|
<<"application/json">>,
|
|
default_headers_no_content_type()
|
|
).
|
|
|
|
default_headers_no_content_type() ->
|
|
#{
|
|
<<"accept">> => <<"application/json">>,
|
|
<<"cache-control">> => <<"no-cache">>,
|
|
<<"connection">> => <<"keep-alive">>,
|
|
<<"keep-alive">> => <<"timeout=30, max=1000">>
|
|
}.
|
|
|
|
transform_header_name(Headers) ->
|
|
maps:fold(
|
|
fun(K0, V, Acc) ->
|
|
K = list_to_binary(string:to_lower(to_list(K0))),
|
|
maps:put(K, V, Acc)
|
|
end,
|
|
#{},
|
|
Headers
|
|
).
|
|
|
|
%% TODO: fix me, not work
|
|
check_ssl_opts(Conf) ->
|
|
case hocon_maps:get("config.url", Conf) of
|
|
undefined ->
|
|
true;
|
|
Url ->
|
|
case emqx_authz_http:parse_url(Url) of
|
|
#{scheme := https} ->
|
|
case hocon_maps:get("config.ssl.enable", Conf) of
|
|
true -> true;
|
|
_ -> {error, ssl_not_enable}
|
|
end;
|
|
#{scheme := http} ->
|
|
true;
|
|
Bad ->
|
|
{bad_scheme, Url, Bad}
|
|
end
|
|
end.
|
|
|
|
union_array(Item) when is_list(Item) ->
|
|
hoconsc:array(hoconsc:union(Item)).
|
|
|
|
query() ->
|
|
#{
|
|
type => binary(),
|
|
desc => ?DESC(query),
|
|
required => true,
|
|
validator => fun(S) ->
|
|
case size(S) > 0 of
|
|
true -> ok;
|
|
_ -> {error, "Request query"}
|
|
end
|
|
end
|
|
}.
|
|
|
|
cmd() ->
|
|
#{
|
|
type => binary(),
|
|
desc => ?DESC(cmd),
|
|
required => true,
|
|
validator => fun(S) ->
|
|
case size(S) > 0 of
|
|
true -> ok;
|
|
_ -> {error, "Request query"}
|
|
end
|
|
end
|
|
}.
|
|
|
|
connector_fields(DB) ->
|
|
connector_fields(DB, config).
|
|
connector_fields(DB, Fields) ->
|
|
Mod0 = io_lib:format("~ts_~ts", [emqx_connector, DB]),
|
|
Mod =
|
|
try
|
|
list_to_existing_atom(Mod0)
|
|
catch
|
|
error:badarg ->
|
|
list_to_atom(Mod0);
|
|
error:Reason ->
|
|
erlang:error(Reason)
|
|
end,
|
|
erlang:apply(Mod, fields, [Fields]).
|
|
|
|
to_list(A) when is_atom(A) ->
|
|
atom_to_list(A);
|
|
to_list(B) when is_binary(B) ->
|
|
binary_to_list(B).
|