mirror of https://github.com/grpc/grpc.git
[binder] Client fuzzer (#27052)
* Add client fuzzer * Limit readable parcel size to 1MBreviewable/pr27355/r1
parent
4cb907457b
commit
b45568212f
3 changed files with 402 additions and 0 deletions
@ -0,0 +1,47 @@ |
||||
# Copyright 2021 gRPC authors. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); |
||||
# you may not use this file except in compliance with the License. |
||||
# You may obtain a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, |
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
# See the License for the specific language governing permissions and |
||||
# limitations under the License. |
||||
|
||||
load("//bazel:grpc_build_system.bzl", "grpc_package") |
||||
load("//test/core/util:grpc_fuzzer.bzl", "grpc_fuzzer") |
||||
|
||||
grpc_package( |
||||
name = "test/core/transport/binder/end2end/fuzzers", |
||||
features = [ |
||||
"layering_check", |
||||
], |
||||
) |
||||
|
||||
licenses(["notice"]) |
||||
|
||||
grpc_fuzzer( |
||||
name = "client_fuzzer", |
||||
srcs = ["client_fuzzer.cc"], |
||||
corpus = "client_fuzzer_corpus", |
||||
language = "C++", |
||||
tags = [ |
||||
"no_mac", |
||||
"no_windows", |
||||
], |
||||
deps = [ |
||||
"//:gpr", |
||||
"//:gpr_base", |
||||
"//:grpc++_base", |
||||
"//:grpc_base", |
||||
"//:grpc_base_c", |
||||
"//src/core/ext/transport/binder/transport:binder_transport", |
||||
"//src/core/ext/transport/binder/wire_format:binder", |
||||
"//src/core/ext/transport/binder/wire_format:wire_reader", |
||||
"//test/core/util:grpc_test_util", |
||||
], |
||||
) |
@ -0,0 +1,355 @@ |
||||
// Copyright 2021 gRPC authors.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
#include <fuzzer/FuzzedDataProvider.h> |
||||
|
||||
#include <thread> |
||||
#include <utility> |
||||
|
||||
#include "absl/memory/memory.h" |
||||
|
||||
#include "src/core/ext/transport/binder/transport/binder_transport.h" |
||||
#include "src/core/ext/transport/binder/wire_format/binder.h" |
||||
#include "src/core/ext/transport/binder/wire_format/wire_reader.h" |
||||
#include "src/core/lib/iomgr/executor.h" |
||||
#include "src/core/lib/surface/channel.h" |
||||
|
||||
bool squelch = true; |
||||
bool leak_check = true; |
||||
|
||||
namespace { |
||||
|
||||
// A WritableParcel implementation that simply does nothing. Don't use
|
||||
// MockWritableParcel here since capturing calls is expensive.
|
||||
class NoOpWritableParcel : public grpc_binder::WritableParcel { |
||||
public: |
||||
int32_t GetDataSize() const override { return 0; } |
||||
absl::Status WriteInt32(int32_t /*data*/) override { |
||||
return absl::OkStatus(); |
||||
} |
||||
absl::Status WriteInt64(int64_t /*data*/) override { |
||||
return absl::OkStatus(); |
||||
} |
||||
absl::Status WriteBinder(grpc_binder::HasRawBinder* /*binder*/) override { |
||||
return absl::OkStatus(); |
||||
} |
||||
absl::Status WriteString(absl::string_view /*s*/) override { |
||||
return absl::OkStatus(); |
||||
} |
||||
absl::Status WriteByteArray(const int8_t* /*buffer*/, |
||||
int32_t /*length*/) override { |
||||
return absl::OkStatus(); |
||||
} |
||||
}; |
||||
|
||||
// Binder implementation used in fuzzing.
|
||||
//
|
||||
// Most of its the functionalities are no-op, except ConstructTxReceiver now
|
||||
// returns a TransactionReceiverForFuzzing.
|
||||
class BinderForFuzzing : public grpc_binder::Binder { |
||||
public: |
||||
BinderForFuzzing() : input_(absl::make_unique<NoOpWritableParcel>()) {} |
||||
|
||||
BinderForFuzzing(const uint8_t* data, size_t size) |
||||
: data_(data), |
||||
size_(size), |
||||
input_(absl::make_unique<NoOpWritableParcel>()) {} |
||||
|
||||
void Initialize() override {} |
||||
absl::Status PrepareTransaction() override { return absl::OkStatus(); } |
||||
|
||||
absl::Status Transact( |
||||
grpc_binder::BinderTransportTxCode /*tx_code*/) override { |
||||
return absl::OkStatus(); |
||||
} |
||||
|
||||
std::unique_ptr<grpc_binder::TransactionReceiver> ConstructTxReceiver( |
||||
grpc_core::RefCountedPtr<grpc_binder::WireReader> wire_reader_ref, |
||||
grpc_binder::TransactionReceiver::OnTransactCb cb) const override; |
||||
|
||||
grpc_binder::WritableParcel* GetWritableParcel() const override { |
||||
return input_.get(); |
||||
} |
||||
void* GetRawBinder() override { return nullptr; } |
||||
|
||||
private: |
||||
const uint8_t* data_; |
||||
size_t size_; |
||||
std::unique_ptr<grpc_binder::WritableParcel> input_; |
||||
}; |
||||
|
||||
// ReadableParcel implementation used in fuzzing.
|
||||
//
|
||||
// It consumes a FuzzedDataProvider, and returns fuzzed data upon user's
|
||||
// requests.
|
||||
class ReadableParcelForFuzzing : public grpc_binder::ReadableParcel { |
||||
public: |
||||
ReadableParcelForFuzzing(FuzzedDataProvider* data_provider, |
||||
bool is_setup_transport) |
||||
: data_provider_(data_provider), |
||||
is_setup_transport_(is_setup_transport), |
||||
consumed_data_size_(0) {} |
||||
|
||||
int32_t GetDataSize() const override { |
||||
return data_provider_->ConsumeIntegral<int32_t>(); |
||||
} |
||||
absl::Status ReadInt32(int32_t* data) override { |
||||
if (consumed_data_size_ >= kParcelDataSizeLimit) { |
||||
return absl::InternalError("Parcel size limit exceeds"); |
||||
} |
||||
if (!is_setup_transport_ && data_provider_->ConsumeBool()) { |
||||
return absl::InternalError("error"); |
||||
} |
||||
*data = data_provider_->ConsumeIntegral<int32_t>(); |
||||
consumed_data_size_ += sizeof(int32_t); |
||||
return absl::OkStatus(); |
||||
} |
||||
absl::Status ReadInt64(int64_t* data) override { |
||||
if (consumed_data_size_ >= kParcelDataSizeLimit) { |
||||
return absl::InternalError("Parcel size limit exceeds"); |
||||
} |
||||
if (!is_setup_transport_ && data_provider_->ConsumeBool()) { |
||||
return absl::InternalError("error"); |
||||
} |
||||
*data = data_provider_->ConsumeIntegral<int64_t>(); |
||||
consumed_data_size_ += sizeof(int64_t); |
||||
return absl::OkStatus(); |
||||
} |
||||
absl::Status ReadBinder( |
||||
std::unique_ptr<grpc_binder::Binder>* binder) override { |
||||
if (consumed_data_size_ >= kParcelDataSizeLimit) { |
||||
return absl::InternalError("Parcel size limit exceeds"); |
||||
} |
||||
if (!is_setup_transport_ && data_provider_->ConsumeBool()) { |
||||
return absl::InternalError("error"); |
||||
} |
||||
*binder = absl::make_unique<BinderForFuzzing>(); |
||||
consumed_data_size_ += sizeof(void*); |
||||
return absl::OkStatus(); |
||||
} |
||||
absl::Status ReadByteArray(std::string* data) override { |
||||
if (consumed_data_size_ >= kParcelDataSizeLimit) { |
||||
return absl::InternalError("Parcel size limit exceeds"); |
||||
} |
||||
if (!is_setup_transport_ && data_provider_->ConsumeBool()) { |
||||
return absl::InternalError("error"); |
||||
} |
||||
*data = data_provider_->ConsumeRandomLengthString(100); |
||||
consumed_data_size_ += data->size(); |
||||
return absl::OkStatus(); |
||||
} |
||||
absl::Status ReadString(std::string* data) override { |
||||
if (consumed_data_size_ >= kParcelDataSizeLimit) { |
||||
return absl::InternalError("Parcel size limit exceeds"); |
||||
} |
||||
if (!is_setup_transport_ && data_provider_->ConsumeBool()) { |
||||
return absl::InternalError("error"); |
||||
} |
||||
*data = data_provider_->ConsumeRandomLengthString(100); |
||||
consumed_data_size_ += data->size(); |
||||
return absl::OkStatus(); |
||||
} |
||||
|
||||
private: |
||||
FuzzedDataProvider* data_provider_; |
||||
// Whether this parcel contains a SETUP_TRANSPORT request. If it is, we will
|
||||
// avoid returning errors in the Read* functions so that the fuzzer will not
|
||||
// be blocked waiting for the correct request.
|
||||
bool is_setup_transport_; |
||||
|
||||
static constexpr size_t kParcelDataSizeLimit = 1024 * 1024; |
||||
size_t consumed_data_size_; |
||||
}; |
||||
|
||||
std::thread* g_fuzzing_thread = nullptr; |
||||
|
||||
void FuzzingLoop( |
||||
const uint8_t* data, size_t size, |
||||
grpc_core::RefCountedPtr<grpc_binder::WireReader> wire_reader_ref, |
||||
grpc_binder::TransactionReceiver::OnTransactCb callback) { |
||||
FuzzedDataProvider data_provider(data, size); |
||||
{ |
||||
// Send SETUP_TRANSPORT request.
|
||||
std::unique_ptr<grpc_binder::ReadableParcel> parcel = |
||||
absl::make_unique<ReadableParcelForFuzzing>( |
||||
&data_provider, |
||||
/*is_setup_transport=*/true); |
||||
callback(static_cast<transaction_code_t>( |
||||
grpc_binder::BinderTransportTxCode::SETUP_TRANSPORT), |
||||
parcel.get()) |
||||
.IgnoreError(); |
||||
} |
||||
while (data_provider.remaining_bytes() > 0) { |
||||
transaction_code_t tx_code = |
||||
data_provider.ConsumeIntegralInRange<transaction_code_t>( |
||||
0, LAST_CALL_TRANSACTION); |
||||
std::unique_ptr<grpc_binder::ReadableParcel> parcel = |
||||
absl::make_unique<ReadableParcelForFuzzing>( |
||||
&data_provider, |
||||
/*is_setup_transport=*/false); |
||||
callback(tx_code, parcel.get()).IgnoreError(); |
||||
} |
||||
wire_reader_ref = nullptr; |
||||
} |
||||
|
||||
// TransactionReceiver implementation used in fuzzing.
|
||||
//
|
||||
// When constructed, start sending fuzzed requests to the client. When all the
|
||||
// bytes are consumed, the reference to WireReader will be released.
|
||||
class TransactionReceiverForFuzzing : public grpc_binder::TransactionReceiver { |
||||
public: |
||||
TransactionReceiverForFuzzing( |
||||
const uint8_t* data, size_t size, |
||||
grpc_core::RefCountedPtr<grpc_binder::WireReader> wire_reader_ref, |
||||
grpc_binder::TransactionReceiver::OnTransactCb cb) { |
||||
gpr_log(GPR_INFO, "Construct TransactionReceiverForFuzzing"); |
||||
GPR_ASSERT(g_fuzzing_thread == nullptr); |
||||
g_fuzzing_thread = new std::thread( |
||||
FuzzingLoop, data, size, std::move(wire_reader_ref), std::move(cb)); |
||||
} |
||||
|
||||
void* GetRawBinder() override { return nullptr; } |
||||
}; |
||||
|
||||
std::unique_ptr<grpc_binder::TransactionReceiver> |
||||
BinderForFuzzing::ConstructTxReceiver( |
||||
grpc_core::RefCountedPtr<grpc_binder::WireReader> wire_reader_ref, |
||||
grpc_binder::TransactionReceiver::OnTransactCb cb) const { |
||||
return absl::make_unique<TransactionReceiverForFuzzing>(data_, size_, |
||||
wire_reader_ref, cb); |
||||
} |
||||
|
||||
void* tag(intptr_t t) { return reinterpret_cast<void*>(t); } |
||||
void dont_log(gpr_log_func_args*) {} |
||||
|
||||
} // namespace
|
||||
|
||||
extern "C" int LLVMFuzzerTestOneInput(const uint8_t* data, size_t size) { |
||||
grpc_test_only_set_slice_hash_seed(0); |
||||
if (squelch) gpr_set_log_function(dont_log); |
||||
grpc_init(); |
||||
{ |
||||
// Copied and modified from grpc/test/core/end2end/fuzzers/client_fuzzer.cc
|
||||
grpc_core::ExecCtx exec_ctx; |
||||
grpc_core::Executor::SetThreadingAll(false); |
||||
|
||||
grpc_completion_queue* cq = grpc_completion_queue_create_for_next(nullptr); |
||||
grpc_transport* client_transport = grpc_create_binder_transport_client( |
||||
absl::make_unique<BinderForFuzzing>(data, size)); |
||||
grpc_arg authority_arg = grpc_channel_arg_string_create( |
||||
const_cast<char*>(GRPC_ARG_DEFAULT_AUTHORITY), |
||||
const_cast<char*>("test-authority")); |
||||
grpc_channel_args* args = |
||||
grpc_channel_args_copy_and_add(nullptr, &authority_arg, 1); |
||||
grpc_channel* channel = |
||||
grpc_channel_create("test-target", args, GRPC_CLIENT_DIRECT_CHANNEL, |
||||
client_transport, nullptr, 0, nullptr); |
||||
grpc_channel_args_destroy(args); |
||||
grpc_slice host = grpc_slice_from_static_string("localhost"); |
||||
grpc_call* call = grpc_channel_create_call( |
||||
channel, nullptr, 0, cq, grpc_slice_from_static_string("/foo"), &host, |
||||
gpr_inf_future(GPR_CLOCK_REALTIME), nullptr); |
||||
grpc_metadata_array initial_metadata_recv; |
||||
grpc_metadata_array_init(&initial_metadata_recv); |
||||
grpc_byte_buffer* response_payload_recv = nullptr; |
||||
grpc_metadata_array trailing_metadata_recv; |
||||
grpc_metadata_array_init(&trailing_metadata_recv); |
||||
grpc_status_code status; |
||||
grpc_slice details = grpc_empty_slice(); |
||||
|
||||
grpc_op ops[6]; |
||||
memset(ops, 0, sizeof(ops)); |
||||
grpc_op* op = ops; |
||||
op->op = GRPC_OP_SEND_INITIAL_METADATA; |
||||
op->data.send_initial_metadata.count = 0; |
||||
op->flags = 0; |
||||
op->reserved = nullptr; |
||||
op++; |
||||
op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
||||
op->flags = 0; |
||||
op->reserved = nullptr; |
||||
op++; |
||||
op->op = GRPC_OP_RECV_INITIAL_METADATA; |
||||
op->data.recv_initial_metadata.recv_initial_metadata = |
||||
&initial_metadata_recv; |
||||
op->flags = 0; |
||||
op->reserved = nullptr; |
||||
op++; |
||||
op->op = GRPC_OP_RECV_MESSAGE; |
||||
op->data.recv_message.recv_message = &response_payload_recv; |
||||
op->flags = 0; |
||||
op->reserved = nullptr; |
||||
op++; |
||||
op->op = GRPC_OP_RECV_STATUS_ON_CLIENT; |
||||
op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv; |
||||
op->data.recv_status_on_client.status = &status; |
||||
op->data.recv_status_on_client.status_details = &details; |
||||
op->flags = 0; |
||||
op->reserved = nullptr; |
||||
op++; |
||||
grpc_call_error error = |
||||
grpc_call_start_batch(call, ops, (size_t)(op - ops), tag(1), nullptr); |
||||
int requested_calls = 1; |
||||
GPR_ASSERT(GRPC_CALL_OK == error); |
||||
grpc_event ev; |
||||
while (true) { |
||||
grpc_core::ExecCtx::Get()->Flush(); |
||||
ev = grpc_completion_queue_next(cq, gpr_inf_past(GPR_CLOCK_REALTIME), |
||||
nullptr); |
||||
switch (ev.type) { |
||||
case GRPC_QUEUE_TIMEOUT: |
||||
goto done; |
||||
case GRPC_QUEUE_SHUTDOWN: |
||||
break; |
||||
case GRPC_OP_COMPLETE: |
||||
requested_calls--; |
||||
break; |
||||
} |
||||
} |
||||
|
||||
done: |
||||
if (requested_calls) { |
||||
grpc_call_cancel(call, nullptr); |
||||
} |
||||
if (g_fuzzing_thread) { |
||||
g_fuzzing_thread->join(); |
||||
} |
||||
for (int i = 0; i < requested_calls; i++) { |
||||
ev = grpc_completion_queue_next(cq, gpr_inf_past(GPR_CLOCK_REALTIME), |
||||
nullptr); |
||||
GPR_ASSERT(ev.type == GRPC_OP_COMPLETE); |
||||
} |
||||
grpc_completion_queue_shutdown(cq); |
||||
for (int i = 0; i < requested_calls; i++) { |
||||
ev = grpc_completion_queue_next(cq, gpr_inf_past(GPR_CLOCK_REALTIME), |
||||
nullptr); |
||||
GPR_ASSERT(ev.type == GRPC_QUEUE_SHUTDOWN); |
||||
} |
||||
grpc_call_unref(call); |
||||
grpc_completion_queue_destroy(cq); |
||||
grpc_metadata_array_destroy(&initial_metadata_recv); |
||||
grpc_metadata_array_destroy(&trailing_metadata_recv); |
||||
grpc_slice_unref(details); |
||||
grpc_channel_destroy(channel); |
||||
if (response_payload_recv != nullptr) { |
||||
grpc_byte_buffer_destroy(response_payload_recv); |
||||
} |
||||
} |
||||
if (g_fuzzing_thread) { |
||||
delete g_fuzzing_thread; |
||||
g_fuzzing_thread = nullptr; |
||||
} |
||||
grpc_shutdown(); |
||||
return 0; |
||||
} |
Loading…
Reference in new issue