GitHub/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim synced 2025-07-16 01:01:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

RPC: conform message-id type to msgpack-RPC spec

Browse Source 
According to [MessagePack RPC specification](https://github.com/msgpack-rpc/msgpack-rpc),
message ID must be 32-bit unsigned integer. But Neovim implementation
uses uint64_t instead of uint32_t. This can have wrong results in the
case of large ids or a malformed request, for example:

    Actual response:   [1,18446744073709551615,[1,"Message is not an array"],null]
    Expected response: [1,4294967295,[1,"Message is not an array"],null]

The issue does not affect RPC clients written in dynamically-typed
languages like Python. Wrong type of sequence id number breaks RPC
clients written statically typed languages like C/C++/Golang: all of
them expect uint32_t as message id.
Examples:
  11268ba2be/src/msgpack/rpc/protocol.h (L27)
  https://github.com/ugorji/go/blob/master/codec/msgpack.go#L993

closes #8850
This commit is contained in:
Daniel Bershatsky
2019-04-12 02:30:19 +02:00
committed by Justin M. Keyes
parent fd00806f01
commit 8dbf23181a
3 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/nvim/msgpack_rpc/channel.c
View File

@ -131,7 +131,7 @@ Object rpc_send_call(uint64_t id,
channel_incref(channel);
RpcState *rpc = &channel->rpc;
uint64_t request_id = rpc->next_request_id++;
uint32_t request_id = rpc->next_request_id++;
// Send the msgpack-rpc request
send_request(channel, request_id, method_name, args);
@ -292,7 +292,7 @@ static void parse_msgpack(Channel *channel)
static void handle_request(Channel *channel, msgpack_object *request)
FUNC_ATTR_NONNULL_ALL
{
uint64_t request_id;
uint32_t request_id;
Error error = ERROR_INIT;
MessageType type = msgpack_rpc_validate(&request_id, request, &error);
@ -437,7 +437,7 @@ static void internal_read_event(void **argv)
wstream_release_wbuffer(buffer);
}
static void send_error(Channel *chan, MessageType type, uint64_t id, char *err)
static void send_error(Channel *chan, MessageType type, uint32_t id, char *err)
{
Error e = ERROR_INIT;
api_set_error(&e, kErrorTypeException, "%s", err);
@ -451,7 +451,7 @@ static void send_error(Channel *chan, MessageType type, uint64_t id, char *err)
}
static void send_request(Channel *channel,
uint64_t id,
uint32_t id,
const char *name,
Array args)
{
@ -584,7 +584,7 @@ static bool is_rpc_response(msgpack_object *obj)
static bool is_valid_rpc_response(msgpack_object *obj, Channel *channel)
{
uint64_t response_id = obj->via.array.ptr[1].via.u64;
uint32_t response_id = (uint32_t)obj->via.array.ptr[1].via.u64;
if (kv_size(channel->rpc.call_stack) == 0) {
return false;
}
@ -622,7 +622,7 @@ static void call_set_error(Channel *channel, char *msg, int loglevel)
}
static WBuffer *serialize_request(uint64_t channel_id,
uint64_t request_id,
uint32_t request_id,
const String method,
Array args,
msgpack_sbuffer *sbuffer,
@ -643,7 +643,7 @@ static WBuffer *serialize_request(uint64_t channel_id,
static WBuffer *serialize_response(uint64_t channel_id,
MessageType type,
uint64_t response_id,
uint32_t response_id,
Error *err,
Object arg,
msgpack_sbuffer *sbuffer)

6
src/nvim/msgpack_rpc/channel_defs.h
View File

@ -13,7 +13,7 @@
typedef struct Channel Channel;
typedef struct {
uint64_t request_id;
uint32_t request_id;
bool returned, errored;
Object result;
} ChannelCallFrame;
@ -23,14 +23,14 @@ typedef struct {
Channel *channel;
MsgpackRpcRequestHandler handler;
Array args;
uint64_t request_id;
uint32_t request_id;
} RequestEvent;
typedef struct {
PMap(cstr_t) *subscribed_events;
bool closed;
msgpack_unpacker *unpacker;
uint64_t next_request_id;
uint32_t next_request_id;
kvec_t(ChannelCallFrame *) call_stack;
Dictionary info;
} RpcState;

12
src/nvim/msgpack_rpc/helpers.c
View File

@ -489,7 +489,7 @@ void msgpack_rpc_from_dictionary(Dictionary result, msgpack_packer *res)
}
/// Serializes a msgpack-rpc request or notification(id == 0)
void msgpack_rpc_serialize_request(uint64_t request_id,
void msgpack_rpc_serialize_request(uint32_t request_id,
const String method,
Array args,
msgpack_packer *pac)
@ -499,7 +499,7 @@ void msgpack_rpc_serialize_request(uint64_t request_id,
msgpack_pack_int(pac, request_id ? 0 : 2);
if (request_id) {
msgpack_pack_uint64(pac, request_id);
msgpack_pack_uint32(pac, request_id);
}
msgpack_rpc_from_string(method, pac);
@ -507,7 +507,7 @@ void msgpack_rpc_serialize_request(uint64_t request_id,
}
/// Serializes a msgpack-rpc response
void msgpack_rpc_serialize_response(uint64_t response_id,
void msgpack_rpc_serialize_response(uint32_t response_id,
Error *err,
Object arg,
msgpack_packer *pac)
@ -515,7 +515,7 @@ void msgpack_rpc_serialize_response(uint64_t response_id,
{
msgpack_pack_array(pac, 4);
msgpack_pack_int(pac, 1);
msgpack_pack_uint64(pac, response_id);
msgpack_pack_uint32(pac, response_id);
if (ERROR_SET(err)) {
// error represented by a [type, message] array
@ -561,7 +561,7 @@ static msgpack_object *msgpack_rpc_msg_id(msgpack_object *req)
return obj->type == MSGPACK_OBJECT_POSITIVE_INTEGER ? obj : NULL;
}
MessageType msgpack_rpc_validate(uint64_t *response_id, msgpack_object *req,
MessageType msgpack_rpc_validate(uint32_t *response_id, msgpack_object *req,
Error *err)
{
*response_id = 0;
@ -600,7 +600,7 @@ MessageType msgpack_rpc_validate(uint64_t *response_id, msgpack_object *req,
api_set_error(err, kErrorTypeValidation, "ID must be a positive integer");
return type;
}
*response_id = id_obj->via.u64;
*response_id = (uint32_t)id_obj->via.u64;
}
if (!msgpack_rpc_method(req)) {