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

Merge pull request #12691 from SergeTupchiy/EMQX-11974-add-max_payload_bytes-validator 

fix(emqx_mgmt_api_clients): check that max_payload_bytes is higher than 0
This commit is contained in:
SergeTupchiy 2024-03-13 14:57:08 +02:00 committed by GitHub
parent 7908e2d591 e514c4a2ac
commit 5c59a7fb86
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -916,7 +916,8 @@ client_msgs_params() ->
" The only exception to this rule is when the first message payload" " The only exception to this rule is when the first message payload"
" is already larger than the limit." " is already larger than the limit."
" In this case, the first message will be returned in the response." " In this case, the first message will be returned in the response."
>> >>,
validator => fun max_bytes_validator/1
})}, })},
hoconsc:ref(emqx_dashboard_swagger, 'after'), hoconsc:ref(emqx_dashboard_swagger, 'after'),
hoconsc:ref(emqx_dashboard_swagger, limit) hoconsc:ref(emqx_dashboard_swagger, limit)
@ -1152,6 +1153,11 @@ cont_encoding(inflight_msgs) -> ?URL_PARAM_INTEGER;
%% binary message id %% binary message id
cont_encoding(mqueue_msgs) -> ?URL_PARAM_BINARY. cont_encoding(mqueue_msgs) -> ?URL_PARAM_BINARY.
max_bytes_validator(MaxBytes) when is_integer(MaxBytes), MaxBytes > 0 ->
ok;
max_bytes_validator(_MaxBytes) ->
{error, "must be higher than 0"}.
%%-------------------------------------------------------------------- %%--------------------------------------------------------------------
%% QueryString to Match Spec %% QueryString to Match Spec

18
apps/emqx_management/test/emqx_mgmt_api_clients_SUITE.erl
View File

@ -985,6 +985,24 @@ test_messages(Path, Topic, Count, AuthHeader, PayloadEncoding) ->
?assertMatch( ?assertMatch(
{error, {_, 400, _}}, {error, {_, 400, _}},
emqx_mgmt_api_test_util:request_api(get, Path, "limit=limit", AuthHeader) emqx_mgmt_api_test_util:request_api(get, Path, "limit=limit", AuthHeader)
),
%% Invalid max_paylod_bytes param
?assertMatch(
{error, {_, 400, _}},
emqx_mgmt_api_test_util:request_api(get, Path, "max_payload_bytes=0", AuthHeader)
),
?assertMatch(
{error, {_, 400, _}},
emqx_mgmt_api_test_util:request_api(get, Path, "max_payload_bytes=-1", AuthHeader)
),
?assertMatch(
{error, {_, 400, _}},
emqx_mgmt_api_test_util:request_api(get, Path, "max_payload_bytes=-1MB", AuthHeader)
),
?assertMatch(
{error, {_, 400, _}},
emqx_mgmt_api_test_util:request_api(get, Path, "max_payload_bytes=0MB", AuthHeader)
). ).
decode_payload(Payload, base64) -> decode_payload(Payload, base64) ->