futriix/tests/unit/protocol.tcl
ranshid dd92d079dc
Fix Protocol desync regression test (#1590)
The desync regression test was created as a regression test for the
following bug:
in case we embed NULL termination inside inline/multi-bulk message we
will not be able to perform strchr in order to
identify the newline(\n)/carriage-return(\r) in the client query buffer.
this can influence (for example) replica reading primary stream and keep
filling it's query buffer endlessly consuming more and more memory.

In order to handle the above risk, a check was added to verify the
inline bulk and multi-bulk size are not exceeding the 64K bytes in the
query-buffer. A test was placed in order to verify this.

This PR introduce the following fixes to the desync regression test:
1. fix the sent payload to flush 1024 bytes block of 'A's instead of
'payload' which was sent by mistake.
2. Make sure that the connection is correctly terminated on protocol
error by the server after exceeding the 64K and not over 64K.
3. add another test intrinsic which will also verify the nested bulk
with embedded null termination (was not verified before)

fixes https://github.com/valkey-io/valkey/issues/1583


NOTE: Although it is possible to change the use of strchr to a more
"safe" utility (eg memchr) which will not pause scan at first occurrence
of '\0', we still like to protect against over excessive usage of the
query buffer and also preserve the current behavior(?). We will look
into improving this though in a followup issue.

---------

Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Signed-off-by: ranshid <88133677+ranshid@users.noreply.github.com>
2025-01-20 20:28:45 +02:00

287 lines
7.9 KiB
Tcl

start_server {tags {"protocol network"}} {
test "Handle an empty query" {
reconnect
r write "\r\n"
r flush
assert_equal "PONG" [r ping]
}
test "Negative multibulk length" {
reconnect
r write "*-10\r\n"
r flush
assert_equal PONG [r ping]
}
test "Out of range multibulk length" {
reconnect
r write "*3000000000\r\n"
r flush
assert_error "*invalid multibulk length*" {r read}
}
test "Wrong multibulk payload header" {
reconnect
r write "*3\r\n\$3\r\nSET\r\n\$1\r\nx\r\nfooz\r\n"
r flush
assert_error "*expected '$', got 'f'*" {r read}
}
test "Negative multibulk payload length" {
reconnect
r write "*3\r\n\$3\r\nSET\r\n\$1\r\nx\r\n\$-10\r\n"
r flush
assert_error "*invalid bulk length*" {r read}
}
test "Out of range multibulk payload length" {
reconnect
r write "*3\r\n\$3\r\nSET\r\n\$1\r\nx\r\n\$2000000000\r\n"
r flush
assert_error "*invalid bulk length*" {r read}
}
test "Non-number multibulk payload length" {
reconnect
r write "*3\r\n\$3\r\nSET\r\n\$1\r\nx\r\n\$blabla\r\n"
r flush
assert_error "*invalid bulk length*" {r read}
}
test "Multi bulk request not followed by bulk arguments" {
reconnect
r write "*1\r\nfoo\r\n"
r flush
assert_error "*expected '$', got 'f'*" {r read}
}
test "Generic wrong number of args" {
reconnect
assert_error "*wrong*arguments*ping*" {r ping x y z}
}
test "Unbalanced number of quotes" {
reconnect
r write "set \"\"\"test-key\"\"\" test-value\r\n"
r write "ping\r\n"
r flush
assert_error "*unbalanced*" {r read}
}
set c 0
foreach seq [list "\x00" "*\x00" "$\x00" "*1\r\n$\x00"] {
incr c
test "Protocol desync regression test #$c" {
if {$::tls} {
set s [::tls::socket [srv 0 host] [srv 0 port]]
} else {
set s [socket [srv 0 host] [srv 0 port]]
}
fconfigure $s -blocking 0
puts -nonewline $s $seq
# PROTO_INLINE_MAX_SIZE is hardcoded in Valkey code to 64K. doing the same here
# since we would like to validate it is enforced.
set PROTO_INLINE_MAX_SIZE [expr 1024 * 64]
set payload [string repeat A 1024]"\n"
set payload_size 0
while {$payload_size <= $PROTO_INLINE_MAX_SIZE} {
if {[catch {
incr payload_size [string length $payload]
puts -nonewline $s $payload
flush $s
}]} {
assert_morethan $payload_size $PROTO_INLINE_MAX_SIZE
break
}
}
wait_for_condition 50 100 {
[string match {*Protocol error*} [gets $s]]
} else {
fail "expected connection to be closed on protocol error after sending $payload_size bytes"
}
close $s
}
}
unset c
# recover the broken connection
reconnect
r ping
# raw RESP response tests
r readraw 1
set nullres {*-1}
if {$::force_resp3} {
set nullres {_}
}
test "raw protocol response" {
r srandmember nonexisting_key
} "$nullres"
r deferred 1
test "raw protocol response - deferred" {
r srandmember nonexisting_key
r read
} "$nullres"
test "raw protocol response - multiline" {
r sadd ss a
assert_equal [r read] {:1}
r srandmember ss 100
assert_equal [r read] {*1}
assert_equal [r read] {$1}
assert_equal [r read] {a}
}
# restore connection settings
r readraw 0
r deferred 0
# check the connection still works
assert_equal [r ping] {PONG}
test {RESP3 attributes} {
r hello 3
assert_equal {Some real reply following the attribute} [r debug protocol attrib]
assert_equal {key-popularity {key:123 90}} [r attributes]
# make sure attributes are not kept from previous command
r ping
assert_error {*attributes* no such element in array} {r attributes}
# restore state
r hello 2
set _ ""
} {} {needs:debug resp3}
test {RESP3 attributes readraw} {
r hello 3
r readraw 1
r deferred 1
r debug protocol attrib
assert_equal [r read] {|1}
assert_equal [r read] {$14}
assert_equal [r read] {key-popularity}
assert_equal [r read] {*2}
assert_equal [r read] {$7}
assert_equal [r read] {key:123}
assert_equal [r read] {:90}
assert_equal [r read] {$39}
assert_equal [r read] {Some real reply following the attribute}
# restore state
r readraw 0
r deferred 0
r hello 2
set _ {}
} {} {needs:debug resp3}
test {RESP3 attributes on RESP2} {
r hello 2
set res [r debug protocol attrib]
set _ $res
} {Some real reply following the attribute} {needs:debug}
test "test big number parsing" {
r hello 3
r debug protocol bignum
} {1234567999999999999999999999999999999} {needs:debug resp3}
test "test bool parsing" {
r hello 3
assert_equal [r debug protocol true] 1
assert_equal [r debug protocol false] 0
r hello 2
assert_equal [r debug protocol true] 1
assert_equal [r debug protocol false] 0
set _ {}
} {} {needs:debug resp3}
test "test verbatim str parsing" {
r hello 3
r debug protocol verbatim
} "This is a verbatim\nstring" {needs:debug resp3}
test "test large number of args" {
r flushdb
set args [split [string trim [string repeat "k v " 10000]]]
lappend args "{k}2" v2
r mset {*}$args
assert_equal [r get "{k}2"] v2
}
test "test argument rewriting - issue 9598" {
# INCRBYFLOAT uses argument rewriting for correct float value propagation.
# We use it to make sure argument rewriting works properly. It's important
# this test is run under valgrind to verify there are no memory leaks in
# arg buffer handling.
r flushdb
# Test normal argument handling
r set k 0
assert_equal [r incrbyfloat k 1.0] 1
# Test argument handing in multi-state buffers
r multi
r incrbyfloat k 1.0
assert_equal [r exec] 2
}
}
start_server {tags {"protocol hello logreqres:skip"}} {
test {HELLO without protover} {
set reply [r HELLO 3]
assert_equal [dict get $reply proto] 3
set reply [r HELLO]
assert_equal [dict get $reply proto] 3
set reply [r HELLO 2]
assert_equal [dict get $reply proto] 2
set reply [r HELLO]
assert_equal [dict get $reply proto] 2
}
test {HELLO and availability-zone} {
r CONFIG SET availability-zone myzone
set reply [r HELLO 3]
assert_equal [dict get $reply availability_zone] myzone
set reply [r HELLO 2]
assert_equal [dict get $reply availability_zone] myzone
r CONFIG SET availability-zone ""
set reply [r HELLO 3]
assert_equal [dict exists $reply availability_zone] 0
set reply [r HELLO 2]
assert_equal [dict exists $reply availability_zone] 0
}
}
start_server {tags {"regression"}} {
test "Regression for a crash with blocking ops and pipelining" {
set rd [valkey_deferring_client]
set fd [r channel]
set proto "*3\r\n\$5\r\nBLPOP\r\n\$6\r\nnolist\r\n\$1\r\n0\r\n"
puts -nonewline $fd $proto$proto
flush $fd
set res {}
$rd rpush nolist a
$rd read
$rd rpush nolist a
$rd read
$rd close
}
}