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

style(gateway): format gateway application

This commit is contained in:
JianBo He 2022-03-31 17:41:32 +08:00
parent 4249d4345b
commit 3f6d78dda0
95 changed files with 16542 additions and 11478 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
apps/emqx_gateway/include/emqx_gateway.hrl
View File

@ -21,19 +21,20 @@
%% @doc The Gateway definition
-type gateway() ::
#{ name := gateway_name()
#{
name := gateway_name(),
%% Description
, descr => binary() | undefined
descr => binary() | undefined,
%% Appears only in getting gateway info
, status => stopped | running | unloaded
status => stopped | running | unloaded,
%% Timestamp in millisecond
, created_at => integer()
created_at => integer(),
%% Timestamp in millisecond
, started_at => integer()
started_at => integer(),
%% Timestamp in millisecond
, stopped_at => integer()
stopped_at => integer(),
%% Appears only in getting gateway info
, config => emqx_config:config()
config => emqx_config:config()
}.
-endif.

12
apps/emqx_gateway/include/emqx_gateway_http.hrl
View File

@ -19,9 +19,11 @@
-define(RESOURCE_NOT_FOUND, 'RESOURCE_NOT_FOUND').
-define(INTERNAL_ERROR, 'INTERNAL_SERVER_ERROR').
-define(STANDARD_RESP(R),
R#{ 400 => emqx_dashboard_swagger:error_codes(
[?BAD_REQUEST], <<"Bad request">>)
, 404 => emqx_dashboard_swagger:error_codes(
[?NOT_FOUND, ?RESOURCE_NOT_FOUND], <<"Not Found">>)
-define(STANDARD_RESP(R), R#{
400 => emqx_dashboard_swagger:error_codes(
[?BAD_REQUEST], <<"Bad request">>
),
404 => emqx_dashboard_swagger:error_codes(
[?NOT_FOUND, ?RESOURCE_NOT_FOUND], <<"Not Found">>
)
}).

26
apps/emqx_gateway/rebar.config
View File

@ -10,22 +10,30 @@
{grpc_plugin, {git, "https://github.com/HJianBo/grpc_plugin", {tag, "v0.10.2"}}}
]}.
{grpc,
[{protos, ["src/exproto/protos"]},
{grpc, [
{protos, ["src/exproto/protos"]},
{out_dir, "src/exproto/"},
{gpb_opts, [{module_name_prefix, "emqx_"},
{module_name_suffix, "_pb"}]}
{gpb_opts, [
{module_name_prefix, "emqx_"},
{module_name_suffix, "_pb"}
]}
]}.
{provider_hooks,
[{pre, [{compile, {grpc, gen}},
{clean, {grpc, clean}}]}
{provider_hooks, [
{pre, [
{compile, {grpc, gen}},
{clean, {grpc, clean}}
]}
]}.
{xref_ignores, [emqx_exproto_pb]}.
{cover_excl_mods, [emqx_exproto_pb,
{cover_excl_mods, [
emqx_exproto_pb,
emqx_exproto_v_1_connection_adapter_client,
emqx_exproto_v_1_connection_adapter_bhvr,
emqx_exproto_v_1_connection_handler_client,
emqx_exproto_v_1_connection_handler_bhvr]}.
emqx_exproto_v_1_connection_handler_bhvr
]}.
{project_plugins, [erlfmt]}.

37
apps/emqx_gateway/src/bhvrs/emqx_gateway_channel.erl
View File

@ -46,7 +46,8 @@
-type gen_server_from() :: {pid(), Tag :: term()}.
-type reply() :: {outgoing, emqx_gateway_frame:packet()}
-type reply() ::
{outgoing, emqx_gateway_frame:packet()}
| {outgoing, [emqx_gateway_frame:packet()]}
| {event, conn_state() | updated}
| {close, Reason :: atom()}.
@ -54,46 +55,46 @@
-type replies() :: reply() | [reply()].
%% @doc Handle the incoming frame
-callback handle_in(emqx_gateway_frame:frame() | {frame_error, any()},
channel())
-> {ok, channel()}
-callback handle_in(
emqx_gateway_frame:frame() | {frame_error, any()},
channel()
) ->
{ok, channel()}
| {ok, replies(), channel()}
| {shutdown, Reason :: any(), channel()}
| {shutdown, Reason :: any(), replies(), channel()}.
%% @doc Handle the outgoing messages dispatched from PUB/SUB system
-callback handle_deliver(list(emqx_types:deliver()), channel())
-> {ok, channel()}
-callback handle_deliver(list(emqx_types:deliver()), channel()) ->
{ok, channel()}
| {ok, replies(), channel()}.
%% @doc Handle the timeout event
-callback handle_timeout(reference(), Msg :: any(), channel())
-> {ok, channel()}
-callback handle_timeout(reference(), Msg :: any(), channel()) ->
{ok, channel()}
| {ok, replies(), channel()}
| {shutdown, Reason :: any(), channel()}.
%% @doc Handle the custom gen_server:call/2 for its connection process
-callback handle_call(Req :: any(), From :: gen_server_from(), channel())
-> {reply, Reply :: any(), channel()}
-callback handle_call(Req :: any(), From :: gen_server_from(), channel()) ->
{reply, Reply :: any(), channel()}
%% Reply to caller and trigger an event(s)
| {reply, Reply :: any(),
EventOrEvents :: tuple() | list(tuple()), channel()}
| {reply, Reply :: any(), EventOrEvents :: tuple() | list(tuple()), channel()}
| {noreply, channel()}
| {noreply, EventOrEvents :: tuple() | list(tuple()), channel()}
| {shutdown, Reason :: any(), Reply :: any(), channel()}
%% Shutdown the process, reply to caller and write a packet to client
| {shutdown, Reason :: any(), Reply :: any(),
emqx_gateway_frame:frame(), channel()}.
| {shutdown, Reason :: any(), Reply :: any(), emqx_gateway_frame:frame(), channel()}.
%% @doc Handle the custom gen_server:cast/2 for its connection process
-callback handle_cast(Req :: any(), channel())
-> ok
-callback handle_cast(Req :: any(), channel()) ->
ok
| {ok, channel()}
| {shutdown, Reason :: any(), channel()}.
%% @doc Handle the custom process messages for its connection process
-callback handle_info(Info :: any(), channel())
-> ok
-callback handle_info(Info :: any(), channel()) ->
ok
| {ok, channel()}
| {shutdown, Reason :: any(), channel()}.

411
apps/emqx_gateway/src/bhvrs/emqx_gateway_conn.erl
View File

@ -21,27 +21,31 @@
-include_lib("emqx/include/logger.hrl").
%% API
-export([ start_link/3
, stop/1
-export([
start_link/3,
stop/1
]).
-export([ info/1
, stats/1
-export([
info/1,
stats/1
]).
-export([ call/2
, call/3
, cast/2
-export([
call/2,
call/3,
cast/2
]).
%% Callback
-export([init/6]).
%% Sys callbacks
-export([ system_continue/3
, system_terminate/4
, system_code_change/4
, system_get_state/1
-export([
system_continue/3,
system_terminate/4,
system_code_change/4,
system_get_state/1
]).
%% Internal callback
@ -95,20 +99,21 @@
-define(ENABLED(X), (X =/= undefined)).
-dialyzer({nowarn_function,
[ system_terminate/4
, handle_call/3
, handle_msg/2
, shutdown/3
, stop/3
, parse_incoming/3
]}).
-dialyzer(
{nowarn_function, [
system_terminate/4,
handle_call/3,
handle_msg/2,
shutdown/3,
stop/3,
parse_incoming/3
]}
).
%% udp
start_link(Socket = {udp, _SockPid, _Sock}, Peername, Options) ->
Args = [self(), Socket, Peername, Options] ++ callback_modules(Options),
{ok, proc_lib:spawn_link(?MODULE, init, Args)};
%% tcp/ssl/dtls
start_link(esockd_transport, Sock, Options) ->
Socket = {esockd_transport, Sock},
@ -116,21 +121,24 @@ start_link(esockd_transport, Sock, Options) ->
{ok, proc_lib:spawn_link(?MODULE, init, Args)}.
callback_modules(Options) ->
[maps:get(frame_mod, Options),
maps:get(chann_mod, Options)].
[
maps:get(frame_mod, Options),
maps:get(chann_mod, Options)
].
%%--------------------------------------------------------------------
%% API
%%--------------------------------------------------------------------
%% @doc Get infos of the connection/channel.
-spec(info(pid()|state()) -> emqx_types:infos()).
-spec info(pid() | state()) -> emqx_types:infos().
info(CPid) when is_pid(CPid) ->
call(CPid, info);
info(State = #state{chann_mod = ChannMod, channel = Channel}) ->
ChanInfo = ChannMod:info(Channel),
SockInfo = maps:from_list(
info(?INFO_KEYS, State)),
info(?INFO_KEYS, State)
),
ChanInfo#{sockinfo => SockInfo}.
info(Keys, State) when is_list(Keys) ->
@ -146,13 +154,16 @@ info(sockstate, #state{sockstate = SockSt}) ->
info(active_n, #state{active_n = ActiveN}) ->
ActiveN.
-spec(stats(pid()|state()) -> emqx_types:stats()).
-spec stats(pid() | state()) -> emqx_types:stats().
stats(CPid) when is_pid(CPid) ->
call(CPid, stats);
stats(#state{socket = Socket,
stats(#state{
socket = Socket,
chann_mod = ChannMod,
channel = Channel}) ->
SockStats = case esockd_getstat(Socket, ?SOCK_STATS) of
channel = Channel
}) ->
SockStats =
case esockd_getstat(Socket, ?SOCK_STATS) of
{ok, Ss} -> Ss;
{error, _} -> []
end,
@ -221,8 +232,10 @@ esockd_getstat({udp, _SockPid, Sock}, Stats) ->
esockd_getstat({esockd_transport, Sock}, Stats) ->
esockd_transport:getstat(Sock, Stats).
esockd_send(Data, #state{socket = {udp, _SockPid, Sock},
peername = {Ip, Port}}) ->
esockd_send(Data, #state{
socket = {udp, _SockPid, Sock},
peername = {Ip, Port}
}) ->
gen_udp:send(Sock, Ip, Port, Data);
esockd_send(Data, #state{socket = {esockd_transport, Sock}}) ->
esockd_transport:async_send(Sock, Data).
@ -238,8 +251,16 @@ init(Parent, WrappedSock, Peername0, Options, FrameMod, ChannMod) ->
case esockd_wait(WrappedSock) of
{ok, NWrappedSock} ->
Peername = esockd_peername(NWrappedSock, Peername0),
run_loop(Parent, init_state(NWrappedSock, Peername,
Options, FrameMod, ChannMod));
run_loop(
Parent,
init_state(
NWrappedSock,
Peername,
Options,
FrameMod,
ChannMod
)
);
{error, Reason} ->
ok = esockd_close(WrappedSock),
exit_on_sock_error(Reason)
@ -248,7 +269,8 @@ init(Parent, WrappedSock, Peername0, Options, FrameMod, ChannMod) ->
init_state(WrappedSock, Peername, Options, FrameMod, ChannMod) ->
{ok, Sockname} = esockd_ensure_ok_or_exit(sockname, WrappedSock),
Peercert = esockd_ensure_ok_or_exit(peercert, WrappedSock),
ConnInfo = #{socktype => esockd_type(WrappedSock),
ConnInfo = #{
socktype => esockd_type(WrappedSock),
peername => Peername,
sockname => Sockname,
peercert => Peercert,
@ -267,7 +289,8 @@ init_state(WrappedSock, Peername, Options, FrameMod, ChannMod) ->
IdleTimeout = emqx_gateway_utils:idle_timeout(Options),
OomPolicy = emqx_gateway_utils:oom_policy(Options),
IdleTimer = emqx_misc:start_timer(IdleTimeout, idle_timeout),
#state{socket = WrappedSock,
#state{
socket = WrappedSock,
peername = Peername,
sockname = Sockname,
sockstate = idle,
@ -286,10 +309,14 @@ init_state(WrappedSock, Peername, Options, FrameMod, ChannMod) ->
listener = maps:get(listener, Options, undefined)
}.
run_loop(Parent, State = #state{socket = Socket,
run_loop(
Parent,
State = #state{
socket = Socket,
peername = Peername,
oom_policy = OomPolicy
}) ->
}
) ->
emqx_logger:set_metadata_peername(esockd:format(Peername)),
_ = emqx_misc:tune_heap_size(OomPolicy),
case activate_socket(State) of
@ -301,9 +328,11 @@ run_loop(Parent, State = #state{socket = Socket,
end.
-spec exit_on_sock_error(atom()) -> no_return().
exit_on_sock_error(Reason) when Reason =:= einval;
exit_on_sock_error(Reason) when
Reason =:= einval;
Reason =:= enotconn;
Reason =:= closed ->
Reason =:= closed
->
erlang:exit(normal);
exit_on_sock_error(timeout) ->
erlang:exit({shutdown, ssl_upgrade_timeout});
@ -317,8 +346,7 @@ recvloop(Parent, State = #state{idle_timeout = IdleTimeout}) ->
receive
Msg ->
handle_recv(Msg, Parent, State)
after
IdleTimeout + 100 ->
after IdleTimeout + 100 ->
hibernate(Parent, cancel_stats_timer(State))
end.
@ -347,13 +375,16 @@ wakeup_from_hib(Parent, State) ->
ensure_stats_timer(Timeout, State = #state{stats_timer = undefined}) ->
State#state{stats_timer = emqx_misc:start_timer(Timeout, emit_stats)};
ensure_stats_timer(_Timeout, State) -> State.
ensure_stats_timer(_Timeout, State) ->
State.
cancel_stats_timer(State = #state{stats_timer = TRef})
when is_reference(TRef) ->
cancel_stats_timer(State = #state{stats_timer = TRef}) when
is_reference(TRef)
->
ok = emqx_misc:cancel_timer(TRef),
State#state{stats_timer = undefined};
cancel_stats_timer(State) -> State.
cancel_stats_timer(State) ->
State.
%%--------------------------------------------------------------------
%% Process next Msg
@ -380,14 +411,19 @@ process_msg([Msg|More], State) ->
exit:{shutdown, _} = Shutdown ->
{stop, Shutdown, State};
Exception:Context:Stack ->
{stop, #{exception => Exception,
{stop,
#{
exception => Exception,
context => Context,
stacktrace => Stack}, State}
stacktrace => Stack
},
State}
end.
append_msg([], Msgs) when is_list(Msgs) ->
Msgs;
append_msg([], Msg) -> [Msg];
append_msg([], Msg) ->
[Msg];
append_msg(Q, Msgs) when is_list(Msgs) ->
lists:append(Q, Msgs);
append_msg(Q, Msg) ->
@ -412,39 +448,37 @@ handle_msg({'$gen_call', From, Req}, State) ->
gen_server:reply(From, Reply),
stop(Reason, NState)
end;
handle_msg({'$gen_cast', Req}, State) ->
with_channel(handle_cast, [Req], State);
handle_msg({datagram, _SockPid, Data}, State) ->
parse_incoming(Data, State);
handle_msg({Inet, _Sock, Data}, State)
when Inet == tcp;
Inet == ssl ->
handle_msg({Inet, _Sock, Data}, State) when
Inet == tcp;
Inet == ssl
->
parse_incoming(Data, State);
handle_msg({incoming, Packet},
State = #state{idle_timer = IdleTimer}) ->
handle_msg(
{incoming, Packet},
State = #state{idle_timer = IdleTimer}
) ->
IdleTimer /= undefined andalso
emqx_misc:cancel_timer(IdleTimer),
NState = State#state{idle_timer = undefined},
handle_incoming(Packet, NState);
handle_msg({outgoing, Data}, State) ->
handle_outgoing(Data, State);
handle_msg({Error, _Sock, Reason}, State)
when Error == tcp_error; Error == ssl_error ->
handle_msg({Error, _Sock, Reason}, State) when
Error == tcp_error; Error == ssl_error
->
handle_info({sock_error, Reason}, State);
handle_msg({Closed, _Sock}, State)
when Closed == tcp_closed; Closed == ssl_closed ->
handle_msg({Closed, _Sock}, State) when
Closed == tcp_closed; Closed == ssl_closed
->
handle_info({sock_closed, Closed}, close_socket(State));
%% TODO: udp_passive???
handle_msg({Passive, _Sock}, State)
when Passive == tcp_passive; Passive == ssl_passive ->
handle_msg({Passive, _Sock}, State) when
Passive == tcp_passive; Passive == ssl_passive
->
%% In Stats
Bytes = emqx_pd:reset_counter(incoming_bytes),
Pubs = emqx_pd:reset_counter(incoming_pkt),
@ -454,12 +488,12 @@ handle_msg({Passive, _Sock}, State)
%% Run GC and Check OOM
NState1 = check_oom(run_gc(InStats, NState)),
handle_info(activate_socket, NState1);
handle_msg(Deliver = {deliver, _Topic, _Msg},
State = #state{active_n = ActiveN}) ->
handle_msg(
Deliver = {deliver, _Topic, _Msg},
State = #state{active_n = ActiveN}
) ->
Delivers = [Deliver | emqx_misc:drain_deliver(ActiveN)],
with_channel(handle_deliver, [Delivers], State);
%% Something sent
%% TODO: Who will deliver this message?
handle_msg({inet_reply, _Sock, ok}, State = #state{active_n = ActiveN}) ->
@ -469,19 +503,21 @@ handle_msg({inet_reply, _Sock, ok}, State = #state{active_n = ActiveN}) ->
Bytes = emqx_pd:reset_counter(outgoing_bytes),
OutStats = #{cnt => Pubs, oct => Bytes},
{ok, check_oom(run_gc(OutStats, State))};
false -> ok
false ->
ok
end;
handle_msg({inet_reply, _Sock, {error, Reason}}, State) ->
handle_info({sock_error, Reason}, State);
handle_msg({close, Reason}, State) ->
?SLOG(debug, #{msg => "force_socket_close", reason => Reason}),
handle_info({sock_closed, Reason}, close_socket(State));
handle_msg({event, connected}, State = #state{
handle_msg(
{event, connected},
State = #state{
chann_mod = ChannMod,
channel = Channel}) ->
channel = Channel
}
) ->
Ctx = ChannMod:info(ctx, Channel),
ClientId = ChannMod:info(clientid, Channel),
emqx_gateway_ctx:insert_channel_info(
@ -490,31 +526,34 @@ handle_msg({event, connected}, State = #state{
info(State),
stats(State)
);
handle_msg({event, disconnected}, State = #state{
handle_msg(
{event, disconnected},
State = #state{
chann_mod = ChannMod,
channel = Channel}) ->
channel = Channel
}
) ->
Ctx = ChannMod:info(ctx, Channel),
ClientId = ChannMod:info(clientid, Channel),
emqx_gateway_ctx:set_chan_info(Ctx, ClientId, info(State)),
emqx_gateway_ctx:connection_closed(Ctx, ClientId),
{ok, State};
handle_msg({event, _Other}, State = #state{
handle_msg(
{event, _Other},
State = #state{
chann_mod = ChannMod,
channel = Channel}) ->
channel = Channel
}
) ->
Ctx = ChannMod:info(ctx, Channel),
ClientId = ChannMod:info(clientid, Channel),
emqx_gateway_ctx:set_chan_info(Ctx, ClientId, info(State)),
emqx_gateway_ctx:set_chan_stats(Ctx, ClientId, stats(State)),
{ok, State};
handle_msg({timeout, TRef, TMsg}, State) ->
handle_timeout(TRef, TMsg, State);
handle_msg(Shutdown = {shutdown, _Reason}, State) ->
stop(Shutdown, State);
handle_msg(Msg, State) ->
handle_info(Msg, State).
@ -522,9 +561,13 @@ handle_msg(Msg, State) ->
%% Terminate
-spec terminate(atom(), state()) -> no_return().
terminate(Reason, State = #state{
terminate(
Reason,
State = #state{
chann_mod = ChannMod,
channel = Channel}) ->
channel = Channel
}
) ->
?SLOG(debug, #{msg => "conn_process_terminated", reason => Reason}),
_ = ChannMod:terminate(Reason, Channel),
_ = close_socket(State),
@ -549,13 +592,16 @@ system_get_state(State) -> {ok, State}.
handle_call(_From, info, State) ->
{reply, info(State), State};
handle_call(_From, stats, State) ->
{reply, stats(State), State};
handle_call(From, Req, State = #state{
handle_call(
From,
Req,
State = #state{
chann_mod = ChannMod,
channel = Channel}) ->
channel = Channel
}
) ->
case ChannMod:handle_call(Req, From, Channel) of
{noreply, NChannel} ->
{noreply, State#state{channel = NChannel}};
@ -578,24 +624,32 @@ handle_call(From, Req, State = #state{
handle_timeout(_TRef, idle_timeout, State) ->
shutdown(idle_timeout, State);
handle_timeout(_TRef, limit_timeout, State) ->
NState = State#state{sockstate = idle,
NState = State#state{
sockstate = idle,
limit_timer = undefined
},
handle_info(activate_socket, NState);
handle_timeout(TRef, Keepalive, State = #state{
handle_timeout(
TRef,
Keepalive,
State = #state{
chann_mod = ChannMod,
socket = Socket,
channel = Channel})
when Keepalive == keepalive;
Keepalive == keepalive_send ->
Stat = case Keepalive of
channel = Channel
}
) when
Keepalive == keepalive;
Keepalive == keepalive_send
->
Stat =
case Keepalive of
keepalive -> recv_oct;
keepalive_send -> send_oct
end,
case ChannMod:info(conn_state, Channel) of
disconnected -> {ok, State};
disconnected ->
{ok, State};
_ ->
case esockd_getstat(Socket, [Stat]) of
{ok, [{Stat, RecvOct}]} ->
@ -604,22 +658,29 @@ handle_timeout(TRef, Keepalive, State = #state{
handle_info({sock_error, Reason}, State)
end
end;
handle_timeout(_TRef, emit_stats, State =
#state{chann_mod = ChannMod, channel = Channel}) ->
handle_timeout(
_TRef,
emit_stats,
State =
#state{chann_mod = ChannMod, channel = Channel}
) ->
Ctx = ChannMod:info(ctx, Channel),
ClientId = ChannMod:info(clientid, Channel),
emqx_gateway_ctx:set_chan_stats(Ctx, ClientId, stats(State)),
{ok, State#state{stats_timer = undefined}};
handle_timeout(TRef, Msg, State) ->
with_channel(handle_timeout, [TRef, Msg], State).
%%--------------------------------------------------------------------
%% Parse incoming data
parse_incoming(Data, State = #state{
parse_incoming(
Data,
State = #state{
chann_mod = ChannMod,
channel = Channel}) ->
channel = Channel
}
) ->
?SLOG(debug, #{msg => "RECV_data", data => Data}),
Oct = iolist_size(Data),
inc_counter(incoming_bytes, Oct),
@ -630,11 +691,14 @@ parse_incoming(Data, State = #state{
parse_incoming(<<>>, Packets, State) ->
{Packets, State};
parse_incoming(Data, Packets,
parse_incoming(
Data,
Packets,
State = #state{
frame_mod = FrameMod,
parse_state = ParseState}) ->
parse_state = ParseState
}
) ->
try FrameMod:parse(Data, ParseState) of
{more, NParseState} ->
{Packets, State#state{parse_state = NParseState}};
@ -643,11 +707,12 @@ parse_incoming(Data, Packets,
parse_incoming(Rest, [Packet | Packets], NState)
catch
error:Reason:Stk ->
?SLOG(error, #{ msg => "parse_frame_failed"
, at_state => ParseState
, input_bytes => Data
, reason => Reason
, stacktrace => Stk
?SLOG(error, #{
msg => "parse_frame_failed",
at_state => ParseState,
input_bytes => Data,
reason => Reason,
stacktrace => Stk
}),
{[{frame_error, Reason} | Packets], State}
end.
@ -660,26 +725,36 @@ next_incoming_msgs(Packets) ->
%%--------------------------------------------------------------------
%% Handle incoming packet
handle_incoming(Packet, State = #state{
handle_incoming(
Packet,
State = #state{
channel = Channel,
frame_mod = FrameMod,
chann_mod = ChannMod
}) ->
}
) ->
Ctx = ChannMod:info(ctx, Channel),
ok = inc_incoming_stats(Ctx, FrameMod, Packet),
?SLOG(debug, #{ msg => "RECV_packet"
, packet => FrameMod:format(Packet)
?SLOG(debug, #{
msg => "RECV_packet",
packet => FrameMod:format(Packet)
}),
with_channel(handle_in, [Packet], State).
%%--------------------------------------------------------------------
%% With Channel
with_channel(Fun, Args, State = #state{
with_channel(
Fun,
Args,
State = #state{
chann_mod = ChannMod,
channel = Channel}) ->
channel = Channel
}
) ->
case erlang:apply(ChannMod, Fun, Args ++ [Channel]) of
ok -> {ok, State};
ok ->
{ok, State};
{ok, NChannel} ->
{ok, State#state{channel = NChannel}};
{ok, Replies, NChannel} ->
@ -697,19 +772,24 @@ with_channel(Fun, Args, State = #state{
handle_outgoing(_Packets = [], _State) ->
ok;
handle_outgoing(Packets,
State = #state{socket = Socket}) when is_list(Packets) ->
handle_outgoing(
Packets,
State = #state{socket = Socket}
) when is_list(Packets) ->
case is_datadram_socket(Socket) of
false ->
send(
lists:map(serialize_and_inc_stats_fun(State), Packets),
State);
State
);
_ ->
lists:foreach(fun(Packet) ->
lists:foreach(
fun(Packet) ->
handle_outgoing(Packet, State)
end, Packets)
end,
Packets
)
end;
handle_outgoing(Packet, State) ->
send((serialize_and_inc_stats_fun(State))(Packet), State).
@ -717,29 +797,33 @@ serialize_and_inc_stats_fun(#state{
frame_mod = FrameMod,
chann_mod = ChannMod,
serialize = Serialize,
channel = Channel}) ->
channel = Channel
}) ->
Ctx = ChannMod:info(ctx, Channel),
fun(Packet) ->
try
Data = FrameMod:serialize_pkt(Packet, Serialize),
?SLOG(debug, #{ msg => "SEND_packet"
?SLOG(debug, #{
msg => "SEND_packet",
%% XXX: optimize it, less cpu comsuption?
, packet => FrameMod:format(Packet)
packet => FrameMod:format(Packet)
}),
ok = inc_outgoing_stats(Ctx, FrameMod, Packet),
Data
catch
_:too_large ->
?SLOG(warning, #{ msg => "packet_too_large_discarded"
, packet => FrameMod:format(Packet)
?SLOG(warning, #{
msg => "packet_too_large_discarded",
packet => FrameMod:format(Packet)
}),
ok = emqx_gateway_ctx:metrics_inc(Ctx, 'delivery.dropped.too_large'),
ok = emqx_gateway_ctx:metrics_inc(Ctx, 'delivery.dropped'),
<<>>;
_:Reason ->
?SLOG(warning, #{ msg => "packet_serialize_failure"
, reason => Reason
, packet => FrameMod:format(Packet)
?SLOG(warning, #{
msg => "packet_serialize_failure",
reason => Reason,
packet => FrameMod:format(Packet)
}),
ok = emqx_gateway_ctx:metrics_inc(Ctx, 'delivery.dropped'),
<<>>
@ -749,17 +833,23 @@ serialize_and_inc_stats_fun(#state{
%%--------------------------------------------------------------------
%% Send data
-spec(send(iodata(), state()) -> ok).
send(IoData, State = #state{socket = Socket,
-spec send(iodata(), state()) -> ok.
send(
IoData,
State = #state{
socket = Socket,
chann_mod = ChannMod,
channel = Channel}) ->
channel = Channel
}
) ->
?SLOG(debug, #{msg => "SEND_data", data => IoData}),
Ctx = ChannMod:info(ctx, Channel),
Oct = iolist_size(IoData),
ok = emqx_gateway_ctx:metrics_inc(Ctx, 'bytes.sent', Oct),
inc_counter(outgoing_bytes, Oct),
case esockd_send(IoData, State) of
ok -> ok;
ok ->
ok;
Error = {error, _Reason} ->
%% Send an inet_reply to postpone handling the error
self() ! {inet_reply, Socket, Error},
@ -772,20 +862,21 @@ send(IoData, State = #state{socket = Socket,
handle_info(activate_socket, State = #state{sockstate = OldSst}) ->
case activate_socket(State) of
{ok, NState = #state{sockstate = NewSst}} ->
if OldSst =/= NewSst ->
if
OldSst =/= NewSst ->
{ok, {event, NewSst}, NState};
true -> {ok, NState}
true ->
{ok, NState}
end;
{error, Reason} ->
handle_info({sock_error, Reason}, State)
end;
handle_info({sock_error, Reason}, State) ->
?SLOG(debug, #{ msg => "sock_error"
, reason => Reason
?SLOG(debug, #{
msg => "sock_error",
reason => Reason
}),
handle_info({sock_closed, Reason}, close_socket(State));
handle_info(Info, State) ->
with_channel(handle_info, [Info], State).
@ -794,16 +885,19 @@ handle_info(Info, State) ->
ensure_rate_limit(Stats, State = #state{limiter = Limiter}) ->
case ?ENABLED(Limiter) andalso emqx_limiter:check(Stats, Limiter) of
false -> State;
false ->
State;
{ok, Limiter1} ->
State#state{limiter = Limiter1};
{pause, Time, Limiter1} ->
%% XXX: which limiter reached?
?SLOG(warning, #{ msg => "reach_rate_limit"
, pause => Time
?SLOG(warning, #{
msg => "reach_rate_limit",
pause => Time
}),
TRef = emqx_misc:start_timer(Time, limit_timeout),
State#state{sockstate = blocked,
State#state{
sockstate = blocked,
limiter = Limiter1,
limit_timer = TRef
}
@ -815,8 +909,7 @@ ensure_rate_limit(Stats, State = #state{limiter = Limiter}) ->
run_gc(Stats, State = #state{gc_state = GcSt}) ->
case ?ENABLED(GcSt) andalso emqx_gc:run(Stats, GcSt) of
false -> State;
{_IsGC, GcSt1} ->
State#state{gc_state = GcSt1}
{_IsGC, GcSt1} -> State#state{gc_state = GcSt1}
end.
check_oom(State = #state{oom_policy = OomPolicy}) ->
@ -824,7 +917,8 @@ check_oom(State = #state{oom_policy = OomPolicy}) ->
{shutdown, Reason} ->
%% triggers terminate/2 callback immediately
erlang:exit({shutdown, Reason});
_Other -> ok
_Other ->
ok
end,
State.
@ -835,8 +929,12 @@ activate_socket(State = #state{sockstate = closed}) ->
{ok, State};
activate_socket(State = #state{sockstate = blocked}) ->
{ok, State};
activate_socket(State = #state{socket = Socket,
active_n = N}) ->
activate_socket(
State = #state{
socket = Socket,
active_n = N
}
) ->
%% FIXME: Works on dtls/udp ???
%% How to handle buffer?
case esockd_setopts(Socket, [{active, N}]) of
@ -847,7 +945,8 @@ activate_socket(State = #state{socket = Socket,
%%--------------------------------------------------------------------
%% Close Socket
close_socket(State = #state{sockstate = closed}) -> State;
close_socket(State = #state{sockstate = closed}) ->
State;
close_socket(State = #state{socket = Socket}) ->
ok = esockd_close(Socket),
State#state{sockstate = closed}.
@ -865,7 +964,8 @@ inc_incoming_stats(Ctx, FrameMod, Packet) ->
ok
end,
Name = list_to_atom(
lists:concat(["packets.", FrameMod:type(Packet), ".received"])),
lists:concat(["packets.", FrameMod:type(Packet), ".received"])
),
emqx_gateway_ctx:metrics_inc(Ctx, Name).
inc_outgoing_stats(Ctx, FrameMod, Packet) ->
@ -878,7 +978,8 @@ inc_outgoing_stats(Ctx, FrameMod, Packet) ->
ok
end,
Name = list_to_atom(
lists:concat(["packets.", FrameMod:type(Packet), ".sent"])),
lists:concat(["packets.", FrameMod:type(Packet), ".sent"])
),
emqx_gateway_ctx:metrics_inc(Ctx, Name).
%%--------------------------------------------------------------------

14
apps/emqx_gateway/src/bhvrs/emqx_gateway_frame.erl
View File

@ -26,16 +26,17 @@
-type frame() :: any().
-type parse_result() :: {ok, frame(),
Rest :: binary(), NewState :: parse_state()}
-type parse_result() ::
{ok, frame(), Rest :: binary(), NewState :: parse_state()}
| {more, NewState :: parse_state()}.
-type serialize_options() :: map().
-export_type([ parse_state/0
, parse_result/0
, serialize_options/0
, frame/0
-export_type([
parse_state/0,
parse_result/0,
serialize_options/0,
frame/0
]).
%% Callbacks
@ -60,4 +61,3 @@
%% @doc
-callback is_message(Frame :: any()) -> boolean().

16
apps/emqx_gateway/src/bhvrs/emqx_gateway_impl.erl
View File

@ -22,18 +22,22 @@
-type reason() :: any().
%% @doc
-callback on_gateway_load(Gateway :: gateway(),
Ctx :: emqx_gateway_ctx:context())
-> {error, reason()}
-callback on_gateway_load(
Gateway :: gateway(),
Ctx :: emqx_gateway_ctx:context()
) ->
{error, reason()}
| {ok, [ChildPid :: pid()], GwState :: state()}
%% TODO: v0.2 The child spec is better for restarting child process
| {ok, [Childspec :: supervisor:child_spec()], GwState :: state()}.
%% @doc
-callback on_gateway_update(Config :: emqx_config:config(),
-callback on_gateway_update(
Config :: emqx_config:config(),
Gateway :: gateway(),
GwState :: state())
-> ok
GwState :: state()
) ->
ok
| {ok, [ChildPid :: pid()], NGwState :: state()}
| {ok, [Childspec :: supervisor:child_spec()], NGwState :: state()}
| {error, reason()}.

77
apps/emqx_gateway/src/coap/emqx_coap_api.erl
View File

@ -44,18 +44,23 @@ paths() ->
[?PREFIX ++ "/request"].
schema(?PREFIX ++ "/request") ->
#{operationId => request,
post => #{ tags => [<<"gateway|coap">>]
, desc => <<"Send a CoAP request message to the client">>
, parameters => request_parameters()
, requestBody => request_body()
, responses => #{200 => coap_message(),
#{
operationId => request,
post => #{
tags => [<<"gateway|coap">>],
desc => <<"Send a CoAP request message to the client">>,
parameters => request_parameters(),
requestBody => request_body(),
responses => #{
200 => coap_message(),
404 => error_codes(['CLIENT_NOT_FOUND'], <<"Client not found error">>),
504 => error_codes(['CLIENT_NOT_RESPONSE'], <<"Waiting for client response timeout">>)}
504 => error_codes(
['CLIENT_NOT_RESPONSE'], <<"Waiting for client response timeout">>
)
}
}
}.
request(post, #{body := Body, bindings := Bindings}) ->
ClientId = maps:get(clientid, Bindings, undefined),
Method = maps:get(<<"method">>, Body, get),
@ -66,8 +71,12 @@ request(post, #{body := Body, bindings := Bindings}) ->
CT = erlang:atom_to_binary(AtomCT),
Payload2 = parse_payload(CT, Payload),
Msg = emqx_coap_message:request(con,
Method, Payload2, #{content_format => CT}),
Msg = emqx_coap_message:request(
con,
Method,
Payload2,
#{content_format => CT}
),
Msg2 = Msg#coap_message{token = Token},
@ -87,42 +96,49 @@ request_parameters() ->
[{clientid, mk(binary(), #{in => path, required => true})}].
request_body() ->
[ {token, mk(binary(), #{desc => "message token, can be empty"})}
, {method, mk(enum([get, put, post, delete]), #{desc => "request method type"})}
, {timeout, mk(emqx_schema:duration_ms(), #{desc => "timespan for response"})}
, {content_type, mk(enum(['text/plain', 'application/json', 'application/octet-stream']),
#{desc => "payload type"})}
, {payload, mk(binary(), #{desc => "the content of the payload"})}
[
{token, mk(binary(), #{desc => "message token, can be empty"})},
{method, mk(enum([get, put, post, delete]), #{desc => "request method type"})},
{timeout, mk(emqx_schema:duration_ms(), #{desc => "timespan for response"})},
{content_type,
mk(
enum(['text/plain', 'application/json', 'application/octet-stream']),
#{desc => "payload type"}
)},
{payload, mk(binary(), #{desc => "the content of the payload"})}
].
coap_message() ->
[ {id, mk(integer(), #{desc => "message id"})}
, {token, mk(string(), #{desc => "message token, can be empty"})}
, {method, mk(string(), #{desc => "response code"})}
, {payload, mk(string(), #{desc => "payload"})}
[
{id, mk(integer(), #{desc => "message id"})},
{token, mk(string(), #{desc => "message token, can be empty"})},
{method, mk(string(), #{desc => "response code"})},
{payload, mk(string(), #{desc => "payload"})}
].
format_to_response(ContentType, #coap_message{id = Id,
format_to_response(ContentType, #coap_message{
id = Id,
token = Token,
method = Method,
payload = Payload}) ->
#{id => Id,
payload = Payload
}) ->
#{
id => Id,
token => Token,
method => format_to_binary(Method),
payload => format_payload(ContentType, Payload)}.
payload => format_payload(ContentType, Payload)
}.
format_to_binary(Obj) ->
erlang:list_to_binary(io_lib:format("~p", [Obj])).
format_payload(<<"application/octet-stream">>, Payload) ->
base64:encode(Payload);
format_payload(_, Payload) ->
Payload.
parse_payload(<<"application/octet-stream">>, Body) ->
base64:decode(Body);
parse_payload(_, Body) ->
Body.
@ -140,10 +156,13 @@ call_client(ClientId, Msg, Timeout) ->
_ ->
not_found
end
catch _:Error:Trace ->
?SLOG(warning, #{msg => "coap_client_call_exception",
catch
_:Error:Trace ->
?SLOG(warning, #{
msg => "coap_client_call_exception",
clientid => ClientId,
error => Error,
stacktrace => Trace}),
stacktrace => Trace
}),
not_found
end.

448
apps/emqx_gateway/src/coap/emqx_coap_channel.erl
View File

@ -19,25 +19,28 @@
-behaviour(emqx_gateway_channel).
%% API
-export([ info/1
, info/2
, stats/1
, validator/4
, metrics_inc/2
, run_hooks/3
, send_request/2
-export([
info/1,
info/2,
stats/1,
validator/4,
metrics_inc/2,
run_hooks/3,
send_request/2
]).
-export([ init/2
, handle_in/2
, handle_deliver/2
, handle_timeout/3
, terminate/2
-export([
init/2,
handle_in/2,
handle_deliver/2,
handle_timeout/3,
terminate/2
]).
-export([ handle_call/3
, handle_cast/2
, handle_info/2
-export([
handle_call/3,
handle_cast/2,
handle_info/2
]).
-export_type([channel/0]).
@ -73,7 +76,8 @@
-type conn_state() :: idle | connecting | connected | disconnected.
-type reply() :: {outgoing, coap_message()}
-type reply() ::
{outgoing, coap_message()}
| {outgoing, [coap_message()]}
| {event, conn_state() | updated}
| {close, Reason :: atom()}.
@ -100,7 +104,6 @@ info(Channel) ->
-spec info(list(atom()) | atom(), channel()) -> term().
info(Keys, Channel) when is_list(Keys) ->
[{Key, info(Key, Channel)} || Key <- Keys];
info(conninfo, #channel{conninfo = ConnInfo}) ->
ConnInfo;
info(conn_state, #channel{conn_state = ConnState}) ->
@ -119,40 +122,46 @@ stats(_) ->
[].
-spec init(map(), map()) -> channel().
init(ConnInfo = #{peername := {PeerHost, _},
sockname := {_, SockPort}},
#{ctx := Ctx} = Config) ->
init(
ConnInfo = #{
peername := {PeerHost, _},
sockname := {_, SockPort}
},
#{ctx := Ctx} = Config
) ->
Peercert = maps:get(peercert, ConnInfo, undefined),
Mountpoint = maps:get(mountpoint, Config, <<>>),
ListenerId = case maps:get(listener, Config, undefined) of
ListenerId =
case maps:get(listener, Config, undefined) of
undefined -> undefined;
{GwName, Type, LisName} ->
emqx_gateway_utils:listener_id(GwName, Type, LisName)
{GwName, Type, LisName} -> emqx_gateway_utils:listener_id(GwName, Type, LisName)
end,
ClientInfo = set_peercert_infos(
Peercert,
#{ zone => default
, listener => ListenerId
, protocol => 'coap'
, peerhost => PeerHost
, sockport => SockPort
, clientid => emqx_guid:to_base62(emqx_guid:gen())
, username => undefined
, is_bridge => false
, is_superuser => false
, mountpoint => Mountpoint
#{
zone => default,
listener => ListenerId,
protocol => 'coap',
peerhost => PeerHost,
sockport => SockPort,
clientid => emqx_guid:to_base62(emqx_guid:gen()),
username => undefined,
is_bridge => false,
is_superuser => false,
mountpoint => Mountpoint
}
),
Heartbeat = ?GET_IDLE_TIME(Config),
#channel{ ctx = Ctx
, conninfo = ConnInfo
, clientinfo = ClientInfo
, timers = #{}
, session = emqx_coap_session:new()
, keepalive = emqx_keepalive:init(Heartbeat)
, connection_required = maps:get(connection_required, Config, false)
, conn_state = idle
#channel{
ctx = Ctx,
conninfo = ConnInfo,
clientinfo = ClientInfo,
timers = #{},
session = emqx_coap_session:new(),
keepalive = emqx_keepalive:init(Heartbeat),
connection_required = maps:get(connection_required, Config, false),
conn_state = idle
}.
validator(Type, Topic, Ctx, ClientInfo) ->
@ -166,8 +175,8 @@ send_request(Channel, Request) ->
%% Handle incoming packet
%%--------------------------------------------------------------------
-spec handle_in(coap_message() | {frame_error, any()}, channel())
-> {ok, channel()}
-spec handle_in(coap_message() | {frame_error, any()}, channel()) ->
{ok, channel()}
| {ok, replies(), channel()}
| {shutdown, Reason :: term(), channel()}
| {shutdown, Reason :: term(), replies(), channel()}.
@ -183,8 +192,13 @@ handle_in(Msg, ChannleT) ->
%%--------------------------------------------------------------------
%% Handle Delivers from broker to client
%%--------------------------------------------------------------------
handle_deliver(Delivers, #channel{session = Session,
ctx = Ctx} = Channel) ->
handle_deliver(
Delivers,
#channel{
session = Session,
ctx = Ctx
} = Channel
) ->
handle_result(emqx_coap_session:deliver(Delivers, Ctx, Session), Channel).
%%--------------------------------------------------------------------
@ -199,13 +213,10 @@ handle_timeout(_, {keepalive, NewVal}, #channel{keepalive = KeepAlive} = Channel
{error, timeout} ->
{shutdown, timeout, ensure_disconnected(keepalive_timeout, Channel)}
end;
handle_timeout(_, {transport, Msg}, Channel) ->
call_session(timeout, Msg, Channel);
handle_timeout(_, disconnect, Channel) ->
{shutdown, normal, Channel};
handle_timeout(_, _, Channel) ->
{ok, Channel}.
@ -213,72 +224,89 @@ handle_timeout(_, _, Channel) ->
%% Handle call
%%--------------------------------------------------------------------
-spec(handle_call(Req :: term(), From :: term(), channel())
-> {reply, Reply :: term(), channel()}
-spec handle_call(Req :: term(), From :: term(), channel()) ->
{reply, Reply :: term(), channel()}
| {reply, Reply :: term(), replies(), channel()}
| {shutdown, Reason :: term(), Reply :: term(), channel()}
| {shutdown, Reason :: term(), Reply :: term(), coap_message(), channel()}).
| {shutdown, Reason :: term(), Reply :: term(), coap_message(), channel()}.
handle_call({send_request, Msg}, From, Channel) ->
Result = call_session(handle_out, {{send_request, From}, Msg}, Channel),
erlang:setelement(1, Result, noreply);
handle_call({subscribe, Topic, SubOpts}, _From,
handle_call(
{subscribe, Topic, SubOpts},
_From,
Channel = #channel{
ctx = Ctx,
clientinfo = ClientInfo
= #{clientid := ClientId,
mountpoint := Mountpoint},
session = Session}) ->
Token = maps:get(token,
clientinfo =
ClientInfo =
#{
clientid := ClientId,
mountpoint := Mountpoint
},
session = Session
}
) ->
Token = maps:get(
token,
maps:get(sub_props, SubOpts, #{}),
<<>>),
<<>>
),
NSubOpts = maps:merge(
emqx_gateway_utils:default_subopts(),
SubOpts),
SubOpts
),
MountedTopic = emqx_mountpoint:mount(Mountpoint, Topic),
_ = emqx_broker:subscribe(MountedTopic, ClientId, NSubOpts),
_ = run_hooks(Ctx, 'session.subscribed',
[ClientInfo, MountedTopic, NSubOpts]),
_ = run_hooks(
Ctx,
'session.subscribed',
[ClientInfo, MountedTopic, NSubOpts]
),
%% modify session state
SubReq = {Topic, Token},
TempMsg = #coap_message{type = non},
%% FIXME: The subopts is not used for emqx_coap_session
Result = emqx_coap_session:process_subscribe(
SubReq, TempMsg, #{}, Session),
SubReq, TempMsg, #{}, Session
),
NSession = maps:get(session, Result),
{reply, {ok, {MountedTopic, NSubOpts}}, Channel#channel{session = NSession}};
handle_call({unsubscribe, Topic}, _From,
handle_call(
{unsubscribe, Topic},
_From,
Channel = #channel{
ctx = Ctx,
clientinfo = ClientInfo
= #{mountpoint := Mountpoint},
session = Session}) ->
clientinfo =
ClientInfo =
#{mountpoint := Mountpoint},
session = Session
}
) ->
MountedTopic = emqx_mountpoint:mount(Mountpoint, Topic),
ok = emqx_broker:unsubscribe(MountedTopic),
_ = run_hooks(Ctx, 'session.unsubscribe',
[ClientInfo, MountedTopic, #{}]),
_ = run_hooks(
Ctx,
'session.unsubscribe',
[ClientInfo, MountedTopic, #{}]
),
%% modify session state
UnSubReq = Topic,
TempMsg = #coap_message{type = non},
Result = emqx_coap_session:process_subscribe(
UnSubReq, TempMsg, #{}, Session),
UnSubReq, TempMsg, #{}, Session
),
NSession = maps:get(session, Result),
{reply, ok, Channel#channel{session = NSession}};
handle_call(subscriptions, _From, Channel = #channel{session = Session}) ->
Subs = emqx_coap_session:info(subscriptions, Session),
{reply, {ok, maps:to_list(Subs)}, Channel};
handle_call(kick, _From, Channel) ->
NChannel = ensure_disconnected(kicked, Channel),
shutdown_and_reply(kicked, ok, NChannel);
handle_call(discard, _From, Channel) ->
shutdown_and_reply(discarded, ok, Channel);
handle_call(Req, _From, Channel) ->
?SLOG(error, #{msg => "unexpected_call", call => Req}),
{reply, ignored, Channel}.
@ -287,8 +315,8 @@ handle_call(Req, _From, Channel) ->
%% Handle Cast
%%--------------------------------------------------------------------
-spec handle_cast(Req :: term(), channel())
-> ok | {ok, channel()} | {shutdown, Reason :: term(), channel()}.
-spec handle_cast(Req :: term(), channel()) ->
ok | {ok, channel()} | {shutdown, Reason :: term(), channel()}.
handle_cast(Req, Channel) ->
?SLOG(error, #{msg => "unexpected_cast", cast => Req}),
{ok, Channel}.
@ -297,11 +325,10 @@ handle_cast(Req, Channel) ->
%% Handle Info
%%--------------------------------------------------------------------
-spec(handle_info(Info :: term(), channel())
-> ok | {ok, channel()} | {shutdown, Reason :: term(), channel()}).
-spec handle_info(Info :: term(), channel()) ->
ok | {ok, channel()} | {shutdown, Reason :: term(), channel()}.
handle_info({subscribe, _AutoSubs}, Channel) ->
{ok, Channel};
handle_info(Info, Channel) ->
?SLOG(warning, #{msg => "unexpected_info", info => Info}),
{ok, Channel}.
@ -309,21 +336,23 @@ handle_info(Info, Channel) ->
%%--------------------------------------------------------------------
%% Terminate
%%--------------------------------------------------------------------
terminate(Reason, #channel{clientinfo = ClientInfo,
terminate(Reason, #channel{
clientinfo = ClientInfo,
ctx = Ctx,
session = Session}) ->
session = Session
}) ->
run_hooks(Ctx, 'session.terminated', [ClientInfo, Reason, Session]).
%%--------------------------------------------------------------------
%% Internal functions
%%--------------------------------------------------------------------
set_peercert_infos(NoSSL, ClientInfo)
when NoSSL =:= nossl;
NoSSL =:= undefined ->
set_peercert_infos(NoSSL, ClientInfo) when
NoSSL =:= nossl;
NoSSL =:= undefined
->
ClientInfo;
set_peercert_infos(Peercert, ClientInfo) ->
{DN, CN} = {esockd_peercert:subject(Peercert),
esockd_peercert:common_name(Peercert)},
{DN, CN} = {esockd_peercert:subject(Peercert), esockd_peercert:common_name(Peercert)},
ClientInfo#{dn => DN, cn => CN}.
ensure_timer(Name, Time, Msg, #channel{timers = Timers} = Channel) ->
@ -348,15 +377,21 @@ ensure_keepalive_timer(Fun, #channel{keepalive = KeepAlive} = Channel) ->
check_auth_state(Msg, #channel{connection_required = Required} = Channel) ->
check_token(Required, Msg, Channel).
check_token(true,
check_token(
true,
Msg,
#channel{token = Token,
#channel{
token = Token,
clientinfo = ClientInfo,
conn_state = CState} = Channel) ->
conn_state = CState
} = Channel
) ->
#{clientid := ClientId} = ClientInfo,
case emqx_coap_message:get_option(uri_query, Msg) of
#{<<"clientid">> := ClientId,
<<"token">> := Token} ->
#{
<<"clientid">> := ClientId,
<<"token">> := Token
} ->
call_session(handle_request, Msg, Channel);
#{<<"clientid">> := DesireId} ->
try_takeover(CState, DesireId, Msg, Channel);
@ -364,7 +399,6 @@ check_token(true,
Reply = emqx_coap_message:piggyback({error, unauthorized}, Msg),
{ok, {outgoing, Reply}, Channel}
end;
check_token(false, Msg, Channel) ->
call_session(handle_request, Msg, Channel).
@ -383,7 +417,6 @@ try_takeover(idle, DesireId, Msg, Channel) ->
do_takeover(DesireId, Msg, Channel)
end
end;
try_takeover(_, DesireId, Msg, Channel) ->
do_takeover(DesireId, Msg, Channel).
@ -392,43 +425,57 @@ do_takeover(_DesireId, Msg, Channel) ->
Reset = emqx_coap_message:reset(Msg),
{ok, {outgoing, Reset}, Channel}.
run_conn_hooks(Input, Channel = #channel{ctx = Ctx,
conninfo = ConnInfo}) ->
run_conn_hooks(
Input,
Channel = #channel{
ctx = Ctx,
conninfo = ConnInfo
}
) ->
ConnProps = #{},
case run_hooks(Ctx, 'client.connect', [ConnInfo], ConnProps) of
Error = {error, _Reason} -> Error;
_NConnProps ->
{ok, Input, Channel}
_NConnProps -> {ok, Input, Channel}
end.
enrich_conninfo({Queries, _Msg},
enrich_conninfo(
{Queries, _Msg},
Channel = #channel{
keepalive = KeepAlive,
conninfo = ConnInfo}) ->
conninfo = ConnInfo
}
) ->
case Queries of
#{<<"clientid">> := ClientId} ->
Interval = maps:get(interval, emqx_keepalive:info(KeepAlive)),
NConnInfo = ConnInfo#{ clientid => ClientId
, proto_name => <<"CoAP">>
, proto_ver => <<"1">>
, clean_start => true
, keepalive => Interval
, expiry_interval => 0
NConnInfo = ConnInfo#{
clientid => ClientId,
proto_name => <<"CoAP">>,
proto_ver => <<"1">>,
clean_start => true,
keepalive => Interval,
expiry_interval => 0
},
{ok, Channel#channel{conninfo = NConnInfo}};
_ ->
{error, "invalid queries", Channel}
end.
enrich_clientinfo({Queries, Msg},
Channel = #channel{clientinfo = ClientInfo0}) ->
enrich_clientinfo(
{Queries, Msg},
Channel = #channel{clientinfo = ClientInfo0}
) ->
case Queries of
#{<<"username">> := UserName,
#{
<<"username">> := UserName,
<<"password">> := Password,
<<"clientid">> := ClientId} ->
ClientInfo = ClientInfo0#{username => UserName,
<<"clientid">> := ClientId
} ->
ClientInfo = ClientInfo0#{
username => UserName,
password => Password,
clientid => ClientId},
clientid => ClientId
},
{ok, NClientInfo} = fix_mountpoint(Msg, ClientInfo),
{ok, Channel#channel{clientinfo = NClientInfo}};
_ ->
@ -439,18 +486,26 @@ set_log_meta(_Input, #channel{clientinfo = #{clientid := ClientId}}) ->
emqx_logger:set_metadata_clientid(ClientId),
ok.
auth_connect(_Input, Channel = #channel{ctx = Ctx,
clientinfo = ClientInfo}) ->
#{clientid := ClientId,
username := Username} = ClientInfo,
auth_connect(
_Input,
Channel = #channel{
ctx = Ctx,
clientinfo = ClientInfo
}
) ->
#{
clientid := ClientId,
username := Username
} = ClientInfo,
case emqx_gateway_ctx:authenticate(Ctx, ClientInfo) of
{ok, NClientInfo} ->
{ok, Channel#channel{clientinfo = NClientInfo}};
{error, Reason} ->
?SLOG(warning, #{ msg => "client_login_failed"
, username => Username
, clientid => ClientId
, reason => Reason
?SLOG(warning, #{
msg => "client_login_failed",
username => Username,
clientid => ClientId,
reason => Reason
}),
{error, Reason}
end.
@ -461,32 +516,43 @@ fix_mountpoint(_Packet, ClientInfo = #{mountpoint := Mountpoint}) ->
Mountpoint1 = emqx_mountpoint:replvar(Mountpoint, ClientInfo),
{ok, ClientInfo#{mountpoint := Mountpoint1}}.
process_connect(#channel{ctx = Ctx,
process_connect(
#channel{
ctx = Ctx,
session = Session,
conninfo = ConnInfo,
clientinfo = ClientInfo} = Channel,
Msg, Result, Iter) ->
clientinfo = ClientInfo
} = Channel,
Msg,
Result,
Iter
) ->
%% inherit the old session
SessFun = fun(_, _) -> Session end,
case emqx_gateway_ctx:open_session(
case
emqx_gateway_ctx:open_session(
Ctx,
true,
ClientInfo,
ConnInfo,
SessFun,
emqx_coap_session
) of
)
of
{ok, _Sess} ->
RandVal = rand:uniform(?TOKEN_MAXIMUM),
Token = erlang:list_to_binary(erlang:integer_to_list(RandVal)),
NResult = Result#{events => [{event, connected}]},
iter(Iter,
iter(
Iter,
reply({ok, created}, Token, Msg, NResult),
Channel#channel{token = Token});
Channel#channel{token = Token}
);
{error, Reason} ->
?SLOG(error, #{ msg => "failed_open_session"
, clientid => maps:get(clientid, ClientInfo)
, reason => Reason
?SLOG(error, #{
msg => "failed_open_session",
clientid => maps:get(clientid, ClientInfo),
reason => Reason
}),
iter(Iter, reply({error, bad_request}, Msg, Result), Channel)
end.
@ -505,11 +571,14 @@ metrics_inc(Name, Ctx) ->
%%--------------------------------------------------------------------
%% Ensure connected
ensure_connected(Channel = #channel{ctx = Ctx,
ensure_connected(
Channel = #channel{
ctx = Ctx,
conninfo = ConnInfo,
clientinfo = ClientInfo}) ->
NConnInfo = ConnInfo#{ connected_at => erlang:system_time(millisecond)
},
clientinfo = ClientInfo
}
) ->
NConnInfo = ConnInfo#{connected_at => erlang:system_time(millisecond)},
_ = run_hooks(Ctx, 'client.connack', [NConnInfo, connection_accepted, []]),
ok = run_hooks(Ctx, 'client.connected', [ClientInfo, NConnInfo]),
Channel#channel{conninfo = NConnInfo, conn_state = connected}.
@ -517,10 +586,14 @@ ensure_connected(Channel = #channel{ctx = Ctx,
%%--------------------------------------------------------------------
%% Ensure disconnected
ensure_disconnected(Reason, Channel = #channel{
ensure_disconnected(
Reason,
Channel = #channel{
ctx = Ctx,
conninfo = ConnInfo,
clientinfo = ClientInfo}) ->
clientinfo = ClientInfo
}
) ->
NConnInfo = ConnInfo#{disconnected_at => erlang:system_time(millisecond)},
ok = run_hooks(Ctx, 'client.disconnected', [ClientInfo, Reason, NConnInfo]),
Channel#channel{conninfo = NConnInfo, conn_state = disconnected}.
@ -540,18 +613,32 @@ call_session(Fun, Msg, #channel{session = Session} = Channel) ->
handle_result(Result, Channel).
handle_result(Result, Channel) ->
iter([ session, fun process_session/4
, proto, fun process_protocol/4
, reply, fun process_reply/4
, out, fun process_out/4
, fun process_nothing/3
iter(
[
session,
fun process_session/4,
proto,
fun process_protocol/4,
reply,
fun process_reply/4,
out,
fun process_out/4,
fun process_nothing/3
],
Result,
Channel).
Channel
).
call_handler(request, Msg, Result,
#channel{ctx = Ctx,
clientinfo = ClientInfo} = Channel, Iter) ->
call_handler(
request,
Msg,
Result,
#channel{
ctx = Ctx,
clientinfo = ClientInfo
} = Channel,
Iter
) ->
HandlerResult =
case emqx_coap_message:get_option(uri_path, Msg) of
[<<"ps">> | RestPath] ->
@ -561,15 +648,20 @@ call_handler(request, Msg, Result,
_ ->
reply({error, bad_request}, Msg)
end,
iter([ connection, fun process_connection/4
, subscribe, fun process_subscribe/4 | Iter],
iter(
[
connection,
fun process_connection/4,
subscribe,
fun process_subscribe/4
| Iter
],
maps:merge(Result, HandlerResult),
Channel);
Channel
);
call_handler(response, {{send_request, From}, Response}, Result, Channel, Iter) ->
gen_server:reply(From, Response),
iter(Iter, Result, Channel);
call_handler(_, _, Result, Channel, Iter) ->
iter(Iter, Result, Channel).
@ -582,7 +674,8 @@ process_protocol({Type, Msg}, Result, Channel, Iter) ->
%% leaf node
process_out(Outs, Result, Channel, _) ->
Outs2 = lists:reverse(Outs),
Outs3 = case maps:get(reply, Result, undefined) of
Outs3 =
case maps:get(reply, Result, undefined) of
undefined ->
Outs2;
Reply ->
@ -595,32 +688,48 @@ process_out(Outs, Result, Channel, _) ->
process_nothing(_, _, Channel) ->
{ok, Channel}.
process_connection({open, Req}, Result,
Channel = #channel{conn_state = idle}, Iter) ->
process_connection(
{open, Req},
Result,
Channel = #channel{conn_state = idle},
Iter
) ->
Queries = emqx_coap_message:get_option(uri_query, Req),
case emqx_misc:pipeline(
[ fun enrich_conninfo/2
, fun run_conn_hooks/2
, fun enrich_clientinfo/2
, fun set_log_meta/2
, fun auth_connect/2
case
emqx_misc:pipeline(
[
fun enrich_conninfo/2,
fun run_conn_hooks/2,
fun enrich_clientinfo/2,
fun set_log_meta/2,
fun auth_connect/2
],
{Queries, Req},
Channel) of
Channel
)
of
{ok, _Input, NChannel} ->
process_connect(ensure_connected(NChannel), Req, Result, Iter);
{error, ReasonCode, NChannel} ->
ErrMsg = io_lib:format("Login Failed: ~ts", [ReasonCode]),
Payload = iolist_to_binary(ErrMsg),
iter(Iter,
iter(
Iter,
reply({error, bad_request}, Payload, Req, Result),
NChannel)
NChannel
)
end;
process_connection({open, Req}, Result,
process_connection(
{open, Req},
Result,
Channel = #channel{
conn_state = ConnState,
clientinfo = #{clientid := ClientId}}, Iter)
when ConnState == connected ->
clientinfo = #{clientid := ClientId}
},
Iter
) when
ConnState == connected
->
Queries = emqx_coap_message:get_option(uri_query, Req),
ErrMsg0 =
case Queries of
@ -633,9 +742,11 @@ process_connection({open, Req}, Result,
end,
ErrMsg = io_lib:format("Bad Request: ~ts", [ErrMsg0]),
Payload = iolist_to_binary(ErrMsg),
iter(Iter,
iter(
Iter,
reply({error, bad_request}, Payload, Req, Result),
Channel);
Channel
);
process_connection({close, Msg}, _, Channel, _) ->
Reply = emqx_coap_message:piggyback({ok, deleted}, Msg),
NChannel = ensure_disconnected(normal, Channel),
@ -651,5 +762,4 @@ process_reply(Reply, Result, #channel{session = Session} = Channel, _) ->
Outs = maps:get(out, Result, []),
Outs2 = lists:reverse(Outs),
Events = maps:get(events, Result, []),
{ok, [{outgoing, [Reply | Outs2]}] ++ Events,
Channel#channel{session = Session2}}.
{ok, [{outgoing, [Reply | Outs2]}] ++ Events, Channel#channel{session = Session2}}.

262
apps/emqx_gateway/src/coap/emqx_coap_frame.erl
View File

@ -19,13 +19,14 @@
-behaviour(emqx_gateway_frame).
%% emqx_gateway_frame callbacks
-export([ initial_parse_state/1
, serialize_opts/0
, serialize_pkt/2
, parse/2
, format/1
, type/1
, is_message/1
-export([
initial_parse_state/1,
serialize_opts/0,
serialize_pkt/2,
parse/2,
format/1,
type/1,
is_message/1
]).
-include("src/coap/include/emqx_coap.hrl").
@ -37,7 +38,8 @@
-define(OPTION_URI_HOST, 3).
-define(OPTION_ETAG, 4).
-define(OPTION_IF_NONE_MATCH, 5).
-define(OPTION_OBSERVE, 6). % draft-ietf-core-observe-16
% draft-ietf-core-observe-16
-define(OPTION_OBSERVE, 6).
-define(OPTION_URI_PORT, 7).
-define(OPTION_LOCATION_PATH, 8).
-define(OPTION_URI_PATH, 11).
@ -46,7 +48,8 @@
-define(OPTION_URI_QUERY, 15).
-define(OPTION_ACCEPT, 17).
-define(OPTION_LOCATION_QUERY, 20).
-define(OPTION_BLOCK2, 23). % draft-ietf-core-block-17
% draft-ietf-core-block-17
-define(OPTION_BLOCK2, 23).
-define(OPTION_BLOCK1, 27).
-define(OPTION_PROXY_URI, 35).
-define(OPTION_PROXY_SCHEME, 39).
@ -70,18 +73,21 @@ serialize_opts() ->
%% empty message
serialize_pkt(#coap_message{type = Type, method = undefined, id = MsgId}, _Opts) ->
<<?VERSION:2, (encode_type(Type)):2, 0:4, 0:3, 0:5, MsgId:16>>;
serialize_pkt(#coap_message{ type = Type
, method = Method
, id = MsgId
, token = Token
, options = Options
, payload = Payload
serialize_pkt(
#coap_message{
type = Type,
method = Method,
id = MsgId,
token = Token,
options = Options,
payload = Payload
},
_Opts) ->
_Opts
) ->
TKL = byte_size(Token),
{Class, Code} = method_to_class_code(Method),
Head = <<?VERSION:2, (encode_type(Type)):2, TKL:4, Class:3, Code:5, MsgId:16, Token:TKL/binary>>,
Head =
<<?VERSION:2, (encode_type(Type)):2, TKL:4, Class:3, Code:5, MsgId:16, Token:TKL/binary>>,
FlatOpts = flatten_options(Options),
encode_option_list(FlatOpts, 0, Head, Payload).
@ -96,23 +102,24 @@ flatten_options(Opts) ->
flatten_options([{_OptId, undefined} | T], Acc) ->
flatten_options(T, Acc);
flatten_options([{OptId, OptVal} | T], Acc) ->
flatten_options(T,
flatten_options(
T,
case is_repeatable_option(OptId) of
false ->
[encode_option(OptId, OptVal) | Acc];
_ ->
try_encode_repeatable(OptId, OptVal) ++ Acc
end);
end
);
flatten_options([], Acc) ->
%% sort by option id for calculate the deltas
lists:keysort(1, Acc).
encode_option_list([{OptNum, OptVal} | OptionList], LastNum, Acc, Payload) ->
NumDiff = OptNum - LastNum,
{Delta, ExtNum} = if
{Delta, ExtNum} =
if
NumDiff >= 269 ->
{14, <<(NumDiff - 269):16>>};
OptNum - LastNum >= 13 ->
@ -121,7 +128,8 @@ encode_option_list([{OptNum, OptVal} | OptionList], LastNum, Acc, Payload) ->
{NumDiff, <<>>}
end,
Binaryize = byte_size(OptVal),
{Len, ExtLen} = if
{Len, ExtLen} =
if
Binaryize >= 269 ->
{14, <<(Binaryize - 269):16>>};
Binaryize >= 13 ->
@ -131,56 +139,84 @@ encode_option_list([{OptNum, OptVal} | OptionList], LastNum, Acc, Payload) ->
end,
Acc2 = <<Acc/binary, Delta:4, Len:4, ExtNum/binary, ExtLen/binary, OptVal/binary>>,
encode_option_list(OptionList, OptNum, Acc2, Payload);
encode_option_list([], _LastNum, Acc, <<>>) ->
Acc;
encode_option_list([], _, Acc, Payload) ->
<<Acc/binary, 16#FF, Payload/binary>>.
try_encode_repeatable(uri_query, Val) when is_map(Val) ->
maps:fold(fun(K, V, Acc) ->
maps:fold(
fun(K, V, Acc) ->
[encode_option(uri_query, <<K/binary, $=, V/binary>>) | Acc]
end,
[], Val);
[],
Val
);
try_encode_repeatable(K, Val) ->
lists:foldr(fun(undefined, Acc) ->
lists:foldr(
fun
(undefined, Acc) ->
Acc;
(E, Acc) ->
[encode_option(K, E) | Acc]
end, [], Val).
end,
[],
Val
).
%% RFC 7252
encode_option(if_match, OptVal) -> {?OPTION_IF_MATCH, OptVal};
encode_option(uri_host, OptVal) -> {?OPTION_URI_HOST, OptVal};
encode_option(etag, OptVal) -> {?OPTION_ETAG, OptVal};
encode_option(if_none_match, true) -> {?OPTION_IF_NONE_MATCH, <<>>};
encode_option(uri_port, OptVal) -> {?OPTION_URI_PORT, binary:encode_unsigned(OptVal)};
encode_option(location_path, OptVal) -> {?OPTION_LOCATION_PATH, OptVal};
encode_option(uri_path, OptVal) -> {?OPTION_URI_PATH, OptVal};
encode_option(if_match, OptVal) ->
{?OPTION_IF_MATCH, OptVal};
encode_option(uri_host, OptVal) ->
{?OPTION_URI_HOST, OptVal};
encode_option(etag, OptVal) ->
{?OPTION_ETAG, OptVal};
encode_option(if_none_match, true) ->
{?OPTION_IF_NONE_MATCH, <<>>};
encode_option(uri_port, OptVal) ->
{?OPTION_URI_PORT, binary:encode_unsigned(OptVal)};
encode_option(location_path, OptVal) ->
{?OPTION_LOCATION_PATH, OptVal};
encode_option(uri_path, OptVal) ->
{?OPTION_URI_PATH, OptVal};
encode_option(content_format, OptVal) when is_integer(OptVal) ->
{?OPTION_CONTENT_FORMAT, binary:encode_unsigned(OptVal)};
encode_option(content_format, OptVal) ->
Num = content_format_to_code(OptVal),
{?OPTION_CONTENT_FORMAT, binary:encode_unsigned(Num)};
encode_option(max_age, OptVal) -> {?OPTION_MAX_AGE, binary:encode_unsigned(OptVal)};
encode_option(uri_query, OptVal) -> {?OPTION_URI_QUERY, OptVal};
encode_option('accept', OptVal) -> {?OPTION_ACCEPT, binary:encode_unsigned(OptVal)};
encode_option(location_query, OptVal) -> {?OPTION_LOCATION_QUERY, OptVal};
encode_option(proxy_uri, OptVal) -> {?OPTION_PROXY_URI, OptVal};
encode_option(proxy_scheme, OptVal) -> {?OPTION_PROXY_SCHEME, OptVal};
encode_option(size1, OptVal) -> {?OPTION_SIZE1, binary:encode_unsigned(OptVal)};
encode_option(observe, OptVal) -> {?OPTION_OBSERVE, binary:encode_unsigned(OptVal)};
encode_option(block2, OptVal) -> {?OPTION_BLOCK2, encode_block(OptVal)};
encode_option(block1, OptVal) -> {?OPTION_BLOCK1, encode_block(OptVal)};
encode_option(max_age, OptVal) ->
{?OPTION_MAX_AGE, binary:encode_unsigned(OptVal)};
encode_option(uri_query, OptVal) ->
{?OPTION_URI_QUERY, OptVal};
encode_option('accept', OptVal) ->
{?OPTION_ACCEPT, binary:encode_unsigned(OptVal)};
encode_option(location_query, OptVal) ->
{?OPTION_LOCATION_QUERY, OptVal};
encode_option(proxy_uri, OptVal) ->
{?OPTION_PROXY_URI, OptVal};
encode_option(proxy_scheme, OptVal) ->
{?OPTION_PROXY_SCHEME, OptVal};
encode_option(size1, OptVal) ->
{?OPTION_SIZE1, binary:encode_unsigned(OptVal)};
encode_option(observe, OptVal) ->
{?OPTION_OBSERVE, binary:encode_unsigned(OptVal)};
encode_option(block2, OptVal) ->
{?OPTION_BLOCK2, encode_block(OptVal)};
encode_option(block1, OptVal) ->
{?OPTION_BLOCK1, encode_block(OptVal)};
%% unknown opton
encode_option(Option, Value) ->
erlang:throw({bad_option, Option, Value}).
encode_block({Num, More, Size}) ->
encode_block1(Num,
if More -> 1; true -> 0 end,
trunc(math:log2(Size))-4).
encode_block1(
Num,
if
More -> 1;
true -> 0
end,
trunc(math:log2(Size)) - 4
).
encode_block1(Num, M, SizEx) when Num < 16 ->
<<Num:4, M:1, SizEx:3>>;
@ -199,7 +235,8 @@ content_format_to_code(<<"application/json">>) -> 50;
content_format_to_code(<<"application/cbor">>) -> 60;
content_format_to_code(<<"application/vnd.oma.lwm2m+tlv">>) -> 11542;
content_format_to_code(<<"application/vnd.oma.lwm2m+json">>) -> 11543;
content_format_to_code(_) -> 42. %% use octet-stream as default
%% use octet-stream as default
content_format_to_code(_) -> 42.
method_to_class_code(get) -> {0, 01};
method_to_class_code(post) -> {0, 02};
@ -229,43 +266,47 @@ method_to_class_code({error, bad_gateway}) -> {5, 02};
method_to_class_code({error, service_unavailable}) -> {5, 03};
method_to_class_code({error, gateway_timeout}) -> {5, 04};
method_to_class_code({error, proxying_not_supported}) -> {5, 05};
method_to_class_code(Method) ->
erlang:throw({bad_method, Method}).
method_to_class_code(Method) -> erlang:throw({bad_method, Method}).
%%--------------------------------------------------------------------
%% parse
%%--------------------------------------------------------------------
-spec parse(binary(), emqx_gateway_frame:parse_state())
-> emqx_gateway_frame:parse_result().
-spec parse(binary(), emqx_gateway_frame:parse_state()) ->
emqx_gateway_frame:parse_result().
parse(<<?VERSION:2, Type:2, 0:4, 0:3, 0:5, MsgId:16>>, ParseState) ->
{ok,
#coap_message{ type = decode_type(Type)
, id = MsgId},
<<>>,
ParseState};
parse(<<?VERSION:2, Type:2, TKL:4, Class:3, Code:5, MsgId:16, Token:TKL/binary, Tail/binary>>,
ParseState) ->
#coap_message{
type = decode_type(Type),
id = MsgId
},
<<>>, ParseState};
parse(
<<?VERSION:2, Type:2, TKL:4, Class:3, Code:5, MsgId:16, Token:TKL/binary, Tail/binary>>,
ParseState
) ->
{Options, Payload} = decode_option_list(Tail),
Options2 = maps:fold(fun(K, V, Acc) ->
Options2 = maps:fold(
fun(K, V, Acc) ->
Acc#{K => get_option_val(K, V)}
end,
#{},
Options),
Options
),
{ok,
#coap_message{ type = decode_type(Type)
, method = class_code_to_method({Class, Code})
, id = MsgId
, token = Token
, options = Options2
, payload = Payload
#coap_message{
type = decode_type(Type),
method = class_code_to_method({Class, Code}),
id = MsgId,
token = Token,
options = Options2,
payload = Payload
},
<<>>,
ParseState}.
<<>>, ParseState}.
get_option_val(uri_query, V) ->
KVList = lists:foldl(fun(E, Acc) ->
KVList = lists:foldl(
fun(E, Acc) ->
case re:split(E, "=") of
[Key, Val] ->
[{Key, Val} | Acc];
@ -274,9 +315,9 @@ get_option_val(uri_query, V) ->
end
end,
[],
V),
V
),
maps:from_list(KVList);
get_option_val(K, V) ->
case is_repeatable_option(K) of
true ->
@ -285,8 +326,8 @@ get_option_val(K, V) ->
V
end.
-spec decode_type(X) -> message_type()
when X :: 0 .. 3.
-spec decode_type(X) -> message_type() when
X :: 0..3.
decode_type(0) -> con;
decode_type(1) -> non;
decode_type(2) -> ack;
@ -298,10 +339,8 @@ decode_option_list(Bin) ->
decode_option_list(<<>>, _OptNum, OptMap) ->
{OptMap, <<>>};
decode_option_list(<<16#FF, Payload/binary>>, _OptNum, OptMap) ->
{OptMap, Payload};
decode_option_list(<<Delta:4, Len:4, Bin/binary>>, OptNum, OptMap) ->
case Delta of
Any when Any < 13 ->
@ -349,30 +388,48 @@ append_option(OptNum, RawOptVal, OptMap) ->
end.
%% RFC 7252
decode_option(?OPTION_IF_MATCH, OptVal) -> {if_match, OptVal};
decode_option(?OPTION_URI_HOST, OptVal) -> {uri_host, OptVal};
decode_option(?OPTION_ETAG, OptVal) -> {etag, OptVal};
decode_option(?OPTION_IF_NONE_MATCH, <<>>) -> {if_none_match, true};
decode_option(?OPTION_URI_PORT, OptVal) -> {uri_port, binary:decode_unsigned(OptVal)};
decode_option(?OPTION_LOCATION_PATH, OptVal) -> {location_path, OptVal};
decode_option(?OPTION_URI_PATH, OptVal) -> {uri_path, OptVal};
decode_option(?OPTION_IF_MATCH, OptVal) ->
{if_match, OptVal};
decode_option(?OPTION_URI_HOST, OptVal) ->
{uri_host, OptVal};
decode_option(?OPTION_ETAG, OptVal) ->
{etag, OptVal};
decode_option(?OPTION_IF_NONE_MATCH, <<>>) ->
{if_none_match, true};
decode_option(?OPTION_URI_PORT, OptVal) ->
{uri_port, binary:decode_unsigned(OptVal)};
decode_option(?OPTION_LOCATION_PATH, OptVal) ->
{location_path, OptVal};
decode_option(?OPTION_URI_PATH, OptVal) ->
{uri_path, OptVal};
decode_option(?OPTION_CONTENT_FORMAT, OptVal) ->
Num = binary:decode_unsigned(OptVal),
{content_format, content_code_to_format(Num)};
decode_option(?OPTION_MAX_AGE, OptVal) -> {max_age, binary:decode_unsigned(OptVal)};
decode_option(?OPTION_URI_QUERY, OptVal) -> {uri_query, OptVal};
decode_option(?OPTION_ACCEPT, OptVal) -> {'accept', binary:decode_unsigned(OptVal)};
decode_option(?OPTION_LOCATION_QUERY, OptVal) -> {location_query, OptVal};
decode_option(?OPTION_PROXY_URI, OptVal) -> {proxy_uri, OptVal};
decode_option(?OPTION_PROXY_SCHEME, OptVal) -> {proxy_scheme, OptVal};
decode_option(?OPTION_SIZE1, OptVal) -> {size1, binary:decode_unsigned(OptVal)};
decode_option(?OPTION_MAX_AGE, OptVal) ->
{max_age, binary:decode_unsigned(OptVal)};
decode_option(?OPTION_URI_QUERY, OptVal) ->
{uri_query, OptVal};
decode_option(?OPTION_ACCEPT, OptVal) ->
{'accept', binary:decode_unsigned(OptVal)};
decode_option(?OPTION_LOCATION_QUERY, OptVal) ->
{location_query, OptVal};
decode_option(?OPTION_PROXY_URI, OptVal) ->
{proxy_uri, OptVal};
decode_option(?OPTION_PROXY_SCHEME, OptVal) ->
{proxy_scheme, OptVal};
decode_option(?OPTION_SIZE1, OptVal) ->
{size1, binary:decode_unsigned(OptVal)};
%% draft-ietf-core-observe-16
decode_option(?OPTION_OBSERVE, OptVal) -> {observe, binary:decode_unsigned(OptVal)};
decode_option(?OPTION_OBSERVE, OptVal) ->
{observe, binary:decode_unsigned(OptVal)};
%% draft-ietf-core-block-17
decode_option(?OPTION_BLOCK2, OptVal) -> {block2, decode_block(OptVal)};
decode_option(?OPTION_BLOCK1, OptVal) -> {block1, decode_block(OptVal)};
decode_option(?OPTION_BLOCK2, OptVal) ->
{block2, decode_block(OptVal)};
decode_option(?OPTION_BLOCK1, OptVal) ->
{block1, decode_block(OptVal)};
%% unknown option
decode_option(OptNum, OptVal) -> {OptNum, OptVal}.
decode_option(OptNum, OptVal) ->
{OptNum, OptVal}.
decode_block(<<Num:4, M:1, SizEx:3>>) -> decode_block1(Num, M, SizEx);
decode_block(<<Num:12, M:1, SizEx:3>>) -> decode_block1(Num, M, SizEx);
@ -391,7 +448,8 @@ content_code_to_format(50) -> <<"application/json">>;
content_code_to_format(60) -> <<"application/cbor">>;
content_code_to_format(11542) -> <<"application/vnd.oma.lwm2m+tlv">>;
content_code_to_format(11543) -> <<"application/vnd.oma.lwm2m+json">>;
content_code_to_format(_) -> <<"application/octet-stream">>. %% use octet as default
%% use octet as default
content_code_to_format(_) -> <<"application/octet-stream">>.
%% RFC 7252
%% atom indicate a request
@ -399,7 +457,6 @@ class_code_to_method({0, 01}) -> get;
class_code_to_method({0, 02}) -> post;
class_code_to_method({0, 03}) -> put;
class_code_to_method({0, 04}) -> delete;
%% success is a tuple {ok, ...}
class_code_to_method({2, 01}) -> {ok, created};
class_code_to_method({2, 02}) -> {ok, deleted};
@ -407,8 +464,8 @@ class_code_to_method({2, 03}) -> {ok, valid};
class_code_to_method({2, 04}) -> {ok, changed};
class_code_to_method({2, 05}) -> {ok, content};
class_code_to_method({2, 07}) -> {ok, nocontent};
class_code_to_method({2, 31}) -> {ok, continue}; % block
% block
class_code_to_method({2, 31}) -> {ok, continue};
%% error is a tuple {error, ...}
class_code_to_method({4, 00}) -> {error, bad_request};
class_code_to_method({4, 01}) -> {error, unauthorized};
@ -417,7 +474,8 @@ class_code_to_method({4, 03}) -> {error, forbidden};
class_code_to_method({4, 04}) -> {error, not_found};
class_code_to_method({4, 05}) -> {error, method_not_allowed};
class_code_to_method({4, 06}) -> {error, not_acceptable};
class_code_to_method({4, 08}) -> {error, request_entity_incomplete}; % block
% block
class_code_to_method({4, 08}) -> {error, request_entity_incomplete};
class_code_to_method({4, 12}) -> {error, precondition_failed};
class_code_to_method({4, 13}) -> {error, request_entity_too_large};
class_code_to_method({4, 15}) -> {error, unsupported_content_format};

71
apps/emqx_gateway/src/coap/emqx_coap_impl.erl
View File

@ -21,20 +21,25 @@
-include_lib("emqx/include/logger.hrl").
-include_lib("emqx_gateway/include/emqx_gateway.hrl").
-import(emqx_gateway_utils,
[ normalize_config/1
, start_listeners/4
, stop_listeners/2
]).
-import(
emqx_gateway_utils,
[
normalize_config/1,
start_listeners/4,
stop_listeners/2
]
).
%% APIs
-export([ reg/0
, unreg/0
-export([
reg/0,
unreg/0
]).
-export([ on_gateway_load/2
, on_gateway_update/3
, on_gateway_unload/2
-export([
on_gateway_load/2,
on_gateway_update/3,
on_gateway_unload/2
]).
%%--------------------------------------------------------------------
@ -42,8 +47,7 @@
%%--------------------------------------------------------------------
reg() ->
RegistryOptions = [ {cbkmod, ?MODULE}
],
RegistryOptions = [{cbkmod, ?MODULE}],
emqx_gateway_registry:reg(coap, RegistryOptions).
unreg() ->
@ -53,22 +57,33 @@ unreg() ->
%% emqx_gateway_registry callbacks
%%--------------------------------------------------------------------
on_gateway_load(_Gateway = #{name := GwName,
on_gateway_load(
_Gateway = #{
name := GwName,
config := Config
}, Ctx) ->
},
Ctx
) ->
Listeners = normalize_config(Config),
ModCfg = #{frame_mod => emqx_coap_frame,
ModCfg = #{
frame_mod => emqx_coap_frame,
chann_mod => emqx_coap_channel
},
case start_listeners(
Listeners, GwName, Ctx, ModCfg) of
case
start_listeners(
Listeners, GwName, Ctx, ModCfg
)
of
{ok, ListenerPids} ->
{ok, ListenerPids, #{ctx => Ctx}};
{error, {Reason, Listener}} ->
throw({badconf, #{ key => listeners
, vallue => Listener
, reason => Reason
}})
throw(
{badconf, #{
key => listeners,
vallue => Listener,
reason => Reason
}}
)
end.
on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
@ -80,14 +95,20 @@ on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
on_gateway_load(Gateway#{config => Config}, Ctx)
catch
Class:Reason:Stk ->
logger:error("Failed to update ~ts; "
logger:error(
"Failed to update ~ts; "
"reason: {~0p, ~0p} stacktrace: ~0p",
[GwName, Class, Reason, Stk]),
[GwName, Class, Reason, Stk]
),
{error, Reason}
end.
on_gateway_unload(_Gateway = #{ name := GwName,
on_gateway_unload(
_Gateway = #{
name := GwName,
config := Config
}, _GwState) ->
},
_GwState
) ->
Listeners = normalize_config(Config),
stop_listeners(GwName, Listeners).

18
apps/emqx_gateway/src/coap/emqx_coap_medium.erl
View File

@ -23,10 +23,15 @@
-include("src/coap/include/emqx_coap.hrl").
%% API
-export([ empty/0, reset/1, reset/2
, out/1, out/2, proto_out/1
, proto_out/2, iter/3, iter/4
, reply/2, reply/3, reply/4]).
-export([
empty/0,
reset/1, reset/2,
out/1, out/2,
proto_out/1,
proto_out/2,
iter/3, iter/4,
reply/2, reply/3, reply/4
]).
%%-type result() :: map() | empty.
@ -46,7 +51,6 @@ out(Msg) ->
out(Msg, #{out := Outs} = Result) ->
Result#{out := [Msg | Outs]};
out(Msg, Result) ->
Result#{out => [Msg]}.
@ -58,13 +62,11 @@ proto_out(Proto, Result) ->
reply(Method, Req) when not is_record(Method, coap_message) ->
reply(Method, <<>>, Req);
reply(Reply, Result) ->
Result#{reply => Reply}.
reply(Method, Req, Result) when is_record(Req, coap_message) ->
reply(Method, <<>>, Req, Result);
reply(Method, Payload, Req) ->
reply(Method, Payload, Req, #{}).
@ -87,7 +89,6 @@ iter([Key, Fun | T], Input, State) ->
%% FunH(Val, maps:remove(Key, Input), State, FunT)
%% end
end;
%% terminal node
iter([Fun], Input, State) ->
Fun(undefined, Input, State).
@ -100,7 +101,6 @@ iter([Key, Fun | T], Input, Arg, State) ->
Val ->
Fun(Val, maps:remove(Key, Input), Arg, State, T)
end;
iter([Fun], Input, Arg, State) ->
Fun(undefined, Input, Arg, State).

60
apps/emqx_gateway/src/coap/emqx_coap_message.erl
View File

@ -24,15 +24,24 @@
%% convenience functions for message construction
-module(emqx_coap_message).
-export([ request/2, request/3, request/4
, ack/1, response/1, response/2
, reset/1, piggyback/2, piggyback/3
, response/3]).
-export([
request/2, request/3, request/4,
ack/1,
response/1, response/2,
reset/1,
piggyback/2, piggyback/3,
response/3
]).
-export([is_request/1]).
-export([ set/3, set_payload/2, get_option/2
, get_option/3, set_payload_block/3, set_payload_block/4]).
-export([
set/3,
set_payload/2,
get_option/2,
get_option/3,
set_payload_block/3, set_payload_block/4
]).
-include("src/coap/include/emqx_coap.hrl").
@ -43,10 +52,12 @@ request(Type, Method, Payload) ->
request(Type, Method, Payload, []).
request(Type, Method, Payload, Options) when is_binary(Payload) ->
#coap_message{type = Type,
#coap_message{
type = Type,
method = Method,
payload = Payload,
options = to_options(Options)}.
options = to_options(Options)
}.
ack(#coap_message{id = Id}) ->
#coap_message{type = ack, id = Id}.
@ -61,14 +72,18 @@ response(Request) ->
response(Method, Request) ->
response(Method, <<>>, Request).
response(Method, Payload, #coap_message{type = Type,
response(Method, Payload, #coap_message{
type = Type,
id = Id,
token = Token}) ->
#coap_message{type = Type,
token = Token
}) ->
#coap_message{
type = Type,
id = Id,
token = Token,
method = Method,
payload = Payload}.
payload = Payload
}.
%% make a response which maybe is a piggyback ack
piggyback(Method, Request) ->
@ -84,8 +99,8 @@ piggyback(Method, Payload, Request) ->
end.
%% omit option for its default value
set(max_age, ?DEFAULT_MAX_AGE, Msg) -> Msg;
set(max_age, ?DEFAULT_MAX_AGE, Msg) ->
Msg;
%% set non-default value
set(Option, Value, Msg = #coap_message{options = Options}) ->
Msg#coap_message{options = Options#{Option => Value}}.
@ -98,13 +113,11 @@ get_option(Option, #coap_message{options = Options}, Def) ->
set_payload(Payload, Msg) when is_binary(Payload) ->
Msg#coap_message{payload = Payload};
set_payload(Payload, Msg) when is_list(Payload) ->
Msg#coap_message{payload = list_to_binary(Payload)}.
set_payload_block(Content, Block, Msg = #coap_message{method = Method}) when is_atom(Method) ->
set_payload_block(Content, block1, Block, Msg);
set_payload_block(Content, Block, Msg = #coap_message{}) ->
set_payload_block(Content, block2, Block, Msg).
@ -114,16 +127,21 @@ set_payload_block(Content, BlockId, {Num, _, Size}, Msg) ->
OffsetEnd = OffsetBegin + Size,
case ContentSize > OffsetEnd of
true ->
set(BlockId, {Num, true, Size},
set_payload(binary:part(Content, OffsetBegin, Size), Msg));
set(
BlockId,
{Num, true, Size},
set_payload(binary:part(Content, OffsetBegin, Size), Msg)
);
_ ->
set(BlockId, {Num, false, Size},
set_payload(binary:part(Content, OffsetBegin, ContentSize - OffsetBegin), Msg))
set(
BlockId,
{Num, false, Size},
set_payload(binary:part(Content, OffsetBegin, ContentSize - OffsetBegin), Msg)
)
end.
is_request(#coap_message{method = Method}) when is_atom(Method) ->
Method =/= undefined;
is_request(_) ->
false.

36
apps/emqx_gateway/src/coap/emqx_coap_observe_res.erl
View File

@ -17,8 +17,14 @@
-module(emqx_coap_observe_res).
%% API
-export([ new_manager/0, insert/3, remove/2
, res_changed/2, foreach/2, subscriptions/1]).
-export([
new_manager/0,
insert/3,
remove/2,
res_changed/2,
foreach/2,
subscriptions/1
]).
-export_type([manager/0]).
-define(MAX_SEQ_ID, 16777215).
@ -26,8 +32,9 @@
-type token() :: binary().
-type seq_id() :: 0..?MAX_SEQ_ID.
-type res() :: #{ token := token()
, seq_id := seq_id()
-type res() :: #{
token := token(),
seq_id := seq_id()
}.
-type manager() :: #{emqx_types:topic() => res()}.
@ -41,7 +48,8 @@ new_manager() ->
-spec insert(emqx_types:topic(), token(), manager()) -> {seq_id(), manager()}.
insert(Topic, Token, Manager) ->
Res = case maps:get(Topic, Manager, undefined) of
Res =
case maps:get(Topic, Manager, undefined) of
undefined ->
new_res(Token);
Any ->
@ -59,17 +67,21 @@ res_changed(Topic, Manager) ->
undefined ->
undefined;
Res ->
#{token := Token,
seq_id := SeqId} = Res2 = res_changed(Res),
#{
token := Token,
seq_id := SeqId
} = Res2 = res_changed(Res),
{Token, SeqId, Manager#{Topic := Res2}}
end.
foreach(F, Manager) ->
maps:fold(fun(K, V, _) ->
maps:fold(
fun(K, V, _) ->
F(K, V)
end,
ok,
Manager),
Manager
),
ok.
-spec subscriptions(manager()) -> [emqx_types:topic()].
@ -81,8 +93,10 @@ subscriptions(Manager) ->
%%--------------------------------------------------------------------
-spec new_res(token()) -> res().
new_res(Token) ->
#{token => Token,
seq_id => 0}.
#{
token => Token,
seq_id => 0
}.
-spec res_changed(res()) -> res().
res_changed(#{seq_id := SeqId} = Res) ->

119
apps/emqx_gateway/src/coap/emqx_coap_session.erl
View File

@ -21,40 +21,47 @@
-include("src/coap/include/emqx_coap.hrl").
%% API
-export([ new/0
, process_subscribe/4
-export([
new/0,
process_subscribe/4
]).
-export([ info/1
, info/2
, stats/1
-export([
info/1,
info/2,
stats/1
]).
-export([ handle_request/2
, handle_response/2
, handle_out/2
, set_reply/2
, deliver/3
, timeout/2]).
-export([
handle_request/2,
handle_response/2,
handle_out/2,
set_reply/2,
deliver/3,
timeout/2
]).
-export_type([session/0]).
-record(session, { transport_manager :: emqx_coap_tm:manager()
, observe_manager :: emqx_coap_observe_res:manager()
, created_at :: pos_integer()
-record(session, {
transport_manager :: emqx_coap_tm:manager(),
observe_manager :: emqx_coap_observe_res:manager(),
created_at :: pos_integer()
}).
-type session() :: #session{}.
%% steal from emqx_session
-define(INFO_KEYS, [subscriptions,
-define(INFO_KEYS, [
subscriptions,
upgrade_qos,
retry_interval,
await_rel_timeout,
created_at
]).
-define(STATS_KEYS, [subscriptions_cnt,
-define(STATS_KEYS, [
subscriptions_cnt,
subscriptions_max,
inflight_cnt,
inflight_max,
@ -75,16 +82,18 @@
-spec new() -> session().
new() ->
_ = emqx_misc:rand_seed(),
#session{ transport_manager = emqx_coap_tm:new()
, observe_manager = emqx_coap_observe_res:new_manager()
, created_at = erlang:system_time(millisecond)}.
#session{
transport_manager = emqx_coap_tm:new(),
observe_manager = emqx_coap_observe_res:new_manager(),
created_at = erlang:system_time(millisecond)
}.
%%--------------------------------------------------------------------
%% Info, Stats
%%--------------------------------------------------------------------
%% @doc Compatible with emqx_session
%% do we need use inflight and mqueue in here?
-spec(info(session()) -> emqx_types:infos()).
-spec info(session()) -> emqx_types:infos().
info(Session) ->
maps:from_list(info(?INFO_KEYS, Session)).
@ -94,7 +103,9 @@ info(subscriptions, #session{observe_manager = OM}) ->
Topics = emqx_coap_observe_res:subscriptions(OM),
lists:foldl(
fun(T, Acc) -> Acc#{T => emqx_gateway_utils:default_subopts()} end,
#{}, Topics);
#{},
Topics
);
info(subscriptions_cnt, #session{observe_manager = OM}) ->
erlang:length(emqx_coap_observe_res:subscriptions(OM));
info(subscriptions_max, _) ->
@ -131,16 +142,18 @@ info(created_at, #session{created_at = CreatedAt}) ->
CreatedAt.
%% @doc Get stats of the session.
-spec(stats(session()) -> emqx_types:stats()).
-spec stats(session()) -> emqx_types:stats().
stats(Session) -> info(?STATS_KEYS, Session).
%%%-------------------------------------------------------------------
%%% Process Message
%%%-------------------------------------------------------------------
handle_request(Msg, Session) ->
call_transport_manager(?FUNCTION_NAME,
call_transport_manager(
?FUNCTION_NAME,
Msg,
Session).
Session
).
handle_response(Msg, Session) ->
call_transport_manager(?FUNCTION_NAME, Msg, Session).
@ -152,8 +165,14 @@ set_reply(Msg, #session{transport_manager = TM} = Session) ->
TM2 = emqx_coap_tm:set_reply(Msg, TM),
Session#session{transport_manager = TM2}.
deliver(Delivers, Ctx, #session{observe_manager = OM,
transport_manager = TM} = Session) ->
deliver(
Delivers,
Ctx,
#session{
observe_manager = OM,
transport_manager = TM
} = Session
) ->
Fun = fun({_, Topic, Message}, {OutAcc, OMAcc, TMAcc} = Acc) ->
case emqx_coap_observe_res:res_changed(Topic, OMAcc) of
undefined ->
@ -169,9 +188,13 @@ deliver(Delivers, Ctx, #session{observe_manager = OM,
end,
{Outs, OM2, TM2} = lists:foldl(Fun, {[], OM, TM}, lists:reverse(Delivers)),
#{out => lists:reverse(Outs),
session => Session#session{observe_manager = OM2,
transport_manager = TM2}}.
#{
out => lists:reverse(Outs),
session => Session#session{
observe_manager = OM2,
transport_manager = TM2
}
}.
timeout(Timer, Session) ->
call_transport_manager(?FUNCTION_NAME, Timer, Session).
@ -179,13 +202,17 @@ timeout(Timer, Session) ->
%%%-------------------------------------------------------------------
%%% Internal functions
%%%-------------------------------------------------------------------
call_transport_manager(Fun,
call_transport_manager(
Fun,
Msg,
#session{transport_manager = TM} = Session) ->
#session{transport_manager = TM} = Session
) ->
Result = emqx_coap_tm:Fun(Msg, TM),
iter([tm, fun process_tm/4, fun process_session/3],
iter(
[tm, fun process_tm/4, fun process_session/3],
Result,
Session).
Session
).
process_tm(TM, Result, Session, Cursor) ->
iter(Cursor, Result, Session#session{transport_manager = TM}).
@ -193,8 +220,12 @@ process_tm(TM, Result, Session, Cursor) ->
process_session(_, Result, Session) ->
Result#{session => Session}.
process_subscribe(Sub, Msg, Result,
#session{observe_manager = OM} = Session) ->
process_subscribe(
Sub,
Msg,
Result,
#session{observe_manager = OM} = Session
) ->
case Sub of
undefined ->
Result;
@ -202,22 +233,28 @@ process_subscribe(Sub, Msg, Result,
{SeqId, OM2} = emqx_coap_observe_res:insert(Topic, Token, OM),
Replay = emqx_coap_message:piggyback({ok, content}, Msg),
Replay2 = Replay#coap_message{options = #{observe => SeqId}},
Result#{reply => Replay2,
session => Session#session{observe_manager = OM2}};
Result#{
reply => Replay2,
session => Session#session{observe_manager = OM2}
};
Topic ->
OM2 = emqx_coap_observe_res:remove(Topic, OM),
Replay = emqx_coap_message:piggyback({ok, nocontent}, Msg),
Result#{reply => Replay,
session => Session#session{observe_manager = OM2}}
Result#{
reply => Replay,
session => Session#session{observe_manager = OM2}
}
end.
mqtt_to_coap(MQTT, Token, SeqId) ->
#message{payload = Payload} = MQTT,
#coap_message{type = get_notify_type(MQTT),
#coap_message{
type = get_notify_type(MQTT),
method = {ok, content},
token = Token,
payload = Payload,
options = #{observe => SeqId}}.
options = #{observe => SeqId}
}.
get_notify_type(#message{qos = Qos}) ->
case emqx_conf:get([gateway, coap, notify_qos], non) of

210
apps/emqx_gateway/src/coap/emqx_coap_tm.erl
View File

@ -17,13 +17,15 @@
%% the transport state machine manager
-module(emqx_coap_tm).
-export([ new/0
, handle_request/2
, handle_response/2
, handle_out/2
, handle_out/3
, set_reply/2
, timeout/2]).
-export([
new/0,
handle_request/2,
handle_response/2,
handle_out/2,
handle_out/3,
set_reply/2,
timeout/2
]).
-export_type([manager/0, event_result/1]).
@ -32,13 +34,15 @@
-type direction() :: in | out.
-record(state_machine, { seq_id :: seq_id()
, id :: state_machine_key()
, token :: token() | undefined
, observe :: 0 | 1 | undefined | observed
, state :: atom()
, timers :: maps:map()
, transport :: emqx_coap_transport:transport()}).
-record(state_machine, {
seq_id :: seq_id(),
id :: state_machine_key(),
token :: token() | undefined,
observe :: 0 | 1 | undefined | observed,
state :: atom(),
timers :: maps:map(),
transport :: emqx_coap_transport:transport()
}).
-type state_machine() :: #state_machine{}.
-type message_id() :: 0..?MAX_MESSAGE_ID.
@ -47,14 +51,16 @@
-type seq_id() :: pos_integer().
-type manager_key() :: token_key() | state_machine_key() | seq_id().
-type manager() :: #{ seq_id => seq_id()
, next_msg_id => coap_message_id()
, token_key() => seq_id()
, state_machine_key() => seq_id()
, seq_id() => state_machine()
-type manager() :: #{
seq_id => seq_id(),
next_msg_id => coap_message_id(),
token_key() => seq_id(),
state_machine_key() => seq_id(),
seq_id() => state_machine()
}.
-type ttimeout() :: {state_timeout, pos_integer(), any()}
-type ttimeout() ::
{state_timeout, pos_integer(), any()}
| {stop_timeout, pos_integer()}.
-type topic() :: binary().
@ -62,11 +68,13 @@
-type sub_register() :: {topic(), token()} | topic().
-type event_result(State) ::
#{next => State,
#{
next => State,
outgoing => coap_message(),
timeouts => list(ttimeout()),
has_sub => undefined | sub_register(),
transport => emqx_coap_transport:transport()}.
transport => emqx_coap_transport:transport()
}.
-define(TOKEN_ID(T), {token, T}).
@ -78,8 +86,9 @@
-spec new() -> manager().
new() ->
#{ seq_id => 1
, next_msg_id => rand:uniform(?MAX_MESSAGE_ID)
#{
seq_id => 1,
next_msg_id => rand:uniform(?MAX_MESSAGE_ID)
}.
handle_request(#coap_message{id = MsgId} = Msg, TM) ->
@ -111,7 +120,6 @@ handle_response(#coap_message{type = Type, id = MsgId, token = Token} = Msg, TM)
%% send to a client, msg can be request/piggyback/separate/notify
handle_out({Ctx, Msg}, TM) ->
handle_out(Msg, Ctx, TM);
handle_out(Msg, TM) ->
handle_out(Msg, undefined, TM).
@ -135,8 +143,10 @@ set_reply(#coap_message{id = MsgId} = Msg, TM) ->
case find_machine(Id, TM) of
undefined ->
TM;
#state_machine{transport = Transport,
seq_id = SeqId} = Machine ->
#state_machine{
transport = Transport,
seq_id = SeqId
} = Machine ->
Transport2 = emqx_coap_transport:set_cache(Msg, Transport),
Machine2 = Machine#state_machine{transport = Transport2},
TM#{SeqId => Machine2}
@ -161,35 +171,52 @@ timeout({SeqId, Type, Msg}, TM) ->
%%--------------------------------------------------------------------
process_event(stop_timeout, _, TM, Machine) ->
process_manager(stop, #{}, Machine, TM);
process_event(Event, Msg, TM, #state_machine{state = State,
transport = Transport} = Machine) ->
process_event(
Event,
Msg,
TM,
#state_machine{
state = State,
transport = Transport
} = Machine
) ->
Result = emqx_coap_transport:State(Event, Msg, Transport),
iter([ proto, fun process_observe_response/5
, next, fun process_state_change/5
, transport, fun process_transport_change/5
, timeouts, fun process_timeouts/5
, fun process_manager/4],
iter(
[
proto,
fun process_observe_response/5,
next,
fun process_state_change/5,
transport,
fun process_transport_change/5,
timeouts,
fun process_timeouts/5,
fun process_manager/4
],
Result,
Machine,
TM).
TM
).
process_observe_response({response, {_, Msg}} = Response,
process_observe_response(
{response, {_, Msg}} = Response,
Result,
#state_machine{observe = 0} = Machine,
TM,
Iter) ->
Iter
) ->
Result2 = proto_out(Response, Result),
case Msg#coap_message.method of
{ok, _} ->
iter(Iter,
iter(
Iter,
Result2#{next => observe},
Machine#state_machine{observe = observed},
TM);
TM
);
_ ->
iter(Iter, Result2, Machine, TM)
end;
process_observe_response(Proto, Result, Machine, TM, Iter) ->
iter(Iter, proto_out(Proto, Result), Machine, TM).
@ -198,10 +225,12 @@ process_state_change(Next, Result, Machine, TM, Iter) ->
stop ->
process_manager(stop, Result, Machine, TM);
_ ->
iter(Iter,
iter(
Iter,
Result,
cancel_state_timer(Machine#state_machine{state = Next}),
TM)
TM
)
end.
process_transport_change(Transport, Result, Machine, TM, Iter) ->
@ -209,22 +238,30 @@ process_transport_change(Transport, Result, Machine, TM, Iter) ->
process_timeouts([], Result, Machine, TM, Iter) ->
iter(Iter, Result, Machine, TM);
process_timeouts(Timeouts, Result,
#state_machine{seq_id = SeqId,
timers = Timers} = Machine, TM, Iter) ->
NewTimers = lists:foldl(fun({state_timeout, _, _} = Timer, Acc) ->
process_timeouts(
Timeouts,
Result,
#state_machine{
seq_id = SeqId,
timers = Timers
} = Machine,
TM,
Iter
) ->
NewTimers = lists:foldl(
fun
({state_timeout, _, _} = Timer, Acc) ->
process_timer(SeqId, Timer, Acc);
({stop_timeout, I}, Acc) ->
process_timer(SeqId, {stop_timeout, I, stop}, Acc)
end,
Timers,
Timeouts),
Timeouts
),
iter(Iter, Result, Machine#state_machine{timers = NewTimers}, TM).
process_manager(stop, Result, #state_machine{seq_id = SeqId}, TM) ->
Result#{tm => delete_machine(SeqId, TM)};
process_manager(_, Result, #state_machine{seq_id = SeqId} = Machine2, TM) ->
Result#{tm => TM#{SeqId => Machine2}}.
@ -246,14 +283,18 @@ delete_machine(Id, Manager) ->
case find_machine(Id, Manager) of
undefined ->
Manager;
#state_machine{seq_id = SeqId,
#state_machine{
seq_id = SeqId,
id = MachineId,
token = Token,
timers = Timers} ->
lists:foreach(fun({_, Ref}) ->
timers = Timers
} ->
lists:foreach(
fun({_, Ref}) ->
emqx_misc:cancel_timer(Ref)
end,
maps:to_list(Timers)),
maps:to_list(Timers)
),
maps:without([SeqId, MachineId, ?TOKEN_ID(Token)], Manager)
end.
@ -268,8 +309,10 @@ find_machine(SeqId, Manager) ->
find_machine_by_seqid(SeqId, Manager) ->
maps:get(SeqId, Manager, undefined).
-spec find_machine_by_keys(list(manager_key()),
manager()) -> state_machine() | undefined.
-spec find_machine_by_keys(
list(manager_key()),
manager()
) -> state_machine() | undefined.
find_machine_by_keys([H | T], Manager) ->
case H of
?TOKEN_ID(<<>>) ->
@ -288,35 +331,46 @@ find_machine_by_keys(_, _) ->
-spec new_in_machine(state_machine_key(), manager()) ->
{state_machine(), manager()}.
new_in_machine(MachineId, #{seq_id := SeqId} = Manager) ->
Machine = #state_machine{ seq_id = SeqId
, id = MachineId
, state = idle
, timers = #{}
, transport = emqx_coap_transport:new()},
{Machine, Manager#{seq_id := SeqId + 1,
Machine = #state_machine{
seq_id = SeqId,
id = MachineId,
state = idle,
timers = #{},
transport = emqx_coap_transport:new()
},
{Machine, Manager#{
seq_id := SeqId + 1,
SeqId => Machine,
MachineId => SeqId}}.
MachineId => SeqId
}}.
-spec new_out_machine(state_machine_key(), any(), coap_message(), manager()) ->
{state_machine(), manager()}.
new_out_machine(MachineId,
new_out_machine(
MachineId,
Ctx,
#coap_message{type = Type, token = Token, options = Opts},
#{seq_id := SeqId} = Manager) ->
#{seq_id := SeqId} = Manager
) ->
Observe = maps:get(observe, Opts, undefined),
Machine = #state_machine{ seq_id = SeqId
, id = MachineId
, token = Token
, observe = Observe
, state = idle
, timers = #{}
, transport = emqx_coap_transport:new(Ctx)},
Machine = #state_machine{
seq_id = SeqId,
id = MachineId,
token = Token,
observe = Observe,
state = idle,
timers = #{},
transport = emqx_coap_transport:new(Ctx)
},
Manager2 = Manager#{seq_id := SeqId + 1,
Manager2 = Manager#{
seq_id := SeqId + 1,
SeqId => Machine,
MachineId => SeqId},
MachineId => SeqId
},
{Machine,
if Token =:= <<>> ->
if
Token =:= <<>> ->
Manager2;
Observe =:= 1 ->
TokenId = ?TOKEN_ID(Token),
@ -331,8 +385,7 @@ new_out_machine(MachineId,
end;
true ->
Manager2
end
}.
end}.
alloc_message_id(#{next_msg_id := MsgId} = TM) ->
alloc_message_id(MsgId, TM).
@ -348,7 +401,8 @@ alloc_message_id(MsgId, TM) ->
next_message_id(MsgId) ->
Next = MsgId + 1,
if Next >= ?MAX_MESSAGE_ID ->
if
Next >= ?MAX_MESSAGE_ID ->
1;
true ->
Next

168
apps/emqx_gateway/src/coap/emqx_coap_transport.erl
View File

@ -11,71 +11,102 @@
-type request_context() :: any().
-record(transport, { cache :: undefined | coap_message()
, req_context :: request_context()
, retry_interval :: non_neg_integer()
, retry_count :: non_neg_integer()
, observe :: non_neg_integer() | undefined
-record(transport, {
cache :: undefined | coap_message(),
req_context :: request_context(),
retry_interval :: non_neg_integer(),
retry_count :: non_neg_integer(),
observe :: non_neg_integer() | undefined
}).
-type transport() :: #transport{}.
-export([ new/0, new/1, idle/3, maybe_reset/3, set_cache/2
, maybe_resend_4request/3, wait_ack/3, until_stop/3
, observe/3, maybe_resend_4response/3]).
-export([
new/0, new/1,
idle/3,
maybe_reset/3,
set_cache/2,
maybe_resend_4request/3,
wait_ack/3,
until_stop/3,
observe/3,
maybe_resend_4response/3
]).
-export_type([transport/0]).
-import(emqx_coap_medium, [ empty/0, reset/2, proto_out/2
, out/1, out/2, proto_out/1
, reply/2]).
-import(emqx_coap_medium, [
empty/0,
reset/2,
proto_out/2,
out/1, out/2,
proto_out/1,
reply/2
]).
-spec new() -> transport().
new() ->
new(undefined).
new(ReqCtx) ->
#transport{cache = undefined,
#transport{
cache = undefined,
retry_interval = 0,
retry_count = 0,
req_context = ReqCtx}.
req_context = ReqCtx
}.
idle(in,
idle(
in,
#coap_message{type = non, method = Method} = Msg,
_) ->
_
) ->
case Method of
undefined ->
reset(Msg, #{next => stop});
_ ->
proto_out({request, Msg},
#{next => until_stop,
proto_out(
{request, Msg},
#{
next => until_stop,
timeouts =>
[{stop_timeout, ?NON_LIFETIME}]})
[{stop_timeout, ?NON_LIFETIME}]
}
)
end;
idle(in,
idle(
in,
#coap_message{type = con, method = Method} = Msg,
_) ->
_
) ->
case Method of
undefined ->
reset(Msg, #{next => stop});
_ ->
proto_out({request, Msg},
#{next => maybe_resend_4request,
timeouts =>[{stop_timeout, ?EXCHANGE_LIFETIME}]})
proto_out(
{request, Msg},
#{
next => maybe_resend_4request,
timeouts => [{stop_timeout, ?EXCHANGE_LIFETIME}]
}
)
end;
idle(out, #coap_message{type = non} = Msg, _) ->
out(Msg, #{next => maybe_reset,
timeouts => [{stop_timeout, ?NON_LIFETIME}]});
out(Msg, #{
next => maybe_reset,
timeouts => [{stop_timeout, ?NON_LIFETIME}]
});
idle(out, Msg, Transport) ->
_ = emqx_misc:rand_seed(),
Timeout = ?ACK_TIMEOUT + rand:uniform(?ACK_RANDOM_FACTOR),
out(Msg, #{next => wait_ack,
out(Msg, #{
next => wait_ack,
transport => Transport#transport{cache = Msg},
timeouts => [ {state_timeout, Timeout, ack_timeout}
, {stop_timeout, ?EXCHANGE_LIFETIME}]}).
timeouts => [
{state_timeout, Timeout, ack_timeout},
{stop_timeout, ?EXCHANGE_LIFETIME}
]
}).
maybe_resend_4request(in, Msg, Transport) ->
maybe_resend(Msg, true, Transport).
@ -98,18 +129,25 @@ maybe_resend(Msg, IsExpecteReq, #transport{cache = Cache}) ->
reset(Msg, #{next => stop})
end.
maybe_reset(in, #coap_message{type = Type, method = Method} = Message,
#transport{req_context = Ctx} = Transport) ->
maybe_reset(
in,
#coap_message{type = Type, method = Method} = Message,
#transport{req_context = Ctx} = Transport
) ->
Ret = #{next => stop},
CtxMsg = {Ctx, Message},
if Type =:= reset ->
if
Type =:= reset ->
proto_out({reset, CtxMsg}, Ret);
is_tuple(Method) ->
on_response(Message,
on_response(
Message,
Transport,
if Type =:= non -> until_stop;
if
Type =:= non -> until_stop;
true -> maybe_resend_4response
end);
end
);
true ->
reset(Message, Ret)
end.
@ -131,26 +169,37 @@ wait_ack(in, #coap_message{type = Type, method = Method} = Msg, #transport{req_c
reset(Msg, #{next => stop})
end
end;
wait_ack(state_timeout,
wait_ack(
state_timeout,
ack_timeout,
#transport{cache = Msg,
#transport{
cache = Msg,
retry_interval = Timeout,
retry_count = Count} =Transport) ->
retry_count = Count
} = Transport
) ->
case Count < ?MAX_RETRANSMIT of
true ->
Timeout2 = Timeout * 2,
out(Msg,
#{transport => Transport#transport{retry_interval = Timeout2,
retry_count = Count + 1},
timeouts => [{state_timeout, Timeout2, ack_timeout}]});
out(
Msg,
#{
transport => Transport#transport{
retry_interval = Timeout2,
retry_count = Count + 1
},
timeouts => [{state_timeout, Timeout2, ack_timeout}]
}
);
_ ->
proto_out({ack_failure, Msg}, #{next_state => stop})
end.
observe(in,
observe(
in,
#coap_message{method = Method} = Message,
#transport{observe = Observe} = Transport) ->
#transport{observe = Observe} = Transport
) ->
case Method of
{ok, _} ->
case emqx_coap_message:get_option(observe, Message, Observe) of
@ -158,9 +207,11 @@ observe(in,
%% repeatd notify, ignore
empty();
NewObserve ->
on_response(Message,
on_response(
Message,
Transport#transport{observe = NewObserve},
?FUNCTION_NAME)
?FUNCTION_NAME
)
end;
{error, _} ->
#{next => stop};
@ -174,17 +225,24 @@ until_stop(_, _, _) ->
set_cache(Cache, Transport) ->
Transport#transport{cache = Cache}.
on_response(#coap_message{type = Type} = Message,
on_response(
#coap_message{type = Type} = Message,
#transport{req_context = Ctx} = Transport,
NextState) ->
NextState
) ->
CtxMsg = {Ctx, Message},
if Type =:= non ->
if
Type =:= non ->
proto_out({response, CtxMsg}, #{next => NextState});
Type =:= con ->
Ack = emqx_coap_message:ack(Message),
proto_out({response, CtxMsg},
out(Ack, #{next => NextState,
transport => Transport#transport{cache = Ack}}));
proto_out(
{response, CtxMsg},
out(Ack, #{
next => NextState,
transport => Transport#transport{cache = Ack}
})
);
true ->
emqx_coap_message:reset(Message)
end.

4
apps/emqx_gateway/src/coap/handler/emqx_coap_mqtt_handler.erl
View File

@ -24,18 +24,14 @@
handle_request([<<"connection">>], #coap_message{method = Method} = Msg, _Ctx, _CInfo) ->
handle_method(Method, Msg);
handle_request(_, Msg, _, _) ->
reply({error, bad_request}, Msg).
handle_method(put, Msg) ->
reply({ok, changed}, Msg);
handle_method(post, Msg) ->
#{connection => {open, Msg}};
handle_method(delete, Msg) ->
#{connection => {close, Msg}};
handle_method(_, Msg) ->
reply({error, method_not_allowed}, Msg).

33
apps/emqx_gateway/src/coap/handler/emqx_coap_pubsub_handler.erl
View File

@ -49,7 +49,6 @@ handle_method(get, Topic, Msg, Ctx, CInfo) ->
_ ->
reply({error, bad_request}, <<"invalid observe value">>, Msg)
end;
handle_method(post, Topic, #coap_message{payload = Payload} = Msg, Ctx, CInfo) ->
case emqx_coap_channel:validator(publish, Topic, Ctx, CInfo) of
allow ->
@ -64,22 +63,23 @@ handle_method(post, Topic, #coap_message{payload = Payload} = Msg, Ctx, CInfo) -
_ ->
reply({error, unauthorized}, Msg)
end;
handle_method(_, _, Msg, _, _) ->
reply({error, method_not_allowed}, Msg).
check_topic([]) ->
error;
check_topic(Path) ->
Sep = <<"/">>,
{ok,
emqx_http_lib:uri_decode(
lists:foldl(fun(Part, Acc) ->
lists:foldl(
fun(Part, Acc) ->
<<Acc/binary, Sep/binary, Part/binary>>
end,
<<>>,
Path))}.
Path
)
)}.
get_sub_opts(#coap_message{options = Opts} = Msg) ->
SubOpts = maps:fold(fun parse_sub_opts/3, #{}, Opts),
@ -100,9 +100,12 @@ parse_sub_opts(<<"rh">>, V, Opts) ->
parse_sub_opts(_, _, Opts) ->
Opts.
type_to_qos(qos0, _) -> ?QOS_0;
type_to_qos(qos1, _) -> ?QOS_1;
type_to_qos(qos2, _) -> ?QOS_2;
type_to_qos(qos0, _) ->
?QOS_0;
type_to_qos(qos1, _) ->
?QOS_1;
type_to_qos(qos2, _) ->
?QOS_2;
type_to_qos(coap, #coap_message{type = Type}) ->
case Type of
non ->
@ -121,24 +124,28 @@ get_publish_qos(Msg) ->
end.
apply_publish_opts(Msg, MQTTMsg) ->
maps:fold(fun(<<"retain">>, V, Acc) ->
maps:fold(
fun
(<<"retain">>, V, Acc) ->
Val = erlang:binary_to_atom(V),
emqx_message:set_flag(retain, Val, Acc);
(<<"expiry">>, V, Acc) ->
Val = erlang:binary_to_integer(V),
Props = emqx_message:get_header(properties, Acc),
emqx_message:set_header(properties,
emqx_message:set_header(
properties,
Props#{'Message-Expiry-Interval' => Val},
Acc);
Acc
);
(_, _, Acc) ->
Acc
end,
MQTTMsg,
emqx_coap_message:get_option(uri_query, Msg)).
emqx_coap_message:get_option(uri_query, Msg)
).
subscribe(#coap_message{token = <<>>} = Msg, _, _, _) ->
reply({error, bad_request}, <<"observe without token">>, Msg);
subscribe(#coap_message{token = Token} = Msg, Topic, Ctx, CInfo) ->
case emqx_coap_channel:validator(subscribe, Topic, Ctx, CInfo) of
allow ->

55
apps/emqx_gateway/src/coap/include/emqx_coap.hrl
View File

@ -26,7 +26,8 @@
-type message_type() :: con | non | ack | reset.
-type max_age() :: 1..?MAXIMUM_MAX_AGE.
-type message_option_name() :: if_match
-type message_option_name() ::
if_match
| uri_host
| etag
| if_none_match
@ -45,32 +46,36 @@
| block1
| block2.
-type message_options() :: #{ if_match => list(binary())
, uri_host => binary()
, etag => list(binary())
, if_none_match => boolean()
, uri_port => 0 .. 65535
, location_path => list(binary())
, uri_path => list(binary())
, content_format => 0 .. 65535
, max_age => non_neg_integer()
, uri_query => list(binary()) | map()
, 'accept' => 0 .. 65535
, location_query => list(binary())
, proxy_uri => binary()
, proxy_scheme => binary()
, size1 => non_neg_integer()
, observer => non_neg_integer()
, block1 => {non_neg_integer(), boolean(), non_neg_integer()}
, block2 => {non_neg_integer(), boolean(), non_neg_integer()}}.
-type message_options() :: #{
if_match => list(binary()),
uri_host => binary(),
etag => list(binary()),
if_none_match => boolean(),
uri_port => 0..65535,
location_path => list(binary()),
uri_path => list(binary()),
content_format => 0..65535,
max_age => non_neg_integer(),
uri_query => list(binary()) | map(),
'accept' => 0..65535,
location_query => list(binary()),
proxy_uri => binary(),
proxy_scheme => binary(),
size1 => non_neg_integer(),
observer => non_neg_integer(),
block1 => {non_neg_integer(), boolean(), non_neg_integer()},
block2 => {non_neg_integer(), boolean(), non_neg_integer()}
}.
-record(coap_mqtt_auth, {clientid, username, password}).
-record(coap_message, { type :: message_type()
, method
, id
, token = <<>>
, options = #{}
, payload = <<>>}).
-record(coap_message, {
type :: message_type(),
method,
id,
token = <<>>,
options = #{},
payload = <<>>
}).
-type coap_message() :: #coap_message{}.

4
apps/emqx_gateway/src/emqx_gateway.app.src
View File

@ -1,6 +1,6 @@
%% -*- mode: erlang -*-
{application, emqx_gateway,
[{description, "The Gateway management application"},
{application, emqx_gateway, [
{description, "The Gateway management application"},
{vsn, "0.1.0"},
{registered, []},
{mod, {emqx_gateway_app, []}},

28
apps/emqx_gateway/src/emqx_gateway.erl
View File

@ -19,14 +19,15 @@
-include("include/emqx_gateway.hrl").
%% Gateway APIs
-export([ registered_gateway/0
, load/2
, unload/1
, lookup/1
, update/2
, start/1
, stop/1
, list/0
-export([
registered_gateway/0,
load/2,
unload/1,
lookup/1,
update/2,
start/1,
stop/1,
list/0
]).
%%--------------------------------------------------------------------
@ -46,13 +47,14 @@ registered_gateway() ->
list() ->
emqx_gateway_sup:list_gateway_insta().
-spec load(gateway_name(), emqx_config:config())
-> {ok, pid()}
-spec load(gateway_name(), emqx_config:config()) ->
{ok, pid()}
| {error, any()}.
load(Name, Config) ->
Gateway = #{ name => Name
, descr => undefined
, config => Config
Gateway = #{
name => Name,
descr => undefined,
config => Config
},
emqx_gateway_sup:load_gateway(Gateway).

880
apps/emqx_gateway/src/emqx_gateway_api.erl
View File

File diff suppressed because it is too large Load Diff

422
apps/emqx_gateway/src/emqx_gateway_api_authn.erl
View File

@ -24,24 +24,29 @@
-import(hoconsc, [mk/2, ref/2]).
-import(emqx_dashboard_swagger, [error_codes/2]).
-import(emqx_gateway_http,
[ return_http_error/2
, with_gateway/2
, with_authn/2
, checks/2
]).
-import(
emqx_gateway_http,
[
return_http_error/2,
with_gateway/2,
with_authn/2,
checks/2
]
).
%% minirest/dashbaord_swagger behaviour callbacks
-export([ api_spec/0
, paths/0
, schema/1
-export([
api_spec/0,
paths/0,
schema/1
]).
%% http handlers
-export([ authn/2
, users/2
, users_insta/2
, import_users/2
-export([
authn/2,
users/2,
users_insta/2,
import_users/2
]).
%% internal export for emqx_gateway_api_listeners module
@ -55,10 +60,11 @@ api_spec() ->
emqx_dashboard_swagger:spec(?MODULE, #{check_schema => true}).
paths() ->
[ "/gateway/:name/authentication"
, "/gateway/:name/authentication/users"
, "/gateway/:name/authentication/users/:uid"
, "/gateway/:name/authentication/import_users"
[
"/gateway/:name/authentication",
"/gateway/:name/authentication/users",
"/gateway/:name/authentication/users/:uid",
"/gateway/:name/authentication/import_users"
].
%%--------------------------------------------------------------------
@ -66,30 +72,29 @@ paths() ->
authn(get, #{bindings := #{name := Name0}}) ->
with_gateway(Name0, fun(GwName, _) ->
try
emqx_gateway_http:authn(GwName)
of
try emqx_gateway_http:authn(GwName) of
Authn -> {200, Authn}
catch
error:{config_not_found, _} ->
{204}
end
end);
authn(put, #{bindings := #{name := Name0},
body := Body}) ->
authn(put, #{
bindings := #{name := Name0},
body := Body
}) ->
with_gateway(Name0, fun(GwName, _) ->
{ok, Authn} = emqx_gateway_http:update_authn(GwName, Body),
{200, Authn}
end);
authn(post, #{bindings := #{name := Name0},
body := Body}) ->
authn(post, #{
bindings := #{name := Name0},
body := Body
}) ->
with_gateway(Name0, fun(GwName, _) ->
{ok, Authn} = emqx_gateway_http:add_authn(GwName, Body),
{201, Authn}
end);
authn(delete, #{bindings := #{name := Name0}}) ->
with_gateway(Name0, fun(GwName, _) ->
ok = emqx_gateway_http:remove_authn(GwName),
@ -97,47 +102,85 @@ authn(delete, #{bindings := #{name := Name0}}) ->
end).
users(get, #{bindings := #{name := Name0}, query_string := Qs}) ->
with_authn(Name0, fun(_GwName, #{id := AuthId,
chain_name := ChainName}) ->
with_authn(Name0, fun(
_GwName,
#{
id := AuthId,
chain_name := ChainName
}
) ->
emqx_authn_api:list_users(ChainName, AuthId, parse_qstring(Qs))
end);
users(post, #{bindings := #{name := Name0},
body := Body}) ->
with_authn(Name0, fun(_GwName, #{id := AuthId,
chain_name := ChainName}) ->
users(post, #{
bindings := #{name := Name0},
body := Body
}) ->
with_authn(Name0, fun(
_GwName,
#{
id := AuthId,
chain_name := ChainName
}
) ->
emqx_authn_api:add_user(ChainName, AuthId, Body)
end).
users_insta(get, #{bindings := #{name := Name0, uid := UserId}}) ->
with_authn(Name0, fun(_GwName, #{id := AuthId,
chain_name := ChainName}) ->
with_authn(Name0, fun(
_GwName,
#{
id := AuthId,
chain_name := ChainName
}
) ->
emqx_authn_api:find_user(ChainName, AuthId, UserId)
end);
users_insta(put, #{bindings := #{name := Name0, uid := UserId},
body := Body}) ->
with_authn(Name0, fun(_GwName, #{id := AuthId,
chain_name := ChainName}) ->
users_insta(put, #{
bindings := #{name := Name0, uid := UserId},
body := Body
}) ->
with_authn(Name0, fun(
_GwName,
#{
id := AuthId,
chain_name := ChainName
}
) ->
emqx_authn_api:update_user(ChainName, AuthId, UserId, Body)
end);
users_insta(delete, #{bindings := #{name := Name0, uid := UserId}}) ->
with_authn(Name0, fun(_GwName, #{id := AuthId,
chain_name := ChainName}) ->
with_authn(Name0, fun(
_GwName,
#{
id := AuthId,
chain_name := ChainName
}
) ->
emqx_authn_api:delete_user(ChainName, AuthId, UserId)
end).
import_users(post, #{bindings := #{name := Name0},
body := Body}) ->
with_authn(Name0, fun(_GwName, #{id := AuthId,
chain_name := ChainName}) ->
import_users(post, #{
bindings := #{name := Name0},
body := Body
}) ->
with_authn(Name0, fun(
_GwName,
#{
id := AuthId,
chain_name := ChainName
}
) ->
case maps:get(<<"filename">>, Body, undefined) of
undefined ->
emqx_authn_api:serialize_error({missing_parameter, filename});
Filename ->
case emqx_authentication:import_users(
ChainName, AuthId, Filename) of
case
emqx_authentication:import_users(
ChainName, AuthId, Filename
)
of
ok -> {204};
{error, Reason} ->
emqx_authn_api:serialize_error(Reason)
{error, Reason} -> emqx_authn_api:serialize_error(Reason)
end
end
end).
@ -146,124 +189,164 @@ import_users(post, #{bindings := #{name := Name0},
%% Utils
parse_qstring(Qs) ->
maps:with([ <<"page">>
, <<"limit">>
, <<"like_username">>
, <<"like_clientid">>], Qs).
maps:with(
[
<<"page">>,
<<"limit">>,
<<"like_username">>,
<<"like_clientid">>
],
Qs
).
%%--------------------------------------------------------------------
%% Swagger defines
%%--------------------------------------------------------------------
schema("/gateway/:name/authentication") ->
#{ 'operationId' => authn,
#{
'operationId' => authn,
get =>
#{ desc => <<"Get the gateway authentication">>
, parameters => params_gateway_name_in_path()
, responses =>
#{
desc => <<"Get the gateway authentication">>,
parameters => params_gateway_name_in_path(),
responses =>
?STANDARD_RESP(
#{ 200 => schema_authn()
, 204 => <<"Authentication does not initiated">>
})
#{
200 => schema_authn(),
204 => <<"Authentication does not initiated">>
}
)
},
put =>
#{ desc => <<"Update authentication for the gateway">>
, parameters => params_gateway_name_in_path()
, 'requestBody' => schema_authn()
, responses =>
#{
desc => <<"Update authentication for the gateway">>,
parameters => params_gateway_name_in_path(),
'requestBody' => schema_authn(),
responses =>
?STANDARD_RESP(#{200 => schema_authn()})
},
post =>
#{ desc => <<"Add authentication for the gateway">>
, parameters => params_gateway_name_in_path()
, 'requestBody' => schema_authn()
, responses =>
#{
desc => <<"Add authentication for the gateway">>,
parameters => params_gateway_name_in_path(),
'requestBody' => schema_authn(),
responses =>
?STANDARD_RESP(#{201 => schema_authn()})
},
delete =>
#{ desc => <<"Remove the gateway authentication">>
, parameters => params_gateway_name_in_path()
, responses =>
#{
desc => <<"Remove the gateway authentication">>,
parameters => params_gateway_name_in_path(),
responses =>
?STANDARD_RESP(#{204 => <<"Deleted">>})
}
};
schema("/gateway/:name/authentication/users") ->
#{ 'operationId' => users
, get =>
#{ desc => <<"Get the users for the authentication">>
, parameters => params_gateway_name_in_path() ++
#{
'operationId' => users,
get =>
#{
desc => <<"Get the users for the authentication">>,
parameters => params_gateway_name_in_path() ++
params_paging_in_qs() ++
params_fuzzy_in_qs()
, responses =>
params_fuzzy_in_qs(),
responses =>
?STANDARD_RESP(
#{ 200 => emqx_dashboard_swagger:schema_with_example(
#{
200 => emqx_dashboard_swagger:schema_with_example(
ref(emqx_authn_api, response_users),
emqx_authn_api:response_users_example())
})
emqx_authn_api:response_users_example()
)
}
)
},
post =>
#{ desc => <<"Add user for the authentication">>
, parameters => params_gateway_name_in_path()
, 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
#{
desc => <<"Add user for the authentication">>,
parameters => params_gateway_name_in_path(),
'requestBody' => emqx_dashboard_swagger:schema_with_examples(
ref(emqx_authn_api, request_user_create),
emqx_authn_api:request_user_create_examples())
, responses =>
emqx_authn_api:request_user_create_examples()
),
responses =>
?STANDARD_RESP(
#{ 201 => emqx_dashboard_swagger:schema_with_example(
#{
201 => emqx_dashboard_swagger:schema_with_example(
ref(emqx_authn_api, response_user),
emqx_authn_api:response_user_examples())
})
emqx_authn_api:response_user_examples()
)
}
)
}
};
schema("/gateway/:name/authentication/users/:uid") ->
#{ 'operationId' => users_insta
, get =>
#{ desc => <<"Get user info from the gateway "
"authentication">>
, parameters => params_gateway_name_in_path() ++
params_userid_in_path()
, responses =>
#{
'operationId' => users_insta,
get =>
#{
desc => <<
"Get user info from the gateway "
"authentication"
>>,
parameters => params_gateway_name_in_path() ++
params_userid_in_path(),
responses =>
?STANDARD_RESP(
#{ 200 => emqx_dashboard_swagger:schema_with_example(
#{
200 => emqx_dashboard_swagger:schema_with_example(
ref(emqx_authn_api, response_user),
emqx_authn_api:response_user_examples())
})
emqx_authn_api:response_user_examples()
)
}
)
},
put =>
#{ desc => <<"Update the user info for the gateway "
"authentication">>
, parameters => params_gateway_name_in_path() ++
params_userid_in_path()
, 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
#{
desc => <<
"Update the user info for the gateway "
"authentication"
>>,
parameters => params_gateway_name_in_path() ++
params_userid_in_path(),
'requestBody' => emqx_dashboard_swagger:schema_with_examples(
ref(emqx_authn_api, request_user_update),
emqx_authn_api:request_user_update_examples())
, responses =>
emqx_authn_api:request_user_update_examples()
),
responses =>
?STANDARD_RESP(
#{ 200 => emqx_dashboard_swagger:schema_with_example(
#{
200 => emqx_dashboard_swagger:schema_with_example(
ref(emqx_authn_api, response_user),
emqx_authn_api:response_user_examples())
})
emqx_authn_api:response_user_examples()
)
}
)
},
delete =>
#{ desc => <<"Delete the user for the gateway "
"authentication">>
, parameters => params_gateway_name_in_path() ++
params_userid_in_path()
, responses =>
#{
desc => <<
"Delete the user for the gateway "
"authentication"
>>,
parameters => params_gateway_name_in_path() ++
params_userid_in_path(),
responses =>
?STANDARD_RESP(#{204 => <<"User Deleted">>})
}
};
schema("/gateway/:name/authentication/import_users") ->
#{ 'operationId' => import_users
, post =>
#{ desc => <<"Import users into the gateway authentication">>
, parameters => params_gateway_name_in_path()
, 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
#{
'operationId' => import_users,
post =>
#{
desc => <<"Import users into the gateway authentication">>,
parameters => params_gateway_name_in_path(),
'requestBody' => emqx_dashboard_swagger:schema_with_examples(
ref(emqx_authn_api, request_import_users),
emqx_authn_api:request_import_users_examples()
)
, responses =>
),
responses =>
?STANDARD_RESP(#{204 => <<"Imported">>})
}
}.
@ -272,52 +355,77 @@ schema("/gateway/:name/authentication/import_users") ->
%% params defines
params_gateway_name_in_path() ->
[{name,
mk(binary(),
#{ in => path
, desc => <<"Gateway Name">>
, example => <<"">>
})}
[
{name,
mk(
binary(),
#{
in => path,
desc => <<"Gateway Name">>,
example => <<"">>
}
)}
].
params_userid_in_path() ->
[{uid, mk(binary(),
#{ in => path
, desc => <<"User ID">>
, example => <<"">>
})}
[
{uid,
mk(
binary(),
#{
in => path,
desc => <<"User ID">>,
example => <<"">>
}
)}
].
params_paging_in_qs() ->
[{page, mk(integer(),
#{ in => query
, required => false
, desc => <<"Page Index">>
, example => 1
})},
{limit, mk(integer(),
#{ in => query
, required => false
, desc => <<"Page Limit">>
, example => 100
})}
[
{page,
mk(
integer(),
#{
in => query,
required => false,
desc => <<"Page Index">>,
example => 1
}
)},
{limit,
mk(
integer(),
#{
in => query,
required => false,
desc => <<"Page Limit">>,
example => 100
}
)}
].
params_fuzzy_in_qs() ->
[{like_username,
mk(binary(),
#{ in => query
, required => false
, desc => <<"Fuzzy search by username">>
, example => <<"username">>
})},
[
{like_username,
mk(
binary(),
#{
in => query,
required => false,
desc => <<"Fuzzy search by username">>,
example => <<"username">>
}
)},
{like_clientid,
mk(binary(),
#{ in => query
, required => false
, desc => <<"Fuzzy search by clientid">>
, example => <<"clientid">>
})}
mk(
binary(),
#{
in => query,
required => false,
desc => <<"Fuzzy search by clientid">>,
example => <<"clientid">>
}
)}
].
%%--------------------------------------------------------------------

1258
apps/emqx_gateway/src/emqx_gateway_api_clients.erl
View File

File diff suppressed because it is too large Load Diff

1071
apps/emqx_gateway/src/emqx_gateway_api_listeners.erl
View File

File diff suppressed because it is too large Load Diff

43
apps/emqx_gateway/src/emqx_gateway_app.erl
View File

@ -22,6 +22,8 @@
-export([start/2, stop/1]).
-elvis([{elvis_style, invalid_dynamic_call, disable}]).
start(_StartType, _StartArgs) ->
{ok, Sup} = emqx_gateway_sup:start_link(),
emqx_gateway_cli:load(),
@ -44,21 +46,28 @@ load_default_gateway_applications() ->
gateway_type_searching() ->
%% FIXME: Hardcoded apps
[emqx_stomp_impl, emqx_sn_impl, emqx_exproto_impl,
emqx_coap_impl, emqx_lwm2m_impl].
[
emqx_stomp_impl,
emqx_sn_impl,
emqx_exproto_impl,
emqx_coap_impl,
emqx_lwm2m_impl
].
reg(Mod) ->
try
Mod:reg(),
?SLOG(debug, #{ msg => "register_gateway_succeed"
, callback_module => Mod
?SLOG(debug, #{
msg => "register_gateway_succeed",
callback_module => Mod
})
catch
Class:Reason:Stk ->
?SLOG(error, #{ msg => "failed_to_register_gateway"
, callback_module => Mod
, reason => {Class, Reason}
, stacktrace => Stk
?SLOG(error, #{
msg => "failed_to_register_gateway",
callback_module => Mod,
reason => {Class, Reason},
stacktrace => Stk
})
end.
@ -70,19 +79,23 @@ load_gateway_by_default([]) ->
load_gateway_by_default([{Type, Confs} | More]) ->
case emqx_gateway_registry:lookup(Type) of
undefined ->
?SLOG(error, #{ msg => "skip_to_load_gateway"
, gateway_name => Type
?SLOG(error, #{
msg => "skip_to_load_gateway",
gateway_name => Type
});
_ ->
case emqx_gateway:load(Type, Confs) of
{ok, _} ->
?SLOG(debug, #{ msg => "load_gateway_succeed"
, gateway_name => Type
?SLOG(debug, #{
msg => "load_gateway_succeed",
gateway_name => Type
});
{error, Reason} ->
?SLOG(error, #{ msg => "load_gateway_failed"
, gateway_name => Type
, reason => Reason})
?SLOG(error, #{
msg => "load_gateway_failed",
gateway_name => Type,
reason => Reason
})
end
end,
load_gateway_by_default(More).

188
apps/emqx_gateway/src/emqx_gateway_cli.erl
View File

@ -17,14 +17,16 @@
%% @doc The Command-Line-Interface module for Gateway Application
-module(emqx_gateway_cli).
-export([ load/0
, unload/0
-export([
load/0,
unload/0
]).
-export([ gateway/1
, 'gateway-registry'/1
, 'gateway-clients'/1
, 'gateway-metrics'/1
-export([
gateway/1,
'gateway-registry'/1,
'gateway-clients'/1,
'gateway-metrics'/1
%, 'gateway-banned'/1
]).
@ -33,9 +35,12 @@
-spec load() -> ok.
load() ->
Cmds = [Fun || {Fun, _} <- ?MODULE:module_info(exports), is_cmd(Fun)],
lists:foreach(fun(Cmd) ->
lists:foreach(
fun(Cmd) ->
emqx_ctl:register_command(Cmd, {?MODULE, Cmd}, [])
end, Cmds).
end,
Cmds
).
-spec unload() -> ok.
unload() ->
@ -55,8 +60,9 @@ gateway(["list"]) ->
lists:foreach(
fun(GwSummary) ->
print(format_gw_summary(GwSummary))
end, emqx_gateway_http:gateways(all));
end,
emqx_gateway_http:gateways(all)
);
gateway(["lookup", Name]) ->
case emqx_gateway:lookup(atom(Name)) of
undefined ->
@ -64,18 +70,18 @@ gateway(["lookup", Name]) ->
Gateway ->
print(format_gateway(Gateway))
end;
gateway(["load", Name, Conf]) ->
case emqx_gateway_conf:load_gateway(
case
emqx_gateway_conf:load_gateway(
bin(Name),
emqx_json:decode(Conf, [return_maps])
) of
)
of
{ok, _} ->
print("ok\n");
{error, Reason} ->
print("Error: ~ts\n", [format_error(Reason)])
end;
gateway(["unload", Name]) ->
case emqx_gateway_conf:unload_gateway(bin(Name)) of
ok ->
@ -83,56 +89,51 @@ gateway(["unload", Name]) ->
{error, Reason} ->
print("Error: ~ts\n", [format_error(Reason)])
end;
gateway(["stop", Name]) ->
case emqx_gateway_conf:update_gateway(
case
emqx_gateway_conf:update_gateway(
bin(Name),
#{<<"enable">> => <<"false">>}
) of
)
of
{ok, _} ->
print("ok\n");
{error, Reason} ->
print("Error: ~ts\n", [format_error(Reason)])
end;
gateway(["start", Name]) ->
case emqx_gateway_conf:update_gateway(
case
emqx_gateway_conf:update_gateway(
bin(Name),
#{<<"enable">> => <<"true">>}
) of
)
of
{ok, _} ->
print("ok\n");
{error, Reason} ->
print("Error: ~ts\n", [format_error(Reason)])
end;
gateway(_) ->
emqx_ctl:usage(
[ {"gateway list",
"List all gateway"}
, {"gateway lookup <Name>",
"Lookup a gateway detailed information"}
, {"gateway load <Name> <JsonConf>",
"Load a gateway with config"}
, {"gateway unload <Name>",
"Unload the gateway"}
, {"gateway stop <Name>",
"Stop the gateway"}
, {"gateway start <Name>",
"Start the gateway"}
]).
[
{"gateway list", "List all gateway"},
{"gateway lookup <Name>", "Lookup a gateway detailed information"},
{"gateway load <Name> <JsonConf>", "Load a gateway with config"},
{"gateway unload <Name>", "Unload the gateway"},
{"gateway stop <Name>", "Stop the gateway"},
{"gateway start <Name>", "Start the gateway"}
]
).
'gateway-registry'(["list"]) ->
lists:foreach(
fun({Name, #{cbkmod := CbMod}}) ->
print("Registered Name: ~ts, Callback Module: ~ts\n", [Name, CbMod])
end,
emqx_gateway_registry:list());
emqx_gateway_registry:list()
);
'gateway-registry'(_) ->
emqx_ctl:usage([ {"gateway-registry list",
"List all registered gateways"}
]).
emqx_ctl:usage([{"gateway-registry list", "List all registered gateways"}]).
'gateway-clients'(["list", Name]) ->
%% XXX: page me?
@ -143,7 +144,6 @@ gateway(_) ->
_ ->
dump(InfoTab, client)
end;
'gateway-clients'(["lookup", Name, ClientId]) ->
ChanTab = emqx_gateway_cm:tabname(chan, Name),
case ets:info(ChanTab) of
@ -151,27 +151,24 @@ gateway(_) ->
print("Bad Gateway Name.\n");
_ ->
case ets:lookup(ChanTab, bin(ClientId)) of
[] -> print("Not Found.\n");
[] ->
print("Not Found.\n");
[Chann] ->
InfoTab = emqx_gateway_cm:tabname(info, Name),
[ChannInfo] = ets:lookup(InfoTab, Chann),
print_record({client, ChannInfo})
end
end;
'gateway-clients'(["kick", Name, ClientId]) ->
case emqx_gateway_cm:kick_session(Name, bin(ClientId)) of
ok -> print("ok\n");
_ -> print("Not Found.\n")
end;
'gateway-clients'(_) ->
emqx_ctl:usage([ {"gateway-clients list <Name>",
"List all clients for a gateway"}
, {"gateway-clients lookup <Name> <ClientId>",
"Lookup the Client Info for specified client"}
, {"gateway-clients kick <Name> <ClientId>",
"Kick out a client"}
emqx_ctl:usage([
{"gateway-clients list <Name>", "List all clients for a gateway"},
{"gateway-clients lookup <Name> <ClientId>", "Lookup the Client Info for specified client"},
{"gateway-clients kick <Name> <ClientId>", "Kick out a client"}
]).
'gateway-metrics'([Name]) ->
@ -181,13 +178,11 @@ gateway(_) ->
Metrics ->
lists:foreach(
fun({K, V}) -> print("~-30s: ~w\n", [K, V]) end,
Metrics)
Metrics
)
end;
'gateway-metrics'(_) ->
emqx_ctl:usage([ {"gateway-metrics <Name>",
"List all metrics for a gateway"}
]).
emqx_ctl:usage([{"gateway-metrics <Name>", "List all metrics for a gateway"}]).
atom(Id) ->
try
@ -207,7 +202,6 @@ dump(Table, Tag) ->
dump(_Table, _, '$end_of_table', Result) ->
lists:reverse(Result);
dump(Table, Tag, Key, Result) ->
PrintValue = [print_record({Tag, Record}) || Record <- ets:lookup(Table, Key)],
dump(Table, Tag, ets:next(Table, Key), [PrintValue | Result]).
@ -220,9 +214,20 @@ print_record({client, {_, Infos, Stats}}) ->
StatsGet = fun(K) -> proplists:get_value(K, Stats, 0) end,
ConnectedAt = SafeGet(connected_at, ConnInfo),
InfoKeys = [clientid, username, peername, clean_start, keepalive,
subscriptions_cnt, send_msg, connected, created_at, connected_at],
Info = #{ clientid => SafeGet(clientid, ClientInfo),
InfoKeys = [
clientid,
username,
peername,
clean_start,
keepalive,
subscriptions_cnt,
send_msg,
connected,
created_at,
connected_at
],
Info = #{
clientid => SafeGet(clientid, ClientInfo),
username => SafeGet(username, ClientInfo),
peername => SafeGet(peername, ConnInfo),
clean_start => SafeGet(clean_start, ConnInfo),
@ -234,50 +239,66 @@ print_record({client, {_, Infos, Stats}}) ->
connected_at => ConnectedAt
},
print("Client(~ts, username=~ts, peername=~ts, "
print(
"Client(~ts, username=~ts, peername=~ts, "
"clean_start=~ts, keepalive=~w, "
"subscriptions=~w, delivered_msgs=~w, "
"connected=~ts, created_at=~w, connected_at=~w)\n",
[format(K, maps:get(K, Info)) || K <- InfoKeys]).
[format(K, maps:get(K, Info)) || K <- InfoKeys]
).
print(S) -> emqx_ctl:print(S).
print(S, A) -> emqx_ctl:print(S, A).
format(_, undefined) ->
undefined;
format(peername, {IPAddr, Port}) ->
IPStr = emqx_mgmt_util:ntoa(IPAddr),
io_lib:format("~ts:~p", [IPStr, Port]);
format(_, Val) ->
Val.
format_gw_summary(#{name := Name, status := unloaded}) ->
io_lib:format("Gateway(name=~ts, status=unloaded)\n", [Name]);
format_gw_summary(#{name := Name, status := stopped,
stopped_at := StoppedAt}) ->
io_lib:format("Gateway(name=~ts, status=stopped, stopped_at=~ts)\n",
[Name, StoppedAt]);
format_gw_summary(#{name := Name, status := running,
format_gw_summary(#{
name := Name,
status := stopped,
stopped_at := StoppedAt
}) ->
io_lib:format(
"Gateway(name=~ts, status=stopped, stopped_at=~ts)\n",
[Name, StoppedAt]
);
format_gw_summary(#{
name := Name,
status := running,
current_connections := ConnCnt,
started_at := StartedAt}) ->
io_lib:format("Gateway(name=~ts, status=running, clients=~w, "
"started_at=~ts)\n", [Name, ConnCnt, StartedAt]).
started_at := StartedAt
}) ->
io_lib:format(
"Gateway(name=~ts, status=running, clients=~w, "
"started_at=~ts)\n",
[Name, ConnCnt, StartedAt]
).
format_gateway(#{name := Name,
status := unloaded}) ->
format_gateway(#{
name := Name,
status := unloaded
}) ->
io_lib:format(
"name: ~ts\n"
"status: unloaded\n", [Name]);
format_gateway(Gw =
#{name := Name,
"status: unloaded\n",
[Name]
);
format_gateway(
Gw =
#{
name := Name,
status := Status,
created_at := CreatedAt,
config := Config
}) ->
}
) ->
{StopOrStart, Timestamp} =
case Status of
stopped -> {stopped_at, maps:get(stopped_at, Gw)};
@ -289,10 +310,15 @@ format_gateway(Gw =
"created_at: ~ts\n"
"~ts: ~ts\n"
"config: ~p\n",
[Name, Status,
[
Name,
Status,
emqx_gateway_utils:unix_ts_to_rfc3339(CreatedAt),
StopOrStart, emqx_gateway_utils:unix_ts_to_rfc3339(Timestamp),
Config]).
StopOrStart,
emqx_gateway_utils:unix_ts_to_rfc3339(Timestamp),
Config
]
).
format_error(Reason) ->
case emqx_gateway_http:reason2msg(Reason) of

452
apps/emqx_gateway/src/emqx_gateway_cm.erl
View File

@ -30,68 +30,75 @@
%% APIs
-export([start_link/1]).
-export([ open_session/5
, open_session/6
, kick_session/2
, kick_session/3
, takeover_session/2
, register_channel/4
, unregister_channel/2
, insert_channel_info/4
, lookup_by_clientid/2
, set_chan_info/3
, set_chan_info/4
, get_chan_info/2
, get_chan_info/3
, set_chan_stats/3
, set_chan_stats/4
, get_chan_stats/2
, get_chan_stats/3
, connection_closed/2
-export([
open_session/5,
open_session/6,
kick_session/2,
kick_session/3,
takeover_session/2,
register_channel/4,
unregister_channel/2,
insert_channel_info/4,
lookup_by_clientid/2,
set_chan_info/3,
set_chan_info/4,
get_chan_info/2,
get_chan_info/3,
set_chan_stats/3,
set_chan_stats/4,
get_chan_stats/2,
get_chan_stats/3,
connection_closed/2
]).
-export([ call/3
, call/4
, cast/3
-export([
call/3,
call/4,
cast/3
]).
-export([ with_channel/3
, lookup_channels/2
-export([
with_channel/3,
lookup_channels/2
]).
%% Internal funcs for getting tabname by GatewayId
-export([cmtabs/1, tabname/2]).
%% gen_server callbacks
-export([ init/1
, handle_call/3
, handle_cast/2
, handle_info/2
, terminate/2
, code_change/3
-export([
init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3
]).
%% RPC targets
-export([ do_lookup_by_clientid/2
, do_get_chan_info/3
, do_set_chan_info/4
, do_get_chan_stats/3
, do_set_chan_stats/4
, do_kick_session/4
, do_takeover_session/3
, do_get_chann_conn_mod/3
, do_call/4
, do_call/5
, do_cast/4
-export([
do_lookup_by_clientid/2,
do_get_chan_info/3,
do_set_chan_info/4,
do_get_chan_stats/3,
do_set_chan_stats/4,
do_kick_session/4,
do_takeover_session/3,
do_get_chann_conn_mod/3,
do_call/4,
do_call/5,
do_cast/4
]).
-export_type([ gateway_name/0
]).
-export_type([gateway_name/0]).
-record(state, {
gwname :: gateway_name(), %% Gateway Name
locker :: pid(), %% ClientId Locker for CM
registry :: pid(), %% ClientId Registry server
%% Gateway Name
gwname :: gateway_name(),
%% ClientId Locker for CM
locker :: pid(),
%% ClientId Registry server
registry :: pid(),
chan_pmon :: emqx_pmon:pmon()
}).
@ -117,14 +124,16 @@ start_link(Options) ->
procname(GwName) ->
list_to_atom(lists:concat([emqx_gateway_, GwName, '_cm'])).
-spec cmtabs(GwName :: gateway_name())
-> {ChanTab :: atom(),
ConnTab :: atom(),
ChannInfoTab :: atom()}.
-spec cmtabs(GwName :: gateway_name()) ->
{ChanTab :: atom(), ConnTab :: atom(), ChannInfoTab :: atom()}.
cmtabs(GwName) ->
{ tabname(chan, GwName) %% Record: {ClientId, Pid}
, tabname(conn, GwName) %% Record: {{ClientId, Pid}, ConnMod}
, tabname(info, GwName) %% Record: {{ClientId, Pid}, Info, Stats}
%% Record: {ClientId, Pid}
{
tabname(chan, GwName),
%% Record: {{ClientId, Pid}, ConnMod}
tabname(conn, GwName),
%% Record: {{ClientId, Pid}, Info, Stats}
tabname(info, GwName)
}.
tabname(chan, GwName) ->
@ -137,10 +146,12 @@ tabname(info, GwName) ->
lockername(GwName) ->
list_to_atom(lists:concat([emqx_gateway_, GwName, '_locker'])).
-spec register_channel(gateway_name(),
-spec register_channel(
gateway_name(),
emqx_types:clientid(),
pid(),
emqx_types:conninfo()) -> ok.
emqx_types:conninfo()
) -> ok.
register_channel(GwName, ClientId, ChanPid, #{conn_mod := ConnMod}) when is_pid(ChanPid) ->
Chan = {ClientId, ChanPid},
true = ets:insert(tabname(chan, GwName), Chan),
@ -155,31 +166,36 @@ unregister_channel(GwName, ClientId) when is_binary(ClientId) ->
ok.
%% @doc Insert/Update the channel info and stats
-spec insert_channel_info(gateway_name(),
-spec insert_channel_info(
gateway_name(),
emqx_types:clientid(),
emqx_types:infos(),
emqx_types:stats()) -> ok.
emqx_types:stats()
) -> ok.
insert_channel_info(GwName, ClientId, Info, Stats) ->
Chan = {ClientId, self()},
true = ets:insert(tabname(info, GwName), {Chan, Info, Stats}),
ok.
%% @doc Get info of a channel.
-spec get_chan_info(gateway_name(), emqx_types:clientid())
-> emqx_types:infos() | undefined.
-spec get_chan_info(gateway_name(), emqx_types:clientid()) ->
emqx_types:infos() | undefined.
get_chan_info(GwName, ClientId) ->
with_channel(GwName, ClientId,
with_channel(
GwName,
ClientId,
fun(ChanPid) ->
get_chan_info(GwName, ClientId, ChanPid)
end).
end
).
-spec do_lookup_by_clientid(gateway_name(), emqx_types:clientid()) -> [pid()].
do_lookup_by_clientid(GwName, ClientId) ->
ChanTab = emqx_gateway_cm:tabname(chan, GwName),
[Pid || {_, Pid} <- ets:lookup(ChanTab, ClientId)].
-spec do_get_chan_info(gateway_name(), emqx_types:clientid(), pid())
-> emqx_types:infos() | undefined.
-spec do_get_chan_info(gateway_name(), emqx_types:clientid(), pid()) ->
emqx_types:infos() | undefined.
do_get_chan_info(GwName, ClientId, ChanPid) ->
Chan = {ClientId, ChanPid},
try
@ -189,8 +205,8 @@ do_get_chan_info(GwName, ClientId, ChanPid) ->
error:badarg -> undefined
end.
-spec get_chan_info(gateway_name(), emqx_types:clientid(), pid())
-> emqx_types:infos() | undefined.
-spec get_chan_info(gateway_name(), emqx_types:clientid(), pid()) ->
emqx_types:infos() | undefined.
get_chan_info(GwName, ClientId, ChanPid) ->
wrap_rpc(
emqx_gateway_cm_proto_v1:get_chan_info(GwName, ClientId, ChanPid)
@ -199,8 +215,11 @@ get_chan_info(GwName, ClientId, ChanPid) ->
-spec lookup_by_clientid(gateway_name(), emqx_types:clientid()) -> [pid()].
lookup_by_clientid(GwName, ClientId) ->
Nodes = mria_mnesia:running_nodes(),
case emqx_gateway_cm_proto_v1:lookup_by_clientid(
Nodes, GwName, ClientId) of
case
emqx_gateway_cm_proto_v1:lookup_by_clientid(
Nodes, GwName, ClientId
)
of
{Pids, []} ->
lists:append(Pids);
{_, _BadNodes} ->
@ -208,74 +227,92 @@ lookup_by_clientid(GwName, ClientId) ->
end.
%% @doc Update infos of the channel.
-spec set_chan_info(gateway_name(),
-spec set_chan_info(
gateway_name(),
emqx_types:clientid(),
emqx_types:infos()) -> boolean().
emqx_types:infos()
) -> boolean().
set_chan_info(GwName, ClientId, Infos) ->
set_chan_info(GwName, ClientId, self(), Infos).
-spec do_set_chan_info(gateway_name(),
-spec do_set_chan_info(
gateway_name(),
emqx_types:clientid(),
pid(),
emqx_types:infos()) -> boolean().
emqx_types:infos()
) -> boolean().
do_set_chan_info(GwName, ClientId, ChanPid, Infos) ->
Chan = {ClientId, ChanPid},
try ets:update_element(tabname(info, GwName), Chan, {2, Infos})
try
ets:update_element(tabname(info, GwName), Chan, {2, Infos})
catch
error:badarg -> false
end.
-spec set_chan_info(gateway_name(),
-spec set_chan_info(
gateway_name(),
emqx_types:clientid(),
pid(),
emqx_types:infos()) -> boolean().
emqx_types:infos()
) -> boolean().
set_chan_info(GwName, ClientId, ChanPid, Infos) ->
wrap_rpc(emqx_gateway_cm_proto_v1:set_chan_info(GwName, ClientId, ChanPid, Infos)).
%% @doc Get channel's stats.
-spec get_chan_stats(gateway_name(), emqx_types:clientid())
-> emqx_types:stats() | undefined.
-spec get_chan_stats(gateway_name(), emqx_types:clientid()) ->
emqx_types:stats() | undefined.
get_chan_stats(GwName, ClientId) ->
with_channel(GwName, ClientId,
with_channel(
GwName,
ClientId,
fun(ChanPid) ->
get_chan_stats(GwName, ClientId, ChanPid)
end).
end
).
-spec do_get_chan_stats(gateway_name(), emqx_types:clientid(), pid())
-> emqx_types:stats() | undefined.
-spec do_get_chan_stats(gateway_name(), emqx_types:clientid(), pid()) ->
emqx_types:stats() | undefined.
do_get_chan_stats(GwName, ClientId, ChanPid) ->
Chan = {ClientId, ChanPid},
try ets:lookup_element(tabname(info, GwName), Chan, 3)
try
ets:lookup_element(tabname(info, GwName), Chan, 3)
catch
error:badarg -> undefined
end.
-spec get_chan_stats(gateway_name(), emqx_types:clientid(), pid())
-> emqx_types:stats() | undefined.
-spec get_chan_stats(gateway_name(), emqx_types:clientid(), pid()) ->
emqx_types:stats() | undefined.
get_chan_stats(GwName, ClientId, ChanPid) ->
wrap_rpc(emqx_gateway_cm_proto_v1:get_chan_stats(GwName, ClientId, ChanPid)).
-spec set_chan_stats(gateway_name(),
-spec set_chan_stats(
gateway_name(),
emqx_types:clientid(),
emqx_types:stats()) -> boolean().
emqx_types:stats()
) -> boolean().
set_chan_stats(GwName, ClientId, Stats) ->
set_chan_stats(GwName, ClientId, self(), Stats).
-spec do_set_chan_stats(gateway_name(),
-spec do_set_chan_stats(
gateway_name(),
emqx_types:clientid(),
pid(),
emqx_types:stats()) -> boolean().
emqx_types:stats()
) -> boolean().
do_set_chan_stats(GwName, ClientId, ChanPid, Stats) ->
Chan = {ClientId, ChanPid},
try ets:update_element(tabname(info, GwName), Chan, {3, Stats})
try
ets:update_element(tabname(info, GwName), Chan, {3, Stats})
catch
error:badarg -> false
end.
-spec set_chan_stats(gateway_name(),
-spec set_chan_stats(
gateway_name(),
emqx_types:clientid(),
pid(),
emqx_types:stats()) -> boolean().
emqx_types:stats()
) -> boolean().
set_chan_stats(GwName, ClientId, ChanPid, Stats) ->
wrap_rpc(emqx_gateway_cm_proto_v1:set_chan_stats(GwName, ClientId, ChanPid, Stats)).
@ -285,14 +322,20 @@ connection_closed(GwName, ClientId) ->
Chan = {ClientId, self()},
ets:delete_object(tabname(conn, GwName), Chan).
-spec open_session(GwName :: gateway_name(),
-spec open_session(
GwName :: gateway_name(),
CleanStart :: boolean(),
ClientInfo :: emqx_types:clientinfo(),
ConnInfo :: emqx_types:conninfo(),
CreateSessionFun :: fun((emqx_types:clientinfo(),
emqx_types:conninfo()) -> Session
))
-> {ok, #{session := Session,
CreateSessionFun :: fun(
(
emqx_types:clientinfo(),
emqx_types:conninfo()
) -> Session
)
) ->
{ok, #{
session := Session,
present := boolean(),
pendings => list()
}}
@ -306,7 +349,8 @@ open_session(GwName, true = _CleanStart, ClientInfo, ConnInfo, CreateSessionFun,
ClientId = maps:get(clientid, ClientInfo),
Fun = fun(_) ->
_ = discard_session(GwName, ClientId),
Session = create_session(GwName,
Session = create_session(
GwName,
ClientInfo,
ConnInfo,
CreateSessionFun,
@ -316,10 +360,14 @@ open_session(GwName, true = _CleanStart, ClientInfo, ConnInfo, CreateSessionFun,
{ok, #{session => Session, present => false}}
end,
locker_trans(GwName, ClientId, Fun);
open_session(GwName, false = _CleanStart,
open_session(
GwName,
false = _CleanStart,
ClientInfo = #{clientid := ClientId},
ConnInfo, CreateSessionFun, SessionMod) ->
ConnInfo,
CreateSessionFun,
SessionMod
) ->
Self = self(),
ResumeStart =
@ -327,10 +375,15 @@ open_session(GwName, false = _CleanStart,
CreateSess =
fun() ->
Session = create_session(
GwName, ClientInfo, ConnInfo,
CreateSessionFun, SessionMod),
GwName,
ClientInfo,
ConnInfo,
CreateSessionFun,
SessionMod
),
register_channel(
GwName, ClientId, Self, ConnInfo),
GwName, ClientId, Self, ConnInfo
),
{ok, #{session => Session, present => false}}
end,
case takeover_session(GwName, ClientId) of
@ -339,14 +392,18 @@ open_session(GwName, false = _CleanStart,
case request_stepdown({takeover, 'end'}, ConnMod, ChanPid) of
{ok, Pendings} ->
register_channel(
GwName, ClientId, Self, ConnInfo),
{ok, #{session => Session,
GwName, ClientId, Self, ConnInfo
),
{ok, #{
session => Session,
present => true,
pendings => Pendings}};
pendings => Pendings
}};
{error, _} ->
CreateSess()
end;
{error, _Reason} -> CreateSess()
{error, _Reason} ->
CreateSess()
end
end,
locker_trans(GwName, ClientId, ResumeStart).
@ -359,9 +416,13 @@ create_session(GwName, ClientInfo, ConnInfo, CreateSessionFun, SessionMod) ->
[ClientInfo, ConnInfo]
),
ok = emqx_gateway_metrics:inc(GwName, 'session.created'),
SessionInfo = case is_tuple(Session)
andalso element(1, Session) == session of
true -> SessionMod:info(Session);
SessionInfo =
case
is_tuple(Session) andalso
element(1, Session) == session
of
true ->
SessionMod:info(Session);
_ ->
case is_map(Session) of
false ->
@ -374,32 +435,38 @@ create_session(GwName, ClientInfo, ConnInfo, CreateSessionFun, SessionMod) ->
Session
catch
Class:Reason:Stk ->
?SLOG(error, #{ msg => "failed_create_session"
, clientid => maps:get(clientid, ClientInfo, undefined)
, username => maps:get(username, ClientInfo, undefined)
, reason => {Class, Reason}
, stacktrace => Stk
?SLOG(error, #{
msg => "failed_create_session",
clientid => maps:get(clientid, ClientInfo, undefined),
username => maps:get(username, ClientInfo, undefined),
reason => {Class, Reason},
stacktrace => Stk
}),
throw(Reason)
end.
%% @doc Try to takeover a session.
-spec(takeover_session(gateway_name(), emqx_types:clientid())
-> {error, term()}
| {ok, atom(), pid(), emqx_session:session()}).
-spec takeover_session(gateway_name(), emqx_types:clientid()) ->
{error, term()}
| {ok, atom(), pid(), emqx_session:session()}.
takeover_session(GwName, ClientId) ->
case lookup_channels(GwName, ClientId) of
[] -> {error, not_found};
[] ->
{error, not_found};
[ChanPid] ->
do_takeover_session(GwName, ClientId, ChanPid);
ChanPids ->
[ChanPid | StalePids] = lists:reverse(ChanPids),
?SLOG(warning, #{ msg => "more_than_one_channel_found"
, chan_pids => ChanPids
?SLOG(warning, #{
msg => "more_than_one_channel_found",
chan_pids => ChanPids
}),
lists:foreach(fun(StalePid) ->
lists:foreach(
fun(StalePid) ->
catch discard_session(GwName, ClientId, StalePid)
end, StalePids),
end,
StalePids
),
do_takeover_session(GwName, ClientId, ChanPid)
end.
@ -432,17 +499,26 @@ discard_session(GwName, ClientId, ChanPid) ->
-spec kick_session(gateway_name(), emqx_types:clientid()) -> ok | {error, not_found}.
kick_session(GwName, ClientId) ->
case lookup_channels(GwName, ClientId) of
[] -> {error, not_found};
[] ->
{error, not_found};
ChanPids ->
ChanPids > 1 andalso begin
?SLOG(warning, #{ msg => "more_than_one_channel_found"
, chan_pids => ChanPids
ChanPids > 1 andalso
begin
?SLOG(
warning,
#{
msg => "more_than_one_channel_found",
chan_pids => ChanPids
},
#{clientid => ClientId})
#{clientid => ClientId}
)
end,
lists:foreach(fun(Pid) ->
lists:foreach(
fun(Pid) ->
_ = kick_session(GwName, ClientId, Pid)
end, ChanPids)
end,
ChanPids
)
end.
kick_session(GwName, ClientId, ChanPid) ->
@ -458,22 +534,29 @@ kick_session(GwName, Action, ClientId, ChanPid) ->
%% However, if the node is still running the old version
%% code (prior to emqx app 4.3.10) some of the RPC handler
%% exceptions may get propagated to a new version node
?SLOG(error, #{ msg => "failed_to_kick_session_on_remote_node"
, node => node(ChanPid)
, action => Action
, error => Error
, reason => Reason
?SLOG(
error,
#{
msg => "failed_to_kick_session_on_remote_node",
node => node(ChanPid),
action => Action,
error => Error,
reason => Reason
},
#{clientid => ClientId})
#{clientid => ClientId}
)
end.
-spec do_kick_session(gateway_name(),
-spec do_kick_session(
gateway_name(),
kick | discard,
emqx_types:clientid(),
pid()) -> ok.
pid()
) -> ok.
do_kick_session(GwName, Action, ClientId, ChanPid) ->
case get_chann_conn_mod(GwName, ClientId, ChanPid) of
undefined -> ok;
undefined ->
ok;
ConnMod when is_atom(ConnMod) ->
ok = request_stepdown(Action, ConnMod, ChanPid)
end.
@ -482,11 +565,12 @@ do_kick_session(GwName, Action, ClientId, ChanPid) ->
%% If failed to response (e.g. timeout) force a kill.
%% Keeping the stale pid around, or returning error or raise an exception
%% benefits nobody.
-spec request_stepdown(Action, module(), pid())
-> ok
-spec request_stepdown(Action, module(), pid()) ->
ok
| {ok, emqx_session:session() | list(emqx_type:deliver())}
| {error, term()}
when Action :: kick | discard | {takeover, 'begin'} | {takeover, 'end'}.
when
Action :: kick | discard | {takeover, 'begin'} | {takeover, 'end'}.
request_stepdown(Action, ConnMod, Pid) ->
Timeout =
case Action == kick orelse Action == discard of
@ -501,10 +585,12 @@ request_stepdown(Action, ConnMod, Pid) ->
ok -> ok;
Reply -> {ok, Reply}
catch
_ : noproc -> % emqx_ws_connection: call
% emqx_ws_connection: call
_:noproc ->
ok = ?tp(debug, "session_already_gone", #{pid => Pid, action => Action}),
{error, noproc};
_ : {noproc, _} -> % emqx_connection: gen_server:call
% emqx_connection: gen_server:call
_:{noproc, _} ->
ok = ?tp(debug, "session_already_gone", #{pid => Pid, action => Action}),
{error, noproc};
_:Reason = {shutdown, _} ->
@ -514,21 +600,29 @@ request_stepdown(Action, ConnMod, Pid) ->
ok = ?tp(debug, "session_already_shutdown", #{pid => Pid, action => Action}),
{error, Reason};
_:{timeout, {gen_server, call, _}} ->
?tp(warning, "session_stepdown_request_timeout",
#{pid => Pid,
?tp(
warning,
"session_stepdown_request_timeout",
#{
pid => Pid,
action => Action,
stale_channel => stale_channel_info(Pid)
}),
}
),
ok = force_kill(Pid),
{error, timeout};
_:Error:St ->
?tp(error, "session_stepdown_request_exception",
#{pid => Pid,
?tp(
error,
"session_stepdown_request_exception",
#{
pid => Pid,
action => Action,
reason => Error,
stacktrace => St,
stale_channel => stale_channel_info(Pid)
}),
}
),
ok = force_kill(Pid),
{error, Error}
end,
@ -552,14 +646,16 @@ with_channel(GwName, ClientId, Fun) ->
end.
%% @doc Lookup channels.
-spec(lookup_channels(gateway_name(), emqx_types:clientid()) -> list(pid())).
-spec lookup_channels(gateway_name(), emqx_types:clientid()) -> list(pid()).
lookup_channels(GwName, ClientId) ->
emqx_gateway_cm_registry:lookup_channels(GwName, ClientId).
-spec do_get_chann_conn_mod(gateway_name(), emqx_types:clientid(), pid()) -> atom().
do_get_chann_conn_mod(GwName, ClientId, ChanPid) ->
Chan = {ClientId, ChanPid},
try [ConnMod] = ets:lookup_element(tabname(conn, GwName), Chan, 2), ConnMod
try
[ConnMod] = ets:lookup_element(tabname(conn, GwName), Chan, 2),
ConnMod
catch
error:badarg -> undefined
end.
@ -568,28 +664,33 @@ do_get_chann_conn_mod(GwName, ClientId, ChanPid) ->
get_chann_conn_mod(GwName, ClientId, ChanPid) ->
wrap_rpc(emqx_gateway_cm_proto_v1:get_chann_conn_mod(GwName, ClientId, ChanPid)).
-spec call(gateway_name(), emqx_types:clientid(), term())
-> undefined | term().
-spec call(gateway_name(), emqx_types:clientid(), term()) ->
undefined | term().
call(GwName, ClientId, Req) ->
with_channel(
GwName, ClientId,
GwName,
ClientId,
fun(ChanPid) ->
wrap_rpc(
emqx_gateway_cm_proto_v1:call(GwName, ClientId, ChanPid, Req)
)
end).
end
).
-spec call(gateway_name(), emqx_types:clientid(), term(), timeout())
-> undefined | term().
-spec call(gateway_name(), emqx_types:clientid(), term(), timeout()) ->
undefined | term().
call(GwName, ClientId, Req, Timeout) ->
with_channel(
GwName, ClientId,
GwName,
ClientId,
fun(ChanPid) ->
wrap_rpc(
emqx_gateway_cm_proto_v1:call(
GwName, ClientId, ChanPid, Req, Timeout)
GwName, ClientId, ChanPid, Req, Timeout
)
end).
)
end
).
do_call(GwName, ClientId, ChanPid, Req) ->
case do_get_chann_conn_mod(GwName, ClientId, ChanPid) of
@ -606,11 +707,14 @@ do_call(GwName, ClientId, ChanPid, Req, Timeout) ->
-spec cast(gateway_name(), emqx_types:clientid(), term()) -> ok.
cast(GwName, ClientId, Req) ->
with_channel(
GwName, ClientId,
GwName,
ClientId,
fun(ChanPid) ->
wrap_rpc(
emqx_gateway_cm_proto_v1:cast(GwName, ClientId, ChanPid, Req))
end),
emqx_gateway_cm_proto_v1:cast(GwName, ClientId, ChanPid, Req)
)
end
),
ok.
do_cast(GwName, ClientId, ChanPid, Req) ->
@ -627,7 +731,11 @@ locker_trans(GwName, ClientId, Fun) ->
Locker = lockername(GwName),
case locker_lock(Locker, ClientId) of
{true, Nodes} ->
try Fun(Nodes) after locker_unlock(Locker, ClientId) end;
try
Fun(Nodes)
after
locker_unlock(Locker, ClientId)
end;
{false, _Nodes} ->
{error, client_id_unavailable}
end.
@ -673,10 +781,12 @@ init(Options) ->
%% TODO: v0.2
%ok = emqx_stats:update_interval(chan_stats, fun ?MODULE:stats_fun/0),
{ok, #state{gwname = GwName,
{ok, #state{
gwname = GwName,
locker = Locker,
registry = Registry,
chan_pmon = emqx_pmon:new()}}.
chan_pmon = emqx_pmon:new()
}}.
handle_call(_Request, _From, State) ->
Reply = ok,
@ -685,19 +795,19 @@ handle_call(_Request, _From, State) ->
handle_cast({registered, {ClientId, ChanPid}}, State = #state{chan_pmon = PMon}) ->
PMon1 = emqx_pmon:monitor(ChanPid, ClientId, PMon),
{noreply, State#state{chan_pmon = PMon1}};
handle_cast(_Msg, State) ->
{noreply, State}.
handle_info({'DOWN', _MRef, process, Pid, _Reason},
State = #state{gwname = GwName, chan_pmon = PMon}) ->
handle_info(
{'DOWN', _MRef, process, Pid, _Reason},
State = #state{gwname = GwName, chan_pmon = PMon}
) ->
ChanPids = [Pid | emqx_misc:drain_down(?DEFAULT_BATCH_SIZE)],
{Items, PMon1} = emqx_pmon:erase_all(ChanPids, PMon),
CmTabs = cmtabs(GwName),
ok = emqx_pool:async_submit(fun do_unregister_channel_task/3, [Items, GwName, CmTabs]),
{noreply, State#state{chan_pmon = PMon1}};
handle_info(_Info, State) ->
{noreply, State}.
@ -713,7 +823,9 @@ do_unregister_channel_task(Items, GwName, CmTabs) ->
lists:foreach(
fun({ChanPid, ClientId}) ->
do_unregister_channel(GwName, {ClientId, ChanPid}, CmTabs)
end, Items).
end,
Items
).
%%--------------------------------------------------------------------
%% Internal funcs

60
apps/emqx_gateway/src/emqx_gateway_cm_registry.erl
View File

@ -23,8 +23,9 @@
-export([start_link/1]).
-export([ register_channel/2
, unregister_channel/2
-export([
register_channel/2,
unregister_channel/2
]).
-export([lookup_channels/2]).
@ -32,12 +33,13 @@
-export([tabname/1]).
%% gen_server callbacks
-export([ init/1
, handle_call/3
, handle_cast/2
, handle_info/2
, terminate/2
, code_change/3
-export([
init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3
]).
-define(CM_SHARD, emqx_gateway_cm_shard).
@ -46,7 +48,7 @@
-record(channel, {chid, pid}).
%% @doc Start the global channel registry for the given gateway name.
-spec(start_link(gateway_name()) -> gen_server:startlink_ret()).
-spec start_link(gateway_name()) -> gen_server:startlink_ret().
start_link(Name) ->
gen_server:start_link(?MODULE, [Name], []).
@ -63,25 +65,27 @@ tabname(Name) ->
-spec register_channel(gateway_name(), binary() | {binary(), pid()}) -> ok.
register_channel(Name, ClientId) when is_binary(ClientId) ->
register_channel(Name, {ClientId, self()});
register_channel(Name, {ClientId, ChanPid})
when is_binary(ClientId), is_pid(ChanPid) ->
register_channel(Name, {ClientId, ChanPid}) when
is_binary(ClientId), is_pid(ChanPid)
->
mria:dirty_write(tabname(Name), record(ClientId, ChanPid)).
%% @doc Unregister a global channel.
-spec unregister_channel(gateway_name(), binary() | {binary(), pid()}) -> ok.
unregister_channel(Name, ClientId) when is_binary(ClientId) ->
unregister_channel(Name, {ClientId, self()});
unregister_channel(Name, {ClientId, ChanPid})
when is_binary(ClientId), is_pid(ChanPid) ->
unregister_channel(Name, {ClientId, ChanPid}) when
is_binary(ClientId), is_pid(ChanPid)
->
mria:dirty_delete_object(tabname(Name), record(ClientId, ChanPid)).
%% @doc Lookup the global channels.
-spec lookup_channels(gateway_name(), binary()) -> list(pid()).
lookup_channels(Name, ClientId) ->
[ChanPid
|| #channel{pid = ChanPid} <- mnesia:dirty_read(tabname(Name), ClientId)].
[
ChanPid
|| #channel{pid = ChanPid} <- mnesia:dirty_read(tabname(Name), ClientId)
].
record(ClientId, ChanPid) ->
#channel{chid = ClientId, pid = ChanPid}.
@ -98,8 +102,13 @@ init([Name]) ->
{storage, ram_copies},
{record_name, channel},
{attributes, record_info(fields, channel)},
{storage_properties, [{ets, [{read_concurrency, true},
{write_concurrency, true}]}]}]),
{storage_properties, [
{ets, [
{read_concurrency, true},
{write_concurrency, true}
]}
]}
]),
ok = mria:wait_for_tables([Tab]),
ok = ekka:monitor(membership),
{ok, #{name => Name}}.
@ -115,14 +124,11 @@ handle_cast(Msg, State) ->
handle_info({membership, {mnesia, down, Node}}, State = #{name := Name}) ->
cleanup_channels(Node, Name),
{noreply, State};
handle_info({membership, {node, down, Node}}, State = #{name := Name}) ->
cleanup_channels(Node, Name),
{noreply, State};
handle_info({membership, _Event}, State) ->
{noreply, State};
handle_info(Info, State) ->
logger:error("Unexpected info: ~p", [Info]),
{noreply, State}.
@ -143,10 +149,14 @@ cleanup_channels(Node, Name) ->
{?LOCK, self()},
fun() ->
mria:transaction(?CM_SHARD, fun do_cleanup_channels/2, [Node, Tab])
end).
end
).
do_cleanup_channels(Node, Tab) ->
Pat = [{#channel{pid = '$1', _ = '_'}, [{'==', {node, '$1'}, Node}], ['$_']}],
lists:foreach(fun(Chan) ->
lists:foreach(
fun(Chan) ->
mnesia:delete_object(Tab, Chan, write)
end, mnesia:select(Tab, Pat, write)).
end,
mnesia:select(Tab, Pat, write)
).

392
apps/emqx_gateway/src/emqx_gateway_conf.erl
View File

@ -20,40 +20,46 @@
-behaviour(emqx_config_handler).
%% Load/Unload
-export([ load/0
, unload/0
-export([
load/0,
unload/0
]).
%% APIs
-export([ gateway/1
, load_gateway/2
, update_gateway/2
, unload_gateway/1
-export([
gateway/1,
load_gateway/2,
update_gateway/2,
unload_gateway/1
]).
-export([ listeners/1
, listener/1
, add_listener/3
, update_listener/3
, remove_listener/2
-export([
listeners/1,
listener/1,
add_listener/3,
update_listener/3,
remove_listener/2
]).
-export([ add_authn/2
, add_authn/3
, update_authn/2
, update_authn/3
, remove_authn/1
, remove_authn/2
-export([
add_authn/2,
add_authn/3,
update_authn/2,
update_authn/3,
remove_authn/1,
remove_authn/2
]).
%% internal exports
-export([ unconvert_listeners/1
, convert_listeners/2
-export([
unconvert_listeners/1,
convert_listeners/2
]).
%% callbacks for emqx_config_handler
-export([ pre_config_update/3
, post_config_update/5
-export([
pre_config_update/3,
post_config_update/5
]).
-include_lib("emqx/include/logger.hrl").
@ -63,8 +69,7 @@
-type atom_or_bin() :: atom() | binary().
-type ok_or_err() :: ok | {error, term()}.
-type map_or_err() :: {ok, map()} | {error, term()}.
-type listener_ref() :: {ListenerType :: atom_or_bin(),
ListenerName :: atom_or_bin()}.
-type listener_ref() :: {ListenerType :: atom_or_bin(), ListenerName :: atom_or_bin()}.
%%--------------------------------------------------------------------
%% Load/Unload
@ -83,21 +88,25 @@ unload() ->
-spec load_gateway(atom_or_bin(), map()) -> map_or_err().
load_gateway(GwName, Conf) ->
NConf = case maps:take(<<"listeners">>, Conf) of
NConf =
case maps:take(<<"listeners">>, Conf) of
error -> Conf;
{Ls, Conf1} ->
Conf1#{<<"listeners">> => unconvert_listeners(Ls)}
{Ls, Conf1} -> Conf1#{<<"listeners">> => unconvert_listeners(Ls)}
end,
ret_gw(GwName, update({?FUNCTION_NAME, bin(GwName), NConf})).
%% @doc convert listener array to map
unconvert_listeners(Ls) when is_list(Ls) ->
lists:foldl(fun(Lis, Acc) ->
lists:foldl(
fun(Lis, Acc) ->
%% FIXME: params apperence guard?
{[Type, Name], Lis1} = maps_key_take([<<"type">>, <<"name">>], Lis),
NLis1 = maps:without([<<"id">>], Lis1),
emqx_map_lib:deep_merge(Acc, #{Type => #{Name => NLis1}})
end, #{}, Ls).
end,
#{},
Ls
).
maps_key_take(Ks, M) ->
maps_key_take(Ks, M, []).
@ -106,8 +115,7 @@ maps_key_take([], M, Acc) ->
maps_key_take([K | Ks], M, Acc) ->
case maps:take(K, M) of
error -> throw(bad_key);
{V, M1} ->
maps_key_take(Ks, M1, [V | Acc])
{V, M1} -> maps_key_take(Ks, M1, [V | Acc])
end.
-spec update_gateway(atom_or_bin(), map()) -> map_or_err().
@ -134,18 +142,23 @@ gateway(GwName0) ->
emqx_config:get_root_raw(Path)
),
Confs = emqx_map_lib:jsonable_map(
emqx_map_lib:deep_get(Path, RawConf)),
emqx_map_lib:deep_get(Path, RawConf)
),
LsConf = maps:get(<<"listeners">>, Confs, #{}),
Confs#{<<"listeners">> => convert_listeners(GwName, LsConf)}.
%% @doc convert listeners map to array
convert_listeners(GwName, Ls) when is_map(Ls) ->
lists:append([do_convert_listener(GwName, Type, maps:to_list(Conf))
|| {Type, Conf} <- maps:to_list(Ls)]).
lists:append([
do_convert_listener(GwName, Type, maps:to_list(Conf))
|| {Type, Conf} <- maps:to_list(Ls)
]).
do_convert_listener(GwName, LType, Conf) ->
[ do_convert_listener2(GwName, LType, LName, LConf)
|| {LName, LConf} <- Conf, is_map(LConf)].
[
do_convert_listener2(GwName, LType, LName, LConf)
|| {LName, LConf} <- Conf, is_map(LConf)
].
do_convert_listener2(GwName, LType, LName, LConf) ->
ListenerId = emqx_gateway_utils:listener_id(GwName, LType, LName),
@ -156,7 +169,8 @@ do_convert_listener2(GwName, LType, LName, LConf) ->
type => LType,
name => LName,
running => Running
}).
}
).
bind2str(LConf = #{bind := Bind}) when is_integer(Bind) ->
maps:put(bind, integer_to_binary(Bind), LConf);
@ -171,28 +185,36 @@ bind2str(LConf = #{<<"bind">> := Bind}) when is_binary(Bind) ->
listeners(GwName0) ->
GwName = bin(GwName0),
RawConf = emqx_config:fill_defaults(
emqx_config:get_root_raw([<<"gateway">>])),
emqx_config:get_root_raw([<<"gateway">>])
),
Listeners = emqx_map_lib:jsonable_map(
emqx_map_lib:deep_get(
[<<"gateway">>, GwName, <<"listeners">>], RawConf)),
[<<"gateway">>, GwName, <<"listeners">>], RawConf
)
),
convert_listeners(GwName, Listeners).
-spec listener(binary()) -> {ok, map()} | {error, not_found} | {error, any()}.
listener(ListenerId) ->
{GwName, Type, LName} = emqx_gateway_utils:parse_listener_id(ListenerId),
RootConf = emqx_config:fill_defaults(
emqx_config:get_root_raw([<<"gateway">>])),
emqx_config:get_root_raw([<<"gateway">>])
),
try
Path = [<<"gateway">>, GwName, <<"listeners">>, Type, LName],
LConf = emqx_map_lib:deep_get(Path, RootConf),
Running = emqx_gateway_utils:is_running(
binary_to_existing_atom(ListenerId), LConf),
{ok, emqx_map_lib:jsonable_map(
binary_to_existing_atom(ListenerId), LConf
),
{ok,
emqx_map_lib:jsonable_map(
LConf#{
id => ListenerId,
type => Type,
name => LName,
running => Running})}
running => Running
}
)}
catch
error:{config_not_found, _} ->
{error, not_found};
@ -203,14 +225,18 @@ listener(ListenerId) ->
-spec add_listener(atom_or_bin(), listener_ref(), map()) -> map_or_err().
add_listener(GwName, ListenerRef, Conf) ->
ret_listener_or_err(
GwName, ListenerRef,
update({?FUNCTION_NAME, bin(GwName), bin(ListenerRef), Conf})).
GwName,
ListenerRef,
update({?FUNCTION_NAME, bin(GwName), bin(ListenerRef), Conf})
).
-spec update_listener(atom_or_bin(), listener_ref(), map()) -> map_or_err().
update_listener(GwName, ListenerRef, Conf) ->
ret_listener_or_err(
GwName, ListenerRef,
update({?FUNCTION_NAME, bin(GwName), bin(ListenerRef), Conf})).
GwName,
ListenerRef,
update({?FUNCTION_NAME, bin(GwName), bin(ListenerRef), Conf})
).
-spec remove_listener(atom_or_bin(), listener_ref()) -> ok_or_err().
remove_listener(GwName, ListenerRef) ->
@ -223,8 +249,10 @@ add_authn(GwName, Conf) ->
-spec add_authn(atom_or_bin(), listener_ref(), map()) -> map_or_err().
add_authn(GwName, ListenerRef, Conf) ->
ret_authn(
GwName, ListenerRef,
update({?FUNCTION_NAME, bin(GwName), bin(ListenerRef), Conf})).
GwName,
ListenerRef,
update({?FUNCTION_NAME, bin(GwName), bin(ListenerRef), Conf})
).
-spec update_authn(atom_or_bin(), map()) -> map_or_err().
update_authn(GwName, Conf) ->
@ -233,8 +261,10 @@ update_authn(GwName, Conf) ->
-spec update_authn(atom_or_bin(), listener_ref(), map()) -> map_or_err().
update_authn(GwName, ListenerRef, Conf) ->
ret_authn(
GwName, ListenerRef,
update({?FUNCTION_NAME, bin(GwName), bin(ListenerRef), Conf})).
GwName,
ListenerRef,
update({?FUNCTION_NAME, bin(GwName), bin(ListenerRef), Conf})
).
-spec remove_authn(atom_or_bin()) -> ok_or_err().
remove_authn(GwName) ->
@ -267,37 +297,57 @@ ret_gw(GwName, {ok, #{raw_config := GwConf}}) ->
GwConf1 = emqx_map_lib:deep_get([bin(GwName)], GwConf),
LsConf = emqx_map_lib:deep_get(
[bin(GwName), <<"listeners">>],
GwConf, #{}),
GwConf,
#{}
),
NLsConf =
lists:foldl(fun({LType, SubConf}, Acc) ->
lists:foldl(
fun({LType, SubConf}, Acc) ->
NLConfs =
lists:map(fun({LName, LConf}) ->
lists:map(
fun({LName, LConf}) ->
do_convert_listener2(GwName, LType, LName, LConf)
end, maps:to_list(SubConf)),
end,
maps:to_list(SubConf)
),
[NLConfs | Acc]
end, [], maps:to_list(LsConf)),
end,
[],
maps:to_list(LsConf)
),
{ok, maps:merge(GwConf1, #{<<"listeners">> => lists:append(NLsConf)})};
ret_gw(_GwName, Err) -> Err.
ret_gw(_GwName, Err) ->
Err.
ret_authn(GwName, {ok, #{raw_config := GwConf}}) ->
Authn = emqx_map_lib:deep_get(
[bin(GwName), <<"authentication">>],
GwConf),
GwConf
),
{ok, Authn};
ret_authn(_GwName, Err) -> Err.
ret_authn(_GwName, Err) ->
Err.
ret_authn(GwName, {LType, LName}, {ok, #{raw_config := GwConf}}) ->
Authn = emqx_map_lib:deep_get(
[bin(GwName), <<"listeners">>, bin(LType),
bin(LName), <<"authentication">>],
GwConf),
[
bin(GwName),
<<"listeners">>,
bin(LType),
bin(LName),
<<"authentication">>
],
GwConf
),
{ok, Authn};
ret_authn(_, _, Err) -> Err.
ret_authn(_, _, Err) ->
Err.
ret_listener_or_err(GwName, {LType, LName}, {ok, #{raw_config := GwConf}}) ->
LConf = emqx_map_lib:deep_get(
[bin(GwName), <<"listeners">>, bin(LType), bin(LName)],
GwConf),
GwConf
),
{ok, do_convert_listener2(GwName, LType, LName, LConf)};
ret_listener_or_err(_, _, Err) ->
Err.
@ -306,9 +356,11 @@ ret_listener_or_err(_, _, Err) ->
%% Config Handler
%%--------------------------------------------------------------------
-spec pre_config_update(list(atom()),
-spec pre_config_update(
list(atom()),
emqx_config:update_request(),
emqx_config:raw_config()) ->
emqx_config:raw_config()
) ->
{ok, emqx_config:update_request()} | {error, term()}.
pre_config_update(_, {load_gateway, GwName, Conf}, RawConf) ->
case maps:get(GwName, RawConf, undefined) of
@ -327,36 +379,45 @@ pre_config_update(_, {update_gateway, GwName, Conf}, RawConf) ->
{ok, emqx_map_lib:deep_merge(RawConf, #{GwName => NConf})}
end;
pre_config_update(_, {unload_gateway, GwName}, RawConf) ->
_ = tune_gw_certs(fun clear_certs/2,
_ = tune_gw_certs(
fun clear_certs/2,
GwName,
maps:get(GwName, RawConf, #{})
),
{ok, maps:remove(GwName, RawConf)};
pre_config_update(_, {add_listener, GwName, {LType, LName}, Conf}, RawConf) ->
case emqx_map_lib:deep_get(
[GwName, <<"listeners">>, LType, LName], RawConf, undefined) of
case
emqx_map_lib:deep_get(
[GwName, <<"listeners">>, LType, LName], RawConf, undefined
)
of
undefined ->
NConf = convert_certs(certs_dir(GwName), Conf),
NListener = #{LType => #{LName => NConf}},
{ok, emqx_map_lib:deep_merge(
{ok,
emqx_map_lib:deep_merge(
RawConf,
#{GwName => #{<<"listeners">> => NListener}})};
#{GwName => #{<<"listeners">> => NListener}}
)};
_ ->
badres_listener(already_exist, GwName, LType, LName)
end;
pre_config_update(_, {update_listener, GwName, {LType, LName}, Conf}, RawConf) ->
case emqx_map_lib:deep_get(
[GwName, <<"listeners">>, LType, LName], RawConf, undefined) of
case
emqx_map_lib:deep_get(
[GwName, <<"listeners">>, LType, LName], RawConf, undefined
)
of
undefined ->
badres_listener(not_found, GwName, LType, LName);
OldConf ->
NConf = convert_certs(certs_dir(GwName), Conf, OldConf),
NListener = #{LType => #{LName => NConf}},
{ok, emqx_map_lib:deep_merge(
{ok,
emqx_map_lib:deep_merge(
RawConf,
#{GwName => #{<<"listeners">> => NListener}})}
#{GwName => #{<<"listeners">> => NListener}}
)}
end;
pre_config_update(_, {remove_listener, GwName, {LType, LName}}, RawConf) ->
Path = [GwName, <<"listeners">>, LType, LName],
@ -367,49 +428,70 @@ pre_config_update(_, {remove_listener, GwName, {LType, LName}}, RawConf) ->
clear_certs(certs_dir(GwName), OldConf),
{ok, emqx_map_lib:deep_remove(Path, RawConf)}
end;
pre_config_update(_, {add_authn, GwName, Conf}, RawConf) ->
case emqx_map_lib:deep_get(
[GwName, ?AUTHN_BIN], RawConf, undefined) of
case
emqx_map_lib:deep_get(
[GwName, ?AUTHN_BIN], RawConf, undefined
)
of
undefined ->
{ok, emqx_map_lib:deep_merge(
{ok,
emqx_map_lib:deep_merge(
RawConf,
#{GwName => #{?AUTHN_BIN => Conf}})};
#{GwName => #{?AUTHN_BIN => Conf}}
)};
_ ->
badres_authn(already_exist, GwName)
end;
pre_config_update(_, {add_authn, GwName, {LType, LName}, Conf}, RawConf) ->
case emqx_map_lib:deep_get(
case
emqx_map_lib:deep_get(
[GwName, <<"listeners">>, LType, LName],
RawConf, undefined) of
RawConf,
undefined
)
of
undefined ->
badres_listener(not_found, GwName, LType, LName);
Listener ->
case maps:get(?AUTHN_BIN, Listener, undefined) of
undefined ->
NListener = maps:put(?AUTHN_BIN, Conf, Listener),
NGateway = #{GwName =>
#{<<"listeners">> =>
#{LType => #{LName => NListener}}}},
NGateway = #{
GwName =>
#{
<<"listeners">> =>
#{LType => #{LName => NListener}}
}
},
{ok, emqx_map_lib:deep_merge(RawConf, NGateway)};
_ ->
badres_listener_authn(already_exist, GwName, LType, LName)
end
end;
pre_config_update(_, {update_authn, GwName, Conf}, RawConf) ->
case emqx_map_lib:deep_get(
[GwName, ?AUTHN_BIN], RawConf, undefined) of
case
emqx_map_lib:deep_get(
[GwName, ?AUTHN_BIN], RawConf, undefined
)
of
undefined ->
badres_authn(not_found, GwName);
_ ->
{ok, emqx_map_lib:deep_merge(
{ok,
emqx_map_lib:deep_merge(
RawConf,
#{GwName => #{?AUTHN_BIN => Conf}})}
#{GwName => #{?AUTHN_BIN => Conf}}
)}
end;
pre_config_update(_, {update_authn, GwName, {LType, LName}, Conf}, RawConf) ->
case emqx_map_lib:deep_get(
case
emqx_map_lib:deep_get(
[GwName, <<"listeners">>, LType, LName],
RawConf, undefined) of
RawConf,
undefined
)
of
undefined ->
badres_listener(not_found, GwName, LType, LName);
Listener ->
@ -422,69 +504,109 @@ pre_config_update(_, {update_authn, GwName, {LType, LName}, Conf}, RawConf) ->
emqx_map_lib:deep_merge(Auth, Conf),
Listener
),
NGateway = #{GwName =>
#{<<"listeners">> =>
#{LType => #{LName => NListener}}}},
NGateway = #{
GwName =>
#{
<<"listeners">> =>
#{LType => #{LName => NListener}}
}
},
{ok, emqx_map_lib:deep_merge(RawConf, NGateway)}
end
end;
pre_config_update(_, {remove_authn, GwName}, RawConf) ->
{ok, emqx_map_lib:deep_remove(
[GwName, ?AUTHN_BIN], RawConf)};
{ok,
emqx_map_lib:deep_remove(
[GwName, ?AUTHN_BIN], RawConf
)};
pre_config_update(_, {remove_authn, GwName, {LType, LName}}, RawConf) ->
Path = [GwName, <<"listeners">>, LType, LName, ?AUTHN_BIN],
{ok, emqx_map_lib:deep_remove(Path, RawConf)};
pre_config_update(_, UnknownReq, _RawConf) ->
logger:error("Unknown configuration update request: ~0p", [UnknownReq]),
{error, badreq}.
badres_gateway(not_found, GwName) ->
{error, {badres, #{resource => gateway, gateway => GwName,
reason => not_found}}};
{error,
{badres, #{
resource => gateway,
gateway => GwName,
reason => not_found
}}};
badres_gateway(already_exist, GwName) ->
{error, {badres, #{resource => gateway, gateway => GwName,
reason => already_exist}}}.
{error,
{badres, #{
resource => gateway,
gateway => GwName,
reason => already_exist
}}}.
badres_listener(not_found, GwName, LType, LName) ->
{error, {badres, #{resource => listener, gateway => GwName,
{error,
{badres, #{
resource => listener,
gateway => GwName,
listener => {GwName, LType, LName},
reason => not_found}}};
reason => not_found
}}};
badres_listener(already_exist, GwName, LType, LName) ->
{error, {badres, #{resource => listener, gateway => GwName,
{error,
{badres, #{
resource => listener,
gateway => GwName,
listener => {GwName, LType, LName},
reason => already_exist}}}.
reason => already_exist
}}}.
badres_authn(not_found, GwName) ->
{error, {badres, #{resource => authn, gateway => GwName,
reason => not_found}}};
{error,
{badres, #{
resource => authn,
gateway => GwName,
reason => not_found
}}};
badres_authn(already_exist, GwName) ->
{error, {badres, #{resource => authn, gateway => GwName,
reason => already_exist}}}.
{error,
{badres, #{
resource => authn,
gateway => GwName,
reason => already_exist
}}}.
badres_listener_authn(not_found, GwName, LType, LName) ->
{error, {badres, #{resource => listener_authn, gateway => GwName,
{error,
{badres, #{
resource => listener_authn,
gateway => GwName,
listener => {GwName, LType, LName},
reason => not_found}}};
reason => not_found
}}};
badres_listener_authn(already_exist, GwName, LType, LName) ->
{error, {badres, #{resource => listener_authn, gateway => GwName,
{error,
{badres, #{
resource => listener_authn,
gateway => GwName,
listener => {GwName, LType, LName},
reason => already_exist}}}.
reason => already_exist
}}}.
-spec post_config_update(list(atom()),
-spec post_config_update(
list(atom()),
emqx_config:update_request(),
emqx_config:config(),
emqx_config:config(), emqx_config:app_envs())
-> ok | {ok, Result::any()} | {error, Reason::term()}.
emqx_config:config(),
emqx_config:app_envs()
) ->
ok | {ok, Result :: any()} | {error, Reason :: term()}.
post_config_update(_, Req, NewConfig, OldConfig, _AppEnvs) when is_tuple(Req) ->
[_Tag, GwName0 | _] = tuple_to_list(Req),
GwName = binary_to_existing_atom(GwName0),
case {maps:get(GwName, NewConfig, undefined),
maps:get(GwName, OldConfig, undefined)} of
case {maps:get(GwName, NewConfig, undefined), maps:get(GwName, OldConfig, undefined)} of
{undefined, undefined} ->
ok; %% nothing to change
%% nothing to change
ok;
{undefined, Old} when is_map(Old) ->
emqx_gateway:unload(GwName);
{New, undefined} when is_map(New) ->
@ -499,29 +621,39 @@ post_config_update(_, _Req, _NewConfig, _OldConfig, _AppEnvs) ->
%% Internal funcs
%%--------------------------------------------------------------------
tune_gw_certs(Fun, GwName, Conf) ->
SubDir = certs_dir(GwName),
case maps:get(<<"listeners">>, Conf, undefined) of
undefined -> Conf;
undefined ->
Conf;
Liss ->
maps:put(<<"listeners">>,
maps:map(fun(_, Lis) ->
maps:map(fun(_, LisConf) ->
maps:put(
<<"listeners">>,
maps:map(
fun(_, Lis) ->
maps:map(
fun(_, LisConf) ->
erlang:apply(Fun, [SubDir, LisConf])
end, Lis)
end, Liss),
Conf)
end,
Lis
)
end,
Liss
),
Conf
)
end.
certs_dir(GwName) when is_binary(GwName) ->
GwName.
convert_certs(SubDir, Conf) ->
case emqx_tls_lib:ensure_ssl_files(
case
emqx_tls_lib:ensure_ssl_files(
SubDir,
maps:get(<<"ssl">>, Conf, undefined)
) of
)
of
{ok, SSL} ->
new_ssl_config(Conf, SSL);
{error, Reason} ->

117
apps/emqx_gateway/src/emqx_gateway_ctx.erl
View File

@ -19,7 +19,6 @@
-include("include/emqx_gateway.hrl").
%% @doc The running context for a Connection/Channel process.
%%
%% The `Context` encapsulates a complex structure of contextual information.
@ -27,45 +26,50 @@
%% configuration, register devices and other common operations.
%%
-type context() ::
#{ %% Gateway Name
gwname := gateway_name()
%% Gateway Name
#{
gwname := gateway_name(),
%% Authentication chains
, auth := [emqx_authentication:chain_name()]
auth := [emqx_authentication:chain_name()],
%% The ConnectionManager PID
, cm := pid()
cm := pid()
}.
%% Authentication circle
-export([ authenticate/2
, open_session/5
, open_session/6
, insert_channel_info/4
, set_chan_info/3
, set_chan_stats/3
, connection_closed/2
-export([
authenticate/2,
open_session/5,
open_session/6,
insert_channel_info/4,
set_chan_info/3,
set_chan_stats/3,
connection_closed/2
]).
%% Message circle
-export([ authorize/4
-export([
authorize/4
% Needless for pub/sub
%, publish/3
%, subscribe/4
]).
%% Metrics & Stats
-export([ metrics_inc/2
, metrics_inc/3
-export([
metrics_inc/2,
metrics_inc/3
]).
%%--------------------------------------------------------------------
%% Authentication circle
%% @doc Authenticate whether the client has access to the Broker.
-spec authenticate(context(), emqx_types:clientinfo())
-> {ok, emqx_types:clientinfo()}
-spec authenticate(context(), emqx_types:clientinfo()) ->
{ok, emqx_types:clientinfo()}
| {error, any()}.
authenticate(_Ctx = #{auth := _ChainNames}, ClientInfo0)
when is_list(_ChainNames) ->
authenticate(_Ctx = #{auth := _ChainNames}, ClientInfo0) when
is_list(_ChainNames)
->
ClientInfo = ClientInfo0#{zone => default},
case emqx_access_control:authenticate(ClientInfo) of
{ok, _} ->
@ -78,43 +82,74 @@ authenticate(_Ctx = #{auth := _ChainNames}, ClientInfo0)
%%
%% This function should be called after the client has authenticated
%% successfully so that the client can be managed in the cluster.
-spec open_session(context(), boolean(), emqx_types:clientinfo(),
-spec open_session(
context(),
boolean(),
emqx_types:clientinfo(),
emqx_types:conninfo(),
fun((emqx_types:clientinfo(),
emqx_types:conninfo()) -> Session)
fun(
(
emqx_types:clientinfo(),
emqx_types:conninfo()
) -> Session
)
-> {ok, #{session := Session,
) ->
{ok, #{
session := Session,
present := boolean(),
pendings => list()
}}
| {error, any()}.
open_session(Ctx, CleanStart, ClientInfo, ConnInfo, CreateSessionFun) ->
open_session(Ctx, CleanStart, ClientInfo, ConnInfo,
CreateSessionFun, emqx_session).
open_session(
Ctx,
CleanStart,
ClientInfo,
ConnInfo,
CreateSessionFun,
emqx_session
).
open_session(_Ctx = #{gwname := GwName},
CleanStart, ClientInfo, ConnInfo, CreateSessionFun, SessionMod) ->
emqx_gateway_cm:open_session(GwName, CleanStart,
ClientInfo, ConnInfo,
CreateSessionFun, SessionMod).
open_session(
_Ctx = #{gwname := GwName},
CleanStart,
ClientInfo,
ConnInfo,
CreateSessionFun,
SessionMod
) ->
emqx_gateway_cm:open_session(
GwName,
CleanStart,
ClientInfo,
ConnInfo,
CreateSessionFun,
SessionMod
).
-spec insert_channel_info(context(),
-spec insert_channel_info(
context(),
emqx_types:clientid(),
emqx_types:infos(),
emqx_types:stats()) -> ok.
emqx_types:stats()
) -> ok.
insert_channel_info(_Ctx = #{gwname := GwName}, ClientId, Infos, Stats) ->
emqx_gateway_cm:insert_channel_info(GwName, ClientId, Infos, Stats).
%% @doc Set the Channel Info to the ConnectionManager for this client
-spec set_chan_info(context(),
-spec set_chan_info(
context(),
emqx_types:clientid(),
emqx_types:infos()) -> boolean().
emqx_types:infos()
) -> boolean().
set_chan_info(_Ctx = #{gwname := GwName}, ClientId, Infos) ->
emqx_gateway_cm:set_chan_info(GwName, ClientId, Infos).
-spec set_chan_stats(context(),
-spec set_chan_stats(
context(),
emqx_types:clientid(),
emqx_types:stats()) -> boolean().
emqx_types:stats()
) -> boolean().
set_chan_stats(_Ctx = #{gwname := GwName}, ClientId, Stats) ->
emqx_gateway_cm:set_chan_stats(GwName, ClientId, Stats).
@ -122,9 +157,13 @@ set_chan_stats(_Ctx = #{gwname := GwName}, ClientId, Stats) ->
connection_closed(_Ctx = #{gwname := GwName}, ClientId) ->
emqx_gateway_cm:connection_closed(GwName, ClientId).
-spec authorize(context(), emqx_types:clientinfo(),
emqx_types:pubsub(), emqx_types:topic())
-> allow | deny.
-spec authorize(
context(),
emqx_types:clientinfo(),
emqx_types:pubsub(),
emqx_types:topic()
) ->
allow | deny.
authorize(_Ctx, ClientInfo, PubSub, Topic) ->
emqx_access_control:authorize(ClientInfo, PubSub, Topic).

52
apps/emqx_gateway/src/emqx_gateway_gw_sup.erl
View File

@ -27,12 +27,13 @@
-export([start_link/1]).
-export([ create_insta/3
, remove_insta/2
, update_insta/3
, start_insta/2
, stop_insta/2
, list_insta/1
-export([
create_insta/3,
remove_insta/2,
update_insta/3,
start_insta/2,
stop_insta/2,
list_insta/1
]).
%% Supervisor callbacks
@ -48,7 +49,8 @@ start_link(GwName) ->
-spec create_insta(pid(), gateway(), map()) -> {ok, GwInstaPid :: pid()} | {error, any()}.
create_insta(Sup, Gateway = #{name := Name}, GwDscrptr) ->
case emqx_gateway_utils:find_sup_child(Sup, Name) of
{ok, _GwInstaPid} -> {error, alredy_existed};
{ok, _GwInstaPid} ->
{error, alredy_existed};
false ->
Ctx = ctx(Sup, Name),
ChildSpec = emqx_gateway_utils:childspec(
@ -65,52 +67,53 @@ create_insta(Sup, Gateway = #{name := Name}, GwDscrptr) ->
-spec remove_insta(pid(), Name :: gateway_name()) -> ok | {error, any()}.
remove_insta(Sup, Name) ->
case emqx_gateway_utils:find_sup_child(Sup, Name) of
false -> ok;
false ->
ok;
{ok, _GwInstaPid} ->
ok = supervisor:terminate_child(Sup, Name),
ok = supervisor:delete_child(Sup, Name)
end.
-spec update_insta(pid(), gateway_name(), emqx_config:config())
-> ok | {error, any()}.
-spec update_insta(pid(), gateway_name(), emqx_config:config()) ->
ok | {error, any()}.
update_insta(Sup, Name, Config) ->
case emqx_gateway_utils:find_sup_child(Sup, Name) of
false -> {error, not_found};
{ok, GwInstaPid} ->
emqx_gateway_insta_sup:update(GwInstaPid, Config)
{ok, GwInstaPid} -> emqx_gateway_insta_sup:update(GwInstaPid, Config)
end.
-spec start_insta(pid(), gateway_name()) -> ok | {error, any()}.
start_insta(Sup, Name) ->
case emqx_gateway_utils:find_sup_child(Sup, Name) of
false -> {error, not_found};
{ok, GwInstaPid} ->
emqx_gateway_insta_sup:enable(GwInstaPid)
{ok, GwInstaPid} -> emqx_gateway_insta_sup:enable(GwInstaPid)
end.
-spec stop_insta(pid(), gateway_name()) -> ok | {error, any()}.
stop_insta(Sup, Name) ->
case emqx_gateway_utils:find_sup_child(Sup, Name) of
false -> {error, not_found};
{ok, GwInstaPid} ->
emqx_gateway_insta_sup:disable(GwInstaPid)
{ok, GwInstaPid} -> emqx_gateway_insta_sup:disable(GwInstaPid)
end.
-spec list_insta(pid()) -> [gateway()].
list_insta(Sup) ->
lists:filtermap(
fun({Name, GwInstaPid, _Type, _Mods}) ->
is_gateway_insta_id(Name)
andalso {true, emqx_gateway_insta_sup:info(GwInstaPid)}
end, supervisor:which_children(Sup)).
is_gateway_insta_id(Name) andalso
{true, emqx_gateway_insta_sup:info(GwInstaPid)}
end,
supervisor:which_children(Sup)
).
%% Supervisor callback
%% @doc Initialize Top Supervisor for a Protocol
init([GwName]) ->
SupFlags = #{ strategy => one_for_one
, intensity => 10
, period => 60
SupFlags = #{
strategy => one_for_one,
intensity => 10,
period => 60
},
CmOpts = [{gwname, GwName}],
CM = emqx_gateway_utils:childspec(worker, emqx_gateway_cm, [CmOpts]),
@ -123,8 +126,9 @@ init([GwName]) ->
ctx(Sup, Name) ->
{ok, CM} = emqx_gateway_utils:find_sup_child(Sup, emqx_gateway_cm),
#{ gwname => Name
, cm => CM
#{
gwname => Name,
cm => CM
}.
is_gateway_insta_id(emqx_gateway_cm) ->

340
apps/emqx_gateway/src/emqx_gateway_http.erl
View File

@ -26,57 +26,62 @@
-import(emqx_gateway_utils, [listener_id/3]).
%% Mgmt APIs - gateway
-export([ gateways/1
]).
-export([gateways/1]).
%% Mgmt APIs
-export([ add_listener/2
, remove_listener/1
, update_listener/2
-export([
add_listener/2,
remove_listener/1,
update_listener/2
]).
-export([ authn/1
, authn/2
, add_authn/2
, add_authn/3
, update_authn/2
, update_authn/3
, remove_authn/1
, remove_authn/2
-export([
authn/1,
authn/2,
add_authn/2,
add_authn/3,
update_authn/2,
update_authn/3,
remove_authn/1,
remove_authn/2
]).
%% Mgmt APIs - clients
-export([ lookup_client/3
, kickout_client/2
, list_client_subscriptions/2
, client_subscribe/4
, client_unsubscribe/3
-export([
lookup_client/3,
kickout_client/2,
list_client_subscriptions/2,
client_subscribe/4,
client_unsubscribe/3
]).
%% Utils for http, swagger, etc.
-export([ return_http_error/2
, with_gateway/2
, with_authn/2
, with_listener_authn/3
, checks/2
, reason2resp/1
, reason2msg/1
-export([
return_http_error/2,
with_gateway/2,
with_authn/2,
with_listener_authn/3,
checks/2,
reason2resp/1,
reason2msg/1
]).
-type gateway_summary() ::
#{ name := binary()
, status := running | stopped | unloaded
, created_at => binary()
, started_at => binary()
, stopped_at => binary()
, max_connections => integer()
, current_connections => integer()
, listeners => []
#{
name := binary(),
status := running | stopped | unloaded,
created_at => binary(),
started_at => binary(),
stopped_at => binary(),
max_connections => integer(),
current_connections => integer(),
listeners => []
}.
-elvis([ {elvis_style, god_modules, disable}
, {elvis_style, no_nested_try_catch, disable}
, {elvis_style, invalid_dynamic_call, disable}
-elvis([
{elvis_style, god_modules, disable},
{elvis_style, no_nested_try_catch, disable},
{elvis_style, invalid_dynamic_call, disable}
]).
-define(DEFAULT_CALL_TIMEOUT, 15000).
@ -85,53 +90,69 @@
%% Mgmt APIs - gateway
%%--------------------------------------------------------------------
-spec gateways(Status :: all | running | stopped | unloaded)
-> [gateway_summary()].
-spec gateways(Status :: all | running | stopped | unloaded) ->
[gateway_summary()].
gateways(Status) ->
Gateways = lists:map(fun({GwName, _}) ->
Gateways = lists:map(
fun({GwName, _}) ->
case emqx_gateway:lookup(GwName) of
undefined -> #{name => GwName, status => unloaded};
undefined ->
#{name => GwName, status => unloaded};
GwInfo = #{config := Config} ->
GwInfo0 = emqx_gateway_utils:unix_ts_to_rfc3339(
[created_at, started_at, stopped_at],
GwInfo),
GwInfo1 = maps:with([name,
GwInfo
),
GwInfo1 = maps:with(
[
name,
status,
created_at,
started_at,
stopped_at], GwInfo0),
stopped_at
],
GwInfo0
),
GwInfo1#{
max_connections => max_connections_count(Config),
current_connections => current_connections_count(GwName),
listeners => get_listeners_status(GwName, Config)}
listeners => get_listeners_status(GwName, Config)
}
end
end, emqx_gateway_registry:list()),
end,
emqx_gateway_registry:list()
),
case Status of
all -> Gateways;
_ ->
[Gw || Gw = #{status := S} <- Gateways, S == Status]
_ -> [Gw || Gw = #{status := S} <- Gateways, S == Status]
end.
%% @private
max_connections_count(Config) ->
Listeners = emqx_gateway_utils:normalize_config(Config),
lists:foldl(fun({_, _, _, SocketOpts, _}, Acc) ->
lists:foldl(
fun({_, _, _, SocketOpts, _}, Acc) ->
Acc + proplists:get_value(max_connections, SocketOpts, 0)
end, 0, Listeners).
end,
0,
Listeners
).
%% @private
current_connections_count(GwName) ->
try
InfoTab = emqx_gateway_cm:tabname(info, GwName),
ets:info(InfoTab, size)
catch _ : _ ->
catch
_:_ ->
0
end.
%% @private
get_listeners_status(GwName, Config) ->
Listeners = emqx_gateway_utils:normalize_config(Config),
lists:map(fun({Type, LisName, ListenOn, _, _}) ->
lists:map(
fun({Type, LisName, ListenOn, _, _}) ->
Name0 = listener_id(GwName, Type, LisName),
Name = {Name0, ListenOn},
LisO = #{id => Name0, type => Type, name => LisName},
@ -141,7 +162,9 @@ get_listeners_status(GwName, Config) ->
_ ->
LisO#{running => false}
end
end, Listeners).
end,
Listeners
).
%%--------------------------------------------------------------------
%% Mgmt APIs - listeners
@ -150,16 +173,30 @@ get_listeners_status(GwName, Config) ->
-spec add_listener(atom() | binary(), map()) -> {ok, map()}.
add_listener(ListenerId, NewConf0) ->
{GwName, Type, Name} = emqx_gateway_utils:parse_listener_id(ListenerId),
NewConf = maps:without([<<"id">>, <<"name">>,
<<"type">>, <<"running">>], NewConf0),
NewConf = maps:without(
[
<<"id">>,
<<"name">>,
<<"type">>,
<<"running">>
],
NewConf0
),
confexp(emqx_gateway_conf:add_listener(GwName, {Type, Name}, NewConf)).
-spec update_listener(atom() | binary(), map()) -> {ok, map()}.
update_listener(ListenerId, NewConf0) ->
{GwName, Type, Name} = emqx_gateway_utils:parse_listener_id(ListenerId),
NewConf = maps:without([<<"id">>, <<"name">>,
<<"type">>, <<"running">>], NewConf0),
NewConf = maps:without(
[
<<"id">>,
<<"name">>,
<<"type">>,
<<"running">>
],
NewConf0
),
confexp(emqx_gateway_conf:update_listener(GwName, {Type, Name}, NewConf)).
-spec remove_listener(binary()) -> ok.
@ -230,22 +267,29 @@ confexp({error, Reason}) -> error(Reason).
%% Mgmt APIs - clients
%%--------------------------------------------------------------------
-spec lookup_client(gateway_name(),
emqx_types:clientid(), {module(), atom()}) -> list().
-spec lookup_client(
gateway_name(),
emqx_types:clientid(),
{module(), atom()}
) -> list().
lookup_client(GwName, ClientId, {M, F}) ->
[begin
[
begin
Info = emqx_gateway_cm:get_chan_info(GwName, ClientId, Pid),
Stats = emqx_gateway_cm:get_chan_stats(GwName, ClientId, Pid),
M:F({{ClientId, Pid}, Info, Stats})
end
|| Pid <- emqx_gateway_cm:lookup_by_clientid(GwName, ClientId)].
|| Pid <- emqx_gateway_cm:lookup_by_clientid(GwName, ClientId)
].
-spec kickout_client(gateway_name(), emqx_types:clientid())
-> {error, any()}
-spec kickout_client(gateway_name(), emqx_types:clientid()) ->
{error, any()}
| ok.
kickout_client(GwName, ClientId) ->
Results = [emqx_gateway_cm:kick_session(GwName, ClientId, Pid)
|| Pid <- emqx_gateway_cm:lookup_by_clientid(GwName, ClientId)],
Results = [
emqx_gateway_cm:kick_session(GwName, ClientId, Pid)
|| Pid <- emqx_gateway_cm:lookup_by_clientid(GwName, ClientId)
],
IsOk = lists:any(fun(Item) -> Item =:= ok end, Results),
case {IsOk, Results} of
{true, _} -> ok;
@ -253,40 +297,59 @@ kickout_client(GwName, ClientId) ->
{false, _} -> lists:last(Results)
end.
-spec list_client_subscriptions(gateway_name(), emqx_types:clientid())
-> {error, any()}
-spec list_client_subscriptions(gateway_name(), emqx_types:clientid()) ->
{error, any()}
| {ok, list()}.
list_client_subscriptions(GwName, ClientId) ->
case client_call(GwName, ClientId, subscriptions) of
{error, Reason} -> {error, Reason};
{error, Reason} ->
{error, Reason};
{ok, Subs} ->
{ok, lists:map(fun({Topic, SubOpts}) ->
{ok,
lists:map(
fun({Topic, SubOpts}) ->
SubOpts#{topic => Topic}
end, Subs)}
end,
Subs
)}
end.
-spec client_subscribe(gateway_name(), emqx_types:clientid(),
emqx_types:topic(), emqx_types:subopts())
-> {error, any()}
-spec client_subscribe(
gateway_name(),
emqx_types:clientid(),
emqx_types:topic(),
emqx_types:subopts()
) ->
{error, any()}
| {ok, {emqx_types:topic(), emqx_types:subopts()}}.
client_subscribe(GwName, ClientId, Topic, SubOpts) ->
client_call(GwName, ClientId, {subscribe, Topic, SubOpts}).
-spec client_unsubscribe(gateway_name(),
emqx_types:clientid(), emqx_types:topic())
-> {error, any()}
-spec client_unsubscribe(
gateway_name(),
emqx_types:clientid(),
emqx_types:topic()
) ->
{error, any()}
| ok.
client_unsubscribe(GwName, ClientId, Topic) ->
client_call(GwName, ClientId, {unsubscribe, Topic}).
client_call(GwName, ClientId, Req) ->
try emqx_gateway_cm:call(
GwName, ClientId,
Req, ?DEFAULT_CALL_TIMEOUT) of
try
emqx_gateway_cm:call(
GwName,
ClientId,
Req,
?DEFAULT_CALL_TIMEOUT
)
of
undefined ->
{error, not_found};
Res -> Res
catch throw : noproc ->
Res ->
Res
catch
throw:noproc ->
{error, not_found};
throw:{badrpc, Reason} ->
{error, {badrpc, Reason}}
@ -311,54 +374,88 @@ return_http_error(Code, Msg) ->
-spec reason2msg({atom(), map()} | any()) -> error | string().
reason2msg({badconf, #{key := Key, value := Value, reason := Reason}}) ->
NValue = case emqx_json:safe_encode(Value) of
NValue =
case emqx_json:safe_encode(Value) of
{ok, Str} -> Str;
{error, _} -> emqx_gateway_utils:stringfy(Value)
end,
fmtstr("Bad config value '~s' for '~s', reason: ~s",
[NValue, Key, Reason]);
reason2msg({badres, #{resource := gateway,
fmtstr(
"Bad config value '~s' for '~s', reason: ~s",
[NValue, Key, Reason]
);
reason2msg(
{badres, #{
resource := gateway,
gateway := GwName,
reason := not_found}}) ->
reason := not_found
}}
) ->
fmtstr("The ~s gateway is unloaded", [GwName]);
reason2msg({badres, #{resource := gateway,
reason2msg(
{badres, #{
resource := gateway,
gateway := GwName,
reason := already_exist}}) ->
reason := already_exist
}}
) ->
fmtstr("The ~s gateway already loaded", [GwName]);
reason2msg({badres, #{resource := listener,
reason2msg(
{badres, #{
resource := listener,
listener := {GwName, LType, LName},
reason := not_found}}) ->
reason := not_found
}}
) ->
fmtstr("Listener ~s not found", [listener_id(GwName, LType, LName)]);
reason2msg({badres, #{resource := listener,
reason2msg(
{badres, #{
resource := listener,
listener := {GwName, LType, LName},
reason := already_exist}}) ->
fmtstr("The listener ~s of ~s already exist",
[listener_id(GwName, LType, LName), GwName]);
reason2msg({badres, #{resource := authn,
reason := already_exist
}}
) ->
fmtstr(
"The listener ~s of ~s already exist",
[listener_id(GwName, LType, LName), GwName]
);
reason2msg(
{badres, #{
resource := authn,
gateway := GwName,
reason := not_found}}) ->
reason := not_found
}}
) ->
fmtstr("The authentication not found on ~s", [GwName]);
reason2msg({badres, #{resource := authn,
reason2msg(
{badres, #{
resource := authn,
gateway := GwName,
reason := already_exist}}) ->
reason := already_exist
}}
) ->
fmtstr("The authentication already exist on ~s", [GwName]);
reason2msg({badres, #{resource := listener_authn,
reason2msg(
{badres, #{
resource := listener_authn,
listener := {GwName, LType, LName},
reason := not_found}}) ->
fmtstr("The authentication not found on ~s",
[listener_id(GwName, LType, LName)]);
reason2msg({badres, #{resource := listener_authn,
reason := not_found
}}
) ->
fmtstr(
"The authentication not found on ~s",
[listener_id(GwName, LType, LName)]
);
reason2msg(
{badres, #{
resource := listener_authn,
listener := {GwName, LType, LName},
reason := already_exist}}) ->
fmtstr("The authentication already exist on ~s",
[listener_id(GwName, LType, LName)]);
reason := already_exist
}}
) ->
fmtstr(
"The authentication already exist on ~s",
[listener_id(GwName, LType, LName)]
);
reason2msg(_) ->
error.
@ -389,9 +486,11 @@ with_listener_authn(GwName0, Id, Fun) ->
-spec with_gateway(binary(), function()) -> any().
with_gateway(GwName0, Fun) ->
try
GwName = try
GwName =
try
binary_to_existing_atom(GwName0)
catch _ : _ -> error(badname)
catch
_:_ -> error(badname)
end,
case emqx_gateway:lookup(GwName) of
undefined ->
@ -411,12 +510,14 @@ with_gateway(GwName0, Fun) ->
%% Exceptions from: emqx:get_config/1
error:{config_not_found, Path0} ->
Path = lists:concat(
lists:join(".", lists:map(fun to_list/1, Path0))),
lists:join(".", lists:map(fun to_list/1, Path0))
),
return_http_error(404, "Resource not found. path: " ++ Path);
Class:Reason:Stk ->
?SLOG(error, #{ msg => "uncatched_error"
, reason => {Class, Reason}
, stacktrace => Stk
?SLOG(error, #{
msg => "uncatched_error",
reason => {Class, Reason},
stacktrace => Stk
}),
reason2resp(Reason)
end.
@ -427,8 +528,7 @@ checks([], _) ->
checks([K | Ks], Map) ->
case maps:is_key(K, Map) of
true -> checks(Ks, Map);
false ->
error({miss_param, K})
false -> error({miss_param, K})
end.
to_list(A) when is_atom(A) ->

223
apps/emqx_gateway/src/emqx_gateway_insta_sup.erl
View File

@ -23,20 +23,22 @@
-include_lib("emqx/include/logger.hrl").
%% APIs
-export([ start_link/3
, info/1
, disable/1
, enable/1
, update/2
-export([
start_link/3,
info/1,
disable/1,
enable/1,
update/2
]).
%% gen_server callbacks
-export([ init/1
, handle_call/3
, handle_cast/2
, handle_info/2
, terminate/2
, code_change/3
-export([
init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3
]).
-record(state, {
@ -105,8 +107,9 @@ init([Gateway, Ctx, _GwDscrptr]) ->
},
case maps:get(enable, Config, true) of
false ->
?SLOG(info, #{ msg => "skip_to_start_gateway_due_to_disabled"
, gateway_name => GwName
?SLOG(info, #{
msg => "skip_to_start_gateway_due_to_disabled",
gateway_name => GwName
}),
{ok, State};
true ->
@ -120,7 +123,6 @@ init([Gateway, Ctx, _GwDscrptr]) ->
handle_call(info, _From, State) ->
{reply, detailed_gateway_info(State), State};
handle_call(disable, _From, State = #state{status = Status}) ->
case Status of
running ->
@ -133,7 +135,6 @@ handle_call(disable, _From, State = #state{status = Status}) ->
_ ->
{reply, {error, already_stopped}, State}
end;
handle_call(enable, _From, State = #state{status = Status}) ->
case Status of
stopped ->
@ -146,7 +147,6 @@ handle_call(enable, _From, State = #state{status = Status}) ->
_ ->
{reply, {error, already_started}, State}
end;
handle_call({update, Config}, _From, State) ->
case do_update_one_by_one(Config, State) of
{ok, NState} ->
@ -155,7 +155,6 @@ handle_call({update, Config}, _From, State) ->
%% If something wrong, nothing to update
{reply, {error, Reason}, State}
end;
handle_call(_Request, _From, State) ->
Reply = ok,
{reply, Reply, State}.
@ -163,37 +162,47 @@ handle_call(_Request, _From, State) ->
handle_cast(_Msg, State) ->
{noreply, State}.
handle_info({'EXIT', Pid, Reason}, State = #state{name = Name,
child_pids = Pids}) ->
handle_info(
{'EXIT', Pid, Reason},
State = #state{
name = Name,
child_pids = Pids
}
) ->
case lists:member(Pid, Pids) of
true ->
?SLOG(error, #{ msg => "child_process_exited"
, child => Pid
, reason => Reason
?SLOG(error, #{
msg => "child_process_exited",
child => Pid,
reason => Reason
}),
case Pids -- [Pid] of
[] ->
?SLOG(error, #{ msg => "gateway_all_children_process_existed"
, gateway_name => Name
?SLOG(error, #{
msg => "gateway_all_children_process_existed",
gateway_name => Name
}),
{noreply, State#state{status = stopped,
{noreply, State#state{
status = stopped,
child_pids = [],
gw_state = undefined}};
gw_state = undefined
}};
RemainPids ->
{noreply, State#state{child_pids = RemainPids}}
end;
_ ->
?SLOG(error, #{ msg => "gateway_catch_a_unknown_process_exited"
, child => Pid
, reason => Reason
, gateway_name => Name
?SLOG(error, #{
msg => "gateway_catch_a_unknown_process_exited",
child => Pid,
reason => Reason,
gateway_name => Name
}),
{noreply, State}
end;
handle_info(Info, State) ->
?SLOG(warning, #{ msg => "unexcepted_info"
, info => Info
?SLOG(warning, #{
msg => "unexcepted_info",
info => Info
}),
{noreply, State}.
@ -208,13 +217,15 @@ code_change(_OldVsn, State, _Extra) ->
detailed_gateway_info(State) ->
maps:filter(
fun(_, V) -> V =/= undefined end,
#{name => State#state.name,
#{
name => State#state.name,
config => State#state.config,
status => State#state.status,
created_at => State#state.created_at,
started_at => State#state.started_at,
stopped_at => State#state.stopped_at
}).
}
).
%%--------------------------------------------------------------------
%% Internal funcs
@ -250,11 +261,15 @@ do_init_authn([_BadConf | More], Names) ->
authns(GwName, Config) ->
Listeners = maps:to_list(maps:get(listeners, Config, #{})),
lists:append(
[ [{emqx_gateway_utils:listener_chain(GwName, LisType, LisName),
authn_conf(Opts)}
|| {LisName, Opts} <- maps:to_list(LisNames) ]
|| {LisType, LisNames} <- Listeners])
++ [{emqx_gateway_utils:global_chain(GwName), authn_conf(Config)}].
[
[
{emqx_gateway_utils:listener_chain(GwName, LisType, LisName), authn_conf(Opts)}
|| {LisName, Opts} <- maps:to_list(LisNames)
]
|| {LisType, LisNames} <- Listeners
]
) ++
[{emqx_gateway_utils:global_chain(GwName), authn_conf(Config)}].
authn_conf(Conf) ->
maps:get(authentication, Conf, #{enable => false}).
@ -263,19 +278,22 @@ do_create_authn_chain(ChainName, AuthConf) ->
case ensure_chain(ChainName) of
ok ->
case emqx_authentication:create_authenticator(ChainName, AuthConf) of
{ok, _} -> ok;
{ok, _} ->
ok;
{error, Reason} ->
?SLOG(error, #{ msg => "failed_to_create_authenticator"
, chain_name => ChainName
, reason => Reason
, config => AuthConf
?SLOG(error, #{
msg => "failed_to_create_authenticator",
chain_name => ChainName,
reason => Reason,
config => AuthConf
}),
throw({badauth, Reason})
end;
{error, Reason} ->
?SLOG(error, #{ msg => "failed_to_create_authn_chanin"
, chain_name => ChainName
, reason => Reason
?SLOG(error, #{
msg => "failed_to_create_authn_chanin",
chain_name => ChainName,
reason => Reason
}),
throw({badauth, Reason})
end.
@ -291,22 +309,32 @@ ensure_chain(ChainName) ->
end.
do_deinit_authn(Names) ->
lists:foreach(fun(ChainName) ->
lists:foreach(
fun(ChainName) ->
case emqx_authentication:delete_chain(ChainName) of
ok -> ok;
{error, {not_found, _}} -> ok;
ok ->
ok;
{error, {not_found, _}} ->
ok;
{error, Reason} ->
?SLOG(error, #{ msg => "failed_to_clean_authn_chain"
, chain_name => ChainName
, reason => Reason
?SLOG(error, #{
msg => "failed_to_clean_authn_chain",
chain_name => ChainName,
reason => Reason
})
end
end, Names).
end,
Names
).
do_update_one_by_one(NCfg, State = #state{
do_update_one_by_one(
NCfg,
State = #state{
name = GwName,
config = OCfg,
status = Status}) ->
status = Status
}
) ->
NEnable = maps:get(enable, NCfg, true),
OAuths = authns(GwName, OCfg),
@ -319,8 +347,10 @@ do_update_one_by_one(NCfg, State = #state{
{stopped, false} ->
{ok, State#state{config = NCfg}};
{running, true} ->
NState = case NAuths == OAuths of
true -> State;
NState =
case NAuths == OAuths of
true ->
State;
false ->
%% Reset Authentication first
_ = do_deinit_authn(State#state.authns),
@ -338,25 +368,32 @@ do_update_one_by_one(NCfg, State = #state{
throw(nomatch)
end.
cb_gateway_unload(State = #state{name = GwName,
gw_state = GwState}) ->
cb_gateway_unload(
State = #state{
name = GwName,
gw_state = GwState
}
) ->
Gateway = detailed_gateway_info(State),
try
#{cbkmod := CbMod} = emqx_gateway_registry:lookup(GwName),
CbMod:on_gateway_unload(Gateway, GwState),
{ok, State#state{child_pids = [],
{ok, State#state{
child_pids = [],
authns = [],
status = stopped,
gw_state = undefined,
started_at = undefined,
stopped_at = erlang:system_time(millisecond)}}
stopped_at = erlang:system_time(millisecond)
}}
catch
Class:Reason:Stk ->
?SLOG(error, #{ msg => "unload_gateway_crashed"
, gateway_name => GwName
, inner_state => GwState
, reason => {Class, Reason}
, stacktrace => Stk
?SLOG(error, #{
msg => "unload_gateway_crashed",
gateway_name => GwName,
inner_state => GwState,
reason => {Class, Reason},
stacktrace => Stk
}),
{error, Reason}
after
@ -367,10 +404,13 @@ cb_gateway_unload(State = #state{name = GwName,
%% 2. Callback to Mod:on_gateway_load/2
%%
%% Notes: If failed, rollback
cb_gateway_load(State = #state{name = GwName,
cb_gateway_load(
State = #state{
name = GwName,
config = Config,
ctx = Ctx}) ->
ctx = Ctx
}
) ->
Gateway = detailed_gateway_info(State),
try
AuthnNames = init_authn(GwName, Config),
@ -394,23 +434,29 @@ cb_gateway_load(State = #state{name = GwName,
end
catch
Class:Reason1:Stk ->
?SLOG(error, #{ msg => "load_gateway_crashed"
, gateway_name => GwName
, gateway => Gateway
, ctx => Ctx
, reason => {Class, Reason1}
, stacktrace => Stk
?SLOG(error, #{
msg => "load_gateway_crashed",
gateway_name => GwName,
gateway => Gateway,
ctx => Ctx,
reason => {Class, Reason1},
stacktrace => Stk
}),
{error, Reason1}
end.
cb_gateway_update(Config,
State = #state{name = GwName,
gw_state = GwState}) ->
cb_gateway_update(
Config,
State = #state{
name = GwName,
gw_state = GwState
}
) ->
try
#{cbkmod := CbMod} = emqx_gateway_registry:lookup(GwName),
case CbMod:on_gateway_update(Config, detailed_gateway_info(State), GwState) of
{error, Reason} -> {error, Reason};
{error, Reason} ->
{error, Reason};
{ok, ChildPidOrSpecs, NGwState} ->
ChildPids = start_child_process(ChildPidOrSpecs),
{ok, State#state{
@ -421,16 +467,18 @@ cb_gateway_update(Config,
end
catch
Class:Reason1:Stk ->
?SLOG(error, #{ msg => "update_gateway_crashed"
, gateway_name => GwName
, new_config => Config
, reason => {Class, Reason1}
, stacktrace => Stk
?SLOG(error, #{
msg => "update_gateway_crashed",
gateway_name => GwName,
new_config => Config,
reason => {Class, Reason1},
stacktrace => Stk
}),
{error, Reason1}
end.
start_child_process([]) -> [];
start_child_process([]) ->
[];
start_child_process([Indictor | _] = ChildPidOrSpecs) ->
case erlang:is_pid(Indictor) of
true ->
@ -441,7 +489,6 @@ start_child_process([Indictor | _] = ChildPidOrSpecs) ->
do_start_child_process(ChildSpecs) when is_list(ChildSpecs) ->
lists:map(fun do_start_child_process/1, ChildSpecs);
do_start_child_process(_ChildSpec = #{start := {M, F, A}}) ->
case erlang:apply(M, F, A) of
{ok, Pid} ->

26
apps/emqx_gateway/src/emqx_gateway_metrics.erl
View File

@ -23,21 +23,23 @@
%% APIs
-export([start_link/1]).
-export([ inc/2
, inc/3
, dec/2
, dec/3
-export([
inc/2,
inc/3,
dec/2,
dec/3
]).
-export([lookup/1]).
%% gen_server callbacks
-export([ init/1
, handle_call/3
, handle_cast/2
, handle_info/2
, terminate/2
, code_change/3
-export([
init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3
]).
-export([tabname/1]).
@ -68,8 +70,8 @@ dec(GwName, Name) ->
dec(GwName, Name, Oct) ->
inc(GwName, Name, -Oct).
-spec lookup(gateway_name())
-> undefined
-spec lookup(gateway_name()) ->
undefined
| [{Name :: atom(), integer()}].
lookup(GwName) ->
Tab = emqx_gateway_metrics:tabname(GwName),

40
apps/emqx_gateway/src/emqx_gateway_registry.erl
View File

@ -22,22 +22,24 @@
-behaviour(gen_server).
%% APIs
-export([ reg/2
, unreg/1
, list/0
, lookup/1
-export([
reg/2,
unreg/1,
list/0,
lookup/1
]).
%% APIs
-export([start_link/0]).
%% gen_server callbacks
-export([ init/1
, handle_call/3
, handle_cast/2
, handle_info/2
, terminate/2
, code_change/3
-export([
init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3
]).
-record(state, {
@ -48,8 +50,9 @@
-type registry_option() :: {cbkmod, atom()}.
-type descriptor() :: #{ cbkmod := atom()
, rgopts := registry_options()
-type descriptor() :: #{
cbkmod := atom(),
rgopts := registry_options()
}.
%%--------------------------------------------------------------------
@ -63,13 +66,14 @@ start_link() ->
%% Mgmt
%%--------------------------------------------------------------------
-spec reg(gateway_name(), registry_options())
-> ok
-spec reg(gateway_name(), registry_options()) ->
ok
| {error, any()}.
reg(Name, RgOpts) ->
CbMod = proplists:get_value(cbkmod, RgOpts, Name),
Dscrptr = #{ cbkmod => CbMod
, rgopts => RgOpts
Dscrptr = #{
cbkmod => CbMod,
rgopts => RgOpts
},
call({reg, Name, Dscrptr}).
@ -110,7 +114,6 @@ handle_call({reg, Name, Dscrptr}, _From, State = #state{reged = Gateways}) ->
_ ->
{reply, {error, already_existed}, State}
end;
handle_call({unreg, Name}, _From, State = #state{reged = Gateways}) ->
case maps:get(Name, Gateways, undefined) of
undefined ->
@ -119,14 +122,11 @@ handle_call({unreg, Name}, _From, State = #state{reged = Gateways}) ->
_ = emqx_gateway_sup:unload_gateway(Name),
{reply, ok, State#state{reged = maps:remove(Name, Gateways)}}
end;
handle_call(all, _From, State = #state{reged = Gateways}) ->
{reply, maps:to_list(Gateways), State};
handle_call({lookup, Name}, _From, State = #state{reged = Gateways}) ->
Reply = maps:get(Name, Gateways, undefined),
{reply, Reply, State};
handle_call(Req, _From, State) ->
logger:error("Unexpected call: ~0p", [Req]),
{reply, ok, State}.

976
apps/emqx_gateway/src/emqx_gateway_schema.erl
View File

File diff suppressed because it is too large Load Diff

68
apps/emqx_gateway/src/emqx_gateway_sup.erl
View File

@ -23,13 +23,14 @@
-export([start_link/0]).
%% Gateway APIs
-export([ load_gateway/1
, unload_gateway/1
, lookup_gateway/1
, update_gateway/2
, start_gateway_insta/1
, stop_gateway_insta/1
, list_gateway_insta/0
-export([
load_gateway/1,
unload_gateway/1,
lookup_gateway/1,
update_gateway/2,
start_gateway_insta/1,
stop_gateway_insta/1,
list_gateway_insta/0
]).
%% supervisor callbacks
@ -42,23 +43,24 @@
start_link() ->
supervisor:start_link({local, ?MODULE}, ?MODULE, []).
-spec load_gateway(gateway()) -> {ok, pid()} | {error, any()}.
load_gateway(Gateway = #{name := GwName}) ->
case emqx_gateway_registry:lookup(GwName) of
undefined -> {error, {unknown_gateway_name, GwName}};
undefined ->
{error, {unknown_gateway_name, GwName}};
GwDscrptr ->
{ok, GwSup} = ensure_gateway_suptree_ready(GwName),
emqx_gateway_gw_sup:create_insta(GwSup, Gateway, GwDscrptr)
end.
-spec unload_gateway(gateway_name())
-> ok
-spec unload_gateway(gateway_name()) ->
ok
| {error, not_found}
| {error, any()}.
unload_gateway(GwName) ->
case lists:keyfind(GwName, 1, supervisor:which_children(?MODULE)) of
false -> {error, not_found};
false ->
{error, not_found};
{_Id, Pid, _Type, _Mods} ->
_ = emqx_gateway_gw_sup:remove_insta(Pid, GwName),
_ = supervisor:terminate_child(?MODULE, GwName),
@ -75,21 +77,23 @@ lookup_gateway(GwName) ->
undefined
end.
-spec update_gateway(gateway_name(), emqx_config:config())
-> ok
-spec update_gateway(gateway_name(), emqx_config:config()) ->
ok
| {error, any()}.
update_gateway(GwName, Config) ->
case emqx_gateway_utils:find_sup_child(?MODULE, GwName) of
{ok, GwSup} ->
emqx_gateway_gw_sup:update_insta(GwSup, GwName, Config);
_ -> {error, not_found}
_ ->
{error, not_found}
end.
start_gateway_insta(GwName) ->
case search_gateway_insta_proc(GwName) of
{ok, {GwSup, _}} ->
emqx_gateway_gw_sup:start_insta(GwSup, GwName);
_ -> {error, not_found}
_ ->
{error, not_found}
end.
-spec stop_gateway_insta(gateway_name()) -> ok | {error, any()}.
@ -97,15 +101,20 @@ stop_gateway_insta(GwName) ->
case search_gateway_insta_proc(GwName) of
{ok, {GwSup, _}} ->
emqx_gateway_gw_sup:stop_insta(GwSup, GwName);
_ -> {error, not_found}
_ ->
{error, not_found}
end.
-spec list_gateway_insta() -> [gateway()].
list_gateway_insta() ->
lists:append(lists:map(
lists:append(
lists:map(
fun(SupId) ->
emqx_gateway_gw_sup:list_insta(SupId)
end, list_started_gateway())).
end,
list_started_gateway()
)
).
-spec list_started_gateway() -> [gateway_name()].
list_started_gateway() ->
@ -114,12 +123,12 @@ list_started_gateway() ->
%% Supervisor callback
init([]) ->
SupFlags = #{ strategy => one_for_one
, intensity => 10
, period => 60
SupFlags = #{
strategy => one_for_one,
intensity => 10,
period => 60
},
ChildSpecs = [ emqx_gateway_utils:childspec(worker, emqx_gateway_registry)
],
ChildSpecs = [emqx_gateway_utils:childspec(worker, emqx_gateway_registry)],
{ok, {SupFlags, ChildSpecs}}.
%%--------------------------------------------------------------------
@ -150,21 +159,24 @@ search_gateway_insta_proc(_InstaId, []) ->
search_gateway_insta_proc(InstaId, [SupPid | More]) ->
case emqx_gateway_utils:find_sup_child(SupPid, InstaId) of
{ok, InstaPid} -> {ok, {SupPid, InstaPid}};
_ ->
search_gateway_insta_proc(InstaId, More)
_ -> search_gateway_insta_proc(InstaId, More)
end.
started_gateway() ->
lists:filtermap(
fun({Id, _, _, _}) ->
is_a_gateway_id(Id) andalso {true, Id}
end, supervisor:which_children(?MODULE)).
end,
supervisor:which_children(?MODULE)
).
started_gateway_pid() ->
lists:filtermap(
fun({Id, Pid, _, _}) ->
is_a_gateway_id(Id) andalso {true, Pid}
end, supervisor:which_children(?MODULE)).
end,
supervisor:which_children(?MODULE)
).
is_a_gateway_id(Id) ->
Id /= emqx_gateway_registry.

364
apps/emqx_gateway/src/emqx_gateway_utils.erl
View File

@ -20,80 +20,86 @@
-include("emqx_gateway.hrl").
-include_lib("emqx/include/logger.hrl").
-export([ childspec/2
, childspec/3
, childspec/4
, supervisor_ret/1
, find_sup_child/2
-export([
childspec/2,
childspec/3,
childspec/4,
supervisor_ret/1,
find_sup_child/2
]).
-export([ start_listeners/4
, start_listener/4
, stop_listeners/2
, stop_listener/2
-export([
start_listeners/4,
start_listener/4,
stop_listeners/2,
stop_listener/2
]).
-export([ apply/2
, format_listenon/1
, parse_listenon/1
, unix_ts_to_rfc3339/1
, unix_ts_to_rfc3339/2
, listener_id/3
, parse_listener_id/1
, is_running/2
, global_chain/1
, listener_chain/3
-export([
apply/2,
format_listenon/1,
parse_listenon/1,
unix_ts_to_rfc3339/1,
unix_ts_to_rfc3339/2,
listener_id/3,
parse_listener_id/1,
is_running/2,
global_chain/1,
listener_chain/3
]).
-export([ stringfy/1
]).
-export([stringfy/1]).
-export([ normalize_config/1
]).
-export([normalize_config/1]).
%% Common Envs
-export([ active_n/1
, ratelimit/1
, frame_options/1
, init_gc_state/1
, stats_timer/1
, idle_timeout/1
, oom_policy/1
-export([
active_n/1,
ratelimit/1,
frame_options/1,
init_gc_state/1,
stats_timer/1,
idle_timeout/1,
oom_policy/1
]).
-export([ default_tcp_options/0
, default_udp_options/0
, default_subopts/0
-export([
default_tcp_options/0,
default_udp_options/0,
default_subopts/0
]).
-define(ACTIVE_N, 100).
-define(DEFAULT_IDLE_TIMEOUT, 30000).
-define(DEFAULT_GC_OPTS, #{count => 1000, bytes => 1024 * 1024}).
-define(DEFAULT_OOM_POLICY, #{max_heap_size => 4194304,
max_message_queue_len => 32000}).
-define(DEFAULT_OOM_POLICY, #{
max_heap_size => 4194304,
max_message_queue_len => 32000
}).
-elvis([{elvis_style, god_modules, disable}]).
-spec childspec(supervisor:worker(), Mod :: atom())
-> supervisor:child_spec().
-spec childspec(supervisor:worker(), Mod :: atom()) ->
supervisor:child_spec().
childspec(Type, Mod) ->
childspec(Mod, Type, Mod, []).
-spec childspec(supervisor:worker(), Mod :: atom(), Args :: list())
-> supervisor:child_spec().
-spec childspec(supervisor:worker(), Mod :: atom(), Args :: list()) ->
supervisor:child_spec().
childspec(Type, Mod, Args) ->
childspec(Mod, Type, Mod, Args).
-spec childspec(atom(), supervisor:worker(), Mod :: atom(), Args :: list())
-> supervisor:child_spec().
-spec childspec(atom(), supervisor:worker(), Mod :: atom(), Args :: list()) ->
supervisor:child_spec().
childspec(Id, Type, Mod, Args) ->
#{ id => Id
, start => {Mod, start_link, Args}
, type => Type
#{
id => Id,
start => {Mod, start_link, Args},
type => Type
}.
-spec supervisor_ret(supervisor:startchild_ret())
-> {ok, pid()}
-spec supervisor_ret(supervisor:startchild_ret()) ->
{ok, pid()}
| {error, supervisor:startchild_err()}.
supervisor_ret({ok, Pid, _Info}) ->
{ok, Pid};
@ -105,8 +111,8 @@ supervisor_ret({error, {Reason, Child}}) ->
supervisor_ret(Ret) ->
Ret.
-spec find_sup_child(Sup :: pid() | atom(), ChildId :: supervisor:child_id())
-> false
-spec find_sup_child(Sup :: pid() | atom(), ChildId :: supervisor:child_id()) ->
false
| {ok, pid()}.
find_sup_child(Sup, ChildId) ->
case lists:keyfind(ChildId, 1, supervisor:which_children(Sup)) of
@ -115,13 +121,16 @@ find_sup_child(Sup, ChildId) ->
end.
%% @doc start listeners. close all listeners if someone failed
-spec start_listeners(Listeners :: list(),
-spec start_listeners(
Listeners :: list(),
GwName :: atom(),
Ctx :: map(),
ModCfg)
-> {ok, [pid()]}
ModCfg
) ->
{ok, [pid()]}
| {error, term()}
when ModCfg :: #{frame_mod := atom(), chann_mod := atom()}.
when
ModCfg :: #{frame_mod := atom(), chann_mod := atom()}.
start_listeners(Listeners, GwName, Ctx, ModCfg) ->
start_listeners(Listeners, GwName, Ctx, ModCfg, []).
@ -133,47 +142,71 @@ start_listeners([L | Ls], GwName, Ctx, ModCfg, Acc) ->
NAcc = Acc ++ [{listener, {{ListenerId, ListenOn}, Pid}}],
start_listeners(Ls, GwName, Ctx, ModCfg, NAcc);
{error, Reason} ->
lists:foreach(fun({listener, {{ListenerId, ListenOn}, _}}) ->
lists:foreach(
fun({listener, {{ListenerId, ListenOn}, _}}) ->
esockd:close({ListenerId, ListenOn})
end, Acc),
end,
Acc
),
{error, {Reason, L}}
end.
-spec start_listener(GwName :: atom(),
-spec start_listener(
GwName :: atom(),
Ctx :: emqx_gateway_ctx:context(),
Listener :: tuple(),
ModCfg :: map())
-> {ok, {ListenerId :: atom(), esockd:listen_on(), pid()}}
ModCfg :: map()
) ->
{ok, {ListenerId :: atom(), esockd:listen_on(), pid()}}
| {error, term()}.
start_listener(GwName, Ctx,
{Type, LisName, ListenOn, SocketOpts, Cfg}, ModCfg) ->
start_listener(
GwName,
Ctx,
{Type, LisName, ListenOn, SocketOpts, Cfg},
ModCfg
) ->
ListenOnStr = emqx_gateway_utils:format_listenon(ListenOn),
ListenerId = emqx_gateway_utils:listener_id(GwName, Type, LisName),
NCfg = maps:merge(Cfg, ModCfg),
case start_listener(GwName, Ctx, Type,
LisName, ListenOn, SocketOpts, NCfg) of
case
start_listener(
GwName,
Ctx,
Type,
LisName,
ListenOn,
SocketOpts,
NCfg
)
of
{ok, Pid} ->
console_print("Gateway ~ts:~ts:~ts on ~ts started.~n",
[GwName, Type, LisName, ListenOnStr]),
console_print(
"Gateway ~ts:~ts:~ts on ~ts started.~n",
[GwName, Type, LisName, ListenOnStr]
),
{ok, {ListenerId, ListenOn, Pid}};
{error, Reason} ->
?ELOG("Failed to start gateway ~ts:~ts:~ts on ~ts: ~0p~n",
[GwName, Type, LisName, ListenOnStr, Reason]),
?ELOG(
"Failed to start gateway ~ts:~ts:~ts on ~ts: ~0p~n",
[GwName, Type, LisName, ListenOnStr, Reason]
),
emqx_gateway_utils:supervisor_ret({error, Reason})
end.
start_listener(GwName, Ctx, Type, LisName, ListenOn, SocketOpts, Cfg) ->
Name = emqx_gateway_utils:listener_id(GwName, Type, LisName),
NCfg = Cfg#{ ctx => Ctx
, listener => {GwName, Type, LisName}
NCfg = Cfg#{
ctx => Ctx,
listener => {GwName, Type, LisName}
},
NSocketOpts = merge_default(Type, SocketOpts),
MFA = {emqx_gateway_conn, start_link, [NCfg]},
do_start_listener(Type, Name, ListenOn, NSocketOpts, MFA).
merge_default(Udp, Options) ->
{Key, Default} = case Udp of
{Key, Default} =
case Udp of
udp ->
{udp_options, default_udp_options()};
dtls ->
@ -185,15 +218,18 @@ merge_default(Udp, Options) ->
end,
case lists:keytake(Key, 1, Options) of
{value, {Key, TcpOpts}, Options1} ->
[{Key, emqx_misc:merge_opts(Default, TcpOpts)}
| Options1];
[
{Key, emqx_misc:merge_opts(Default, TcpOpts)}
| Options1
];
false ->
[{Key, Default} | Options]
end.
do_start_listener(Type, Name, ListenOn, SocketOpts, MFA)
when Type == tcp;
Type == ssl ->
do_start_listener(Type, Name, ListenOn, SocketOpts, MFA) when
Type == tcp;
Type == ssl
->
esockd:open(Name, ListenOn, SocketOpts, MFA);
do_start_listener(udp, Name, ListenOn, SocketOpts, MFA) ->
esockd:open_udp(Name, ListenOn, SocketOpts, MFA);
@ -210,11 +246,15 @@ stop_listener(GwName, {Type, LisName, ListenOn, SocketOpts, Cfg}) ->
ListenOnStr = emqx_gateway_utils:format_listenon(ListenOn),
case StopRet of
ok ->
console_print("Gateway ~ts:~ts:~ts on ~ts stopped.~n",
[GwName, Type, LisName, ListenOnStr]);
console_print(
"Gateway ~ts:~ts:~ts on ~ts stopped.~n",
[GwName, Type, LisName, ListenOnStr]
);
{error, Reason} ->
?ELOG("Failed to stop gateway ~ts:~ts:~ts on ~ts: ~0p~n",
[GwName, Type, LisName, ListenOnStr, Reason])
?ELOG(
"Failed to stop gateway ~ts:~ts:~ts on ~ts: ~0p~n",
[GwName, Type, LisName, ListenOnStr, Reason]
)
end,
StopRet.
@ -228,17 +268,23 @@ console_print(Fmt, Args) -> ?ULOG(Fmt, Args).
console_print(_Fmt, _Args) -> ok.
-endif.
apply({M, F, A}, A2) when is_atom(M),
apply({M, F, A}, A2) when
is_atom(M),
is_atom(M),
is_list(A),
is_list(A2) ->
is_list(A2)
->
erlang:apply(M, F, A ++ A2);
apply({F, A}, A2) when is_function(F),
apply({F, A}, A2) when
is_function(F),
is_list(A),
is_list(A2) ->
is_list(A2)
->
erlang:apply(F, A ++ A2);
apply(F, A2) when is_function(F),
is_list(A2) ->
apply(F, A2) when
is_function(F),
is_list(A2)
->
erlang:apply(F, A2).
format_listenon(Port) when is_integer(Port) ->
@ -255,21 +301,20 @@ parse_listenon(IpPort) when is_tuple(IpPort) ->
parse_listenon(Str) when is_binary(Str) ->
parse_listenon(binary_to_list(Str));
parse_listenon(Str) when is_list(Str) ->
try list_to_integer(Str)
catch _ : _ ->
try
list_to_integer(Str)
catch
_:_ ->
case emqx_schema:to_ip_port(Str) of
{ok, R} -> R;
{error, _} ->
error({invalid_listenon_name, Str})
{error, _} -> error({invalid_listenon_name, Str})
end
end.
listener_id(GwName, Type, LisName) ->
binary_to_atom(
<<(bin(GwName))/binary, ":",
(bin(Type))/binary, ":",
(bin(LisName))/binary
>>).
<<(bin(GwName))/binary, ":", (bin(Type))/binary, ":", (bin(LisName))/binary>>
).
parse_listener_id(Id) when is_atom(Id) ->
parse_listener_id(atom_to_binary(Id));
@ -286,7 +331,8 @@ is_running(ListenerId, #{<<"bind">> := ListenOn0}) ->
try esockd:listener({ListenerId, ListenOn}) of
Pid when is_pid(Pid) ->
true
catch _:_ ->
catch
_:_ ->
false
end.
@ -315,10 +361,13 @@ unix_ts_to_rfc3339(Keys, Map) when is_list(Keys) ->
lists:foldl(fun(K, Acc) -> unix_ts_to_rfc3339(K, Acc) end, Map, Keys);
unix_ts_to_rfc3339(Key, Map) ->
case maps:get(Key, Map, undefined) of
undefined -> Map;
undefined ->
Map;
Ts ->
Map#{Key =>
emqx_rule_funcs:unix_ts_to_rfc3339(Ts, <<"millisecond">>)}
Map#{
Key =>
emqx_rule_funcs:unix_ts_to_rfc3339(Ts, <<"millisecond">>)
}
end.
unix_ts_to_rfc3339(Ts) ->
@ -330,60 +379,104 @@ stringfy(T) when is_list(T); is_binary(T) ->
stringfy(T) ->
iolist_to_binary(io_lib:format("~0p", [T])).
-spec normalize_config(emqx_config:config())
-> list({ Type :: udp | tcp | ssl | dtls
, Name :: atom()
, ListenOn :: esockd:listen_on()
, SocketOpts :: esockd:option()
, Cfg :: map()
-spec normalize_config(emqx_config:config()) ->
list({
Type :: udp | tcp | ssl | dtls,
Name :: atom(),
ListenOn :: esockd:listen_on(),
SocketOpts :: esockd:option(),
Cfg :: map()
}).
normalize_config(RawConf) ->
LisMap = maps:get(listeners, RawConf, #{}),
Cfg0 = maps:without([listeners], RawConf),
lists:append(maps:fold(fun(Type, Liss, AccIn1) ->
lists:append(
maps:fold(
fun(Type, Liss, AccIn1) ->
Listeners =
maps:fold(fun(Name, Confs, AccIn2) ->
maps:fold(
fun(Name, Confs, AccIn2) ->
ListenOn = maps:get(bind, Confs),
SocketOpts = esockd_opts(Type, Confs),
RemainCfgs = maps:without(
[bind, tcp, ssl, udp, dtls]
++ proplists:get_keys(SocketOpts), Confs),
[bind, tcp, ssl, udp, dtls] ++
proplists:get_keys(SocketOpts),
Confs
),
Cfg = maps:merge(Cfg0, RemainCfgs),
[{Type, Name, ListenOn, SocketOpts, Cfg} | AccIn2]
end, [], Liss),
end,
[],
Liss
),
[Listeners | AccIn1]
end, [], LisMap)).
end,
[],
LisMap
)
).
esockd_opts(Type, Opts0) ->
Opts1 = maps:with([acceptors, max_connections, max_conn_rate,
proxy_protocol, proxy_protocol_timeout], Opts0),
Opts1 = maps:with(
[
acceptors,
max_connections,
max_conn_rate,
proxy_protocol,
proxy_protocol_timeout
],
Opts0
),
Opts2 = Opts1#{access_rules => esockd_access_rules(maps:get(access_rules, Opts0, []))},
maps:to_list(case Type of
tcp -> Opts2#{tcp_options => sock_opts(tcp, Opts0)};
ssl -> Opts2#{tcp_options => sock_opts(tcp, Opts0),
ssl_options => ssl_opts(ssl, Opts0)};
udp -> Opts2#{udp_options => sock_opts(udp, Opts0)};
dtls -> Opts2#{udp_options => sock_opts(udp, Opts0),
dtls_options => ssl_opts(dtls, Opts0)}
end).
maps:to_list(
case Type of
tcp ->
Opts2#{tcp_options => sock_opts(tcp, Opts0)};
ssl ->
Opts2#{
tcp_options => sock_opts(tcp, Opts0),
ssl_options => ssl_opts(ssl, Opts0)
};
udp ->
Opts2#{udp_options => sock_opts(udp, Opts0)};
dtls ->
Opts2#{
udp_options => sock_opts(udp, Opts0),
dtls_options => ssl_opts(dtls, Opts0)
}
end
).
esockd_access_rules(StrRules) ->
Access = fun(S) ->
[A, CIDR] = string:tokens(S, " "),
{list_to_atom(A), case CIDR of "all" -> all; _ -> CIDR end}
{
list_to_atom(A),
case CIDR of
"all" -> all;
_ -> CIDR
end
}
end,
[Access(R) || R <- StrRules].
ssl_opts(Name, Opts) ->
maps:to_list(
emqx_tls_lib:drop_tls13_for_old_otp(
maps:without([enable],
maps:get(Name, Opts, #{})))).
maps:without(
[enable],
maps:get(Name, Opts, #{})
)
)
).
sock_opts(Name, Opts) ->
maps:to_list(
maps:without([active_n],
maps:get(Name, Opts, #{}))).
maps:without(
[active_n],
maps:get(Name, Opts, #{})
)
).
%%--------------------------------------------------------------------
%% Envs
@ -417,7 +510,10 @@ oom_policy(Options) ->
-spec stats_timer(map()) -> undefined | disabled.
stats_timer(Options) ->
case enable_stats(Options) of true -> undefined; false -> disabled end.
case enable_stats(Options) of
true -> undefined;
false -> disabled
end.
-spec enable_stats(map()) -> boolean().
enable_stats(Options) ->
@ -427,16 +523,26 @@ enable_stats(Options) ->
%% Envs2
default_tcp_options() ->
[binary, {packet, raw}, {reuseaddr, true},
{nodelay, true}, {backlog, 512}].
[
binary,
{packet, raw},
{reuseaddr, true},
{nodelay, true},
{backlog, 512}
].
default_udp_options() ->
[binary].
default_subopts() ->
#{rh => 1, %% Retain Handling
rap => 0, %% Retain as Publish
nl => 0, %% No Local
qos => 0, %% QoS
%% Retain Handling
#{
rh => 1,
%% Retain as Publish
rap => 0,
%% No Local
nl => 0,
%% QoS
qos => 0,
is_new => true
}.

427
apps/emqx_gateway/src/exproto/emqx_exproto_channel.erl
View File

@ -21,20 +21,21 @@
-include_lib("emqx/include/types.hrl").
-include_lib("emqx/include/logger.hrl").
-export([ info/1
, info/2
, stats/1
-export([
info/1,
info/2,
stats/1
]).
-export([ init/2
, handle_in/2
, handle_deliver/2
, handle_timeout/3
, handle_call/3
, handle_cast/2
, handle_info/2
, terminate/2
-export([
init/2,
handle_in/2,
handle_deliver/2,
handle_timeout/3,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2
]).
-export_type([channel/0]).
@ -64,15 +65,16 @@
closed_reason = undefined
}).
-opaque(channel() :: #channel{}).
-opaque channel() :: #channel{}.
-type(conn_state() :: idle | connecting | connected | disconnected).
-type conn_state() :: idle | connecting | connected | disconnected.
-type(reply() :: {outgoing, binary()}
-type reply() ::
{outgoing, binary()}
| {outgoing, [binary()]}
| {close, Reason :: atom()}).
| {close, Reason :: atom()}.
-type(replies() :: emqx_types:packet() | reply() | [reply()]).
-type replies() :: emqx_types:packet() | reply() | [reply()].
-define(TIMER_TABLE, #{
alive_timer => keepalive,
@ -99,13 +101,17 @@ info(clientid, #channel{clientinfo = ClientInfo}) ->
maps:get(clientid, ClientInfo, undefined);
info(clientinfo, #channel{clientinfo = ClientInfo}) ->
ClientInfo;
info(session, #channel{subscriptions = Subs,
conninfo = ConnInfo}) ->
#{subscriptions => Subs,
info(session, #channel{
subscriptions = Subs,
conninfo = ConnInfo
}) ->
#{
subscriptions => Subs,
upgrade_qos => false,
retry_interval => 0,
await_rel_timeout => 0,
created_at => maps:get(connected_at, ConnInfo)};
created_at => maps:get(connected_at, ConnInfo)
};
info(conn_state, #channel{conn_state = ConnState}) ->
ConnState;
info(will_msg, _) ->
@ -115,7 +121,8 @@ info(ctx, #channel{ctx = Ctx}) ->
-spec stats(channel()) -> emqx_types:stats().
stats(#channel{subscriptions = Subs}) ->
[{subscriptions_cnt, maps:size(Subs)},
[
{subscriptions_cnt, maps:size(Subs)},
{subscriptions_max, 0},
{inflight_cnt, 0},
{inflight_max, 0},
@ -124,25 +131,31 @@ stats(#channel{subscriptions = Subs}) ->
{mqueue_dropped, 0},
{next_pkt_id, 0},
{awaiting_rel_cnt, 0},
{awaiting_rel_max, 0}].
{awaiting_rel_max, 0}
].
%%--------------------------------------------------------------------
%% Init the channel
%%--------------------------------------------------------------------
-spec init(emqx_exproto_types:conninfo(), map()) -> channel().
init(ConnInfo = #{socktype := Socktype,
init(
ConnInfo = #{
socktype := Socktype,
peername := Peername,
sockname := Sockname,
peercert := Peercert}, Options) ->
peercert := Peercert
},
Options
) ->
Ctx = maps:get(ctx, Options),
GRpcChann = maps:get(handler, Options),
PoolName = maps:get(pool_name, Options),
NConnInfo = default_conninfo(ConnInfo),
ListenerId = case maps:get(listener, Options, undefined) of
ListenerId =
case maps:get(listener, Options, undefined) of
undefined -> undefined;
{GwName, Type, LisName} ->
emqx_gateway_utils:listener_id(GwName, Type, LisName)
{GwName, Type, LisName} -> emqx_gateway_utils:listener_id(GwName, Type, LisName)
end,
ClientInfo = maps:put(listener, ListenerId, default_clientinfo(ConnInfo)),
Channel = #channel{
@ -154,22 +167,33 @@ init(ConnInfo = #{socktype := Socktype,
timers = #{}
},
Req = #{conninfo =>
peercert(Peercert,
#{socktype => socktype(Socktype),
Req = #{
conninfo =>
peercert(
Peercert,
#{
socktype => socktype(Socktype),
peername => address(Peername),
sockname => address(Sockname)})},
sockname => address(Sockname)
}
)
},
try_dispatch(on_socket_created, wrap(Req), Channel).
%% @private
peercert(NoSsl, ConnInfo) when NoSsl == nossl;
NoSsl == undefined ->
peercert(NoSsl, ConnInfo) when
NoSsl == nossl;
NoSsl == undefined
->
ConnInfo;
peercert(Peercert, ConnInfo) ->
Fn = fun(_, V) -> V =/= undefined end,
Infos = maps:filter(Fn,
#{cn => esockd_peercert:common_name(Peercert),
dn => esockd_peercert:subject(Peercert)}
Infos = maps:filter(
Fn,
#{
cn => esockd_peercert:common_name(Peercert),
dn => esockd_peercert:subject(Peercert)
}
),
case maps:size(Infos) of
0 ->
@ -192,27 +216,37 @@ address({Host, Port}) ->
%% Handle incoming packet
%%--------------------------------------------------------------------
-spec handle_in(binary(), channel())
-> {ok, channel()}
-spec handle_in(binary(), channel()) ->
{ok, channel()}
| {shutdown, Reason :: term(), channel()}.
handle_in(Data, Channel) ->
Req = #{bytes => Data},
{ok, try_dispatch(on_received_bytes, wrap(Req), Channel)}.
-spec handle_deliver(list(emqx_types:deliver()), channel())
-> {ok, channel()}
-spec handle_deliver(list(emqx_types:deliver()), channel()) ->
{ok, channel()}
| {shutdown, Reason :: term(), channel()}.
handle_deliver(Delivers, Channel = #channel{ctx = Ctx,
clientinfo = ClientInfo}) ->
handle_deliver(
Delivers,
Channel = #channel{
ctx = Ctx,
clientinfo = ClientInfo
}
) ->
%% XXX: ?? Nack delivers from shared subscriptions
Mountpoint = maps:get(mountpoint, ClientInfo),
NodeStr = atom_to_binary(node(), utf8),
Msgs = lists:map(fun({_, _, Msg}) ->
Msgs = lists:map(
fun({_, _, Msg}) ->
ok = metrics_inc(Ctx, 'messages.delivered'),
Msg1 = emqx_hooks:run_fold('message.delivered',
[ClientInfo], Msg),
Msg1 = emqx_hooks:run_fold(
'message.delivered',
[ClientInfo],
Msg
),
NMsg = emqx_mountpoint:unmount(Mountpoint, Msg1),
#{node => NodeStr,
#{
node => NodeStr,
id => emqx_guid:to_hexstr(emqx_message:id(NMsg)),
qos => emqx_message:qos(NMsg),
from => fmt_from(emqx_message:from(NMsg)),
@ -220,18 +254,26 @@ handle_deliver(Delivers, Channel = #channel{ctx = Ctx,
payload => emqx_message:payload(NMsg),
timestamp => emqx_message:timestamp(NMsg)
}
end, Delivers),
end,
Delivers
),
Req = #{messages => Msgs},
{ok, try_dispatch(on_received_messages, wrap(Req), Channel)}.
-spec handle_timeout(reference(), Msg :: term(), channel())
-> {ok, channel()}
-spec handle_timeout(reference(), Msg :: term(), channel()) ->
{ok, channel()}
| {shutdown, Reason :: term(), channel()}.
handle_timeout(_TRef, {keepalive, _StatVal},
Channel = #channel{keepalive = undefined}) ->
handle_timeout(
_TRef,
{keepalive, _StatVal},
Channel = #channel{keepalive = undefined}
) ->
{ok, Channel};
handle_timeout(_TRef, {keepalive, StatVal},
Channel = #channel{keepalive = Keepalive}) ->
handle_timeout(
_TRef,
{keepalive, StatVal},
Channel = #channel{keepalive = Keepalive}
) ->
case emqx_keepalive:check(StatVal, Keepalive) of
{ok, NKeepalive} ->
NChannel = Channel#channel{keepalive = NKeepalive},
@ -240,97 +282,119 @@ handle_timeout(_TRef, {keepalive, StatVal},
Req = #{type => 'KEEPALIVE'},
{ok, try_dispatch(on_timer_timeout, wrap(Req), Channel)}
end;
handle_timeout(_TRef, force_close, Channel = #channel{closed_reason = Reason}) ->
{shutdown, {error, {force_close, Reason}}, Channel};
handle_timeout(_TRef, Msg, Channel) ->
?SLOG(warning, #{msg => "unexpected_timeout_signal",
signal => Msg}),
?SLOG(warning, #{
msg => "unexpected_timeout_signal",
signal => Msg
}),
{ok, Channel}.
-spec handle_call(Req :: any(), From :: any(), channel())
-> {reply, Reply :: term(), channel()}
-spec handle_call(Req :: any(), From :: any(), channel()) ->
{reply, Reply :: term(), channel()}
| {reply, Reply :: term(), replies(), channel()}
| {shutdown, Reason :: term(), Reply :: term(), channel()}.
handle_call({send, Data}, _From, Channel) ->
{reply, ok, [{outgoing, Data}], Channel};
handle_call(close, _From, Channel = #channel{conn_state = connected}) ->
{reply, ok, [{event, disconnected}, {close, normal}], Channel};
handle_call(close, _From, Channel) ->
{reply, ok, [{close, normal}], Channel};
handle_call({auth, ClientInfo, _Password}, _From,
Channel = #channel{conn_state = connected}) ->
?SLOG(warning, #{ msg => "ingore_duplicated_authorized_command"
, request_clientinfo => ClientInfo
handle_call(
{auth, ClientInfo, _Password},
_From,
Channel = #channel{conn_state = connected}
) ->
?SLOG(warning, #{
msg => "ingore_duplicated_authorized_command",
request_clientinfo => ClientInfo
}),
{reply, {error, ?RESP_PERMISSION_DENY, <<"Duplicated authenticate command">>}, Channel};
handle_call({auth, ClientInfo0, Password}, _From,
handle_call(
{auth, ClientInfo0, Password},
_From,
Channel = #channel{
ctx = Ctx,
conninfo = ConnInfo,
clientinfo = ClientInfo}) ->
clientinfo = ClientInfo
}
) ->
ClientInfo1 = enrich_clientinfo(ClientInfo0, ClientInfo),
ConnInfo1 = enrich_conninfo(ClientInfo0, ConnInfo),
Channel1 = Channel#channel{conninfo = ConnInfo1,
clientinfo = ClientInfo1},
Channel1 = Channel#channel{
conninfo = ConnInfo1,
clientinfo = ClientInfo1
},
#{clientid := ClientId, username := Username} = ClientInfo1,
case emqx_gateway_ctx:authenticate(
Ctx, ClientInfo1#{password => Password}) of
case
emqx_gateway_ctx:authenticate(
Ctx, ClientInfo1#{password => Password}
)
of
{ok, NClientInfo} ->
SessFun = fun(_, _) -> #{} end,
emqx_logger:set_metadata_clientid(ClientId),
case emqx_gateway_ctx:open_session(
case
emqx_gateway_ctx:open_session(
Ctx,
true,
NClientInfo,
ConnInfo1,
SessFun
) of
)
of
{ok, _Session} ->
?SLOG(debug, #{ msg => "client_login_succeed"
, clientid => ClientId
, username => Username
?SLOG(debug, #{
msg => "client_login_succeed",
clientid => ClientId,
username => Username
}),
{reply, ok, [{event, connected}],
ensure_connected(Channel1#channel{clientinfo = NClientInfo})};
{error, Reason} ->
?SLOG(warning, #{ msg => "client_login_failed"
, clientid => ClientId
, username => Username
, reason => Reason
?SLOG(warning, #{
msg => "client_login_failed",
clientid => ClientId,
username => Username,
reason => Reason
}),
{reply, {error, ?RESP_PERMISSION_DENY, Reason}, Channel}
end;
{error, Reason} ->
?SLOG(warning, #{ msg => "client_login_failed"
, clientid => ClientId
, username => Username
, reason => Reason}),
?SLOG(warning, #{
msg => "client_login_failed",
clientid => ClientId,
username => Username,
reason => Reason
}),
{reply, {error, ?RESP_PERMISSION_DENY, Reason}, Channel}
end;
handle_call({start_timer, keepalive, Interval}, _From,
handle_call(
{start_timer, keepalive, Interval},
_From,
Channel = #channel{
conninfo = ConnInfo,
clientinfo = ClientInfo
}) ->
}
) ->
NConnInfo = ConnInfo#{keepalive => Interval},
NClientInfo = ClientInfo#{keepalive => Interval},
NChannel = Channel#channel{conninfo = NConnInfo, clientinfo = NClientInfo},
{reply, ok, ensure_keepalive(NChannel)};
handle_call({subscribe_from_client, TopicFilter, Qos}, _From,
handle_call(
{subscribe_from_client, TopicFilter, Qos},
_From,
Channel = #channel{
ctx = Ctx,
conn_state = connected,
clientinfo = ClientInfo}) ->
clientinfo = ClientInfo
}
) ->
case emqx_gateway_ctx:authorize(Ctx, ClientInfo, subscribe, TopicFilter) of
deny ->
{reply, {error, ?RESP_PERMISSION_DENY, <<"Authorization deny">>}, Channel};
@ -338,31 +402,35 @@ handle_call({subscribe_from_client, TopicFilter, Qos}, _From,
{ok, _, NChannel} = do_subscribe([{TopicFilter, #{qos => Qos}}], Channel),
{reply, ok, NChannel}
end;
handle_call({subscribe, Topic, SubOpts}, _From, Channel) ->
{ok,
[{NTopicFilter, NSubOpts}], NChannel} = do_subscribe([{Topic, SubOpts}], Channel),
{ok, [{NTopicFilter, NSubOpts}], NChannel} = do_subscribe([{Topic, SubOpts}], Channel),
{reply, {ok, {NTopicFilter, NSubOpts}}, NChannel};
handle_call({unsubscribe_from_client, TopicFilter}, _From,
Channel = #channel{conn_state = connected}) ->
handle_call(
{unsubscribe_from_client, TopicFilter},
_From,
Channel = #channel{conn_state = connected}
) ->
{ok, NChannel} = do_unsubscribe([{TopicFilter, #{}}], Channel),
{reply, ok, NChannel};
handle_call({unsubscribe, Topic}, _From, Channel) ->
{ok, NChannel} = do_unsubscribe([Topic], Channel),
{reply, ok, NChannel};
handle_call(subscriptions, _From, Channel = #channel{subscriptions = Subs}) ->
{reply, {ok, maps:to_list(Subs)}, Channel};
handle_call({publish, Topic, Qos, Payload}, _From,
handle_call(
{publish, Topic, Qos, Payload},
_From,
Channel = #channel{
ctx = Ctx,
conn_state = connected,
clientinfo = ClientInfo
= #{clientid := From,
mountpoint := Mountpoint}}) ->
clientinfo =
ClientInfo =
#{
clientid := From,
mountpoint := Mountpoint
}
}
) ->
case emqx_gateway_ctx:authorize(Ctx, ClientInfo, publish, Topic) of
deny ->
{reply, {error, ?RESP_PERMISSION_DENY, <<"Authorization deny">>}, Channel};
@ -372,36 +440,39 @@ handle_call({publish, Topic, Qos, Payload}, _From,
_ = emqx:publish(NMsg),
{reply, ok, Channel}
end;
handle_call(kick, _From, Channel) ->
{shutdown, kicked, ok, ensure_disconnected(kicked, Channel)};
handle_call(discard, _From, Channel) ->
{shutdown, discarded, ok, Channel};
handle_call(Req, _From, Channel) ->
?SLOG(warning, #{ msg => "unexpected_call"
, call => Req
?SLOG(warning, #{
msg => "unexpected_call",
call => Req
}),
{reply, {error, unexpected_call}, Channel}.
-spec handle_cast(any(), channel())
-> {ok, channel()}
-spec handle_cast(any(), channel()) ->
{ok, channel()}
| {ok, replies(), channel()}
| {shutdown, Reason :: term(), channel()}.
handle_cast(Req, Channel) ->
?SLOG(warning, #{ msg => "unexpected_call"
, call => Req
?SLOG(warning, #{
msg => "unexpected_call",
call => Req
}),
{ok, Channel}.
-spec handle_info(any(), channel())
-> {ok, channel()}
-spec handle_info(any(), channel()) ->
{ok, channel()}
| {shutdown, Reason :: term(), channel()}.
handle_info({sock_closed, Reason},
Channel = #channel{rqueue = Queue, inflight = Inflight}) ->
case queue:len(Queue) =:= 0
andalso Inflight =:= undefined of
handle_info(
{sock_closed, Reason},
Channel = #channel{rqueue = Queue, inflight = Inflight}
) ->
case
queue:len(Queue) =:= 0 andalso
Inflight =:= undefined
of
true ->
Channel1 = ensure_disconnected({sock_closed, Reason}, Channel),
{shutdown, Reason, Channel1};
@ -411,24 +482,23 @@ handle_info({sock_closed, Reason},
Channel2 = ensure_timer(force_timer, Channel1),
{ok, ensure_disconnected({sock_closed, Reason}, Channel2)}
end;
handle_info({hreply, on_socket_created, ok}, Channel) ->
dispatch_or_close_process(Channel#channel{inflight = undefined});
handle_info({hreply, FunName, ok}, Channel)
when FunName == on_socket_closed;
handle_info({hreply, FunName, ok}, Channel) when
FunName == on_socket_closed;
FunName == on_received_bytes;
FunName == on_received_messages;
FunName == on_timer_timeout ->
FunName == on_timer_timeout
->
dispatch_or_close_process(Channel#channel{inflight = undefined});
handle_info({hreply, FunName, {error, Reason}}, Channel) ->
{shutdown, {error, {FunName, Reason}}, Channel};
handle_info({subscribe, _}, Channel) ->
{ok, Channel};
handle_info(Info, Channel) ->
?SLOG(warning, #{ msg => "unexpected_info"
, info => Info
?SLOG(warning, #{
msg => "unexpected_info",
info => Info
}),
{ok, Channel}.
@ -446,13 +516,22 @@ do_subscribe(TopicFilters, Channel) ->
fun({TopicFilter, SubOpts}, {MadeSubs, ChannelAcc}) ->
{Sub, Channel1} = do_subscribe(TopicFilter, SubOpts, ChannelAcc),
{MadeSubs ++ [Sub], Channel1}
end, {[], Channel}, parse_topic_filters(TopicFilters)),
end,
{[], Channel},
parse_topic_filters(TopicFilters)
),
{ok, MadeSubs, NChannel}.
%% @private
do_subscribe(TopicFilter, SubOpts, Channel =
#channel{clientinfo = ClientInfo = #{mountpoint := Mountpoint},
subscriptions = Subs}) ->
do_subscribe(
TopicFilter,
SubOpts,
Channel =
#channel{
clientinfo = ClientInfo = #{mountpoint := Mountpoint},
subscriptions = Subs
}
) ->
%% Mountpoint first
NTopicFilter = emqx_mountpoint:mount(Mountpoint, TopicFilter),
NSubOpts = maps:merge(emqx_gateway_utils:default_subopts(), SubOpts),
@ -462,34 +541,49 @@ do_subscribe(TopicFilter, SubOpts, Channel =
case IsNew of
true ->
ok = emqx:subscribe(NTopicFilter, SubId, NSubOpts),
ok = emqx_hooks:run('session.subscribed',
[ClientInfo, NTopicFilter, NSubOpts#{is_new => IsNew}]),
{{NTopicFilter, NSubOpts},
Channel#channel{subscriptions = Subs#{NTopicFilter => NSubOpts}}};
ok = emqx_hooks:run(
'session.subscribed',
[ClientInfo, NTopicFilter, NSubOpts#{is_new => IsNew}]
),
{{NTopicFilter, NSubOpts}, Channel#channel{
subscriptions = Subs#{NTopicFilter => NSubOpts}
}};
_ ->
%% Update subopts
ok = emqx:subscribe(NTopicFilter, SubId, NSubOpts),
{{NTopicFilter, NSubOpts},
Channel#channel{subscriptions = Subs#{NTopicFilter => NSubOpts}}}
{{NTopicFilter, NSubOpts}, Channel#channel{
subscriptions = Subs#{NTopicFilter => NSubOpts}
}}
end.
do_unsubscribe(TopicFilters, Channel) ->
NChannel = lists:foldl(
fun({TopicFilter, SubOpts}, ChannelAcc) ->
do_unsubscribe(TopicFilter, SubOpts, ChannelAcc)
end, Channel, parse_topic_filters(TopicFilters)),
end,
Channel,
parse_topic_filters(TopicFilters)
),
{ok, NChannel}.
%% @private
do_unsubscribe(TopicFilter, UnSubOpts, Channel =
#channel{clientinfo = ClientInfo = #{mountpoint := Mountpoint},
subscriptions = Subs}) ->
do_unsubscribe(
TopicFilter,
UnSubOpts,
Channel =
#channel{
clientinfo = ClientInfo = #{mountpoint := Mountpoint},
subscriptions = Subs
}
) ->
NTopicFilter = emqx_mountpoint:mount(Mountpoint, TopicFilter),
case maps:find(NTopicFilter, Subs) of
{ok, SubOpts} ->
ok = emqx:unsubscribe(NTopicFilter),
ok = emqx_hooks:run('session.unsubscribed',
[ClientInfo, TopicFilter, maps:merge(SubOpts, UnSubOpts)]),
ok = emqx_hooks:run(
'session.unsubscribed',
[ClientInfo, TopicFilter, maps:merge(SubOpts, UnSubOpts)]
),
Channel#channel{subscriptions = maps:remove(NTopicFilter, Subs)};
_ ->
Channel
@ -503,25 +597,32 @@ parse_topic_filters(TopicFilters) ->
%% Ensure & Hooks
%%--------------------------------------------------------------------
ensure_connected(Channel = #channel{
ensure_connected(
Channel = #channel{
ctx = Ctx,
conninfo = ConnInfo,
clientinfo = ClientInfo}) ->
clientinfo = ClientInfo
}
) ->
NConnInfo = ConnInfo#{connected_at => erlang:system_time(millisecond)},
ok = run_hooks(Ctx, 'client.connected', [ClientInfo, NConnInfo]),
Channel#channel{conninfo = NConnInfo,
Channel#channel{
conninfo = NConnInfo,
conn_state = connected
}.
ensure_disconnected(Reason, Channel = #channel{
ensure_disconnected(
Reason,
Channel = #channel{
ctx = Ctx,
conn_state = connected,
conninfo = ConnInfo,
clientinfo = ClientInfo}) ->
clientinfo = ClientInfo
}
) ->
NConnInfo = ConnInfo#{disconnected_at => erlang:system_time(millisecond)},
ok = run_hooks(Ctx, 'client.disconnected', [ClientInfo, Reason, NConnInfo]),
Channel#channel{conninfo = NConnInfo, conn_state = disconnected};
ensure_disconnected(_Reason, Channel = #channel{conninfo = ConnInfo}) ->
NConnInfo = ConnInfo#{disconnected_at => erlang:system_time(millisecond)},
Channel#channel{conninfo = NConnInfo, conn_state = disconnected}.
@ -550,7 +651,8 @@ ensure_timer(Name, Channel = #channel{timers = Timers}) ->
Time = interval(Name, Channel),
case TRef == undefined andalso Time > 0 of
true -> ensure_timer(Name, Time, Channel);
false -> Channel %% Timer disabled or exists
%% Timer disabled or exists
false -> Channel
end.
ensure_timer(Name, Time, Channel = #channel{timers = Timers}) ->
@ -576,10 +678,13 @@ interval(alive_timer, #channel{keepalive = Keepalive}) ->
wrap(Req) ->
Req#{conn => base64:encode(term_to_binary(self()))}.
dispatch_or_close_process(Channel = #channel{
dispatch_or_close_process(
Channel = #channel{
rqueue = Queue,
inflight = undefined,
gcli = GClient}) ->
gcli = GClient
}
) ->
case queue:out(Queue) of
{empty, _} ->
case Channel#channel.conn_state of
@ -613,7 +718,8 @@ enrich_clientinfo(InClientInfo = #{proto_name := ProtoName}, ClientInfo) ->
NClientInfo#{protocol => proto_name_to_protocol(ProtoName)}.
default_conninfo(ConnInfo) ->
ConnInfo#{clean_start => true,
ConnInfo#{
clean_start => true,
clientid => undefined,
username => undefined,
conn_mod => undefined,
@ -624,11 +730,15 @@ default_conninfo(ConnInfo) ->
connected_at => erlang:system_time(millisecond),
keepalive => 0,
receive_maximum => 0,
expiry_interval => 0}.
expiry_interval => 0
}.
default_clientinfo(#{peername := {PeerHost, _},
sockname := {_, SockPort}}) ->
#{zone => default,
default_clientinfo(#{
peername := {PeerHost, _},
sockname := {_, SockPort}
}) ->
#{
zone => default,
protocol => exproto,
peerhost => PeerHost,
sockport => SockPort,
@ -636,7 +746,8 @@ default_clientinfo(#{peername := {PeerHost, _},
username => undefined,
is_bridge => false,
is_superuser => false,
mountpoint => undefined}.
mountpoint => undefined
}.
stringfy(Reason) ->
unicode:characters_to_binary((io_lib:format("~0p", [Reason]))).

16
apps/emqx_gateway/src/exproto/emqx_exproto_frame.erl
View File

@ -20,13 +20,14 @@
-behaviour(emqx_gateway_frame).
-export([ initial_parse_state/1
, serialize_opts/0
, parse/2
, serialize_pkt/2
, format/1
, is_message/1
, type/1
-export([
initial_parse_state/1,
serialize_opts/0,
parse/2,
serialize_pkt/2,
format/1,
is_message/1,
type/1
]).
initial_parse_state(_) ->
@ -47,4 +48,3 @@ format(Data) ->
is_message(_) -> true.
type(_) -> unknown.

73
apps/emqx_gateway/src/exproto/emqx_exproto_gcli.erl
View File

@ -21,19 +21,19 @@
-include_lib("emqx/include/logger.hrl").
%% APIs
-export([async_call/3]).
-export([start_link/2]).
%% gen_server callbacks
-export([ init/1
, handle_call/3
, handle_cast/2
, handle_info/2
, terminate/2
, code_change/3
-export([
init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3
]).
-record(state, {
@ -49,11 +49,18 @@
%%--------------------------------------------------------------------
start_link(Pool, Id) ->
gen_server:start_link({local, emqx_misc:proc_name(?MODULE, Id)},
?MODULE, [Pool, Id], []).
gen_server:start_link(
{local, emqx_misc:proc_name(?MODULE, Id)},
?MODULE,
[Pool, Id],
[]
).
async_call(FunName, Req = #{conn := Conn},
Options = #{pool_name := PoolName}) ->
async_call(
FunName,
Req = #{conn := Conn},
Options = #{pool_name := PoolName}
) ->
cast(pick(PoolName, Conn), {rpc, FunName, Req, Options, self()}).
%%--------------------------------------------------------------------
@ -82,41 +89,48 @@ handle_call(_Request, _From, State) ->
handle_cast({rpc, Fun, Req, Options, From}, State = #state{streams = Streams}) ->
case ensure_stream_opened(Fun, Options, Streams) of
{error, Reason} ->
?SLOG(error, #{ msg => "request_grpc_server_failed"
, function => {?CONN_ADAPTER_MOD, Fun, Options}
, reason => Reason}),
?SLOG(error, #{
msg => "request_grpc_server_failed",
function => {?CONN_ADAPTER_MOD, Fun, Options},
reason => Reason
}),
reply(From, Fun, {error, Reason}),
{noreply, State#state{streams = Streams#{Fun => undefined}}};
{ok, Stream} ->
case catch grpc_client:send(Stream, Req) of
ok ->
?SLOG(debug, #{ msg => "send_grpc_request_succeed"
, function => {?CONN_ADAPTER_MOD, Fun}
, request => Req
?SLOG(debug, #{
msg => "send_grpc_request_succeed",
function => {?CONN_ADAPTER_MOD, Fun},
request => Req
}),
reply(From, Fun, ok),
{noreply, State#state{streams = Streams#{Fun => Stream}}};
{'EXIT', {not_found, _Stk}} ->
%% Not found the stream, reopen it
?SLOG(info, #{ msg => "cannt_find_old_stream_ref"
, function => {?CONN_ADAPTER_MOD, Fun}
?SLOG(info, #{
msg => "cannt_find_old_stream_ref",
function => {?CONN_ADAPTER_MOD, Fun}
}),
handle_cast(
{rpc, Fun, Req, Options, From},
State#state{streams = maps:remove(Fun, Streams)});
State#state{streams = maps:remove(Fun, Streams)}
);
{'EXIT', {timeout, _Stk}} ->
?SLOG(error, #{ msg => "send_grpc_request_timeout"
, function => {?CONN_ADAPTER_MOD, Fun}
, request => Req
?SLOG(error, #{
msg => "send_grpc_request_timeout",
function => {?CONN_ADAPTER_MOD, Fun},
request => Req
}),
reply(From, Fun, {error, timeout}),
{noreply, State#state{streams = Streams#{Fun => Stream}}};
{'EXIT', {Reason1, Stk}} ->
?SLOG(error, #{ msg => "send_grpc_request_failed"
, function => {?CONN_ADAPTER_MOD, Fun}
, request => Req
, error => Reason1
, stacktrace => Stk
?SLOG(error, #{
msg => "send_grpc_request_failed",
function => {?CONN_ADAPTER_MOD, Fun},
request => Req,
error => Reason1,
stacktrace => Stk
}),
reply(From, Fun, {error, Reason1}),
{noreply, State#state{streams = Streams#{Fun => undefined}}}
@ -147,5 +161,6 @@ ensure_stream_opened(Fun, Options, Streams) ->
{ok, Stream} -> {ok, Stream};
{error, Reason} -> {error, Reason}
end;
Stream -> {ok, Stream}
Stream ->
{ok, Stream}
end.

163
apps/emqx_gateway/src/exproto/emqx_exproto_gsvr.erl
View File

@ -27,48 +27,57 @@
-define(DEFAULT_CALL_TIMEOUT, 5000).
%% gRPC server callbacks
-export([ send/2
, close/2
, authenticate/2
, start_timer/2
, publish/2
, subscribe/2
, unsubscribe/2
-export([
send/2,
close/2,
authenticate/2,
start_timer/2,
publish/2,
subscribe/2,
unsubscribe/2
]).
%%--------------------------------------------------------------------
%% gRPC ConnectionAdapter service
%%--------------------------------------------------------------------
-spec send(emqx_exproto_pb:send_bytes_request(), grpc:metadata())
-> {ok, emqx_exproto_pb:code_response(), grpc:metadata()}
-spec send(emqx_exproto_pb:send_bytes_request(), grpc:metadata()) ->
{ok, emqx_exproto_pb:code_response(), grpc:metadata()}
| {error, grpc_cowboy_h:error_response()}.
send(Req = #{conn := Conn, bytes := Bytes}, Md) ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
{ok, response(call(Conn, {send, Bytes})), Md}.
-spec close(emqx_exproto_pb:close_socket_request(), grpc:metadata())
-> {ok, emqx_exproto_pb:code_response(), grpc:metadata()}
-spec close(emqx_exproto_pb:close_socket_request(), grpc:metadata()) ->
{ok, emqx_exproto_pb:code_response(), grpc:metadata()}
| {error, grpc_cowboy_h:error_response()}.
close(Req = #{conn := Conn}, Md) ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
{ok, response(call(Conn, close)), Md}.
-spec authenticate(emqx_exproto_pb:authenticate_request(), grpc:metadata())
-> {ok, emqx_exproto_pb:code_response(), grpc:metadata()}
-spec authenticate(emqx_exproto_pb:authenticate_request(), grpc:metadata()) ->
{ok, emqx_exproto_pb:code_response(), grpc:metadata()}
| {error, grpc_cowboy_h:error_response()}.
authenticate(Req = #{conn := Conn,
authenticate(
Req = #{
conn := Conn,
password := Password,
clientinfo := ClientInfo}, Md) ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
clientinfo := ClientInfo
},
Md
) ->
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
case validate(clientinfo, ClientInfo) of
false ->
@ -77,69 +86,77 @@ authenticate(Req = #{conn := Conn,
{ok, response(call(Conn, {auth, ClientInfo, Password})), Md}
end.
-spec start_timer(emqx_exproto_pb:timer_request(), grpc:metadata())
-> {ok, emqx_exproto_pb:code_response(), grpc:metadata()}
-spec start_timer(emqx_exproto_pb:timer_request(), grpc:metadata()) ->
{ok, emqx_exproto_pb:code_response(), grpc:metadata()}
| {error, grpc_cowboy_h:error_response()}.
start_timer(Req = #{conn := Conn, type := Type, interval := Interval}, Md)
when Type =:= 'KEEPALIVE' andalso Interval > 0 ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
start_timer(Req = #{conn := Conn, type := Type, interval := Interval}, Md) when
Type =:= 'KEEPALIVE' andalso Interval > 0
->
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
{ok, response(call(Conn, {start_timer, keepalive, Interval})), Md};
start_timer(Req, Md) ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
{ok, response({error, ?RESP_PARAMS_TYPE_ERROR}), Md}.
-spec publish(emqx_exproto_pb:publish_request(), grpc:metadata())
-> {ok, emqx_exproto_pb:code_response(), grpc:metadata()}
-spec publish(emqx_exproto_pb:publish_request(), grpc:metadata()) ->
{ok, emqx_exproto_pb:code_response(), grpc:metadata()}
| {error, grpc_cowboy_h:error_response()}.
publish(Req = #{conn := Conn, topic := Topic, qos := Qos, payload := Payload}, Md)
when ?IS_QOS(Qos) ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
publish(Req = #{conn := Conn, topic := Topic, qos := Qos, payload := Payload}, Md) when
?IS_QOS(Qos)
->
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
{ok, response(call(Conn, {publish, Topic, Qos, Payload})), Md};
publish(Req, Md) ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
{ok, response({error, ?RESP_PARAMS_TYPE_ERROR}), Md}.
-spec subscribe(emqx_exproto_pb:subscribe_request(), grpc:metadata())
-> {ok, emqx_exproto_pb:code_response(), grpc:metadata()}
-spec subscribe(emqx_exproto_pb:subscribe_request(), grpc:metadata()) ->
{ok, emqx_exproto_pb:code_response(), grpc:metadata()}
| {error, grpc_cowboy_h:error_response()}.
subscribe(Req = #{conn := Conn, topic := Topic, qos := Qos}, Md)
when ?IS_QOS(Qos) ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
subscribe(Req = #{conn := Conn, topic := Topic, qos := Qos}, Md) when
?IS_QOS(Qos)
->
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
{ok, response(call(Conn, {subscribe_from_client, Topic, Qos})), Md};
subscribe(Req, Md) ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
{ok, response({error, ?RESP_PARAMS_TYPE_ERROR}), Md}.
-spec unsubscribe(emqx_exproto_pb:unsubscribe_request(), grpc:metadata())
-> {ok, emqx_exproto_pb:code_response(), grpc:metadata()}
-spec unsubscribe(emqx_exproto_pb:unsubscribe_request(), grpc:metadata()) ->
{ok, emqx_exproto_pb:code_response(), grpc:metadata()}
| {error, grpc_cowboy_h:error_response()}.
unsubscribe(Req = #{conn := Conn, topic := Topic}, Md) ->
?SLOG(debug, #{ msg => "recv_grpc_function_call"
, function => ?FUNCTION_NAME
, request => Req
?SLOG(debug, #{
msg => "recv_grpc_function_call",
function => ?FUNCTION_NAME,
request => Req
}),
{ok, response(call(Conn, {unsubscribe_from_client, Topic})), Md}.
@ -158,16 +175,16 @@ call(ConnStr, Req) ->
exit:badarg ->
{error, ?RESP_PARAMS_TYPE_ERROR, <<"The conn type error">>};
exit:noproc ->
{error, ?RESP_CONN_PROCESS_NOT_ALIVE,
<<"Connection process is not alive">>};
{error, ?RESP_CONN_PROCESS_NOT_ALIVE, <<"Connection process is not alive">>};
exit:timeout ->
{error, ?RESP_UNKNOWN, <<"Connection is not answered">>};
Class:Reason:Stk ->
?SLOG(error, #{ msg => "call_conn_process_crashed"
, request => Req
, conn_str=> ConnStr
, reason => {Class, Reason}
, stacktrace => Stk
?SLOG(error, #{
msg => "call_conn_process_crashed",
request => Req,
conn_str => ConnStr,
reason => {Class, Reason},
stacktrace => Stk
}),
{error, ?RESP_UNKNOWN, <<"Unknown crashes">>}
end.
@ -184,11 +201,13 @@ validate(clientinfo, M) ->
response(ok) ->
#{code => ?RESP_SUCCESS};
response({error, Code, Reason})
when ?IS_GRPC_RESULT_CODE(Code) ->
response({error, Code, Reason}) when
?IS_GRPC_RESULT_CODE(Code)
->
#{code => Code, message => stringfy(Reason)};
response({error, Code})
when ?IS_GRPC_RESULT_CODE(Code) ->
response({error, Code}) when
?IS_GRPC_RESULT_CODE(Code)
->
#{code => Code};
response(Other) ->
#{code => ?RESP_UNKNOWN, message => stringfy(Other)}.

145
apps/emqx_gateway/src/exproto/emqx_exproto_impl.erl
View File

@ -21,20 +21,25 @@
-include_lib("emqx/include/logger.hrl").
-import(emqx_gateway_utils,
[ normalize_config/1
, start_listeners/4
, stop_listeners/2
]).
-import(
emqx_gateway_utils,
[
normalize_config/1,
start_listeners/4,
stop_listeners/2
]
).
%% APIs
-export([ reg/0
, unreg/0
-export([
reg/0,
unreg/0
]).
-export([ on_gateway_load/2
, on_gateway_update/3
, on_gateway_unload/2
-export([
on_gateway_load/2,
on_gateway_update/3,
on_gateway_unload/2
]).
%%--------------------------------------------------------------------
@ -42,8 +47,7 @@
%%--------------------------------------------------------------------
reg() ->
RegistryOptions = [ {cbkmod, ?MODULE}
],
RegistryOptions = [{cbkmod, ?MODULE}],
emqx_gateway_registry:reg(exproto, RegistryOptions).
unreg() ->
@ -53,11 +57,16 @@ unreg() ->
%% emqx_gateway_registry callbacks
%%--------------------------------------------------------------------
on_gateway_load(_Gateway = #{ name := GwName,
on_gateway_load(
_Gateway = #{
name := GwName,
config := Config
}, Ctx) ->
},
Ctx
) ->
%% XXX: How to monitor it ?
_ = start_grpc_client_channel(GwName,
_ = start_grpc_client_channel(
GwName,
maps:get(handler, Config, undefined)
),
%% XXX: How to monitor it ?
@ -67,8 +76,11 @@ on_gateway_load(_Gateway = #{ name := GwName,
PoolName = pool_name(GwName),
PoolSize = emqx_vm:schedulers() * 2,
{ok, PoolSup} = emqx_pool_sup:start_link(
PoolName, hash, PoolSize,
{emqx_exproto_gcli, start_link, []}),
PoolName,
hash,
PoolSize,
{emqx_exproto_gcli, start_link, []}
),
NConfig = maps:without(
[server, handler],
@ -78,18 +90,25 @@ on_gateway_load(_Gateway = #{ name := GwName,
NConfig#{handler => GwName}
),
ModCfg = #{frame_mod => emqx_exproto_frame,
ModCfg = #{
frame_mod => emqx_exproto_frame,
chann_mod => emqx_exproto_channel
},
case start_listeners(
Listeners, GwName, Ctx, ModCfg) of
case
start_listeners(
Listeners, GwName, Ctx, ModCfg
)
of
{ok, ListenerPids} ->
{ok, ListenerPids, _GwState = #{ctx => Ctx, pool => PoolSup}};
{error, {Reason, Listener}} ->
throw({badconf, #{ key => listeners
, vallue => Listener
, reason => Reason
}})
throw(
{badconf, #{
key => listeners,
vallue => Listener,
reason => Reason
}}
)
end.
on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
@ -101,15 +120,21 @@ on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
on_gateway_load(Gateway#{config => Config}, Ctx)
catch
Class:Reason:Stk ->
logger:error("Failed to update ~ts; "
logger:error(
"Failed to update ~ts; "
"reason: {~0p, ~0p} stacktrace: ~0p",
[GwName, Class, Reason, Stk]),
[GwName, Class, Reason, Stk]
),
{error, Reason}
end.
on_gateway_unload(_Gateway = #{ name := GwName,
on_gateway_unload(
_Gateway = #{
name := GwName,
config := Config
}, _GwState = #{pool := PoolSup}) ->
},
_GwState = #{pool := PoolSup}
) ->
Listeners = emqx_gateway_utils:normalize_config(Config),
%% Stop funcs???
exit(PoolSup, kill),
@ -124,29 +149,42 @@ on_gateway_unload(_Gateway = #{ name := GwName,
start_grpc_server(_GwName, undefined) ->
undefined;
start_grpc_server(GwName, Options = #{bind := ListenOn}) ->
Services = #{protos => [emqx_exproto_pb],
Services = #{
protos => [emqx_exproto_pb],
services => #{
'emqx.exproto.v1.ConnectionAdapter' => emqx_exproto_gsvr}
'emqx.exproto.v1.ConnectionAdapter' => emqx_exproto_gsvr
}
},
SvrOptions = case emqx_map_lib:deep_get([ssl, enable], Options, false) of
false -> [];
SvrOptions =
case emqx_map_lib:deep_get([ssl, enable], Options, false) of
false ->
[];
true ->
[{ssl_options,
[
{ssl_options,
maps:to_list(
maps:without([enable], maps:get(ssl, Options, #{}))
)
}]
)}
]
end,
case grpc:start_server(GwName, ListenOn, Services, SvrOptions) of
{ok, _SvrPid} ->
console_print("Start ~ts gRPC server on ~p successfully.~n",
[GwName, ListenOn]);
console_print(
"Start ~ts gRPC server on ~p successfully.~n",
[GwName, ListenOn]
);
{error, Reason} ->
?ELOG("Failed to start ~ts gRPC server on ~p, reason: ~0p",
[GwName, ListenOn, Reason]),
throw({badconf, #{key => server,
?ELOG(
"Failed to start ~ts gRPC server on ~p, reason: ~0p",
[GwName, ListenOn, Reason]
),
throw(
{badconf, #{
key => server,
value => Options,
reason => illegal_grpc_server_confs}})
reason => illegal_grpc_server_confs
}}
)
end.
stop_grpc_server(GwName) ->
@ -158,13 +196,16 @@ start_grpc_client_channel(_GwName, undefined) ->
start_grpc_client_channel(GwName, Options = #{address := Address}) ->
#{host := Host, port := Port} =
case emqx_http_lib:uri_parse(Address) of
{ok, URIMap0} -> URIMap0;
{ok, URIMap0} ->
URIMap0;
{error, _Reason} ->
throw({badconf, #{key => address,
throw(
{badconf, #{
key => address,
value => Address,
reason => illegal_grpc_address
}})
}}
)
end,
case emqx_map_lib:deep_get([ssl, enable], Options, false) of
false ->
@ -172,9 +213,13 @@ start_grpc_client_channel(GwName, Options = #{address := Address}) ->
grpc_client_sup:create_channel_pool(GwName, SvrAddr, #{});
true ->
SslOpts = maps:to_list(maps:get(ssl, Options, #{})),
ClientOpts = #{gun_opts =>
#{transport => ssl,
transport_opts => SslOpts}},
ClientOpts = #{
gun_opts =>
#{
transport => ssl,
transport_opts => SslOpts
}
},
SvrAddr = compose_http_uri(https, Host, Port),
grpc_client_sup:create_channel_pool(GwName, SvrAddr, ClientOpts)
@ -183,7 +228,9 @@ start_grpc_client_channel(GwName, Options = #{address := Address}) ->
compose_http_uri(Scheme, Host, Port) ->
lists:flatten(
io_lib:format(
"~s://~s:~w", [Scheme, inet:ntoa(Host), Port])).
"~s://~s:~w", [Scheme, inet:ntoa(Host), Port]
)
).
stop_grpc_client_channel(GwName) ->
_ = grpc_client_sup:stop_channel_pool(GwName),

19
apps/emqx_gateway/src/exproto/include/emqx_exproto.hrl
View File

@ -16,8 +16,13 @@
-define(APP, emqx_exproto).
-define(TCP_SOCKOPTS, [binary, {packet, raw}, {reuseaddr, true},
{backlog, 512}, {nodelay, true}]).
-define(TCP_SOCKOPTS, [
binary,
{packet, raw},
{reuseaddr, true},
{backlog, 512},
{nodelay, true}
]).
-define(UDP_SOCKOPTS, []).
@ -30,7 +35,9 @@
-define(RESP_PARAMS_TYPE_ERROR, 'PARAMS_TYPE_ERROR').
-define(RESP_REQUIRED_PARAMS_MISSED, 'REQUIRED_PARAMS_MISSED').
-define(RESP_PERMISSION_DENY, 'PERMISSION_DENY').
-define(IS_GRPC_RESULT_CODE(C), ( C =:= ?RESP_SUCCESS
orelse C =:= ?RESP_CONN_PROCESS_NOT_ALIVE
orelse C =:= ?RESP_REQUIRED_PARAMS_MISSED
orelse C =:= ?RESP_PERMISSION_DENY)).
-define(IS_GRPC_RESULT_CODE(C),
(C =:= ?RESP_SUCCESS orelse
C =:= ?RESP_CONN_PROCESS_NOT_ALIVE orelse
C =:= ?RESP_REQUIRED_PARAMS_MISSED orelse
C =:= ?RESP_PERMISSION_DENY)
).

46
apps/emqx_gateway/src/lwm2m/binary_util.erl
View File

@ -3,27 +3,30 @@
%% copied from https://github.com/arcusfelis/binary2
%% Bytes
-export([ reverse/1
, join/2
, duplicate/2
, suffix/2
, prefix/2
-export([
reverse/1,
join/2,
duplicate/2,
suffix/2,
prefix/2
]).
%% Bits
-export([ union/2
, subtract/2
, intersection/2
, inverse/1
-export([
union/2,
subtract/2,
intersection/2,
inverse/1
]).
%% Trimming
-export([ rtrim/1
, rtrim/2
, ltrim/1
, ltrim/2
, trim/1
, trim/2
-export([
rtrim/1,
rtrim/2,
ltrim/1,
ltrim/2,
trim/1,
trim/2
]).
%% Parsing
@ -35,12 +38,10 @@
%% CoAP
-export([join_path/1]).
trim(B) -> trim(B, 0).
ltrim(B) -> ltrim(B, 0).
rtrim(B) -> rtrim(B, 0).
rtrim(B, X) when is_binary(B), is_integer(X) ->
S = byte_size(B),
do_rtrim(S, B, X);
@ -48,13 +49,11 @@ rtrim(B, [_|_]=Xs) when is_binary(B) ->
S = byte_size(B),
do_mrtrim(S, B, Xs).
ltrim(B, X) when is_binary(B), is_integer(X) ->
do_ltrim(B, X);
ltrim(B, [_ | _] = Xs) when is_binary(B) ->
do_mltrim(B, Xs).
%% @doc The second element is a single integer element or an ordset of elements.
trim(B, X) when is_binary(B), is_integer(X) ->
From = ltrimc(B, X, 0),
@ -109,7 +108,6 @@ do_mrtrim(S, B, Xs) ->
false -> binary_part(B, 0, S)
end.
ltrimc(<<X, B/binary>>, X, C) ->
ltrimc(B, X, C + 1);
ltrimc(_B, _X, C) ->
@ -150,7 +148,6 @@ reverse(Bin) when is_binary(Bin) ->
join([B | Bs], Sep) when is_binary(Sep) ->
iolist_to_binary([B | add_separator(Bs, Sep)]);
join([], _Sep) ->
<<>>.
@ -170,7 +167,6 @@ suffix(B, L) when is_binary(B), is_integer(L), L > 0 ->
S = byte_size(B),
binary:part(B, S - L, L).
union(B1, B2) ->
S = bit_size(B1),
<<V1:S>> = B1,
@ -224,7 +220,5 @@ join_path(PathList) ->
join_path(PathList, <<>>).
join_path([], Result) -> Result;
join_path([<<>> | PathList], Result) ->
join_path(PathList, Result);
join_path([Path | PathList], Result) ->
join_path(PathList, <<Result/binary, "/", Path/binary>>).
join_path([<<>> | PathList], Result) -> join_path(PathList, Result);
join_path([Path | PathList], Result) -> join_path(PathList, <<Result/binary, "/", Path/binary>>).

95
apps/emqx_gateway/src/lwm2m/emqx_lwm2m_api.erl
View File

@ -104,8 +104,11 @@ schema(?PATH("/write")) ->
parameters => [
{clientid, mk(binary(), #{in => path, example => "urn:oma:lwm2m:oma:2"})},
{path, mk(binary(), #{in => query, required => true, example => "/3/0/7"})},
{type, mk(hoconsc:enum(?DATA_TYPE),
#{in => query, required => true, example => 'Integer'})},
{type,
mk(
hoconsc:enum(?DATA_TYPE),
#{in => query, required => true, example => 'Integer'}
)},
{value, mk(binary(), #{in => query, required => true, example => 123})}
],
responses => #{
@ -118,8 +121,11 @@ schema(?PATH("/write")) ->
fields(resource) ->
[
{operations, mk(binary(), #{desc => <<"Resource Operations">>, example => "E"})},
{'dataType', mk(hoconsc:enum(?DATA_TYPE), #{desc => <<"Data Type">>,
example => 'Integer'})},
{'dataType',
mk(hoconsc:enum(?DATA_TYPE), #{
desc => <<"Data Type">>,
example => 'Integer'
})},
{path, mk(binary(), #{desc => <<"Resource Path">>, example => "urn:oma:lwm2m:oma:2"})},
{name, mk(binary(), #{desc => <<"Resource Name">>, example => "lwm2m-test"})}
].
@ -128,8 +134,10 @@ lookup_cmd(get, #{bindings := Bindings, query_string := QS}) ->
ClientId = maps:get(clientid, Bindings),
case emqx_gateway_cm_registry:lookup_channels(lwm2m, ClientId) of
[Channel | _] ->
#{<<"path">> := Path,
<<"action">> := Action} = QS,
#{
<<"path">> := Path,
<<"action">> := Action
} = QS,
{ok, Result} = emqx_lwm2m_channel:lookup_cmd(Channel, Path, Action),
lookup_cmd_return(Result, ClientId, Action, Path);
_ ->
@ -137,26 +145,29 @@ lookup_cmd(get, #{bindings := Bindings, query_string := QS}) ->
end.
lookup_cmd_return(undefined, ClientId, Action, Path) ->
{200,
#{clientid => ClientId,
{200, #{
clientid => ClientId,
action => Action,
code => <<"6.01">>,
codeMsg => <<"reply_not_received">>,
path => Path}};
path => Path
}};
lookup_cmd_return({Code, CodeMsg, Content}, ClientId, Action, Path) ->
{200,
format_cmd_content(Content,
format_cmd_content(
Content,
Action,
#{clientid => ClientId,
#{
clientid => ClientId,
action => Action,
code => Code,
codeMsg => CodeMsg,
path => Path})}.
path => Path
}
)}.
format_cmd_content(undefined, _MsgType, Result) ->
Result;
format_cmd_content(Content, <<"discover">>, Result) ->
[H | Content1] = Content,
{_, [HObjId]} = emqx_lwm2m_session:parse_object_list(H),
@ -166,17 +177,18 @@ format_cmd_content(Content, <<"discover">>, Result) ->
[Content2 | _] ->
{_, ObjL} = emqx_lwm2m_session:parse_object_list(Content2),
ObjL;
[] -> []
[] ->
[]
end,
R = case emqx_lwm2m_xml_object:get_obj_def(binary_to_integer(ObjId), true) of
R =
case emqx_lwm2m_xml_object:get_obj_def(binary_to_integer(ObjId), true) of
{error, _} ->
lists:map(fun(Object) -> #{Object => Object} end, ObjectList);
ObjDefinition ->
lists:map(fun(Obj) -> to_operations(Obj, ObjDefinition) end, ObjectList)
end,
Result#{content => R};
format_cmd_content(Content, _, Result) ->
Result#{content => Content}.
@ -185,15 +197,21 @@ to_operations(Obj, ObjDefinition) ->
ResId = binary_to_integer(RawResId),
Operations =
case emqx_lwm2m_xml_object:get_resource_operations(ResId, ObjDefinition) of
"E" -> #{operations => <<"E">>};
"E" ->
#{operations => <<"E">>};
Oper ->
#{'dataType' =>
list_to_binary(emqx_lwm2m_xml_object:get_resource_type(ResId, ObjDefinition)),
#{
'dataType' =>
list_to_binary(
emqx_lwm2m_xml_object:get_resource_type(ResId, ObjDefinition)
),
operations => list_to_binary(Oper)
}
end,
Operations#{path => Obj,
name => list_to_binary(emqx_lwm2m_xml_object:get_resource_name(ResId, ObjDefinition))}.
Operations#{
path => Obj,
name => list_to_binary(emqx_lwm2m_xml_object:get_resource_name(ResId, ObjDefinition))
}.
path_list(Path) ->
case binary:split(binary_util:trim(Path, $/), [<<$/>>], [global]) of
@ -203,33 +221,40 @@ path_list(Path) ->
[ObjId] -> [ObjId]
end.
observe(post, #{bindings := #{clientid := ClientId},
query_string := #{<<"path">> := Path, <<"enable">> := Enable}}) ->
MsgType = case Enable of
observe(post, #{
bindings := #{clientid := ClientId},
query_string := #{<<"path">> := Path, <<"enable">> := Enable}
}) ->
MsgType =
case Enable of
true -> <<"observe">>;
_ -> <<"cancel-observe">>
end,
Cmd = #{<<"msgType">> => MsgType,
Cmd = #{
<<"msgType">> => MsgType,
<<"data">> => #{<<"path">> => Path}
},
send_cmd(ClientId, Cmd).
read(post, #{bindings := #{clientid := ClientId},
query_string := Qs}) ->
Cmd = #{<<"msgType">> => <<"read">>,
read(post, #{
bindings := #{clientid := ClientId},
query_string := Qs
}) ->
Cmd = #{
<<"msgType">> => <<"read">>,
<<"data">> => Qs
},
send_cmd(ClientId, Cmd).
write(post, #{bindings := #{clientid := ClientId},
query_string := Qs}) ->
Cmd = #{<<"msgType">> => <<"write">>,
write(post, #{
bindings := #{clientid := ClientId},
query_string := Qs
}) ->
Cmd = #{
<<"msgType">> => <<"write">>,
<<"data">> => Qs
},

494
apps/emqx_gateway/src/lwm2m/emqx_lwm2m_channel.erl
View File

@ -21,25 +21,28 @@
-include("src/lwm2m/include/emqx_lwm2m.hrl").
%% API
-export([ info/1
, info/2
, stats/1
, with_context/2
, do_takeover/3
, lookup_cmd/3
, send_cmd/2
-export([
info/1,
info/2,
stats/1,
with_context/2,
do_takeover/3,
lookup_cmd/3,
send_cmd/2
]).
-export([ init/2
, handle_in/2
, handle_deliver/2
, handle_timeout/3
, terminate/2
-export([
init/2,
handle_in/2,
handle_deliver/2,
handle_timeout/3,
terminate/2
]).
-export([ handle_call/3
, handle_cast/2
, handle_info/2
-export([
handle_call/3,
handle_cast/2,
handle_info/2
]).
-record(channel, {
@ -64,7 +67,8 @@
-type conn_state() :: idle | connecting | connected | disconnected.
-type reply() :: {outgoing, coap_message()}
-type reply() ::
{outgoing, coap_message()}
| {outgoing, [coap_message()]}
| {event, conn_state() | updated}
| {close, Reason :: atom()}.
@ -73,10 +77,13 @@
%% TODO:
-define(DEFAULT_OVERRIDE,
#{ clientid => <<"">> %% Generate clientid by default
, username => <<"${Packet.uri_query.ep}">>
, password => <<"">>
}).
%% Generate clientid by default
#{
clientid => <<"">>,
username => <<"${Packet.uri_query.ep}">>,
password => <<"">>
}
).
-define(INFO_KEYS, [conninfo, conn_state, clientinfo, session]).
@ -91,7 +98,6 @@ info(Channel) ->
info(Keys, Channel) when is_list(Keys) ->
[{Key, info(Key, Channel)} || Key <- Keys];
info(conninfo, #channel{conninfo = ConnInfo}) ->
ConnInfo;
info(conn_state, #channel{conn_state = ConnState}) ->
@ -108,38 +114,44 @@ info(ctx, #channel{ctx = Ctx}) ->
stats(_) ->
[].
init(ConnInfo = #{peername := {PeerHost, _},
sockname := {_, SockPort}},
#{ctx := Ctx} = Config) ->
init(
ConnInfo = #{
peername := {PeerHost, _},
sockname := {_, SockPort}
},
#{ctx := Ctx} = Config
) ->
Peercert = maps:get(peercert, ConnInfo, undefined),
Mountpoint = maps:get(mountpoint, Config, undefined),
ListenerId = case maps:get(listener, Config, undefined) of
ListenerId =
case maps:get(listener, Config, undefined) of
undefined -> undefined;
{GwName, Type, LisName} ->
emqx_gateway_utils:listener_id(GwName, Type, LisName)
{GwName, Type, LisName} -> emqx_gateway_utils:listener_id(GwName, Type, LisName)
end,
ClientInfo = set_peercert_infos(
Peercert,
#{ zone => default
, listener => ListenerId
, protocol => lwm2m
, peerhost => PeerHost
, sockport => SockPort
, username => undefined
, clientid => undefined
, is_bridge => false
, is_superuser => false
, mountpoint => Mountpoint
#{
zone => default,
listener => ListenerId,
protocol => lwm2m,
peerhost => PeerHost,
sockport => SockPort,
username => undefined,
clientid => undefined,
is_bridge => false,
is_superuser => false,
mountpoint => Mountpoint
}
),
#channel{ ctx = Ctx
, conninfo = ConnInfo
, clientinfo = ClientInfo
, timers = #{}
, session = emqx_lwm2m_session:new()
, conn_state = idle
, with_context = with_context(Ctx, ClientInfo)
#channel{
ctx = Ctx,
conninfo = ConnInfo,
clientinfo = ClientInfo,
timers = #{},
session = emqx_lwm2m_session:new(),
conn_state = idle,
with_context = with_context(Ctx, ClientInfo)
}.
lookup_cmd(Channel, Path, Action) ->
@ -152,8 +164,8 @@ send_cmd(Channel, Cmd) ->
%% Handle incoming packet
%%--------------------------------------------------------------------
-spec handle_in(coap_message() | {frame_error, any()}, channel())
-> {ok, channel()}
-spec handle_in(coap_message() | {frame_error, any()}, channel()) ->
{ok, channel()}
| {ok, replies(), channel()}
| {shutdown, Reason :: term(), channel()}
| {shutdown, Reason :: term(), replies(), channel()}.
@ -170,18 +182,21 @@ handle_deliver(Delivers, Channel) ->
%%--------------------------------------------------------------------
%% Handle timeout
%%--------------------------------------------------------------------
handle_timeout(_, lifetime, #channel{ctx = Ctx,
handle_timeout(
_,
lifetime,
#channel{
ctx = Ctx,
clientinfo = ClientInfo,
conninfo = ConnInfo} = Channel) ->
conninfo = ConnInfo
} = Channel
) ->
ok = run_hooks(Ctx, 'client.disconnected', [ClientInfo, timeout, ConnInfo]),
{shutdown, timeout, Channel};
handle_timeout(_, {transport, _} = Msg, Channel) ->
call_session(timeout, Msg, Channel);
handle_timeout(_, disconnect, Channel) ->
{shutdown, normal, Channel};
handle_timeout(_, _, Channel) ->
{ok, Channel}.
@ -189,63 +204,78 @@ handle_timeout(_, _, Channel) ->
%% Handle call
%%--------------------------------------------------------------------
handle_call({lookup_cmd, Path, Type}, _From,
Channel = #channel{session = Session}) ->
handle_call(
{lookup_cmd, Path, Type},
_From,
Channel = #channel{session = Session}
) ->
Result = emqx_lwm2m_session:find_cmd_record(Path, Type, Session),
{reply, {ok, Result}, Channel};
handle_call({send_cmd, Cmd}, _From, Channel) ->
{ok, Outs, Channel2} = call_session(send_cmd, Cmd, Channel),
{reply, ok, Outs, Channel2};
handle_call({subscribe, Topic, SubOpts}, _From,
handle_call(
{subscribe, Topic, SubOpts},
_From,
Channel = #channel{
ctx = Ctx,
clientinfo = ClientInfo
= #{clientid := ClientId,
mountpoint := Mountpoint},
session = Session}) ->
clientinfo =
ClientInfo =
#{
clientid := ClientId,
mountpoint := Mountpoint
},
session = Session
}
) ->
NSubOpts = maps:merge(
emqx_gateway_utils:default_subopts(),
SubOpts),
SubOpts
),
MountedTopic = emqx_mountpoint:mount(Mountpoint, Topic),
_ = emqx_broker:subscribe(MountedTopic, ClientId, NSubOpts),
_ = run_hooks(Ctx, 'session.subscribed',
[ClientInfo, MountedTopic, NSubOpts]),
_ = run_hooks(
Ctx,
'session.subscribed',
[ClientInfo, MountedTopic, NSubOpts]
),
%% modify session state
Subs = emqx_lwm2m_session:info(subscriptions, Session),
NSubs = maps:put(MountedTopic, NSubOpts, Subs),
NSession = emqx_lwm2m_session:set_subscriptions(NSubs, Session),
{reply, {ok, {MountedTopic, NSubOpts}}, Channel#channel{session = NSession}};
handle_call({unsubscribe, Topic}, _From,
handle_call(
{unsubscribe, Topic},
_From,
Channel = #channel{
ctx = Ctx,
clientinfo = ClientInfo
= #{mountpoint := Mountpoint},
session = Session}) ->
clientinfo =
ClientInfo =
#{mountpoint := Mountpoint},
session = Session
}
) ->
MountedTopic = emqx_mountpoint:mount(Mountpoint, Topic),
ok = emqx_broker:unsubscribe(MountedTopic),
_ = run_hooks(Ctx, 'session.unsubscribe',
[ClientInfo, MountedTopic, #{}]),
_ = run_hooks(
Ctx,
'session.unsubscribe',
[ClientInfo, MountedTopic, #{}]
),
%% modify session state
Subs = emqx_lwm2m_session:info(subscriptions, Session),
NSubs = maps:remove(MountedTopic, Subs),
NSession = emqx_lwm2m_session:set_subscriptions(NSubs, Session),
{reply, ok, Channel#channel{session = NSession}};
handle_call(subscriptions, _From, Channel = #channel{session = Session}) ->
Subs = maps:to_list(emqx_lwm2m_session:info(subscriptions, Session)),
{reply, {ok, Subs}, Channel};
handle_call(kick, _From, Channel) ->
NChannel = ensure_disconnected(kicked, Channel),
shutdown_and_reply(kicked, ok, NChannel);
handle_call(discard, _From, Channel) ->
shutdown_and_reply(discarded, ok, Channel);
%% TODO: No Session Takeover
%handle_call({takeover, 'begin'}, _From, Channel = #channel{session = Session}) ->
% reply(Session, Channel#channel{takeover = true});
@ -259,8 +289,9 @@ handle_call(discard, _From, Channel) ->
% shutdown_and_reply(takenover, AllPendings, Channel);
handle_call(Req, _From, Channel) ->
?SLOG(error, #{ msg => "unexpected_call"
, call => Req
?SLOG(error, #{
msg => "unexpected_call",
call => Req
}),
{reply, ignored, Channel}.
@ -268,8 +299,9 @@ handle_call(Req, _From, Channel) ->
%% Handle Cast
%%--------------------------------------------------------------------
handle_cast(Req, Channel) ->
?SLOG(error, #{ msg => "unexpected_cast"
, cast => Req
?SLOG(error, #{
msg => "unexpected_cast",
cast => Req
}),
{ok, Channel}.
@ -279,19 +311,21 @@ handle_cast(Req, Channel) ->
handle_info({subscribe, _AutoSubs}, Channel) ->
%% not need handle this message
{ok, Channel};
handle_info(Info, Channel) ->
?SLOG(error, #{ msg => "unexpected_info"
, info => Info
?SLOG(error, #{
msg => "unexpected_info",
info => Info
}),
{ok, Channel}.
%%--------------------------------------------------------------------
%% Terminate
%%--------------------------------------------------------------------
terminate(Reason, #channel{ctx = Ctx,
terminate(Reason, #channel{
ctx = Ctx,
clientinfo = ClientInfo,
session = Session}) ->
session = Session
}) ->
MountedTopic = emqx_lwm2m_session:on_close(Session),
_ = run_hooks(Ctx, 'session.unsubscribe', [ClientInfo, MountedTopic, #{}]),
run_hooks(Ctx, 'session.terminated', [ClientInfo, Reason, Session]).
@ -303,10 +337,13 @@ terminate(Reason, #channel{ctx = Ctx,
%%--------------------------------------------------------------------
%% Ensure connected
ensure_connected(Channel = #channel{
ensure_connected(
Channel = #channel{
ctx = Ctx,
conninfo = ConnInfo,
clientinfo = ClientInfo}) ->
clientinfo = ClientInfo
}
) ->
_ = run_hooks(Ctx, 'client.connack', [ConnInfo, connection_accepted, []]),
NConnInfo = ConnInfo#{connected_at => erlang:system_time(millisecond)},
@ -319,13 +356,20 @@ ensure_connected(Channel = #channel{
%%--------------------------------------------------------------------
%% Ensure disconnected
ensure_disconnected(Reason, Channel = #channel{
ensure_disconnected(
Reason,
Channel = #channel{
ctx = Ctx,
conninfo = ConnInfo,
clientinfo = ClientInfo}) ->
clientinfo = ClientInfo
}
) ->
NConnInfo = ConnInfo#{disconnected_at => erlang:system_time(millisecond)},
ok = run_hooks(Ctx, 'client.disconnected',
[ClientInfo, Reason, NConnInfo]),
ok = run_hooks(
Ctx,
'client.disconnected',
[ClientInfo, Reason, NConnInfo]
),
Channel#channel{conninfo = NConnInfo, conn_state = disconnected}.
shutdown_and_reply(Reason, Reply, Channel) ->
@ -334,13 +378,13 @@ shutdown_and_reply(Reason, Reply, Channel) ->
%shutdown_and_reply(Reason, Reply, OutPkt, Channel) ->
% {shutdown, Reason, Reply, OutPkt, Channel}.
set_peercert_infos(NoSSL, ClientInfo)
when NoSSL =:= nossl;
NoSSL =:= undefined ->
set_peercert_infos(NoSSL, ClientInfo) when
NoSSL =:= nossl;
NoSSL =:= undefined
->
ClientInfo;
set_peercert_infos(Peercert, ClientInfo) ->
{DN, CN} = {esockd_peercert:subject(Peercert),
esockd_peercert:common_name(Peercert)},
{DN, CN} = {esockd_peercert:subject(Peercert), esockd_peercert:common_name(Peercert)},
ClientInfo#{dn => DN, cn => CN}.
make_timer(Name, Time, Msg, Channel = #channel{timers = Timers}) ->
@ -349,7 +393,8 @@ make_timer(Name, Time, Msg, Channel = #channel{timers = Timers}) ->
update_life_timer(#channel{session = Session, timers = Timers} = Channel) ->
LifeTime = emqx_lwm2m_session:info(lifetime, Session),
_ = case maps:get(lifetime, Timers, undefined) of
_ =
case maps:get(lifetime, Timers, undefined) of
undefined -> ok;
Ref -> erlang:cancel_timer(Ref)
end,
@ -365,18 +410,25 @@ do_takeover(_DesireId, Msg, Channel) ->
call_session(handle_out, Reset, Channel).
do_connect(Req, Result, Channel, Iter) ->
case emqx_misc:pipeline(
[ fun check_lwm2m_version/2
, fun enrich_conninfo/2
, fun run_conn_hooks/2
, fun enrich_clientinfo/2
, fun set_log_meta/2
, fun auth_connect/2
case
emqx_misc:pipeline(
[
fun check_lwm2m_version/2,
fun enrich_conninfo/2,
fun run_conn_hooks/2,
fun enrich_clientinfo/2,
fun set_log_meta/2,
fun auth_connect/2
],
Req,
Channel) of
{ok, _Input, #channel{session = Session,
with_context = WithContext} = NChannel} ->
Channel
)
of
{ok, _Input,
#channel{
session = Session,
with_context = WithContext
} = NChannel} ->
case emqx_lwm2m_session:info(reg_info, Session) of
undefined ->
process_connect(ensure_connected(NChannel), Req, Result, Iter);
@ -387,15 +439,20 @@ do_connect(Req, Result, Channel, Iter) ->
{error, ReasonCode, NChannel} ->
ErrMsg = io_lib:format("Login Failed: ~ts", [ReasonCode]),
Payload = erlang:list_to_binary(lists:flatten(ErrMsg)),
iter(Iter,
iter(
Iter,
reply({error, bad_request}, Payload, Req, Result),
NChannel)
NChannel
)
end.
check_lwm2m_version(#coap_message{options = Opts},
#channel{conninfo = ConnInfo} = Channel) ->
check_lwm2m_version(
#coap_message{options = Opts},
#channel{conninfo = ConnInfo} = Channel
) ->
Ver = gets([uri_query, <<"lwm2m">>], Opts),
IsValid = case Ver of
IsValid =
case Ver of
<<"1.0">> ->
true;
<<"1">> ->
@ -405,48 +462,61 @@ check_lwm2m_version(#coap_message{options = Opts},
_ ->
false
end,
if IsValid ->
NConnInfo = ConnInfo#{ connected_at => erlang:system_time(millisecond)
, proto_ver => Ver
if
IsValid ->
NConnInfo = ConnInfo#{
connected_at => erlang:system_time(millisecond),
proto_ver => Ver
},
{ok, Channel#channel{conninfo = NConnInfo}};
true ->
?SLOG(error, #{ msg => "reject_REGISTRE_request"
, reason => {unsupported_version, Ver}
?SLOG(error, #{
msg => "reject_REGISTRE_request",
reason => {unsupported_version, Ver}
}),
{error, "invalid lwm2m version", Channel}
end.
run_conn_hooks(Input, Channel = #channel{ctx = Ctx,
conninfo = ConnInfo}) ->
run_conn_hooks(
Input,
Channel = #channel{
ctx = Ctx,
conninfo = ConnInfo
}
) ->
ConnProps = #{},
case run_hooks(Ctx, 'client.connect', [ConnInfo], ConnProps) of
Error = {error, _Reason} -> Error;
_NConnProps ->
{ok, Input, Channel}
_NConnProps -> {ok, Input, Channel}
end.
enrich_conninfo(#coap_message{options = Options},
enrich_conninfo(
#coap_message{options = Options},
Channel = #channel{
conninfo = ConnInfo}) ->
conninfo = ConnInfo
}
) ->
Query = maps:get(uri_query, Options, #{}),
case Query of
#{<<"ep">> := Epn, <<"lt">> := Lifetime} ->
ClientId = maps:get(<<"device_id">>, Query, Epn),
NConnInfo = ConnInfo#{ clientid => ClientId
, proto_name => <<"LwM2M">>
, proto_ver => <<"1.0.1">>
, clean_start => true
, keepalive => binary_to_integer(Lifetime)
, expiry_interval => 0
NConnInfo = ConnInfo#{
clientid => ClientId,
proto_name => <<"LwM2M">>,
proto_ver => <<"1.0.1">>,
clean_start => true,
keepalive => binary_to_integer(Lifetime),
expiry_interval => 0
},
{ok, Channel#channel{conninfo = NConnInfo}};
_ ->
{error, "invalid queries", Channel}
end.
enrich_clientinfo(#coap_message{options = Options} = Msg,
Channel = #channel{clientinfo = ClientInfo0}) ->
enrich_clientinfo(
#coap_message{options = Options} = Msg,
Channel = #channel{clientinfo = ClientInfo0}
) ->
Query = maps:get(uri_query, Options, #{}),
case Query of
#{<<"ep">> := Epn, <<"lt">> := Lifetime} ->
@ -455,16 +525,19 @@ enrich_clientinfo(#coap_message{options = Options} = Msg,
Password = maps:get(<<"password">>, Query, undefined),
ClientId = maps:get(<<"device_id">>, Query, Epn),
ClientInfo =
ClientInfo0#{endpoint_name => Epn,
ClientInfo0#{
endpoint_name => Epn,
lifetime => binary_to_integer(Lifetime),
username => Username,
password => Password,
clientid => ClientId},
clientid => ClientId
},
{ok, NClientInfo} = fix_mountpoint(Msg, ClientInfo),
{ok, Channel#channel{clientinfo = NClientInfo}};
_ ->
?SLOG(error, #{ msg => "reject_REGISTER_request"
, reason => {wrong_paramters, Query}
?SLOG(error, #{
msg => "reject_REGISTER_request",
reason => {wrong_paramters, Query}
}),
{error, "invalid queries", Channel}
end.
@ -473,18 +546,26 @@ set_log_meta(_Input, #channel{clientinfo = #{clientid := ClientId}}) ->
emqx_logger:set_metadata_clientid(ClientId),
ok.
auth_connect(_Input, Channel = #channel{ctx = Ctx,
clientinfo = ClientInfo}) ->
auth_connect(
_Input,
Channel = #channel{
ctx = Ctx,
clientinfo = ClientInfo
}
) ->
#{clientid := ClientId, username := Username} = ClientInfo,
case emqx_gateway_ctx:authenticate(Ctx, ClientInfo) of
{ok, NClientInfo} ->
{ok, Channel#channel{clientinfo = NClientInfo,
with_context = with_context(Ctx, ClientInfo)}};
{ok, Channel#channel{
clientinfo = NClientInfo,
with_context = with_context(Ctx, ClientInfo)
}};
{error, Reason} ->
?SLOG(warning, #{ msg => "client_login_failed"
, clientid => ClientId
, username => Username
, reason => Reason
?SLOG(warning, #{
msg => "client_login_failed",
clientid => ClientId,
username => Username,
reason => Reason
}),
{error, Reason}
end.
@ -495,22 +576,30 @@ fix_mountpoint(_Packet, ClientInfo = #{mountpoint := Mountpoint}) ->
Mountpoint1 = emqx_mountpoint:replvar(Mountpoint, ClientInfo),
{ok, ClientInfo#{mountpoint := Mountpoint1}}.
process_connect(Channel = #channel{ctx = Ctx,
process_connect(
Channel = #channel{
ctx = Ctx,
session = Session,
conninfo = ConnInfo,
clientinfo = ClientInfo,
with_context = WithContext},
Msg, Result, Iter) ->
with_context = WithContext
},
Msg,
Result,
Iter
) ->
%% inherit the old session
SessFun = fun(_, _) -> #{} end,
case emqx_gateway_ctx:open_session(
case
emqx_gateway_ctx:open_session(
Ctx,
true,
ClientInfo,
ConnInfo,
SessFun,
emqx_lwm2m_session
) of
)
of
{ok, _} ->
Mountpoint = maps:get(mountpoint, ClientInfo, <<>>),
NewResult0 = emqx_lwm2m_session:init(
@ -522,8 +611,9 @@ process_connect(Channel = #channel{ctx = Ctx,
NewResult1 = NewResult0#{events => [{event, connected}]},
iter(Iter, maps:merge(Result, NewResult1), Channel);
{error, Reason} ->
?SLOG(error, #{ msg => "falied_to_open_session"
, reason => Reason
?SLOG(error, #{
msg => "falied_to_open_session",
reason => Reason
}),
iter(Iter, reply({error, bad_request}, Msg, Result), Channel)
end.
@ -557,52 +647,68 @@ with_context(publish, [Topic, Msg], Ctx, ClientInfo) ->
_ = emqx_broker:publish(Msg),
ok;
_ ->
?SLOG(error, #{ msg => "publish_denied"
, topic => Topic
?SLOG(error, #{
msg => "publish_denied",
topic => Topic
}),
{error, deny}
end;
with_context(subscribe, [Topic, Opts], Ctx, ClientInfo) ->
#{clientid := ClientId,
endpoint_name := EndpointName} = ClientInfo,
#{
clientid := ClientId,
endpoint_name := EndpointName
} = ClientInfo,
case emqx_gateway_ctx:authorize(Ctx, ClientInfo, subscribe, Topic) of
allow ->
run_hooks(Ctx, 'session.subscribed', [ClientInfo, Topic, Opts]),
?SLOG(debug, #{ msg => "subscribe_topic_succeed"
, topic => Topic
, clientid => ClientId
, endpoint_name => EndpointName
?SLOG(debug, #{
msg => "subscribe_topic_succeed",
topic => Topic,
clientid => ClientId,
endpoint_name => EndpointName
}),
emqx_broker:subscribe(Topic, ClientId, Opts),
ok;
_ ->
?SLOG(error, #{ msg => "subscribe_denied"
, topic => Topic
?SLOG(error, #{
msg => "subscribe_denied",
topic => Topic
}),
{error, deny}
end;
with_context(metrics, Name, Ctx, _ClientInfo) ->
emqx_gateway_ctx:metrics_inc(Ctx, Name).
%%--------------------------------------------------------------------
%% Call Chain
%%--------------------------------------------------------------------
call_session(Fun,
call_session(
Fun,
Msg,
#channel{session = Session,
with_context = WithContext} = Channel) ->
iter([ session, fun process_session/4
, proto, fun process_protocol/4
, return, fun process_return/4
, lifetime, fun process_lifetime/4
, reply, fun process_reply/4
, out, fun process_out/4
, fun process_nothing/3
#channel{
session = Session,
with_context = WithContext
} = Channel
) ->
iter(
[
session,
fun process_session/4,
proto,
fun process_protocol/4,
return,
fun process_return/4,
lifetime,
fun process_lifetime/4,
reply,
fun process_reply/4,
out,
fun process_out/4,
fun process_nothing/3
],
emqx_lwm2m_session:Fun(Msg, WithContext, Session),
Channel).
Channel
).
process_session(Session, Result, Channel, Iter) ->
iter(Iter, Result, Channel#channel{session = Session}).
@ -610,14 +716,22 @@ process_session(Session, Result, Channel, Iter) ->
process_protocol({request, Msg}, Result, Channel, Iter) ->
#coap_message{method = Method} = Msg,
handle_request_protocol(Method, Msg, Result, Channel, Iter);
process_protocol(Msg, Result,
#channel{with_context = WithContext, session = Session} = Channel, Iter) ->
process_protocol(
Msg,
Result,
#channel{with_context = WithContext, session = Session} = Channel,
Iter
) ->
ProtoResult = emqx_lwm2m_session:handle_protocol_in(Msg, WithContext, Session),
iter(Iter, maps:merge(Result, ProtoResult), Channel).
handle_request_protocol(post, #coap_message{options = Opts} = Msg,
Result, Channel, Iter) ->
handle_request_protocol(
post,
#coap_message{options = Opts} = Msg,
Result,
Channel,
Iter
) ->
case Opts of
#{uri_path := [?REG_PREFIX]} ->
do_connect(Msg, Result, Channel, Iter);
@ -626,9 +740,13 @@ handle_request_protocol(post, #coap_message{options = Opts} = Msg,
_ ->
iter(Iter, reply({error, not_found}, Msg, Result), Channel)
end;
handle_request_protocol(delete, #coap_message{options = Opts} = Msg,
Result, Channel, Iter) ->
handle_request_protocol(
delete,
#coap_message{options = Opts} = Msg,
Result,
Channel,
Iter
) ->
case Opts of
#{uri_path := Location} ->
case check_location(Location, Channel) of
@ -642,8 +760,13 @@ handle_request_protocol(delete, #coap_message{options = Opts} = Msg,
iter(Iter, reply({error, bad_request}, Msg, Result), Channel)
end.
do_update(Location, Msg, Result,
#channel{session = Session, with_context = WithContext} = Channel, Iter) ->
do_update(
Location,
Msg,
Result,
#channel{session = Session, with_context = WithContext} = Channel,
Iter
) ->
case check_location(Location, Channel) of
true ->
NewResult = emqx_lwm2m_session:update(Msg, WithContext, Session),
@ -654,13 +777,16 @@ do_update(Location, Msg, Result,
process_return({Outs, Session}, Result, Channel, Iter) ->
OldOuts = maps:get(out, Result, []),
iter(Iter,
iter(
Iter,
Result#{out => Outs ++ OldOuts},
Channel#channel{session = Session}).
Channel#channel{session = Session}
).
process_out(Outs, Result, Channel, _) ->
Outs2 = lists:reverse(Outs),
Outs3 = case maps:get(reply, Result, undefined) of
Outs3 =
case maps:get(reply, Result, undefined) of
undefined ->
Outs2;
Reply ->

215
apps/emqx_gateway/src/lwm2m/emqx_lwm2m_cmd.erl
View File

@ -20,10 +20,11 @@
-include("src/coap/include/emqx_coap.hrl").
-include("src/lwm2m/include/emqx_lwm2m.hrl").
-export([ mqtt_to_coap/2
, coap_to_mqtt/4
, empty_ack_to_mqtt/1
, coap_failure_to_mqtt/2
-export([
mqtt_to_coap/2,
coap_to_mqtt/4,
empty_ack_to_mqtt/1,
coap_failure_to_mqtt/2
]).
-export([path_list/1, extract_path/1]).
@ -54,26 +55,47 @@ mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"create">>, <<"data"
FullPathList = add_alternate_path_prefix(AlternatePath, PathList),
TlvData = emqx_lwm2m_message:json_to_tlv(PathList, maps:get(<<"content">>, Data)),
Payload = emqx_lwm2m_tlv:encode(TlvData),
CoapRequest = emqx_coap_message:request(con, post, Payload,
[{uri_path, FullPathList},
CoapRequest = emqx_coap_message:request(
con,
post,
Payload,
[
{uri_path, FullPathList},
{uri_query, QueryList},
{content_format, <<"application/vnd.oma.lwm2m+tlv">>}]),
{content_format, <<"application/vnd.oma.lwm2m+tlv">>}
]
),
{CoapRequest, InputCmd};
mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"delete">>, <<"data">> := Data}) ->
{PathList, QueryList} = path_list(maps:get(<<"path">>, Data)),
FullPathList = add_alternate_path_prefix(AlternatePath, PathList),
{emqx_coap_message:request(con, delete, <<>>,
[{uri_path, FullPathList},
{uri_query, QueryList}]), InputCmd};
{
emqx_coap_message:request(
con,
delete,
<<>>,
[
{uri_path, FullPathList},
{uri_query, QueryList}
]
),
InputCmd
};
mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"read">>, <<"data">> := Data}) ->
{PathList, QueryList} = path_list(maps:get(<<"path">>, Data)),
FullPathList = add_alternate_path_prefix(AlternatePath, PathList),
{emqx_coap_message:request(con, get, <<>>,
[{uri_path, FullPathList},
{uri_query, QueryList}]), InputCmd};
{
emqx_coap_message:request(
con,
get,
<<>>,
[
{uri_path, FullPathList},
{uri_query, QueryList}
]
),
InputCmd
};
mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"write">>, <<"data">> := Data}) ->
CoapRequest =
case maps:get(<<"basePath">>, Data, <<"/">>) of
@ -83,7 +105,6 @@ mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"write">>, <<"data">
batch_write_request(AlternatePath, BasePath, maps:get(<<"content">>, Data))
end,
{CoapRequest, InputCmd};
mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"execute">>, <<"data">> := Data}) ->
{PathList, QueryList} = path_list(maps:get(<<"path">>, Data)),
FullPathList = add_alternate_path_prefix(AlternatePath, PathList),
@ -93,85 +114,122 @@ mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"execute">>, <<"data
undefined -> <<>>;
Arg1 -> Arg1
end,
{emqx_coap_message:request(con, post, Args,
[{uri_path, FullPathList},
{
emqx_coap_message:request(
con,
post,
Args,
[
{uri_path, FullPathList},
{uri_query, QueryList},
{content_format, <<"text/plain">>}]), InputCmd};
{content_format, <<"text/plain">>}
]
),
InputCmd
};
mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"discover">>, <<"data">> := Data}) ->
{PathList, QueryList} = path_list(maps:get(<<"path">>, Data)),
FullPathList = add_alternate_path_prefix(AlternatePath, PathList),
{emqx_coap_message:request(con, get, <<>>,
[{uri_path, FullPathList},
{
emqx_coap_message:request(
con,
get,
<<>>,
[
{uri_path, FullPathList},
{uri_query, QueryList},
{'accept', ?LWM2M_FORMAT_LINK}]), InputCmd};
{'accept', ?LWM2M_FORMAT_LINK}
]
),
InputCmd
};
mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"write-attr">>, <<"data">> := Data}) ->
{PathList, QueryList} = path_list(maps:get(<<"path">>, Data)),
FullPathList = add_alternate_path_prefix(AlternatePath, PathList),
Query = attr_query_list(Data),
{emqx_coap_message:request(con, put, <<>>,
[{uri_path, FullPathList},
{
emqx_coap_message:request(
con,
put,
<<>>,
[
{uri_path, FullPathList},
{uri_query, QueryList},
{uri_query, Query}]), InputCmd};
{uri_query, Query}
]
),
InputCmd
};
mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"observe">>, <<"data">> := Data}) ->
{PathList, QueryList} = path_list(maps:get(<<"path">>, Data)),
FullPathList = add_alternate_path_prefix(AlternatePath, PathList),
{emqx_coap_message:request(con, get, <<>>,
[{uri_path, FullPathList},
{
emqx_coap_message:request(
con,
get,
<<>>,
[
{uri_path, FullPathList},
{uri_query, QueryList},
{observe, 0}]), InputCmd};
mqtt_to_coap(AlternatePath, InputCmd = #{<<"msgType">> := <<"cancel-observe">>, <<"data">> := Data}) ->
{observe, 0}
]
),
InputCmd
};
mqtt_to_coap(
AlternatePath, InputCmd = #{<<"msgType">> := <<"cancel-observe">>, <<"data">> := Data}
) ->
{PathList, QueryList} = path_list(maps:get(<<"path">>, Data)),
FullPathList = add_alternate_path_prefix(AlternatePath, PathList),
{emqx_coap_message:request(con, get, <<>>,
[{uri_path, FullPathList},
{
emqx_coap_message:request(
con,
get,
<<>>,
[
{uri_path, FullPathList},
{uri_query, QueryList},
{observe, 1}]), InputCmd}.
{observe, 1}
]
),
InputCmd
}.
coap_to_mqtt(_Method = {_, Code}, _CoapPayload, _Options, Ref = #{<<"msgType">> := <<"create">>}) ->
make_response(Code, Ref);
coap_to_mqtt(_Method = {_, Code}, _CoapPayload, _Options, Ref = #{<<"msgType">> := <<"delete">>}) ->
make_response(Code, Ref);
coap_to_mqtt(Method, CoapPayload, Options, Ref = #{<<"msgType">> := <<"read">>}) ->
read_resp_to_mqtt(Method, CoapPayload, data_format(Options), Ref);
coap_to_mqtt(Method, CoapPayload, _Options, Ref = #{<<"msgType">> := <<"write">>}) ->
write_resp_to_mqtt(Method, CoapPayload, Ref);
coap_to_mqtt(Method, _CoapPayload, _Options, Ref = #{<<"msgType">> := <<"execute">>}) ->
execute_resp_to_mqtt(Method, Ref);
coap_to_mqtt(Method, CoapPayload, _Options, Ref = #{<<"msgType">> := <<"discover">>}) ->
discover_resp_to_mqtt(Method, CoapPayload, Ref);
coap_to_mqtt(Method, CoapPayload, _Options, Ref = #{<<"msgType">> := <<"write-attr">>}) ->
writeattr_resp_to_mqtt(Method, CoapPayload, Ref);
coap_to_mqtt(Method, CoapPayload, Options, Ref = #{<<"msgType">> := <<"observe">>}) ->
observe_resp_to_mqtt(Method, CoapPayload, data_format(Options), observe_seq(Options), Ref);
coap_to_mqtt(Method, CoapPayload, Options, Ref = #{<<"msgType">> := <<"cancel-observe">>}) ->
cancel_observe_resp_to_mqtt(Method, CoapPayload, data_format(Options), Ref).
read_resp_to_mqtt({error, ErrorCode}, _CoapPayload, _Format, Ref) ->
make_response(ErrorCode, Ref);
read_resp_to_mqtt({ok, SuccessCode}, CoapPayload, Format, Ref) ->
try
Result = content_to_mqtt(CoapPayload, Format, Ref),
make_response(SuccessCode, Ref, Format, Result)
catch
error:not_implemented -> make_response(not_implemented, Ref);
error:not_implemented ->
make_response(not_implemented, Ref);
_:Ex:_ST ->
?SLOG(error, #{ msg => "bad_payload_format"
, payload => CoapPayload
, reason => Ex
, stacktrace => _ST}),
?SLOG(error, #{
msg => "bad_payload_format",
payload => CoapPayload,
reason => Ex,
stacktrace => _ST
}),
make_response(bad_request, Ref)
end.
@ -183,59 +241,47 @@ coap_failure_to_mqtt(Ref, MsgType) ->
content_to_mqtt(CoapPayload, <<"text/plain">>, Ref) ->
emqx_lwm2m_message:text_to_json(extract_path(Ref), CoapPayload);
content_to_mqtt(CoapPayload, <<"application/octet-stream">>, Ref) ->
emqx_lwm2m_message:opaque_to_json(extract_path(Ref), CoapPayload);
content_to_mqtt(CoapPayload, <<"application/vnd.oma.lwm2m+tlv">>, Ref) ->
emqx_lwm2m_message:tlv_to_json(extract_path(Ref), CoapPayload);
content_to_mqtt(CoapPayload, <<"application/vnd.oma.lwm2m+json">>, _Ref) ->
emqx_lwm2m_message:translate_json(CoapPayload).
write_resp_to_mqtt({ok, changed}, _CoapPayload, Ref) ->
make_response(changed, Ref);
write_resp_to_mqtt({ok, content}, CoapPayload, Ref) when CoapPayload =:= <<>> ->
make_response(method_not_allowed, Ref);
write_resp_to_mqtt({ok, content}, _CoapPayload, Ref) ->
make_response(changed, Ref);
write_resp_to_mqtt({error, Error}, _CoapPayload, Ref) ->
make_response(Error, Ref).
execute_resp_to_mqtt({ok, changed}, Ref) ->
make_response(changed, Ref);
execute_resp_to_mqtt({error, Error}, Ref) ->
make_response(Error, Ref).
discover_resp_to_mqtt({ok, content}, CoapPayload, Ref) ->
Links = binary:split(CoapPayload, <<",">>, [global]),
make_response(content, Ref, <<"application/link-format">>, Links);
discover_resp_to_mqtt({error, Error}, _CoapPayload, Ref) ->
make_response(Error, Ref).
writeattr_resp_to_mqtt({ok, changed}, _CoapPayload, Ref) ->
make_response(changed, Ref);
writeattr_resp_to_mqtt({error, Error}, _CoapPayload, Ref) ->
make_response(Error, Ref).
observe_resp_to_mqtt({error, Error}, _CoapPayload, _Format, _ObserveSeqNum, Ref) ->
make_response(Error, Ref);
observe_resp_to_mqtt({ok, content}, CoapPayload, Format, 0, Ref) ->
read_resp_to_mqtt({ok, content}, CoapPayload, Format, Ref);
observe_resp_to_mqtt({ok, content}, CoapPayload, Format, ObserveSeqNum, Ref) ->
read_resp_to_mqtt({ok, content}, CoapPayload, Format, Ref#{<<"seqNum">> => ObserveSeqNum}).
cancel_observe_resp_to_mqtt({ok, content}, CoapPayload, Format, Ref) ->
read_resp_to_mqtt({ok, content}, CoapPayload, Format, Ref);
cancel_observe_resp_to_mqtt({error, Error}, _CoapPayload, _Format, Ref) ->
make_response(Error, Ref).
@ -304,8 +350,7 @@ path_list(Path) ->
query_list(PathWithQuery) ->
case binary:split(PathWithQuery, [<<$?>>], []) of
[Path] -> {Path, []};
[Path, Querys] ->
{Path, binary:split(Querys, [<<$&>>], [global])}
[Path, Querys] -> {Path, binary:split(Querys, [<<$&>>], [global])}
end.
attr_query_list(Data) ->
@ -314,7 +359,8 @@ attr_query_list(Data) ->
attr_query_list(QueryJson = #{}, ValidAttrKeys, QueryList) ->
maps:fold(
fun
(_K, null, Acc) -> Acc;
(_K, null, Acc) ->
Acc;
(K, V, Acc) ->
case lists:member(K, ValidAttrKeys) of
true ->
@ -323,7 +369,10 @@ attr_query_list(QueryJson = #{}, ValidAttrKeys, QueryList) ->
false ->
Acc
end
end, QueryList, QueryJson).
end,
QueryList,
QueryJson
).
valid_attr_keys() ->
[<<"pmin">>, <<"pmax">>, <<"gt">>, <<"lt">>, <<"st">>].
@ -336,7 +385,6 @@ observe_seq(Options) ->
add_alternate_path_prefix(<<"/">>, PathList) ->
PathList;
add_alternate_path_prefix(AlternatePath, PathList) ->
[binary_util:trim(AlternatePath, $/) | PathList].
@ -350,22 +398,29 @@ extract_path(Ref = #{}) ->
end;
#{<<"path">> := Path} ->
Path
end).
end
).
batch_write_request(AlternatePath, BasePath, Content) ->
{PathList, QueryList} = path_list(BasePath),
Method = case length(PathList) of
Method =
case length(PathList) of
2 -> post;
3 -> put
end,
FullPathList = add_alternate_path_prefix(AlternatePath, PathList),
TlvData = emqx_lwm2m_message:json_to_tlv(PathList, Content),
Payload = emqx_lwm2m_tlv:encode(TlvData),
emqx_coap_message:request(con, Method, Payload,
[{uri_path, FullPathList},
emqx_coap_message:request(
con,
Method,
Payload,
[
{uri_path, FullPathList},
{uri_query, QueryList},
{content_format, <<"application/vnd.oma.lwm2m+tlv">>}]).
{content_format, <<"application/vnd.oma.lwm2m+tlv">>}
]
).
single_write_request(AlternatePath, Data) ->
{PathList, QueryList} = path_list(maps:get(<<"path">>, Data)),
@ -373,10 +428,16 @@ single_write_request(AlternatePath, Data) ->
%% TO DO: handle write to resource instance, e.g. /4/0/1/0
TlvData = emqx_lwm2m_message:json_to_tlv(PathList, [Data]),
Payload = emqx_lwm2m_tlv:encode(TlvData),
emqx_coap_message:request(con, put, Payload,
[{uri_path, FullPathList},
emqx_coap_message:request(
con,
put,
Payload,
[
{uri_path, FullPathList},
{uri_query, QueryList},
{content_format, <<"application/vnd.oma.lwm2m+tlv">>}]).
{content_format, <<"application/vnd.oma.lwm2m+tlv">>}
]
).
drop_query(Path) ->
case binary:split(Path, [<<$?>>]) of

76
apps/emqx_gateway/src/lwm2m/emqx_lwm2m_impl.erl
View File

@ -22,13 +22,15 @@
-include_lib("emqx/include/logger.hrl").
%% APIs
-export([ reg/0
, unreg/0
-export([
reg/0,
unreg/0
]).
-export([ on_gateway_load/2
, on_gateway_update/3
, on_gateway_unload/2
-export([
on_gateway_load/2,
on_gateway_update/3,
on_gateway_unload/2
]).
%%--------------------------------------------------------------------
@ -36,8 +38,7 @@
%%--------------------------------------------------------------------
reg() ->
RegistryOptions = [ {cbkmod, ?MODULE}
],
RegistryOptions = [{cbkmod, ?MODULE}],
emqx_gateway_registry:reg(lwm2m, RegistryOptions).
unreg() ->
@ -47,32 +48,46 @@ unreg() ->
%% emqx_gateway_registry callbacks
%%--------------------------------------------------------------------
on_gateway_load(_Gateway = #{ name := GwName,
on_gateway_load(
_Gateway = #{
name := GwName,
config := Config
}, Ctx) ->
},
Ctx
) ->
XmlDir = maps:get(xml_dir, Config),
case emqx_lwm2m_xml_object_db:start_link(XmlDir) of
{ok, RegPid} ->
Listeners = emqx_gateway_utils:normalize_config(Config),
ModCfg = #{frame_mod => emqx_coap_frame,
ModCfg = #{
frame_mod => emqx_coap_frame,
chann_mod => emqx_lwm2m_channel
},
case emqx_gateway_utils:start_listeners(
Listeners, GwName, Ctx, ModCfg) of
case
emqx_gateway_utils:start_listeners(
Listeners, GwName, Ctx, ModCfg
)
of
{ok, ListenerPids} ->
{ok, ListenerPids, #{ctx => Ctx, registry => RegPid}};
{error, {Reason, Listener}} ->
_ = emqx_lwm2m_xml_object_db:stop(),
throw({badconf, #{ key => listeners
, vallue => Listener
, reason => Reason
}})
throw(
{badconf, #{
key => listeners,
vallue => Listener,
reason => Reason
}}
)
end;
{error, Reason} ->
throw({badconf, #{ key => xml_dir
, value => XmlDir
, reason => Reason
}})
throw(
{badconf, #{
key => xml_dir,
value => XmlDir,
reason => Reason
}}
)
end.
on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
@ -84,15 +99,26 @@ on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
on_gateway_load(Gateway#{config => Config}, Ctx)
catch
Class:Reason:Stk ->
logger:error("Failed to update ~ts; "
logger:error(
"Failed to update ~ts; "
"reason: {~0p, ~0p} stacktrace: ~0p",
[GwName, Class, Reason, Stk]),
[GwName, Class, Reason, Stk]
),
{error, Reason}
end.
on_gateway_unload(_Gateway = #{ name := GwName,
on_gateway_unload(
_Gateway = #{
name := GwName,
config := Config
}, _GwState = #{registry := _RegPid}) ->
_ = try emqx_lwm2m_xml_object_db:stop() catch _ : _ -> ok end,
},
_GwState = #{registry := _RegPid}
) ->
_ =
try
emqx_lwm2m_xml_object_db:stop()
catch
_:_ -> ok
end,
Listeners = emqx_gateway_utils:normalize_config(Config),
emqx_gateway_utils:stop_listeners(GwName, Listeners).

98
apps/emqx_gateway/src/lwm2m/emqx_lwm2m_message.erl
View File

@ -16,11 +16,12 @@
-module(emqx_lwm2m_message).
-export([ tlv_to_json/2
, json_to_tlv/2
, text_to_json/2
, opaque_to_json/2
, translate_json/1
-export([
tlv_to_json/2,
json_to_tlv/2,
text_to_json/2,
opaque_to_json/2,
translate_json/1
]).
-include("src/lwm2m/include/emqx_lwm2m.hrl").
@ -46,7 +47,6 @@ tlv_to_json(BaseName, TlvData) ->
tlv_level1(integer_to_binary(ObjectId), List3, ObjDefinition, [])
end.
tlv_level1(_Path, [], _ObjDefinition, Acc) ->
Acc;
tlv_level1(Path, [#{tlv_object_instance := Id, value := Value} | T], ObjDefinition, Acc) ->
@ -55,22 +55,41 @@ tlv_level1(Path, [#{tlv_object_instance:=Id, value:=Value}|T], ObjDefinition, Ac
tlv_level2(_, [], _, Acc) ->
Acc;
tlv_level2(RelativePath, [#{tlv_resource_with_value:=ResourceId, value:=Value}|T], ObjDefinition, Acc) ->
tlv_level2(
RelativePath, [#{tlv_resource_with_value := ResourceId, value := Value} | T], ObjDefinition, Acc
) ->
Val = value(Value, ResourceId, ObjDefinition),
New = #{path => make_path(RelativePath, ResourceId),
value=>Val},
New = #{
path => make_path(RelativePath, ResourceId),
value => Val
},
tlv_level2(RelativePath, T, ObjDefinition, Acc ++ [New]);
tlv_level2(RelativePath, [#{tlv_multiple_resource:=ResourceId, value:=Value}|T], ObjDefinition, Acc) ->
SubList = tlv_level3(make_path(RelativePath, ResourceId),
Value, ResourceId, ObjDefinition, []),
tlv_level2(
RelativePath, [#{tlv_multiple_resource := ResourceId, value := Value} | T], ObjDefinition, Acc
) ->
SubList = tlv_level3(
make_path(RelativePath, ResourceId),
Value,
ResourceId,
ObjDefinition,
[]
),
tlv_level2(RelativePath, T, ObjDefinition, Acc ++ SubList).
tlv_level3(_RelativePath, [], _Id, _ObjDefinition, Acc) ->
lists:reverse(Acc);
tlv_level3(RelativePath, [#{tlv_resource_instance:=InsId, value:=Value}|T], ResourceId, ObjDefinition, Acc) ->
tlv_level3(
RelativePath,
[#{tlv_resource_instance := InsId, value := Value} | T],
ResourceId,
ObjDefinition,
Acc
) ->
Val = value(Value, ResourceId, ObjDefinition),
New = #{path => make_path(RelativePath, InsId),
value=>Val},
New = #{
path => make_path(RelativePath, InsId),
value => Val
},
tlv_level3(RelativePath, T, ResourceId, ObjDefinition, [New | Acc]).
tlv_single_resource(BaseName, Id, Value, ObjDefinition) ->
@ -79,9 +98,19 @@ tlv_single_resource(BaseName, Id, Value, ObjDefinition) ->
basename(OldBaseName, _ObjectId, ObjectInstanceId, ResourceId, 3) ->
case binary:split(binary_util:trim(OldBaseName, $/), [<<$/>>], [global]) of
[ObjId, ObjInsId, ResId] -> <<$/, ObjId/binary, $/, ObjInsId/binary, $/, ResId/binary>>;
[ObjId, ObjInsId] -> <<$/, ObjId/binary, $/, ObjInsId/binary, $/, (integer_to_binary(ResourceId))/binary>>;
[ObjId] -> <<$/, ObjId/binary, $/, (integer_to_binary(ObjectInstanceId))/binary, $/, (integer_to_binary(ResourceId))/binary>>
[ObjId, ObjInsId, ResId] ->
<<$/, ObjId/binary, $/, ObjInsId/binary, $/, ResId/binary>>;
[ObjId, ObjInsId] ->
<<$/, ObjId/binary, $/, ObjInsId/binary, $/, (integer_to_binary(ResourceId))/binary>>;
[ObjId] ->
<<
$/,
ObjId/binary,
$/,
(integer_to_binary(ObjectInstanceId))/binary,
$/,
(integer_to_binary(ResourceId))/binary
>>
end;
basename(OldBaseName, _ObjectId, ObjectInstanceId, _ResourceId, 2) ->
case binary:split(binary_util:trim(OldBaseName, $/), [<<$/>>], [global]) of
@ -109,8 +138,10 @@ object_id(BaseName) ->
object_resource_id(BaseName) ->
case binary:split(binary_util:trim(BaseName, $/), [<<$/>>], [global]) of
[_ObjIdBin1] -> error({invalid_basename, BaseName});
[_ObjIdBin2, _] -> error({invalid_basename, BaseName});
[_ObjIdBin1] ->
error({invalid_basename, BaseName});
[_ObjIdBin2, _] ->
error({invalid_basename, BaseName});
[ObjIdBin3, _, ResourceId3] ->
{binary_to_integer(ObjIdBin3), binary_to_integer(ResourceId3)};
[ObjIdBin3, _, ResourceId3, _] ->
@ -121,7 +152,8 @@ object_resource_id(BaseName) ->
value(Value, ResourceId, ObjDefinition) ->
case emqx_lwm2m_xml_object:get_resource_type(ResourceId, ObjDefinition) of
"String" ->
Value; % keep binary type since it is same as a string for jsx
% keep binary type since it is same as a string for jsx
Value;
"Integer" ->
Size = byte_size(Value) * 8,
<<IntResult:Size/signed>> = Value,
@ -131,7 +163,8 @@ value(Value, ResourceId, ObjDefinition) ->
<<FloatResult:Size/float>> = Value,
FloatResult;
"Boolean" ->
B = case Value of
B =
case Value of
<<0>> -> false;
<<1>> -> true
end,
@ -149,8 +182,12 @@ value(Value, ResourceId, ObjDefinition) ->
json_to_tlv([_ObjectId, _ObjectInstanceId, ResourceId], ResourceArray) ->
case length(ResourceArray) of
1 -> element_single_resource(integer(ResourceId), ResourceArray);
_ -> element_loop_level4(ResourceArray, [#{tlv_multiple_resource=>integer(ResourceId), value=>[]}])
1 ->
element_single_resource(integer(ResourceId), ResourceArray);
_ ->
element_loop_level4(ResourceArray, [
#{tlv_multiple_resource => integer(ResourceId), value => []}
])
end;
json_to_tlv([_ObjectId, _ObjectInstanceId], ResourceArray) ->
element_loop_level3(ResourceArray, []);
@ -191,7 +228,6 @@ insert(Level, #{<<"path">> := EleName, <<"type">> := Type, <<"value">> := Value}
% json text to TLV binary
value_ex(K, Value) when K =:= <<"Integer">>; K =:= <<"Float">>; K =:= <<"Time">> ->
encode_number(Value);
value_ex(K, Value) when K =:= <<"String">> ->
Value;
value_ex(K, Value) when K =:= <<"Opaque">> ->
@ -201,7 +237,6 @@ value_ex(K, Value) when K =:= <<"Opaque">> ->
base64:decode(Value);
value_ex(K, <<"true">>) when K =:= <<"Boolean">> -> <<1>>;
value_ex(K, <<"false">>) when K =:= <<"Boolean">> -> <<0>>;
value_ex(K, Value) when K =:= <<"Objlnk">>; K =:= ov ->
[P1, P2] = binary:split(Value, [<<$:>>], [global]),
<<(binary_to_integer(P1)):16, (binary_to_integer(P2)):16>>.
@ -247,7 +282,6 @@ insert_resource_instance_into_resource(ResourceInstanceId, Value, Acc) ->
Acc2 ++ [NewMap]
end.
find_obj_instance(_ObjectInstanceId, []) ->
undefined;
find_obj_instance(ObjectInstanceId, [H = #{tlv_object_instance := ObjectInstanceId} | _T]) ->
@ -298,7 +332,8 @@ text_value(Text, ResourceId, ObjDefinition) ->
"Float" ->
binary_to_number(Text);
"Boolean" ->
B = case Text of
B =
case Text of
<<"true">> -> false;
<<"false">> -> true
end,
@ -327,9 +362,12 @@ translate_element(BaseName, [Element | ElementList], Acc) ->
RelativePath = maps:get(<<"n">>, Element, <<>>),
FullPath = full_path(BaseName, RelativePath),
NewAcc = [
#{path => FullPath,
#{
path => FullPath,
value => get_element_value(Element)
} | Acc],
}
| Acc
],
translate_element(BaseName, ElementList, NewAcc).
full_path(BaseName, RelativePath) ->

397
apps/emqx_gateway/src/lwm2m/emqx_lwm2m_session.erl
View File

@ -22,26 +22,35 @@
-include("src/lwm2m/include/emqx_lwm2m.hrl").
%% API
-export([ new/0, init/4, update/3, parse_object_list/1
, reregister/3, on_close/1, find_cmd_record/3]).
-export([
new/0,
init/4,
update/3,
parse_object_list/1,
reregister/3,
on_close/1,
find_cmd_record/3
]).
%% Info & Stats
-export([ info/1
, info/2
, stats/1
, stats/2
-export([
info/1,
info/2,
stats/1,
stats/2
]).
-export([ handle_coap_in/3
, handle_protocol_in/3
, handle_deliver/3
, timeout/3
, send_cmd/3
, set_reply/2]).
-export([
handle_coap_in/3,
handle_protocol_in/3,
handle_deliver/3,
timeout/3,
send_cmd/3,
set_reply/2
]).
%% froce update subscriptions
-export([ set_subscriptions/2
]).
-export([set_subscriptions/2]).
-export_type([session/0]).
@ -57,30 +66,42 @@
-type cmd_code_msg() :: binary().
-type cmd_code_content() :: list(map()).
-type cmd_result() :: undefined | {cmd_code(), cmd_code_msg(), cmd_code_content()}.
-type cmd_record() :: #{cmd_record_key() => cmd_result(),
queue := queue:queue()}.
-type cmd_record() :: #{
cmd_record_key() => cmd_result(),
queue := queue:queue()
}.
-record(session, { coap :: emqx_coap_tm:manager()
, queue :: queue:queue(queued_request())
, wait_ack :: request_context() | undefined
, endpoint_name :: binary() | undefined
, location_path :: list(binary()) | undefined
, reg_info :: map() | undefined
, lifetime :: non_neg_integer() | undefined
, is_cache_mode :: boolean()
, mountpoint :: binary()
, last_active_at :: non_neg_integer()
, created_at :: non_neg_integer()
, cmd_record :: cmd_record()
, subscriptions :: map()
-record(session, {
coap :: emqx_coap_tm:manager(),
queue :: queue:queue(queued_request()),
wait_ack :: request_context() | undefined,
endpoint_name :: binary() | undefined,
location_path :: list(binary()) | undefined,
reg_info :: map() | undefined,
lifetime :: non_neg_integer() | undefined,
is_cache_mode :: boolean(),
mountpoint :: binary(),
last_active_at :: non_neg_integer(),
created_at :: non_neg_integer(),
cmd_record :: cmd_record(),
subscriptions :: map()
}).
-type session() :: #session{}.
-define(PREFIX, <<"rd">>).
-define(NOW, erlang:system_time(second)).
-define(IGNORE_OBJECT, [<<"0">>, <<"1">>, <<"2">>, <<"4">>, <<"5">>, <<"6">>,
<<"7">>, <<"9">>, <<"15">>]).
-define(IGNORE_OBJECT, [
<<"0">>,
<<"1">>,
<<"2">>,
<<"4">>,
<<"5">>,
<<"6">>,
<<"7">>,
<<"9">>,
<<"15">>
]).
-define(CMD_KEY(Path, Type), {Path, Type}).
-define(MAX_RECORD_SIZE, 100).
@ -90,7 +111,8 @@
-define(lwm2m_up_dm_topic, {<<"/v1/up/dm">>, 0}).
%% steal from emqx_session
-define(INFO_KEYS, [id,
-define(INFO_KEYS, [
id,
is_persistent,
subscriptions,
upgrade_qos,
@ -99,7 +121,8 @@
created_at
]).
-define(STATS_KEYS, [subscriptions_cnt,
-define(STATS_KEYS, [
subscriptions_cnt,
subscriptions_max,
inflight_cnt,
inflight_max,
@ -121,33 +144,43 @@
%%--------------------------------------------------------------------
-spec new() -> session().
new() ->
#session{ coap = emqx_coap_tm:new()
, queue = queue:new()
, last_active_at = ?NOW
, created_at = erlang:system_time(millisecond)
, is_cache_mode = false
, mountpoint = <<>>
, cmd_record = #{queue => queue:new()}
, lifetime = emqx:get_config([gateway, lwm2m, lifetime_max])
, subscriptions = #{}
#session{
coap = emqx_coap_tm:new(),
queue = queue:new(),
last_active_at = ?NOW,
created_at = erlang:system_time(millisecond),
is_cache_mode = false,
mountpoint = <<>>,
cmd_record = #{queue => queue:new()},
lifetime = emqx:get_config([gateway, lwm2m, lifetime_max]),
subscriptions = #{}
}.
-spec init(coap_message(), binary(), function(), session()) -> map().
init(#coap_message{options = Opts,
payload = Payload} = Msg, MountPoint, WithContext, Session) ->
init(
#coap_message{
options = Opts,
payload = Payload
} = Msg,
MountPoint,
WithContext,
Session
) ->
Query = maps:get(uri_query, Opts),
RegInfo = append_object_list(Query, Payload),
LifeTime = get_lifetime(RegInfo),
Epn = maps:get(<<"ep">>, Query),
Location = [?PREFIX, Epn],
NewSession = Session#session{endpoint_name = Epn,
NewSession = Session#session{
endpoint_name = Epn,
location_path = Location,
reg_info = RegInfo,
lifetime = LifeTime,
mountpoint = MountPoint,
is_cache_mode = is_psm(RegInfo) orelse is_qmode(RegInfo),
queue = queue:new()},
queue = queue:new()
},
Result = return(register_init(WithContext, NewSession)),
Reply = emqx_coap_message:piggyback({ok, created}, Msg),
@ -174,13 +207,12 @@ find_cmd_record(Path, Type, #session{cmd_record = Record}) ->
%%--------------------------------------------------------------------
%% Info, Stats
%%--------------------------------------------------------------------
-spec(info(session()) -> emqx_types:infos()).
-spec info(session()) -> emqx_types:infos().
info(Session) ->
maps:from_list(info(?INFO_KEYS, Session)).
info(Keys, Session) when is_list(Keys) ->
[{Key, info(Key, Session)} || Key <- Keys];
info(id, _) ->
undefined;
info(is_persistent, _) ->
@ -203,12 +235,11 @@ info(lifetime, #session{lifetime = LT}) ->
info(reg_info, #session{reg_info = RI}) ->
RI.
-spec(stats(session()) -> emqx_types:stats()).
-spec stats(session()) -> emqx_types:stats().
stats(Session) -> stats(?STATS_KEYS, Session).
stats(Keys, Session) when is_list(Keys) ->
[{Key, stats(Key, Session)} || Key <- Keys];
stats(subscriptions_cnt, #session{subscriptions = Subs}) ->
maps:size(Subs);
stats(subscriptions_max, _) ->
@ -236,11 +267,14 @@ stats(latency_stats, _) ->
%% API
%%--------------------------------------------------------------------
handle_coap_in(Msg, _WithContext, Session) ->
call_coap(case emqx_coap_message:is_request(Msg) of
call_coap(
case emqx_coap_message:is_request(Msg) of
true -> handle_request;
_ -> handle_response
end,
Msg, Session#session{last_active_at = ?NOW}).
Msg,
Session#session{last_active_at = ?NOW}
).
handle_deliver(Delivers, WithContext, Session) ->
return(deliver(Delivers, WithContext, Session)).
@ -263,13 +297,10 @@ set_subscriptions(Subs, Session) ->
%%--------------------------------------------------------------------
handle_protocol_in({response, CtxMsg}, WithContext, Session) ->
return(handle_coap_response(CtxMsg, WithContext, Session));
handle_protocol_in({ack, CtxMsg}, WithContext, Session) ->
return(handle_ack(CtxMsg, WithContext, Session));
handle_protocol_in({ack_failure, CtxMsg}, WithContext, Session) ->
return(handle_ack_failure(CtxMsg, WithContext, Session));
handle_protocol_in({reset, CtxMsg}, WithContext, Session) ->
return(handle_ack_reset(CtxMsg, WithContext, Session)).
@ -278,13 +309,16 @@ handle_protocol_in({reset, CtxMsg}, WithContext, Session) ->
%%--------------------------------------------------------------------
append_object_list(Query, Payload) ->
RegInfo = append_object_list2(Query, Payload),
lists:foldl(fun(Key, Acc) ->
lists:foldl(
fun(Key, Acc) ->
fix_reg_info(Key, Acc)
end,
RegInfo,
[<<"lt">>]).
[<<"lt">>]
).
append_object_list2(LwM2MQuery, <<>>) -> LwM2MQuery;
append_object_list2(LwM2MQuery, <<>>) ->
LwM2MQuery;
append_object_list2(LwM2MQuery, LwM2MPayload) when is_binary(LwM2MPayload) ->
{AlterPath, ObjList} = parse_object_list(LwM2MPayload),
LwM2MQuery#{
@ -294,14 +328,13 @@ append_object_list2(LwM2MQuery, LwM2MPayload) when is_binary(LwM2MPayload) ->
fix_reg_info(<<"lt">>, #{<<"lt">> := LT} = RegInfo) ->
RegInfo#{<<"lt">> := erlang:binary_to_integer(LT)};
fix_reg_info(_, RegInfo) ->
RegInfo.
parse_object_list(<<>>) -> {<<"/">>, <<>>};
parse_object_list(<<>>) ->
{<<"/">>, <<>>};
parse_object_list(ObjLinks) when is_binary(ObjLinks) ->
parse_object_list(binary:split(ObjLinks, <<",">>, [global]));
parse_object_list(FullObjLinkList) ->
case drop_attr(FullObjLinkList) of
{<<"/">>, _} = RootPrefixedLinks ->
@ -313,8 +346,11 @@ parse_object_list(FullObjLinkList) ->
fun
(<<Prefix:LenAlterPath/binary, Link/binary>>) when Prefix =:= AlterPath ->
trim(Link);
(Link) -> Link
end, ObjLinkList),
(Link) ->
Link
end,
ObjLinkList
),
{AlterPath, WithOutPrefix}
end.
@ -325,25 +361,31 @@ drop_attr(LinkList) ->
{false, MainLink} -> {AlternatePath, [MainLink | LinkAcc]};
{true, MainLink} -> {MainLink, LinkAcc}
end
end, {<<"/">>, []}, LinkList).
end,
{<<"/">>, []},
LinkList
).
parse_link(Link) ->
[MainLink | Attrs] = binary:split(trim(Link), <<";">>, [global]),
{is_alternate_path(Attrs), delink(trim(MainLink))}.
is_alternate_path(LinkAttrs) ->
lists:any(fun(Attr) ->
lists:any(
fun(Attr) ->
case binary:split(trim(Attr), <<"=">>) of
[<<"rt">>, ?OMA_ALTER_PATH_RT] ->
true;
[AttrKey, _] when AttrKey =/= <<>> ->
false;
_BadAttr -> throw({bad_attr, _BadAttr})
_BadAttr ->
throw({bad_attr, _BadAttr})
end
end,
LinkAttrs).
LinkAttrs
).
trim(Str)-> binary_util:trim(Str, $ ).
trim(Str) -> binary_util:trim(Str, $\s).
delink(Str) ->
Ltrim = binary_util:ltrim(Str, $<),
@ -359,24 +401,27 @@ get_lifetime(_) ->
get_lifetime(#{<<"lt">> := _} = NewRegInfo, _) ->
get_lifetime(NewRegInfo);
get_lifetime(_, OldRegInfo) ->
get_lifetime(OldRegInfo).
-spec update(coap_message(), function(), binary(), session()) -> map().
update(#coap_message{options = Opts, payload = Payload} = Msg,
update(
#coap_message{options = Opts, payload = Payload} = Msg,
WithContext,
CmdType,
#session{reg_info = OldRegInfo} = Session) ->
#session{reg_info = OldRegInfo} = Session
) ->
Query = maps:get(uri_query, Opts, #{}),
RegInfo = append_object_list(Query, Payload),
UpdateRegInfo = maps:merge(OldRegInfo, RegInfo),
LifeTime = get_lifetime(UpdateRegInfo, OldRegInfo),
NewSession = Session#session{reg_info = UpdateRegInfo,
NewSession = Session#session{
reg_info = UpdateRegInfo,
is_cache_mode =
is_psm(UpdateRegInfo) orelse is_qmode(UpdateRegInfo),
lifetime = LifeTime},
lifetime = LifeTime
},
Session2 = proto_subscribe(WithContext, NewSession),
Session3 = send_dl_msg(Session2),
@ -395,7 +440,8 @@ register_init(WithContext, #session{reg_info = RegInfo} = Session) ->
MountedTopic = mount(Topic, Session),
SubOpts = maps:merge(
emqx_gateway_utils:default_subopts(),
#{qos => Qos}),
#{qos => Qos}
),
Session3 = do_subscribe(MountedTopic, SubOpts, WithContext, Session2),
Session4 = send_dl_msg(Session3),
@ -412,20 +458,32 @@ proto_subscribe(WithContext, #session{wait_ack = WaitAck} = Session) ->
MountedTopic = mount(Topic, Session),
SubOpts = maps:merge(
emqx_gateway_utils:default_subopts(),
#{qos => Qos}),
NSession = case WaitAck of
#{qos => Qos}
),
NSession =
case WaitAck of
undefined ->
Session;
Ctx ->
MqttPayload = emqx_lwm2m_cmd:coap_failure_to_mqtt(
Ctx, <<"coap_timeout">>),
send_to_mqtt(Ctx, <<"coap_timeout">>,
MqttPayload, WithContext, Session)
Ctx, <<"coap_timeout">>
),
send_to_mqtt(
Ctx,
<<"coap_timeout">>,
MqttPayload,
WithContext,
Session
)
end,
do_subscribe(MountedTopic, SubOpts, WithContext, NSession).
do_subscribe(Topic, SubOpts, WithContext,
Session = #session{subscriptions = Subs}) ->
do_subscribe(
Topic,
SubOpts,
WithContext,
Session = #session{subscriptions = Subs}
) ->
case WithContext(subscribe, [Topic, SubOpts]) of
{error, _} ->
Session;
@ -452,12 +510,14 @@ observe_object_list(AlternatePath, ObjectList, Session) ->
Fun = fun(ObjectPath, Acc) ->
{[ObjId | _], _} = emqx_lwm2m_cmd:path_list(ObjectPath),
case lists:member(ObjId, ?IGNORE_OBJECT) of
true -> Acc;
true ->
Acc;
false ->
try
emqx_lwm2m_xml_object_db:find_objectid(binary_to_integer(ObjId)),
observe_object(AlternatePath, ObjectPath, Acc)
catch error:no_xml_definition ->
catch
error:no_xml_definition ->
Acc
end
end
@ -465,16 +525,18 @@ observe_object_list(AlternatePath, ObjectList, Session) ->
lists:foldl(Fun, Session, ObjectList).
observe_object(AlternatePath, ObjectPath, Session) ->
Payload = #{<<"msgType">> => <<"observe">>,
Payload = #{
<<"msgType">> => <<"observe">>,
<<"data">> => #{<<"path">> => ObjectPath},
<<"is_auto_observe">> => true
},
deliver_auto_observe_to_coap(AlternatePath, Payload, Session).
deliver_auto_observe_to_coap(AlternatePath, TermData, Session) ->
?SLOG(info, #{ msg => "send_auto_observe"
, path => AlternatePath
, data => TermData
?SLOG(info, #{
msg => "send_auto_observe",
path => AlternatePath,
data => TermData
}),
{Req, Ctx} = emqx_lwm2m_cmd:mqtt_to_coap(AlternatePath, TermData),
maybe_do_deliver_to_coap(Ctx, Req, 0, false, Session).
@ -485,13 +547,16 @@ is_auto_observe() ->
%%--------------------------------------------------------------------
%% Response
%%--------------------------------------------------------------------
handle_coap_response({Ctx = #{<<"msgType">> := EventType},
#coap_message{method = CoapMsgMethod,
handle_coap_response(
{Ctx = #{<<"msgType">> := EventType}, #coap_message{
method = CoapMsgMethod,
type = CoapMsgType,
payload = CoapMsgPayload,
options = CoapMsgOpts}},
options = CoapMsgOpts
}},
WithContext,
Session) ->
Session
) ->
MqttPayload = emqx_lwm2m_cmd:coap_to_mqtt(CoapMsgMethod, CoapMsgPayload, CoapMsgOpts, Ctx),
{ReqPath, _} = emqx_lwm2m_cmd:path_list(emqx_lwm2m_cmd:extract_path(Ctx)),
Session2 = record_response(EventType, MqttPayload, Session),
@ -500,7 +565,9 @@ handle_coap_response({Ctx = #{<<"msgType">> := EventType},
{[<<"5">> | _], _, <<"observe">>, CoapMsgType} when CoapMsgType =/= ack ->
%% this is a notification for status update during NB firmware upgrade.
%% need to reply to DM http callbacks
send_to_mqtt(Ctx, <<"notify">>, MqttPayload, ?lwm2m_up_dm_topic, WithContext, Session2);
send_to_mqtt(
Ctx, <<"notify">>, MqttPayload, ?lwm2m_up_dm_topic, WithContext, Session2
);
{_ReqPath, _, <<"observe">>, CoapMsgType} when CoapMsgType =/= ack ->
%% this is actually a notification, correct the msgType
send_to_mqtt(Ctx, <<"notify">>, MqttPayload, WithContext, Session2);
@ -537,7 +604,8 @@ handle_ack_failure(Ctx, MsgType, WithContext, Session) ->
may_send_dl_msg(coap_timeout, Ctx, #session{wait_ack = WaitAck} = Session) ->
case is_cache_mode(Session) of
false -> send_dl_msg(Ctx, Session);
false ->
send_dl_msg(Ctx, Session);
true ->
case WaitAck of
Ctx ->
@ -547,24 +615,32 @@ may_send_dl_msg(coap_timeout, Ctx, #session{wait_ack = WaitAck} = Session) ->
end
end.
is_cache_mode(#session{is_cache_mode = IsCacheMode,
last_active_at = LastActiveAt}) ->
is_cache_mode(#session{
is_cache_mode = IsCacheMode,
last_active_at = LastActiveAt
}) ->
IsCacheMode andalso
((?NOW - LastActiveAt) >=
emqx:get_config([gateway, lwm2m, qmode_time_window])).
is_psm(#{<<"apn">> := APN}) when APN =:= <<"Ctnb">>;
is_psm(#{<<"apn">> := APN}) when
APN =:= <<"Ctnb">>;
APN =:= <<"psmA.eDRX0.ctnb">>;
APN =:= <<"psmC.eDRX0.ctnb">>;
APN =:= <<"psmF.eDRXC.ctnb">>
-> true;
is_psm(_) -> false.
->
true;
is_psm(_) ->
false.
is_qmode(#{<<"b">> := Binding}) when Binding =:= <<"UQ">>;
is_qmode(#{<<"b">> := Binding}) when
Binding =:= <<"UQ">>;
Binding =:= <<"SQ">>;
Binding =:= <<"UQS">>
-> true;
is_qmode(_) -> false.
->
true;
is_qmode(_) ->
false.
send_dl_msg(Session) ->
%% if has in waiting donot send
@ -589,7 +665,8 @@ send_to_coap(#session{queue = Queue} = Session) ->
case queue:out(Queue) of
{{value, {Timestamp, Ctx, Req}}, Q2} ->
Now = ?NOW,
if Timestamp =:= 0 orelse Timestamp > Now ->
if
Timestamp =:= 0 orelse Timestamp > Now ->
send_to_coap(Ctx, Req, Session#session{queue = Q2});
true ->
send_to_coap(Session#session{queue = Q2})
@ -599,14 +676,16 @@ send_to_coap(#session{queue = Queue} = Session) ->
end.
send_to_coap(Ctx, Req, Session) ->
?SLOG(debug, #{ msg => "deliver_to_coap"
, coap_request => Req
?SLOG(debug, #{
msg => "deliver_to_coap",
coap_request => Req
}),
out_to_coap(Ctx, Req, Session#session{wait_ack = Ctx}).
send_msg_not_waiting_ack(Ctx, Req, Session) ->
?SLOG(debug, #{ msg => "deliver_to_coap_and_no_ack"
, coap_request => Req
?SLOG(debug, #{
msg => "deliver_to_coap_and_no_ack",
coap_request => Req
}),
%% cmd_sent(Ref, LwM2MOpts).
out_to_coap(Ctx, Req, Session).
@ -619,17 +698,35 @@ send_to_mqtt(Ref, EventType, Payload, WithContext, Session) ->
Mheaders = maps:get(mheaders, Ref, #{}),
proto_publish(Topic, Payload#{<<"msgType">> => EventType}, Qos, Mheaders, WithContext, Session).
send_to_mqtt(Ctx, EventType, Payload, {Topic, Qos},
WithContext, Session) ->
send_to_mqtt(
Ctx,
EventType,
Payload,
{Topic, Qos},
WithContext,
Session
) ->
Mheaders = maps:get(mheaders, Ctx, #{}),
proto_publish(Topic, Payload#{<<"msgType">> => EventType}, Qos, Mheaders, WithContext, Session).
proto_publish(Topic, Payload, Qos, Headers, WithContext,
#session{endpoint_name = Epn} = Session) ->
proto_publish(
Topic,
Payload,
Qos,
Headers,
WithContext,
#session{endpoint_name = Epn} = Session
) ->
MountedTopic = mount(Topic, Session),
%% TODO: Append message metadata into headers
Msg = emqx_message:make(Epn, Qos, MountedTopic,
emqx_json:encode(Payload), #{}, Headers),
Msg = emqx_message:make(
Epn,
Qos,
MountedTopic,
emqx_json:encode(Payload),
#{},
Headers
),
_ = WithContext(publish, [MountedTopic, Msg]),
Session.
@ -642,13 +739,10 @@ downlink_topic() ->
uplink_topic(<<"notify">>) ->
emqx:get_config([gateway, lwm2m, translators, notify]);
uplink_topic(<<"register">>) ->
emqx:get_config([gateway, lwm2m, translators, register]);
uplink_topic(<<"update">>) ->
emqx:get_config([gateway, lwm2m, translators, update]);
uplink_topic(_) ->
emqx:get_config([gateway, lwm2m, translators, response]).
@ -659,46 +753,67 @@ uplink_topic(_) ->
deliver(Delivers, WithContext, #session{reg_info = RegInfo} = Session) ->
IsCacheMode = is_cache_mode(Session),
AlternatePath = maps:get(<<"alternatePath">>, RegInfo, <<"/">>),
lists:foldl(fun({deliver, _, MQTT}, Acc) ->
deliver_to_coap(AlternatePath,
MQTT#message.payload, MQTT, IsCacheMode, WithContext, Acc)
lists:foldl(
fun({deliver, _, MQTT}, Acc) ->
deliver_to_coap(
AlternatePath,
MQTT#message.payload,
MQTT,
IsCacheMode,
WithContext,
Acc
)
end,
Session,
Delivers).
Delivers
).
deliver_to_coap(AlternatePath, JsonData, MQTT, CacheMode, WithContext, Session) when is_binary(JsonData)->
deliver_to_coap(AlternatePath, JsonData, MQTT, CacheMode, WithContext, Session) when
is_binary(JsonData)
->
try
TermData = emqx_json:decode(JsonData, [return_maps]),
deliver_to_coap(AlternatePath, TermData, MQTT, CacheMode, WithContext, Session)
catch
ExClass:Error:ST ->
?SLOG(error, #{ msg => "invaild_json_format_to_deliver"
, data => JsonData
, reason => {ExClass, Error}
, stacktrace => ST
?SLOG(error, #{
msg => "invaild_json_format_to_deliver",
data => JsonData,
reason => {ExClass, Error},
stacktrace => ST
}),
WithContext(metrics, 'delivery.dropped'),
Session
end;
deliver_to_coap(AlternatePath, TermData, MQTT, CacheMode, WithContext, Session) when is_map(TermData) ->
deliver_to_coap(AlternatePath, TermData, MQTT, CacheMode, WithContext, Session) when
is_map(TermData)
->
WithContext(metrics, 'messages.delivered'),
{Req, Ctx} = emqx_lwm2m_cmd:mqtt_to_coap(AlternatePath, TermData),
ExpiryTime = get_expiry_time(MQTT),
Session2 = record_request(Ctx, Session),
maybe_do_deliver_to_coap(Ctx, Req, ExpiryTime, CacheMode, Session2).
maybe_do_deliver_to_coap(Ctx, Req, ExpiryTime, CacheMode,
#session{wait_ack = WaitAck,
queue = Queue} = Session) ->
maybe_do_deliver_to_coap(
Ctx,
Req,
ExpiryTime,
CacheMode,
#session{
wait_ack = WaitAck,
queue = Queue
} = Session
) ->
MHeaders = maps:get(mheaders, Ctx, #{}),
TTL = maps:get(<<"ttl">>, MHeaders, 7200),
case TTL of
0 ->
send_msg_not_waiting_ack(Ctx, Req, Session);
_ ->
case not CacheMode
andalso queue:is_empty(Queue) andalso WaitAck =:= undefined of
case
not CacheMode andalso
queue:is_empty(Queue) andalso WaitAck =:= undefined
of
true ->
send_to_coap(Ctx, Req, Session);
false ->
@ -706,8 +821,10 @@ maybe_do_deliver_to_coap(Ctx, Req, ExpiryTime, CacheMode,
end
end.
get_expiry_time(#message{headers = #{properties := #{'Message-Expiry-Interval' := Interval}},
timestamp = Ts}) ->
get_expiry_time(#message{
headers = #{properties := #{'Message-Expiry-Interval' := Interval}},
timestamp = Ts
}) ->
Ts + Interval * 1000;
get_expiry_time(_) ->
0.
@ -726,9 +843,11 @@ send_cmd_impl(Cmd, #session{reg_info = RegInfo} = Session) ->
%% Call CoAP
%%--------------------------------------------------------------------
call_coap(Fun, Msg, #session{coap = Coap} = Session) ->
iter([tm, fun process_tm/4, fun process_session/3],
iter(
[tm, fun process_tm/4, fun process_session/3],
emqx_coap_tm:Fun(Msg, Coap),
Session).
Session
).
process_tm(TM, Result, Session, Cursor) ->
iter(Cursor, Result, Session#session{coap = TM}).
@ -758,10 +877,11 @@ return(#session{coap = CoAP} = Session) ->
do_out([{Ctx, Out} | T], TM, Msgs) ->
%% TODO maybe set a special token?
#{out := [Msg],
tm := TM2} = emqx_coap_tm:handle_out(Out, Ctx, TM),
#{
out := [Msg],
tm := TM2
} = emqx_coap_tm:handle_out(Out, Ctx, TM),
do_out(T, TM2, [Msg | Msgs]);
do_out(_, TM, Msgs) ->
{ok, TM, Msgs}.
@ -789,7 +909,6 @@ record_cmd(Path, Type, Result, #session{cmd_record = #{queue := Queue} = Record
check_record_size(Record, Queue) when ?RECORD_SIZE(Record) =< ?MAX_RECORD_SIZE ->
Record#{queue := Queue};
check_record_size(Record, Queue) ->
{{value, Key}, Queue2} = queue:out(Queue),
Record2 = maps:remove(Key, Record),

42
apps/emqx_gateway/src/lwm2m/emqx_lwm2m_tlv.erl
View File

@ -16,11 +16,11 @@
-module(emqx_lwm2m_tlv).
-export([ parse/1
, encode/1
-export([
parse/1,
encode/1
]).
-ifdef(TEST).
-export([binary_to_hex_string/1]).
-endif.
@ -54,7 +54,6 @@
% NOTE: TLV does not has object level, only has object instance level. It implies TLV can not represent multiple objects
%----------------------------------------------------------------------------------------------------------------------------------------
parse(Data) ->
parse_loop(Data, []).
@ -67,13 +66,19 @@ parse_loop(Data, Acc) ->
parse_step1(<<?TLV_TYPE_OBJECT_INSTANCE:2, IdLength:1, LengthType:2, InlineLength:3, Rest/binary>>) ->
{Id, Value, Rest2} = parse_step2(id_length_bit_width(IdLength), LengthType, InlineLength, Rest),
{#{tlv_object_instance => Id, value => parse_loop(Value, [])}, Rest2};
parse_step1(<<?TLV_TYPE_RESOURCE_INSTANCE:2, IdLength:1, LengthType:2, InlineLength:3, Rest/binary>>) ->
parse_step1(
<<?TLV_TYPE_RESOURCE_INSTANCE:2, IdLength:1, LengthType:2, InlineLength:3, Rest/binary>>
) ->
{Id, Value, Rest2} = parse_step2(id_length_bit_width(IdLength), LengthType, InlineLength, Rest),
{#{tlv_resource_instance => Id, value => Value}, Rest2};
parse_step1(<<?TLV_TYPE_MULTIPLE_RESOURCE:2, IdLength:1, LengthType:2, InlineLength:3, Rest/binary>>) ->
parse_step1(
<<?TLV_TYPE_MULTIPLE_RESOURCE:2, IdLength:1, LengthType:2, InlineLength:3, Rest/binary>>
) ->
{Id, Value, Rest2} = parse_step2(id_length_bit_width(IdLength), LengthType, InlineLength, Rest),
{#{tlv_multiple_resource => Id, value => parse_loop(Value, [])}, Rest2};
parse_step1(<<?TLV_TYPE_RESOURCE_WITH_VALUE:2, IdLength:1, LengthType:2, InlineLength:3, Rest/binary>>) ->
parse_step1(
<<?TLV_TYPE_RESOURCE_WITH_VALUE:2, IdLength:1, LengthType:2, InlineLength:3, Rest/binary>>
) ->
{Id, Value, Rest2} = parse_step2(id_length_bit_width(IdLength), LengthType, InlineLength, Rest),
{#{tlv_resource_with_value => Id, value => Value}, Rest2}.
@ -97,7 +102,6 @@ parse_step3(Id, Length, Data) ->
id_length_bit_width(0) -> 8;
id_length_bit_width(1) -> 16.
encode(TlvList) ->
encode(TlvList, <<>>).
@ -122,15 +126,24 @@ encode([#{tlv_resource_with_value := Id, value := Value}|T], Acc) ->
encode_body(Type, Id, Value) ->
Size = byte_size(Value),
{IdLength, IdBinarySize, IdBinary} = if
{IdLength, IdBinarySize, IdBinary} =
if
Id < 256 -> {0, 1, <<Id:8>>};
true -> {1, 2, <<Id:16>>}
end,
if
Size < 8 -> <<Type:2, IdLength:1, ?TLV_NO_LENGTH_FIELD:2, Size:3, IdBinary:IdBinarySize/binary, Value:Size/binary>>;
Size < 256 -> <<Type:2, IdLength:1, ?TLV_LEGNTH_8_BIT:2, 0:3, IdBinary:IdBinarySize/binary, Size:8, Value:Size/binary>>;
Size < 65536 -> <<Type:2, IdLength:1, ?TLV_LEGNTH_16_BIT:2, 0:3, IdBinary:IdBinarySize/binary, Size:16, Value:Size/binary>>;
true -> <<Type:2, IdLength:1, ?TLV_LEGNTH_24_BIT:2, 0:3, IdBinary:IdBinarySize/binary, Size:24, Value:Size/binary>>
Size < 8 ->
<<Type:2, IdLength:1, ?TLV_NO_LENGTH_FIELD:2, Size:3, IdBinary:IdBinarySize/binary,
Value:Size/binary>>;
Size < 256 ->
<<Type:2, IdLength:1, ?TLV_LEGNTH_8_BIT:2, 0:3, IdBinary:IdBinarySize/binary, Size:8,
Value:Size/binary>>;
Size < 65536 ->
<<Type:2, IdLength:1, ?TLV_LEGNTH_16_BIT:2, 0:3, IdBinary:IdBinarySize/binary, Size:16,
Value:Size/binary>>;
true ->
<<Type:2, IdLength:1, ?TLV_LEGNTH_24_BIT:2, 0:3, IdBinary:IdBinarySize/binary, Size:24,
Value:Size/binary>>
end.
encode_value(Value) when is_binary(Value) ->
@ -152,10 +165,7 @@ encode_value(Value) when is_float(Value) ->
encode_value(Value) ->
error(io_lib:format("unsupported format ~p", [Value])).
-ifdef(TEST).
binary_to_hex_string(Data) ->
lists:flatten([io_lib:format("~2.16.0B ", [X]) || <<X:8>> <= Data]).
-endif.

31
apps/emqx_gateway/src/lwm2m/emqx_lwm2m_xml_object.erl
View File

@ -19,13 +19,14 @@
-include("src/lwm2m/include/emqx_lwm2m.hrl").
-include_lib("xmerl/include/xmerl.hrl").
-export([ get_obj_def/2
, get_object_id/1
, get_object_name/1
, get_object_and_resource_id/2
, get_resource_type/2
, get_resource_name/2
, get_resource_operations/2
-export([
get_obj_def/2,
get_object_id/1,
get_object_name/1,
get_object_and_resource_id/2,
get_resource_type/2,
get_resource_name/2,
get_resource_operations/2
]).
% This module is for future use. Disabled now.
@ -46,20 +47,28 @@ get_object_name(ObjDefinition) ->
get_object_and_resource_id(ResourceNameBinary, ObjDefinition) ->
ResourceNameString = binary_to_list(ResourceNameBinary),
[#xmlText{value = ObjectId}] = xmerl_xpath:string("ObjectID/text()", ObjDefinition),
[#xmlAttribute{value=ResourceId}] = xmerl_xpath:string("Resources/Item/Name[.=\""++ResourceNameString++"\"]/../@ID", ObjDefinition),
[#xmlAttribute{value = ResourceId}] = xmerl_xpath:string(
"Resources/Item/Name[.=\"" ++ ResourceNameString ++ "\"]/../@ID", ObjDefinition
),
{ObjectId, ResourceId}.
get_resource_type(ResourceIdInt, ObjDefinition) ->
ResourceIdString = integer_to_list(ResourceIdInt),
[#xmlText{value=DataType}] = xmerl_xpath:string("Resources/Item[@ID=\""++ResourceIdString++"\"]/Type/text()", ObjDefinition),
[#xmlText{value = DataType}] = xmerl_xpath:string(
"Resources/Item[@ID=\"" ++ ResourceIdString ++ "\"]/Type/text()", ObjDefinition
),
DataType.
get_resource_name(ResourceIdInt, ObjDefinition) ->
ResourceIdString = integer_to_list(ResourceIdInt),
[#xmlText{value=Name}] = xmerl_xpath:string("Resources/Item[@ID=\""++ResourceIdString++"\"]/Name/text()", ObjDefinition),
[#xmlText{value = Name}] = xmerl_xpath:string(
"Resources/Item[@ID=\"" ++ ResourceIdString ++ "\"]/Name/text()", ObjDefinition
),
Name.
get_resource_operations(ResourceIdInt, ObjDefinition) ->
ResourceIdString = integer_to_list(ResourceIdInt),
[#xmlText{value=Operations}] = xmerl_xpath:string("Resources/Item[@ID=\""++ResourceIdString++"\"]/Operations/text()", ObjDefinition),
[#xmlText{value = Operations}] = xmerl_xpath:string(
"Resources/Item[@ID=\"" ++ ResourceIdString ++ "\"]/Operations/text()", ObjDefinition
),
Operations.

48
apps/emqx_gateway/src/lwm2m/emqx_lwm2m_xml_object_db.erl
View File

@ -23,19 +23,21 @@
% This module is for future use. Disabled now.
%% API
-export([ start_link/1
, stop/0
, find_name/1
, find_objectid/1
-export([
start_link/1,
stop/0,
find_name/1,
find_objectid/1
]).
%% gen_server.
-export([ init/1
, handle_call/3
, handle_cast/2
, handle_info/2
, terminate/2
, code_change/3
-export([
init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3
]).
-define(LWM2M_OBJECT_DEF_TAB, lwm2m_object_def_tab).
@ -47,8 +49,8 @@
%% API Function Definitions
%% ------------------------------------------------------------------
-spec start_link(string())
-> {ok, pid()}
-spec start_link(string()) ->
{ok, pid()}
| ignore
| {error, no_xml_files_found}
| {error, term()}.
@ -56,7 +58,8 @@ start_link(XmlDir) ->
gen_server:start_link({local, ?MODULE}, ?MODULE, [XmlDir], []).
find_objectid(ObjectId) ->
ObjectIdInt = case is_list(ObjectId) of
ObjectIdInt =
case is_list(ObjectId) of
true -> list_to_integer(ObjectId);
false -> ObjectId
end,
@ -66,7 +69,8 @@ find_objectid(ObjectId) ->
end.
find_name(Name) ->
NameBinary = case is_list(Name) of
NameBinary =
case is_list(Name) of
true -> list_to_binary(Name);
false -> Name
end,
@ -93,7 +97,8 @@ init([XmlDir]) ->
case load(XmlDir) of
ok ->
{ok, #state{}};
{error, Reason} -> {stop, Reason}
{error, Reason} ->
{stop, Reason}
end.
handle_call(_Request, _From, State) ->
@ -118,7 +123,9 @@ code_change(_OldVsn, State, _Extra) ->
%%--------------------------------------------------------------------
load(BaseDir) ->
Wild = filename:join(BaseDir, "*.xml"),
Wild2 = if is_binary(Wild) ->
Wild2 =
if
is_binary(Wild) ->
erlang:binary_to_list(Wild);
true ->
Wild
@ -136,10 +143,11 @@ load_loop([FileName|T]) ->
[#xmlText{value = Name}] = xmerl_xpath:string("Name/text()", ObjectXml),
ObjectId = list_to_integer(ObjectIdString),
NameBinary = list_to_binary(Name),
?SLOG(debug, #{ msg => "load_object_succeed"
, filename => FileName
, object_id => ObjectId
, object_name => NameBinary
?SLOG(debug, #{
msg => "load_object_succeed",
filename => FileName,
object_id => ObjectId,
object_name => NameBinary
}),
ets:insert(?LWM2M_OBJECT_DEF_TAB, {ObjectId, ObjectXml}),
ets:insert(?LWM2M_OBJECT_NAME_TO_ID_TAB, {NameBinary, ObjectId}),

1
apps/emqx_gateway/src/lwm2m/include/emqx_lwm2m.hrl
View File

@ -16,7 +16,6 @@
-define(LWAPP, emqx_lwm2m).
-define(OMA_ALTER_PATH_RT, <<"\"oma.lwm2m\"">>).
-define(MQ_COMMAND_ID, <<"CmdID">>).

77
apps/emqx_gateway/src/mqttsn/emqx_sn_broadcast.erl
View File

@ -21,13 +21,20 @@
-include("src/mqttsn/include/emqx_sn.hrl").
-include_lib("emqx/include/logger.hrl").
-export([ start_link/2
, stop/0
-export([
start_link/2,
stop/0
]).
%% gen_server
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
terminate/2, code_change/3]).
-export([
init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3
]).
-record(state, {gwid, sock, port, addrs, duration, tref}).
@ -37,12 +44,12 @@
%% API
%%--------------------------------------------------------------------
-spec(start_link(pos_integer(), inet:port_number())
-> {ok, pid()} | {error, term()}).
-spec start_link(pos_integer(), inet:port_number()) ->
{ok, pid()} | {error, term()}.
start_link(GwId, Port) ->
gen_server:start_link({local, ?MODULE}, ?MODULE, [GwId, Port], []).
-spec(stop() -> ok).
-spec stop() -> ok.
stop() ->
gen_server:stop(?MODULE, nomal, infinity).
@ -54,27 +61,35 @@ init([GwId, Port]) ->
%% FIXME:
Duration = application:get_env(emqx_sn, advertise_duration, ?DEFAULT_DURATION),
{ok, Sock} = gen_udp:open(0, [binary, {broadcast, true}]),
{ok, ensure_advertise(#state{gwid = GwId, addrs = boradcast_addrs(),
sock = Sock, port = Port, duration = Duration})}.
{ok,
ensure_advertise(#state{
gwid = GwId,
addrs = boradcast_addrs(),
sock = Sock,
port = Port,
duration = Duration
})}.
handle_call(Req, _From, State) ->
?SLOG(error, #{ msg => "unexpected_call"
, call => Req
?SLOG(error, #{
msg => "unexpected_call",
call => Req
}),
{reply, ignored, State}.
handle_cast(Msg, State) ->
?SLOG(error, #{ msg => "unexpected_cast"
, cast => Msg
?SLOG(error, #{
msg => "unexpected_cast",
cast => Msg
}),
{noreply, State}.
handle_info(broadcast_advertise, State) ->
{noreply, ensure_advertise(State), hibernate};
handle_info(Info, State) ->
?SLOG(error, #{ msg => "unexpected_info"
, info => Info
?SLOG(error, #{
msg => "unexpected_info",
info => Info
}),
{noreply, State}.
@ -93,17 +108,29 @@ ensure_advertise(State = #state{duration = Duration}) ->
send_advertise(State),
State#state{tref = erlang:send_after(Duration, self(), broadcast_advertise)}.
send_advertise(#state{gwid = GwId, sock = Sock, port = Port,
addrs = Addrs, duration = Duration}) ->
send_advertise(#state{
gwid = GwId,
sock = Sock,
port = Port,
addrs = Addrs,
duration = Duration
}) ->
Data = emqx_sn_frame:serialize_pkt(?SN_ADVERTISE_MSG(GwId, Duration), #{}),
lists:foreach(fun(Addr) ->
?SLOG(debug, #{ msg => "send_ADVERTISE_msg"
, address => Addr
lists:foreach(
fun(Addr) ->
?SLOG(debug, #{
msg => "send_ADVERTISE_msg",
address => Addr
}),
gen_udp:send(Sock, Addr, Port, Data)
end, Addrs).
end,
Addrs
).
boradcast_addrs() ->
lists:usort([Addr || {ok, IfList} <- [inet:getiflist()], If <- IfList,
{ok, [{broadaddr, Addr}]} <- [inet:ifget(If, [broadaddr])]]).
lists:usort([
Addr
|| {ok, IfList} <- [inet:getiflist()],
If <- IfList,
{ok, [{broadaddr, Addr}]} <- [inet:ifget(If, [broadaddr])]
]).

1637
apps/emqx_gateway/src/mqttsn/emqx_sn_channel.erl
View File

File diff suppressed because it is too large Load Diff

259
apps/emqx_gateway/src/mqttsn/emqx_sn_frame.erl
View File

@ -22,14 +22,15 @@
-include("src/mqttsn/include/emqx_sn.hrl").
-export([ initial_parse_state/1
, serialize_opts/0
, parse/2
, serialize_pkt/2
, message_type/1
, format/1
, type/1
, is_message/1
-export([
initial_parse_state/1,
serialize_opts/0,
parse/2,
serialize_pkt/2,
message_type/1,
format/1,
type/1,
is_message/1
]).
-define(flag, 1 / binary).
@ -39,8 +40,9 @@
-type parse_state() :: #{}.
-type serialize_opts() :: #{}.
-export_type([ parse_state/0
, serialize_opts/0
-export_type([
parse_state/0,
serialize_opts/0
]).
%%--------------------------------------------------------------------
@ -95,9 +97,13 @@ parse_var(?SN_PUBLISH, <<FlagsBin:?flag, Topic:2/binary, MsgId:?short, Data/bina
{Flags, parse_topic(IdType, Topic), MsgId, Data};
parse_var(?SN_PUBACK, <<TopicId:?short, MsgId:?short, ReturnCode:?byte>>) ->
{TopicId, MsgId, ReturnCode};
parse_var(PubRec, <<MsgId:?short>>) when PubRec == ?SN_PUBREC; PubRec == ?SN_PUBREL; PubRec == ?SN_PUBCOMP ->
parse_var(PubRec, <<MsgId:?short>>) when
PubRec == ?SN_PUBREC; PubRec == ?SN_PUBREL; PubRec == ?SN_PUBCOMP
->
MsgId;
parse_var(Sub, <<FlagsBin:?flag, MsgId:?short, Topic/binary>>) when Sub == ?SN_SUBSCRIBE; Sub == ?SN_UNSUBSCRIBE ->
parse_var(Sub, <<FlagsBin:?flag, MsgId:?short, Topic/binary>>) when
Sub == ?SN_SUBSCRIBE; Sub == ?SN_UNSUBSCRIBE
->
#mqtt_sn_flags{topic_id_type = IdType} = Flags = parse_flags(Sub, FlagsBin),
{Flags, MsgId, parse_topic(IdType, Topic)};
parse_var(?SN_SUBACK, <<Flags:?flag, TopicId:?short, MsgId:?short, ReturnCode:?byte>>) ->
@ -131,8 +137,9 @@ parse_flags(?SN_WILLTOPIC, <<_D:1, QoS:2, Retain:1, _Will:1, _C:1, _:2>>) ->
#mqtt_sn_flags{qos = QoS, retain = bool(Retain)};
parse_flags(?SN_PUBLISH, <<Dup:1, QoS:2, Retain:1, _Will:1, _C:1, IdType:2>>) ->
#mqtt_sn_flags{dup = bool(Dup), qos = QoS, retain = bool(Retain), topic_id_type = IdType};
parse_flags(Sub, <<Dup:1, QoS:2, _R:1, _Will:1, _C:1, IdType:2>>)
when Sub == ?SN_SUBSCRIBE; Sub == ?SN_UNSUBSCRIBE ->
parse_flags(Sub, <<Dup:1, QoS:2, _R:1, _Will:1, _C:1, IdType:2>>) when
Sub == ?SN_SUBSCRIBE; Sub == ?SN_UNSUBSCRIBE
->
#mqtt_sn_flags{dup = bool(Dup), qos = QoS, topic_id_type = IdType};
parse_flags(?SN_SUBACK, <<_D:1, QoS:2, _R:1, _W:1, _C:1, _Id:2>>) ->
#mqtt_sn_flags{qos = QoS};
@ -151,7 +158,8 @@ parse_topic(2#11, Topic) -> Topic.
%%--------------------------------------------------------------------
serialize_pkt(#mqtt_sn_message{type = Type, variable = Var}, Opts) ->
VarBin = serialize(Type, Var, Opts), VarLen = size(VarBin),
VarBin = serialize(Type, Var, Opts),
VarLen = size(VarBin),
if
VarLen < 254 -> <<(VarLen + 2), Type, VarBin/binary>>;
true -> <<16#01, (VarLen + 4):?short, Type, VarBin/binary>>
@ -182,18 +190,33 @@ serialize(?SN_REGISTER, {TopicId, MsgId, TopicName}, _Opts) ->
<<TopicId:?short, MsgId:?short, TopicName/binary>>;
serialize(?SN_REGACK, {TopicId, MsgId, ReturnCode}, _Opts) ->
<<TopicId:?short, MsgId:?short, ReturnCode>>;
serialize(?SN_PUBLISH, {Flags=#mqtt_sn_flags{topic_id_type = ?SN_NORMAL_TOPIC}, TopicId, MsgId, Data}, _Opts) ->
serialize(
?SN_PUBLISH,
{Flags = #mqtt_sn_flags{topic_id_type = ?SN_NORMAL_TOPIC}, TopicId, MsgId, Data},
_Opts
) ->
<<(serialize_flags(Flags))/binary, TopicId:?short, MsgId:?short, Data/binary>>;
serialize(?SN_PUBLISH, {Flags=#mqtt_sn_flags{topic_id_type = ?SN_PREDEFINED_TOPIC}, TopicId, MsgId, Data}, _Opts) ->
serialize(
?SN_PUBLISH,
{Flags = #mqtt_sn_flags{topic_id_type = ?SN_PREDEFINED_TOPIC}, TopicId, MsgId, Data},
_Opts
) ->
<<(serialize_flags(Flags))/binary, TopicId:?short, MsgId:?short, Data/binary>>;
serialize(?SN_PUBLISH, {Flags=#mqtt_sn_flags{topic_id_type = ?SN_SHORT_TOPIC}, STopicName, MsgId, Data}, _Opts) ->
serialize(
?SN_PUBLISH,
{Flags = #mqtt_sn_flags{topic_id_type = ?SN_SHORT_TOPIC}, STopicName, MsgId, Data},
_Opts
) ->
<<(serialize_flags(Flags))/binary, STopicName:2/binary, MsgId:?short, Data/binary>>;
serialize(?SN_PUBACK, {TopicId, MsgId, ReturnCode}, _Opts) ->
<<TopicId:?short, MsgId:?short, ReturnCode>>;
serialize(PubRec, MsgId, _Opts) when PubRec == ?SN_PUBREC; PubRec == ?SN_PUBREL; PubRec == ?SN_PUBCOMP ->
serialize(PubRec, MsgId, _Opts) when
PubRec == ?SN_PUBREC; PubRec == ?SN_PUBREL; PubRec == ?SN_PUBCOMP
->
<<MsgId:?short>>;
serialize(Sub, {Flags = #mqtt_sn_flags{topic_id_type = IdType}, MsgId, Topic}, _Opts)
when Sub == ?SN_SUBSCRIBE; Sub == ?SN_UNSUBSCRIBE ->
serialize(Sub, {Flags = #mqtt_sn_flags{topic_id_type = IdType}, MsgId, Topic}, _Opts) when
Sub == ?SN_SUBSCRIBE; Sub == ?SN_UNSUBSCRIBE
->
<<(serialize_flags(Flags))/binary, MsgId:16, (serialize_topic(IdType, Topic))/binary>>;
serialize(?SN_SUBACK, {Flags, TopicId, MsgId, ReturnCode}, _Opts) ->
<<(serialize_flags(Flags))/binary, TopicId:?short, MsgId:?short, ReturnCode>>;
@ -216,9 +239,22 @@ serialize(?SN_DISCONNECT, undefined, _Opts) ->
serialize(?SN_DISCONNECT, Duration, _Opts) ->
<<Duration:?short>>.
serialize_flags(#mqtt_sn_flags{dup = Dup, qos = QoS, retain = Retain, will = Will,
clean_start = CleanStart, topic_id_type = IdType}) ->
<<(bool(Dup)):1, (i(QoS)):2, (bool(Retain)):1, (bool(Will)):1, (bool(CleanStart)):1, (i(IdType)):2>>.
serialize_flags(#mqtt_sn_flags{
dup = Dup,
qos = QoS,
retain = Retain,
will = Will,
clean_start = CleanStart,
topic_id_type = IdType
}) ->
<<
(bool(Dup)):1,
(i(QoS)):2,
(bool(Retain)):1,
(bool(Will)):1,
(bool(CleanStart)):1,
(i(IdType)):2
>>.
serialize_topic(2#00, Topic) -> Topic;
serialize_topic(2#01, Id) -> <<Id:?short>>;
@ -294,11 +330,19 @@ message_type(Type) ->
format(?SN_CONNECT_MSG(Flags, ProtocolId, Duration, ClientId)) ->
#mqtt_sn_flags{
will = Will,
clean_start = CleanStart} = Flags,
io_lib:format("SN_CONNECT(W~w, C~w, ProtocolId=~w, Duration=~w, "
clean_start = CleanStart
} = Flags,
io_lib:format(
"SN_CONNECT(W~w, C~w, ProtocolId=~w, Duration=~w, "
"ClientId=~ts)",
[bool(Will), bool(CleanStart),
ProtocolId, Duration, ClientId]);
[
bool(Will),
bool(CleanStart),
ProtocolId,
Duration,
ClientId
]
);
format(?SN_CONNACK_MSG(ReturnCode)) ->
io_lib:format("SN_CONNACK(ReturnCode=~w)", [ReturnCode]);
format(?SN_WILLTOPICREQ_MSG()) ->
@ -306,9 +350,12 @@ format(?SN_WILLTOPICREQ_MSG()) ->
format(?SN_WILLTOPIC_MSG(Flags, Topic)) ->
#mqtt_sn_flags{
qos = QoS,
retain = Retain} = Flags,
io_lib:format("SN_WILLTOPIC(Q~w, R~w, Topic=~s)",
[QoS, bool(Retain), Topic]);
retain = Retain
} = Flags,
io_lib:format(
"SN_WILLTOPIC(Q~w, R~w, Topic=~s)",
[QoS, bool(Retain), Topic]
);
format(?SN_WILLTOPIC_EMPTY_MSG) ->
"SN_WILLTOPIC(_)";
format(?SN_WILLMSGREQ_MSG()) ->
@ -320,14 +367,26 @@ format(?SN_PUBLISH_MSG(Flags, TopicId, MsgId, Data)) ->
dup = Dup,
qos = QoS,
retain = Retain,
topic_id_type = TopicIdType} = Flags,
io_lib:format("SN_PUBLISH(D~w, Q~w, R~w, TopicIdType=~w, TopicId=~w, "
topic_id_type = TopicIdType
} = Flags,
io_lib:format(
"SN_PUBLISH(D~w, Q~w, R~w, TopicIdType=~w, TopicId=~w, "
"MsgId=~w, Payload=~p)",
[bool(Dup), QoS, bool(Retain),
TopicIdType, TopicId, MsgId, Data]);
[
bool(Dup),
QoS,
bool(Retain),
TopicIdType,
TopicId,
MsgId,
Data
]
);
format(?SN_PUBACK_MSG(TopicId, MsgId, ReturnCode)) ->
io_lib:format("SN_PUBACK(TopicId=~w, MsgId=~w, ReturnCode=~w)",
[TopicId, MsgId, ReturnCode]);
io_lib:format(
"SN_PUBACK(TopicId=~w, MsgId=~w, ReturnCode=~w)",
[TopicId, MsgId, ReturnCode]
);
format(?SN_PUBREC_MSG(?SN_PUBCOMP, MsgId)) ->
io_lib:format("SN_PUBCOMP(MsgId=~w)", [MsgId]);
format(?SN_PUBREC_MSG(?SN_PUBREC, MsgId)) ->
@ -338,70 +397,110 @@ format(?SN_SUBSCRIBE_MSG(Flags, Msgid, Topic)) ->
#mqtt_sn_flags{
dup = Dup,
qos = QoS,
topic_id_type = TopicIdType} = Flags,
io_lib:format("SN_SUBSCRIBE(D~w, Q~w, TopicIdType=~w, MsgId=~w, "
topic_id_type = TopicIdType
} = Flags,
io_lib:format(
"SN_SUBSCRIBE(D~w, Q~w, TopicIdType=~w, MsgId=~w, "
"TopicId=~w)",
[bool(Dup), QoS, TopicIdType, Msgid, Topic]);
[bool(Dup), QoS, TopicIdType, Msgid, Topic]
);
format(?SN_SUBACK_MSG(Flags, TopicId, MsgId, ReturnCode)) ->
#mqtt_sn_flags{qos = QoS} = Flags,
io_lib:format("SN_SUBACK(GrantedQoS=~w, MsgId=~w, TopicId=~w, "
io_lib:format(
"SN_SUBACK(GrantedQoS=~w, MsgId=~w, TopicId=~w, "
"ReturnCode=~w)",
[QoS, MsgId, TopicId, ReturnCode]);
[QoS, MsgId, TopicId, ReturnCode]
);
format(?SN_UNSUBSCRIBE_MSG(Flags, Msgid, Topic)) ->
#mqtt_sn_flags{topic_id_type = TopicIdType} = Flags,
io_lib:format("SN_UNSUBSCRIBE(TopicIdType=~w, MsgId=~w, TopicId=~w)",
[TopicIdType, Msgid, Topic]);
io_lib:format(
"SN_UNSUBSCRIBE(TopicIdType=~w, MsgId=~w, TopicId=~w)",
[TopicIdType, Msgid, Topic]
);
format(?SN_UNSUBACK_MSG(MsgId)) ->
io_lib:format("SN_UNSUBACK(MsgId=~w)", [MsgId]);
format(?SN_REGISTER_MSG(TopicId, MsgId, TopicName)) ->
io_lib:format("SN_REGISTER(TopicId=~w, MsgId=~w, TopicName=~s)",
[TopicId, MsgId, TopicName]);
io_lib:format(
"SN_REGISTER(TopicId=~w, MsgId=~w, TopicName=~s)",
[TopicId, MsgId, TopicName]
);
format(?SN_REGACK_MSG(TopicId, MsgId, ReturnCode)) ->
io_lib:format("SN_REGACK(TopicId=~w, MsgId=~w, ReturnCode=~w)",
[TopicId, MsgId, ReturnCode]);
io_lib:format(
"SN_REGACK(TopicId=~w, MsgId=~w, ReturnCode=~w)",
[TopicId, MsgId, ReturnCode]
);
format(?SN_PINGREQ_MSG(ClientId)) ->
io_lib:format("SN_PINGREQ(ClientId=~s)", [ClientId]);
format(?SN_PINGRESP_MSG()) ->
"SN_PINGRESP()";
format(?SN_DISCONNECT_MSG(Duration)) ->
io_lib:format("SN_DISCONNECT(Duration=~w)", [Duration]);
format(#mqtt_sn_message{type = Type, variable = Var}) ->
io_lib:format("mqtt_sn_message(type=~s, Var=~w)",
[emqx_sn_frame:message_type(Type), Var]).
io_lib:format(
"mqtt_sn_message(type=~s, Var=~w)",
[emqx_sn_frame:message_type(Type), Var]
).
is_message(#mqtt_sn_message{type = Type})
when Type == ?SN_PUBLISH ->
is_message(#mqtt_sn_message{type = Type}) when
Type == ?SN_PUBLISH
->
true;
is_message(_) ->
false.
type(#mqtt_sn_message{type = Type}) ->
type(Type);
type(?SN_ADVERTISE) -> advertise;
type(?SN_SEARCHGW) -> serachgw;
type(?SN_GWINFO) -> gwinfo;
type(?SN_CONNECT) -> connect;
type(?SN_CONNACK) -> connack;
type(?SN_WILLTOPICREQ) -> willtopicreq;
type(?SN_WILLTOPIC) -> willtopic;
type(?SN_WILLMSGREQ) -> willmsgreq;
type(?SN_WILLMSG) -> willmsg;
type(?SN_REGISTER) -> register;
type(?SN_REGACK) -> regack;
type(?SN_PUBLISH) -> publish;
type(?SN_PUBACK) -> puback;
type(?SN_PUBCOMP) -> pubcomp;
type(?SN_PUBREC) -> pubrec;
type(?SN_PUBREL) -> pubrel;
type(?SN_SUBSCRIBE) -> subscribe;
type(?SN_SUBACK) -> suback;
type(?SN_UNSUBSCRIBE) -> unsubscribe;
type(?SN_UNSUBACK) -> unsuback;
type(?SN_PINGREQ) -> pingreq;
type(?SN_PINGRESP) -> pingresp;
type(?SN_DISCONNECT) -> disconnect;
type(?SN_WILLTOPICUPD) -> willtopicupd;
type(?SN_WILLTOPICRESP) -> willtopicresp;
type(?SN_WILLMSGUPD) -> willmsgupd;
type(?SN_WILLMSGRESP) -> willmsgresp.
type(?SN_ADVERTISE) ->
advertise;
type(?SN_SEARCHGW) ->
serachgw;
type(?SN_GWINFO) ->
gwinfo;
type(?SN_CONNECT) ->
connect;
type(?SN_CONNACK) ->
connack;
type(?SN_WILLTOPICREQ) ->
willtopicreq;
type(?SN_WILLTOPIC) ->
willtopic;
type(?SN_WILLMSGREQ) ->
willmsgreq;
type(?SN_WILLMSG) ->
willmsg;
type(?SN_REGISTER) ->
register;
type(?SN_REGACK) ->
regack;
type(?SN_PUBLISH) ->
publish;
type(?SN_PUBACK) ->
puback;
type(?SN_PUBCOMP) ->
pubcomp;
type(?SN_PUBREC) ->
pubrec;
type(?SN_PUBREL) ->
pubrel;
type(?SN_SUBSCRIBE) ->
subscribe;
type(?SN_SUBACK) ->
suback;
type(?SN_UNSUBSCRIBE) ->
unsubscribe;
type(?SN_UNSUBACK) ->
unsuback;
type(?SN_PINGREQ) ->
pingreq;
type(?SN_PINGRESP) ->
pingresp;
type(?SN_DISCONNECT) ->
disconnect;
type(?SN_WILLTOPICUPD) ->
willtopicupd;
type(?SN_WILLTOPICRESP) ->
willtopicresp;
type(?SN_WILLMSGUPD) ->
willmsgupd;
type(?SN_WILLMSGRESP) ->
willmsgresp.

75
apps/emqx_gateway/src/mqttsn/emqx_sn_impl.erl
View File

@ -21,20 +21,25 @@
-include_lib("emqx/include/logger.hrl").
-import(emqx_gateway_utils,
[ normalize_config/1
, start_listeners/4
, stop_listeners/2
]).
-import(
emqx_gateway_utils,
[
normalize_config/1,
start_listeners/4,
stop_listeners/2
]
).
%% APIs
-export([ reg/0
, unreg/0
-export([
reg/0,
unreg/0
]).
-export([ on_gateway_load/2
, on_gateway_update/3
, on_gateway_unload/2
-export([
on_gateway_load/2,
on_gateway_update/3,
on_gateway_unload/2
]).
%%--------------------------------------------------------------------
@ -42,8 +47,7 @@
%%--------------------------------------------------------------------
reg() ->
RegistryOptions = [ {cbkmod, ?MODULE}
],
RegistryOptions = [{cbkmod, ?MODULE}],
emqx_gateway_registry:reg(mqttsn, RegistryOptions).
unreg() ->
@ -53,10 +57,13 @@ unreg() ->
%% emqx_gateway_registry callbacks
%%--------------------------------------------------------------------
on_gateway_load(_Gateway = #{ name := GwName,
on_gateway_load(
_Gateway = #{
name := GwName,
config := Config
}, Ctx) ->
},
Ctx
) ->
%% We Also need to start `emqx_sn_broadcast` &
%% `emqx_sn_registry` process
case maps:get(broadcast, Config, false) of
@ -66,7 +73,8 @@ on_gateway_load(_Gateway = #{ name := GwName,
%% FIXME:
Port = 1884,
SnGwId = maps:get(gateway_id, Config, undefined),
_ = emqx_sn_broadcast:start_link(SnGwId, Port), ok
_ = emqx_sn_broadcast:start_link(SnGwId, Port),
ok
end,
PredefTopics = maps:get(predefined, Config, []),
@ -79,19 +87,26 @@ on_gateway_load(_Gateway = #{ name := GwName,
Listeners = emqx_gateway_utils:normalize_config(NConfig),
ModCfg = #{frame_mod => emqx_sn_frame,
ModCfg = #{
frame_mod => emqx_sn_frame,
chann_mod => emqx_sn_channel
},
case start_listeners(
Listeners, GwName, Ctx, ModCfg) of
case
start_listeners(
Listeners, GwName, Ctx, ModCfg
)
of
{ok, ListenerPids} ->
{ok, ListenerPids, _GwState = #{ctx => Ctx}};
{error, {Reason, Listener}} ->
throw({badconf, #{ key => listeners
, value => Listener
, reason => Reason
}})
throw(
{badconf, #{
key => listeners,
value => Listener,
reason => Reason
}}
)
end.
on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
@ -103,14 +118,20 @@ on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
on_gateway_load(Gateway#{config => Config}, Ctx)
catch
Class:Reason:Stk ->
logger:error("Failed to update ~ts; "
logger:error(
"Failed to update ~ts; "
"reason: {~0p, ~0p} stacktrace: ~0p",
[GwName, Class, Reason, Stk]),
[GwName, Class, Reason, Stk]
),
{error, Reason}
end.
on_gateway_unload(_Gateway = #{ name := GwName,
on_gateway_unload(
_Gateway = #{
name := GwName,
config := Config
}, _GwState) ->
},
_GwState
) ->
Listeners = normalize_config(Config),
stop_listeners(GwName, Listeners).

134
apps/emqx_gateway/src/mqttsn/emqx_sn_registry.erl
View File

@ -24,24 +24,26 @@
-include("src/mqttsn/include/emqx_sn.hrl").
-include_lib("emqx/include/logger.hrl").
-export([ start_link/2
-export([start_link/2]).
-export([
register_topic/3,
unregister_topic/2
]).
-export([ register_topic/3
, unregister_topic/2
]).
-export([ lookup_topic/3
, lookup_topic_id/3
-export([
lookup_topic/3,
lookup_topic_id/3
]).
%% gen_server callbacks
-export([ init/1
, handle_call/3
, handle_cast/2
, handle_info/2
, terminate/2
, code_change/3
-export([
init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3
]).
-export([lookup_name/1]).
@ -52,20 +54,19 @@
-record(emqx_sn_registry, {key, value}).
-type registry() :: {Tab :: atom(),
RegistryPid :: pid()}.
-type registry() :: {Tab :: atom(), RegistryPid :: pid()}.
%%-----------------------------------------------------------------------------
-spec start_link(atom(), list())
-> ignore
-spec start_link(atom(), list()) ->
ignore
| {ok, pid()}
| {error, Reason :: term()}.
start_link(InstaId, PredefTopics) ->
gen_server:start_link(?MODULE, [InstaId, PredefTopics], []).
-spec register_topic(registry(), emqx_types:clientid(), emqx_types:topic())
-> integer()
-spec register_topic(registry(), emqx_types:clientid(), emqx_types:topic()) ->
integer()
| {error, term()}.
register_topic({_, Pid}, ClientId, TopicName) when is_binary(TopicName) ->
case emqx_topic:wildcard(TopicName) of
@ -75,21 +76,23 @@ register_topic({_, Pid}, ClientId, TopicName) when is_binary(TopicName) ->
%% id by the gateway when sending PUBLISH messages to the client (not
%% relevant in case of subscriptions to a short topic name or to a topic
%% name which contains wildcard characters)
true -> {error, wildcard_topic}
true ->
{error, wildcard_topic}
end.
-spec lookup_topic(registry(), emqx_types:clientid(), pos_integer())
-> undefined
-spec lookup_topic(registry(), emqx_types:clientid(), pos_integer()) ->
undefined
| binary().
lookup_topic({Tab, _}, ClientId, TopicId) when is_integer(TopicId) ->
case lookup_element(Tab, {predef, TopicId}, 3) of
undefined ->
lookup_element(Tab, {ClientId, TopicId}, 3);
Topic -> Topic
Topic ->
Topic
end.
-spec lookup_topic_id(registry(), emqx_types:clientid(), emqx_types:topic())
-> undefined
-spec lookup_topic_id(registry(), emqx_types:clientid(), emqx_types:topic()) ->
undefined
| pos_integer()
| {predef, integer()}.
lookup_topic_id({Tab, _}, ClientId, TopicName) when is_binary(TopicName) ->
@ -102,7 +105,11 @@ lookup_topic_id({Tab, _}, ClientId, TopicName) when is_binary(TopicName) ->
%% @private
lookup_element(Tab, Key, Pos) ->
try ets:lookup_element(Tab, Key, Pos) catch error:badarg -> undefined end.
try
ets:lookup_element(Tab, Key, Pos)
catch
error:badarg -> undefined
end.
-spec unregister_topic(registry(), emqx_types:clientid()) -> ok.
unregister_topic({_, Pid}, ClientId) ->
@ -135,18 +142,27 @@ init([InstaId, PredefTopics]) ->
TopicName = iolist_to_binary(TopicName0),
mria:dirty_write(Tab, #emqx_sn_registry{
key = {predef, TopicId},
value = TopicName}
),
value = TopicName
}),
mria:dirty_write(Tab, #emqx_sn_registry{
key = {predef, TopicName},
value = TopicId}
value = TopicId
}),
if
TopicId > AccId -> TopicId;
true -> AccId
end
end,
0,
PredefTopics
),
if TopicId > AccId -> TopicId; true -> AccId end
end, 0, PredefTopics),
{ok, #state{tabname = Tab, max_predef_topic_id = MaxPredefId}}.
handle_call({register, ClientId, TopicName}, _From,
State = #state{tabname = Tab, max_predef_topic_id = PredefId}) ->
handle_call(
{register, ClientId, TopicName},
_From,
State = #state{tabname = Tab, max_predef_topic_id = PredefId}
) ->
case lookup_topic_id({Tab, self()}, ClientId, TopicName) of
{predef, PredefTopicId} when is_integer(PredefTopicId) ->
{reply, PredefTopicId, State};
@ -158,15 +174,30 @@ handle_call({register, ClientId, TopicName}, _From,
{reply, {error, too_large}, State};
TopicId ->
Fun = fun() ->
mnesia:write(Tab, #emqx_sn_registry{
mnesia:write(
Tab,
#emqx_sn_registry{
key = {ClientId, next_topic_id},
value = TopicId + 1}, write),
mnesia:write(Tab, #emqx_sn_registry{
value = TopicId + 1
},
write
),
mnesia:write(
Tab,
#emqx_sn_registry{
key = {ClientId, TopicName},
value = TopicId}, write),
mnesia:write(Tab, #emqx_sn_registry{
value = TopicId
},
write
),
mnesia:write(
Tab,
#emqx_sn_registry{
key = {ClientId, TopicId},
value = TopicName}, write)
value = TopicName
},
write
)
end,
case mria:transaction(?SN_SHARD, Fun) of
{atomic, ok} ->
@ -176,35 +207,38 @@ handle_call({register, ClientId, TopicName}, _From,
end
end
end;
handle_call({unregister, ClientId}, _From, State = #state{tabname = Tab}) ->
Registry = mnesia:dirty_match_object(
Tab,
{emqx_sn_registry, {ClientId, '_'}, '_'}
),
lists:foreach(fun(R) ->
lists:foreach(
fun(R) ->
mria:dirty_delete_object(Tab, R)
end, Registry),
end,
Registry
),
{reply, ok, State};
handle_call(name, _From, State = #state{tabname = Tab}) ->
{reply, {Tab, self()}, State};
handle_call(Req, _From, State) ->
?SLOG(error, #{ msg => "unexpected_call"
, call => Req
?SLOG(error, #{
msg => "unexpected_call",
call => Req
}),
{reply, ignored, State}.
handle_cast(Msg, State) ->
?SLOG(error, #{ msg => "unexpected_cast"
, cast => Msg
?SLOG(error, #{
msg => "unexpected_cast",
cast => Msg
}),
{noreply, State}.
handle_info(Info, State) ->
?SLOG(error, #{ msg => "unexpected_info"
, info => Info
?SLOG(error, #{
msg => "unexpected_info",
info => Info
}),
{noreply, State}.

196
apps/emqx_gateway/src/mqttsn/include/emqx_sn.hrl
View File

@ -14,7 +14,6 @@
%% limitations under the License.
%%--------------------------------------------------------------------
%%--------------------------------------------------------------------
%% MQTT-SN Types
%%--------------------------------------------------------------------
@ -47,7 +46,7 @@
-define(SN_WILLMSGUPD, 16#1C).
-define(SN_WILLMSGRESP, 16#1D).
-type(mqtt_sn_type() :: ?SN_ADVERTISE..?SN_WILLMSGRESP).
-type mqtt_sn_type() :: ?SN_ADVERTISE..?SN_WILLMSGRESP.
-define(SN_RC_ACCEPTED, 16#00).
-define(SN_RC_CONGESTION, 16#01).
@ -62,137 +61,162 @@
-define(QOS_NEG1, 3).
-type(mqtt_sn_return_code() :: ?SN_RC_ACCEPTED .. ?SN_RC2_EXCEED_LIMITATION).
-type mqtt_sn_return_code() :: ?SN_RC_ACCEPTED..?SN_RC2_EXCEED_LIMITATION.
%%--------------------------------------------------------------------
%% MQTT-SN Message
%%--------------------------------------------------------------------
-record(mqtt_sn_flags, {dup = false,
-record(mqtt_sn_flags, {
dup = false,
qos = 0,
retain = false,
will = false,
clean_start = false,
topic_id_type = 0}).
topic_id_type = 0
}).
-type(mqtt_sn_flags() :: #mqtt_sn_flags{}).
-type mqtt_sn_flags() :: #mqtt_sn_flags{}.
-type(mqtt_sn_variable() :: undefined | integer() | binary() | tuple()).
-type mqtt_sn_variable() :: undefined | integer() | binary() | tuple().
-record(mqtt_sn_message, {type :: mqtt_sn_type(),
variable :: mqtt_sn_variable()}).
-record(mqtt_sn_message, {
type :: mqtt_sn_type(),
variable :: mqtt_sn_variable()
}).
-type(mqtt_sn_message() :: #mqtt_sn_message{}).
-type mqtt_sn_message() :: #mqtt_sn_message{}.
-define(SN_ADVERTISE_MSG(GwId, Duration),
#mqtt_sn_message{type = ?SN_ADVERTISE,
variable = {GwId, Duration}}).
-define(SN_ADVERTISE_MSG(GwId, Duration), #mqtt_sn_message{
type = ?SN_ADVERTISE,
variable = {GwId, Duration}
}).
-define(SN_SEARCHGW_MSG(Radius),
#mqtt_sn_message{type = ?SN_SEARCHGW,
variable = Radius}).
-define(SN_SEARCHGW_MSG(Radius), #mqtt_sn_message{
type = ?SN_SEARCHGW,
variable = Radius
}).
-define(SN_GWINFO_MSG(GwId, GwAddr),
#mqtt_sn_message{type = ?SN_GWINFO,
variable = {GwId, GwAddr}}).
-define(SN_GWINFO_MSG(GwId, GwAddr), #mqtt_sn_message{
type = ?SN_GWINFO,
variable = {GwId, GwAddr}
}).
-define(SN_CONNECT_MSG(Flags, ProtocolId, Duration, ClientId),
#mqtt_sn_message{type = ?SN_CONNECT,
variable = {Flags, ProtocolId, Duration, ClientId}}).
-define(SN_CONNECT_MSG(Flags, ProtocolId, Duration, ClientId), #mqtt_sn_message{
type = ?SN_CONNECT,
variable = {Flags, ProtocolId, Duration, ClientId}
}).
-define(SN_CONNACK_MSG(ReturnCode),
#mqtt_sn_message{type = ?SN_CONNACK, variable = ReturnCode}).
-define(SN_CONNACK_MSG(ReturnCode), #mqtt_sn_message{type = ?SN_CONNACK, variable = ReturnCode}).
-define(SN_WILLTOPICREQ_MSG(),
#mqtt_sn_message{type = ?SN_WILLTOPICREQ}).
-define(SN_WILLTOPICREQ_MSG(), #mqtt_sn_message{type = ?SN_WILLTOPICREQ}).
-define(SN_WILLTOPIC_MSG(Flags, Topic),
#mqtt_sn_message{type = ?SN_WILLTOPIC,
variable = {Flags, Topic}}).
-define(SN_WILLTOPIC_MSG(Flags, Topic), #mqtt_sn_message{
type = ?SN_WILLTOPIC,
variable = {Flags, Topic}
}).
-define(SN_WILLTOPIC_EMPTY_MSG,
#mqtt_sn_message{type = ?SN_WILLTOPIC,
variable = undefined}).
-define(SN_WILLTOPIC_EMPTY_MSG, #mqtt_sn_message{
type = ?SN_WILLTOPIC,
variable = undefined
}).
-define(SN_WILLMSGREQ_MSG(),
#mqtt_sn_message{type = ?SN_WILLMSGREQ}).
-define(SN_WILLMSGREQ_MSG(), #mqtt_sn_message{type = ?SN_WILLMSGREQ}).
-define(SN_WILLMSG_MSG(Msg),
#mqtt_sn_message{type = ?SN_WILLMSG, variable = Msg}).
-define(SN_WILLMSG_MSG(Msg), #mqtt_sn_message{type = ?SN_WILLMSG, variable = Msg}).
-define(SN_REGISTER_MSG(TopicId, MsgId, TopicName),
#mqtt_sn_message{type = ?SN_REGISTER,
variable = {TopicId, MsgId, TopicName}}).
-define(SN_REGISTER_MSG(TopicId, MsgId, TopicName), #mqtt_sn_message{
type = ?SN_REGISTER,
variable = {TopicId, MsgId, TopicName}
}).
-define(SN_REGACK_MSG(TopicId, MsgId, ReturnCode),
#mqtt_sn_message{type = ?SN_REGACK,
variable = {TopicId, MsgId, ReturnCode}}).
-define(SN_REGACK_MSG(TopicId, MsgId, ReturnCode), #mqtt_sn_message{
type = ?SN_REGACK,
variable = {TopicId, MsgId, ReturnCode}
}).
-define(SN_PUBLISH_MSG(Flags, TopicId, MsgId, Data),
#mqtt_sn_message{type = ?SN_PUBLISH,
variable = {Flags, TopicId, MsgId, Data}}).
-define(SN_PUBLISH_MSG(Flags, TopicId, MsgId, Data), #mqtt_sn_message{
type = ?SN_PUBLISH,
variable = {Flags, TopicId, MsgId, Data}
}).
-define(SN_PUBACK_MSG(TopicId, MsgId, ReturnCode),
#mqtt_sn_message{type = ?SN_PUBACK,
variable = {TopicId, MsgId, ReturnCode}}).
-define(SN_PUBACK_MSG(TopicId, MsgId, ReturnCode), #mqtt_sn_message{
type = ?SN_PUBACK,
variable = {TopicId, MsgId, ReturnCode}
}).
%% Type: SN_PUBREC | SN_PUBREL | SN_PUBCOMP
-define(SN_PUBREC_MSG(Type, MsgId),
#mqtt_sn_message{type = Type,
variable = MsgId}).
-define(SN_PUBREC_MSG(Type, MsgId), #mqtt_sn_message{
type = Type,
variable = MsgId
}).
-define(SN_SUBSCRIBE_MSG(Flags, MsgId, Topic),
#mqtt_sn_message{type = ?SN_SUBSCRIBE,
variable = {Flags, MsgId, Topic}}).
-define(SN_SUBSCRIBE_MSG(Flags, MsgId, Topic), #mqtt_sn_message{
type = ?SN_SUBSCRIBE,
variable = {Flags, MsgId, Topic}
}).
-define(SN_SUBSCRIBE_MSG_TYPE(Type, Topic, QoS),
#mqtt_sn_message{type = ?SN_SUBSCRIBE,
-define(SN_SUBSCRIBE_MSG_TYPE(Type, Topic, QoS), #mqtt_sn_message{
type = ?SN_SUBSCRIBE,
variable = {
#mqtt_sn_flags{qos = QoS, topic_id_type = Type},
_, Topic}}).
_,
Topic
}
}).
-define(SN_SUBACK_MSG(Flags, TopicId, MsgId, ReturnCode),
#mqtt_sn_message{type = ?SN_SUBACK,
variable = {Flags, TopicId, MsgId, ReturnCode}}).
-define(SN_SUBACK_MSG(Flags, TopicId, MsgId, ReturnCode), #mqtt_sn_message{
type = ?SN_SUBACK,
variable = {Flags, TopicId, MsgId, ReturnCode}
}).
-define(SN_UNSUBSCRIBE_MSG(Flags, MsgId, Topic),
#mqtt_sn_message{type = ?SN_UNSUBSCRIBE,
variable = {Flags, MsgId, Topic}}).
-define(SN_UNSUBSCRIBE_MSG(Flags, MsgId, Topic), #mqtt_sn_message{
type = ?SN_UNSUBSCRIBE,
variable = {Flags, MsgId, Topic}
}).
-define(SN_UNSUBSCRIBE_MSG_TYPE(Type, Topic),
#mqtt_sn_message{type = ?SN_UNSUBSCRIBE,
-define(SN_UNSUBSCRIBE_MSG_TYPE(Type, Topic), #mqtt_sn_message{
type = ?SN_UNSUBSCRIBE,
variable = {
#mqtt_sn_flags{topic_id_type = Type},
_, Topic}}).
_,
Topic
}
}).
-define(SN_UNSUBACK_MSG(MsgId),
#mqtt_sn_message{type = ?SN_UNSUBACK,
variable = MsgId}).
-define(SN_UNSUBACK_MSG(MsgId), #mqtt_sn_message{
type = ?SN_UNSUBACK,
variable = MsgId
}).
-define(SN_PINGREQ_MSG(ClientId),
#mqtt_sn_message{type = ?SN_PINGREQ, variable = ClientId}).
-define(SN_PINGREQ_MSG(ClientId), #mqtt_sn_message{type = ?SN_PINGREQ, variable = ClientId}).
-define(SN_PINGRESP_MSG(), #mqtt_sn_message{type = ?SN_PINGRESP}).
-define(SN_DISCONNECT_MSG(Duration),
#mqtt_sn_message{type = ?SN_DISCONNECT,
variable = Duration}).
-define(SN_DISCONNECT_MSG(Duration), #mqtt_sn_message{
type = ?SN_DISCONNECT,
variable = Duration
}).
-define(SN_WILLTOPICUPD_MSG(Flags, Topic),
#mqtt_sn_message{type = ?SN_WILLTOPICUPD,
variable = {Flags, Topic}}).
-define(SN_WILLTOPICUPD_MSG(Flags, Topic), #mqtt_sn_message{
type = ?SN_WILLTOPICUPD,
variable = {Flags, Topic}
}).
-define(SN_WILLTOPICRESP_MSG(ReturnCode),
#mqtt_sn_message{type = ?SN_WILLTOPICRESP,
variable = ReturnCode}).
-define(SN_WILLTOPICRESP_MSG(ReturnCode), #mqtt_sn_message{
type = ?SN_WILLTOPICRESP,
variable = ReturnCode
}).
-define(SN_WILLMSGUPD_MSG(Msg),
#mqtt_sn_message{type = ?SN_WILLMSGUPD,
variable = Msg}).
-define(SN_WILLMSGUPD_MSG(Msg), #mqtt_sn_message{
type = ?SN_WILLMSGUPD,
variable = Msg
}).
-define(SN_WILLMSGRESP_MSG(ReturnCode),
#mqtt_sn_message{type = ?SN_WILLMSGRESP,
variable = ReturnCode}).
-define(SN_WILLMSGRESP_MSG(ReturnCode), #mqtt_sn_message{
type = ?SN_WILLMSGRESP,
variable = ReturnCode
}).
-define(SN_NORMAL_TOPIC, 0).
-define(SN_PREDEFINED_TOPIC, 1).

115
apps/emqx_gateway/src/proto/emqx_gateway_cm_proto_v1.erl
View File

@ -18,19 +18,20 @@
-behaviour(emqx_bpapi).
-export([ introduced_in/0
-export([
introduced_in/0,
, get_chan_info/3
, set_chan_info/4
, get_chan_stats/3
, set_chan_stats/4
, kick_session/4
, get_chann_conn_mod/3
, lookup_by_clientid/3
, takeover_session/3
, call/4
, call/5
, cast/4
get_chan_info/3,
set_chan_info/4,
get_chan_stats/3,
set_chan_stats/4,
kick_session/4,
get_chann_conn_mod/3,
lookup_by_clientid/3,
takeover_session/3,
call/4,
call/5,
cast/4
]).
-include_lib("emqx/include/bpapi.hrl").
@ -43,71 +44,103 @@ introduced_in() ->
lookup_by_clientid(Nodes, GwName, ClientId) ->
rpc:multicall(Nodes, emqx_gateway_cm, do_lookup_by_clientid, [GwName, ClientId]).
-spec get_chan_info(emqx_gateway_cm:gateway_name(), emqx_types:clientid(), pid())
-> emqx_types:infos() | undefined | {badrpc, _}.
-spec get_chan_info(emqx_gateway_cm:gateway_name(), emqx_types:clientid(), pid()) ->
emqx_types:infos() | undefined | {badrpc, _}.
get_chan_info(GwName, ClientId, ChanPid) ->
rpc:call(node(ChanPid), emqx_gateway_cm, do_get_chan_info, [GwName, ClientId, ChanPid]).
-spec set_chan_info(emqx_gateway_cm:gateway_name(),
-spec set_chan_info(
emqx_gateway_cm:gateway_name(),
emqx_types:clientid(),
pid(),
emqx_types:infos()) -> boolean() | {badrpc, _}.
emqx_types:infos()
) -> boolean() | {badrpc, _}.
set_chan_info(GwName, ClientId, ChanPid, Infos) ->
rpc:call(node(ChanPid), emqx_gateway_cm, do_set_chan_info, [GwName, ClientId, ChanPid, Infos]).
-spec get_chan_stats(emqx_gateway_cm:gateway_name(), emqx_types:clientid(), pid())
-> emqx_types:stats() | undefined | {badrpc, _}.
-spec get_chan_stats(emqx_gateway_cm:gateway_name(), emqx_types:clientid(), pid()) ->
emqx_types:stats() | undefined | {badrpc, _}.
get_chan_stats(GwName, ClientId, ChanPid) ->
rpc:call(node(ChanPid), emqx_gateway_cm, do_get_chan_stats, [GwName, ClientId, ChanPid]).
-spec set_chan_stats(emqx_gateway_cm:gateway_name(),
-spec set_chan_stats(
emqx_gateway_cm:gateway_name(),
emqx_types:clientid(),
pid(),
emqx_types:stats()) -> boolean() | {badrpc, _}.
emqx_types:stats()
) -> boolean() | {badrpc, _}.
set_chan_stats(GwName, ClientId, ChanPid, Stats) ->
rpc:call(node(ChanPid), emqx_gateway_cm, do_set_chan_stats, [GwName, ClientId, ChanPid, Stats]).
-spec kick_session(emqx_gateway_cm:gateway_name(),
-spec kick_session(
emqx_gateway_cm:gateway_name(),
kick | discard,
emqx_types:clientid(), pid()) -> _.
emqx_types:clientid(),
pid()
) -> _.
kick_session(GwName, Action, ClientId, ChanPid) ->
rpc:call(node(ChanPid),
emqx_gateway_cm, do_kick_session,
[GwName, Action, ClientId, ChanPid]).
rpc:call(
node(ChanPid),
emqx_gateway_cm,
do_kick_session,
[GwName, Action, ClientId, ChanPid]
).
-spec get_chann_conn_mod(emqx_gateway_cm:gateway_name(),
-spec get_chann_conn_mod(
emqx_gateway_cm:gateway_name(),
emqx_types:clientid(),
pid()) -> atom() | {badrpc, _}.
pid()
) -> atom() | {badrpc, _}.
get_chann_conn_mod(GwName, ClientId, ChanPid) ->
rpc:call(node(ChanPid), emqx_gateway_cm, do_get_chann_conn_mod,
[GwName, ClientId, ChanPid]).
rpc:call(
node(ChanPid),
emqx_gateway_cm,
do_get_chann_conn_mod,
[GwName, ClientId, ChanPid]
).
-spec takeover_session(emqx_gateway_cm:gateway_name(),
-spec takeover_session(
emqx_gateway_cm:gateway_name(),
emqx_types:clientid(),
pid()) -> boolean() | {badrpc, _}.
pid()
) -> boolean() | {badrpc, _}.
takeover_session(GwName, ClientId, ChanPid) ->
rpc:call(node(ChanPid), emqx_gateway_cm, do_takeover_session, [GwName, ClientId, ChanPid]).
-spec call(emqx_gateway_cm:gateway_name(),
-spec call(
emqx_gateway_cm:gateway_name(),
emqx_types:clientid(),
pid(),
term(),
timeout()) -> term() | {badrpc, _}.
timeout()
) -> term() | {badrpc, _}.
call(GwName, ClientId, ChanPid, Req, Timeout) ->
rpc:call(node(ChanPid), emqx_gateway_cm, do_call,
[GwName, ClientId, ChanPid, Req, Timeout]).
rpc:call(
node(ChanPid),
emqx_gateway_cm,
do_call,
[GwName, ClientId, ChanPid, Req, Timeout]
).
-spec call(emqx_gateway_cm:gateway_name(),
-spec call(
emqx_gateway_cm:gateway_name(),
emqx_types:clientid(),
pid(),
term()) -> term() | {badrpc, _}.
term()
) -> term() | {badrpc, _}.
call(GwName, ClientId, ChanPid, Req) ->
rpc:call(node(ChanPid), emqx_gateway_cm, do_call,
[GwName, ClientId, ChanPid, Req]).
rpc:call(
node(ChanPid),
emqx_gateway_cm,
do_call,
[GwName, ClientId, ChanPid, Req]
).
-spec cast(emqx_gateway_cm:gateway_name(),
-spec cast(
emqx_gateway_cm:gateway_name(),
emqx_types:clientid(),
pid(),
term()) -> term() | {badrpc, _}.
term()
) -> term() | {badrpc, _}.
cast(GwName, ClientId, ChanPid, Req) ->
rpc:call(node(ChanPid), emqx_gateway_cm, do_cast, [GwName, ClientId, ChanPid, Req]).

762
apps/emqx_gateway/src/stomp/emqx_stomp_channel.erl
View File

File diff suppressed because it is too large Load Diff

185
apps/emqx_gateway/src/stomp/emqx_stomp_frame.erl
View File

@ -72,20 +72,23 @@
-include("src/stomp/include/emqx_stomp.hrl").
-export([ initial_parse_state/1
, parse/2
, serialize_opts/0
, serialize_pkt/2
-export([
initial_parse_state/1,
parse/2,
serialize_opts/0,
serialize_pkt/2
]).
-export([ make/1
, make/2
, make/3
, format/1
-export([
make/1,
make/2,
make/3,
format/1
]).
-export([ type/1
, is_message/1
-export([
type/1,
is_message/1
]).
-define(NULL, 0).
@ -96,22 +99,26 @@
-define(IS_ESC(Ch), Ch == ?CR; Ch == ?LF; Ch == ?BSL; Ch == ?COLON).
-record(parser_state, {cmd,
-record(parser_state, {
cmd,
headers = [],
hdname,
acc = <<>> :: binary(),
limit}).
limit
}).
-record(frame_limit, {max_header_num, max_header_length, max_body_length}).
-type(parse_result() :: {ok, stomp_frame(), binary(), parse_state()}
| {more, parse_state()}).
-type parse_result() ::
{ok, stomp_frame(), binary(), parse_state()}
| {more, parse_state()}.
-type(parse_state() ::
#{phase := none | command | headers | hdname | hdvalue | body,
-type parse_state() ::
#{
phase := none | command | headers | hdname | hdvalue | body,
pre => binary(),
state := #parser_state{}
}).
}.
%-dialyzer({nowarn_function, [serialize_pkt/2,make/1]}).
@ -133,14 +140,12 @@ g(Key, Opts, Val) ->
-spec parse(binary(), parse_state()) -> parse_result().
parse(<<>>, Parser) ->
{more, Parser};
parse(Bytes, #{phase := body, length := Len, state := State}) ->
parse(body, Bytes, State, Len);
parse(<<?LF, Bytes/binary>>, #{phase := hdname, state := State}) ->
parse(body, Bytes, State, content_len(State));
parse(Bytes, #{phase := Phase, state := State}) when Phase =/= none ->
parse(Phase, Bytes, State);
parse(Bytes, Parser = #{pre := Pre}) ->
parse(<<Pre/binary, Bytes/binary>>, maps:without([pre], Parser));
parse(<<?CR, ?LF, Rest/binary>>, #{phase := Phase, state := State}) ->
@ -149,15 +154,19 @@ parse(<<?CR>>, Parser) ->
{more, Parser#{pre => <<?CR>>}};
parse(<<?CR, _Ch:8, _Rest/binary>>, _Parser) ->
error(linefeed_expected);
parse(<<?BSL>>, Parser = #{phase := Phase}) when Phase =:= hdname;
Phase =:= hdvalue ->
parse(<<?BSL>>, Parser = #{phase := Phase}) when
Phase =:= hdname;
Phase =:= hdvalue
->
{more, Parser#{pre => <<?BSL>>}};
parse(<<?BSL, Ch:8, Rest/binary>>,
#{phase := Phase, state := State}) when Phase =:= hdname;
Phase =:= hdvalue ->
parse(
<<?BSL, Ch:8, Rest/binary>>,
#{phase := Phase, state := State}
) when
Phase =:= hdname;
Phase =:= hdvalue
->
parse(Phase, Rest, acc(unescape(Ch), State));
parse(<<?LF>>, Parser = #{phase := none}) ->
{more, Parser};
parse(Bytes, #{phase := none, state := State}) ->
@ -170,12 +179,10 @@ parse(command, <<Ch:8, Rest/binary>>, State) ->
parse(command, Rest, acc(Ch, State));
parse(command, <<>>, State) ->
{more, #{phase => command, state => State}};
parse(headers, <<?LF, Rest/binary>>, State) ->
parse(body, Rest, State, content_len(State#parser_state{acc = <<>>}));
parse(headers, Bin, State) ->
parse(hdname, Bin, State);
parse(hdname, <<?LF, _Rest/binary>>, _State) ->
error(unexpected_linefeed);
parse(hdname, <<?COLON, Rest/binary>>, State = #parser_state{acc = Acc}) ->
@ -184,10 +191,13 @@ parse(hdname, <<Ch:8, Rest/binary>>, State) ->
parse(hdname, Rest, acc(Ch, State));
parse(hdname, <<>>, State) ->
{more, #{phase => hdname, state => State}};
parse(hdvalue, <<?LF, Rest/binary>>,
State = #parser_state{headers = Headers, hdname = Name, acc = Acc}) ->
NState = State#parser_state{headers = add_header(Name, Acc, Headers),
parse(
hdvalue,
<<?LF, Rest/binary>>,
State = #parser_state{headers = Headers, hdname = Name, acc = Acc}
) ->
NState = State#parser_state{
headers = add_header(Name, Acc, Headers),
hdname = undefined,
acc = <<>>
},
@ -205,17 +215,21 @@ parse(body, Bin, State, none) ->
[Chunk, Rest] ->
{ok, new_frame(acc(Chunk, State)), Rest, new_state(State)};
[Chunk] ->
{more, #{phase => body,
{more, #{
phase => body,
length => none,
state => acc(Chunk, State)}}
state => acc(Chunk, State)
}}
end;
parse(body, Bin, State, Len) when byte_size(Bin) >= (Len + 1) ->
<<Chunk:Len/binary, ?NULL, Rest/binary>> = Bin,
{ok, new_frame(acc(Chunk, State)), Rest, new_state(State)};
parse(body, Bin, State, Len) ->
{more, #{phase => body,
{more, #{
phase => body,
length => Len - byte_size(Bin),
state => acc(Bin, State)}}.
state => acc(Bin, State)
}}.
add_header(Name, Value, Headers) ->
case lists:keyfind(Name, 1, Headers) of
@ -256,19 +270,24 @@ serialize_opts() ->
serialize_pkt(#stomp_frame{command = ?CMD_HEARTBEAT}, _SerializeOpts) ->
<<$\n>>;
serialize_pkt(#stomp_frame{command = Cmd, headers = Headers, body = Body},
_SerializeOpts) ->
serialize_pkt(
#stomp_frame{command = Cmd, headers = Headers, body = Body},
_SerializeOpts
) ->
Headers1 = lists:keydelete(<<"content-length">>, 1, Headers),
Headers2 =
case iolist_size(Body) of
0 -> Headers1;
Len -> Headers1 ++ [{<<"content-length">>, Len}]
end,
[Cmd,
?LF, [serialize_pkt(header, Header) || Header <- Headers2],
?LF, Body, 0];
[
Cmd,
?LF,
[serialize_pkt(header, Header) || Header <- Headers2],
?LF,
Body,
0
];
serialize_pkt(header, {Name, Val}) when is_integer(Val) ->
[escape(Name), ?COLON, integer_to_list(Val), ?LF];
serialize_pkt(header, {Name, Val}) ->
@ -276,11 +295,16 @@ serialize_pkt(header, {Name, Val}) ->
escape(Bin) when is_binary(Bin) ->
<<<<(escape(Ch))/binary>> || <<Ch>> <= Bin>>;
escape(?CR) -> <<?BSL, $r>>;
escape(?LF) -> <<?BSL, $n>>;
escape(?BSL) -> <<?BSL, ?BSL>>;
escape(?COLON) -> <<?BSL, $c>>;
escape(Ch) -> <<Ch>>.
escape(?CR) ->
<<?BSL, $r>>;
escape(?LF) ->
<<?BSL, $n>>;
escape(?BSL) ->
<<?BSL, ?BSL>>;
escape(?COLON) ->
<<?BSL, $c>>;
escape(Ch) ->
<<Ch>>.
new_state(#parser_state{limit = Limit}) ->
#{phase => none, state => #parser_state{limit = Limit}}.
@ -295,9 +319,10 @@ make(?CMD_HEARTBEAT) ->
#stomp_frame{command = ?CMD_HEARTBEAT}.
make(<<"CONNECTED">>, Headers) ->
#stomp_frame{command = <<"CONNECTED">>,
headers = [{<<"server">>, ?STOMP_SERVER} | Headers]};
#stomp_frame{
command = <<"CONNECTED">>,
headers = [{<<"server">>, ?STOMP_SERVER} | Headers]
};
make(Command, Headers) ->
#stomp_frame{command = Command, headers = Headers}.
@ -307,27 +332,45 @@ make(Command, Headers, Body) ->
%% @doc Format a frame
format(Frame) -> serialize_pkt(Frame, #{}).
is_message(#stomp_frame{command = CMD})
when CMD == ?CMD_SEND;
CMD == ?CMD_MESSAGE ->
is_message(#stomp_frame{command = CMD}) when
CMD == ?CMD_SEND;
CMD == ?CMD_MESSAGE
->
true;
is_message(_) -> false.
is_message(_) ->
false.
type(#stomp_frame{command = CMD}) ->
type(CMD);
type(?CMD_STOMP) -> connect;
type(?CMD_CONNECT) -> connect;
type(?CMD_SEND) -> send;
type(?CMD_SUBSCRIBE) -> subscribe;
type(?CMD_UNSUBSCRIBE) -> unsubscribe;
type(?CMD_BEGIN) -> 'begin';
type(?CMD_COMMIT) -> commit;
type(?CMD_ABORT) -> abort;
type(?CMD_ACK) -> ack;
type(?CMD_NACK) -> nack;
type(?CMD_DISCONNECT) -> disconnect;
type(?CMD_CONNECTED) -> connected;
type(?CMD_MESSAGE) -> message;
type(?CMD_RECEIPT) -> receipt;
type(?CMD_ERROR) -> error;
type(?CMD_HEARTBEAT) -> heartbeat.
type(?CMD_STOMP) ->
connect;
type(?CMD_CONNECT) ->
connect;
type(?CMD_SEND) ->
send;
type(?CMD_SUBSCRIBE) ->
subscribe;
type(?CMD_UNSUBSCRIBE) ->
unsubscribe;
type(?CMD_BEGIN) ->
'begin';
type(?CMD_COMMIT) ->
commit;
type(?CMD_ABORT) ->
abort;
type(?CMD_ACK) ->
ack;
type(?CMD_NACK) ->
nack;
type(?CMD_DISCONNECT) ->
disconnect;
type(?CMD_CONNECTED) ->
connected;
type(?CMD_MESSAGE) ->
message;
type(?CMD_RECEIPT) ->
receipt;
type(?CMD_ERROR) ->
error;
type(?CMD_HEARTBEAT) ->
heartbeat.

60
apps/emqx_gateway/src/stomp/emqx_stomp_heartbeat.erl
View File

@ -19,18 +19,20 @@
-include("src/stomp/include/emqx_stomp.hrl").
-export([ init/1
, check/3
, reset/3
, info/1
, interval/2
-export([
init/1,
check/3,
reset/3,
info/1,
interval/2
]).
-record(heartbeater, {interval, statval, repeat}).
-type name() :: incoming | outgoing.
-type heartbeat() :: #{incoming => #heartbeater{},
-type heartbeat() :: #{
incoming => #heartbeater{},
outgoing => #heartbeater{}
}.
@ -42,10 +44,13 @@
init({0, 0}) ->
#{};
init({Cx, Cy}) ->
maps:filter(fun(_, V) -> V /= undefined end,
#{incoming => heartbeater(Cx),
maps:filter(
fun(_, V) -> V /= undefined end,
#{
incoming => heartbeater(Cx),
outgoing => heartbeater(Cy)
}).
}
).
heartbeater(0) ->
undefined;
@ -56,29 +61,34 @@ heartbeater(I) ->
repeat = 0
}.
-spec check(name(), pos_integer(), heartbeat())
-> {ok, heartbeat()}
-spec check(name(), pos_integer(), heartbeat()) ->
{ok, heartbeat()}
| {error, timeout}.
check(Name, NewVal, HrtBt) ->
HrtBter = maps:get(Name, HrtBt),
case check(NewVal, HrtBter) of
{error, _} = R -> R;
{ok, NHrtBter} ->
{ok, HrtBt#{Name => NHrtBter}}
{ok, NHrtBter} -> {ok, HrtBt#{Name => NHrtBter}}
end.
check(NewVal, HrtBter = #heartbeater{statval = OldVal,
repeat = Repeat}) ->
check(
NewVal,
HrtBter = #heartbeater{
statval = OldVal,
repeat = Repeat
}
) ->
if
NewVal =/= OldVal ->
{ok, HrtBter#heartbeater{statval = NewVal, repeat = 0}};
Repeat < 1 ->
{ok, HrtBter#heartbeater{repeat = Repeat + 1}};
true -> {error, timeout}
true ->
{error, timeout}
end.
-spec reset(name(), pos_integer(), heartbeat())
-> heartbeat().
-spec reset(name(), pos_integer(), heartbeat()) ->
heartbeat().
reset(Name, NewVal, HrtBt) ->
HrtBter = maps:get(Name, HrtBt),
HrtBt#{Name => reset(NewVal, HrtBter)}.
@ -88,11 +98,19 @@ reset(NewVal, HrtBter) ->
-spec info(heartbeat()) -> map().
info(HrtBt) ->
maps:map(fun(_, #heartbeater{interval = Intv,
maps:map(
fun(
_,
#heartbeater{
interval = Intv,
statval = Val,
repeat = Repeat}) ->
repeat = Repeat
}
) ->
#{interval => Intv, statval => Val, repeat => Repeat}
end, HrtBt).
end,
HrtBt
).
interval(Type, HrtBt) ->
case maps:get(Type, HrtBt, undefined) of

71
apps/emqx_gateway/src/stomp/emqx_stomp_impl.erl
View File

@ -21,20 +21,25 @@
-include_lib("emqx/include/logger.hrl").
-include_lib("emqx_gateway/include/emqx_gateway.hrl").
-import(emqx_gateway_utils,
[ normalize_config/1
, start_listeners/4
, stop_listeners/2
]).
-import(
emqx_gateway_utils,
[
normalize_config/1,
start_listeners/4,
stop_listeners/2
]
).
%% APIs
-export([ reg/0
, unreg/0
-export([
reg/0,
unreg/0
]).
-export([ on_gateway_load/2
, on_gateway_update/3
, on_gateway_unload/2
-export([
on_gateway_load/2,
on_gateway_update/3,
on_gateway_unload/2
]).
%%--------------------------------------------------------------------
@ -43,8 +48,7 @@
-spec reg() -> ok | {error, any()}.
reg() ->
RegistryOptions = [ {cbkmod, ?MODULE}
],
RegistryOptions = [{cbkmod, ?MODULE}],
emqx_gateway_registry:reg(stomp, RegistryOptions).
-spec unreg() -> ok | {error, any()}.
@ -55,24 +59,35 @@ unreg() ->
%% emqx_gateway_registry callbacks
%%--------------------------------------------------------------------
on_gateway_load(_Gateway = #{ name := GwName,
on_gateway_load(
_Gateway = #{
name := GwName,
config := Config
}, Ctx) ->
},
Ctx
) ->
Listeners = normalize_config(Config),
ModCfg = #{frame_mod => emqx_stomp_frame,
ModCfg = #{
frame_mod => emqx_stomp_frame,
chann_mod => emqx_stomp_channel
},
case start_listeners(
Listeners, GwName, Ctx, ModCfg) of
case
start_listeners(
Listeners, GwName, Ctx, ModCfg
)
of
{ok, ListenerPids} ->
%% FIXME: How to throw an exception to interrupt the restart logic ?
%% FIXME: Assign ctx to GwState
{ok, ListenerPids, _GwState = #{ctx => Ctx}};
{error, {Reason, Listener}} ->
throw({badconf, #{ key => listeners
, vallue => Listener
, reason => Reason
}})
throw(
{badconf, #{
key => listeners,
vallue => Listener,
reason => Reason
}}
)
end.
on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
@ -84,14 +99,20 @@ on_gateway_update(Config, Gateway, GwState = #{ctx := Ctx}) ->
on_gateway_load(Gateway#{config => Config}, Ctx)
catch
Class:Reason:Stk ->
logger:error("Failed to update ~ts; "
logger:error(
"Failed to update ~ts; "
"reason: {~0p, ~0p} stacktrace: ~0p",
[GwName, Class, Reason, Stk]),
[GwName, Class, Reason, Stk]
),
{error, Reason}
end.
on_gateway_unload(_Gateway = #{ name := GwName,
on_gateway_unload(
_Gateway = #{
name := GwName,
config := Config
}, _GwState) ->
},
_GwState
) ->
Listeners = normalize_config(Config),
stop_listeners(GwName, Listeners).

7
apps/emqx_gateway/src/stomp/include/emqx_stomp.hrl
View File

@ -59,8 +59,8 @@
-record(stomp_frame, {
command :: client_command() | server_command(),
headers = [],
body = <<>> :: iodata()}
).
body = <<>> :: iodata()
}).
-type stomp_frame() :: #stomp_frame{}.
@ -68,7 +68,8 @@
-define(PACKET(CMD, Headers), #stomp_frame{command = CMD, headers = Headers}).
-define(PACKET(CMD, Headers, Body), #stomp_frame{command = CMD,
-define(PACKET(CMD, Headers, Body), #stomp_frame{
command = CMD,
headers = Headers,
body = Body
}).

92
apps/emqx_gateway/test/emqx_coap_SUITE.erl
View File

@ -19,37 +19,40 @@
-compile(export_all).
-compile(nowarn_export_all).
-import(emqx_gateway_test_utils,
[ request/2
, request/3
]).
-import(
emqx_gateway_test_utils,
[
request/2,
request/3
]
).
-include_lib("er_coap_client/include/coap.hrl").
-include_lib("emqx/include/emqx.hrl").
-include_lib("eunit/include/eunit.hrl").
-include_lib("common_test/include/ct.hrl").
-define(CONF_DEFAULT, <<"
gateway.coap
{
idle_timeout = 30s
enable_stats = false
mountpoint = \"\"
notify_type = qos
connection_required = true
subscribe_qos = qos1
publish_qos = qos1
listeners.udp.default
{bind = 5683}
}
">>).
-define(CONF_DEFAULT, <<
"\n"
"gateway.coap\n"
"{\n"
" idle_timeout = 30s\n"
" enable_stats = false\n"
" mountpoint = \"\"\n"
" notify_type = qos\n"
" connection_required = true\n"
" subscribe_qos = qos1\n"
" publish_qos = qos1\n"
"\n"
" listeners.udp.default\n"
" {bind = 5683}\n"
"}\n"
>>).
-define(LOGT(Format, Args), ct:pal("TEST_SUITE: " ++ Format, Args)).
-define(PS_PREFIX, "coap://127.0.0.1/ps").
-define(MQTT_PREFIX, "coap://127.0.0.1/mqtt").
all() -> emqx_common_test_helpers:all(?MODULE).
init_per_suite(Config) ->
@ -73,10 +76,12 @@ t_connection(_) ->
timer:sleep(100),
?assertNotEqual(
[],
emqx_gateway_cm_registry:lookup_channels(coap, <<"client1">>)),
emqx_gateway_cm_registry:lookup_channels(coap, <<"client1">>)
),
%% heartbeat
HeartURI = ?MQTT_PREFIX ++
HeartURI =
?MQTT_PREFIX ++
"/connection?clientid=client1&token=" ++
Token,
@ -88,7 +93,8 @@ t_connection(_) ->
timer:sleep(100),
?assertEqual(
[],
emqx_gateway_cm_registry:lookup_channels(coap, <<"client1">>))
emqx_gateway_cm_registry:lookup_channels(coap, <<"client1">>)
)
end,
do(Action).
@ -110,8 +116,7 @@ t_publish(_) ->
{deliver, Topic, Msg} ->
?assertEqual(Topic, Msg#message.topic),
?assertEqual(Payload, Msg#message.payload)
after
500 ->
after 500 ->
?assert(false)
end
end,
@ -168,7 +173,6 @@ t_subscribe(_) ->
?assertEqual([], emqx:subscribers(Topic)).
t_un_subscribe(_) ->
Topic = <<"/abc">>,
Fun = fun(Channel, Token) ->
@ -232,11 +236,17 @@ t_clients_api(_) ->
#{clientid := ClientId} = Client1,
%% searching
{200, #{data := [Client2]}} =
request(get, "/gateway/coap/clients",
[{<<"clientid">>, ClientId}]),
request(
get,
"/gateway/coap/clients",
[{<<"clientid">>, ClientId}]
),
{200, #{data := [Client3]}} =
request(get, "/gateway/coap/clients",
[{<<"like_clientid">>, <<"cli">>}]),
request(
get,
"/gateway/coap/clients",
[{<<"like_clientid">>, <<"cli">>}]
),
%% lookup
{200, Client4} =
request(get, "/gateway/coap/clients/client1"),
@ -255,18 +265,20 @@ t_clients_subscription_api(_) ->
%% list
{200, []} = request(get, Path),
%% create
SubReq = #{ topic => <<"tx">>
, qos => 0
, nl => 0
, rap => 0
, rh => 0
SubReq = #{
topic => <<"tx">>,
qos => 0,
nl => 0,
rap => 0,
rh => 0
},
{201, SubsResp} = request(post, Path, SubReq),
{200, [SubsResp2]} = request(get, Path),
?assertEqual(
maps:get(topic, SubsResp),
maps:get(topic, SubsResp2)),
maps:get(topic, SubsResp2)
),
{204, _} = request(delete, Path ++ "/tx"),
@ -325,7 +337,8 @@ t_on_offline_event(_) ->
%% helpers
connection(Channel) ->
URI = ?MQTT_PREFIX ++
URI =
?MQTT_PREFIX ++
"/connection?clientid=client1&username=admin&password=public",
Req = make_req(post),
{ok, created, Data} = do_request(Channel, URI, Req),
@ -343,7 +356,6 @@ observe(Channel, Token, true) ->
Req = make_req(get, <<>>, [{observe, 0}]),
{ok, content, _Data} = do_request(Channel, URI, Req),
ok;
observe(Channel, Token, false) ->
URI = ?PS_PREFIX ++ "/coap/observe?clientid=client1&token=" ++ Token,
Req = make_req(get, <<>>, [{observe, 1}]),
@ -360,7 +372,6 @@ make_req(Method, Payload, Opts) ->
er_coap_message:request(con, Method, Payload, Opts).
do_request(Channel, URI, #coap_message{options = Opts} = Req) ->
{_, _, Path, Query} = er_coap_client:resolve_uri(URI),
Opts2 = [{uri_path, Path}, {uri_query, Query} | Opts],
Req2 = Req#coap_message{options = Opts2},
@ -371,8 +382,7 @@ do_request(Channel, URI, #coap_message{options = Opts} = Req) ->
with_response(Channel) ->
receive
{coap_response, _ChId, Channel,
_Ref, Message=#coap_message{method=Code}} ->
{coap_response, _ChId, Channel, _Ref, Message = #coap_message{method = Code}} ->
return_response(Code, Message);
{coap_error, _ChId, Channel, _Ref, reset} ->
{error, reset}

126
apps/emqx_gateway/test/emqx_coap_api_SUITE.erl
View File

@ -23,26 +23,28 @@
-include_lib("eunit/include/eunit.hrl").
-include_lib("common_test/include/ct.hrl").
-define(CONF_DEFAULT, <<"
gateway.coap {
idle_timeout = 30s
enable_stats = false
mountpoint = \"\"
notify_type = qos
connection_required = true
subscribe_qos = qos1
publish_qos = qos1
listeners.udp.default {
bind = 5683
}
}
">>).
-define(CONF_DEFAULT, <<
"\n"
"gateway.coap {\n"
" idle_timeout = 30s\n"
" enable_stats = false\n"
" mountpoint = \"\"\n"
" notify_type = qos\n"
" connection_required = true\n"
" subscribe_qos = qos1\n"
" publish_qos = qos1\n"
" listeners.udp.default {\n"
" bind = 5683\n"
" }\n"
"}\n"
>>).
-define(HOST, "127.0.0.1").
-define(PORT, 5683).
-define(CONN_URI,
"coap://127.0.0.1/mqtt/connection?clientid=client1&"
"username=admin&password=public").
"username=admin&password=public"
).
-define(LOGT(Format, Args), ct:pal("TEST_SUITE: " ++ Format, Args)).
@ -72,13 +74,16 @@ t_send_request_api(_) ->
Path = emqx_mgmt_api_test_util:api_path(["gateway/coap/clients/client1/request"]),
Token = <<"atoken">>,
Payload = <<"simple echo this">>,
Req = #{token => Token,
Req = #{
token => Token,
payload => Payload,
timeout => <<"10s">>,
content_type => <<"text/plain">>,
method => <<"get">>},
method => <<"get">>
},
Auth = emqx_mgmt_api_test_util:auth_header_(),
{ok, Response} = emqx_mgmt_api_test_util:request_api(post,
{ok, Response} = emqx_mgmt_api_test_util:request_api(
post,
Path,
"method=get",
Auth,
@ -113,34 +118,55 @@ test_send_coap_request(UdpSock, Method, Content, Options, MsgId) ->
is_list(Options) orelse error("Options must be a list"),
case resolve_uri(?CONN_URI) of
{coap, {IpAddr, Port}, Path, Query} ->
Request0 = emqx_coap_message:request(con, Method, Content,
[{uri_path, Path},
{uri_query, Query} | Options]),
Request0 = emqx_coap_message:request(
con,
Method,
Content,
[
{uri_path, Path},
{uri_query, Query}
| Options
]
),
Request = Request0#coap_message{id = MsgId},
?LOGT("send_coap_request Request=~p", [Request]),
RequestBinary = emqx_coap_frame:serialize_pkt(Request, undefined),
?LOGT("test udp socket send to ~p:~p, data=~p",
[IpAddr, Port, RequestBinary]),
?LOGT(
"test udp socket send to ~p:~p, data=~p",
[IpAddr, Port, RequestBinary]
),
ok = gen_udp:send(UdpSock, IpAddr, Port, RequestBinary);
{SchemeDiff, ChIdDiff, _, _} ->
error(
lists:flatten(
io_lib:format(
"scheme ~ts or ChId ~ts does not match with socket",
[SchemeDiff, ChIdDiff])
))
[SchemeDiff, ChIdDiff]
)
)
)
end.
test_recv_coap_response(UdpSock) ->
{ok, {Address, Port, Packet}} = gen_udp:recv(UdpSock, 0, 2000),
{ok, Response, _, _} = emqx_coap_frame:parse(Packet, undefined),
?LOGT("test udp receive from ~p:~p, data1=~p, Response=~p",
[Address, Port, Packet, Response]),
?LOGT(
"test udp receive from ~p:~p, data1=~p, Response=~p",
[Address, Port, Packet, Response]
),
#coap_message{
type = ack, method = Method, id = Id,
token = Token, options = Options, payload = Payload} = Response,
?LOGT("receive coap response Method=~p, Id=~p, Token=~p, "
"Options=~p, Payload=~p", [Method, Id, Token, Options, Payload]),
type = ack,
method = Method,
id = Id,
token = Token,
options = Options,
payload = Payload
} = Response,
?LOGT(
"receive coap response Method=~p, Id=~p, Token=~p, "
"Options=~p, Payload=~p",
[Method, Id, Token, Options, Payload]
),
Response.
test_recv_coap_request(UdpSock) ->
@ -148,11 +174,18 @@ test_recv_coap_request(UdpSock) ->
{ok, {_Address, _Port, Packet}} ->
{ok, Request, _, _} = emqx_coap_frame:parse(Packet, undefined),
#coap_message{
type = con, method = Method, id = Id,
token = Token, payload = Payload, options = Options} = Request,
?LOGT("receive coap request Method=~p, Id=~p, "
type = con,
method = Method,
id = Id,
token = Token,
payload = Payload,
options = Options
} = Request,
?LOGT(
"receive coap request Method=~p, Id=~p, "
"Token=~p, Options=~p, Payload=~p",
[Method, Id, Token, Options, Payload]),
[Method, Id, Token, Options, Payload]
),
Request;
{error, Reason} ->
?LOGT("test_recv_coap_request failed, Reason=~p", [Reason]),
@ -168,10 +201,13 @@ test_send_coap_response(UdpSock, Host, Port, Code, Content, Request) ->
ok = gen_udp:send(UdpSock, IpAddr, Port, Binary).
resolve_uri(Uri) ->
{ok, #{scheme := Scheme,
{ok,
#{
scheme := Scheme,
host := Host,
port := PortNo,
path := Path} = URIMap} = emqx_http_lib:uri_parse(Uri),
path := Path
} = URIMap} = emqx_http_lib:uri_parse(Uri),
Query = maps:get(query, URIMap, undefined),
{ok, PeerIP} = inet:getaddr(Host, inet),
{Scheme, {PeerIP, PortNo}, split_path(Path), split_query(Query)}.
@ -181,16 +217,18 @@ split_path([$/]) -> [];
split_path([$/ | Path]) -> split_segments(Path, $/, []).
split_query(undefined) -> #{};
split_query(Path) ->
split_segments(Path, $&, []).
split_query(Path) -> split_segments(Path, $&, []).
split_segments(Path, Char, Acc) ->
case string:rchr(Path, Char) of
0 ->
[make_segment(Path) | Acc];
N when N > 0 ->
split_segments(string:substr(Path, 1, N-1), Char,
[make_segment(string:substr(Path, N+1)) | Acc])
split_segments(
string:substr(Path, 1, N - 1),
Char,
[make_segment(string:substr(Path, N + 1)) | Acc]
)
end.
make_segment(Seg) ->
@ -206,10 +244,8 @@ get_path([{_, _}|T], Acc) ->
get_path(T, Acc).
join_path([], Acc) -> Acc;
join_path([<<"/">>|T], Acc) ->
join_path(T, Acc);
join_path([H|T], Acc) ->
join_path(T, <<Acc/binary, $/, H/binary>>).
join_path([<<"/">> | T], Acc) -> join_path(T, Acc);
join_path([H | T], Acc) -> join_path(T, <<Acc/binary, $/, H/binary>>).
sprintf(Format, Args) ->
lists:flatten(io_lib:format(Format, Args)).

124
apps/emqx_gateway/test/emqx_exproto_SUITE.erl
View File

@ -19,17 +19,20 @@
-compile(export_all).
-compile(nowarn_export_all).
-import(emqx_exproto_echo_svr,
[ frame_connect/2
, frame_connack/1
, frame_publish/3
, frame_puback/1
, frame_subscribe/2
, frame_suback/1
, frame_unsubscribe/1
, frame_unsuback/1
, frame_disconnect/0
]).
-import(
emqx_exproto_echo_svr,
[
frame_connect/2,
frame_connack/1,
frame_publish/3,
frame_puback/1,
frame_subscribe/2,
frame_suback/1,
frame_unsubscribe/1,
frame_unsuback/1,
frame_disconnect/0
]
).
-include_lib("emqx/include/emqx.hrl").
-include_lib("emqx/include/emqx_mqtt.hrl").
@ -68,10 +71,12 @@ set_special_cfg(emqx_gateway) ->
LisType = get(grpname),
emqx_config:put(
[gateway, exproto],
#{server => #{bind => 9100},
#{
server => #{bind => 9100},
handler => #{address => "http://127.0.0.1:9001"},
listeners => listener_confs(LisType)
});
}
);
set_special_cfg(_App) ->
ok.
@ -90,7 +95,8 @@ t_mountpoint_echo(Cfg) ->
SockType = proplists:get_value(listener_type, Cfg),
Sock = open(SockType),
Client = #{proto_name => <<"demo">>,
Client = #{
proto_name => <<"demo">>,
proto_ver => <<"v0.1">>,
clientid => <<"test_client_1">>,
mountpoint => <<"ct/">>
@ -132,15 +138,19 @@ t_auth_deny(Cfg) ->
SockType = proplists:get_value(listener_type, Cfg),
Sock = open(SockType),
Client = #{proto_name => <<"demo">>,
Client = #{
proto_name => <<"demo">>,
proto_ver => <<"v0.1">>,
clientid => <<"test_client_1">>
},
Password = <<"123456">>,
ok = meck:new(emqx_gateway_ctx, [passthrough, no_history, no_link]),
ok = meck:expect(emqx_gateway_ctx, authenticate,
fun(_, _) -> {error, ?RC_NOT_AUTHORIZED} end),
ok = meck:expect(
emqx_gateway_ctx,
authenticate,
fun(_, _) -> {error, ?RC_NOT_AUTHORIZED} end
),
ConnBin = frame_connect(Client, Password),
ConnAckBin = frame_connack(1),
@ -148,7 +158,8 @@ t_auth_deny(Cfg) ->
send(Sock, ConnBin),
{ok, ConnAckBin} = recv(Sock, 5000),
SockType =/= udp andalso begin
SockType =/= udp andalso
begin
{error, closed} = recv(Sock, 5000)
end,
meck:unload([emqx_gateway_ctx]).
@ -157,7 +168,8 @@ t_acl_deny(Cfg) ->
SockType = proplists:get_value(listener_type, Cfg),
Sock = open(SockType),
Client = #{proto_name => <<"demo">>,
Client = #{
proto_name => <<"demo">>,
proto_ver => <<"v0.1">>,
clientid => <<"test_client_1">>
},
@ -197,7 +209,8 @@ t_keepalive_timeout(Cfg) ->
SockType = proplists:get_value(listener_type, Cfg),
Sock = open(SockType),
Client = #{proto_name => <<"demo">>,
Client = #{
proto_name => <<"demo">>,
proto_ver => <<"v0.1">>,
clientid => <<"test_client_1">>,
keepalive => 2
@ -213,15 +226,18 @@ t_keepalive_timeout(Cfg) ->
DisconnectBin = frame_disconnect(),
{ok, DisconnectBin} = recv(Sock, 10000),
SockType =/= udp andalso begin
SockType =/= udp andalso
begin
{error, closed} = recv(Sock, 5000)
end, ok.
end,
ok.
t_hook_connected_disconnected(Cfg) ->
SockType = proplists:get_value(listener_type, Cfg),
Sock = open(SockType),
Client = #{proto_name => <<"demo">>,
Client = #{
proto_name => <<"demo">>,
proto_ver => <<"v0.1">>,
clientid => <<"test_client_1">>
},
@ -252,7 +268,8 @@ t_hook_connected_disconnected(Cfg) ->
error(hook_is_not_running)
end,
SockType =/= udp andalso begin
SockType =/= udp andalso
begin
{error, closed} = recv(Sock, 5000)
end,
emqx:unhook('client.connected', {?MODULE, hook_fun1}),
@ -262,7 +279,8 @@ t_hook_session_subscribed_unsubscribed(Cfg) ->
SockType = proplists:get_value(listener_type, Cfg),
Sock = open(SockType),
Client = #{proto_name => <<"demo">>,
Client = #{
proto_name => <<"demo">>,
proto_ver => <<"v0.1">>,
clientid => <<"test_client_1">>
},
@ -310,7 +328,8 @@ t_hook_message_delivered(Cfg) ->
SockType = proplists:get_value(listener_type, Cfg),
Sock = open(SockType),
Client = #{proto_name => <<"demo">>,
Client = #{
proto_name => <<"demo">>,
proto_ver => <<"v0.1">>,
clientid => <<"test_client_1">>
},
@ -340,11 +359,19 @@ t_hook_message_delivered(Cfg) ->
%%--------------------------------------------------------------------
%% Utils
hook_fun1(_, _, Parent) -> Parent ! connected, ok.
hook_fun2(_, _, _, Parent) -> Parent ! disconnected, ok.
hook_fun1(_, _, Parent) ->
Parent ! connected,
ok.
hook_fun2(_, _, _, Parent) ->
Parent ! disconnected,
ok.
hook_fun3(_, _, _, Parent) -> Parent ! subscribed, ok.
hook_fun4(_, _, _, Parent) -> Parent ! unsubscribed, ok.
hook_fun3(_, _, _, Parent) ->
Parent ! subscribed,
ok.
hook_fun4(_, _, _, Parent) ->
Parent ! unsubscribed,
ok.
hook_fun5(_, Msg) -> {ok, Msg#message{payload = <<"2">>}}.
@ -403,40 +430,50 @@ close({dtls, Sock}) ->
socketopts(tcp) ->
#{tcp => tcp_opts()};
socketopts(ssl) ->
#{tcp => tcp_opts(),
ssl => ssl_opts()};
#{
tcp => tcp_opts(),
ssl => ssl_opts()
};
socketopts(udp) ->
#{udp => udp_opts()};
socketopts(dtls) ->
#{udp => udp_opts(),
dtls => dtls_opts()}.
#{
udp => udp_opts(),
dtls => dtls_opts()
}.
tcp_opts() ->
maps:merge(
udp_opts(),
#{send_timeout => 15000,
#{
send_timeout => 15000,
send_timeout_close => true,
backlog => 100,
nodelay => true}
nodelay => true
}
).
udp_opts() ->
#{recbuf => 1024,
#{
recbuf => 1024,
sndbuf => 1024,
buffer => 1024,
reuseaddr => true}.
reuseaddr => true
}.
ssl_opts() ->
Certs = certs("key.pem", "cert.pem", "cacert.pem"),
maps:merge(
Certs,
#{versions => emqx_tls_lib:default_versions(),
#{
versions => emqx_tls_lib:default_versions(),
ciphers => emqx_tls_lib:default_ciphers(),
verify => verify_peer,
fail_if_no_peer_cert => true,
secure_renegotiate => false,
reuse_sessions => true,
honor_cipher_order => true}
honor_cipher_order => true
}
).
dtls_opts() ->
@ -450,7 +487,8 @@ client_ssl_opts() ->
certs(Key, Cert, CACert) ->
CertsPath = emqx_common_test_helpers:deps_path(emqx, "etc/certs"),
#{keyfile => filename:join([ CertsPath, Key ]),
#{
keyfile => filename:join([CertsPath, Key]),
certfile => filename:join([CertsPath, Cert]),
cacertfile => filename:join([ CertsPath, CACert])}.
cacertfile => filename:join([CertsPath, CACert])
}.

152
apps/emqx_gateway/test/emqx_exproto_echo_svr.erl
View File

@ -18,36 +18,45 @@
-behaviour(emqx_exproto_v_1_connection_handler_bhvr).
-export([ start/0
, stop/1
-export([
start/0,
stop/1
]).
-export([ frame_connect/2
, frame_connack/1
, frame_publish/3
, frame_puback/1
, frame_subscribe/2
, frame_suback/1
, frame_unsubscribe/1
, frame_unsuback/1
, frame_disconnect/0
-export([
frame_connect/2,
frame_connack/1,
frame_publish/3,
frame_puback/1,
frame_subscribe/2,
frame_suback/1,
frame_unsubscribe/1,
frame_unsuback/1,
frame_disconnect/0
]).
-export([ on_socket_created/2
, on_received_bytes/2
, on_socket_closed/2
, on_timer_timeout/2
, on_received_messages/2
-export([
on_socket_created/2,
on_received_bytes/2,
on_socket_closed/2,
on_timer_timeout/2,
on_received_messages/2
]).
-define(LOG(Fmt, Args), ct:pal(Fmt, Args)).
-define(HTTP, #{grpc_opts => #{service_protos => [emqx_exproto_pb],
services => #{'emqx.exproto.v1.ConnectionHandler' => ?MODULE}},
listen_opts => #{port => 9001,
socket_options => []},
-define(HTTP, #{
grpc_opts => #{
service_protos => [emqx_exproto_pb],
services => #{'emqx.exproto.v1.ConnectionHandler' => ?MODULE}
},
listen_opts => #{
port => 9001,
socket_options => []
},
pool_opts => #{size => 8},
transport_opts => #{ssl => false}}).
transport_opts => #{ssl => false}
}).
-define(CLIENT, emqx_exproto_v_1_connection_adapter_client).
@ -70,18 +79,20 @@
-define(TYPE_DISCONNECT, 9).
-define(loop_recv_and_reply_empty_success(Stream),
?loop_recv_and_reply_empty_success(Stream, fun(_) -> ok end)).
?loop_recv_and_reply_empty_success(Stream, fun(_) -> ok end)
).
-define(loop_recv_and_reply_empty_success(Stream, Fun),
begin
-define(loop_recv_and_reply_empty_success(Stream, Fun), begin
LoopRecv = fun _Lp(_St) ->
case grpc_stream:recv(_St) of
{more, _Reqs, _NSt} ->
?LOG("~p: ~p~n", [?FUNCTION_NAME, _Reqs]),
Fun(_Reqs), _Lp(_NSt);
Fun(_Reqs),
_Lp(_NSt);
{eos, _Reqs, _NSt} ->
?LOG("~p: ~p~n", [?FUNCTION_NAME, _Reqs]),
Fun(_Reqs), _NSt
Fun(_Reqs),
_NSt
end
end,
NStream = LoopRecv(Stream),
@ -101,7 +112,8 @@ start_channel() ->
grpc_client_sup:create_channel_pool(ct_test_channel, "http://127.0.0.1:9100", #{}).
start_server() ->
Services = #{protos => [emqx_exproto_pb],
Services = #{
protos => [emqx_exproto_pb],
services => #{'emqx.exproto.v1.ConnectionHandler' => ?MODULE}
},
Options = [],
@ -115,53 +127,68 @@ stop([_ChannPid, _SvrPid]) ->
%% Protocol Adapter callbacks
%%--------------------------------------------------------------------
-spec on_socket_created(grpc_stream:stream(), grpc:metadata())
-> {ok, grpc_stream:stream()}.
-spec on_socket_created(grpc_stream:stream(), grpc:metadata()) ->
{ok, grpc_stream:stream()}.
on_socket_created(Stream, _Md) ->
?loop_recv_and_reply_empty_success(Stream).
-spec on_socket_closed(grpc_stream:stream(), grpc:metadata())
-> {ok, grpc_stream:stream()}.
-spec on_socket_closed(grpc_stream:stream(), grpc:metadata()) ->
{ok, grpc_stream:stream()}.
on_socket_closed(Stream, _Md) ->
?loop_recv_and_reply_empty_success(Stream).
-spec on_received_bytes(grpc_stream:stream(), grpc:metadata())
-> {ok, grpc_stream:stream()}.
-spec on_received_bytes(grpc_stream:stream(), grpc:metadata()) ->
{ok, grpc_stream:stream()}.
on_received_bytes(Stream, _Md) ->
?loop_recv_and_reply_empty_success(Stream,
?loop_recv_and_reply_empty_success(
Stream,
fun(Reqs) ->
lists:foreach(
fun(#{conn := Conn, bytes := Bytes}) ->
#{<<"type">> := Type} = Params = emqx_json:decode(Bytes, [return_maps]),
_ = handle_in(Conn, Type, Params)
end, Reqs)
end).
end,
Reqs
)
end
).
-spec on_timer_timeout(grpc_stream:stream(), grpc:metadata())
-> {ok, grpc_stream:stream()}.
-spec on_timer_timeout(grpc_stream:stream(), grpc:metadata()) ->
{ok, grpc_stream:stream()}.
on_timer_timeout(Stream, _Md) ->
?loop_recv_and_reply_empty_success(Stream,
?loop_recv_and_reply_empty_success(
Stream,
fun(Reqs) ->
lists:foreach(
fun(#{conn := Conn, type := 'KEEPALIVE'}) ->
?LOG("Close this connection ~p due to keepalive timeout", [Conn]),
handle_out(Conn, ?TYPE_DISCONNECT),
?close(#{conn => Conn})
end, Reqs)
end).
end,
Reqs
)
end
).
-spec on_received_messages(grpc_stream:stream(), grpc:metadata())
-> {ok, grpc_stream:stream()}.
-spec on_received_messages(grpc_stream:stream(), grpc:metadata()) ->
{ok, grpc_stream:stream()}.
on_received_messages(Stream, _Md) ->
?loop_recv_and_reply_empty_success(Stream,
?loop_recv_and_reply_empty_success(
Stream,
fun(Reqs) ->
lists:foreach(
fun(#{conn := Conn, messages := Messages}) ->
lists:foreach(fun(Message) ->
lists:foreach(
fun(Message) ->
handle_out(Conn, ?TYPE_PUBLISH, Message)
end, Messages)
end, Reqs)
end).
end,
Messages
)
end,
Reqs
)
end
).
%%--------------------------------------------------------------------
%% The Protocol Example:
@ -189,12 +216,16 @@ on_received_messages(Stream, _Md) ->
handle_in(Conn, ?TYPE_CONNECT, #{<<"clientinfo">> := ClientInfo, <<"password">> := Password}) ->
NClientInfo = maps:from_list(
[{binary_to_atom(K, utf8), V}
|| {K, V} <- maps:to_list(ClientInfo)]),
[
{binary_to_atom(K, utf8), V}
|| {K, V} <- maps:to_list(ClientInfo)
]
),
case ?authenticate(#{conn => Conn, clientinfo => NClientInfo, password => Password}) of
{ok, #{code := 'SUCCESS'}, _} ->
case maps:get(keepalive, NClientInfo, 0) of
0 -> ok;
0 ->
ok;
Intv ->
?LOG("Try call start_timer with ~ps", [Intv]),
?start_timer(#{conn => Conn, type => 'KEEPALIVE', interval => Intv})
@ -204,9 +235,11 @@ handle_in(Conn, ?TYPE_CONNECT, #{<<"clientinfo">> := ClientInfo, <<"password">>
handle_out(Conn, ?TYPE_CONNACK, 1),
?close(#{conn => Conn})
end;
handle_in(Conn, ?TYPE_PUBLISH, #{<<"topic">> := Topic,
handle_in(Conn, ?TYPE_PUBLISH, #{
<<"topic">> := Topic,
<<"qos">> := Qos,
<<"payload">> := Payload}) ->
<<"payload">> := Payload
}) ->
case ?publish(#{conn => Conn, topic => Topic, qos => Qos, payload => Payload}) of
{ok, #{code := 'SUCCESS'}, _} ->
handle_out(Conn, ?TYPE_PUBACK, 0);
@ -227,7 +260,6 @@ handle_in(Conn, ?TYPE_UNSUBSCRIBE, #{<<"topic">> := Topic}) ->
_ ->
handle_out(Conn, ?TYPE_UNSUBACK, 1)
end;
handle_in(Conn, ?TYPE_DISCONNECT, _) ->
?close(#{conn => Conn}).
@ -249,17 +281,21 @@ handle_out(Conn, ?TYPE_DISCONNECT) ->
%% Frame
frame_connect(ClientInfo, Password) ->
emqx_json:encode(#{type => ?TYPE_CONNECT,
emqx_json:encode(#{
type => ?TYPE_CONNECT,
clientinfo => ClientInfo,
password => Password}).
password => Password
}).
frame_connack(Code) ->
emqx_json:encode(#{type => ?TYPE_CONNACK, code => Code}).
frame_publish(Topic, Qos, Payload) ->
emqx_json:encode(#{type => ?TYPE_PUBLISH,
emqx_json:encode(#{
type => ?TYPE_PUBLISH,
topic => Topic,
qos => Qos,
payload => Payload}).
payload => Payload
}).
frame_puback(Code) ->
emqx_json:encode(#{type => ?TYPE_PUBACK, code => Code}).

48
apps/emqx_gateway/test/emqx_gateway_SUITE.erl
View File

@ -44,25 +44,30 @@ end_per_suite(_Conf) ->
%%--------------------------------------------------------------------
t_registered_gateway(_) ->
[{coap, #{cbkmod := emqx_coap_impl}},
[
{coap, #{cbkmod := emqx_coap_impl}},
{exproto, #{cbkmod := emqx_exproto_impl}},
{lwm2m, #{cbkmod := emqx_lwm2m_impl}},
{mqttsn, #{cbkmod := emqx_sn_impl}},
{stomp, #{cbkmod := emqx_stomp_impl}}] = emqx_gateway:registered_gateway().
{stomp, #{cbkmod := emqx_stomp_impl}}
] = emqx_gateway:registered_gateway().
t_load_unload_list_lookup(_) ->
{ok, _} = emqx_gateway:load(?GWNAME, #{idle_timeout => 1000}),
?assertEqual(
{error, alredy_existed},
emqx_gateway:load(?GWNAME, #{})),
emqx_gateway:load(?GWNAME, #{})
),
?assertEqual(
{error, {unknown_gateway_name, bad_gw_name}},
emqx_gateway:load(bad_gw_name, #{})),
emqx_gateway:load(bad_gw_name, #{})
),
?assertEqual(1, length(emqx_gateway:list())),
?assertEqual(
emqx_gateway:lookup(?GWNAME),
lists:nth(1, emqx_gateway:list())),
lists:nth(1, emqx_gateway:list())
),
?assertEqual(ok, emqx_gateway:unload(?GWNAME)),
?assertEqual({error, not_found}, emqx_gateway:unload(?GWNAME)).
@ -78,23 +83,34 @@ t_start_stop_update(_) ->
#{status := stopped} = emqx_gateway:lookup(?GWNAME),
ok = emqx_gateway:update(
?GWNAME, #{enable => false, idle_timeout => 2000}),
#{status := stopped,
config := #{idle_timeout := 2000}} = emqx_gateway:lookup(?GWNAME),
?GWNAME, #{enable => false, idle_timeout => 2000}
),
#{
status := stopped,
config := #{idle_timeout := 2000}
} = emqx_gateway:lookup(?GWNAME),
ok = emqx_gateway:update(
?GWNAME, #{enable => true, idle_timeout => 3000}),
#{status := running,
config := #{idle_timeout := 3000}} = emqx_gateway:lookup(?GWNAME),
?GWNAME, #{enable => true, idle_timeout => 3000}
),
#{
status := running,
config := #{idle_timeout := 3000}
} = emqx_gateway:lookup(?GWNAME),
ok = emqx_gateway:update(
?GWNAME, #{enable => false, idle_timeout => 4000}),
#{status := stopped,
config := #{idle_timeout := 4000}} = emqx_gateway:lookup(?GWNAME),
?GWNAME, #{enable => false, idle_timeout => 4000}
),
#{
status := stopped,
config := #{idle_timeout := 4000}
} = emqx_gateway:lookup(?GWNAME),
ok = emqx_gateway:start(?GWNAME),
#{status := running,
config := #{idle_timeout := 4000}} = emqx_gateway:lookup(?GWNAME),
#{
status := running,
config := #{idle_timeout := 4000}
} = emqx_gateway:lookup(?GWNAME),
{error, already_started} = emqx_gateway:start(?GWNAME),
ok.

143
apps/emqx_gateway/test/emqx_gateway_api_SUITE.erl
View File

@ -19,12 +19,15 @@
-compile(export_all).
-compile(nowarn_export_all).
-import(emqx_gateway_test_utils,
[ assert_confs/2
, assert_feilds_apperence/2
, request/2
, request/3
]).
-import(
emqx_gateway_test_utils,
[
assert_confs/2,
assert_feilds_apperence/2,
request/2,
request/3
]
).
-include_lib("eunit/include/eunit.hrl").
@ -59,8 +62,10 @@ t_gateway(_) ->
assert_bad_request(BadReq),
{201, _} = request(post, "/gateway", #{name => <<"stomp">>}),
{200, StompGw1} = request(get, "/gateway/stomp"),
assert_feilds_apperence([name, status, enable, created_at, started_at],
StompGw1),
assert_feilds_apperence(
[name, status, enable, created_at, started_at],
StompGw1
),
{204, _} = request(delete, "/gateway/stomp"),
{200, StompGw2} = request(get, "/gateway/stomp"),
assert_gw_unloaded(StompGw2),
@ -70,8 +75,10 @@ t_gateway_stomp(_) ->
{200, Gw} = request(get, "/gateway/stomp"),
assert_gw_unloaded(Gw),
%% post
GwConf = #{name => <<"stomp">>,
frame => #{max_headers => 5,
GwConf = #{
name => <<"stomp">>,
frame => #{
max_headers => 5,
max_headers_length => 100,
max_body_length => 100
},
@ -93,7 +100,8 @@ t_gateway_mqttsn(_) ->
{200, Gw} = request(get, "/gateway/mqttsn"),
assert_gw_unloaded(Gw),
%% post
GwConf = #{name => <<"mqttsn">>,
GwConf = #{
name => <<"mqttsn">>,
gateway_id => 1,
broadcast => true,
predefined => [#{id => 1, topic => <<"t/a">>}],
@ -116,7 +124,8 @@ t_gateway_coap(_) ->
{200, Gw} = request(get, "/gateway/coap"),
assert_gw_unloaded(Gw),
%% post
GwConf = #{name => <<"coap">>,
GwConf = #{
name => <<"coap">>,
heartbeat => <<"60s">>,
connection_required => true,
listeners => [
@ -137,7 +146,8 @@ t_gateway_lwm2m(_) ->
{200, Gw} = request(get, "/gateway/lwm2m"),
assert_gw_unloaded(Gw),
%% post
GwConf = #{name => <<"lwm2m">>,
GwConf = #{
name => <<"lwm2m">>,
xml_dir => <<"../../lib/emqx_gateway/src/lwm2m/lwm2m_xml">>,
lifetime_min => <<"1s">>,
lifetime_max => <<"1000s">>,
@ -168,7 +178,8 @@ t_gateway_exproto(_) ->
{200, Gw} = request(get, "/gateway/exproto"),
assert_gw_unloaded(Gw),
%% post
GwConf = #{name => <<"exproto">>,
GwConf = #{
name => <<"exproto">>,
server => #{bind => <<"9100">>},
handler => #{address => <<"http://127.0.0.1:9001">>},
listeners => [
@ -190,7 +201,8 @@ t_authn(_) ->
{201, _} = request(post, "/gateway", GwConf),
{204, _} = request(get, "/gateway/stomp/authentication"),
AuthConf = #{mechanism => <<"password_based">>,
AuthConf = #{
mechanism => <<"password_based">>,
backend => <<"built_in_database">>,
user_id_type => <<"clientid">>
},
@ -213,7 +225,8 @@ t_authn_data_mgmt(_) ->
{201, _} = request(post, "/gateway", GwConf),
{204, _} = request(get, "/gateway/stomp/authentication"),
AuthConf = #{mechanism => <<"password_based">>,
AuthConf = #{
mechanism => <<"password_based">>,
backend => <<"built_in_database">>,
user_id_type => <<"clientid">>
},
@ -221,32 +234,43 @@ t_authn_data_mgmt(_) ->
{200, ConfResp} = request(get, "/gateway/stomp/authentication"),
assert_confs(AuthConf, ConfResp),
User1 = #{ user_id => <<"test">>
, password => <<"123456">>
, is_superuser => false
User1 = #{
user_id => <<"test">>,
password => <<"123456">>,
is_superuser => false
},
{201, _} = request(post, "/gateway/stomp/authentication/users", User1),
{200, #{data := [UserRespd1]}} = request(get, "/gateway/stomp/authentication/users"),
assert_confs(UserRespd1, User1),
{200, UserRespd2} = request(get,
"/gateway/stomp/authentication/users/test"),
{200, UserRespd2} = request(
get,
"/gateway/stomp/authentication/users/test"
),
assert_confs(UserRespd2, User1),
{200, UserRespd3} = request(put,
{200, UserRespd3} = request(
put,
"/gateway/stomp/authentication/users/test",
#{password => <<"654321">>,
is_superuser => true}),
#{
password => <<"654321">>,
is_superuser => true
}
),
assert_confs(UserRespd3, User1#{is_superuser => true}),
{200, UserRespd4} = request(get,
"/gateway/stomp/authentication/users/test"),
{200, UserRespd4} = request(
get,
"/gateway/stomp/authentication/users/test"
),
assert_confs(UserRespd4, User1#{is_superuser => true}),
{204, _} = request(delete, "/gateway/stomp/authentication/users/test"),
{200, #{data := []}} = request(get,
"/gateway/stomp/authentication/users"),
{200, #{data := []}} = request(
get,
"/gateway/stomp/authentication/users"
),
{204, _} = request(delete, "/gateway/stomp/authentication"),
{204, _} = request(get, "/gateway/stomp/authentication"),
@ -256,7 +280,8 @@ t_listeners(_) ->
GwConf = #{name => <<"stomp">>},
{201, _} = request(post, "/gateway", GwConf),
{404, _} = request(get, "/gateway/stomp/listeners"),
LisConf = #{name => <<"def">>,
LisConf = #{
name => <<"def">>,
type => <<"tcp">>,
bind => <<"61613">>
},
@ -281,17 +306,22 @@ t_listeners(_) ->
{204, _} = request(delete, "/gateway/stomp").
t_listeners_authn(_) ->
GwConf = #{name => <<"stomp">>,
GwConf = #{
name => <<"stomp">>,
listeners => [
#{name => <<"def">>,
#{
name => <<"def">>,
type => <<"tcp">>,
bind => <<"61613">>
}]},
}
]
},
{201, _} = request(post, "/gateway", GwConf),
{200, ConfResp} = request(get, "/gateway/stomp"),
assert_confs(GwConf, ConfResp),
AuthConf = #{mechanism => <<"password_based">>,
AuthConf = #{
mechanism => <<"password_based">>,
backend => <<"built_in_database">>,
user_id_type => <<"clientid">>
},
@ -312,17 +342,22 @@ t_listeners_authn(_) ->
{204, _} = request(delete, "/gateway/stomp").
t_listeners_authn_data_mgmt(_) ->
GwConf = #{name => <<"stomp">>,
GwConf = #{
name => <<"stomp">>,
listeners => [
#{name => <<"def">>,
#{
name => <<"def">>,
type => <<"tcp">>,
bind => <<"61613">>
}]},
}
]
},
{201, _} = request(post, "/gateway", GwConf),
{200, ConfResp} = request(get, "/gateway/stomp"),
assert_confs(GwConf, ConfResp),
AuthConf = #{mechanism => <<"password_based">>,
AuthConf = #{
mechanism => <<"password_based">>,
backend => <<"built_in_database">>,
user_id_type => <<"clientid">>
},
@ -331,43 +366,51 @@ t_listeners_authn_data_mgmt(_) ->
{200, ConfResp2} = request(get, Path),
assert_confs(AuthConf, ConfResp2),
User1 = #{ user_id => <<"test">>
, password => <<"123456">>
, is_superuser => false
User1 = #{
user_id => <<"test">>,
password => <<"123456">>,
is_superuser => false
},
{201, _} = request(post,
{201, _} = request(
post,
"/gateway/stomp/listeners/stomp:tcp:def/authentication/users",
User1),
User1
),
{200,
#{data := [UserRespd1]} } = request(
{200, #{data := [UserRespd1]}} = request(
get,
Path ++ "/users"),
Path ++ "/users"
),
assert_confs(UserRespd1, User1),
{200, UserRespd2} = request(
get,
Path ++ "/users/test"),
Path ++ "/users/test"
),
assert_confs(UserRespd2, User1),
{200, UserRespd3} = request(
put,
Path ++ "/users/test",
#{password => <<"654321">>, is_superuser => true}),
#{password => <<"654321">>, is_superuser => true}
),
assert_confs(UserRespd3, User1#{is_superuser => true}),
{200, UserRespd4} = request(
get,
Path ++ "/users/test"),
Path ++ "/users/test"
),
assert_confs(UserRespd4, User1#{is_superuser => true}),
{204, _} = request(
delete,
Path ++ "/users/test"),
Path ++ "/users/test"
),
{200, #{data := []}} = request(
get,
Path ++ "/users"),
Path ++ "/users"
),
{204, _} = request(delete, "/gateway/stomp").
%%--------------------------------------------------------------------

112
apps/emqx_gateway/test/emqx_gateway_cli_SUITE.erl
View File

@ -21,30 +21,38 @@
-include_lib("eunit/include/eunit.hrl").
-define(GP(S), begin S, receive {fmt, P} -> P; O -> O end end).
-define(GP(S), begin
S,
receive
{fmt, P} -> P;
O -> O
end
end).
%% this parses to #{}, will not cause config cleanup
%% so we will need call emqx_config:erase
-define(CONF_DEFAULT, <<"
gateway {}
">>).
-define(CONF_DEFAULT, <<
"\n"
"gateway {}\n"
>>).
%% The config with json format for mqtt-sn gateway
-define(CONF_MQTTSN, "
{\"idle_timeout\": \"30s\",
\"enable_stats\": true,
\"mountpoint\": \"mqttsn/\",
\"gateway_id\": 1,
\"broadcast\": true,
\"enable_qos3\": true,
\"predefined\": [{\"id\": 1001, \"topic\": \"pred/a\"}],
\"listeners\":
[{\"type\": \"udp\",
\"name\": \"ct\",
\"bind\": \"1884\"
}]
}
").
-define(CONF_MQTTSN,
"\n"
"{\"idle_timeout\": \"30s\",\n"
" \"enable_stats\": true,\n"
" \"mountpoint\": \"mqttsn/\",\n"
" \"gateway_id\": 1,\n"
" \"broadcast\": true,\n"
" \"enable_qos3\": true,\n"
" \"predefined\": [{\"id\": 1001, \"topic\": \"pred/a\"}],\n"
" \"listeners\":\n"
" [{\"type\": \"udp\",\n"
" \"name\": \"ct\",\n"
" \"bind\": \"1884\"\n"
" }]\n"
"}\n"
).
%%--------------------------------------------------------------------
%% Setup
@ -65,16 +73,25 @@ end_per_suite(Conf) ->
init_per_testcase(_, Conf) ->
Self = self(),
ok = meck:new(emqx_ctl, [passthrough, no_history, no_link]),
ok = meck:expect(emqx_ctl, usage,
fun(L) -> emqx_ctl:format_usage(L) end),
ok = meck:expect(emqx_ctl, print,
ok = meck:expect(
emqx_ctl,
usage,
fun(L) -> emqx_ctl:format_usage(L) end
),
ok = meck:expect(
emqx_ctl,
print,
fun(Fmt) ->
Self ! {fmt, emqx_ctl:format(Fmt, [])}
end),
ok = meck:expect(emqx_ctl, print,
end
),
ok = meck:expect(
emqx_ctl,
print,
fun(Fmt, Args) ->
Self ! {fmt, emqx_ctl:format(Fmt, Args)}
end),
end
),
Conf.
end_per_testcase(_, _) ->
@ -93,7 +110,8 @@ t_load_unload(_) ->
t_gateway_registry_usage(_) ->
?assertEqual(
["gateway-registry list # List all registered gateways\n"],
emqx_gateway_cli:'gateway-registry'(usage)).
emqx_gateway_cli:'gateway-registry'(usage)
).
t_gateway_registry_list(_) ->
emqx_gateway_cli:'gateway-registry'(["list"]),
@ -102,17 +120,20 @@ t_gateway_registry_list(_) ->
"Registered Name: exproto, Callback Module: emqx_exproto_impl\n"
"Registered Name: lwm2m, Callback Module: emqx_lwm2m_impl\n"
"Registered Name: mqttsn, Callback Module: emqx_sn_impl\n"
"Registered Name: stomp, Callback Module: emqx_stomp_impl\n"
, acc_print()).
"Registered Name: stomp, Callback Module: emqx_stomp_impl\n",
acc_print()
).
t_gateway_usage(_) ->
?assertEqual(
["gateway list # List all gateway\n",
[
"gateway list # List all gateway\n",
"gateway lookup <Name> # Lookup a gateway detailed information\n",
"gateway load <Name> <JsonConf> # Load a gateway with config\n",
"gateway unload <Name> # Unload the gateway\n",
"gateway stop <Name> # Stop the gateway\n",
"gateway start <Name> # Start the gateway\n"],
"gateway start <Name> # Start the gateway\n"
],
emqx_gateway_cli:gateway(usage)
).
@ -123,8 +144,9 @@ t_gateway_list(_) ->
"Gateway(name=exproto, status=unloaded)\n"
"Gateway(name=lwm2m, status=unloaded)\n"
"Gateway(name=mqttsn, status=unloaded)\n"
"Gateway(name=stomp, status=unloaded)\n"
, acc_print()),
"Gateway(name=stomp, status=unloaded)\n",
acc_print()
),
emqx_gateway_cli:gateway(["load", "mqttsn", ?CONF_MQTTSN]),
?assertEqual("ok\n", acc_print()),
@ -158,8 +180,9 @@ t_gateway_load_unload_lookup(_) ->
emqx_gateway_cli:gateway(["load", "mqttsn", "{}"]),
?assertEqual(
"Error: The mqttsn gateway already loaded\n"
, acc_print()),
"Error: The mqttsn gateway already loaded\n",
acc_print()
),
emqx_gateway_cli:gateway(["load", "bad-gw-name", "{}"]),
%% TODO: assert it. for example:
@ -196,12 +219,14 @@ t_gateway_start_stop(_) ->
t_gateway_clients_usage(_) ->
?assertEqual(
["gateway-clients list <Name> "
[
"gateway-clients list <Name> "
"# List all clients for a gateway\n",
"gateway-clients lookup <Name> <ClientId> "
"# Lookup the Client Info for specified client\n",
"gateway-clients kick <Name> <ClientId> "
"# Kick out a client\n"],
"# Kick out a client\n"
],
emqx_gateway_cli:'gateway-clients'(usage)
).
@ -258,8 +283,10 @@ t_gateway_clients_kick(_) ->
t_gateway_metrcis_usage(_) ->
?assertEqual(
[ "gateway-metrics <Name> "
"# List all metrics for a gateway\n"],
[
"gateway-metrics <Name> "
"# List all metrics for a gateway\n"
],
emqx_gateway_cli:'gateway-metrics'(usage)
).
@ -279,10 +306,13 @@ acc_print(Acc) ->
sn_client_connect(ClientId) ->
{ok, Socket} = gen_udp:open(0, [binary]),
_ = emqx_sn_protocol_SUITE:send_connect_msg(Socket, ClientId),
?assertEqual(<<3, 16#05, 0>>,
emqx_sn_protocol_SUITE:receive_response(Socket)),
?assertEqual(
<<3, 16#05, 0>>,
emqx_sn_protocol_SUITE:receive_response(Socket)
),
Socket.
sn_client_disconnect(Socket) ->
_ = emqx_sn_protocol_SUITE:send_disconnect_msg(Socket, undefined),
gen_udp:close(Socket), ok.
gen_udp:close(Socket),
ok.

231
apps/emqx_gateway/test/emqx_gateway_cm_SUITE.erl
View File

@ -61,40 +61,70 @@ end_per_testcase(_TestCase, Conf) ->
%%--------------------------------------------------------------------
t_open_session(_) ->
{ok, #{present := false,
session := #{}}} = emqx_gateway_cm:open_session(
?GWNAME, false, clientinfo(), conninfo(),
fun(_, _) -> #{} end),
{ok, #{
present := false,
session := #{}
}} = emqx_gateway_cm:open_session(
?GWNAME,
false,
clientinfo(),
conninfo(),
fun(_, _) -> #{} end
),
{ok, SessionRes} = emqx_gateway_cm:open_session(
?GWNAME, true, clientinfo(), conninfo(),
fun(_, _) -> #{no => 1} end),
?assertEqual(#{present => false,
session => #{no => 1}}, SessionRes),
?GWNAME,
true,
clientinfo(),
conninfo(),
fun(_, _) -> #{no => 1} end
),
?assertEqual(
#{
present => false,
session => #{no => 1}
},
SessionRes
),
%% assert1. check channel infos in ets table
Chann = {?CLIENTID, self()},
?assertEqual(
[Chann],
ets:tab2list(emqx_gateway_cm:tabname(chan, ?GWNAME))),
ets:tab2list(emqx_gateway_cm:tabname(chan, ?GWNAME))
),
?assertEqual(
[{Chann, ?MODULE}],
ets:tab2list(emqx_gateway_cm:tabname(conn, ?GWNAME))),
ets:tab2list(emqx_gateway_cm:tabname(conn, ?GWNAME))
),
%% assert2. discard the presented session
{ok, SessionRes2} = emqx_gateway_cm:open_session(
?GWNAME, true, clientinfo(), conninfo(),
fun(_, _) -> #{no => 2} end),
?assertEqual(#{present => false,
session => #{no => 2}}, SessionRes2),
?GWNAME,
true,
clientinfo(),
conninfo(),
fun(_, _) -> #{no => 2} end
),
?assertEqual(
#{
present => false,
session => #{no => 2}
},
SessionRes2
),
emqx_gateway_cm:insert_channel_info(
?GWNAME, ?CLIENTID,
#{clientinfo => clientinfo(), conninfo => conninfo()}, []),
?GWNAME,
?CLIENTID,
#{clientinfo => clientinfo(), conninfo => conninfo()},
[]
),
?assertEqual(
1,
ets:info(emqx_gateway_cm:tabname(info, ?GWNAME), size)),
ets:info(emqx_gateway_cm:tabname(info, ?GWNAME), size)
),
receive
discard ->
@ -107,42 +137,61 @@ t_open_session(_) ->
%% assert3. no channel infos in ets table
?assertEqual(
[],
ets:tab2list(emqx_gateway_cm:tabname(chan, ?GWNAME))),
ets:tab2list(emqx_gateway_cm:tabname(chan, ?GWNAME))
),
?assertEqual(
[],
ets:tab2list(emqx_gateway_cm:tabname(conn, ?GWNAME))),
ets:tab2list(emqx_gateway_cm:tabname(conn, ?GWNAME))
),
?assertEqual(
[],
ets:tab2list(emqx_gateway_cm:tabname(info, ?GWNAME))).
ets:tab2list(emqx_gateway_cm:tabname(info, ?GWNAME))
).
t_get_set_chan_info_stats(_) ->
{ok, SessionRes} = emqx_gateway_cm:open_session(
?GWNAME, true, clientinfo(), conninfo(),
fun(_, _) -> #{no => 1} end),
?assertEqual(#{present => false,
session => #{no => 1}}, SessionRes),
?GWNAME,
true,
clientinfo(),
conninfo(),
fun(_, _) -> #{no => 1} end
),
?assertEqual(
#{
present => false,
session => #{no => 1}
},
SessionRes
),
emqx_gateway_cm:insert_channel_info(
?GWNAME, ?CLIENTID,
#{clientinfo => clientinfo(), conninfo => conninfo()}, []),
?GWNAME,
?CLIENTID,
#{clientinfo => clientinfo(), conninfo => conninfo()},
[]
),
%% Info: get/set
NInfo = #{newinfo => true, node => node()},
emqx_gateway_cm:set_chan_info(?GWNAME, ?CLIENTID, NInfo),
?assertEqual(
NInfo,
emqx_gateway_cm:get_chan_info(?GWNAME, ?CLIENTID)),
emqx_gateway_cm:get_chan_info(?GWNAME, ?CLIENTID)
),
?assertEqual(
NInfo,
emqx_gateway_cm:get_chan_info(?GWNAME, ?CLIENTID, self())),
emqx_gateway_cm:get_chan_info(?GWNAME, ?CLIENTID, self())
),
%% Stats: get/set
NStats = [{newstats, true}],
emqx_gateway_cm:set_chan_stats(?GWNAME, ?CLIENTID, NStats),
?assertEqual(
NStats,
emqx_gateway_cm:get_chan_stats(?GWNAME, ?CLIENTID)),
emqx_gateway_cm:get_chan_stats(?GWNAME, ?CLIENTID)
),
?assertEqual(
NStats,
emqx_gateway_cm:get_chan_stats(?GWNAME, ?CLIENTID, self())),
emqx_gateway_cm:get_chan_stats(?GWNAME, ?CLIENTID, self())
),
emqx_gateway_cm:connection_closed(?GWNAME, ?CLIENTID),
emqx_gateway_cm:unregister_channel(?GWNAME, ?CLIENTID).
@ -151,54 +200,82 @@ t_handle_process_down(Conf) ->
Pid = proplists:get_value(cm, Conf),
{ok, SessionRes} = emqx_gateway_cm:open_session(
?GWNAME, true, clientinfo(), conninfo(),
fun(_, _) -> #{no => 1} end),
?assertEqual(#{present => false,
session => #{no => 1}}, SessionRes),
?GWNAME,
true,
clientinfo(),
conninfo(),
fun(_, _) -> #{no => 1} end
),
?assertEqual(
#{
present => false,
session => #{no => 1}
},
SessionRes
),
emqx_gateway_cm:insert_channel_info(
?GWNAME, ?CLIENTID,
#{clientinfo => clientinfo(), conninfo => conninfo()}, []),
?GWNAME,
?CLIENTID,
#{clientinfo => clientinfo(), conninfo => conninfo()},
[]
),
_ = Pid ! {'DOWN', mref, process, self(), normal},
timer:sleep(200), %% wait the async clear task
%% wait the async clear task
timer:sleep(200),
?assertEqual(
[],
ets:tab2list(emqx_gateway_cm:tabname(chan, ?GWNAME))),
ets:tab2list(emqx_gateway_cm:tabname(chan, ?GWNAME))
),
?assertEqual(
[],
ets:tab2list(emqx_gateway_cm:tabname(conn, ?GWNAME))),
ets:tab2list(emqx_gateway_cm:tabname(conn, ?GWNAME))
),
?assertEqual(
[],
ets:tab2list(emqx_gateway_cm:tabname(info, ?GWNAME))).
ets:tab2list(emqx_gateway_cm:tabname(info, ?GWNAME))
).
t_kick_session(_) ->
%% session1
{ok, _} = emqx_gateway_cm:open_session(
?GWNAME, true, clientinfo(), conninfo(),
fun(_, _) -> #{no => 1} end),
?GWNAME,
true,
clientinfo(),
conninfo(),
fun(_, _) -> #{no => 1} end
),
emqx_gateway_cm:insert_channel_info(
?GWNAME, ?CLIENTID,
#{clientinfo => clientinfo(), conninfo => conninfo()}, []),
?GWNAME,
?CLIENTID,
#{clientinfo => clientinfo(), conninfo => conninfo()},
[]
),
%% meck `lookup_channels`
Self = self(),
ok = meck:new(emqx_gateway_cm_registry,
[passthrough, no_history, no_link]),
ok = meck:expect(emqx_gateway_cm_registry, lookup_channels,
fun(_, ?CLIENTID) -> [Self, Self] end),
ok = meck:new(
emqx_gateway_cm_registry,
[passthrough, no_history, no_link]
),
ok = meck:expect(
emqx_gateway_cm_registry,
lookup_channels,
fun(_, ?CLIENTID) -> [Self, Self] end
),
ok = emqx_gateway_cm:kick_session(?GWNAME, ?CLIENTID),
receive kick -> ok
receive
kick -> ok
after 100 -> ?assert(false, "waiting discard msg timeout")
end,
receive
kick ->
emqx_gateway_cm:connection_closed(?GWNAME, ?CLIENTID),
emqx_gateway_cm:unregister_channel(?GWNAME, ?CLIENTID)
after
100 ->
after 100 ->
?assert(false, "waiting kick msg timeout")
end,
?assertMatch({error, not_found}, emqx_gateway_http:kickout_client(?GWNAME, <<"i-dont-exist">>)),
@ -214,37 +291,41 @@ t_unexpected_handle(Conf) ->
%% helpers
clientinfo() ->
#{ clientid => ?CLIENTID
, is_bridge => false
, is_superuser => false
, listener => 'mqttsn:udp:default'
, mountpoint => <<"mqttsn/">>
, peerhost => {127, 0, 0, 1}
, protocol => 'mqtt-sn'
, sockport => 1884
, username => undefined
, zone => default
#{
clientid => ?CLIENTID,
is_bridge => false,
is_superuser => false,
listener => 'mqttsn:udp:default',
mountpoint => <<"mqttsn/">>,
peerhost => {127, 0, 0, 1},
protocol => 'mqtt-sn',
sockport => 1884,
username => undefined,
zone => default
}.
conninfo() ->
#{ clean_start => true
, clientid => ?CLIENTID
, conn_mod => ?MODULE
, connected_at => 1641805544652
, expiry_interval => 0
, keepalive => 10
, peercert => nossl
, peername => {{127, 0, 0, 1}, 64810}
, proto_name => <<"MQTT-SN">>
, proto_ver => <<"1.2">>
, sockname => {{0, 0, 0, 0}, 1884}
, socktype => udp
#{
clean_start => true,
clientid => ?CLIENTID,
conn_mod => ?MODULE,
connected_at => 1641805544652,
expiry_interval => 0,
keepalive => 10,
peercert => nossl,
peername => {{127, 0, 0, 1}, 64810},
proto_name => <<"MQTT-SN">>,
proto_ver => <<"1.2">>,
sockname => {{0, 0, 0, 0}, 1884},
socktype => udp
}.
%%--------------------------------------------------------------------
%% connection module mock
call(ConnPid, discard, _) ->
ConnPid ! discard, ok;
ConnPid ! discard,
ok;
call(ConnPid, kick, _) ->
ConnPid ! kick, ok.
ConnPid ! kick,
ok.

27
apps/emqx_gateway/test/emqx_gateway_cm_registry_SUITE.erl
View File

@ -57,50 +57,59 @@ end_per_testcase(_TestCase, Conf) ->
t_tabname(_) ->
?assertEqual(
emqx_gateway_gw_name_channel_registry,
emqx_gateway_cm_registry:tabname(gw_name)).
emqx_gateway_cm_registry:tabname(gw_name)
).
t_register_unregister_channel(_) ->
ok = emqx_gateway_cm_registry:register_channel(?GWNAME, ?CLIENTID),
?assertEqual(
[{channel, ?CLIENTID, self()}],
ets:tab2list(emqx_gateway_cm_registry:tabname(?GWNAME))),
ets:tab2list(emqx_gateway_cm_registry:tabname(?GWNAME))
),
?assertEqual(
[self()],
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)),
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)
),
ok = emqx_gateway_cm_registry:unregister_channel(?GWNAME, ?CLIENTID),
?assertEqual(
[],
ets:tab2list(emqx_gateway_cm_registry:tabname(?GWNAME))),
ets:tab2list(emqx_gateway_cm_registry:tabname(?GWNAME))
),
?assertEqual(
[],
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)).
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)
).
t_cleanup_channels_mnesia_down(Conf) ->
Pid = proplists:get_value(registry, Conf),
emqx_gateway_cm_registry:register_channel(?GWNAME, ?CLIENTID),
?assertEqual(
[self()],
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)),
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)
),
Pid ! {membership, {mnesia, down, node()}},
ct:sleep(100),
?assertEqual(
[],
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)).
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)
).
t_cleanup_channels_node_down(Conf) ->
Pid = proplists:get_value(registry, Conf),
emqx_gateway_cm_registry:register_channel(?GWNAME, ?CLIENTID),
?assertEqual(
[self()],
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)),
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)
),
Pid ! {membership, {node, down, node()}},
ct:sleep(100),
?assertEqual(
[],
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)).
emqx_gateway_cm_registry:lookup_channels(?GWNAME, ?CLIENTID)
).
t_handle_unexpected_msg(Conf) ->
Pid = proplists:get_value(registry, Conf),

452
apps/emqx_gateway/test/emqx_gateway_conf_SUITE.erl
View File

@ -19,10 +19,13 @@
-compile(export_all).
-compile(nowarn_export_all).
-import(emqx_gateway_test_utils,
[ assert_confs/2
, maybe_unconvert_listeners/1
]).
-import(
emqx_gateway_test_utils,
[
assert_confs/2,
maybe_unconvert_listeners/1
]
).
-include_lib("eunit/include/eunit.hrl").
@ -49,205 +52,210 @@ init_per_testcase(_CaseName, Conf) ->
%% Cases
%%--------------------------------------------------------------------
-define(SVR_CA,
<<"-----BEGIN CERTIFICATE-----
MIIDUTCCAjmgAwIBAgIJAPPYCjTmxdt/MA0GCSqGSIb3DQEBCwUAMD8xCzAJBgNV
BAYTAkNOMREwDwYDVQQIDAhoYW5nemhvdTEMMAoGA1UECgwDRU1RMQ8wDQYDVQQD
DAZSb290Q0EwHhcNMjAwNTA4MDgwNjUyWhcNMzAwNTA2MDgwNjUyWjA/MQswCQYD
VQQGEwJDTjERMA8GA1UECAwIaGFuZ3pob3UxDDAKBgNVBAoMA0VNUTEPMA0GA1UE
AwwGUm9vdENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzcgVLex1
EZ9ON64EX8v+wcSjzOZpiEOsAOuSXOEN3wb8FKUxCdsGrsJYB7a5VM/Jot25Mod2
juS3OBMg6r85k2TWjdxUoUs+HiUB/pP/ARaaW6VntpAEokpij/przWMPgJnBF3Ur
MjtbLayH9hGmpQrI5c2vmHQ2reRZnSFbY+2b8SXZ+3lZZgz9+BaQYWdQWfaUWEHZ
uDaNiViVO0OT8DRjCuiDp3yYDj3iLWbTA/gDL6Tf5XuHuEwcOQUrd+h0hyIphO8D
tsrsHZ14j4AWYLk1CPA6pq1HIUvEl2rANx2lVUNv+nt64K/Mr3RnVQd9s8bK+TXQ
KGHd2Lv/PALYuwIDAQABo1AwTjAdBgNVHQ4EFgQUGBmW+iDzxctWAWxmhgdlE8Pj
EbQwHwYDVR0jBBgwFoAUGBmW+iDzxctWAWxmhgdlE8PjEbQwDAYDVR0TBAUwAwEB
/zANBgkqhkiG9w0BAQsFAAOCAQEAGbhRUjpIred4cFAFJ7bbYD9hKu/yzWPWkMRa
ErlCKHmuYsYk+5d16JQhJaFy6MGXfLgo3KV2itl0d+OWNH0U9ULXcglTxy6+njo5
CFqdUBPwN1jxhzo9yteDMKF4+AHIxbvCAJa17qcwUKR5MKNvv09C6pvQDJLzid7y
E2dkgSuggik3oa0427KvctFf8uhOV94RvEDyqvT5+pgNYZ2Yfga9pD/jjpoHEUlo
88IGU8/wJCx3Ds2yc8+oBg/ynxG8f/HmCC1ET6EHHoe2jlo8FpU/SgGtghS1YL30
IWxNsPrUP+XsZpBJy/mvOhE5QXo6Y35zDqqj8tI7AGmAWu22jg==
-----END CERTIFICATE-----
">>).
-define(SVR_CA, <<
"-----BEGIN CERTIFICATE-----\n"
"MIIDUTCCAjmgAwIBAgIJAPPYCjTmxdt/MA0GCSqGSIb3DQEBCwUAMD8xCzAJBgNV\n"
"BAYTAkNOMREwDwYDVQQIDAhoYW5nemhvdTEMMAoGA1UECgwDRU1RMQ8wDQYDVQQD\n"
"DAZSb290Q0EwHhcNMjAwNTA4MDgwNjUyWhcNMzAwNTA2MDgwNjUyWjA/MQswCQYD\n"
"VQQGEwJDTjERMA8GA1UECAwIaGFuZ3pob3UxDDAKBgNVBAoMA0VNUTEPMA0GA1UE\n"
"AwwGUm9vdENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzcgVLex1\n"
"EZ9ON64EX8v+wcSjzOZpiEOsAOuSXOEN3wb8FKUxCdsGrsJYB7a5VM/Jot25Mod2\n"
"juS3OBMg6r85k2TWjdxUoUs+HiUB/pP/ARaaW6VntpAEokpij/przWMPgJnBF3Ur\n"
"MjtbLayH9hGmpQrI5c2vmHQ2reRZnSFbY+2b8SXZ+3lZZgz9+BaQYWdQWfaUWEHZ\n"
"uDaNiViVO0OT8DRjCuiDp3yYDj3iLWbTA/gDL6Tf5XuHuEwcOQUrd+h0hyIphO8D\n"
"tsrsHZ14j4AWYLk1CPA6pq1HIUvEl2rANx2lVUNv+nt64K/Mr3RnVQd9s8bK+TXQ\n"
"KGHd2Lv/PALYuwIDAQABo1AwTjAdBgNVHQ4EFgQUGBmW+iDzxctWAWxmhgdlE8Pj\n"
"EbQwHwYDVR0jBBgwFoAUGBmW+iDzxctWAWxmhgdlE8PjEbQwDAYDVR0TBAUwAwEB\n"
"/zANBgkqhkiG9w0BAQsFAAOCAQEAGbhRUjpIred4cFAFJ7bbYD9hKu/yzWPWkMRa\n"
"ErlCKHmuYsYk+5d16JQhJaFy6MGXfLgo3KV2itl0d+OWNH0U9ULXcglTxy6+njo5\n"
"CFqdUBPwN1jxhzo9yteDMKF4+AHIxbvCAJa17qcwUKR5MKNvv09C6pvQDJLzid7y\n"
"E2dkgSuggik3oa0427KvctFf8uhOV94RvEDyqvT5+pgNYZ2Yfga9pD/jjpoHEUlo\n"
"88IGU8/wJCx3Ds2yc8+oBg/ynxG8f/HmCC1ET6EHHoe2jlo8FpU/SgGtghS1YL30\n"
"IWxNsPrUP+XsZpBJy/mvOhE5QXo6Y35zDqqj8tI7AGmAWu22jg==\n"
"-----END CERTIFICATE-----\n"
>>).
-define(SVR_CERT,
<<"-----BEGIN CERTIFICATE-----
MIIDEzCCAfugAwIBAgIBAjANBgkqhkiG9w0BAQsFADA/MQswCQYDVQQGEwJDTjER
MA8GA1UECAwIaGFuZ3pob3UxDDAKBgNVBAoMA0VNUTEPMA0GA1UEAwwGUm9vdENB
MB4XDTIwMDUwODA4MDcwNVoXDTMwMDUwNjA4MDcwNVowPzELMAkGA1UEBhMCQ04x
ETAPBgNVBAgMCGhhbmd6aG91MQwwCgYDVQQKDANFTVExDzANBgNVBAMMBlNlcnZl
cjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALNeWT3pE+QFfiRJzKmn
AMUrWo3K2j/Tm3+Xnl6WLz67/0rcYrJbbKvS3uyRP/stXyXEKw9CepyQ1ViBVFkW
Aoy8qQEOWFDsZc/5UzhXUnb6LXr3qTkFEjNmhj+7uzv/lbBxlUG1NlYzSeOB6/RT
8zH/lhOeKhLnWYPXdXKsa1FL6ij4X8DeDO1kY7fvAGmBn/THh1uTpDizM4YmeI+7
4dmayA5xXvARte5h4Vu5SIze7iC057N+vymToMk2Jgk+ZZFpyXrnq+yo6RaD3ANc
lrc4FbeUQZ5a5s5Sxgs9a0Y3WMG+7c5VnVXcbjBRz/aq2NtOnQQjikKKQA8GF080
BQkCAwEAAaMaMBgwCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwDQYJKoZIhvcNAQEL
BQADggEBAJefnMZpaRDHQSNUIEL3iwGXE9c6PmIsQVE2ustr+CakBp3TZ4l0enLt
iGMfEVFju69cO4oyokWv+hl5eCMkHBf14Kv51vj448jowYnF1zmzn7SEzm5Uzlsa
sqjtAprnLyof69WtLU1j5rYWBuFX86yOTwRAFNjm9fvhAcrEONBsQtqipBWkMROp
iUYMkRqbKcQMdwxov+lHBYKq9zbWRoqLROAn54SRqgQk6c15JdEfgOOjShbsOkIH
UhqcwRkQic7n1zwHVGVDgNIZVgmJ2IdIWBlPEC7oLrRrBD/X1iEEXtKab6p5o22n
KB5mN+iQaE+Oe2cpGKZJiJRdM+IqDDQ=
-----END CERTIFICATE-----
">>).
-define(SVR_CERT, <<
"-----BEGIN CERTIFICATE-----\n"
"MIIDEzCCAfugAwIBAgIBAjANBgkqhkiG9w0BAQsFADA/MQswCQYDVQQGEwJDTjER\n"
"MA8GA1UECAwIaGFuZ3pob3UxDDAKBgNVBAoMA0VNUTEPMA0GA1UEAwwGUm9vdENB\n"
"MB4XDTIwMDUwODA4MDcwNVoXDTMwMDUwNjA4MDcwNVowPzELMAkGA1UEBhMCQ04x\n"
"ETAPBgNVBAgMCGhhbmd6aG91MQwwCgYDVQQKDANFTVExDzANBgNVBAMMBlNlcnZl\n"
"cjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALNeWT3pE+QFfiRJzKmn\n"
"AMUrWo3K2j/Tm3+Xnl6WLz67/0rcYrJbbKvS3uyRP/stXyXEKw9CepyQ1ViBVFkW\n"
"Aoy8qQEOWFDsZc/5UzhXUnb6LXr3qTkFEjNmhj+7uzv/lbBxlUG1NlYzSeOB6/RT\n"
"8zH/lhOeKhLnWYPXdXKsa1FL6ij4X8DeDO1kY7fvAGmBn/THh1uTpDizM4YmeI+7\n"
"4dmayA5xXvARte5h4Vu5SIze7iC057N+vymToMk2Jgk+ZZFpyXrnq+yo6RaD3ANc\n"
"lrc4FbeUQZ5a5s5Sxgs9a0Y3WMG+7c5VnVXcbjBRz/aq2NtOnQQjikKKQA8GF080\n"
"BQkCAwEAAaMaMBgwCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwDQYJKoZIhvcNAQEL\n"
"BQADggEBAJefnMZpaRDHQSNUIEL3iwGXE9c6PmIsQVE2ustr+CakBp3TZ4l0enLt\n"
"iGMfEVFju69cO4oyokWv+hl5eCMkHBf14Kv51vj448jowYnF1zmzn7SEzm5Uzlsa\n"
"sqjtAprnLyof69WtLU1j5rYWBuFX86yOTwRAFNjm9fvhAcrEONBsQtqipBWkMROp\n"
"iUYMkRqbKcQMdwxov+lHBYKq9zbWRoqLROAn54SRqgQk6c15JdEfgOOjShbsOkIH\n"
"UhqcwRkQic7n1zwHVGVDgNIZVgmJ2IdIWBlPEC7oLrRrBD/X1iEEXtKab6p5o22n\n"
"KB5mN+iQaE+Oe2cpGKZJiJRdM+IqDDQ=\n"
"-----END CERTIFICATE-----\n"
>>).
-define(SVR_KEY,
<<"-----BEGIN RSA PRIVATE KEY-----
MIIEowIBAAKCAQEAs15ZPekT5AV+JEnMqacAxStajcraP9Obf5eeXpYvPrv/Stxi
sltsq9Le7JE/+y1fJcQrD0J6nJDVWIFUWRYCjLypAQ5YUOxlz/lTOFdSdvotevep
OQUSM2aGP7u7O/+VsHGVQbU2VjNJ44Hr9FPzMf+WE54qEudZg9d1cqxrUUvqKPhf
wN4M7WRjt+8AaYGf9MeHW5OkOLMzhiZ4j7vh2ZrIDnFe8BG17mHhW7lIjN7uILTn
s36/KZOgyTYmCT5lkWnJeuer7KjpFoPcA1yWtzgVt5RBnlrmzlLGCz1rRjdYwb7t
zlWdVdxuMFHP9qrY206dBCOKQopADwYXTzQFCQIDAQABAoIBAQCuvCbr7Pd3lvI/
n7VFQG+7pHRe1VKwAxDkx2t8cYos7y/QWcm8Ptwqtw58HzPZGWYrgGMCRpzzkRSF
V9g3wP1S5Scu5C6dBu5YIGc157tqNGXB+SpdZddJQ4Nc6yGHXYERllT04ffBGc3N
WG/oYS/1cSteiSIrsDy/91FvGRCi7FPxH3wIgHssY/tw69s1Cfvaq5lr2NTFzxIG
xCvpJKEdSfVfS9I7LYiymVjst3IOR/w76/ZFY9cRa8ZtmQSWWsm0TUpRC1jdcbkm
ZoJptYWlP+gSwx/fpMYftrkJFGOJhHJHQhwxT5X/ajAISeqjjwkWSEJLwnHQd11C
Zy2+29lBAoGBANlEAIK4VxCqyPXNKfoOOi5dS64NfvyH4A1v2+KaHWc7lqaqPN49
ezfN2n3X+KWx4cviDD914Yc2JQ1vVJjSaHci7yivocDo2OfZDmjBqzaMp/y+rX1R
/f3MmiTqMa468rjaxI9RRZu7vDgpTR+za1+OBCgMzjvAng8dJuN/5gjlAoGBANNY
uYPKtearBmkqdrSV7eTUe49Nhr0XotLaVBH37TCW0Xv9wjO2xmbm5Ga/DCtPIsBb
yPeYwX9FjoasuadUD7hRvbFu6dBa0HGLmkXRJZTcD7MEX2Lhu4BuC72yDLLFd0r+
Ep9WP7F5iJyagYqIZtz+4uf7gBvUDdmvXz3sGr1VAoGAdXTD6eeKeiI6PlhKBztF
zOb3EQOO0SsLv3fnodu7ZaHbUgLaoTMPuB17r2jgrYM7FKQCBxTNdfGZmmfDjlLB
0xZ5wL8ibU30ZXL8zTlWPElST9sto4B+FYVVF/vcG9sWeUUb2ncPcJ/Po3UAktDG
jYQTTyuNGtSJHpad/YOZctkCgYBtWRaC7bq3of0rJGFOhdQT9SwItN/lrfj8hyHA
OjpqTV4NfPmhsAtu6j96OZaeQc+FHvgXwt06cE6Rt4RG4uNPRluTFgO7XYFDfitP
vCppnoIw6S5BBvHwPP+uIhUX2bsi/dm8vu8tb+gSvo4PkwtFhEr6I9HglBKmcmog
q6waEQKBgHyecFBeM6Ls11Cd64vborwJPAuxIW7HBAFj/BS99oeG4TjBx4Sz2dFd
rzUibJt4ndnHIvCN8JQkjNG14i9hJln+H3mRss8fbZ9vQdqG+2vOWADYSzzsNI55
RFY7JjluKcVkp/zCDeUxTU3O6sS+v6/3VE11Cob6OYQx3lN5wrZ3
-----END RSA PRIVATE KEY-----
">>).
-define(SVR_KEY, <<
"-----BEGIN RSA PRIVATE KEY-----\n"
"MIIEowIBAAKCAQEAs15ZPekT5AV+JEnMqacAxStajcraP9Obf5eeXpYvPrv/Stxi\n"
"sltsq9Le7JE/+y1fJcQrD0J6nJDVWIFUWRYCjLypAQ5YUOxlz/lTOFdSdvotevep\n"
"OQUSM2aGP7u7O/+VsHGVQbU2VjNJ44Hr9FPzMf+WE54qEudZg9d1cqxrUUvqKPhf\n"
"wN4M7WRjt+8AaYGf9MeHW5OkOLMzhiZ4j7vh2ZrIDnFe8BG17mHhW7lIjN7uILTn\n"
"s36/KZOgyTYmCT5lkWnJeuer7KjpFoPcA1yWtzgVt5RBnlrmzlLGCz1rRjdYwb7t\n"
"zlWdVdxuMFHP9qrY206dBCOKQopADwYXTzQFCQIDAQABAoIBAQCuvCbr7Pd3lvI/\n"
"n7VFQG+7pHRe1VKwAxDkx2t8cYos7y/QWcm8Ptwqtw58HzPZGWYrgGMCRpzzkRSF\n"
"V9g3wP1S5Scu5C6dBu5YIGc157tqNGXB+SpdZddJQ4Nc6yGHXYERllT04ffBGc3N\n"
"WG/oYS/1cSteiSIrsDy/91FvGRCi7FPxH3wIgHssY/tw69s1Cfvaq5lr2NTFzxIG\n"
"xCvpJKEdSfVfS9I7LYiymVjst3IOR/w76/ZFY9cRa8ZtmQSWWsm0TUpRC1jdcbkm\n"
"ZoJptYWlP+gSwx/fpMYftrkJFGOJhHJHQhwxT5X/ajAISeqjjwkWSEJLwnHQd11C\n"
"Zy2+29lBAoGBANlEAIK4VxCqyPXNKfoOOi5dS64NfvyH4A1v2+KaHWc7lqaqPN49\n"
"ezfN2n3X+KWx4cviDD914Yc2JQ1vVJjSaHci7yivocDo2OfZDmjBqzaMp/y+rX1R\n"
"/f3MmiTqMa468rjaxI9RRZu7vDgpTR+za1+OBCgMzjvAng8dJuN/5gjlAoGBANNY\n"
"uYPKtearBmkqdrSV7eTUe49Nhr0XotLaVBH37TCW0Xv9wjO2xmbm5Ga/DCtPIsBb\n"
"yPeYwX9FjoasuadUD7hRvbFu6dBa0HGLmkXRJZTcD7MEX2Lhu4BuC72yDLLFd0r+\n"
"Ep9WP7F5iJyagYqIZtz+4uf7gBvUDdmvXz3sGr1VAoGAdXTD6eeKeiI6PlhKBztF\n"
"zOb3EQOO0SsLv3fnodu7ZaHbUgLaoTMPuB17r2jgrYM7FKQCBxTNdfGZmmfDjlLB\n"
"0xZ5wL8ibU30ZXL8zTlWPElST9sto4B+FYVVF/vcG9sWeUUb2ncPcJ/Po3UAktDG\n"
"jYQTTyuNGtSJHpad/YOZctkCgYBtWRaC7bq3of0rJGFOhdQT9SwItN/lrfj8hyHA\n"
"OjpqTV4NfPmhsAtu6j96OZaeQc+FHvgXwt06cE6Rt4RG4uNPRluTFgO7XYFDfitP\n"
"vCppnoIw6S5BBvHwPP+uIhUX2bsi/dm8vu8tb+gSvo4PkwtFhEr6I9HglBKmcmog\n"
"q6waEQKBgHyecFBeM6Ls11Cd64vborwJPAuxIW7HBAFj/BS99oeG4TjBx4Sz2dFd\n"
"rzUibJt4ndnHIvCN8JQkjNG14i9hJln+H3mRss8fbZ9vQdqG+2vOWADYSzzsNI55\n"
"RFY7JjluKcVkp/zCDeUxTU3O6sS+v6/3VE11Cob6OYQx3lN5wrZ3\n"
"-----END RSA PRIVATE KEY-----\n"
>>).
-define(SVR_CERT2,
<<"-----BEGIN CERTIFICATE-----
MIIDEzCCAfugAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MQswCQYDVQQGEwJDTjER
MA8GA1UECAwIaGFuZ3pob3UxDDAKBgNVBAoMA0VNUTEPMA0GA1UEAwwGUm9vdENB
MB4XDTIwMDUwODA4MDY1N1oXDTMwMDUwNjA4MDY1N1owPzELMAkGA1UEBhMCQ04x
ETAPBgNVBAgMCGhhbmd6aG91MQwwCgYDVQQKDANFTVExDzANBgNVBAMMBkNsaWVu
dDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMy4hoksKcZBDbY680u6
TS25U51nuB1FBcGMlF9B/t057wPOlxF/OcmbxY5MwepS41JDGPgulE1V7fpsXkiW
1LUimYV/tsqBfymIe0mlY7oORahKji7zKQ2UBIVFhdlvQxunlIDnw6F9popUgyHt
dMhtlgZK8oqRwHxO5dbfoukYd6J/r+etS5q26sgVkf3C6dt0Td7B25H9qW+f7oLV
PbcHYCa+i73u9670nrpXsC+Qc7Mygwa2Kq/jwU+ftyLQnOeW07DuzOwsziC/fQZa
nbxR+8U9FNftgRcC3uP/JMKYUqsiRAuaDokARZxVTV5hUElfpO6z6/NItSDvvh3i
eikCAwEAAaMaMBgwCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwDQYJKoZIhvcNAQEL
BQADggEBABchYxKo0YMma7g1qDswJXsR5s56Czx/I+B41YcpMBMTrRqpUC0nHtLk
M7/tZp592u/tT8gzEnQjZLKBAhFeZaR3aaKyknLqwiPqJIgg0pgsBGITrAK3Pv4z
5/YvAJJKgTe5UdeTz6U4lvNEux/4juZ4pmqH4qSFJTOzQS7LmgSmNIdd072rwXBd
UzcSHzsJgEMb88u/LDLjj1pQ7AtZ4Tta8JZTvcgBFmjB0QUi6fgkHY6oGat/W4kR
jSRUBlMUbM/drr2PVzRc2dwbFIl3X+ZE6n5Sl3ZwRAC/s92JU6CPMRW02muVu6xl
goraNgPISnrbpR6KjxLZkVembXzjNNc=
-----END CERTIFICATE-----
">>).
-define(SVR_CERT2, <<
"-----BEGIN CERTIFICATE-----\n"
"MIIDEzCCAfugAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MQswCQYDVQQGEwJDTjER\n"
"MA8GA1UECAwIaGFuZ3pob3UxDDAKBgNVBAoMA0VNUTEPMA0GA1UEAwwGUm9vdENB\n"
"MB4XDTIwMDUwODA4MDY1N1oXDTMwMDUwNjA4MDY1N1owPzELMAkGA1UEBhMCQ04x\n"
"ETAPBgNVBAgMCGhhbmd6aG91MQwwCgYDVQQKDANFTVExDzANBgNVBAMMBkNsaWVu\n"
"dDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMy4hoksKcZBDbY680u6\n"
"TS25U51nuB1FBcGMlF9B/t057wPOlxF/OcmbxY5MwepS41JDGPgulE1V7fpsXkiW\n"
"1LUimYV/tsqBfymIe0mlY7oORahKji7zKQ2UBIVFhdlvQxunlIDnw6F9popUgyHt\n"
"dMhtlgZK8oqRwHxO5dbfoukYd6J/r+etS5q26sgVkf3C6dt0Td7B25H9qW+f7oLV\n"
"PbcHYCa+i73u9670nrpXsC+Qc7Mygwa2Kq/jwU+ftyLQnOeW07DuzOwsziC/fQZa\n"
"nbxR+8U9FNftgRcC3uP/JMKYUqsiRAuaDokARZxVTV5hUElfpO6z6/NItSDvvh3i\n"
"eikCAwEAAaMaMBgwCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwDQYJKoZIhvcNAQEL\n"
"BQADggEBABchYxKo0YMma7g1qDswJXsR5s56Czx/I+B41YcpMBMTrRqpUC0nHtLk\n"
"M7/tZp592u/tT8gzEnQjZLKBAhFeZaR3aaKyknLqwiPqJIgg0pgsBGITrAK3Pv4z\n"
"5/YvAJJKgTe5UdeTz6U4lvNEux/4juZ4pmqH4qSFJTOzQS7LmgSmNIdd072rwXBd\n"
"UzcSHzsJgEMb88u/LDLjj1pQ7AtZ4Tta8JZTvcgBFmjB0QUi6fgkHY6oGat/W4kR\n"
"jSRUBlMUbM/drr2PVzRc2dwbFIl3X+ZE6n5Sl3ZwRAC/s92JU6CPMRW02muVu6xl\n"
"goraNgPISnrbpR6KjxLZkVembXzjNNc=\n"
"-----END CERTIFICATE-----\n"
>>).
-define(SVR_KEY2,
<<"-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEAzLiGiSwpxkENtjrzS7pNLblTnWe4HUUFwYyUX0H+3TnvA86X
EX85yZvFjkzB6lLjUkMY+C6UTVXt+mxeSJbUtSKZhX+2yoF/KYh7SaVjug5FqEqO
LvMpDZQEhUWF2W9DG6eUgOfDoX2milSDIe10yG2WBkryipHAfE7l1t+i6Rh3on+v
561LmrbqyBWR/cLp23RN3sHbkf2pb5/ugtU9twdgJr6Lve73rvSeulewL5BzszKD
BrYqr+PBT5+3ItCc55bTsO7M7CzOIL99BlqdvFH7xT0U1+2BFwLe4/8kwphSqyJE
C5oOiQBFnFVNXmFQSV+k7rPr80i1IO++HeJ6KQIDAQABAoIBAGWgvPjfuaU3qizq
uti/FY07USz0zkuJdkANH6LiSjlchzDmn8wJ0pApCjuIE0PV/g9aS8z4opp5q/gD
UBLM/a8mC/xf2EhTXOMrY7i9p/I3H5FZ4ZehEqIw9sWKK9YzC6dw26HabB2BGOnW
5nozPSQ6cp2RGzJ7BIkxSZwPzPnVTgy3OAuPOiJytvK+hGLhsNaT+Y9bNDvplVT2
ZwYTV8GlHZC+4b2wNROILm0O86v96O+Qd8nn3fXjGHbMsAnONBq10bZS16L4fvkH
5G+W/1PeSXmtZFppdRRDxIW+DWcXK0D48WRliuxcV4eOOxI+a9N2ZJZZiNLQZGwg
w3A8+mECgYEA8HuJFrlRvdoBe2U/EwUtG74dcyy30L4yEBnN5QscXmEEikhaQCfX
Wm6EieMcIB/5I5TQmSw0cmBMeZjSXYoFdoI16/X6yMMuATdxpvhOZGdUGXxhAH+x
xoTUavWZnEqW3fkUU71kT5E2f2i+0zoatFESXHeslJyz85aAYpP92H0CgYEA2e5A
Yozt5eaA1Gyhd8SeptkEU4xPirNUnVQHStpMWUb1kzTNXrPmNWccQ7JpfpG6DcYl
zUF6p6mlzY+zkMiyPQjwEJlhiHM2NlL1QS7td0R8ewgsFoyn8WsBI4RejWrEG9td
EDniuIw+pBFkcWthnTLHwECHdzgquToyTMjrBB0CgYEA28tdGbrZXhcyAZEhHAZA
Gzog+pKlkpEzeonLKIuGKzCrEKRecIK5jrqyQsCjhS0T7ZRnL4g6i0s+umiV5M5w
fcc292pEA1h45L3DD6OlKplSQVTv55/OYS4oY3YEJtf5mfm8vWi9lQeY8sxOlQpn
O+VZTdBHmTC8PGeTAgZXHZUCgYA6Tyv88lYowB7SN2qQgBQu8jvdGtqhcs/99GCr
H3N0I69LPsKAR0QeH8OJPXBKhDUywESXAaEOwS5yrLNP1tMRz5Vj65YUCzeDG3kx
gpvY4IMp7ArX0bSRvJ6mYSFnVxy3k174G3TVCfksrtagHioVBGQ7xUg5ltafjrms
n8l55QKBgQDVzU8tQvBVqY8/1lnw11Vj4fkE/drZHJ5UkdC1eenOfSWhlSLfUJ8j
ds7vEWpRPPoVuPZYeR1y78cyxKe1GBx6Wa2lF5c7xjmiu0xbRnrxYeLolce9/ntp
asClqpnHT8/VJYTD7Kqj0fouTTZf0zkig/y+2XERppd8k+pSKjUCPQ==
-----END RSA PRIVATE KEY-----
">>).
-define(SVR_KEY2, <<
"-----BEGIN RSA PRIVATE KEY-----\n"
"MIIEpAIBAAKCAQEAzLiGiSwpxkENtjrzS7pNLblTnWe4HUUFwYyUX0H+3TnvA86X\n"
"EX85yZvFjkzB6lLjUkMY+C6UTVXt+mxeSJbUtSKZhX+2yoF/KYh7SaVjug5FqEqO\n"
"LvMpDZQEhUWF2W9DG6eUgOfDoX2milSDIe10yG2WBkryipHAfE7l1t+i6Rh3on+v\n"
"561LmrbqyBWR/cLp23RN3sHbkf2pb5/ugtU9twdgJr6Lve73rvSeulewL5BzszKD\n"
"BrYqr+PBT5+3ItCc55bTsO7M7CzOIL99BlqdvFH7xT0U1+2BFwLe4/8kwphSqyJE\n"
"C5oOiQBFnFVNXmFQSV+k7rPr80i1IO++HeJ6KQIDAQABAoIBAGWgvPjfuaU3qizq\n"
"uti/FY07USz0zkuJdkANH6LiSjlchzDmn8wJ0pApCjuIE0PV/g9aS8z4opp5q/gD\n"
"UBLM/a8mC/xf2EhTXOMrY7i9p/I3H5FZ4ZehEqIw9sWKK9YzC6dw26HabB2BGOnW\n"
"5nozPSQ6cp2RGzJ7BIkxSZwPzPnVTgy3OAuPOiJytvK+hGLhsNaT+Y9bNDvplVT2\n"
"ZwYTV8GlHZC+4b2wNROILm0O86v96O+Qd8nn3fXjGHbMsAnONBq10bZS16L4fvkH\n"
"5G+W/1PeSXmtZFppdRRDxIW+DWcXK0D48WRliuxcV4eOOxI+a9N2ZJZZiNLQZGwg\n"
"w3A8+mECgYEA8HuJFrlRvdoBe2U/EwUtG74dcyy30L4yEBnN5QscXmEEikhaQCfX\n"
"Wm6EieMcIB/5I5TQmSw0cmBMeZjSXYoFdoI16/X6yMMuATdxpvhOZGdUGXxhAH+x\n"
"xoTUavWZnEqW3fkUU71kT5E2f2i+0zoatFESXHeslJyz85aAYpP92H0CgYEA2e5A\n"
"Yozt5eaA1Gyhd8SeptkEU4xPirNUnVQHStpMWUb1kzTNXrPmNWccQ7JpfpG6DcYl\n"
"zUF6p6mlzY+zkMiyPQjwEJlhiHM2NlL1QS7td0R8ewgsFoyn8WsBI4RejWrEG9td\n"
"EDniuIw+pBFkcWthnTLHwECHdzgquToyTMjrBB0CgYEA28tdGbrZXhcyAZEhHAZA\n"
"Gzog+pKlkpEzeonLKIuGKzCrEKRecIK5jrqyQsCjhS0T7ZRnL4g6i0s+umiV5M5w\n"
"fcc292pEA1h45L3DD6OlKplSQVTv55/OYS4oY3YEJtf5mfm8vWi9lQeY8sxOlQpn\n"
"O+VZTdBHmTC8PGeTAgZXHZUCgYA6Tyv88lYowB7SN2qQgBQu8jvdGtqhcs/99GCr\n"
"H3N0I69LPsKAR0QeH8OJPXBKhDUywESXAaEOwS5yrLNP1tMRz5Vj65YUCzeDG3kx\n"
"gpvY4IMp7ArX0bSRvJ6mYSFnVxy3k174G3TVCfksrtagHioVBGQ7xUg5ltafjrms\n"
"n8l55QKBgQDVzU8tQvBVqY8/1lnw11Vj4fkE/drZHJ5UkdC1eenOfSWhlSLfUJ8j\n"
"ds7vEWpRPPoVuPZYeR1y78cyxKe1GBx6Wa2lF5c7xjmiu0xbRnrxYeLolce9/ntp\n"
"asClqpnHT8/VJYTD7Kqj0fouTTZf0zkig/y+2XERppd8k+pSKjUCPQ==\n"
"-----END RSA PRIVATE KEY-----\n"
>>).
-define(CONF_STOMP_BAISC_1,
#{ <<"idle_timeout">> => <<"10s">>,
-define(CONF_STOMP_BAISC_1, #{
<<"idle_timeout">> => <<"10s">>,
<<"mountpoint">> => <<"t/">>,
<<"frame">> =>
#{ <<"max_headers">> => 20,
#{
<<"max_headers">> => 20,
<<"max_headers_length">> => 2000,
<<"max_body_length">> => 2000
}
}).
-define(CONF_STOMP_BAISC_2,
#{ <<"idle_timeout">> => <<"20s">>,
-define(CONF_STOMP_BAISC_2, #{
<<"idle_timeout">> => <<"20s">>,
<<"mountpoint">> => <<"t2/">>,
<<"frame">> =>
#{ <<"max_headers">> => 30,
#{
<<"max_headers">> => 30,
<<"max_headers_length">> => 3000,
<<"max_body_length">> => 3000
}
}).
-define(CONF_STOMP_LISTENER_1,
#{ <<"bind">> => <<"61613">>
}).
-define(CONF_STOMP_LISTENER_2,
#{ <<"bind">> => <<"61614">>
}).
-define(CONF_STOMP_LISTENER_SSL,
#{ <<"bind">> => <<"61614">>,
-define(CONF_STOMP_LISTENER_1, #{<<"bind">> => <<"61613">>}).
-define(CONF_STOMP_LISTENER_2, #{<<"bind">> => <<"61614">>}).
-define(CONF_STOMP_LISTENER_SSL, #{
<<"bind">> => <<"61614">>,
<<"ssl">> =>
#{ <<"cacertfile">> => ?SVR_CA,
#{
<<"cacertfile">> => ?SVR_CA,
<<"certfile">> => ?SVR_CERT,
<<"keyfile">> => ?SVR_KEY
}
}).
-define(CONF_STOMP_LISTENER_SSL_2,
#{ <<"bind">> => <<"61614">>,
-define(CONF_STOMP_LISTENER_SSL_2, #{
<<"bind">> => <<"61614">>,
<<"ssl">> =>
#{ <<"cacertfile">> => ?SVR_CA,
#{
<<"cacertfile">> => ?SVR_CA,
<<"certfile">> => ?SVR_CERT2,
<<"keyfile">> => ?SVR_KEY2
}
}).
-define(CERTS_PATH(CertName), filename:join(["../../lib/emqx/etc/certs/", CertName])).
-define(CONF_STOMP_LISTENER_SSL_PATH,
#{ <<"bind">> => <<"61614">>,
-define(CONF_STOMP_LISTENER_SSL_PATH, #{
<<"bind">> => <<"61614">>,
<<"ssl">> =>
#{ <<"cacertfile">> => ?CERTS_PATH("cacert.pem"),
#{
<<"cacertfile">> => ?CERTS_PATH("cacert.pem"),
<<"certfile">> => ?CERTS_PATH("cert.pem"),
<<"keyfile">> => ?CERTS_PATH("key.pem")
}
}).
-define(CONF_STOMP_AUTHN_1,
#{ <<"mechanism">> => <<"password_based">>,
-define(CONF_STOMP_AUTHN_1, #{
<<"mechanism">> => <<"password_based">>,
<<"backend">> => <<"built_in_database">>,
<<"user_id_type">> => <<"clientid">>
}).
-define(CONF_STOMP_AUTHN_2,
#{ <<"mechanism">> => <<"password_based">>,
-define(CONF_STOMP_AUTHN_2, #{
<<"mechanism">> => <<"password_based">>,
<<"backend">> => <<"built_in_database">>,
<<"user_id_type">> => <<"username">>
}).
t_load_unload_gateway(_) ->
StompConf1 = compose(?CONF_STOMP_BAISC_1,
StompConf1 = compose(
?CONF_STOMP_BAISC_1,
?CONF_STOMP_AUTHN_1,
?CONF_STOMP_LISTENER_1
),
StompConf2 = compose(?CONF_STOMP_BAISC_2,
StompConf2 = compose(
?CONF_STOMP_BAISC_2,
?CONF_STOMP_AUTHN_1,
?CONF_STOMP_LISTENER_1),
?CONF_STOMP_LISTENER_1
),
{ok, _} = emqx_gateway_conf:load_gateway(stomp, StompConf1),
?assertMatch(
{error, {badres, #{reason := already_exist}}},
emqx_gateway_conf:load_gateway(stomp, StompConf1)),
emqx_gateway_conf:load_gateway(stomp, StompConf1)
),
assert_confs(StompConf1, emqx:get_raw_config([gateway, stomp])),
{ok, _} = emqx_gateway_conf:update_gateway(stomp, StompConf2),
@ -258,10 +266,14 @@ t_load_unload_gateway(_) ->
?assertMatch(
{error, {badres, #{reason := not_found}}},
emqx_gateway_conf:update_gateway(stomp, StompConf2)),
emqx_gateway_conf:update_gateway(stomp, StompConf2)
),
?assertException(error, {config_not_found, [gateway, stomp]},
emqx:get_raw_config([gateway, stomp])),
?assertException(
error,
{config_not_found, [gateway, stomp]},
emqx:get_raw_config([gateway, stomp])
),
ok.
t_load_remove_authn(_) ->
@ -273,21 +285,25 @@ t_load_remove_authn(_) ->
{ok, _} = emqx_gateway_conf:add_authn(<<"stomp">>, ?CONF_STOMP_AUTHN_1),
assert_confs(
maps:put(<<"authentication">>, ?CONF_STOMP_AUTHN_1, StompConf),
emqx:get_raw_config([gateway, stomp])),
emqx:get_raw_config([gateway, stomp])
),
{ok, _} = emqx_gateway_conf:update_authn(<<"stomp">>, ?CONF_STOMP_AUTHN_2),
assert_confs(
maps:put(<<"authentication">>, ?CONF_STOMP_AUTHN_2, StompConf),
emqx:get_raw_config([gateway, stomp])),
emqx:get_raw_config([gateway, stomp])
),
ok = emqx_gateway_conf:remove_authn(<<"stomp">>),
?assertMatch(
{error, {badres, #{reason := not_found}}},
emqx_gateway_conf:update_authn(<<"stomp">>, ?CONF_STOMP_AUTHN_2)),
emqx_gateway_conf:update_authn(<<"stomp">>, ?CONF_STOMP_AUTHN_2)
),
?assertException(
error, {config_not_found, [gateway, stomp, authentication]},
error,
{config_not_found, [gateway, stomp, authentication]},
emqx:get_raw_config([gateway, stomp, authentication])
),
ok.
@ -299,29 +315,39 @@ t_load_remove_listeners(_) ->
assert_confs(StompConf, emqx:get_raw_config([gateway, stomp])),
{ok, _} = emqx_gateway_conf:add_listener(
<<"stomp">>, {<<"tcp">>, <<"default">>},
?CONF_STOMP_LISTENER_1),
<<"stomp">>,
{<<"tcp">>, <<"default">>},
?CONF_STOMP_LISTENER_1
),
assert_confs(
maps:merge(StompConf, listener(?CONF_STOMP_LISTENER_1)),
emqx:get_raw_config([gateway, stomp])),
emqx:get_raw_config([gateway, stomp])
),
{ok, _} = emqx_gateway_conf:update_listener(
<<"stomp">>, {<<"tcp">>, <<"default">>},
?CONF_STOMP_LISTENER_2),
<<"stomp">>,
{<<"tcp">>, <<"default">>},
?CONF_STOMP_LISTENER_2
),
assert_confs(
maps:merge(StompConf, listener(?CONF_STOMP_LISTENER_2)),
emqx:get_raw_config([gateway, stomp])),
emqx:get_raw_config([gateway, stomp])
),
ok = emqx_gateway_conf:remove_listener(
<<"stomp">>, {<<"tcp">>, <<"default">>}),
<<"stomp">>, {<<"tcp">>, <<"default">>}
),
?assertMatch(
{error, {badres, #{reason := not_found}}},
emqx_gateway_conf:update_listener(
<<"stomp">>, {<<"tcp">>, <<"default">>}, ?CONF_STOMP_LISTENER_2)),
<<"stomp">>, {<<"tcp">>, <<"default">>}, ?CONF_STOMP_LISTENER_2
)
),
?assertException(
error, {config_not_found, [gateway, stomp, listeners, tcp, default]},
error,
{config_not_found, [gateway, stomp, listeners, tcp, default]},
emqx:get_raw_config([gateway, stomp, listeners, tcp, default])
),
ok.
@ -346,24 +372,30 @@ t_load_remove_listener_authn(_) ->
assert_confs(StompConf, emqx:get_raw_config([gateway, stomp])),
{ok, _} = emqx_gateway_conf:add_authn(
<<"stomp">>, {<<"tcp">>, <<"default">>}, ?CONF_STOMP_AUTHN_1),
<<"stomp">>, {<<"tcp">>, <<"default">>}, ?CONF_STOMP_AUTHN_1
),
assert_confs(StompConf1, emqx:get_raw_config([gateway, stomp])),
{ok, _} = emqx_gateway_conf:update_authn(
<<"stomp">>, {<<"tcp">>, <<"default">>}, ?CONF_STOMP_AUTHN_2),
<<"stomp">>, {<<"tcp">>, <<"default">>}, ?CONF_STOMP_AUTHN_2
),
assert_confs(StompConf2, emqx:get_raw_config([gateway, stomp])),
ok = emqx_gateway_conf:remove_authn(
<<"stomp">>, {<<"tcp">>, <<"default">>}),
<<"stomp">>, {<<"tcp">>, <<"default">>}
),
?assertMatch(
{error, {badres, #{reason := not_found}}},
emqx_gateway_conf:update_authn(
<<"stomp">>, {<<"tcp">>, <<"default">>}, ?CONF_STOMP_AUTHN_2)),
<<"stomp">>, {<<"tcp">>, <<"default">>}, ?CONF_STOMP_AUTHN_2
)
),
Path = [gateway, stomp, listeners, tcp, default, authentication],
?assertException(
error, {config_not_found, Path},
error,
{config_not_found, Path},
emqx:get_raw_config(Path)
),
ok.
@ -381,8 +413,11 @@ t_load_gateway_with_certs_content(_) ->
),
ok = emqx_gateway_conf:unload_gateway(<<"stomp">>),
assert_ssl_confs_files_deleted(SslConf),
?assertException(error, {config_not_found, [gateway, stomp]},
emqx:get_raw_config([gateway, stomp])),
?assertException(
error,
{config_not_found, [gateway, stomp]},
emqx:get_raw_config([gateway, stomp])
),
ok.
%% TODO: Comment out this test case for now, because emqx_tls_lib
@ -411,44 +446,57 @@ t_add_listener_with_certs_content(_) ->
assert_confs(StompConf, emqx:get_raw_config([gateway, stomp])),
{ok, _} = emqx_gateway_conf:add_listener(
<<"stomp">>, {<<"ssl">>, <<"default">>},
?CONF_STOMP_LISTENER_SSL),
<<"stomp">>,
{<<"ssl">>, <<"default">>},
?CONF_STOMP_LISTENER_SSL
),
assert_confs(
maps:merge(StompConf, ssl_listener(?CONF_STOMP_LISTENER_SSL)),
emqx:get_raw_config([gateway, stomp])),
emqx:get_raw_config([gateway, stomp])
),
{ok, _} = emqx_gateway_conf:update_listener(
<<"stomp">>, {<<"ssl">>, <<"default">>},
?CONF_STOMP_LISTENER_SSL_2),
<<"stomp">>,
{<<"ssl">>, <<"default">>},
?CONF_STOMP_LISTENER_SSL_2
),
assert_confs(
maps:merge(StompConf, ssl_listener(?CONF_STOMP_LISTENER_SSL_2)),
emqx:get_raw_config([gateway, stomp])),
emqx:get_raw_config([gateway, stomp])
),
SslConf = emqx_map_lib:deep_get(
[<<"listeners">>, <<"ssl">>, <<"default">>, <<"ssl">>],
emqx:get_raw_config([gateway, stomp])
),
ok = emqx_gateway_conf:remove_listener(
<<"stomp">>, {<<"ssl">>, <<"default">>}),
<<"stomp">>, {<<"ssl">>, <<"default">>}
),
assert_ssl_confs_files_deleted(SslConf),
?assertMatch(
{error, {badres, #{reason := not_found}}},
emqx_gateway_conf:update_listener(
<<"stomp">>, {<<"ssl">>, <<"default">>}, ?CONF_STOMP_LISTENER_SSL_2)),
<<"stomp">>, {<<"ssl">>, <<"default">>}, ?CONF_STOMP_LISTENER_SSL_2
)
),
?assertException(
error, {config_not_found, [gateway, stomp, listeners, ssl, default]},
error,
{config_not_found, [gateway, stomp, listeners, ssl, default]},
emqx:get_raw_config([gateway, stomp, listeners, ssl, default])
),
ok.
assert_ssl_confs_files_deleted(SslConf) when is_map(SslConf) ->
Ks = [<<"cacertfile">>, <<"certfile">>, <<"keyfile">>],
lists:foreach(fun(K) ->
lists:foreach(
fun(K) ->
Path = maps:get(K, SslConf),
{error, enoent} = file:read_file(Path)
end, Ks).
end,
Ks
).
%%--------------------------------------------------------------------
%% Utils
@ -456,7 +504,8 @@ assert_ssl_confs_files_deleted(SslConf) when is_map(SslConf) ->
compose(Basic, Authn, Listener) ->
maps:merge(
maps:merge(Basic, #{<<"authentication">> => Authn}),
listener(Listener)).
listener(Listener)
).
compose_listener(Basic, Listener) ->
maps:merge(Basic, listener(Listener)).
@ -470,12 +519,25 @@ compose_authn(Basic, Authn) ->
compose_listener_authn(Basic, Listener, Authn) ->
maps:merge(
Basic,
listener(maps:put(<<"authentication">>, Authn, Listener))).
listener(maps:put(<<"authentication">>, Authn, Listener))
).
listener(L) ->
#{<<"listeners">> => [L#{<<"type">> => <<"tcp">>,
<<"name">> => <<"default">>}]}.
#{
<<"listeners">> => [
L#{
<<"type">> => <<"tcp">>,
<<"name">> => <<"default">>
}
]
}.
ssl_listener(L) ->
#{<<"listeners">> => [L#{<<"type">> => <<"ssl">>,
<<"name">> => <<"default">>}]}.
#{
<<"listeners">> => [
L#{
<<"type">> => <<"ssl">>,
<<"name">> => <<"default">>
}
]
}.

32
apps/emqx_gateway/test/emqx_gateway_ctx_SUITE.erl
View File

@ -29,11 +29,16 @@ all() -> emqx_common_test_helpers:all(?MODULE).
init_per_suite(Conf) ->
ok = meck:new(emqx_access_control, [passthrough, no_history, no_link]),
ok = meck:expect(emqx_access_control, authenticate,
fun(#{clientid := bad_client}) ->
ok = meck:expect(
emqx_access_control,
authenticate,
fun
(#{clientid := bad_client}) ->
{error, bad_username_or_password};
(ClientInfo) -> {ok, ClientInfo}
end),
(ClientInfo) ->
{ok, ClientInfo}
end
),
Conf.
end_per_suite(_Conf) ->
@ -45,23 +50,26 @@ end_per_suite(_Conf) ->
t_authenticate(_) ->
Ctx = #{gwname => mqttsn, auth => [], cm => self()},
Info1 = #{ mountpoint => undefined
, clientid => <<"user1">>
Info1 = #{
mountpoint => undefined,
clientid => <<"user1">>
},
NInfo1 = zone(Info1),
?assertEqual({ok, NInfo1}, emqx_gateway_ctx:authenticate(Ctx, Info1)),
Info2 = #{ mountpoint => <<"mqttsn/${clientid}/">>
, clientid => <<"user1">>
Info2 = #{
mountpoint => <<"mqttsn/${clientid}/">>,
clientid => <<"user1">>
},
NInfo2 = zone(Info2#{mountpoint => <<"mqttsn/user1/">>}),
?assertEqual({ok, NInfo2}, emqx_gateway_ctx:authenticate(Ctx, Info2)),
Info3 = #{ mountpoint => <<"mqttsn/${clientid}/">>
, clientid => bad_client
Info3 = #{
mountpoint => <<"mqttsn/${clientid}/">>,
clientid => bad_client
},
{error, bad_username_or_password}
= emqx_gateway_ctx:authenticate(Ctx, Info3),
{error, bad_username_or_password} =
emqx_gateway_ctx:authenticate(Ctx, Info3),
ok.
zone(Info) -> Info#{zone => default}.

6
apps/emqx_gateway/test/emqx_gateway_metrics_SUITE.erl
View File

@ -59,14 +59,16 @@ t_inc_dec(_) ->
?assertEqual(
[{?METRIC, 2}],
emqx_gateway_metrics:lookup(?GWNAME)),
emqx_gateway_metrics:lookup(?GWNAME)
),
ok = emqx_gateway_metrics:dec(?GWNAME, ?METRIC),
ok = emqx_gateway_metrics:dec(?GWNAME, ?METRIC),
?assertEqual(
[{?METRIC, 0}],
emqx_gateway_metrics:lookup(?GWNAME)).
emqx_gateway_metrics:lookup(?GWNAME)
).
t_handle_unexpected_msg(Conf) ->
Pid = proplists:get_value(metrics, Conf),

19
apps/emqx_gateway/test/emqx_gateway_registry_SUITE.erl
View File

@ -21,11 +21,14 @@
-compile(export_all).
-compile(nowarn_export_all).
-define(CONF_DEFAULT, <<"""
gateway: {
stomp {}
}
""">>).
-define(CONF_DEFAULT, <<
""
"\n"
"gateway: {\n"
" stomp {}\n"
"}\n"
""
>>).
all() -> emqx_common_test_helpers:all(?MODULE).
@ -52,8 +55,10 @@ t_load_unload(_) ->
ok = emqx_gateway_registry:reg(test, RgOpts),
?assertEqual(OldCnt + 1, length(emqx_gateway_registry:list())),
#{cbkmod := ?MODULE,
rgopts := RgOpts} = emqx_gateway_registry:lookup(test),
#{
cbkmod := ?MODULE,
rgopts := RgOpts
} = emqx_gateway_registry:lookup(test),
{error, already_existed} = emqx_gateway_registry:reg(test, [{cbkmod, ?MODULE}]),

72
apps/emqx_gateway/test/emqx_gateway_test_utils.erl
View File

@ -23,28 +23,40 @@ assert_confs(Expected0, Effected) ->
Expected = maybe_unconvert_listeners(Expected0),
case do_assert_confs(root, Expected, Effected) of
false ->
io:format(standard_error, "Expected config: ~p,\n"
io:format(
standard_error,
"Expected config: ~p,\n"
"Effected config: ~p",
[Expected, Effected]),
[Expected, Effected]
),
exit(conf_not_match);
true ->
ok
end.
do_assert_confs(_Key, Expected, Effected) when is_map(Expected),
is_map(Effected) ->
do_assert_confs(_Key, Expected, Effected) when
is_map(Expected),
is_map(Effected)
->
Ks1 = maps:keys(Expected),
lists:all(fun(K) ->
do_assert_confs(K,
lists:all(
fun(K) ->
do_assert_confs(
K,
maps:get(K, Expected),
maps:get(K, Effected, undefined))
end, Ks1);
do_assert_confs(Key, Expected, Effected) when Key == <<"cacertfile">>;
maps:get(K, Effected, undefined)
)
end,
Ks1
);
do_assert_confs(Key, Expected, Effected) when
Key == <<"cacertfile">>;
Key == <<"certfile">>;
Key == <<"keyfile">> ->
Key == <<"keyfile">>
->
case Expected == Effected of
true -> true;
true ->
true;
false ->
case file:read_file(Effected) of
{ok, Content} -> Expected == Content;
@ -52,31 +64,40 @@ do_assert_confs(Key, Expected, Effected) when Key == <<"cacertfile">>;
end
end;
do_assert_confs(Key, [Expected | More1], [Effected | More2]) ->
do_assert_confs(Key, Expected, Effected)
andalso do_assert_confs(Key, More1, More2);
do_assert_confs(Key, Expected, Effected) andalso
do_assert_confs(Key, More1, More2);
do_assert_confs(_Key, [], []) ->
true;
do_assert_confs(Key, Expected, Effected) ->
Res = Expected =:= Effected,
Res == false andalso
ct:pal("Errors: ~p value not match, "
"expected: ~p, got: ~p~n", [Key, Expected, Effected]),
ct:pal(
"Errors: ~p value not match, "
"expected: ~p, got: ~p~n",
[Key, Expected, Effected]
),
Res.
maybe_unconvert_listeners(Conf) when is_map(Conf) ->
case maps:take(<<"listeners">>, Conf) of
error -> Conf;
error ->
Conf;
{Ls, Conf1} ->
Conf1#{<<"listeners">> =>
emqx_gateway_conf:unconvert_listeners(Ls)}
Conf1#{
<<"listeners">> =>
emqx_gateway_conf:unconvert_listeners(Ls)
}
end;
maybe_unconvert_listeners(Conf) ->
Conf.
assert_feilds_apperence(Ks, Map) ->
lists:foreach(fun(K) ->
lists:foreach(
fun(K) ->
_ = maps:get(K, Map)
end, Ks).
end,
Ks
).
%%--------------------------------------------------------------------
%% http
@ -100,11 +121,14 @@ request(post = Mth, Path, Body) ->
do_request(Mth, Req) ->
case httpc:request(Mth, Req, [], [{body_format, binary}]) of
{ok, {{_Vsn, Code, _Text}, _, Resp}} ->
NResp = case Resp of
<<>> -> #{};
NResp =
case Resp of
<<>> ->
#{};
_ ->
emqx_map_lib:unsafe_atom_key_map(
emqx_json:decode(Resp, [return_maps]))
emqx_json:decode(Resp, [return_maps])
)
end,
{Code, NResp};
{error, Reason} ->

1248
apps/emqx_gateway/test/emqx_lwm2m_SUITE.erl
View File

File diff suppressed because it is too large Load Diff

146
apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl
View File

@ -28,38 +28,50 @@
-include_lib("eunit/include/eunit.hrl").
-include_lib("common_test/include/ct.hrl").
-define(CONF_DEFAULT, <<"
gateway.lwm2m {
xml_dir = \"../../lib/emqx_gateway/src/lwm2m/lwm2m_xml\"
lifetime_min = 100s
lifetime_max = 86400s
qmode_time_window = 200
auto_observe = false
mountpoint = \"lwm2m/${username}\"
update_msg_publish_condition = contains_object_list
translators {
command = {topic = \"/dn/#\", qos = 0}
response = {topic = \"/up/resp\", qos = 0}
notify = {topic = \"/up/notify\", qos = 0}
register = {topic = \"/up/resp\", qos = 0}
update = {topic = \"/up/resp\", qos = 0}
}
listeners.udp.default {
bind = 5783
}
}
">>).
-define(CONF_DEFAULT, <<
"\n"
"gateway.lwm2m {\n"
" xml_dir = \"../../lib/emqx_gateway/src/lwm2m/lwm2m_xml\"\n"
" lifetime_min = 100s\n"
" lifetime_max = 86400s\n"
" qmode_time_window = 200\n"
" auto_observe = false\n"
" mountpoint = \"lwm2m/${username}\"\n"
" update_msg_publish_condition = contains_object_list\n"
" translators {\n"
" command = {topic = \"/dn/#\", qos = 0}\n"
" response = {topic = \"/up/resp\", qos = 0}\n"
" notify = {topic = \"/up/notify\", qos = 0}\n"
" register = {topic = \"/up/resp\", qos = 0}\n"
" update = {topic = \"/up/resp\", qos = 0}\n"
" }\n"
" listeners.udp.default {\n"
" bind = 5783\n"
" }\n"
"}\n"
>>).
-define(assertExists(Map, Key),
?assertNotEqual(maps:get(Key, Map, undefined), undefined)).
?assertNotEqual(maps:get(Key, Map, undefined), undefined)
).
-record(coap_content, {content_format, payload = <<>>}).
-import(emqx_lwm2m_SUITE, [ request/4, response/3, test_send_coap_response/7
, test_recv_coap_request/1, test_recv_coap_response/1
, test_send_coap_request/6, test_recv_mqtt_response/1
, std_register/5, reslove_uri/1, split_path/1, split_query/1
, join_path/2, sprintf/2]).
-import(emqx_lwm2m_SUITE, [
request/4,
response/3,
test_send_coap_response/7,
test_recv_coap_request/1,
test_recv_coap_response/1,
test_send_coap_request/6,
test_recv_mqtt_response/1,
std_register/5,
reslove_uri/1,
split_path/1,
split_query/1,
join_path/2,
sprintf/2
]).
%%--------------------------------------------------------------------
%% Setups
@ -114,10 +126,14 @@ t_lookup_cmd_read(Config) ->
sprintf("coap://127.0.0.1:~b/rd?ep=~ts&lt=600&lwm2m=1", [?PORT, Epn]),
#coap_content{
content_format = <<"text/plain">>,
payload = <<"</lwm2m>;rt=\"oma.lwm2m\";ct=11543,"
"</lwm2m/1/0>,</lwm2m/2/0>,</lwm2m/3/0>">>},
payload = <<
"</lwm2m>;rt=\"oma.lwm2m\";ct=11543,"
"</lwm2m/1/0>,</lwm2m/2/0>,</lwm2m/3/0>"
>>
},
[],
MsgId1),
MsgId1
),
#coap_message{method = Method1} = test_recv_coap_response(UdpSock),
?assertEqual({ok, created}, Method1),
@ -128,7 +144,8 @@ t_lookup_cmd_read(Config) ->
CmdId = 206,
CommandTopic = <<"lwm2m/", (list_to_binary(Epn))/binary, "/dn/dm">>,
Command = #{
<<"requestID">> => CmdId, <<"cacheID">> => CmdId,
<<"requestID">> => CmdId,
<<"cacheID">> => CmdId,
<<"msgType">> => <<"read">>,
<<"data">> => #{
<<"path">> => <<"/3/0/0">>
@ -152,7 +169,8 @@ t_lookup_cmd_read(Config) ->
{ok, content},
#coap_content{content_format = <<"text/plain">>, payload = <<"EMQ">>},
Request2,
true),
true
),
timer:sleep(200),
normal_received_request(Epn, <<"/3/0/0">>, <<"read">>).
@ -172,11 +190,14 @@ t_lookup_cmd_discover(Config) ->
%% step2, send a WRITE command to device
CommandTopic = <<"lwm2m/", (list_to_binary(Epn))/binary, "/dn/dm">>,
CmdId = 307,
Command = #{<<"requestID">> => CmdId, <<"cacheID">> => CmdId,
Command = #{
<<"requestID">> => CmdId,
<<"cacheID">> => CmdId,
<<"msgType">> => <<"discover">>,
<<"data">> => #{
<<"path">> => <<"/3/0/7">>
} },
}
},
CommandJson = emqx_json:encode(Command),
test_mqtt_broker:publish(CommandTopic, CommandJson, 0),
@ -193,10 +214,13 @@ t_lookup_cmd_discover(Config) ->
"127.0.0.1",
?PORT,
{ok, content},
#coap_content{content_format = <<"application/link-format">>,
payload = PayloadDiscover},
#coap_content{
content_format = <<"application/link-format">>,
payload = PayloadDiscover
},
Request2,
true),
true
),
timer:sleep(200),
discover_received_request(Epn, <<"/3/0/7">>, <<"discover">>).
@ -212,11 +236,16 @@ t_read(Config) ->
UdpSock,
post,
sprintf("coap://127.0.0.1:~b/rd?ep=~ts&lt=600&lwm2m=1", [?PORT, Epn]),
#coap_content{content_format = <<"text/plain">>,
payload = <<"</lwm2m>;rt=\"oma.lwm2m\";ct=11543,"
"</lwm2m/1/0>,</lwm2m/2/0>,</lwm2m/3/0>">>},
#coap_content{
content_format = <<"text/plain">>,
payload = <<
"</lwm2m>;rt=\"oma.lwm2m\";ct=11543,"
"</lwm2m/1/0>,</lwm2m/2/0>,</lwm2m/3/0>"
>>
},
[],
MsgId1),
MsgId1
),
#coap_message{method = Method1} = test_recv_coap_response(UdpSock),
?assertEqual({ok, created}, Method1),
@ -231,7 +260,6 @@ t_read(Config) ->
?assertEqual(get, Method),
?assertEqual([<<"lwm2m">>, <<"3">>, <<"0">>, <<"0">>], maps:get(uri_path, Opts)).
t_write(Config) ->
UdpSock = ?config(sock, Config),
Epn = "urn:oma:lwm2m:oma:4",
@ -244,11 +272,16 @@ t_write(Config) ->
UdpSock,
post,
sprintf("coap://127.0.0.1:~b/rd?ep=~ts&lt=600&lwm2m=1", [?PORT, Epn]),
#coap_content{content_format = <<"text/plain">>,
payload = <<"</lwm2m>;rt=\"oma.lwm2m\";ct=11543,"
"</lwm2m/1/0>,</lwm2m/2/0>,</lwm2m/3/0>">>},
#coap_content{
content_format = <<"text/plain">>,
payload = <<
"</lwm2m>;rt=\"oma.lwm2m\";ct=11543,"
"</lwm2m/1/0>,</lwm2m/2/0>,</lwm2m/3/0>"
>>
},
[],
MsgId1),
MsgId1
),
#coap_message{method = Method1} = test_recv_coap_response(UdpSock),
?assertEqual({ok, created}, Method1),
@ -264,8 +297,6 @@ t_write(Config) ->
?assertEqual([<<"lwm2m">>, <<"3">>, <<"0">>, <<"13">>], maps:get(uri_path, Opts)),
?assertEqual(<<"application/vnd.oma.lwm2m+tlv">>, maps:get(content_format, Opts)).
t_observe(Config) ->
UdpSock = ?config(sock, Config),
Epn = "urn:oma:lwm2m:oma:5",
@ -278,11 +309,16 @@ t_observe(Config) ->
UdpSock,
post,
sprintf("coap://127.0.0.1:~b/rd?ep=~ts&lt=600&lwm2m=1", [?PORT, Epn]),
#coap_content{content_format = <<"text/plain">>,
payload = <<"</lwm2m>;rt=\"oma.lwm2m\";ct=11543,"
"</lwm2m/1/0>,</lwm2m/2/0>,</lwm2m/3/0>">>},
#coap_content{
content_format = <<"text/plain">>,
payload = <<
"</lwm2m>;rt=\"oma.lwm2m\";ct=11543,"
"</lwm2m/1/0>,</lwm2m/2/0>,</lwm2m/3/0>"
>>
},
[],
MsgId1),
MsgId1
),
#coap_message{method = Method1} = test_recv_coap_response(UdpSock),
?assertEqual({ok, created}, Method1),
@ -318,11 +354,13 @@ call_send_api(ClientId, Cmd, Query) ->
no_received_request(ClientId, Path, Action) ->
Response = call_lookup_api(ClientId, Path, Action),
NotReceived = #{<<"clientid">> => list_to_binary(ClientId),
NotReceived = #{
<<"clientid">> => list_to_binary(ClientId),
<<"action">> => Action,
<<"code">> => <<"6.01">>,
<<"codeMsg">> => <<"reply_not_received">>,
<<"path">> => Path},
<<"path">> => Path
},
?assertEqual(NotReceived, emqx_json:decode(Response, [return_maps])).
normal_received_request(ClientId, Path, Action) ->
Response = call_lookup_api(ClientId, Path, Action),

8
apps/emqx_gateway/test/emqx_sn_frame_SUITE.erl
View File

@ -165,10 +165,12 @@ random_test_body() ->
Data = generate_random_binary(),
case catch parse(Data) of
Msg when is_record(Msg, mqtt_sn_message) -> ok;
{'EXIT', {Err, _Stack}}
when Err =:= unkown_message_type;
{'EXIT', {Err, _Stack}} when
Err =:= unkown_message_type;
Err =:= malformed_message_len;
Err =:= malformed_message_flags -> ok
Err =:= malformed_message_flags
->
ok
end.
generate_random_binary() ->

765
apps/emqx_gateway/test/emqx_sn_protocol_SUITE.erl
View File

File diff suppressed because it is too large Load Diff

14
apps/emqx_gateway/test/emqx_sn_registry_SUITE.erl
View File

@ -23,8 +23,10 @@
-define(REGISTRY, emqx_sn_registry).
-define(MAX_PREDEF_ID, 2).
-define(PREDEF_TOPICS, [#{id => 1, topic => <<"/predefined/topic/name/hello">>},
#{id => 2, topic => <<"/predefined/topic/name/nice">>}]).
-define(PREDEF_TOPICS, [
#{id => 1, topic => <<"/predefined/topic/name/hello">>},
#{id => 2, topic => <<"/predefined/topic/name/nice">>}
]).
%%--------------------------------------------------------------------
%% Setups
@ -110,8 +112,12 @@ t_register_case4(Config) ->
t_deny_wildcard_topic(Config) ->
Reg = proplists:get_value(reg, Config),
?assertEqual({error, wildcard_topic}, ?REGISTRY:register_topic(Reg, <<"ClientId">>, <<"/TopicA/#">>)),
?assertEqual({error, wildcard_topic}, ?REGISTRY:register_topic(Reg, <<"ClientId">>, <<"/+/TopicB">>)).
?assertEqual(
{error, wildcard_topic}, ?REGISTRY:register_topic(Reg, <<"ClientId">>, <<"/TopicA/#">>)
),
?assertEqual(
{error, wildcard_topic}, ?REGISTRY:register_topic(Reg, <<"ClientId">>, <<"/+/TopicB">>)
).
%%--------------------------------------------------------------------
%% Helper funcs

676
apps/emqx_gateway/test/emqx_stomp_SUITE.erl
View File

@ -22,25 +22,29 @@
-compile(export_all).
-compile(nowarn_export_all).
-import(emqx_gateway_test_utils,
[ assert_feilds_apperence/2
, request/2
, request/3
]).
-import(
emqx_gateway_test_utils,
[
assert_feilds_apperence/2,
request/2,
request/3
]
).
-define(HEARTBEAT, <<$\n>>).
-define(CONF_DEFAULT, <<"
gateway.stomp {
clientinfo_override {
username = \"${Packet.headers.login}\"
password = \"${Packet.headers.passcode}\"
}
listeners.tcp.default {
bind = 61613
}
}
">>).
-define(CONF_DEFAULT, <<
"\n"
"gateway.stomp {\n"
" clientinfo_override {\n"
" username = \"${Packet.headers.login}\"\n"
" password = \"${Packet.headers.passcode}\"\n"
" }\n"
" listeners.tcp.default {\n"
" bind = 61613\n"
" }\n"
"}\n"
>>).
all() -> emqx_common_test_helpers:all(?MODULE).
@ -64,25 +68,45 @@ end_per_suite(_Cfg) ->
t_connect(_) ->
%% Connect should be succeed
with_connection(fun(Sock) ->
gen_tcp:send(Sock, serialize(<<"CONNECT">>,
[{<<"accept-version">>, ?STOMP_VER},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, ?STOMP_VER},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"1000,2000">>}])),
{<<"heart-beat">>, <<"1000,2000">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, Frame = #stomp_frame{command = <<"CONNECTED">>,
{ok,
Frame = #stomp_frame{
command = <<"CONNECTED">>,
headers = _,
body = _}, _, _} = parse(Data),
body = _
},
_, _} = parse(Data),
<<"2000,1000">> = proplists:get_value(<<"heart-beat">>, Frame#stomp_frame.headers),
gen_tcp:send(Sock, serialize(<<"DISCONNECT">>,
[{<<"receipt">>, <<"12345">>}])),
gen_tcp:send(
Sock,
serialize(
<<"DISCONNECT">>,
[{<<"receipt">>, <<"12345">>}]
)
),
{ok, Data1} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"RECEIPT">>,
{ok,
#stomp_frame{
command = <<"RECEIPT">>,
headers = [{<<"receipt-id">>, <<"12345">>}],
body = _}, _, _} = parse(Data1)
body = _
},
_, _} = parse(Data1)
end),
%% Connect will be failed, because of bad login or passcode
@ -104,34 +128,52 @@ t_connect(_) ->
%% Connect will be failed, because of bad version
with_connection(fun(Sock) ->
gen_tcp:send(Sock,
serialize(<<"CONNECT">>,
[{<<"accept-version">>, <<"2.0,2.1">>},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, <<"2.0,2.1">>},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"1000,2000">>}])),
{<<"heart-beat">>, <<"1000,2000">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, Frame, _, _} = parse(Data),
#stomp_frame{
command = <<"ERROR">>,
headers = _,
body = <<"Login Failed: Supported protocol versions < 1.2">>} = Frame
body = <<"Login Failed: Supported protocol versions < 1.2">>
} = Frame
end).
t_heartbeat(_) ->
%% Test heart beat
with_connection(fun(Sock) ->
gen_tcp:send(Sock, serialize(<<"CONNECT">>,
[{<<"accept-version">>, ?STOMP_VER},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, ?STOMP_VER},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"1000,800">>}])),
{<<"heart-beat">>, <<"1000,800">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"CONNECTED">>,
{ok,
#stomp_frame{
command = <<"CONNECTED">>,
headers = _,
body = _}, _, _} = parse(Data),
body = _
},
_, _} = parse(Data),
{ok, ?HEARTBEAT} = gen_tcp:recv(Sock, 0),
%% Server will close the connection because never receive the heart beat from client
@ -140,235 +182,457 @@ t_heartbeat(_) ->
t_subscribe(_) ->
with_connection(fun(Sock) ->
gen_tcp:send(Sock, serialize(<<"CONNECT">>,
[{<<"accept-version">>, ?STOMP_VER},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, ?STOMP_VER},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"0,0">>}])),
{<<"heart-beat">>, <<"0,0">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"CONNECTED">>,
{ok,
#stomp_frame{
command = <<"CONNECTED">>,
headers = _,
body = _}, _, _} = parse(Data),
body = _
},
_, _} = parse(Data),
%% Subscribe
gen_tcp:send(Sock, serialize(<<"SUBSCRIBE">>,
[{<<"id">>, 0},
gen_tcp:send(
Sock,
serialize(
<<"SUBSCRIBE">>,
[
{<<"id">>, 0},
{<<"destination">>, <<"/queue/foo">>},
{<<"ack">>, <<"auto">>}])),
{<<"ack">>, <<"auto">>}
]
)
),
%% 'user-defined' header will be retain
gen_tcp:send(Sock, serialize(<<"SEND">>,
[{<<"destination">>, <<"/queue/foo">>},
{<<"user-defined">>, <<"emq">>}],
<<"hello">>)),
gen_tcp:send(
Sock,
serialize(
<<"SEND">>,
[
{<<"destination">>, <<"/queue/foo">>},
{<<"user-defined">>, <<"emq">>}
],
<<"hello">>
)
),
{ok, Data1} = gen_tcp:recv(Sock, 0, 1000),
{ok, Frame = #stomp_frame{command = <<"MESSAGE">>,
{ok,
Frame = #stomp_frame{
command = <<"MESSAGE">>,
headers = _,
body = <<"hello">>}, _, _} = parse(Data1),
lists:foreach(fun({Key, Val}) ->
body = <<"hello">>
},
_, _} = parse(Data1),
lists:foreach(
fun({Key, Val}) ->
Val = proplists:get_value(Key, Frame#stomp_frame.headers)
end, [{<<"destination">>, <<"/queue/foo">>},
end,
[
{<<"destination">>, <<"/queue/foo">>},
{<<"subscription">>, <<"0">>},
{<<"user-defined">>, <<"emq">>}]),
{<<"user-defined">>, <<"emq">>}
]
),
%% Unsubscribe
gen_tcp:send(Sock, serialize(<<"UNSUBSCRIBE">>,
[{<<"id">>, 0},
{<<"receipt">>, <<"12345">>}])),
gen_tcp:send(
Sock,
serialize(
<<"UNSUBSCRIBE">>,
[
{<<"id">>, 0},
{<<"receipt">>, <<"12345">>}
]
)
),
{ok, Data2} = gen_tcp:recv(Sock, 0, 1000),
{ok, #stomp_frame{command = <<"RECEIPT">>,
{ok,
#stomp_frame{
command = <<"RECEIPT">>,
headers = [{<<"receipt-id">>, <<"12345">>}],
body = _}, _, _} = parse(Data2),
body = _
},
_, _} = parse(Data2),
gen_tcp:send(Sock, serialize(<<"SEND">>,
gen_tcp:send(
Sock,
serialize(
<<"SEND">>,
[{<<"destination">>, <<"/queue/foo">>}],
<<"You will not receive this msg">>)),
<<"You will not receive this msg">>
)
),
{error, timeout} = gen_tcp:recv(Sock, 0, 500)
end).
t_transaction(_) ->
with_connection(fun(Sock) ->
gen_tcp:send(Sock, serialize(<<"CONNECT">>,
[{<<"accept-version">>, ?STOMP_VER},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, ?STOMP_VER},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"0,0">>}])),
{<<"heart-beat">>, <<"0,0">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"CONNECTED">>,
{ok,
#stomp_frame{
command = <<"CONNECTED">>,
headers = _,
body = _}, _, _} = parse(Data),
body = _
},
_, _} = parse(Data),
%% Subscribe
gen_tcp:send(Sock, serialize(<<"SUBSCRIBE">>,
[{<<"id">>, 0},
gen_tcp:send(
Sock,
serialize(
<<"SUBSCRIBE">>,
[
{<<"id">>, 0},
{<<"destination">>, <<"/queue/foo">>},
{<<"ack">>, <<"auto">>}])),
{<<"ack">>, <<"auto">>}
]
)
),
%% Transaction: tx1
gen_tcp:send(Sock, serialize(<<"BEGIN">>,
[{<<"transaction">>, <<"tx1">>}])),
gen_tcp:send(
Sock,
serialize(
<<"BEGIN">>,
[{<<"transaction">>, <<"tx1">>}]
)
),
gen_tcp:send(Sock, serialize(<<"SEND">>,
[{<<"destination">>, <<"/queue/foo">>},
{<<"transaction">>, <<"tx1">>}],
<<"hello">>)),
gen_tcp:send(
Sock,
serialize(
<<"SEND">>,
[
{<<"destination">>, <<"/queue/foo">>},
{<<"transaction">>, <<"tx1">>}
],
<<"hello">>
)
),
%% You will not receive any messages
{error, timeout} = gen_tcp:recv(Sock, 0, 1000),
gen_tcp:send(Sock, serialize(<<"SEND">>,
[{<<"destination">>, <<"/queue/foo">>},
{<<"transaction">>, <<"tx1">>}],
<<"hello again">>)),
gen_tcp:send(
Sock,
serialize(
<<"SEND">>,
[
{<<"destination">>, <<"/queue/foo">>},
{<<"transaction">>, <<"tx1">>}
],
<<"hello again">>
)
),
gen_tcp:send(Sock, serialize(<<"COMMIT">>,
[{<<"transaction">>, <<"tx1">>}])),
gen_tcp:send(
Sock,
serialize(
<<"COMMIT">>,
[{<<"transaction">>, <<"tx1">>}]
)
),
ct:sleep(1000),
{ok, Data1} = gen_tcp:recv(Sock, 0, 500),
{ok, #stomp_frame{command = <<"MESSAGE">>,
{ok,
#stomp_frame{
command = <<"MESSAGE">>,
headers = _,
body = <<"hello">>}, Rest1, _} = parse(Data1),
body = <<"hello">>
},
Rest1, _} = parse(Data1),
%{ok, Data2} = gen_tcp:recv(Sock, 0, 500),
{ok, #stomp_frame{command = <<"MESSAGE">>,
{ok,
#stomp_frame{
command = <<"MESSAGE">>,
headers = _,
body = <<"hello again">>}, _Rest2, _} = parse(Rest1),
body = <<"hello again">>
},
_Rest2, _} = parse(Rest1),
%% Transaction: tx2
gen_tcp:send(Sock, serialize(<<"BEGIN">>,
[{<<"transaction">>, <<"tx2">>}])),
gen_tcp:send(
Sock,
serialize(
<<"BEGIN">>,
[{<<"transaction">>, <<"tx2">>}]
)
),
gen_tcp:send(Sock, serialize(<<"SEND">>,
[{<<"destination">>, <<"/queue/foo">>},
{<<"transaction">>, <<"tx2">>}],
<<"hello">>)),
gen_tcp:send(
Sock,
serialize(
<<"SEND">>,
[
{<<"destination">>, <<"/queue/foo">>},
{<<"transaction">>, <<"tx2">>}
],
<<"hello">>
)
),
gen_tcp:send(Sock, serialize(<<"ABORT">>,
[{<<"transaction">>, <<"tx2">>}])),
gen_tcp:send(
Sock,
serialize(
<<"ABORT">>,
[{<<"transaction">>, <<"tx2">>}]
)
),
%% You will not receive any messages
{error, timeout} = gen_tcp:recv(Sock, 0, 1000),
gen_tcp:send(Sock, serialize(<<"DISCONNECT">>,
[{<<"receipt">>, <<"12345">>}])),
gen_tcp:send(
Sock,
serialize(
<<"DISCONNECT">>,
[{<<"receipt">>, <<"12345">>}]
)
),
{ok, Data3} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"RECEIPT">>,
{ok,
#stomp_frame{
command = <<"RECEIPT">>,
headers = [{<<"receipt-id">>, <<"12345">>}],
body = _}, _, _} = parse(Data3)
body = _
},
_, _} = parse(Data3)
end).
t_receipt_in_error(_) ->
with_connection(fun(Sock) ->
gen_tcp:send(Sock, serialize(<<"CONNECT">>,
[{<<"accept-version">>, ?STOMP_VER},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, ?STOMP_VER},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"0,0">>}])),
{<<"heart-beat">>, <<"0,0">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"CONNECTED">>,
{ok,
#stomp_frame{
command = <<"CONNECTED">>,
headers = _,
body = _}, _, _} = parse(Data),
body = _
},
_, _} = parse(Data),
gen_tcp:send(Sock, serialize(<<"ABORT">>,
[{<<"transaction">>, <<"tx1">>},
{<<"receipt">>, <<"12345">>}])),
gen_tcp:send(
Sock,
serialize(
<<"ABORT">>,
[
{<<"transaction">>, <<"tx1">>},
{<<"receipt">>, <<"12345">>}
]
)
),
{ok, Data1} = gen_tcp:recv(Sock, 0),
{ok, Frame = #stomp_frame{command = <<"ERROR">>,
{ok,
Frame = #stomp_frame{
command = <<"ERROR">>,
headers = _,
body = <<"Transaction tx1 not found">>}, _, _} = parse(Data1),
body = <<"Transaction tx1 not found">>
},
_, _} = parse(Data1),
<<"12345">> = proplists:get_value(<<"receipt-id">>, Frame#stomp_frame.headers)
end).
t_ack(_) ->
with_connection(fun(Sock) ->
gen_tcp:send(Sock, serialize(<<"CONNECT">>,
[{<<"accept-version">>, ?STOMP_VER},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, ?STOMP_VER},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"0,0">>}])),
{<<"heart-beat">>, <<"0,0">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"CONNECTED">>,
{ok,
#stomp_frame{
command = <<"CONNECTED">>,
headers = _,
body = _}, _, _} = parse(Data),
body = _
},
_, _} = parse(Data),
%% Subscribe
gen_tcp:send(Sock, serialize(<<"SUBSCRIBE">>,
[{<<"id">>, 0},
gen_tcp:send(
Sock,
serialize(
<<"SUBSCRIBE">>,
[
{<<"id">>, 0},
{<<"destination">>, <<"/queue/foo">>},
{<<"ack">>, <<"client">>}])),
{<<"ack">>, <<"client">>}
]
)
),
gen_tcp:send(Sock, serialize(<<"SEND">>,
gen_tcp:send(
Sock,
serialize(
<<"SEND">>,
[{<<"destination">>, <<"/queue/foo">>}],
<<"ack test">>)),
<<"ack test">>
)
),
{ok, Data1} = gen_tcp:recv(Sock, 0),
{ok, Frame = #stomp_frame{command = <<"MESSAGE">>,
{ok,
Frame = #stomp_frame{
command = <<"MESSAGE">>,
headers = _,
body = <<"ack test">>}, _, _} = parse(Data1),
body = <<"ack test">>
},
_, _} = parse(Data1),
AckId = proplists:get_value(<<"ack">>, Frame#stomp_frame.headers),
gen_tcp:send(Sock, serialize(<<"ACK">>,
[{<<"id">>, AckId},
{<<"receipt">>, <<"12345">>}])),
gen_tcp:send(
Sock,
serialize(
<<"ACK">>,
[
{<<"id">>, AckId},
{<<"receipt">>, <<"12345">>}
]
)
),
{ok, Data2} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"RECEIPT">>,
{ok,
#stomp_frame{
command = <<"RECEIPT">>,
headers = [{<<"receipt-id">>, <<"12345">>}],
body = _}, _, _} = parse(Data2),
body = _
},
_, _} = parse(Data2),
gen_tcp:send(Sock, serialize(<<"SEND">>,
gen_tcp:send(
Sock,
serialize(
<<"SEND">>,
[{<<"destination">>, <<"/queue/foo">>}],
<<"nack test">>)),
<<"nack test">>
)
),
{ok, Data3} = gen_tcp:recv(Sock, 0),
{ok, Frame1 = #stomp_frame{command = <<"MESSAGE">>,
{ok,
Frame1 = #stomp_frame{
command = <<"MESSAGE">>,
headers = _,
body = <<"nack test">>}, _, _} = parse(Data3),
body = <<"nack test">>
},
_, _} = parse(Data3),
AckId1 = proplists:get_value(<<"ack">>, Frame1#stomp_frame.headers),
gen_tcp:send(Sock, serialize(<<"NACK">>,
[{<<"id">>, AckId1},
{<<"receipt">>, <<"12345">>}])),
gen_tcp:send(
Sock,
serialize(
<<"NACK">>,
[
{<<"id">>, AckId1},
{<<"receipt">>, <<"12345">>}
]
)
),
{ok, Data4} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"RECEIPT">>,
{ok,
#stomp_frame{
command = <<"RECEIPT">>,
headers = [{<<"receipt-id">>, <<"12345">>}],
body = _}, _, _} = parse(Data4)
body = _
},
_, _} = parse(Data4)
end).
t_1000_msg_send(_) ->
with_connection(fun(Sock) ->
gen_tcp:send(Sock, serialize(<<"CONNECT">>,
[{<<"accept-version">>, ?STOMP_VER},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, ?STOMP_VER},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"0,0">>}])),
{<<"heart-beat">>, <<"0,0">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"CONNECTED">>,
{ok,
#stomp_frame{
command = <<"CONNECTED">>,
headers = _,
body = _}, _, _} = parse(Data),
body = _
},
_, _} = parse(Data),
Topic = <<"/queue/foo">>,
SendFun = fun() ->
gen_tcp:send(Sock, serialize(<<"SEND">>,
gen_tcp:send(
Sock,
serialize(
<<"SEND">>,
[{<<"destination">>, Topic}],
<<"msgtest">>))
<<"msgtest">>
)
)
end,
RecvFun = fun() ->
@ -387,23 +651,36 @@ t_1000_msg_send(_) ->
t_sticky_packets_truncate_after_headers(_) ->
with_connection(fun(Sock) ->
gen_tcp:send(Sock, serialize(<<"CONNECT">>,
[{<<"accept-version">>, ?STOMP_VER},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, ?STOMP_VER},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"0,0">>}])),
{<<"heart-beat">>, <<"0,0">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"CONNECTED">>,
{ok,
#stomp_frame{
command = <<"CONNECTED">>,
headers = _,
body = _}, _, _} = parse(Data),
body = _
},
_, _} = parse(Data),
Topic = <<"/queue/foo">>,
emqx:subscribe(Topic),
gen_tcp:send(Sock, ["SEND\n",
gen_tcp:send(Sock, [
"SEND\n",
"content-length:3\n",
"destination:/queue/foo\n"]),
"destination:/queue/foo\n"
]),
timer:sleep(300),
gen_tcp:send(Sock, ["\nfoo", 0]),
receive
@ -415,51 +692,106 @@ t_sticky_packets_truncate_after_headers(_) ->
end).
t_rest_clienit_info(_) ->
with_connection(fun(Sock) ->
gen_tcp:send(Sock, serialize(<<"CONNECT">>,
[{<<"accept-version">>, ?STOMP_VER},
gen_tcp:send(
Sock,
serialize(
<<"CONNECT">>,
[
{<<"accept-version">>, ?STOMP_VER},
{<<"host">>, <<"127.0.0.1:61613">>},
{<<"login">>, <<"guest">>},
{<<"passcode">>, <<"guest">>},
{<<"heart-beat">>, <<"0,0">>}])),
{<<"heart-beat">>, <<"0,0">>}
]
)
),
{ok, Data} = gen_tcp:recv(Sock, 0),
{ok, #stomp_frame{command = <<"CONNECTED">>,
{ok,
#stomp_frame{
command = <<"CONNECTED">>,
headers = _,
body = _}, _, _} = parse(Data),
body = _
},
_, _} = parse(Data),
%% client lists
{200, Clients} = request(get, "/gateway/stomp/clients"),
?assertEqual(1, length(maps:get(data, Clients))),
StompClient = lists:nth(1, maps:get(data, Clients)),
ClientId = maps:get(clientid, StompClient),
ClientPath = "/gateway/stomp/clients/"
++ binary_to_list(ClientId),
ClientPath =
"/gateway/stomp/clients/" ++
binary_to_list(ClientId),
{200, StompClient1} = request(get, ClientPath),
?assertEqual(StompClient, StompClient1),
assert_feilds_apperence(
[proto_name, awaiting_rel_max, inflight_cnt, disconnected_at,
send_msg, heap_size, connected, recv_cnt, send_pkt, mailbox_len,
username, recv_pkt, expiry_interval, clientid, mqueue_max,
send_oct, ip_address, is_bridge, awaiting_rel_cnt, mqueue_dropped,
mqueue_len, node, inflight_max, reductions, subscriptions_max,
connected_at, keepalive, created_at, clean_start,
subscriptions_cnt, recv_msg, send_cnt, proto_ver, recv_oct
], StompClient),
[
proto_name,
awaiting_rel_max,
inflight_cnt,
disconnected_at,
send_msg,
heap_size,
connected,
recv_cnt,
send_pkt,
mailbox_len,
username,
recv_pkt,
expiry_interval,
clientid,
mqueue_max,
send_oct,
ip_address,
is_bridge,
awaiting_rel_cnt,
mqueue_dropped,
mqueue_len,
node,
inflight_max,
reductions,
subscriptions_max,
connected_at,
keepalive,
created_at,
clean_start,
subscriptions_cnt,
recv_msg,
send_cnt,
proto_ver,
recv_oct
],
StompClient
),
%% sub & unsub
{200, []} = request(get, ClientPath ++ "/subscriptions"),
gen_tcp:send(Sock, serialize(<<"SUBSCRIBE">>,
[{<<"id">>, 0},
gen_tcp:send(
Sock,
serialize(
<<"SUBSCRIBE">>,
[
{<<"id">>, 0},
{<<"destination">>, <<"/queue/foo">>},
{<<"ack">>, <<"client">>}])),
{<<"ack">>, <<"client">>}
]
)
),
timer:sleep(100),
{200, Subs} = request(get, ClientPath ++ "/subscriptions"),
?assertEqual(1, length(Subs)),
assert_feilds_apperence([topic, qos], lists:nth(1, Subs)),
{201, _} = request(post, ClientPath ++ "/subscriptions",
#{topic => <<"t/a">>, qos => 1,
sub_props => #{subid => <<"1001">>}}),
{201, _} = request(
post,
ClientPath ++ "/subscriptions",
#{
topic => <<"t/a">>,
qos => 1,
sub_props => #{subid => <<"1001">>}
}
),
{200, Subs1} = request(get, ClientPath ++ "/subscriptions"),
?assertEqual(2, length(Subs1)),
@ -470,7 +802,8 @@ t_rest_clienit_info(_) ->
%% kickout
{204, _} = request(delete, ClientPath),
ignored = gen_server:call(emqx_cm, ignore, infinity), % sync
% sync
ignored = gen_server:call(emqx_cm, ignore, infinity),
ok = emqx_pool:flush_async_tasks(),
{200, Clients2} = request(get, "/gateway/stomp/clients"),
?assertEqual(0, length(maps:get(data, Clients2)))
@ -484,10 +817,12 @@ t_rest_clienit_info(_) ->
%% TODO: RateLimit, OOM,
with_connection(DoFun) ->
{ok, Sock} = gen_tcp:connect({127, 0, 0, 1},
{ok, Sock} = gen_tcp:connect(
{127, 0, 0, 1},
61613,
[binary, {packet, raw}, {active, false}],
3000),
3000
),
try
DoFun(Sock)
after
@ -501,7 +836,8 @@ serialize(Command, Headers, Body) ->
emqx_stomp_frame:serialize_pkt(emqx_stomp_frame:make(Command, Headers, Body), #{}).
parse(Data) ->
ProtoEnv = #{max_headers => 10,
ProtoEnv = #{
max_headers => 10,
max_header_length => 1024,
max_body_length => 8192
},

15
apps/emqx_gateway/test/emqx_stomp_heartbeat_SUITE.erl
View File

@ -41,19 +41,24 @@ t_check_1(_) ->
t_check_2(_) ->
HrtBt = emqx_stomp_heartbeat:init({1, 0}),
#{incoming := _} = lists:foldl(fun(I, Acc) ->
#{incoming := _} = lists:foldl(
fun(I, Acc) ->
{ok, NAcc} = emqx_stomp_heartbeat:check(incoming, I, Acc),
NAcc
end, HrtBt, lists:seq(1,1000)),
end,
HrtBt,
lists:seq(1, 1000)
),
ok.
t_info(_) ->
HrtBt = emqx_stomp_heartbeat:init({100, 100}),
#{incoming := _,
outgoing := _} = emqx_stomp_heartbeat:info(HrtBt).
#{
incoming := _,
outgoing := _
} = emqx_stomp_heartbeat:info(HrtBt).
t_interval(_) ->
HrtBt = emqx_stomp_heartbeat:init({1, 0}),
1 = emqx_stomp_heartbeat:interval(incoming, HrtBt),
undefined = emqx_stomp_heartbeat:interval(outgoing, HrtBt).

302
apps/emqx_gateway/test/emqx_tlv_SUITE.erl
View File

@ -30,8 +30,18 @@
%%--------------------------------------------------------------------
all() ->
[case01, case02, case03, case03_0,
case04, case05, case06, case07, case08, case09].
[
case01,
case02,
case03,
case03_0,
case04,
case05,
case06,
case07,
case08,
case09
].
init_per_suite(Config) ->
Config.
@ -44,9 +54,9 @@ end_per_suite(Config) ->
%%--------------------------------------------------------------------
case01(_Config) ->
Data = <<16#C8, 16#00, 16#14, 16#4F, 16#70, 16#65, 16#6E, 16#20,
16#4D, 16#6F, 16#62, 16#69, 16#6C, 16#65, 16#20, 16#41,
16#6C, 16#6C, 16#69, 16#61, 16#6E, 16#63, 16#65>>,
Data =
<<16#C8, 16#00, 16#14, 16#4F, 16#70, 16#65, 16#6E, 16#20, 16#4D, 16#6F, 16#62, 16#69, 16#6C,
16#65, 16#20, 16#41, 16#6C, 16#6C, 16#69, 16#61, 16#6E, 16#63, 16#65>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [
#{tlv_resource_with_value => 16#00, value => <<"Open Mobile Alliance">>}
@ -58,25 +68,29 @@ case01(_Config) ->
case02(_Config) ->
Data = <<16#86, 16#06, 16#41, 16#00, 16#01, 16#41, 16#01, 16#05>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [ #{tlv_multiple_resource => 16#06,
value => [ #{tlv_resource_instance => 16#00, value => <<1>>},
#{tlv_resource_instance => 16#01, value => <<5>>}]}
Exp = [
#{
tlv_multiple_resource => 16#06,
value => [
#{tlv_resource_instance => 16#00, value => <<1>>},
#{tlv_resource_instance => 16#01, value => <<5>>}
]
}
],
?assertEqual(Exp, R),
EncodedBinary = emqx_lwm2m_tlv:encode(Exp),
?assertEqual(EncodedBinary, Data).
case03(_Config) ->
Data = <<16#C8, 16#00, 16#14, 16#4F, 16#70, 16#65, 16#6E, 16#20,
16#4D, 16#6F, 16#62, 16#69, 16#6C, 16#65, 16#20, 16#41,
16#6C, 16#6C, 16#69, 16#61, 16#6E, 16#63, 16#65, 16#C8,
16#01, 16#16, 16#4C, 16#69, 16#67, 16#68, 16#74, 16#77,
16#65, 16#69, 16#67, 16#68, 16#74, 16#20, 16#4D, 16#32,
16#4D, 16#20, 16#43, 16#6C, 16#69, 16#65, 16#6E, 16#74,
16#C8, 16#02, 16#09, 16#33, 16#34, 16#35, 16#30, 16#30,
16#30, 16#31, 16#32, 16#33>>,
Data =
<<16#C8, 16#00, 16#14, 16#4F, 16#70, 16#65, 16#6E, 16#20, 16#4D, 16#6F, 16#62, 16#69, 16#6C,
16#65, 16#20, 16#41, 16#6C, 16#6C, 16#69, 16#61, 16#6E, 16#63, 16#65, 16#C8, 16#01,
16#16, 16#4C, 16#69, 16#67, 16#68, 16#74, 16#77, 16#65, 16#69, 16#67, 16#68, 16#74,
16#20, 16#4D, 16#32, 16#4D, 16#20, 16#43, 16#6C, 16#69, 16#65, 16#6E, 16#74, 16#C8,
16#02, 16#09, 16#33, 16#34, 16#35, 16#30, 16#30, 16#30, 16#31, 16#32, 16#33>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [ #{tlv_resource_with_value => 16#00, value => <<"Open Mobile Alliance">>},
Exp = [
#{tlv_resource_with_value => 16#00, value => <<"Open Mobile Alliance">>},
#{tlv_resource_with_value => 16#01, value => <<"Lightweight M2M Client">>},
#{tlv_resource_with_value => 16#02, value => <<"345000123">>}
],
@ -87,10 +101,14 @@ case03(_Config) ->
case03_0(_Config) ->
Data = <<16#87, 16#02, 16#41, 16#7F, 16#07, 16#61, 16#01, 16#36, 16#01>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [ #{tlv_multiple_resource => 16#02,
value => [ #{tlv_resource_instance => 16#7F, value => <<16#07>>},
Exp = [
#{
tlv_multiple_resource => 16#02,
value => [
#{tlv_resource_instance => 16#7F, value => <<16#07>>},
#{tlv_resource_instance => 16#0136, value => <<16#01>>}
]}
]
}
],
?assertEqual(Exp, R),
EncodedBinary = emqx_lwm2m_tlv:encode(Exp),
@ -98,35 +116,50 @@ case03_0(_Config) ->
case04(_Config) ->
% 6.4.3.1 Single Object Instance Request Example
Data = <<16#C8, 16#00, 16#14, 16#4F, 16#70, 16#65, 16#6E, 16#20,
16#4D, 16#6F, 16#62, 16#69, 16#6C, 16#65, 16#20, 16#41,
16#6C, 16#6C, 16#69, 16#61, 16#6E, 16#63, 16#65, 16#C8,
16#01, 16#16, 16#4C, 16#69, 16#67, 16#68, 16#74, 16#77,
16#65, 16#69, 16#67, 16#68, 16#74, 16#20, 16#4D, 16#32,
16#4D, 16#20, 16#43, 16#6C, 16#69, 16#65, 16#6E, 16#74,
16#C8, 16#02, 16#09, 16#33, 16#34, 16#35, 16#30, 16#30,
16#30, 16#31, 16#32, 16#33, 16#C3, 16#03, 16#31, 16#2E,
16#30, 16#86, 16#06, 16#41, 16#00, 16#01, 16#41, 16#01,
16#05, 16#88, 16#07, 16#08, 16#42, 16#00, 16#0E, 16#D8,
16#42, 16#01, 16#13, 16#88, 16#87, 16#08, 16#41, 16#00,
16#7D, 16#42, 16#01, 16#03, 16#84, 16#C1, 16#09, 16#64,
16#C1, 16#0A, 16#0F, 16#83, 16#0B, 16#41, 16#00, 16#00,
16#C4, 16#0D, 16#51, 16#82, 16#42, 16#8F, 16#C6, 16#0E,
16#2B, 16#30, 16#32, 16#3A, 16#30, 16#30, 16#C1, 16#10, 16#55>>,
Data =
<<16#C8, 16#00, 16#14, 16#4F, 16#70, 16#65, 16#6E, 16#20, 16#4D, 16#6F, 16#62, 16#69, 16#6C,
16#65, 16#20, 16#41, 16#6C, 16#6C, 16#69, 16#61, 16#6E, 16#63, 16#65, 16#C8, 16#01,
16#16, 16#4C, 16#69, 16#67, 16#68, 16#74, 16#77, 16#65, 16#69, 16#67, 16#68, 16#74,
16#20, 16#4D, 16#32, 16#4D, 16#20, 16#43, 16#6C, 16#69, 16#65, 16#6E, 16#74, 16#C8,
16#02, 16#09, 16#33, 16#34, 16#35, 16#30, 16#30, 16#30, 16#31, 16#32, 16#33, 16#C3,
16#03, 16#31, 16#2E, 16#30, 16#86, 16#06, 16#41, 16#00, 16#01, 16#41, 16#01, 16#05,
16#88, 16#07, 16#08, 16#42, 16#00, 16#0E, 16#D8, 16#42, 16#01, 16#13, 16#88, 16#87,
16#08, 16#41, 16#00, 16#7D, 16#42, 16#01, 16#03, 16#84, 16#C1, 16#09, 16#64, 16#C1,
16#0A, 16#0F, 16#83, 16#0B, 16#41, 16#00, 16#00, 16#C4, 16#0D, 16#51, 16#82, 16#42,
16#8F, 16#C6, 16#0E, 16#2B, 16#30, 16#32, 16#3A, 16#30, 16#30, 16#C1, 16#10, 16#55>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [ #{tlv_resource_with_value => 16#00, value => <<"Open Mobile Alliance">>},
Exp = [
#{tlv_resource_with_value => 16#00, value => <<"Open Mobile Alliance">>},
#{tlv_resource_with_value => 16#01, value => <<"Lightweight M2M Client">>},
#{tlv_resource_with_value => 16#02, value => <<"345000123">>},
#{tlv_resource_with_value => 16#03, value => <<"1.0">>},
#{tlv_multiple_resource => 16#06, value => [#{tlv_resource_instance => 16#00, value => <<1>>},
#{tlv_resource_instance => 16#01, value => <<5>>}]},
#{tlv_multiple_resource => 16#07, value => [#{tlv_resource_instance => 16#00, value => <<16#0ED8:16>>},
#{tlv_resource_instance => 16#01, value => <<16#1388:16>>}]},
#{tlv_multiple_resource => 16#08, value => [#{tlv_resource_instance => 16#00, value => <<16#7d>>},
#{tlv_resource_instance => 16#01, value => <<16#0384:16>>}]},
#{
tlv_multiple_resource => 16#06,
value => [
#{tlv_resource_instance => 16#00, value => <<1>>},
#{tlv_resource_instance => 16#01, value => <<5>>}
]
},
#{
tlv_multiple_resource => 16#07,
value => [
#{tlv_resource_instance => 16#00, value => <<16#0ED8:16>>},
#{tlv_resource_instance => 16#01, value => <<16#1388:16>>}
]
},
#{
tlv_multiple_resource => 16#08,
value => [
#{tlv_resource_instance => 16#00, value => <<16#7d>>},
#{tlv_resource_instance => 16#01, value => <<16#0384:16>>}
]
},
#{tlv_resource_with_value => 16#09, value => <<16#64>>},
#{tlv_resource_with_value => 16#0A, value => <<16#0F>>},
#{tlv_multiple_resource => 16#0B, value => [#{tlv_resource_instance => 16#00, value => <<16#00>>}]},
#{
tlv_multiple_resource => 16#0B,
value => [#{tlv_resource_instance => 16#00, value => <<16#00>>}]
},
#{tlv_resource_with_value => 16#0D, value => <<16#5182428F:32>>},
#{tlv_resource_with_value => 16#0E, value => <<"+02:00">>},
#{tlv_resource_with_value => 16#10, value => <<"U">>}
@ -138,43 +171,59 @@ case04(_Config) ->
case05(_Config) ->
% 6.4.3.2 Multiple Object Instance Request Examples
% A) Request on Single-Instance Object
Data = <<16#08, 16#00, 16#79, 16#C8, 16#00, 16#14, 16#4F, 16#70,
16#65, 16#6E, 16#20, 16#4D, 16#6F, 16#62, 16#69, 16#6C,
16#65, 16#20, 16#41, 16#6C, 16#6C, 16#69, 16#61, 16#6E,
16#63, 16#65, 16#C8, 16#01, 16#16, 16#4C, 16#69, 16#67,
16#68, 16#74, 16#77, 16#65, 16#69, 16#67, 16#68, 16#74,
16#20, 16#4D, 16#32, 16#4D, 16#20, 16#43, 16#6C, 16#69,
16#65, 16#6E, 16#74, 16#C8, 16#02, 16#09, 16#33, 16#34,
16#35, 16#30, 16#30, 16#30, 16#31, 16#32, 16#33, 16#C3,
16#03, 16#31, 16#2E, 16#30, 16#86, 16#06, 16#41, 16#00,
16#01, 16#41, 16#01, 16#05, 16#88, 16#07, 16#08, 16#42,
16#00, 16#0E, 16#D8, 16#42, 16#01, 16#13, 16#88, 16#87,
16#08, 16#41, 16#00, 16#7D, 16#42, 16#01, 16#03, 16#84,
16#C1, 16#09, 16#64, 16#C1, 16#0A, 16#0F, 16#83, 16#0B,
16#41, 16#00, 16#00, 16#C4, 16#0D, 16#51, 16#82, 16#42,
16#8F, 16#C6, 16#0E, 16#2B, 16#30, 16#32, 16#3A, 16#30,
16#30, 16#C1, 16#10, 16#55>>,
Data =
<<16#08, 16#00, 16#79, 16#C8, 16#00, 16#14, 16#4F, 16#70, 16#65, 16#6E, 16#20, 16#4D, 16#6F,
16#62, 16#69, 16#6C, 16#65, 16#20, 16#41, 16#6C, 16#6C, 16#69, 16#61, 16#6E, 16#63,
16#65, 16#C8, 16#01, 16#16, 16#4C, 16#69, 16#67, 16#68, 16#74, 16#77, 16#65, 16#69,
16#67, 16#68, 16#74, 16#20, 16#4D, 16#32, 16#4D, 16#20, 16#43, 16#6C, 16#69, 16#65,
16#6E, 16#74, 16#C8, 16#02, 16#09, 16#33, 16#34, 16#35, 16#30, 16#30, 16#30, 16#31,
16#32, 16#33, 16#C3, 16#03, 16#31, 16#2E, 16#30, 16#86, 16#06, 16#41, 16#00, 16#01,
16#41, 16#01, 16#05, 16#88, 16#07, 16#08, 16#42, 16#00, 16#0E, 16#D8, 16#42, 16#01,
16#13, 16#88, 16#87, 16#08, 16#41, 16#00, 16#7D, 16#42, 16#01, 16#03, 16#84, 16#C1,
16#09, 16#64, 16#C1, 16#0A, 16#0F, 16#83, 16#0B, 16#41, 16#00, 16#00, 16#C4, 16#0D,
16#51, 16#82, 16#42, 16#8F, 16#C6, 16#0E, 16#2B, 16#30, 16#32, 16#3A, 16#30, 16#30,
16#C1, 16#10, 16#55>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [
#{tlv_object_instance => 16#00, value => [
#{
tlv_object_instance => 16#00,
value => [
#{tlv_resource_with_value => 16#00, value => <<"Open Mobile Alliance">>},
#{tlv_resource_with_value => 16#01, value => <<"Lightweight M2M Client">>},
#{tlv_resource_with_value => 16#02, value => <<"345000123">>},
#{tlv_resource_with_value => 16#03, value => <<"1.0">>},
#{tlv_multiple_resource => 16#06, value => [#{tlv_resource_instance => 16#00, value => <<1>>},
#{tlv_resource_instance => 16#01, value => <<5>>}]},
#{tlv_multiple_resource => 16#07, value => [#{tlv_resource_instance => 16#00, value => <<16#0ED8:16>>},
#{
tlv_multiple_resource => 16#06,
value => [
#{tlv_resource_instance => 16#00, value => <<1>>},
#{tlv_resource_instance => 16#01, value => <<5>>}
]
},
#{
tlv_multiple_resource => 16#07,
value => [
#{tlv_resource_instance => 16#00, value => <<16#0ED8:16>>},
#{tlv_resource_instance => 16#01, value => <<16#1388:16>>}
]},
#{tlv_multiple_resource => 16#08, value => [#{tlv_resource_instance => 16#00, value => <<16#7d>>},
#{tlv_resource_instance => 16#01, value => <<16#0384:16>>}]},
]
},
#{
tlv_multiple_resource => 16#08,
value => [
#{tlv_resource_instance => 16#00, value => <<16#7d>>},
#{tlv_resource_instance => 16#01, value => <<16#0384:16>>}
]
},
#{tlv_resource_with_value => 16#09, value => <<16#64>>},
#{tlv_resource_with_value => 16#0A, value => <<16#0F>>},
#{tlv_multiple_resource => 16#0B, value => [#{tlv_resource_instance => 16#00, value => <<16#00>>}]},
#{
tlv_multiple_resource => 16#0B,
value => [#{tlv_resource_instance => 16#00, value => <<16#00>>}]
},
#{tlv_resource_with_value => 16#0D, value => <<16#5182428F:32>>},
#{tlv_resource_with_value => 16#0E, value => <<"+02:00">>},
#{tlv_resource_with_value => 16#10, value => <<"U">>}
]}
]
}
],
?assertEqual(Exp, R),
EncodedBinary = emqx_lwm2m_tlv:encode(Exp),
@ -183,24 +232,40 @@ case05(_Config) ->
case06(_Config) ->
% 6.4.3.2 Multiple Object Instance Request Examples
% B) Request on Multiple-Instances Object having 2 instances
Data = <<16#08, 16#00, 16#0E, 16#C1, 16#00, 16#01, 16#C1, 16#01,
16#00, 16#83, 16#02, 16#41, 16#7F, 16#07, 16#C1, 16#03,
16#7F, 16#08, 16#02, 16#12, 16#C1, 16#00, 16#03, 16#C1,
16#01, 16#00, 16#87, 16#02, 16#41, 16#7F, 16#07, 16#61,
16#01, 16#36, 16#01, 16#C1, 16#03, 16#7F>>,
Data =
<<16#08, 16#00, 16#0E, 16#C1, 16#00, 16#01, 16#C1, 16#01, 16#00, 16#83, 16#02, 16#41, 16#7F,
16#07, 16#C1, 16#03, 16#7F, 16#08, 16#02, 16#12, 16#C1, 16#00, 16#03, 16#C1, 16#01,
16#00, 16#87, 16#02, 16#41, 16#7F, 16#07, 16#61, 16#01, 16#36, 16#01, 16#C1, 16#03,
16#7F>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [#{tlv_object_instance => 16#00, value => [#{tlv_resource_with_value => 16#00, value => <<16#01>>},
Exp = [
#{
tlv_object_instance => 16#00,
value => [
#{tlv_resource_with_value => 16#00, value => <<16#01>>},
#{tlv_resource_with_value => 16#01, value => <<16#00>>},
#{tlv_multiple_resource => 16#02,
value => [#{tlv_resource_instance => 16#7F, value => <<16#07>>}]},
#{
tlv_multiple_resource => 16#02,
value => [#{tlv_resource_instance => 16#7F, value => <<16#07>>}]
},
#{tlv_resource_with_value => 16#03, value => <<16#7F>>}
]},
#{tlv_object_instance => 16#02, value => [#{tlv_resource_with_value => 16#00, value => <<16#03>>},
]
},
#{
tlv_object_instance => 16#02,
value => [
#{tlv_resource_with_value => 16#00, value => <<16#03>>},
#{tlv_resource_with_value => 16#01, value => <<16#00>>},
#{tlv_multiple_resource => 16#02,
value => [#{tlv_resource_instance => 16#7F, value => <<16#07>>},
#{tlv_resource_instance => 16#0136, value => <<16#01>>}]},
#{tlv_resource_with_value => 16#03, value => <<16#7F>>}]}
#{
tlv_multiple_resource => 16#02,
value => [
#{tlv_resource_instance => 16#7F, value => <<16#07>>},
#{tlv_resource_instance => 16#0136, value => <<16#01>>}
]
},
#{tlv_resource_with_value => 16#03, value => <<16#7F>>}
]
}
],
?assertEqual(Exp, R),
EncodedBinary = emqx_lwm2m_tlv:encode(Exp),
@ -209,15 +274,20 @@ case06(_Config) ->
case07(_Config) ->
% 6.4.3.2 Multiple Object Instance Request Examples
% C) Request on Multiple-Instances Object having 1 instance only
Data = <<16#08, 16#00, 16#0F, 16#C1, 16#00, 16#01, 16#C4, 16#01,
16#00, 16#01, 16#51, 16#80, 16#C1, 16#06, 16#01, 16#C1,
16#07, 16#55>>,
Data =
<<16#08, 16#00, 16#0F, 16#C1, 16#00, 16#01, 16#C4, 16#01, 16#00, 16#01, 16#51, 16#80, 16#C1,
16#06, 16#01, 16#C1, 16#07, 16#55>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [#{tlv_object_instance => 16#00,
value => [#{tlv_resource_with_value => 16#00, value => <<16#01>>},
Exp = [
#{
tlv_object_instance => 16#00,
value => [
#{tlv_resource_with_value => 16#00, value => <<16#01>>},
#{tlv_resource_with_value => 16#01, value => <<86400:32>>},
#{tlv_resource_with_value => 16#06, value => <<16#01>>},
#{tlv_resource_with_value => 16#07, value => <<$U>>}]}
#{tlv_resource_with_value => 16#07, value => <<$U>>}
]
}
],
?assertEqual(Exp, R),
EncodedBinary = emqx_lwm2m_tlv:encode(Exp),
@ -226,14 +296,19 @@ case07(_Config) ->
case08(_Config) ->
% 6.4.3.3 Example of Request on an Object Instance containing an Object Link Resource
% Example 1) request to Object 65 Instance 0: Read /65/0
Data = <<16#88, 16#00, 16#0C, 16#44, 16#00, 16#00, 16#42, 16#00,
16#00, 16#44, 16#01, 16#00, 16#42, 16#00, 16#01, 16#C8,
16#01, 16#0D, 16#38, 16#36, 16#31, 16#33, 16#38, 16#30,
16#30, 16#37, 16#35, 16#35, 16#35, 16#30, 16#30, 16#C4,
16#02, 16#12, 16#34, 16#56, 16#78>>,
Data =
<<16#88, 16#00, 16#0C, 16#44, 16#00, 16#00, 16#42, 16#00, 16#00, 16#44, 16#01, 16#00, 16#42,
16#00, 16#01, 16#C8, 16#01, 16#0D, 16#38, 16#36, 16#31, 16#33, 16#38, 16#30, 16#30,
16#37, 16#35, 16#35, 16#35, 16#30, 16#30, 16#C4, 16#02, 16#12, 16#34, 16#56, 16#78>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [#{tlv_multiple_resource => 16#00, value => [#{tlv_resource_instance => 16#00, value => <<16#00, 16#42, 16#00, 16#00>>},
#{tlv_resource_instance => 16#01, value => <<16#00, 16#42, 16#00, 16#01>>}]},
Exp = [
#{
tlv_multiple_resource => 16#00,
value => [
#{tlv_resource_instance => 16#00, value => <<16#00, 16#42, 16#00, 16#00>>},
#{tlv_resource_instance => 16#01, value => <<16#00, 16#42, 16#00, 16#01>>}
]
},
#{tlv_resource_with_value => 16#01, value => <<"8613800755500">>},
#{tlv_resource_with_value => 16#02, value => <<16#12345678:32>>}
],
@ -244,25 +319,32 @@ case08(_Config) ->
case09(_Config) ->
% 6.4.3.3 Example of Request on an Object Instance containing an Object Link Resource
% Example 2) request to Object 66: Read /66: TLV payload will contain 2 Object Instances
Data = <<16#08, 16#00, 16#26, 16#C8, 16#00, 16#0B, 16#6D, 16#79,
16#53, 16#65, 16#72, 16#76, 16#69, 16#63, 16#65, 16#20,
16#31, 16#C8, 16#01, 16#0F, 16#49, 16#6E, 16#74, 16#65,
16#72, 16#6E, 16#65, 16#74, 16#2E, 16#31, 16#35, 16#2E,
16#32, 16#33, 16#34, 16#C4, 16#02, 16#00, 16#43, 16#00,
16#00, 16#08, 16#01, 16#26, 16#C8, 16#00, 16#0B, 16#6D,
16#79, 16#53, 16#65, 16#72, 16#76, 16#69, 16#63, 16#65,
16#20, 16#32, 16#C8, 16#01, 16#0F, 16#49, 16#6E, 16#74,
16#65, 16#72, 16#6E, 16#65, 16#74, 16#2E, 16#31, 16#35,
16#2E, 16#32, 16#33, 16#35, 16#C4, 16#02, 16#FF, 16#FF,
16#FF, 16#FF>>,
Data =
<<16#08, 16#00, 16#26, 16#C8, 16#00, 16#0B, 16#6D, 16#79, 16#53, 16#65, 16#72, 16#76, 16#69,
16#63, 16#65, 16#20, 16#31, 16#C8, 16#01, 16#0F, 16#49, 16#6E, 16#74, 16#65, 16#72,
16#6E, 16#65, 16#74, 16#2E, 16#31, 16#35, 16#2E, 16#32, 16#33, 16#34, 16#C4, 16#02,
16#00, 16#43, 16#00, 16#00, 16#08, 16#01, 16#26, 16#C8, 16#00, 16#0B, 16#6D, 16#79,
16#53, 16#65, 16#72, 16#76, 16#69, 16#63, 16#65, 16#20, 16#32, 16#C8, 16#01, 16#0F,
16#49, 16#6E, 16#74, 16#65, 16#72, 16#6E, 16#65, 16#74, 16#2E, 16#31, 16#35, 16#2E,
16#32, 16#33, 16#35, 16#C4, 16#02, 16#FF, 16#FF, 16#FF, 16#FF>>,
R = emqx_lwm2m_tlv:parse(Data),
Exp = [#{tlv_object_instance => 16#00, value => [#{tlv_resource_with_value => 16#00, value => <<"myService 1">>},
Exp = [
#{
tlv_object_instance => 16#00,
value => [
#{tlv_resource_with_value => 16#00, value => <<"myService 1">>},
#{tlv_resource_with_value => 16#01, value => <<"Internet.15.234">>},
#{tlv_resource_with_value => 16#02, value => <<16#00, 16#43, 16#00, 16#00>>}]},
#{tlv_object_instance => 16#01, value => [#{tlv_resource_with_value => 16#00, value => <<"myService 2">>},
#{tlv_resource_with_value => 16#02, value => <<16#00, 16#43, 16#00, 16#00>>}
]
},
#{
tlv_object_instance => 16#01,
value => [
#{tlv_resource_with_value => 16#00, value => <<"myService 2">>},
#{tlv_resource_with_value => 16#01, value => <<"Internet.15.235">>},
#{tlv_resource_with_value => 16#02, value => <<16#FF, 16#FF, 16#FF, 16#FF>>}
]}
]
}
],
?assertEqual(Exp, R),
EncodedBinary = emqx_lwm2m_tlv:encode(Exp),

149
apps/emqx_gateway/test/props/emqx_sn_proper_types.erl
View File

@ -31,20 +31,28 @@
%%--------------------------------------------------------------------
'ADVERTISE'() ->
?LET({GwId, Duration}, {gateway_id(), duration()},
?SN_ADVERTISE_MSG(GwId, Duration)).
?LET(
{GwId, Duration},
{gateway_id(), duration()},
?SN_ADVERTISE_MSG(GwId, Duration)
).
'SEARCHGW'() ->
?LET(Radius, radius(), ?SN_SEARCHGW_MSG(Radius)).
'GWINFO'() ->
?LET({GwId, GwAddr}, {gateway_id(), gateway_addr()},
?SN_GWINFO_MSG(GwId, GwAddr)).
?LET(
{GwId, GwAddr},
{gateway_id(), gateway_addr()},
?SN_GWINFO_MSG(GwId, GwAddr)
).
'CONNECT'() ->
?LET({Flags, ProtocolId, Duration, ClientId},
?LET(
{Flags, ProtocolId, Duration, ClientId},
{conn_flags(), protocol_id(), duration(), clientid()},
?SN_CONNECT_MSG(Flags, ProtocolId, Duration, ClientId)).
?SN_CONNECT_MSG(Flags, ProtocolId, Duration, ClientId)
).
'CONNACK'() ->
?LET(Rc, return_code(), ?SN_CONNACK_MSG(Rc)).
@ -53,8 +61,11 @@
?SN_WILLTOPICREQ_MSG().
'WILLTOPIC'() ->
?LET({Flags, Topic}, {will_topic_flags(), topic()},
?SN_WILLTOPIC_MSG(Flags, Topic)).
?LET(
{Flags, Topic},
{will_topic_flags(), topic()},
?SN_WILLTOPIC_MSG(Flags, Topic)
).
'WILLTOPCI_EMPTY'() ->
?SN_WILLTOPIC_EMPTY_MSG.
@ -66,48 +77,67 @@
?LET(Payload, binary(), ?SN_WILLMSG_MSG(Payload)).
'REGISTER'() ->
?LET({MsgId, TopicName},
?LET(
{MsgId, TopicName},
{message_id(), topic()},
?SN_REGISTER_MSG(16#0000, MsgId, TopicName)).
?SN_REGISTER_MSG(16#0000, MsgId, TopicName)
).
'REGACK'() ->
?LET({TopicId, MsgId, Rc},
?LET(
{TopicId, MsgId, Rc},
{topic_id(), message_id(), return_code()},
?SN_REGACK_MSG(TopicId, MsgId, Rc)).
?SN_REGACK_MSG(TopicId, MsgId, Rc)
).
'PUBLISH'() ->
?LET({Flags, MsgId, Data},
?LET(
{Flags, MsgId, Data},
{publish_flags(), message_id(), binary()},
?SN_PUBLISH_MSG(Flags, pub_topic_by_type(Flags), MsgId, Data)).
?SN_PUBLISH_MSG(Flags, pub_topic_by_type(Flags), MsgId, Data)
).
'PUBACK'() ->
?LET({TopicId, MsgId, Rc},
?LET(
{TopicId, MsgId, Rc},
{topic_id(), message_id(), return_code()},
?SN_PUBACK_MSG(TopicId, MsgId, Rc)).
?SN_PUBACK_MSG(TopicId, MsgId, Rc)
).
'PUBCOMP_REC_REL'() ->
?LET({Type, MsgId},
?LET(
{Type, MsgId},
{oneof([?SN_PUBREC, ?SN_PUBREL, ?SN_PUBCOMP]), message_id()},
?SN_PUBREC_MSG(Type, MsgId)).
?SN_PUBREC_MSG(Type, MsgId)
).
'SUBSCRIBE'() ->
?LET({Flags, MsgId},
?LET(
{Flags, MsgId},
{subscribe_flags(), message_id()},
?SN_SUBSCRIBE_MSG(Flags, MsgId, topic_by_type(Flags))).
?SN_SUBSCRIBE_MSG(Flags, MsgId, topic_by_type(Flags))
).
'SUBACK'() ->
?LET({Flags, TopicId, MsgId, Rc},
?LET(
{Flags, TopicId, MsgId, Rc},
{suback_flags(), topic_id(), message_id(), return_code()},
?SN_SUBACK_MSG(Flags, TopicId, MsgId, Rc)).
?SN_SUBACK_MSG(Flags, TopicId, MsgId, Rc)
).
'UNSUBSCRIBE'() ->
?LET({Flags, MsgId},
?LET(
{Flags, MsgId},
{unsubscribe_flags(), message_id()},
?SN_UNSUBSCRIBE_MSG(Flags, MsgId, topic_by_type(Flags))).
?SN_UNSUBSCRIBE_MSG(Flags, MsgId, topic_by_type(Flags))
).
'UNSUBACK'() ->
?LET(MsgId, message_id(),
?SN_UNSUBACK_MSG(MsgId)).
?LET(
MsgId,
message_id(),
?SN_UNSUBACK_MSG(MsgId)
).
'PINGREQ'() ->
?LET(ClientId, clientid(), ?SN_PINGREQ_MSG(ClientId)).
@ -119,9 +149,11 @@
?LET(Duration, oneof([duration(), undefined]), ?SN_DISCONNECT_MSG(Duration)).
'WILLTOPICUPD'() ->
?LET({Flags, Topic},
?LET(
{Flags, Topic},
{willtopic_upd_flags(), topic()},
?SN_WILLTOPICUPD_MSG(Flags, Topic)).
?SN_WILLTOPICUPD_MSG(Flags, Topic)
).
'WILLTOPICRESP'() ->
?LET(Rc, return_code(), ?SN_WILLTOPICRESP_MSG(Rc)).
@ -148,35 +180,56 @@ radius() ->
range(0, 16#ff).
gateway_addr() ->
?LET(L, oneof([0, range(2, 16#ff)]),
?LET(
L,
oneof([0, range(2, 16#ff)]),
begin
Addr = list_to_binary([rand:uniform(256) - 1 || _ <- lists:seq(1, L)]),
<<(byte_size(Addr)):8, Addr/binary>>
end).
end
).
mqtt_sn_flags() ->
?LET({Dup, Qos, Retain, Will, CleanStart, IdType},
?LET(
{Dup, Qos, Retain, Will, CleanStart, IdType},
{boolean(), mqtt_sn_qos(), boolean(), boolean(), boolean(), topic_id_type()},
#mqtt_sn_flags{dup = Dup, qos = Qos, retain = Retain, will = Will,
clean_start = CleanStart, topic_id_type = IdType}).
#mqtt_sn_flags{
dup = Dup,
qos = Qos,
retain = Retain,
will = Will,
clean_start = CleanStart,
topic_id_type = IdType
}
).
conn_flags() ->
?LET({Will, CleanStart}, {boolean(), boolean()},
#mqtt_sn_flags{will = Will,clean_start = CleanStart}).
?LET(
{Will, CleanStart},
{boolean(), boolean()},
#mqtt_sn_flags{will = Will, clean_start = CleanStart}
).
will_topic_flags() ->
?LET({Qos, Retain}, {mqtt_sn_qos(), boolean()},
#mqtt_sn_flags{qos = Qos, retain = Retain}).
?LET(
{Qos, Retain},
{mqtt_sn_qos(), boolean()},
#mqtt_sn_flags{qos = Qos, retain = Retain}
).
publish_flags() ->
?LET({Dup, Qos, Retain, IdType},
?LET(
{Dup, Qos, Retain, IdType},
{boolean(), publish_qos(), boolean(), pub_topic_id_type()},
#mqtt_sn_flags{dup = Dup, qos = Qos, retain = Retain, topic_id_type = IdType}).
#mqtt_sn_flags{dup = Dup, qos = Qos, retain = Retain, topic_id_type = IdType}
).
subscribe_flags() ->
?LET({Dup, Qos, IdType},
?LET(
{Dup, Qos, IdType},
{boolean(), publish_qos(), topic_id_type()},
#mqtt_sn_flags{dup = Dup, qos = Qos, topic_id_type = IdType}).
#mqtt_sn_flags{dup = Dup, qos = Qos, topic_id_type = IdType}
).
suback_flags() ->
?LET(Qos, mqtt_sn_qos(), #mqtt_sn_flags{qos = Qos}).
@ -185,8 +238,11 @@ unsubscribe_flags()->
?LET(IdType, topic_id_type(), #mqtt_sn_flags{topic_id_type = IdType}).
willtopic_upd_flags() ->
?LET({Qos, Retain}, {mqtt_sn_qos(), boolean()},
#mqtt_sn_flags{qos = Qos, retain = Retain}).
?LET(
{Qos, Retain},
{mqtt_sn_qos(), boolean()},
#mqtt_sn_flags{qos = Qos, retain = Retain}
).
mqtt_sn_qos() ->
oneof([0, 1, 2]).
@ -209,10 +265,13 @@ protocol_id() ->
%% The ClientId field has a variable length and contains
%% a 1-23 character long string
clientid() ->
?LET(L, range(1, 23),
?LET(
L,
range(1, 23),
begin
list_to_binary([rand_09_az_AZ() || _ <- lists:seq(1, L)])
end).
end
).
return_code() ->
range(0, 16#ff).

57
apps/emqx_gateway/test/props/prop_emqx_sn_frame.erl
View File

@ -22,10 +22,14 @@
-compile({no_auto_import, [register/1]}).
-define(ALL(Vars, Types, Exprs),
?SETUP(fun() ->
?SETUP(
fun() ->
State = do_setup(),
fun() -> do_teardown(State) end
end, ?FORALL(Vars, Types, Exprs))).
end,
?FORALL(Vars, Types, Exprs)
)
).
parse(D) ->
{ok, P, _Rest, _State} = emqx_sn_frame:parse(D, #{}),
@ -39,11 +43,14 @@ serialize(P) ->
%%--------------------------------------------------------------------
prop_parse_and_serialize() ->
?ALL(Msg, mqtt_sn_message(),
?ALL(
Msg,
mqtt_sn_message(),
begin
Msg = parse(serialize(Msg)),
true
end).
end
).
%%--------------------------------------------------------------------
%% Helper
@ -61,18 +68,32 @@ do_teardown(_) ->
mqtt_sn_message() ->
M = emqx_sn_proper_types,
oneof([ M:'ADVERTISE'(), M:'SEARCHGW'()
, M:'GWINFO'(), M:'CONNECT'()
, M:'CONNACK'(), M:'WILLTOTPICREQ'()
, M:'WILLTOPIC'(), M:'WILLTOPCI_EMPTY'()
, M:'WILLMESSAGEREQ'(), M:'WILLMESSAGE'()
, M:'REGISTER'(), M:'REGACK'()
, M:'PUBLISH'(), M:'PUBACK'()
, M:'PUBCOMP_REC_REL'(), M:'SUBSCRIBE'()
, M:'SUBACK'(), M:'UNSUBSCRIBE'()
, M:'UNSUBACK'(), M:'PINGREQ'()
, M:'PINGRESP'(), M:'DISCONNECT'()
, M:'DISCONNECT'(), M:'WILLTOPICUPD'()
, M:'WILLTOPICRESP'(), M:'WILLMSGUPD'()
, M:'WILLMSGRESP'()
oneof([
M:'ADVERTISE'(),
M:'SEARCHGW'(),
M:'GWINFO'(),
M:'CONNECT'(),
M:'CONNACK'(),
M:'WILLTOTPICREQ'(),
M:'WILLTOPIC'(),
M:'WILLTOPCI_EMPTY'(),
M:'WILLMESSAGEREQ'(),
M:'WILLMESSAGE'(),
M:'REGISTER'(),
M:'REGACK'(),
M:'PUBLISH'(),
M:'PUBACK'(),
M:'PUBCOMP_REC_REL'(),
M:'SUBSCRIBE'(),
M:'SUBACK'(),
M:'UNSUBSCRIBE'(),
M:'UNSUBACK'(),
M:'PINGREQ'(),
M:'PINGRESP'(),
M:'DISCONNECT'(),
M:'DISCONNECT'(),
M:'WILLTOPICUPD'(),
M:'WILLTOPICRESP'(),
M:'WILLMSGUPD'(),
M:'WILLMSGRESP'()
]).

50
apps/emqx_gateway/test/test_mqtt_broker.erl
View File

@ -65,36 +65,38 @@ handle_call({subscribe, Topic, Proc}, _From, State=#state{subscriber = SubList})
?LOGT("test broker subscribe Topic=~p, Pid=~p~n", [Topic, Proc]),
is_binary(Topic) orelse error("Topic should be a binary"),
{reply, {ok, []}, State#state{subscriber = [{Topic, Proc} | SubList]}};
handle_call(get_subscribed_topics, _From, State = #state{subscriber = SubList}) ->
Response = subscribed_topics(SubList, []),
?LOGT("test broker get subscribed topics=~p~n", [Response]),
{reply, Response, State};
handle_call({unsubscribe, Topic}, _From, State = #state{subscriber = SubList}) ->
?LOGT("test broker unsubscribe Topic=~p~n", [Topic]),
is_binary(Topic) orelse error("Topic should be a binary"),
NewSubList = proplists:delete(Topic, SubList),
{reply, {ok, []}, State#state{subscriber = NewSubList}};
handle_call({publish, {Topic, Msg, MatchedTopicFilter}}, _From, State=#state{subscriber = SubList}) ->
handle_call(
{publish, {Topic, Msg, MatchedTopicFilter}}, _From, State = #state{subscriber = SubList}
) ->
(is_binary(Topic) and is_binary(Msg)) orelse error("Topic and Msg should be binary"),
Pid = proplists:get_value(MatchedTopicFilter, SubList),
?LOGT("test broker publish topic=~p, Msg=~p, Pid=~p, MatchedTopicFilter=~p, SubList=~p~n", [Topic, Msg, Pid, MatchedTopicFilter, SubList]),
(Pid == undefined) andalso ?LOGT("!!!!! this topic ~p has never been subscribed, please specify a valid topic filter", [MatchedTopicFilter]),
?LOGT("test broker publish topic=~p, Msg=~p, Pid=~p, MatchedTopicFilter=~p, SubList=~p~n", [
Topic, Msg, Pid, MatchedTopicFilter, SubList
]),
(Pid == undefined) andalso
?LOGT(
"!!!!! this topic ~p has never been subscribed, please specify a valid topic filter", [
MatchedTopicFilter
]
),
?assertNotEqual(undefined, Pid),
Pid ! {deliver, #message{topic = Topic, payload = Msg}},
{reply, ok, State};
handle_call(stop, _From, State) ->
{stop, normal, stopped, State};
handle_call(Req, _From, State) ->
?LOGT("test_broker_server: ignore call Req=~p~n", [Req]),
{reply, {error, badreq}, State}.
handle_cast(Msg, State) ->
?LOGT("test_broker_server: ignore cast msg=~p~n", [Msg]),
{noreply, State}.
@ -110,37 +112,36 @@ terminate(Reason, _State) ->
code_change(_OldVsn, State, _Extra) ->
{ok, State}.
subscribed_topics([], Acc) ->
Acc;
subscribed_topics([{Topic, _Pid} | T], Acc) ->
subscribed_topics(T, [Topic | Acc]).
-record(keepalive, {statfun, statval, tsec, tmsg, tref, repeat = 0}).
-type(keepalive() :: #keepalive{}).
-type keepalive() :: #keepalive{}.
%% @doc Start a keepalive
-spec(start(fun(), integer(), any()) -> undefined | keepalive()).
-spec start(fun(), integer(), any()) -> undefined | keepalive().
start(_, 0, _) ->
undefined;
start(StatFun, TimeoutSec, TimeoutMsg) ->
{ok, StatVal} = StatFun(),
#keepalive{statfun = StatFun, statval = StatVal,
tsec = TimeoutSec, tmsg = TimeoutMsg,
tref = timer(TimeoutSec, TimeoutMsg)}.
#keepalive{
statfun = StatFun,
statval = StatVal,
tsec = TimeoutSec,
tmsg = TimeoutMsg,
tref = timer(TimeoutSec, TimeoutMsg)
}.
%% @doc Check keepalive, called when timeout.
-spec(check(keepalive()) -> {ok, keepalive()} | {error, any()}).
-spec check(keepalive()) -> {ok, keepalive()} | {error, any()}.
check(KeepAlive = #keepalive{statfun = StatFun, statval = LastVal, repeat = Repeat}) ->
case StatFun() of
{ok, NewVal} ->
if NewVal =/= LastVal ->
if
NewVal =/= LastVal ->
{ok, resume(KeepAlive#keepalive{statval = NewVal, repeat = 0})};
Repeat < 1 ->
{ok, resume(KeepAlive#keepalive{statval = NewVal, repeat = Repeat + 1})};
@ -155,7 +156,7 @@ resume(KeepAlive = #keepalive{tsec = TimeoutSec, tmsg = TimeoutMsg}) ->
KeepAlive#keepalive{tref = timer(TimeoutSec, TimeoutMsg)}.
%% @doc Cancel Keepalive
-spec(cancel(keepalive()) -> ok).
-spec cancel(keepalive()) -> ok.
cancel(#keepalive{tref = TRef}) ->
cancel(TRef);
cancel(undefined) ->
@ -166,6 +167,5 @@ cancel(TRef) ->
timer(Sec, Msg) ->
erlang:send_after(timer:seconds(Sec), self(), Msg).
log(Format, Args) ->
logger:debug(Format, Args).

2
scripts/check-format.sh
View File

@ -8,7 +8,7 @@ set -euo pipefail
cd -P -- "$(dirname -- "$0")/.."
APPS=()
APPS+=( 'apps/emqx' 'apps/emqx_modules' )
APPS+=( 'apps/emqx' 'apps/emqx_modules' 'apps/emqx_gateway')
APPS+=( 'lib-ee/emqx_enterprise_conf' 'lib-ee/emqx_license' )
for app in "${APPS[@]}"; do