From b9acf94fd7dc297cfe07d41cf9c2c6491368e49e Mon Sep 17 00:00:00 2001 From: JimMoen Date: Thu, 9 Dec 2021 16:05:50 +0800 Subject: [PATCH 1/4] feat(frame): better log for proxy_protocol config disabled --- src/emqx_connection.erl | 7 ++++++- src/emqx_frame.erl | 14 ++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/src/emqx_connection.erl b/src/emqx_connection.erl index 5dfb3e220..ef12f6bcf 100644 --- a/src/emqx_connection.erl +++ b/src/emqx_connection.erl @@ -629,10 +629,15 @@ parse_incoming(Data, Packets, State = #state{parse_state = ParseState}) -> NState = State#state{parse_state = NParseState}, parse_incoming(Rest, [Packet|Packets], NState) catch + error:proxy_protocol_config_disabled:_Stk -> + ?LOG(error, + "~nMalformed packet, " + "please check proxy_protocol config for specific listeners and zones~n"), + {[{frame_error, proxy_protocol_config_disabled} | Packets], State}; error:Reason:Stk -> ?LOG(error, "~nParse failed for ~0p~n~0p~nFrame data:~0p", [Reason, Stk, Data]), - {[{frame_error, Reason}|Packets], State} + {[{frame_error, Reason} | Packets], State} end. -compile({inline, [next_incoming_msgs/1]}). diff --git a/src/emqx_frame.erl b/src/emqx_frame.erl index 79ac9da35..0722d996d 100644 --- a/src/emqx_frame.erl +++ b/src/emqx_frame.erl @@ -71,6 +71,13 @@ -define(MULTIPLIER_MAX, 16#200000). +%% proxy_protocol v1 header human readable +-define(PPV1_PROXY, "PROXY "). +-define(PPV1_PROXY_UNKNOWN, "PROXY UNKNOWN"). +%% proxy_protocol v2 header signature: +%% 16#0D,16#0A, 16#0D,16#0A,16#00,16#0D,16#0A,16#51,16#55,16#49,16#54,16#0A +-define(PPV2_HEADER_SIG, "\r\n\r\n\0\r\nQUIT\n"). + -dialyzer({no_match, [serialize_utf8_string/2]}). %%-------------------------------------------------------------------- @@ -100,6 +107,13 @@ parse(Bin) -> -spec(parse(binary(), parse_state()) -> parse_result()). parse(<<>>, {none, Options}) -> {more, {none, Options}}; +parse(<>, {none, _Options}) + when IPVer =:= <<"TCP4 ">> orelse IPVer =:= <<"TCP6 ">> -> + error(proxy_protocol_config_disabled); +parse(<>, {none, _Options}) -> + error(proxy_protocol_config_disabled); +parse(<>, {none, _Options}) -> + error(proxy_protocol_config_disabled); parse(<>, {none, Options = #{strict_mode := StrictMode}}) -> %% Validate header if strict mode. From 3ecc79e1bca3c156a106cda7160ce4081e40df29 Mon Sep 17 00:00:00 2001 From: JimMoen Date: Thu, 9 Dec 2021 16:35:18 +0800 Subject: [PATCH 2/4] test(frame): test packet proxy_protocol config disabled --- src/emqx_frame.erl | 4 ++++ test/emqx_frame_SUITE.erl | 12 ++++++++++-- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/src/emqx_frame.erl b/src/emqx_frame.erl index 0722d996d..17daf9809 100644 --- a/src/emqx_frame.erl +++ b/src/emqx_frame.erl @@ -80,6 +80,10 @@ -dialyzer({no_match, [serialize_utf8_string/2]}). +-ifdef(TEST). +-export([parse_variable_byte_integer/1]). +-endif. + %%-------------------------------------------------------------------- %% Init Parse State %%-------------------------------------------------------------------- diff --git a/test/emqx_frame_SUITE.erl b/test/emqx_frame_SUITE.erl index 591c75bdc..4b43c8506 100644 --- a/test/emqx_frame_SUITE.erl +++ b/test/emqx_frame_SUITE.erl @@ -43,7 +43,9 @@ groups() -> [{parse, [parallel], [t_parse_cont, t_parse_frame_too_large, - t_parse_frame_malformed_variable_byte_integer + t_parse_frame_malformed_variable_byte_integer, + t_parse_frame_variable_byte_integer, + t_parse_frame_proxy_protocol %% proxy_protocol_config_disabled packet. ]}, {connect, [parallel], [t_serialize_parse_v3_connect, @@ -142,6 +144,13 @@ t_parse_frame_variable_byte_integer(_) -> ?catch_error(malformed_variable_byte_integer, emqx_frame:parse_variable_byte_integer(Bin)). +t_parse_frame_proxy_protocol(_) -> + BinList = [ <<"PROXY TCP4 ">>, <<"PROXY TCP6 ">>, <<"PROXY UNKNOWN">> + , <<"\r\n\r\n\0\r\nQUIT\n">>], + [?assertError( proxy_protocol_config_disabled + , emqx_frame:parse(Bin)) + || Bin <- BinList]. + t_serialize_parse_v3_connect(_) -> Bin = <<16,37,0,6,77,81,73,115,100,112,3,2,0,60,0,23,109,111,115, 113,112,117, 98,47,49,48,52,53,49,45,105,77,97,99,46,108, @@ -555,4 +564,3 @@ parse_to_packet(Bin, Opts) -> Packet. payload(Len) -> iolist_to_binary(lists:duplicate(Len, 1)). - From bad314ae0875a1868ab692def7ec4de9e4779596 Mon Sep 17 00:00:00 2001 From: JimMoen Date: Thu, 9 Dec 2021 19:45:24 +0800 Subject: [PATCH 3/4] chore(gitignore): update gitignore --- .gitignore | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.gitignore b/.gitignore index 218b22261..bbb4edebb 100644 --- a/.gitignore +++ b/.gitignore @@ -47,3 +47,15 @@ dist.zip scripts/git-token etc/*.seg _upgrade_base/ +erlang_ls.config +.els_cache/ +# VSCode files +.vs/ +.vscode/ +# Emacs Backup files +*~ +# Emacs temporary files +.#* +*# +# For direnv +.envrc From 24060285c5a4c1941766b0ff1b97fdc9a0b52ac4 Mon Sep 17 00:00:00 2001 From: JimMoen Date: Fri, 10 Dec 2021 14:15:09 +0800 Subject: [PATCH 4/4] chore(appup): update appup.src --- src/emqx.appup.src | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/emqx.appup.src b/src/emqx.appup.src index c510b3043..cea35e90d 100644 --- a/src/emqx.appup.src +++ b/src/emqx.appup.src @@ -3,12 +3,14 @@ [{"4.3.11", [{load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, + {load_module,emqx_frame,brutal_purge,soft_purge,[]}, {load_module,emqx_http_lib,brutal_purge,soft_purge,[]}]}, {"4.3.10", [{load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_http_lib,brutal_purge,soft_purge,[]}, {load_module,emqx_app,brutal_purge,soft_purge,[]}, + {load_module,emqx_frame,brutal_purge,soft_purge,[]}, {load_module,emqx_connection,brutal_purge,soft_purge,[]}]}, {"4.3.9", [{load_module,emqx_vm,brutal_purge,soft_purge,[]}, @@ -194,12 +196,14 @@ [{"4.3.11", [{load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, + {load_module,emqx_frame,brutal_purge,soft_purge,[]}, {load_module,emqx_http_lib,brutal_purge,soft_purge,[]}]}, {"4.3.10", [{load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_http_lib,brutal_purge,soft_purge,[]}, {load_module,emqx_app,brutal_purge,soft_purge,[]}, + {load_module,emqx_frame,brutal_purge,soft_purge,[]}, {load_module,emqx_connection,brutal_purge,soft_purge,[]}]}, {"4.3.9", [{load_module,emqx_vm,brutal_purge,soft_purge,[]},