New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add helpers for encoding and decoding IPROTO requests #8054
Comments
NeraverinTarantool
removed
the
2.11
Target is 2.11 and all newer release/master branches
label
Jan 16, 2023
locker
added a commit
to locker/tarantool
that referenced
this issue
Oct 27, 2023
Closes tarantool#8054 @TarantoolBot document Title: Document Lua helpers for encoding/decoding IPROTO packets The following new constants and functions were added to the `box.iproto` namespace: - `GREETING_SIZE`: Size of a Tarantool greeting message - `GREETING_PROTOCOL_LEN_MAX`: Max length of a protocol string that can be encoded in a Tarantool greeting message. - `GREETING_SALT_LEN_MAX`: Max length of a salt string that can be encoded in a Tarantool greeting message. - `box.iproto.encode_greeting({version = x, uuid = x, salt = x})`: Encodes a Tarantool greeting message. Takes a table. Returns a string. Raises on error. The protocol is set to "Binary" (IPROTO). - `box.iproto.decode_greeting(string)`: Decodes a Tarantool greeting message. Takes a string. Returns a table with the following fields: `protocol`, `version`, `uuid`, `salt`. Raises on error. The input string must be exactly `GREETING_SIZE` bytes long. - `box.iproto.encode_packet(header[, body])`: Encodes an IPROTO packet. Takes a packet header and optionally a body given as a table or a string. A table argument will be encoded in MsgPack. A string argument will be copied as is (it's supposed to contain valid MsgPack but it isn't enforced). Returns a string. Raises on error. - `box.iproto.decode_packet(string[, pos])`: Decodes an IPROTO packet. Takes a string containing one or more encoded IPROTO packets and optionally a position in the string to start decoding from. If the position is omitted, the function will start decoding from the beginning of the string. On success returns the decoded packet header, body, and the position in the string where decoding stopped. Both header and body are returned as `msgpack.object`. The body may be absent (set to nil). If the input is truncated, returns nil and the min number of bytes required to decode the packet. On failure, raises an error. For examples, see [`test/app-luatest/iproto_encoder_test.lua`][1]. [1]: https://github.com/tarantool/tarantool/blob/master/test/app-luatest/iproto_encoder_test.lua
locker
added a commit
to locker/tarantool
that referenced
this issue
Oct 30, 2023
Closes tarantool#8054 @TarantoolBot document Title: Document Lua helpers for encoding/decoding IPROTO packets The following new constants and functions were added to the `box.iproto` namespace: - `GREETING_SIZE`: Size of a Tarantool greeting message - `GREETING_PROTOCOL_LEN_MAX`: Max length of a protocol string that can be encoded in a Tarantool greeting message. - `GREETING_SALT_LEN_MAX`: Max length of a salt string that can be encoded in a Tarantool greeting message. - `box.iproto.encode_greeting({version = x, uuid = x, salt = x})`: Encodes a Tarantool greeting message. Takes a table. Returns a string. Raises on error. The protocol is set to "Binary" (IPROTO). - `box.iproto.decode_greeting(string)`: Decodes a Tarantool greeting message. Takes a string. Returns a table with the following fields: `protocol`, `version`, `uuid`, `salt`. Raises on error. The input string must be exactly `GREETING_SIZE` bytes long. - `box.iproto.encode_packet(header[, body])`: Encodes an IPROTO packet. Takes a packet header and optionally a body given as a table or a string. A table argument will be encoded in MsgPack. A string argument will be copied as is (it's supposed to contain valid MsgPack but it isn't enforced). Returns a string. Raises on error. - `box.iproto.decode_packet(string[, pos])`: Decodes an IPROTO packet. Takes a string containing one or more encoded IPROTO packets and optionally a position in the string to start decoding from. If the position is omitted, the function will start decoding from the beginning of the string. On success returns the decoded packet header, body, and the position in the string where decoding stopped. Both header and body are returned as `msgpack.object`. The body may be absent (set to nil). If the input is truncated, returns nil and the min number of bytes required to decode the packet. On failure, raises an error. For examples, see [`test/app-luatest/iproto_encoder_test.lua`][1]. [1]: https://github.com/tarantool/tarantool/blob/master/test/app-luatest/iproto_encoder_test.lua
locker
added a commit
that referenced
this issue
Oct 31, 2023
Closes #8054 @TarantoolBot document Title: Document Lua helpers for encoding/decoding IPROTO packets The following new constants and functions were added to the `box.iproto` namespace: - `GREETING_SIZE`: Size of a Tarantool greeting message - `GREETING_PROTOCOL_LEN_MAX`: Max length of a protocol string that can be encoded in a Tarantool greeting message. - `GREETING_SALT_LEN_MAX`: Max length of a salt string that can be encoded in a Tarantool greeting message. - `box.iproto.encode_greeting({version = x, uuid = x, salt = x})`: Encodes a Tarantool greeting message. Takes a table. Returns a string. Raises on error. The protocol is set to "Binary" (IPROTO). - `box.iproto.decode_greeting(string)`: Decodes a Tarantool greeting message. Takes a string. Returns a table with the following fields: `protocol`, `version`, `uuid`, `salt`. Raises on error. The input string must be exactly `GREETING_SIZE` bytes long. - `box.iproto.encode_packet(header[, body])`: Encodes an IPROTO packet. Takes a packet header and optionally a body given as a table or a string. A table argument will be encoded in MsgPack. A string argument will be copied as is (it's supposed to contain valid MsgPack but it isn't enforced). Returns a string. Raises on error. - `box.iproto.decode_packet(string[, pos])`: Decodes an IPROTO packet. Takes a string containing one or more encoded IPROTO packets and optionally a position in the string to start decoding from. If the position is omitted, the function will start decoding from the beginning of the string. On success returns the decoded packet header, body, and the position in the string where decoding stopped. Both header and body are returned as `msgpack.object`. The body may be absent (set to nil). If the input is truncated, returns nil and the min number of bytes required to decode the packet. On failure, raises an error. For examples, see [`test/app-luatest/iproto_encoder_test.lua`][1]. [1]: https://github.com/tarantool/tarantool/blob/master/test/app-luatest/iproto_encoder_test.lua
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In the scope of #7716, we added the ability to override specific IPROTO requests on a configured Tarantool sever and send IPROTO responses over an IPROTO connection established by the server. Unfortunately, there's still no convenient helpers available that would allow to implement the IPROTO protocol in Lua on top of raw sockets, without configuring box. It could be useful for application developers that want to emulate IPROTO for some reason as well as in tests. Currently, we have to generate IPROTO requests manually, which is tedious:
tarantool/test/box-luatest/ghs_16_user_enumeration_test.lua
Lines 18 to 43 in 2574ff1
What we need is:
This is all done by net.box under the hood. We could probably just make the code public.
The text was updated successfully, but these errors were encountered: