1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/390223051): Remove C-library calls to fix the errors.
#pragma allow_unsafe_libc_calls
#endif
#include "remoting/base/protobuf_http_stream_parser.h"
#include <string.h>
#include "base/logging.h"
#include "base/numerics/safe_conversions.h"
#include "base/strings/stringprintf.h"
#include "net/base/io_buffer.h"
#include "remoting/base/http_status.h"
#include "remoting/base/protobuf_http_client_messages.pb.h"
#include "third_party/protobuf/src/google/protobuf/io/coded_stream.h"
#include "third_party/protobuf/src/google/protobuf/wire_format_lite.h"
namespace remoting {
namespace {
using ::google::protobuf::internal::WireFormatLite;
constexpr int kReadBufferSpareCapacity = 512;
} // namespace
ProtobufHttpStreamParser::ProtobufHttpStreamParser(
const MessageCallback& message_callback,
StreamClosedCallback stream_closed_callback)
: message_callback_(message_callback),
stream_closed_callback_(std::move(stream_closed_callback)) {
DCHECK(message_callback_);
DCHECK(stream_closed_callback_);
}
ProtobufHttpStreamParser::~ProtobufHttpStreamParser() = default;
void ProtobufHttpStreamParser::Append(std::string_view data) {
int required_remaining_capacity = data.size() + kReadBufferSpareCapacity;
if (!read_buffer_) {
read_buffer_ = base::MakeRefCounted<net::GrowableIOBuffer>();
read_buffer_->SetCapacity(required_remaining_capacity);
} else if (read_buffer_->RemainingCapacity() < required_remaining_capacity) {
read_buffer_->SetCapacity(read_buffer_->offset() +
required_remaining_capacity);
}
DCHECK_GE(read_buffer_->RemainingCapacity(), static_cast<int>(data.size()));
memcpy(read_buffer_->data(), data.data(), data.size());
read_buffer_->set_offset(read_buffer_->offset() + data.size());
ParseStreamIfAvailable();
}
bool ProtobufHttpStreamParser::HasPendingData() const {
return read_buffer_ && read_buffer_->offset() > 0;
}
void ProtobufHttpStreamParser::ParseStreamIfAvailable() {
DCHECK(read_buffer_);
auto buffer = read_buffer_->span_before_offset();
google::protobuf::io::CodedInputStream input_stream(buffer.data(),
buffer.size());
int bytes_consumed = 0;
auto weak_this = weak_factory_.GetWeakPtr();
// We can't use StreamBody::ParseFromString() here, as it can't do partial
// parsing, nor can it tell how many bytes are consumed.
while (bytes_consumed < read_buffer_->offset()) {
bool is_successful = ParseOneField(&input_stream);
if (!weak_this) {
// The callback might have deleted |this|, in which case we need to
// carefully return without touching any member of |this|.
return;
}
if (is_successful) {
// Only update |bytes_consumed| if the whole field is decoded.
// |input_stream| can still advance when the field is not decodable.
bytes_consumed = input_stream.CurrentPosition();
} else {
// The stream data can't be fully decoded yet.
break;
}
}
if (bytes_consumed <= 0) {
return;
}
base::span<const uint8_t> bytes_not_consumed =
read_buffer_->span_before_offset().subspan(
static_cast<size_t>(bytes_consumed));
read_buffer_->everything().copy_prefix_from(bytes_not_consumed);
read_buffer_->set_offset(bytes_not_consumed.size());
}
bool ProtobufHttpStreamParser::ParseOneField(
google::protobuf::io::CodedInputStream* input_stream) {
// Note that the StreamBody definition is only significant in its tag ID
// allocations for "messages" and "status". There isn't any clear boundary
// between two StreamBody instances.
//
// A typical stream looks like:
//
// [message tag] <length> <message> [message tag] <length> <message> ...
// [status tag] <status> EOF
//
// Stream data failing to comply with this format usually means more data is
// needed.
uint32_t message_tag = input_stream->ReadTag();
if (message_tag == 0) {
VLOG(1) << "Can't read message tag yet.";
return false;
}
WireFormatLite::WireType wire_type =
WireFormatLite::GetTagWireType(message_tag);
int field_number = WireFormatLite::GetTagFieldNumber(message_tag);
switch (field_number) {
case protobufhttpclient::StreamBody::kMessagesFieldNumber: {
if (!ValidateWireType(field_number, wire_type)) {
break;
}
std::string message;
if (!WireFormatLite::ReadBytes(input_stream, &message)) {
VLOG(1) << "Can't read stream message yet.";
return false;
}
VLOG(1) << "Stream message decoded.";
message_callback_.Run(message);
break;
}
case protobufhttpclient::StreamBody::kStatusFieldNumber: {
if (!ValidateWireType(field_number, wire_type)) {
break;
}
protobufhttpclient::Status status;
if (!WireFormatLite::ReadMessage(input_stream, &status)) {
VLOG(1) << "Can't read status yet.";
return false;
}
VLOG(1) << "Client status decoded.";
std::move(stream_closed_callback_).Run(HttpStatus(status));
break;
}
default:
if (field_number == protobufhttpclient::StreamBody::kNoopFieldNumber) {
VLOG(1) << "Found noop field.";
} else {
LOG(WARNING) << "Skipping unrecognized StreamBody field: "
<< field_number
<< ", wire type: " << static_cast<int>(wire_type);
}
if (!WireFormatLite::SkipField(input_stream, message_tag)) {
VLOG(1) << "Can't skip the field yet.";
return false;
}
break;
}
return true;
}
bool ProtobufHttpStreamParser::ValidateWireType(
int field_number,
WireFormatLite::WireType wire_type) {
if (wire_type == WireFormatLite::WireType::WIRETYPE_LENGTH_DELIMITED) {
return true;
}
auto error_message = base::StringPrintf(
"Invalid wire type %d for field number %d", wire_type, field_number);
LOG(WARNING) << error_message;
std::move(stream_closed_callback_)
.Run(HttpStatus(HttpStatus::Code::UNKNOWN, error_message));
return false;
}
} // namespace remoting
|
