mirror of https://github.com/grpc/grpc.git
Yash Tibrewal
6 years ago
commit
3896dabb85
161 changed files with 7314 additions and 3376 deletions
@ -0,0 +1,3 @@ |
||||
# load bazelrc from the legacy location |
||||
# as recommended in https://github.com/bazelbuild/bazel/issues/6319 |
||||
import %workspace%/tools/bazel.rc |
||||
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
@ -0,0 +1,44 @@ |
||||
# Copyright 2018 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. |
||||
"""The Python implementation of the GRPC helloworld.Greeter client with channel options and call timeout parameters.""" |
||||
|
||||
from __future__ import print_function |
||||
|
||||
import grpc |
||||
|
||||
import helloworld_pb2 |
||||
import helloworld_pb2_grpc |
||||
|
||||
|
||||
def run(): |
||||
# NOTE(gRPC Python Team): .close() is possible on a channel and should be |
||||
# used in circumstances in which the with statement does not fit the needs |
||||
# of the code. |
||||
# |
||||
# For more channel options, please see https://grpc.io/grpc/core/group__grpc__arg__keys.html |
||||
with grpc.insecure_channel( |
||||
target='localhost:50051', |
||||
options=[('grpc.lb_policy_name', 'pick_first'), |
||||
('grpc.enable_retries', 0), ('grpc.keepalive_timeout_ms', |
||||
10000)]) as channel: |
||||
stub = helloworld_pb2_grpc.GreeterStub(channel) |
||||
# Timeout in seconds. |
||||
# Please refer gRPC Python documents for more detail. https://grpc.io/grpc/python/grpc.html |
||||
response = stub.SayHello( |
||||
helloworld_pb2.HelloRequest(name='you'), timeout=10) |
||||
print("Greeter client received: " + response.message) |
||||
|
||||
|
||||
if __name__ == '__main__': |
||||
run() |
||||
@ -1,7 +1,7 @@ |
||||
/* Automatically generated nanopb constant definitions */ |
||||
/* Generated by nanopb-0.3.7-dev */ |
||||
|
||||
#include "src/cpp/server/health/health.pb.h" |
||||
#include "src/core/ext/filters/client_channel/health/health.pb.h" |
||||
/* @@protoc_insertion_point(includes) */ |
||||
#if PB_PROTO_HEADER_VERSION != 30 |
||||
#error Regenerate this file with the current version of nanopb generator. |
||||
@ -0,0 +1,647 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 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 <grpc/support/port_platform.h> |
||||
|
||||
#include <stdint.h> |
||||
#include <stdio.h> |
||||
|
||||
#include "src/core/ext/filters/client_channel/health/health_check_client.h" |
||||
|
||||
#include "pb_decode.h" |
||||
#include "pb_encode.h" |
||||
#include "src/core/ext/filters/client_channel/health/health.pb.h" |
||||
#include "src/core/lib/debug/trace.h" |
||||
#include "src/core/lib/gprpp/mutex_lock.h" |
||||
#include "src/core/lib/slice/slice_internal.h" |
||||
#include "src/core/lib/transport/error_utils.h" |
||||
#include "src/core/lib/transport/status_metadata.h" |
||||
|
||||
#define HEALTH_CHECK_INITIAL_CONNECT_BACKOFF_SECONDS 1 |
||||
#define HEALTH_CHECK_RECONNECT_BACKOFF_MULTIPLIER 1.6 |
||||
#define HEALTH_CHECK_RECONNECT_MAX_BACKOFF_SECONDS 120 |
||||
#define HEALTH_CHECK_RECONNECT_JITTER 0.2 |
||||
|
||||
grpc_core::TraceFlag grpc_health_check_client_trace(false, |
||||
"health_check_client"); |
||||
|
||||
namespace grpc_core { |
||||
|
||||
//
|
||||
// HealthCheckClient
|
||||
//
|
||||
|
||||
HealthCheckClient::HealthCheckClient( |
||||
const char* service_name, |
||||
RefCountedPtr<ConnectedSubchannel> connected_subchannel, |
||||
grpc_pollset_set* interested_parties, |
||||
grpc_core::RefCountedPtr<grpc_core::channelz::SubchannelNode> channelz_node) |
||||
: InternallyRefCountedWithTracing<HealthCheckClient>( |
||||
&grpc_health_check_client_trace), |
||||
service_name_(service_name), |
||||
connected_subchannel_(std::move(connected_subchannel)), |
||||
interested_parties_(interested_parties), |
||||
channelz_node_(std::move(channelz_node)), |
||||
retry_backoff_( |
||||
BackOff::Options() |
||||
.set_initial_backoff( |
||||
HEALTH_CHECK_INITIAL_CONNECT_BACKOFF_SECONDS * 1000) |
||||
.set_multiplier(HEALTH_CHECK_RECONNECT_BACKOFF_MULTIPLIER) |
||||
.set_jitter(HEALTH_CHECK_RECONNECT_JITTER) |
||||
.set_max_backoff(HEALTH_CHECK_RECONNECT_MAX_BACKOFF_SECONDS * |
||||
1000)) { |
||||
if (grpc_health_check_client_trace.enabled()) { |
||||
gpr_log(GPR_INFO, "created HealthCheckClient %p", this); |
||||
} |
||||
GRPC_CLOSURE_INIT(&retry_timer_callback_, OnRetryTimer, this, |
||||
grpc_schedule_on_exec_ctx); |
||||
gpr_mu_init(&mu_); |
||||
StartCall(); |
||||
} |
||||
|
||||
HealthCheckClient::~HealthCheckClient() { |
||||
if (grpc_health_check_client_trace.enabled()) { |
||||
gpr_log(GPR_INFO, "destroying HealthCheckClient %p", this); |
||||
} |
||||
GRPC_ERROR_UNREF(error_); |
||||
gpr_mu_destroy(&mu_); |
||||
} |
||||
|
||||
void HealthCheckClient::NotifyOnHealthChange(grpc_connectivity_state* state, |
||||
grpc_closure* closure) { |
||||
MutexLock lock(&mu_); |
||||
GPR_ASSERT(notify_state_ == nullptr); |
||||
if (*state != state_) { |
||||
*state = state_; |
||||
GRPC_CLOSURE_SCHED(closure, GRPC_ERROR_REF(error_)); |
||||
return; |
||||
} |
||||
notify_state_ = state; |
||||
on_health_changed_ = closure; |
||||
} |
||||
|
||||
void HealthCheckClient::SetHealthStatus(grpc_connectivity_state state, |
||||
grpc_error* error) { |
||||
MutexLock lock(&mu_); |
||||
SetHealthStatusLocked(state, error); |
||||
} |
||||
|
||||
void HealthCheckClient::SetHealthStatusLocked(grpc_connectivity_state state, |
||||
grpc_error* error) { |
||||
if (grpc_health_check_client_trace.enabled()) { |
||||
gpr_log(GPR_INFO, "HealthCheckClient %p: setting state=%d error=%s", this, |
||||
state, grpc_error_string(error)); |
||||
} |
||||
if (notify_state_ != nullptr && *notify_state_ != state) { |
||||
*notify_state_ = state; |
||||
notify_state_ = nullptr; |
||||
GRPC_CLOSURE_SCHED(on_health_changed_, GRPC_ERROR_REF(error)); |
||||
on_health_changed_ = nullptr; |
||||
} |
||||
state_ = state; |
||||
GRPC_ERROR_UNREF(error_); |
||||
error_ = error; |
||||
} |
||||
|
||||
void HealthCheckClient::Orphan() { |
||||
if (grpc_health_check_client_trace.enabled()) { |
||||
gpr_log(GPR_INFO, "HealthCheckClient %p: shutting down", this); |
||||
} |
||||
{ |
||||
MutexLock lock(&mu_); |
||||
if (on_health_changed_ != nullptr) { |
||||
*notify_state_ = GRPC_CHANNEL_SHUTDOWN; |
||||
notify_state_ = nullptr; |
||||
GRPC_CLOSURE_SCHED(on_health_changed_, GRPC_ERROR_NONE); |
||||
on_health_changed_ = nullptr; |
||||
} |
||||
shutting_down_ = true; |
||||
call_state_.reset(); |
||||
if (retry_timer_callback_pending_) { |
||||
grpc_timer_cancel(&retry_timer_); |
||||
} |
||||
} |
||||
Unref(DEBUG_LOCATION, "orphan"); |
||||
} |
||||
|
||||
void HealthCheckClient::StartCall() { |
||||
MutexLock lock(&mu_); |
||||
StartCallLocked(); |
||||
} |
||||
|
||||
void HealthCheckClient::StartCallLocked() { |
||||
if (shutting_down_) return; |
||||
GPR_ASSERT(call_state_ == nullptr); |
||||
SetHealthStatusLocked(GRPC_CHANNEL_CONNECTING, GRPC_ERROR_NONE); |
||||
call_state_ = MakeOrphanable<CallState>(Ref(), interested_parties_); |
||||
if (grpc_health_check_client_trace.enabled()) { |
||||
gpr_log(GPR_INFO, "HealthCheckClient %p: created CallState %p", this, |
||||
call_state_.get()); |
||||
} |
||||
call_state_->StartCall(); |
||||
} |
||||
|
||||
void HealthCheckClient::StartRetryTimer() { |
||||
MutexLock lock(&mu_); |
||||
SetHealthStatusLocked( |
||||
GRPC_CHANNEL_TRANSIENT_FAILURE, |
||||
GRPC_ERROR_CREATE_FROM_STATIC_STRING( |
||||
"health check call failed; will retry after backoff")); |
||||
grpc_millis next_try = retry_backoff_.NextAttemptTime(); |
||||
if (grpc_health_check_client_trace.enabled()) { |
||||
gpr_log(GPR_INFO, "HealthCheckClient %p: health check call lost...", this); |
||||
grpc_millis timeout = next_try - ExecCtx::Get()->Now(); |
||||
if (timeout > 0) { |
||||
gpr_log(GPR_INFO, |
||||
"HealthCheckClient %p: ... will retry in %" PRId64 "ms.", this, |
||||
timeout); |
||||
} else { |
||||
gpr_log(GPR_INFO, "HealthCheckClient %p: ... retrying immediately.", |
||||
this); |
||||
} |
||||
} |
||||
// Ref for callback, tracked manually.
|
||||
Ref(DEBUG_LOCATION, "health_retry_timer").release(); |
||||
retry_timer_callback_pending_ = true; |
||||
grpc_timer_init(&retry_timer_, next_try, &retry_timer_callback_); |
||||
} |
||||
|
||||
void HealthCheckClient::OnRetryTimer(void* arg, grpc_error* error) { |
||||
HealthCheckClient* self = static_cast<HealthCheckClient*>(arg); |
||||
{ |
||||
MutexLock lock(&self->mu_); |
||||
self->retry_timer_callback_pending_ = false; |
||||
if (!self->shutting_down_ && error == GRPC_ERROR_NONE && |
||||
self->call_state_ == nullptr) { |
||||
if (grpc_health_check_client_trace.enabled()) { |
||||
gpr_log(GPR_INFO, "HealthCheckClient %p: restarting health check call", |
||||
self); |
||||
} |
||||
self->StartCallLocked(); |
||||
} |
||||
} |
||||
self->Unref(DEBUG_LOCATION, "health_retry_timer"); |
||||
} |
||||
|
||||
//
|
||||
// protobuf helpers
|
||||
//
|
||||
|
||||
namespace { |
||||
|
||||
void EncodeRequest(const char* service_name, |
||||
ManualConstructor<SliceBufferByteStream>* send_message) { |
||||
grpc_health_v1_HealthCheckRequest request_struct; |
||||
request_struct.has_service = true; |
||||
snprintf(request_struct.service, sizeof(request_struct.service), "%s", |
||||
service_name); |
||||
pb_ostream_t ostream; |
||||
memset(&ostream, 0, sizeof(ostream)); |
||||
pb_encode(&ostream, grpc_health_v1_HealthCheckRequest_fields, |
||||
&request_struct); |
||||
grpc_slice request_slice = GRPC_SLICE_MALLOC(ostream.bytes_written); |
||||
ostream = pb_ostream_from_buffer(GRPC_SLICE_START_PTR(request_slice), |
||||
GRPC_SLICE_LENGTH(request_slice)); |
||||
GPR_ASSERT(pb_encode(&ostream, grpc_health_v1_HealthCheckRequest_fields, |
||||
&request_struct) != 0); |
||||
grpc_slice_buffer slice_buffer; |
||||
grpc_slice_buffer_init(&slice_buffer); |
||||
grpc_slice_buffer_add(&slice_buffer, request_slice); |
||||
send_message->Init(&slice_buffer, 0); |
||||
grpc_slice_buffer_destroy_internal(&slice_buffer); |
||||
} |
||||
|
||||
// Returns true if healthy.
|
||||
// If there was an error parsing the response, sets *error and returns false.
|
||||
bool DecodeResponse(grpc_slice_buffer* slice_buffer, grpc_error** error) { |
||||
// If message is empty, assume unhealthy.
|
||||
if (slice_buffer->length == 0) { |
||||
*error = |
||||
GRPC_ERROR_CREATE_FROM_STATIC_STRING("health check response was empty"); |
||||
return false; |
||||
} |
||||
// Concatenate the slices to form a single string.
|
||||
UniquePtr<uint8_t> recv_message_deleter; |
||||
uint8_t* recv_message; |
||||
if (slice_buffer->count == 1) { |
||||
recv_message = GRPC_SLICE_START_PTR(slice_buffer->slices[0]); |
||||
} else { |
||||
recv_message = static_cast<uint8_t*>(gpr_malloc(slice_buffer->length)); |
||||
recv_message_deleter.reset(recv_message); |
||||
size_t offset = 0; |
||||
for (size_t i = 0; i < slice_buffer->count; ++i) { |
||||
memcpy(recv_message + offset, |
||||
GRPC_SLICE_START_PTR(slice_buffer->slices[i]), |
||||
GRPC_SLICE_LENGTH(slice_buffer->slices[i])); |
||||
offset += GRPC_SLICE_LENGTH(slice_buffer->slices[i]); |
||||
} |
||||
} |
||||
// Deserialize message.
|
||||
grpc_health_v1_HealthCheckResponse response_struct; |
||||
pb_istream_t istream = |
||||
pb_istream_from_buffer(recv_message, slice_buffer->length); |
||||
if (!pb_decode(&istream, grpc_health_v1_HealthCheckResponse_fields, |
||||
&response_struct)) { |
||||
// Can't parse message; assume unhealthy.
|
||||
*error = GRPC_ERROR_CREATE_FROM_STATIC_STRING( |
||||
"cannot parse health check response"); |
||||
return false; |
||||
} |
||||
if (!response_struct.has_status) { |
||||
// Field not present; assume unhealthy.
|
||||
*error = GRPC_ERROR_CREATE_FROM_STATIC_STRING( |
||||
"status field not present in health check response"); |
||||
return false; |
||||
} |
||||
return response_struct.status == |
||||
grpc_health_v1_HealthCheckResponse_ServingStatus_SERVING; |
||||
} |
||||
|
||||
} // namespace
|
||||
|
||||
//
|
||||
// HealthCheckClient::CallState
|
||||
//
|
||||
|
||||
HealthCheckClient::CallState::CallState( |
||||
RefCountedPtr<HealthCheckClient> health_check_client, |
||||
grpc_pollset_set* interested_parties) |
||||
: InternallyRefCountedWithTracing<CallState>( |
||||
&grpc_health_check_client_trace), |
||||
health_check_client_(std::move(health_check_client)), |
||||
pollent_(grpc_polling_entity_create_from_pollset_set(interested_parties)), |
||||
arena_(gpr_arena_create(health_check_client_->connected_subchannel_ |
||||
->GetInitialCallSizeEstimate(0))) { |
||||
memset(&call_combiner_, 0, sizeof(call_combiner_)); |
||||
grpc_call_combiner_init(&call_combiner_); |
||||
memset(context_, 0, sizeof(context_)); |
||||
gpr_atm_rel_store(&seen_response_, static_cast<gpr_atm>(0)); |
||||
} |
||||
|
||||
HealthCheckClient::CallState::~CallState() { |
||||
if (grpc_health_check_client_trace.enabled()) { |
||||
gpr_log(GPR_INFO, "HealthCheckClient %p: destroying CallState %p", |
||||
health_check_client_.get(), this); |
||||
} |
||||
if (call_ != nullptr) GRPC_SUBCHANNEL_CALL_UNREF(call_, "call_ended"); |
||||
// Unset the call combiner cancellation closure. This has the
|
||||
// effect of scheduling the previously set cancellation closure, if
|
||||
// any, so that it can release any internal references it may be
|
||||
// holding to the call stack. Also flush the closures on exec_ctx so that
|
||||
// filters that schedule cancel notification closures on exec_ctx do not
|
||||
// need to take a ref of the call stack to guarantee closure liveness.
|
||||
grpc_call_combiner_set_notify_on_cancel(&call_combiner_, nullptr); |
||||
grpc_core::ExecCtx::Get()->Flush(); |
||||
grpc_call_combiner_destroy(&call_combiner_); |
||||
gpr_arena_destroy(arena_); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::Orphan() { |
||||
grpc_call_combiner_cancel(&call_combiner_, GRPC_ERROR_CANCELLED); |
||||
Cancel(); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::StartCall() { |
||||
ConnectedSubchannel::CallArgs args = { |
||||
&pollent_, |
||||
GRPC_MDSTR_SLASH_GRPC_DOT_HEALTH_DOT_V1_DOT_HEALTH_SLASH_WATCH, |
||||
gpr_now(GPR_CLOCK_MONOTONIC), // start_time
|
||||
GRPC_MILLIS_INF_FUTURE, // deadline
|
||||
arena_, |
||||
context_, |
||||
&call_combiner_, |
||||
0, // parent_data_size
|
||||
}; |
||||
grpc_error* error = |
||||
health_check_client_->connected_subchannel_->CreateCall(args, &call_); |
||||
if (error != GRPC_ERROR_NONE) { |
||||
gpr_log(GPR_ERROR, |
||||
"HealthCheckClient %p CallState %p: error creating health " |
||||
"checking call on subchannel (%s); will retry", |
||||
health_check_client_.get(), this, grpc_error_string(error)); |
||||
GRPC_ERROR_UNREF(error); |
||||
// Schedule instead of running directly, since we must not be
|
||||
// holding health_check_client_->mu_ when CallEnded() is called.
|
||||
Ref(DEBUG_LOCATION, "call_end_closure").release(); |
||||
GRPC_CLOSURE_SCHED( |
||||
GRPC_CLOSURE_INIT(&batch_.handler_private.closure, CallEndedRetry, this, |
||||
grpc_schedule_on_exec_ctx), |
||||
GRPC_ERROR_NONE); |
||||
return; |
||||
} |
||||
// Initialize payload and batch.
|
||||
memset(&batch_, 0, sizeof(batch_)); |
||||
batch_.payload = &payload_; |
||||
// on_complete callback takes ref, handled manually.
|
||||
Ref(DEBUG_LOCATION, "on_complete").release(); |
||||
batch_.on_complete = GRPC_CLOSURE_INIT(&on_complete_, OnComplete, this, |
||||
grpc_schedule_on_exec_ctx); |
||||
// Add send_initial_metadata op.
|
||||
grpc_metadata_batch_init(&send_initial_metadata_); |
||||
error = grpc_metadata_batch_add_head( |
||||
&send_initial_metadata_, &path_metadata_storage_, |
||||
grpc_mdelem_from_slices( |
||||
GRPC_MDSTR_PATH, |
||||
GRPC_MDSTR_SLASH_GRPC_DOT_HEALTH_DOT_V1_DOT_HEALTH_SLASH_WATCH)); |
||||
GPR_ASSERT(error == GRPC_ERROR_NONE); |
||||
payload_.send_initial_metadata.send_initial_metadata = |
||||
&send_initial_metadata_; |
||||
payload_.send_initial_metadata.send_initial_metadata_flags = 0; |
||||
payload_.send_initial_metadata.peer_string = nullptr; |
||||
batch_.send_initial_metadata = true; |
||||
// Add send_message op.
|
||||
EncodeRequest(health_check_client_->service_name_, &send_message_); |
||||
payload_.send_message.send_message.reset(send_message_.get()); |
||||
batch_.send_message = true; |
||||
// Add send_trailing_metadata op.
|
||||
grpc_metadata_batch_init(&send_trailing_metadata_); |
||||
payload_.send_trailing_metadata.send_trailing_metadata = |
||||
&send_trailing_metadata_; |
||||
batch_.send_trailing_metadata = true; |
||||
// Add recv_initial_metadata op.
|
||||
grpc_metadata_batch_init(&recv_initial_metadata_); |
||||
payload_.recv_initial_metadata.recv_initial_metadata = |
||||
&recv_initial_metadata_; |
||||
payload_.recv_initial_metadata.recv_flags = nullptr; |
||||
payload_.recv_initial_metadata.trailing_metadata_available = nullptr; |
||||
payload_.recv_initial_metadata.peer_string = nullptr; |
||||
// recv_initial_metadata_ready callback takes ref, handled manually.
|
||||
Ref(DEBUG_LOCATION, "recv_initial_metadata_ready").release(); |
||||
payload_.recv_initial_metadata.recv_initial_metadata_ready = |
||||
GRPC_CLOSURE_INIT(&recv_initial_metadata_ready_, RecvInitialMetadataReady, |
||||
this, grpc_schedule_on_exec_ctx); |
||||
batch_.recv_initial_metadata = true; |
||||
// Add recv_message op.
|
||||
payload_.recv_message.recv_message = &recv_message_; |
||||
// recv_message callback takes ref, handled manually.
|
||||
Ref(DEBUG_LOCATION, "recv_message_ready").release(); |
||||
payload_.recv_message.recv_message_ready = GRPC_CLOSURE_INIT( |
||||
&recv_message_ready_, RecvMessageReady, this, grpc_schedule_on_exec_ctx); |
||||
batch_.recv_message = true; |
||||
// Start batch.
|
||||
StartBatch(&batch_); |
||||
// Initialize recv_trailing_metadata batch.
|
||||
memset(&recv_trailing_metadata_batch_, 0, |
||||
sizeof(recv_trailing_metadata_batch_)); |
||||
recv_trailing_metadata_batch_.payload = &payload_; |
||||
// Add recv_trailing_metadata op.
|
||||
grpc_metadata_batch_init(&recv_trailing_metadata_); |
||||
payload_.recv_trailing_metadata.recv_trailing_metadata = |
||||
&recv_trailing_metadata_; |
||||
payload_.recv_trailing_metadata.collect_stats = &collect_stats_; |
||||
// This callback signals the end of the call, so it relies on the
|
||||
// initial ref instead of taking a new ref. When it's invoked, the
|
||||
// initial ref is released.
|
||||
payload_.recv_trailing_metadata.recv_trailing_metadata_ready = |
||||
GRPC_CLOSURE_INIT(&recv_trailing_metadata_ready_, |
||||
RecvTrailingMetadataReady, this, |
||||
grpc_schedule_on_exec_ctx); |
||||
recv_trailing_metadata_batch_.recv_trailing_metadata = true; |
||||
// Start recv_trailing_metadata batch.
|
||||
StartBatch(&recv_trailing_metadata_batch_); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::StartBatchInCallCombiner(void* arg, |
||||
grpc_error* error) { |
||||
grpc_transport_stream_op_batch* batch = |
||||
static_cast<grpc_transport_stream_op_batch*>(arg); |
||||
grpc_subchannel_call* call = |
||||
static_cast<grpc_subchannel_call*>(batch->handler_private.extra_arg); |
||||
grpc_subchannel_call_process_op(call, batch); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::StartBatch( |
||||
grpc_transport_stream_op_batch* batch) { |
||||
batch->handler_private.extra_arg = call_; |
||||
GRPC_CLOSURE_INIT(&batch->handler_private.closure, StartBatchInCallCombiner, |
||||
batch, grpc_schedule_on_exec_ctx); |
||||
GRPC_CALL_COMBINER_START(&call_combiner_, &batch->handler_private.closure, |
||||
GRPC_ERROR_NONE, "start_subchannel_batch"); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::OnCancelComplete(void* arg, |
||||
grpc_error* error) { |
||||
HealthCheckClient::CallState* self = |
||||
static_cast<HealthCheckClient::CallState*>(arg); |
||||
GRPC_CALL_COMBINER_STOP(&self->call_combiner_, "health_cancel"); |
||||
self->Unref(DEBUG_LOCATION, "cancel"); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::StartCancel(void* arg, grpc_error* error) { |
||||
HealthCheckClient::CallState* self = |
||||
static_cast<HealthCheckClient::CallState*>(arg); |
||||
auto* batch = grpc_make_transport_stream_op( |
||||
GRPC_CLOSURE_CREATE(OnCancelComplete, self, grpc_schedule_on_exec_ctx)); |
||||
batch->cancel_stream = true; |
||||
batch->payload->cancel_stream.cancel_error = GRPC_ERROR_CANCELLED; |
||||
grpc_subchannel_call_process_op(self->call_, batch); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::Cancel() { |
||||
if (call_ != nullptr) { |
||||
Ref(DEBUG_LOCATION, "cancel").release(); |
||||
GRPC_CALL_COMBINER_START( |
||||
&call_combiner_, |
||||
GRPC_CLOSURE_CREATE(StartCancel, this, grpc_schedule_on_exec_ctx), |
||||
GRPC_ERROR_NONE, "health_cancel"); |
||||
} |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::OnComplete(void* arg, grpc_error* error) { |
||||
HealthCheckClient::CallState* self = |
||||
static_cast<HealthCheckClient::CallState*>(arg); |
||||
GRPC_CALL_COMBINER_STOP(&self->call_combiner_, "on_complete"); |
||||
grpc_metadata_batch_destroy(&self->send_initial_metadata_); |
||||
grpc_metadata_batch_destroy(&self->send_trailing_metadata_); |
||||
self->Unref(DEBUG_LOCATION, "on_complete"); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::RecvInitialMetadataReady(void* arg, |
||||
grpc_error* error) { |
||||
HealthCheckClient::CallState* self = |
||||
static_cast<HealthCheckClient::CallState*>(arg); |
||||
GRPC_CALL_COMBINER_STOP(&self->call_combiner_, "recv_initial_metadata_ready"); |
||||
grpc_metadata_batch_destroy(&self->recv_initial_metadata_); |
||||
self->Unref(DEBUG_LOCATION, "recv_initial_metadata_ready"); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::DoneReadingRecvMessage(grpc_error* error) { |
||||
recv_message_.reset(); |
||||
if (error != GRPC_ERROR_NONE) { |
||||
GRPC_ERROR_UNREF(error); |
||||
Cancel(); |
||||
grpc_slice_buffer_destroy_internal(&recv_message_buffer_); |
||||
Unref(DEBUG_LOCATION, "recv_message_ready"); |
||||
return; |
||||
} |
||||
const bool healthy = DecodeResponse(&recv_message_buffer_, &error); |
||||
const grpc_connectivity_state state = |
||||
healthy ? GRPC_CHANNEL_READY : GRPC_CHANNEL_TRANSIENT_FAILURE; |
||||
if (error == GRPC_ERROR_NONE && !healthy) { |
||||
error = GRPC_ERROR_CREATE_FROM_STATIC_STRING("backend unhealthy"); |
||||
} |
||||
health_check_client_->SetHealthStatus(state, error); |
||||
gpr_atm_rel_store(&seen_response_, static_cast<gpr_atm>(1)); |
||||
grpc_slice_buffer_destroy_internal(&recv_message_buffer_); |
||||
// Start another recv_message batch.
|
||||
// This re-uses the ref we're holding.
|
||||
// Note: Can't just reuse batch_ here, since we don't know that all
|
||||
// callbacks from the original batch have completed yet.
|
||||
memset(&recv_message_batch_, 0, sizeof(recv_message_batch_)); |
||||
recv_message_batch_.payload = &payload_; |
||||
payload_.recv_message.recv_message = &recv_message_; |
||||
payload_.recv_message.recv_message_ready = GRPC_CLOSURE_INIT( |
||||
&recv_message_ready_, RecvMessageReady, this, grpc_schedule_on_exec_ctx); |
||||
recv_message_batch_.recv_message = true; |
||||
StartBatch(&recv_message_batch_); |
||||
} |
||||
|
||||
grpc_error* HealthCheckClient::CallState::PullSliceFromRecvMessage() { |
||||
grpc_slice slice; |
||||
grpc_error* error = recv_message_->Pull(&slice); |
||||
if (error == GRPC_ERROR_NONE) { |
||||
grpc_slice_buffer_add(&recv_message_buffer_, slice); |
||||
} |
||||
return error; |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::ContinueReadingRecvMessage() { |
||||
while (recv_message_->Next(SIZE_MAX, &recv_message_ready_)) { |
||||
grpc_error* error = PullSliceFromRecvMessage(); |
||||
if (error != GRPC_ERROR_NONE) { |
||||
DoneReadingRecvMessage(error); |
||||
return; |
||||
} |
||||
if (recv_message_buffer_.length == recv_message_->length()) { |
||||
DoneReadingRecvMessage(GRPC_ERROR_NONE); |
||||
break; |
||||
} |
||||
} |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::OnByteStreamNext(void* arg, |
||||
grpc_error* error) { |
||||
HealthCheckClient::CallState* self = |
||||
static_cast<HealthCheckClient::CallState*>(arg); |
||||
if (error != GRPC_ERROR_NONE) { |
||||
self->DoneReadingRecvMessage(GRPC_ERROR_REF(error)); |
||||
return; |
||||
} |
||||
error = self->PullSliceFromRecvMessage(); |
||||
if (error != GRPC_ERROR_NONE) { |
||||
self->DoneReadingRecvMessage(error); |
||||
return; |
||||
} |
||||
if (self->recv_message_buffer_.length == self->recv_message_->length()) { |
||||
self->DoneReadingRecvMessage(GRPC_ERROR_NONE); |
||||
} else { |
||||
self->ContinueReadingRecvMessage(); |
||||
} |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::RecvMessageReady(void* arg, |
||||
grpc_error* error) { |
||||
HealthCheckClient::CallState* self = |
||||
static_cast<HealthCheckClient::CallState*>(arg); |
||||
GRPC_CALL_COMBINER_STOP(&self->call_combiner_, "recv_message_ready"); |
||||
if (self->recv_message_ == nullptr) { |
||||
self->Unref(DEBUG_LOCATION, "recv_message_ready"); |
||||
return; |
||||
} |
||||
grpc_slice_buffer_init(&self->recv_message_buffer_); |
||||
GRPC_CLOSURE_INIT(&self->recv_message_ready_, OnByteStreamNext, self, |
||||
grpc_schedule_on_exec_ctx); |
||||
self->ContinueReadingRecvMessage(); |
||||
// Ref will continue to be held until we finish draining the byte stream.
|
||||
} |
||||
|
||||
void HealthCheckClient::CallState::RecvTrailingMetadataReady( |
||||
void* arg, grpc_error* error) { |
||||
HealthCheckClient::CallState* self = |
||||
static_cast<HealthCheckClient::CallState*>(arg); |
||||
GRPC_CALL_COMBINER_STOP(&self->call_combiner_, |
||||
"recv_trailing_metadata_ready"); |
||||
// Get call status.
|
||||
grpc_status_code status = GRPC_STATUS_UNKNOWN; |
||||
if (error != GRPC_ERROR_NONE) { |
||||
grpc_error_get_status(error, GRPC_MILLIS_INF_FUTURE, &status, |
||||
nullptr /* slice */, nullptr /* http_error */, |
||||
nullptr /* error_string */); |
||||
} else if (self->recv_trailing_metadata_.idx.named.grpc_status != nullptr) { |
||||
status = grpc_get_status_code_from_metadata( |
||||
self->recv_trailing_metadata_.idx.named.grpc_status->md); |
||||
} |
||||
if (grpc_health_check_client_trace.enabled()) { |
||||
gpr_log(GPR_INFO, |
||||
"HealthCheckClient %p CallState %p: health watch failed with " |
||||
"status %d", |
||||
self->health_check_client_.get(), self, status); |
||||
} |
||||
// Clean up.
|
||||
grpc_metadata_batch_destroy(&self->recv_trailing_metadata_); |
||||
// For status UNIMPLEMENTED, give up and assume always healthy.
|
||||
bool retry = true; |
||||
if (status == GRPC_STATUS_UNIMPLEMENTED) { |
||||
static const char kErrorMessage[] = |
||||
"health checking Watch method returned UNIMPLEMENTED; " |
||||
"disabling health checks but assuming server is healthy"; |
||||
gpr_log(GPR_ERROR, kErrorMessage); |
||||
if (self->health_check_client_->channelz_node_ != nullptr) { |
||||
self->health_check_client_->channelz_node_->AddTraceEvent( |
||||
channelz::ChannelTrace::Error, |
||||
grpc_slice_from_static_string(kErrorMessage)); |
||||
} |
||||
self->health_check_client_->SetHealthStatus(GRPC_CHANNEL_READY, |
||||
GRPC_ERROR_NONE); |
||||
retry = false; |
||||
} |
||||
self->CallEnded(retry); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::CallEndedRetry(void* arg, |
||||
grpc_error* error) { |
||||
HealthCheckClient::CallState* self = |
||||
static_cast<HealthCheckClient::CallState*>(arg); |
||||
self->CallEnded(true /* retry */); |
||||
self->Unref(DEBUG_LOCATION, "call_end_closure"); |
||||
} |
||||
|
||||
void HealthCheckClient::CallState::CallEnded(bool retry) { |
||||
// If this CallState is still in use, this call ended because of a failure,
|
||||
// so we need to stop using it and optionally create a new one.
|
||||
// Otherwise, we have deliberately ended this call, and no further action
|
||||
// is required.
|
||||
if (this == health_check_client_->call_state_.get()) { |
||||
health_check_client_->call_state_.reset(); |
||||
if (retry) { |
||||
GPR_ASSERT(!health_check_client_->shutting_down_); |
||||
if (static_cast<bool>(gpr_atm_acq_load(&seen_response_))) { |
||||
// If the call fails after we've gotten a successful response, reset
|
||||
// the backoff and restart the call immediately.
|
||||
health_check_client_->retry_backoff_.Reset(); |
||||
health_check_client_->StartCall(); |
||||
} else { |
||||
// If the call failed without receiving any messages, retry later.
|
||||
health_check_client_->StartRetryTimer(); |
||||
} |
||||
} |
||||
} |
||||
Unref(DEBUG_LOCATION, "call_ended"); |
||||
} |
||||
|
||||
} // namespace grpc_core
|
||||
@ -0,0 +1,173 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 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. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_CORE_EXT_FILTERS_CLIENT_CHANNEL_HEALTH_HEALTH_CHECK_CLIENT_H |
||||
#define GRPC_CORE_EXT_FILTERS_CLIENT_CHANNEL_HEALTH_HEALTH_CHECK_CLIENT_H |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include <grpc/grpc.h> |
||||
#include <grpc/support/atm.h> |
||||
#include <grpc/support/sync.h> |
||||
|
||||
#include "src/core/ext/filters/client_channel/client_channel_channelz.h" |
||||
#include "src/core/ext/filters/client_channel/subchannel.h" |
||||
#include "src/core/lib/backoff/backoff.h" |
||||
#include "src/core/lib/gpr/arena.h" |
||||
#include "src/core/lib/gprpp/orphanable.h" |
||||
#include "src/core/lib/gprpp/ref_counted_ptr.h" |
||||
#include "src/core/lib/iomgr/call_combiner.h" |
||||
#include "src/core/lib/iomgr/closure.h" |
||||
#include "src/core/lib/iomgr/polling_entity.h" |
||||
#include "src/core/lib/iomgr/timer.h" |
||||
#include "src/core/lib/transport/byte_stream.h" |
||||
#include "src/core/lib/transport/metadata_batch.h" |
||||
#include "src/core/lib/transport/transport.h" |
||||
|
||||
namespace grpc_core { |
||||
|
||||
class HealthCheckClient |
||||
: public InternallyRefCountedWithTracing<HealthCheckClient> { |
||||
public: |
||||
HealthCheckClient(const char* service_name, |
||||
RefCountedPtr<ConnectedSubchannel> connected_subchannel, |
||||
grpc_pollset_set* interested_parties, |
||||
RefCountedPtr<channelz::SubchannelNode> channelz_node); |
||||
|
||||
~HealthCheckClient(); |
||||
|
||||
// When the health state changes from *state, sets *state to the new
|
||||
// value and schedules closure.
|
||||
// Only one closure can be outstanding at a time.
|
||||
void NotifyOnHealthChange(grpc_connectivity_state* state, |
||||
grpc_closure* closure); |
||||
|
||||
void Orphan() override; |
||||
|
||||
private: |
||||
// Contains a call to the backend and all the data related to the call.
|
||||
class CallState : public InternallyRefCountedWithTracing<CallState> { |
||||
public: |
||||
CallState(RefCountedPtr<HealthCheckClient> health_check_client, |
||||
grpc_pollset_set* interested_parties_); |
||||
~CallState(); |
||||
|
||||
void Orphan() override; |
||||
|
||||
void StartCall(); |
||||
|
||||
private: |
||||
void Cancel(); |
||||
|
||||
void StartBatch(grpc_transport_stream_op_batch* batch); |
||||
static void StartBatchInCallCombiner(void* arg, grpc_error* error); |
||||
|
||||
static void CallEndedRetry(void* arg, grpc_error* error); |
||||
void CallEnded(bool retry); |
||||
|
||||
static void OnComplete(void* arg, grpc_error* error); |
||||
static void RecvInitialMetadataReady(void* arg, grpc_error* error); |
||||
static void RecvMessageReady(void* arg, grpc_error* error); |
||||
static void RecvTrailingMetadataReady(void* arg, grpc_error* error); |
||||
static void StartCancel(void* arg, grpc_error* error); |
||||
static void OnCancelComplete(void* arg, grpc_error* error); |
||||
|
||||
static void OnByteStreamNext(void* arg, grpc_error* error); |
||||
void ContinueReadingRecvMessage(); |
||||
grpc_error* PullSliceFromRecvMessage(); |
||||
void DoneReadingRecvMessage(grpc_error* error); |
||||
|
||||
RefCountedPtr<HealthCheckClient> health_check_client_; |
||||
grpc_polling_entity pollent_; |
||||
|
||||
gpr_arena* arena_; |
||||
grpc_call_combiner call_combiner_; |
||||
grpc_call_context_element context_[GRPC_CONTEXT_COUNT]; |
||||
|
||||
// The streaming call to the backend. Always non-NULL.
|
||||
grpc_subchannel_call* call_; |
||||
|
||||
grpc_transport_stream_op_batch_payload payload_; |
||||
grpc_transport_stream_op_batch batch_; |
||||
grpc_transport_stream_op_batch recv_message_batch_; |
||||
grpc_transport_stream_op_batch recv_trailing_metadata_batch_; |
||||
|
||||
grpc_closure on_complete_; |
||||
|
||||
// send_initial_metadata
|
||||
grpc_metadata_batch send_initial_metadata_; |
||||
grpc_linked_mdelem path_metadata_storage_; |
||||
|
||||
// send_message
|
||||
ManualConstructor<SliceBufferByteStream> send_message_; |
||||
|
||||
// send_trailing_metadata
|
||||
grpc_metadata_batch send_trailing_metadata_; |
||||
|
||||
// recv_initial_metadata
|
||||
grpc_metadata_batch recv_initial_metadata_; |
||||
grpc_closure recv_initial_metadata_ready_; |
||||
|
||||
// recv_message
|
||||
OrphanablePtr<ByteStream> recv_message_; |
||||
grpc_closure recv_message_ready_; |
||||
grpc_slice_buffer recv_message_buffer_; |
||||
gpr_atm seen_response_; |
||||
|
||||
// recv_trailing_metadata
|
||||
grpc_metadata_batch recv_trailing_metadata_; |
||||
grpc_transport_stream_stats collect_stats_; |
||||
grpc_closure recv_trailing_metadata_ready_; |
||||
}; |
||||
|
||||
void StartCall(); |
||||
void StartCallLocked(); // Requires holding mu_.
|
||||
|
||||
void StartRetryTimer(); |
||||
static void OnRetryTimer(void* arg, grpc_error* error); |
||||
|
||||
void SetHealthStatus(grpc_connectivity_state state, grpc_error* error); |
||||
void SetHealthStatusLocked(grpc_connectivity_state state, |
||||
grpc_error* error); // Requires holding mu_.
|
||||
|
||||
const char* service_name_; // Do not own.
|
||||
RefCountedPtr<ConnectedSubchannel> connected_subchannel_; |
||||
grpc_pollset_set* interested_parties_; // Do not own.
|
||||
RefCountedPtr<channelz::SubchannelNode> channelz_node_; |
||||
|
||||
gpr_mu mu_; |
||||
grpc_connectivity_state state_ = GRPC_CHANNEL_CONNECTING; |
||||
grpc_error* error_ = GRPC_ERROR_NONE; |
||||
grpc_connectivity_state* notify_state_ = nullptr; |
||||
grpc_closure* on_health_changed_ = nullptr; |
||||
bool shutting_down_ = false; |
||||
|
||||
// The data associated with the current health check call. It holds a ref
|
||||
// to this HealthCheckClient object.
|
||||
OrphanablePtr<CallState> call_state_; |
||||
|
||||
// Call retry state.
|
||||
BackOff retry_backoff_; |
||||
grpc_timer retry_timer_; |
||||
grpc_closure retry_timer_callback_; |
||||
bool retry_timer_callback_pending_ = false; |
||||
}; |
||||
|
||||
} // namespace grpc_core
|
||||
|
||||
#endif /* GRPC_CORE_EXT_FILTERS_CLIENT_CHANNEL_HEALTH_HEALTH_CHECK_CLIENT_H */ |
||||
@ -0,0 +1,310 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 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 <grpc/support/port_platform.h> |
||||
|
||||
#include "src/core/lib/security/security_connector/fake/fake_security_connector.h" |
||||
|
||||
#include <stdbool.h> |
||||
|
||||
#include <grpc/support/alloc.h> |
||||
#include <grpc/support/log.h> |
||||
#include <grpc/support/string_util.h> |
||||
|
||||
#include "src/core/ext/transport/chttp2/alpn/alpn.h" |
||||
#include "src/core/lib/channel/channel_args.h" |
||||
#include "src/core/lib/channel/handshaker.h" |
||||
#include "src/core/lib/gpr/host_port.h" |
||||
#include "src/core/lib/gpr/string.h" |
||||
#include "src/core/lib/security/context/security_context.h" |
||||
#include "src/core/lib/security/credentials/credentials.h" |
||||
#include "src/core/lib/security/credentials/fake/fake_credentials.h" |
||||
#include "src/core/lib/security/transport/security_handshaker.h" |
||||
#include "src/core/lib/security/transport/target_authority_table.h" |
||||
#include "src/core/tsi/fake_transport_security.h" |
||||
|
||||
typedef struct { |
||||
grpc_channel_security_connector base; |
||||
char* target; |
||||
char* expected_targets; |
||||
bool is_lb_channel; |
||||
char* target_name_override; |
||||
} grpc_fake_channel_security_connector; |
||||
|
||||
static void fake_channel_destroy(grpc_security_connector* sc) { |
||||
grpc_fake_channel_security_connector* c = |
||||
reinterpret_cast<grpc_fake_channel_security_connector*>(sc); |
||||
grpc_call_credentials_unref(c->base.request_metadata_creds); |
||||
gpr_free(c->target); |
||||
gpr_free(c->expected_targets); |
||||
gpr_free(c->target_name_override); |
||||
gpr_free(c); |
||||
} |
||||
|
||||
static void fake_server_destroy(grpc_security_connector* sc) { gpr_free(sc); } |
||||
|
||||
static bool fake_check_target(const char* target_type, const char* target, |
||||
const char* set_str) { |
||||
GPR_ASSERT(target_type != nullptr); |
||||
GPR_ASSERT(target != nullptr); |
||||
char** set = nullptr; |
||||
size_t set_size = 0; |
||||
gpr_string_split(set_str, ",", &set, &set_size); |
||||
bool found = false; |
||||
for (size_t i = 0; i < set_size; ++i) { |
||||
if (set[i] != nullptr && strcmp(target, set[i]) == 0) found = true; |
||||
} |
||||
for (size_t i = 0; i < set_size; ++i) { |
||||
gpr_free(set[i]); |
||||
} |
||||
gpr_free(set); |
||||
return found; |
||||
} |
||||
|
||||
static void fake_secure_name_check(const char* target, |
||||
const char* expected_targets, |
||||
bool is_lb_channel) { |
||||
if (expected_targets == nullptr) return; |
||||
char** lbs_and_backends = nullptr; |
||||
size_t lbs_and_backends_size = 0; |
||||
bool success = false; |
||||
gpr_string_split(expected_targets, ";", &lbs_and_backends, |
||||
&lbs_and_backends_size); |
||||
if (lbs_and_backends_size > 2 || lbs_and_backends_size == 0) { |
||||
gpr_log(GPR_ERROR, "Invalid expected targets arg value: '%s'", |
||||
expected_targets); |
||||
goto done; |
||||
} |
||||
if (is_lb_channel) { |
||||
if (lbs_and_backends_size != 2) { |
||||
gpr_log(GPR_ERROR, |
||||
"Invalid expected targets arg value: '%s'. Expectations for LB " |
||||
"channels must be of the form 'be1,be2,be3,...;lb1,lb2,...", |
||||
expected_targets); |
||||
goto done; |
||||
} |
||||
if (!fake_check_target("LB", target, lbs_and_backends[1])) { |
||||
gpr_log(GPR_ERROR, "LB target '%s' not found in expected set '%s'", |
||||
target, lbs_and_backends[1]); |
||||
goto done; |
||||
} |
||||
success = true; |
||||
} else { |
||||
if (!fake_check_target("Backend", target, lbs_and_backends[0])) { |
||||
gpr_log(GPR_ERROR, "Backend target '%s' not found in expected set '%s'", |
||||
target, lbs_and_backends[0]); |
||||
goto done; |
||||
} |
||||
success = true; |
||||
} |
||||
done: |
||||
for (size_t i = 0; i < lbs_and_backends_size; ++i) { |
||||
gpr_free(lbs_and_backends[i]); |
||||
} |
||||
gpr_free(lbs_and_backends); |
||||
if (!success) abort(); |
||||
} |
||||
|
||||
static void fake_check_peer(grpc_security_connector* sc, tsi_peer peer, |
||||
grpc_auth_context** auth_context, |
||||
grpc_closure* on_peer_checked) { |
||||
const char* prop_name; |
||||
grpc_error* error = GRPC_ERROR_NONE; |
||||
*auth_context = nullptr; |
||||
if (peer.property_count != 1) { |
||||
error = GRPC_ERROR_CREATE_FROM_STATIC_STRING( |
||||
"Fake peers should only have 1 property."); |
||||
goto end; |
||||
} |
||||
prop_name = peer.properties[0].name; |
||||
if (prop_name == nullptr || |
||||
strcmp(prop_name, TSI_CERTIFICATE_TYPE_PEER_PROPERTY)) { |
||||
char* msg; |
||||
gpr_asprintf(&msg, "Unexpected property in fake peer: %s.", |
||||
prop_name == nullptr ? "<EMPTY>" : prop_name); |
||||
error = GRPC_ERROR_CREATE_FROM_COPIED_STRING(msg); |
||||
gpr_free(msg); |
||||
goto end; |
||||
} |
||||
if (strncmp(peer.properties[0].value.data, TSI_FAKE_CERTIFICATE_TYPE, |
||||
peer.properties[0].value.length)) { |
||||
error = GRPC_ERROR_CREATE_FROM_STATIC_STRING( |
||||
"Invalid value for cert type property."); |
||||
goto end; |
||||
} |
||||
*auth_context = grpc_auth_context_create(nullptr); |
||||
grpc_auth_context_add_cstring_property( |
||||
*auth_context, GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME, |
||||
GRPC_FAKE_TRANSPORT_SECURITY_TYPE); |
||||
end: |
||||
GRPC_CLOSURE_SCHED(on_peer_checked, error); |
||||
tsi_peer_destruct(&peer); |
||||
} |
||||
|
||||
static void fake_channel_check_peer(grpc_security_connector* sc, tsi_peer peer, |
||||
grpc_auth_context** auth_context, |
||||
grpc_closure* on_peer_checked) { |
||||
fake_check_peer(sc, peer, auth_context, on_peer_checked); |
||||
grpc_fake_channel_security_connector* c = |
||||
reinterpret_cast<grpc_fake_channel_security_connector*>(sc); |
||||
fake_secure_name_check(c->target, c->expected_targets, c->is_lb_channel); |
||||
} |
||||
|
||||
static void fake_server_check_peer(grpc_security_connector* sc, tsi_peer peer, |
||||
grpc_auth_context** auth_context, |
||||
grpc_closure* on_peer_checked) { |
||||
fake_check_peer(sc, peer, auth_context, on_peer_checked); |
||||
} |
||||
|
||||
static int fake_channel_cmp(grpc_security_connector* sc1, |
||||
grpc_security_connector* sc2) { |
||||
grpc_fake_channel_security_connector* c1 = |
||||
reinterpret_cast<grpc_fake_channel_security_connector*>(sc1); |
||||
grpc_fake_channel_security_connector* c2 = |
||||
reinterpret_cast<grpc_fake_channel_security_connector*>(sc2); |
||||
int c = grpc_channel_security_connector_cmp(&c1->base, &c2->base); |
||||
if (c != 0) return c; |
||||
c = strcmp(c1->target, c2->target); |
||||
if (c != 0) return c; |
||||
if (c1->expected_targets == nullptr || c2->expected_targets == nullptr) { |
||||
c = GPR_ICMP(c1->expected_targets, c2->expected_targets); |
||||
} else { |
||||
c = strcmp(c1->expected_targets, c2->expected_targets); |
||||
} |
||||
if (c != 0) return c; |
||||
return GPR_ICMP(c1->is_lb_channel, c2->is_lb_channel); |
||||
} |
||||
|
||||
static int fake_server_cmp(grpc_security_connector* sc1, |
||||
grpc_security_connector* sc2) { |
||||
return grpc_server_security_connector_cmp( |
||||
reinterpret_cast<grpc_server_security_connector*>(sc1), |
||||
reinterpret_cast<grpc_server_security_connector*>(sc2)); |
||||
} |
||||
|
||||
static bool fake_channel_check_call_host(grpc_channel_security_connector* sc, |
||||
const char* host, |
||||
grpc_auth_context* auth_context, |
||||
grpc_closure* on_call_host_checked, |
||||
grpc_error** error) { |
||||
grpc_fake_channel_security_connector* c = |
||||
reinterpret_cast<grpc_fake_channel_security_connector*>(sc); |
||||
char* authority_hostname = nullptr; |
||||
char* authority_ignored_port = nullptr; |
||||
char* target_hostname = nullptr; |
||||
char* target_ignored_port = nullptr; |
||||
gpr_split_host_port(host, &authority_hostname, &authority_ignored_port); |
||||
gpr_split_host_port(c->target, &target_hostname, &target_ignored_port); |
||||
if (c->target_name_override != nullptr) { |
||||
char* fake_security_target_name_override_hostname = nullptr; |
||||
char* fake_security_target_name_override_ignored_port = nullptr; |
||||
gpr_split_host_port(c->target_name_override, |
||||
&fake_security_target_name_override_hostname, |
||||
&fake_security_target_name_override_ignored_port); |
||||
if (strcmp(authority_hostname, |
||||
fake_security_target_name_override_hostname) != 0) { |
||||
gpr_log(GPR_ERROR, |
||||
"Authority (host) '%s' != Fake Security Target override '%s'", |
||||
host, fake_security_target_name_override_hostname); |
||||
abort(); |
||||
} |
||||
gpr_free(fake_security_target_name_override_hostname); |
||||
gpr_free(fake_security_target_name_override_ignored_port); |
||||
} else if (strcmp(authority_hostname, target_hostname) != 0) { |
||||
gpr_log(GPR_ERROR, "Authority (host) '%s' != Target '%s'", |
||||
authority_hostname, target_hostname); |
||||
abort(); |
||||
} |
||||
gpr_free(authority_hostname); |
||||
gpr_free(authority_ignored_port); |
||||
gpr_free(target_hostname); |
||||
gpr_free(target_ignored_port); |
||||
return true; |
||||
} |
||||
|
||||
static void fake_channel_cancel_check_call_host( |
||||
grpc_channel_security_connector* sc, grpc_closure* on_call_host_checked, |
||||
grpc_error* error) { |
||||
GRPC_ERROR_UNREF(error); |
||||
} |
||||
|
||||
static void fake_channel_add_handshakers( |
||||
grpc_channel_security_connector* sc, grpc_pollset_set* interested_parties, |
||||
grpc_handshake_manager* handshake_mgr) { |
||||
grpc_handshake_manager_add( |
||||
handshake_mgr, |
||||
grpc_security_handshaker_create( |
||||
tsi_create_fake_handshaker(true /* is_client */), &sc->base)); |
||||
} |
||||
|
||||
static void fake_server_add_handshakers(grpc_server_security_connector* sc, |
||||
grpc_pollset_set* interested_parties, |
||||
grpc_handshake_manager* handshake_mgr) { |
||||
grpc_handshake_manager_add( |
||||
handshake_mgr, |
||||
grpc_security_handshaker_create( |
||||
tsi_create_fake_handshaker(false /* is_client */), &sc->base)); |
||||
} |
||||
|
||||
static grpc_security_connector_vtable fake_channel_vtable = { |
||||
fake_channel_destroy, fake_channel_check_peer, fake_channel_cmp}; |
||||
|
||||
static grpc_security_connector_vtable fake_server_vtable = { |
||||
fake_server_destroy, fake_server_check_peer, fake_server_cmp}; |
||||
|
||||
grpc_channel_security_connector* grpc_fake_channel_security_connector_create( |
||||
grpc_channel_credentials* channel_creds, |
||||
grpc_call_credentials* request_metadata_creds, const char* target, |
||||
const grpc_channel_args* args) { |
||||
grpc_fake_channel_security_connector* c = |
||||
static_cast<grpc_fake_channel_security_connector*>( |
||||
gpr_zalloc(sizeof(*c))); |
||||
gpr_ref_init(&c->base.base.refcount, 1); |
||||
c->base.base.url_scheme = GRPC_FAKE_SECURITY_URL_SCHEME; |
||||
c->base.base.vtable = &fake_channel_vtable; |
||||
c->base.channel_creds = channel_creds; |
||||
c->base.request_metadata_creds = |
||||
grpc_call_credentials_ref(request_metadata_creds); |
||||
c->base.check_call_host = fake_channel_check_call_host; |
||||
c->base.cancel_check_call_host = fake_channel_cancel_check_call_host; |
||||
c->base.add_handshakers = fake_channel_add_handshakers; |
||||
c->target = gpr_strdup(target); |
||||
const char* expected_targets = grpc_fake_transport_get_expected_targets(args); |
||||
c->expected_targets = gpr_strdup(expected_targets); |
||||
c->is_lb_channel = grpc_core::FindTargetAuthorityTableInArgs(args) != nullptr; |
||||
const grpc_arg* target_name_override_arg = |
||||
grpc_channel_args_find(args, GRPC_SSL_TARGET_NAME_OVERRIDE_ARG); |
||||
if (target_name_override_arg != nullptr) { |
||||
c->target_name_override = |
||||
gpr_strdup(grpc_channel_arg_get_string(target_name_override_arg)); |
||||
} |
||||
return &c->base; |
||||
} |
||||
|
||||
grpc_server_security_connector* grpc_fake_server_security_connector_create( |
||||
grpc_server_credentials* server_creds) { |
||||
grpc_server_security_connector* c = |
||||
static_cast<grpc_server_security_connector*>( |
||||
gpr_zalloc(sizeof(grpc_server_security_connector))); |
||||
gpr_ref_init(&c->base.refcount, 1); |
||||
c->base.vtable = &fake_server_vtable; |
||||
c->base.url_scheme = GRPC_FAKE_SECURITY_URL_SCHEME; |
||||
c->server_creds = server_creds; |
||||
c->add_handshakers = fake_server_add_handshakers; |
||||
return c; |
||||
} |
||||
@ -0,0 +1,42 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 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. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_CORE_LIB_SECURITY_SECURITY_CONNECTOR_FAKE_FAKE_SECURITY_CONNECTOR_H |
||||
#define GRPC_CORE_LIB_SECURITY_SECURITY_CONNECTOR_FAKE_FAKE_SECURITY_CONNECTOR_H |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include <grpc/grpc_security.h> |
||||
|
||||
#include "src/core/lib/channel/handshaker.h" |
||||
#include "src/core/lib/security/security_connector/security_connector.h" |
||||
|
||||
#define GRPC_FAKE_SECURITY_URL_SCHEME "http+fake_security" |
||||
|
||||
/* Creates a fake connector that emulates real channel security. */ |
||||
grpc_channel_security_connector* grpc_fake_channel_security_connector_create( |
||||
grpc_channel_credentials* channel_creds, |
||||
grpc_call_credentials* request_metadata_creds, const char* target, |
||||
const grpc_channel_args* args); |
||||
|
||||
/* Creates a fake connector that emulates real server security. */ |
||||
grpc_server_security_connector* grpc_fake_server_security_connector_create( |
||||
grpc_server_credentials* server_creds); |
||||
|
||||
#endif /* GRPC_CORE_LIB_SECURITY_SECURITY_CONNECTOR_FAKE_FAKE_SECURITY_CONNECTOR_H \ |
||||
*/ |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,474 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 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 <grpc/support/port_platform.h> |
||||
|
||||
#include "src/core/lib/security/security_connector/ssl/ssl_security_connector.h" |
||||
|
||||
#include <stdbool.h> |
||||
|
||||
#include <grpc/support/alloc.h> |
||||
#include <grpc/support/log.h> |
||||
#include <grpc/support/string_util.h> |
||||
|
||||
#include "src/core/ext/transport/chttp2/alpn/alpn.h" |
||||
#include "src/core/lib/channel/handshaker.h" |
||||
#include "src/core/lib/gpr/host_port.h" |
||||
#include "src/core/lib/gpr/string.h" |
||||
#include "src/core/lib/security/context/security_context.h" |
||||
#include "src/core/lib/security/credentials/credentials.h" |
||||
#include "src/core/lib/security/credentials/ssl/ssl_credentials.h" |
||||
#include "src/core/lib/security/security_connector/load_system_roots.h" |
||||
#include "src/core/lib/security/security_connector/ssl_utils.h" |
||||
#include "src/core/lib/security/transport/security_handshaker.h" |
||||
#include "src/core/tsi/ssl_transport_security.h" |
||||
#include "src/core/tsi/transport_security.h" |
||||
|
||||
typedef struct { |
||||
grpc_channel_security_connector base; |
||||
tsi_ssl_client_handshaker_factory* client_handshaker_factory; |
||||
char* target_name; |
||||
char* overridden_target_name; |
||||
const verify_peer_options* verify_options; |
||||
} grpc_ssl_channel_security_connector; |
||||
|
||||
typedef struct { |
||||
grpc_server_security_connector base; |
||||
tsi_ssl_server_handshaker_factory* server_handshaker_factory; |
||||
} grpc_ssl_server_security_connector; |
||||
|
||||
static bool server_connector_has_cert_config_fetcher( |
||||
grpc_ssl_server_security_connector* c) { |
||||
GPR_ASSERT(c != nullptr); |
||||
grpc_ssl_server_credentials* server_creds = |
||||
reinterpret_cast<grpc_ssl_server_credentials*>(c->base.server_creds); |
||||
GPR_ASSERT(server_creds != nullptr); |
||||
return server_creds->certificate_config_fetcher.cb != nullptr; |
||||
} |
||||
|
||||
static void ssl_channel_destroy(grpc_security_connector* sc) { |
||||
grpc_ssl_channel_security_connector* c = |
||||
reinterpret_cast<grpc_ssl_channel_security_connector*>(sc); |
||||
grpc_channel_credentials_unref(c->base.channel_creds); |
||||
grpc_call_credentials_unref(c->base.request_metadata_creds); |
||||
tsi_ssl_client_handshaker_factory_unref(c->client_handshaker_factory); |
||||
c->client_handshaker_factory = nullptr; |
||||
if (c->target_name != nullptr) gpr_free(c->target_name); |
||||
if (c->overridden_target_name != nullptr) gpr_free(c->overridden_target_name); |
||||
gpr_free(sc); |
||||
} |
||||
|
||||
static void ssl_server_destroy(grpc_security_connector* sc) { |
||||
grpc_ssl_server_security_connector* c = |
||||
reinterpret_cast<grpc_ssl_server_security_connector*>(sc); |
||||
grpc_server_credentials_unref(c->base.server_creds); |
||||
tsi_ssl_server_handshaker_factory_unref(c->server_handshaker_factory); |
||||
c->server_handshaker_factory = nullptr; |
||||
gpr_free(sc); |
||||
} |
||||
|
||||
static void ssl_channel_add_handshakers(grpc_channel_security_connector* sc, |
||||
grpc_pollset_set* interested_parties, |
||||
grpc_handshake_manager* handshake_mgr) { |
||||
grpc_ssl_channel_security_connector* c = |
||||
reinterpret_cast<grpc_ssl_channel_security_connector*>(sc); |
||||
// Instantiate TSI handshaker.
|
||||
tsi_handshaker* tsi_hs = nullptr; |
||||
tsi_result result = tsi_ssl_client_handshaker_factory_create_handshaker( |
||||
c->client_handshaker_factory, |
||||
c->overridden_target_name != nullptr ? c->overridden_target_name |
||||
: c->target_name, |
||||
&tsi_hs); |
||||
if (result != TSI_OK) { |
||||
gpr_log(GPR_ERROR, "Handshaker creation failed with error %s.", |
||||
tsi_result_to_string(result)); |
||||
return; |
||||
} |
||||
// Create handshakers.
|
||||
grpc_handshake_manager_add( |
||||
handshake_mgr, grpc_security_handshaker_create(tsi_hs, &sc->base)); |
||||
} |
||||
|
||||
/* Attempts to replace the server_handshaker_factory with a new factory using
|
||||
* the provided grpc_ssl_server_certificate_config. Should new factory creation |
||||
* fail, the existing factory will not be replaced. Returns true on success (new |
||||
* factory created). */ |
||||
static bool try_replace_server_handshaker_factory( |
||||
grpc_ssl_server_security_connector* sc, |
||||
const grpc_ssl_server_certificate_config* config) { |
||||
if (config == nullptr) { |
||||
gpr_log(GPR_ERROR, |
||||
"Server certificate config callback returned invalid (NULL) " |
||||
"config."); |
||||
return false; |
||||
} |
||||
gpr_log(GPR_DEBUG, "Using new server certificate config (%p).", config); |
||||
|
||||
size_t num_alpn_protocols = 0; |
||||
const char** alpn_protocol_strings = |
||||
grpc_fill_alpn_protocol_strings(&num_alpn_protocols); |
||||
tsi_ssl_pem_key_cert_pair* cert_pairs = grpc_convert_grpc_to_tsi_cert_pairs( |
||||
config->pem_key_cert_pairs, config->num_key_cert_pairs); |
||||
tsi_ssl_server_handshaker_factory* new_handshaker_factory = nullptr; |
||||
grpc_ssl_server_credentials* server_creds = |
||||
reinterpret_cast<grpc_ssl_server_credentials*>(sc->base.server_creds); |
||||
tsi_result result = tsi_create_ssl_server_handshaker_factory_ex( |
||||
cert_pairs, config->num_key_cert_pairs, config->pem_root_certs, |
||||
grpc_get_tsi_client_certificate_request_type( |
||||
server_creds->config.client_certificate_request), |
||||
grpc_get_ssl_cipher_suites(), alpn_protocol_strings, |
||||
static_cast<uint16_t>(num_alpn_protocols), &new_handshaker_factory); |
||||
gpr_free(cert_pairs); |
||||
gpr_free((void*)alpn_protocol_strings); |
||||
|
||||
if (result != TSI_OK) { |
||||
gpr_log(GPR_ERROR, "Handshaker factory creation failed with %s.", |
||||
tsi_result_to_string(result)); |
||||
return false; |
||||
} |
||||
tsi_ssl_server_handshaker_factory_unref(sc->server_handshaker_factory); |
||||
sc->server_handshaker_factory = new_handshaker_factory; |
||||
return true; |
||||
} |
||||
|
||||
/* Attempts to fetch the server certificate config if a callback is available.
|
||||
* Current certificate config will continue to be used if the callback returns |
||||
* an error. Returns true if new credentials were sucessfully loaded. */ |
||||
static bool try_fetch_ssl_server_credentials( |
||||
grpc_ssl_server_security_connector* sc) { |
||||
grpc_ssl_server_certificate_config* certificate_config = nullptr; |
||||
bool status; |
||||
|
||||
GPR_ASSERT(sc != nullptr); |
||||
if (!server_connector_has_cert_config_fetcher(sc)) return false; |
||||
|
||||
grpc_ssl_server_credentials* server_creds = |
||||
reinterpret_cast<grpc_ssl_server_credentials*>(sc->base.server_creds); |
||||
grpc_ssl_certificate_config_reload_status cb_result = |
||||
server_creds->certificate_config_fetcher.cb( |
||||
server_creds->certificate_config_fetcher.user_data, |
||||
&certificate_config); |
||||
if (cb_result == GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_UNCHANGED) { |
||||
gpr_log(GPR_DEBUG, "No change in SSL server credentials."); |
||||
status = false; |
||||
} else if (cb_result == GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_NEW) { |
||||
status = try_replace_server_handshaker_factory(sc, certificate_config); |
||||
} else { |
||||
// Log error, continue using previously-loaded credentials.
|
||||
gpr_log(GPR_ERROR, |
||||
"Failed fetching new server credentials, continuing to " |
||||
"use previously-loaded credentials."); |
||||
status = false; |
||||
} |
||||
|
||||
if (certificate_config != nullptr) { |
||||
grpc_ssl_server_certificate_config_destroy(certificate_config); |
||||
} |
||||
return status; |
||||
} |
||||
|
||||
static void ssl_server_add_handshakers(grpc_server_security_connector* sc, |
||||
grpc_pollset_set* interested_parties, |
||||
grpc_handshake_manager* handshake_mgr) { |
||||
grpc_ssl_server_security_connector* c = |
||||
reinterpret_cast<grpc_ssl_server_security_connector*>(sc); |
||||
// Instantiate TSI handshaker.
|
||||
try_fetch_ssl_server_credentials(c); |
||||
tsi_handshaker* tsi_hs = nullptr; |
||||
tsi_result result = tsi_ssl_server_handshaker_factory_create_handshaker( |
||||
c->server_handshaker_factory, &tsi_hs); |
||||
if (result != TSI_OK) { |
||||
gpr_log(GPR_ERROR, "Handshaker creation failed with error %s.", |
||||
tsi_result_to_string(result)); |
||||
return; |
||||
} |
||||
// Create handshakers.
|
||||
grpc_handshake_manager_add( |
||||
handshake_mgr, grpc_security_handshaker_create(tsi_hs, &sc->base)); |
||||
} |
||||
|
||||
static grpc_error* ssl_check_peer(grpc_security_connector* sc, |
||||
const char* peer_name, const tsi_peer* peer, |
||||
grpc_auth_context** auth_context) { |
||||
#if TSI_OPENSSL_ALPN_SUPPORT |
||||
/* Check the ALPN if ALPN is supported. */ |
||||
const tsi_peer_property* p = |
||||
tsi_peer_get_property_by_name(peer, TSI_SSL_ALPN_SELECTED_PROTOCOL); |
||||
if (p == nullptr) { |
||||
return GRPC_ERROR_CREATE_FROM_STATIC_STRING( |
||||
"Cannot check peer: missing selected ALPN property."); |
||||
} |
||||
if (!grpc_chttp2_is_alpn_version_supported(p->value.data, p->value.length)) { |
||||
return GRPC_ERROR_CREATE_FROM_STATIC_STRING( |
||||
"Cannot check peer: invalid ALPN value."); |
||||
} |
||||
#endif /* TSI_OPENSSL_ALPN_SUPPORT */ |
||||
/* Check the peer name if specified. */ |
||||
if (peer_name != nullptr && !grpc_ssl_host_matches_name(peer, peer_name)) { |
||||
char* msg; |
||||
gpr_asprintf(&msg, "Peer name %s is not in peer certificate", peer_name); |
||||
grpc_error* error = GRPC_ERROR_CREATE_FROM_COPIED_STRING(msg); |
||||
gpr_free(msg); |
||||
return error; |
||||
} |
||||
*auth_context = grpc_ssl_peer_to_auth_context(peer); |
||||
return GRPC_ERROR_NONE; |
||||
} |
||||
|
||||
static void ssl_channel_check_peer(grpc_security_connector* sc, tsi_peer peer, |
||||
grpc_auth_context** auth_context, |
||||
grpc_closure* on_peer_checked) { |
||||
grpc_ssl_channel_security_connector* c = |
||||
reinterpret_cast<grpc_ssl_channel_security_connector*>(sc); |
||||
const char* target_name = c->overridden_target_name != nullptr |
||||
? c->overridden_target_name |
||||
: c->target_name; |
||||
grpc_error* error = ssl_check_peer(sc, target_name, &peer, auth_context); |
||||
if (error == GRPC_ERROR_NONE && |
||||
c->verify_options->verify_peer_callback != nullptr) { |
||||
const tsi_peer_property* p = |
||||
tsi_peer_get_property_by_name(&peer, TSI_X509_PEM_CERT_PROPERTY); |
||||
if (p == nullptr) { |
||||
error = GRPC_ERROR_CREATE_FROM_STATIC_STRING( |
||||
"Cannot check peer: missing pem cert property."); |
||||
} else { |
||||
char* peer_pem = static_cast<char*>(gpr_malloc(p->value.length + 1)); |
||||
memcpy(peer_pem, p->value.data, p->value.length); |
||||
peer_pem[p->value.length] = '\0'; |
||||
int callback_status = c->verify_options->verify_peer_callback( |
||||
target_name, peer_pem, |
||||
c->verify_options->verify_peer_callback_userdata); |
||||
gpr_free(peer_pem); |
||||
if (callback_status) { |
||||
char* msg; |
||||
gpr_asprintf(&msg, "Verify peer callback returned a failure (%d)", |
||||
callback_status); |
||||
error = GRPC_ERROR_CREATE_FROM_COPIED_STRING(msg); |
||||
gpr_free(msg); |
||||
} |
||||
} |
||||
} |
||||
GRPC_CLOSURE_SCHED(on_peer_checked, error); |
||||
tsi_peer_destruct(&peer); |
||||
} |
||||
|
||||
static void ssl_server_check_peer(grpc_security_connector* sc, tsi_peer peer, |
||||
grpc_auth_context** auth_context, |
||||
grpc_closure* on_peer_checked) { |
||||
grpc_error* error = ssl_check_peer(sc, nullptr, &peer, auth_context); |
||||
tsi_peer_destruct(&peer); |
||||
GRPC_CLOSURE_SCHED(on_peer_checked, error); |
||||
} |
||||
|
||||
static int ssl_channel_cmp(grpc_security_connector* sc1, |
||||
grpc_security_connector* sc2) { |
||||
grpc_ssl_channel_security_connector* c1 = |
||||
reinterpret_cast<grpc_ssl_channel_security_connector*>(sc1); |
||||
grpc_ssl_channel_security_connector* c2 = |
||||
reinterpret_cast<grpc_ssl_channel_security_connector*>(sc2); |
||||
int c = grpc_channel_security_connector_cmp(&c1->base, &c2->base); |
||||
if (c != 0) return c; |
||||
c = strcmp(c1->target_name, c2->target_name); |
||||
if (c != 0) return c; |
||||
return (c1->overridden_target_name == nullptr || |
||||
c2->overridden_target_name == nullptr) |
||||
? GPR_ICMP(c1->overridden_target_name, c2->overridden_target_name) |
||||
: strcmp(c1->overridden_target_name, c2->overridden_target_name); |
||||
} |
||||
|
||||
static int ssl_server_cmp(grpc_security_connector* sc1, |
||||
grpc_security_connector* sc2) { |
||||
return grpc_server_security_connector_cmp( |
||||
reinterpret_cast<grpc_server_security_connector*>(sc1), |
||||
reinterpret_cast<grpc_server_security_connector*>(sc2)); |
||||
} |
||||
|
||||
static bool ssl_channel_check_call_host(grpc_channel_security_connector* sc, |
||||
const char* host, |
||||
grpc_auth_context* auth_context, |
||||
grpc_closure* on_call_host_checked, |
||||
grpc_error** error) { |
||||
grpc_ssl_channel_security_connector* c = |
||||
reinterpret_cast<grpc_ssl_channel_security_connector*>(sc); |
||||
grpc_security_status status = GRPC_SECURITY_ERROR; |
||||
tsi_peer peer = grpc_shallow_peer_from_ssl_auth_context(auth_context); |
||||
if (grpc_ssl_host_matches_name(&peer, host)) status = GRPC_SECURITY_OK; |
||||
/* If the target name was overridden, then the original target_name was
|
||||
'checked' transitively during the previous peer check at the end of the |
||||
handshake. */ |
||||
if (c->overridden_target_name != nullptr && |
||||
strcmp(host, c->target_name) == 0) { |
||||
status = GRPC_SECURITY_OK; |
||||
} |
||||
if (status != GRPC_SECURITY_OK) { |
||||
*error = GRPC_ERROR_CREATE_FROM_STATIC_STRING( |
||||
"call host does not match SSL server name"); |
||||
} |
||||
grpc_shallow_peer_destruct(&peer); |
||||
return true; |
||||
} |
||||
|
||||
static void ssl_channel_cancel_check_call_host( |
||||
grpc_channel_security_connector* sc, grpc_closure* on_call_host_checked, |
||||
grpc_error* error) { |
||||
GRPC_ERROR_UNREF(error); |
||||
} |
||||
|
||||
static grpc_security_connector_vtable ssl_channel_vtable = { |
||||
ssl_channel_destroy, ssl_channel_check_peer, ssl_channel_cmp}; |
||||
|
||||
static grpc_security_connector_vtable ssl_server_vtable = { |
||||
ssl_server_destroy, ssl_server_check_peer, ssl_server_cmp}; |
||||
|
||||
grpc_security_status grpc_ssl_channel_security_connector_create( |
||||
grpc_channel_credentials* channel_creds, |
||||
grpc_call_credentials* request_metadata_creds, |
||||
const grpc_ssl_config* config, const char* target_name, |
||||
const char* overridden_target_name, |
||||
tsi_ssl_session_cache* ssl_session_cache, |
||||
grpc_channel_security_connector** sc) { |
||||
tsi_result result = TSI_OK; |
||||
grpc_ssl_channel_security_connector* c; |
||||
char* port; |
||||
bool has_key_cert_pair; |
||||
tsi_ssl_client_handshaker_options options; |
||||
memset(&options, 0, sizeof(options)); |
||||
options.alpn_protocols = |
||||
grpc_fill_alpn_protocol_strings(&options.num_alpn_protocols); |
||||
|
||||
if (config == nullptr || target_name == nullptr) { |
||||
gpr_log(GPR_ERROR, "An ssl channel needs a config and a target name."); |
||||
goto error; |
||||
} |
||||
if (config->pem_root_certs == nullptr) { |
||||
// Use default root certificates.
|
||||
options.pem_root_certs = grpc_core::DefaultSslRootStore::GetPemRootCerts(); |
||||
options.root_store = grpc_core::DefaultSslRootStore::GetRootStore(); |
||||
if (options.pem_root_certs == nullptr) { |
||||
gpr_log(GPR_ERROR, "Could not get default pem root certs."); |
||||
goto error; |
||||
} |
||||
} else { |
||||
options.pem_root_certs = config->pem_root_certs; |
||||
} |
||||
c = static_cast<grpc_ssl_channel_security_connector*>( |
||||
gpr_zalloc(sizeof(grpc_ssl_channel_security_connector))); |
||||
|
||||
gpr_ref_init(&c->base.base.refcount, 1); |
||||
c->base.base.vtable = &ssl_channel_vtable; |
||||
c->base.base.url_scheme = GRPC_SSL_URL_SCHEME; |
||||
c->base.channel_creds = grpc_channel_credentials_ref(channel_creds); |
||||
c->base.request_metadata_creds = |
||||
grpc_call_credentials_ref(request_metadata_creds); |
||||
c->base.check_call_host = ssl_channel_check_call_host; |
||||
c->base.cancel_check_call_host = ssl_channel_cancel_check_call_host; |
||||
c->base.add_handshakers = ssl_channel_add_handshakers; |
||||
gpr_split_host_port(target_name, &c->target_name, &port); |
||||
gpr_free(port); |
||||
if (overridden_target_name != nullptr) { |
||||
c->overridden_target_name = gpr_strdup(overridden_target_name); |
||||
} |
||||
c->verify_options = &config->verify_options; |
||||
|
||||
has_key_cert_pair = config->pem_key_cert_pair != nullptr && |
||||
config->pem_key_cert_pair->private_key != nullptr && |
||||
config->pem_key_cert_pair->cert_chain != nullptr; |
||||
if (has_key_cert_pair) { |
||||
options.pem_key_cert_pair = config->pem_key_cert_pair; |
||||
} |
||||
options.cipher_suites = grpc_get_ssl_cipher_suites(); |
||||
options.session_cache = ssl_session_cache; |
||||
result = tsi_create_ssl_client_handshaker_factory_with_options( |
||||
&options, &c->client_handshaker_factory); |
||||
if (result != TSI_OK) { |
||||
gpr_log(GPR_ERROR, "Handshaker factory creation failed with %s.", |
||||
tsi_result_to_string(result)); |
||||
ssl_channel_destroy(&c->base.base); |
||||
*sc = nullptr; |
||||
goto error; |
||||
} |
||||
*sc = &c->base; |
||||
gpr_free((void*)options.alpn_protocols); |
||||
return GRPC_SECURITY_OK; |
||||
|
||||
error: |
||||
gpr_free((void*)options.alpn_protocols); |
||||
return GRPC_SECURITY_ERROR; |
||||
} |
||||
|
||||
static grpc_ssl_server_security_connector* |
||||
grpc_ssl_server_security_connector_initialize( |
||||
grpc_server_credentials* server_creds) { |
||||
grpc_ssl_server_security_connector* c = |
||||
static_cast<grpc_ssl_server_security_connector*>( |
||||
gpr_zalloc(sizeof(grpc_ssl_server_security_connector))); |
||||
gpr_ref_init(&c->base.base.refcount, 1); |
||||
c->base.base.url_scheme = GRPC_SSL_URL_SCHEME; |
||||
c->base.base.vtable = &ssl_server_vtable; |
||||
c->base.add_handshakers = ssl_server_add_handshakers; |
||||
c->base.server_creds = grpc_server_credentials_ref(server_creds); |
||||
return c; |
||||
} |
||||
|
||||
grpc_security_status grpc_ssl_server_security_connector_create( |
||||
grpc_server_credentials* gsc, grpc_server_security_connector** sc) { |
||||
tsi_result result = TSI_OK; |
||||
grpc_ssl_server_credentials* server_credentials = |
||||
reinterpret_cast<grpc_ssl_server_credentials*>(gsc); |
||||
grpc_security_status retval = GRPC_SECURITY_OK; |
||||
|
||||
GPR_ASSERT(server_credentials != nullptr); |
||||
GPR_ASSERT(sc != nullptr); |
||||
|
||||
grpc_ssl_server_security_connector* c = |
||||
grpc_ssl_server_security_connector_initialize(gsc); |
||||
if (server_connector_has_cert_config_fetcher(c)) { |
||||
// Load initial credentials from certificate_config_fetcher:
|
||||
if (!try_fetch_ssl_server_credentials(c)) { |
||||
gpr_log(GPR_ERROR, "Failed loading SSL server credentials from fetcher."); |
||||
retval = GRPC_SECURITY_ERROR; |
||||
} |
||||
} else { |
||||
size_t num_alpn_protocols = 0; |
||||
const char** alpn_protocol_strings = |
||||
grpc_fill_alpn_protocol_strings(&num_alpn_protocols); |
||||
result = tsi_create_ssl_server_handshaker_factory_ex( |
||||
server_credentials->config.pem_key_cert_pairs, |
||||
server_credentials->config.num_key_cert_pairs, |
||||
server_credentials->config.pem_root_certs, |
||||
grpc_get_tsi_client_certificate_request_type( |
||||
server_credentials->config.client_certificate_request), |
||||
grpc_get_ssl_cipher_suites(), alpn_protocol_strings, |
||||
static_cast<uint16_t>(num_alpn_protocols), |
||||
&c->server_handshaker_factory); |
||||
gpr_free((void*)alpn_protocol_strings); |
||||
if (result != TSI_OK) { |
||||
gpr_log(GPR_ERROR, "Handshaker factory creation failed with %s.", |
||||
tsi_result_to_string(result)); |
||||
retval = GRPC_SECURITY_ERROR; |
||||
} |
||||
} |
||||
|
||||
if (retval == GRPC_SECURITY_OK) { |
||||
*sc = &c->base; |
||||
} else { |
||||
if (c != nullptr) ssl_server_destroy(&c->base.base); |
||||
if (sc != nullptr) *sc = nullptr; |
||||
} |
||||
return retval; |
||||
} |
||||
@ -0,0 +1,77 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 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. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_CORE_LIB_SECURITY_SECURITY_CONNECTOR_SSL_SSL_SECURITY_CONNECTOR_H |
||||
#define GRPC_CORE_LIB_SECURITY_SECURITY_CONNECTOR_SSL_SSL_SECURITY_CONNECTOR_H |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include <grpc/grpc_security.h> |
||||
|
||||
#include "src/core/lib/security/security_connector/security_connector.h" |
||||
|
||||
#include "src/core/tsi/ssl_transport_security.h" |
||||
#include "src/core/tsi/transport_security_interface.h" |
||||
|
||||
typedef struct { |
||||
tsi_ssl_pem_key_cert_pair* pem_key_cert_pair; |
||||
char* pem_root_certs; |
||||
verify_peer_options verify_options; |
||||
} grpc_ssl_config; |
||||
|
||||
/* Creates an SSL channel_security_connector.
|
||||
- request_metadata_creds is the credentials object which metadata |
||||
will be sent with each request. This parameter can be NULL. |
||||
- config is the SSL config to be used for the SSL channel establishment. |
||||
- is_client should be 0 for a server or a non-0 value for a client. |
||||
- secure_peer_name is the secure peer name that should be checked in |
||||
grpc_channel_security_connector_check_peer. This parameter may be NULL in |
||||
which case the peer name will not be checked. Note that if this parameter |
||||
is not NULL, then, pem_root_certs should not be NULL either. |
||||
- sc is a pointer on the connector to be created. |
||||
This function returns GRPC_SECURITY_OK in case of success or a |
||||
specific error code otherwise. |
||||
*/ |
||||
grpc_security_status grpc_ssl_channel_security_connector_create( |
||||
grpc_channel_credentials* channel_creds, |
||||
grpc_call_credentials* request_metadata_creds, |
||||
const grpc_ssl_config* config, const char* target_name, |
||||
const char* overridden_target_name, |
||||
tsi_ssl_session_cache* ssl_session_cache, |
||||
grpc_channel_security_connector** sc); |
||||
|
||||
/* Config for ssl servers. */ |
||||
typedef struct { |
||||
tsi_ssl_pem_key_cert_pair* pem_key_cert_pairs; |
||||
size_t num_key_cert_pairs; |
||||
char* pem_root_certs; |
||||
grpc_ssl_client_certificate_request_type client_certificate_request; |
||||
} grpc_ssl_server_config; |
||||
|
||||
/* Creates an SSL server_security_connector.
|
||||
- config is the SSL config to be used for the SSL channel establishment. |
||||
- sc is a pointer on the connector to be created. |
||||
This function returns GRPC_SECURITY_OK in case of success or a |
||||
specific error code otherwise. |
||||
*/ |
||||
grpc_security_status grpc_ssl_server_security_connector_create( |
||||
grpc_server_credentials* server_credentials, |
||||
grpc_server_security_connector** sc); |
||||
|
||||
#endif /* GRPC_CORE_LIB_SECURITY_SECURITY_CONNECTOR_SSL_SSL_SECURITY_CONNECTOR_H \ |
||||
*/ |
||||
@ -0,0 +1,345 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2015 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 <grpc/support/port_platform.h> |
||||
|
||||
#include "src/core/lib/security/security_connector/ssl_utils.h" |
||||
|
||||
#include <grpc/slice_buffer.h> |
||||
#include <grpc/support/alloc.h> |
||||
#include <grpc/support/log.h> |
||||
#include <grpc/support/string_util.h> |
||||
|
||||
#include "src/core/ext/transport/chttp2/alpn/alpn.h" |
||||
#include "src/core/lib/channel/channel_args.h" |
||||
#include "src/core/lib/gpr/env.h" |
||||
#include "src/core/lib/gpr/host_port.h" |
||||
#include "src/core/lib/gpr/string.h" |
||||
#include "src/core/lib/iomgr/load_file.h" |
||||
#include "src/core/lib/security/context/security_context.h" |
||||
#include "src/core/lib/security/security_connector/load_system_roots.h" |
||||
#include "src/core/tsi/ssl_transport_security.h" |
||||
|
||||
/* -- Constants. -- */ |
||||
|
||||
#ifndef INSTALL_PREFIX |
||||
static const char* installed_roots_path = "/usr/share/grpc/roots.pem"; |
||||
#else |
||||
static const char* installed_roots_path = |
||||
INSTALL_PREFIX "/share/grpc/roots.pem"; |
||||
#endif |
||||
|
||||
/** Environment variable used as a flag to enable/disable loading system root
|
||||
certificates from the OS trust store. */ |
||||
#ifndef GRPC_NOT_USE_SYSTEM_SSL_ROOTS_ENV_VAR |
||||
#define GRPC_NOT_USE_SYSTEM_SSL_ROOTS_ENV_VAR "GRPC_NOT_USE_SYSTEM_SSL_ROOTS" |
||||
#endif |
||||
|
||||
#ifndef TSI_OPENSSL_ALPN_SUPPORT |
||||
#define TSI_OPENSSL_ALPN_SUPPORT 1 |
||||
#endif |
||||
|
||||
/* -- Overridden default roots. -- */ |
||||
|
||||
static grpc_ssl_roots_override_callback ssl_roots_override_cb = nullptr; |
||||
|
||||
void grpc_set_ssl_roots_override_callback(grpc_ssl_roots_override_callback cb) { |
||||
ssl_roots_override_cb = cb; |
||||
} |
||||
|
||||
/* -- Cipher suites. -- */ |
||||
|
||||
/* Defines the cipher suites that we accept by default. All these cipher suites
|
||||
are compliant with HTTP2. */ |
||||
#define GRPC_SSL_CIPHER_SUITES \ |
||||
"ECDHE-ECDSA-AES128-GCM-SHA256:" \
|
||||
"ECDHE-ECDSA-AES256-GCM-SHA384:" \
|
||||
"ECDHE-RSA-AES128-GCM-SHA256:" \
|
||||
"ECDHE-RSA-AES256-GCM-SHA384" |
||||
|
||||
static gpr_once cipher_suites_once = GPR_ONCE_INIT; |
||||
static const char* cipher_suites = nullptr; |
||||
|
||||
static void init_cipher_suites(void) { |
||||
char* overridden = gpr_getenv("GRPC_SSL_CIPHER_SUITES"); |
||||
cipher_suites = overridden != nullptr ? overridden : GRPC_SSL_CIPHER_SUITES; |
||||
} |
||||
|
||||
/* --- Util --- */ |
||||
|
||||
const char* grpc_get_ssl_cipher_suites(void) { |
||||
gpr_once_init(&cipher_suites_once, init_cipher_suites); |
||||
return cipher_suites; |
||||
} |
||||
|
||||
tsi_client_certificate_request_type |
||||
grpc_get_tsi_client_certificate_request_type( |
||||
grpc_ssl_client_certificate_request_type grpc_request_type) { |
||||
switch (grpc_request_type) { |
||||
case GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE: |
||||
return TSI_DONT_REQUEST_CLIENT_CERTIFICATE; |
||||
|
||||
case GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY: |
||||
return TSI_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY; |
||||
|
||||
case GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY: |
||||
return TSI_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY; |
||||
|
||||
case GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY: |
||||
return TSI_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY; |
||||
|
||||
case GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY: |
||||
return TSI_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY; |
||||
|
||||
default: |
||||
return TSI_DONT_REQUEST_CLIENT_CERTIFICATE; |
||||
} |
||||
} |
||||
|
||||
const char** grpc_fill_alpn_protocol_strings(size_t* num_alpn_protocols) { |
||||
GPR_ASSERT(num_alpn_protocols != nullptr); |
||||
*num_alpn_protocols = grpc_chttp2_num_alpn_versions(); |
||||
const char** alpn_protocol_strings = static_cast<const char**>( |
||||
gpr_malloc(sizeof(const char*) * (*num_alpn_protocols))); |
||||
for (size_t i = 0; i < *num_alpn_protocols; i++) { |
||||
alpn_protocol_strings[i] = grpc_chttp2_get_alpn_version_index(i); |
||||
} |
||||
return alpn_protocol_strings; |
||||
} |
||||
|
||||
int grpc_ssl_host_matches_name(const tsi_peer* peer, const char* peer_name) { |
||||
char* allocated_name = nullptr; |
||||
int r; |
||||
|
||||
char* ignored_port; |
||||
gpr_split_host_port(peer_name, &allocated_name, &ignored_port); |
||||
gpr_free(ignored_port); |
||||
peer_name = allocated_name; |
||||
if (!peer_name) return 0; |
||||
|
||||
// IPv6 zone-id should not be included in comparisons.
|
||||
char* const zone_id = strchr(allocated_name, '%'); |
||||
if (zone_id != nullptr) *zone_id = '\0'; |
||||
|
||||
r = tsi_ssl_peer_matches_name(peer, peer_name); |
||||
gpr_free(allocated_name); |
||||
return r; |
||||
} |
||||
|
||||
grpc_auth_context* grpc_ssl_peer_to_auth_context(const tsi_peer* peer) { |
||||
size_t i; |
||||
grpc_auth_context* ctx = nullptr; |
||||
const char* peer_identity_property_name = nullptr; |
||||
|
||||
/* The caller has checked the certificate type property. */ |
||||
GPR_ASSERT(peer->property_count >= 1); |
||||
ctx = grpc_auth_context_create(nullptr); |
||||
grpc_auth_context_add_cstring_property( |
||||
ctx, GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME, |
||||
GRPC_SSL_TRANSPORT_SECURITY_TYPE); |
||||
for (i = 0; i < peer->property_count; i++) { |
||||
const tsi_peer_property* prop = &peer->properties[i]; |
||||
if (prop->name == nullptr) continue; |
||||
if (strcmp(prop->name, TSI_X509_SUBJECT_COMMON_NAME_PEER_PROPERTY) == 0) { |
||||
/* If there is no subject alt name, have the CN as the identity. */ |
||||
if (peer_identity_property_name == nullptr) { |
||||
peer_identity_property_name = GRPC_X509_CN_PROPERTY_NAME; |
||||
} |
||||
grpc_auth_context_add_property(ctx, GRPC_X509_CN_PROPERTY_NAME, |
||||
prop->value.data, prop->value.length); |
||||
} else if (strcmp(prop->name, |
||||
TSI_X509_SUBJECT_ALTERNATIVE_NAME_PEER_PROPERTY) == 0) { |
||||
peer_identity_property_name = GRPC_X509_SAN_PROPERTY_NAME; |
||||
grpc_auth_context_add_property(ctx, GRPC_X509_SAN_PROPERTY_NAME, |
||||
prop->value.data, prop->value.length); |
||||
} else if (strcmp(prop->name, TSI_X509_PEM_CERT_PROPERTY) == 0) { |
||||
grpc_auth_context_add_property(ctx, GRPC_X509_PEM_CERT_PROPERTY_NAME, |
||||
prop->value.data, prop->value.length); |
||||
} else if (strcmp(prop->name, TSI_SSL_SESSION_REUSED_PEER_PROPERTY) == 0) { |
||||
grpc_auth_context_add_property(ctx, GRPC_SSL_SESSION_REUSED_PROPERTY, |
||||
prop->value.data, prop->value.length); |
||||
} |
||||
} |
||||
if (peer_identity_property_name != nullptr) { |
||||
GPR_ASSERT(grpc_auth_context_set_peer_identity_property_name( |
||||
ctx, peer_identity_property_name) == 1); |
||||
} |
||||
return ctx; |
||||
} |
||||
|
||||
static void add_shallow_auth_property_to_peer(tsi_peer* peer, |
||||
const grpc_auth_property* prop, |
||||
const char* tsi_prop_name) { |
||||
tsi_peer_property* tsi_prop = &peer->properties[peer->property_count++]; |
||||
tsi_prop->name = const_cast<char*>(tsi_prop_name); |
||||
tsi_prop->value.data = prop->value; |
||||
tsi_prop->value.length = prop->value_length; |
||||
} |
||||
|
||||
tsi_peer grpc_shallow_peer_from_ssl_auth_context( |
||||
const grpc_auth_context* auth_context) { |
||||
size_t max_num_props = 0; |
||||
grpc_auth_property_iterator it; |
||||
const grpc_auth_property* prop; |
||||
tsi_peer peer; |
||||
memset(&peer, 0, sizeof(peer)); |
||||
|
||||
it = grpc_auth_context_property_iterator(auth_context); |
||||
while (grpc_auth_property_iterator_next(&it) != nullptr) max_num_props++; |
||||
|
||||
if (max_num_props > 0) { |
||||
peer.properties = static_cast<tsi_peer_property*>( |
||||
gpr_malloc(max_num_props * sizeof(tsi_peer_property))); |
||||
it = grpc_auth_context_property_iterator(auth_context); |
||||
while ((prop = grpc_auth_property_iterator_next(&it)) != nullptr) { |
||||
if (strcmp(prop->name, GRPC_X509_SAN_PROPERTY_NAME) == 0) { |
||||
add_shallow_auth_property_to_peer( |
||||
&peer, prop, TSI_X509_SUBJECT_ALTERNATIVE_NAME_PEER_PROPERTY); |
||||
} else if (strcmp(prop->name, GRPC_X509_CN_PROPERTY_NAME) == 0) { |
||||
add_shallow_auth_property_to_peer( |
||||
&peer, prop, TSI_X509_SUBJECT_COMMON_NAME_PEER_PROPERTY); |
||||
} else if (strcmp(prop->name, GRPC_X509_PEM_CERT_PROPERTY_NAME) == 0) { |
||||
add_shallow_auth_property_to_peer(&peer, prop, |
||||
TSI_X509_PEM_CERT_PROPERTY); |
||||
} |
||||
} |
||||
} |
||||
return peer; |
||||
} |
||||
|
||||
void grpc_shallow_peer_destruct(tsi_peer* peer) { |
||||
if (peer->properties != nullptr) gpr_free(peer->properties); |
||||
} |
||||
|
||||
/* --- Ssl cache implementation. --- */ |
||||
|
||||
grpc_ssl_session_cache* grpc_ssl_session_cache_create_lru(size_t capacity) { |
||||
tsi_ssl_session_cache* cache = tsi_ssl_session_cache_create_lru(capacity); |
||||
return reinterpret_cast<grpc_ssl_session_cache*>(cache); |
||||
} |
||||
|
||||
void grpc_ssl_session_cache_destroy(grpc_ssl_session_cache* cache) { |
||||
tsi_ssl_session_cache* tsi_cache = |
||||
reinterpret_cast<tsi_ssl_session_cache*>(cache); |
||||
tsi_ssl_session_cache_unref(tsi_cache); |
||||
} |
||||
|
||||
static void* grpc_ssl_session_cache_arg_copy(void* p) { |
||||
tsi_ssl_session_cache* tsi_cache = |
||||
reinterpret_cast<tsi_ssl_session_cache*>(p); |
||||
// destroy call below will unref the pointer.
|
||||
tsi_ssl_session_cache_ref(tsi_cache); |
||||
return p; |
||||
} |
||||
|
||||
static void grpc_ssl_session_cache_arg_destroy(void* p) { |
||||
tsi_ssl_session_cache* tsi_cache = |
||||
reinterpret_cast<tsi_ssl_session_cache*>(p); |
||||
tsi_ssl_session_cache_unref(tsi_cache); |
||||
} |
||||
|
||||
static int grpc_ssl_session_cache_arg_cmp(void* p, void* q) { |
||||
return GPR_ICMP(p, q); |
||||
} |
||||
|
||||
grpc_arg grpc_ssl_session_cache_create_channel_arg( |
||||
grpc_ssl_session_cache* cache) { |
||||
static const grpc_arg_pointer_vtable vtable = { |
||||
grpc_ssl_session_cache_arg_copy, |
||||
grpc_ssl_session_cache_arg_destroy, |
||||
grpc_ssl_session_cache_arg_cmp, |
||||
}; |
||||
return grpc_channel_arg_pointer_create( |
||||
const_cast<char*>(GRPC_SSL_SESSION_CACHE_ARG), cache, &vtable); |
||||
} |
||||
|
||||
/* --- Default SSL root store implementation. --- */ |
||||
|
||||
namespace grpc_core { |
||||
|
||||
tsi_ssl_root_certs_store* DefaultSslRootStore::default_root_store_; |
||||
grpc_slice DefaultSslRootStore::default_pem_root_certs_; |
||||
|
||||
const tsi_ssl_root_certs_store* DefaultSslRootStore::GetRootStore() { |
||||
InitRootStore(); |
||||
return default_root_store_; |
||||
} |
||||
|
||||
const char* DefaultSslRootStore::GetPemRootCerts() { |
||||
InitRootStore(); |
||||
return GRPC_SLICE_IS_EMPTY(default_pem_root_certs_) |
||||
? nullptr |
||||
: reinterpret_cast<const char*> |
||||
GRPC_SLICE_START_PTR(default_pem_root_certs_); |
||||
} |
||||
|
||||
grpc_slice DefaultSslRootStore::ComputePemRootCerts() { |
||||
grpc_slice result = grpc_empty_slice(); |
||||
char* not_use_system_roots_env_value = |
||||
gpr_getenv(GRPC_NOT_USE_SYSTEM_SSL_ROOTS_ENV_VAR); |
||||
const bool not_use_system_roots = gpr_is_true(not_use_system_roots_env_value); |
||||
gpr_free(not_use_system_roots_env_value); |
||||
// First try to load the roots from the environment.
|
||||
char* default_root_certs_path = |
||||
gpr_getenv(GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR); |
||||
if (default_root_certs_path != nullptr) { |
||||
GRPC_LOG_IF_ERROR("load_file", |
||||
grpc_load_file(default_root_certs_path, 1, &result)); |
||||
gpr_free(default_root_certs_path); |
||||
} |
||||
// Try overridden roots if needed.
|
||||
grpc_ssl_roots_override_result ovrd_res = GRPC_SSL_ROOTS_OVERRIDE_FAIL; |
||||
if (GRPC_SLICE_IS_EMPTY(result) && ssl_roots_override_cb != nullptr) { |
||||
char* pem_root_certs = nullptr; |
||||
ovrd_res = ssl_roots_override_cb(&pem_root_certs); |
||||
if (ovrd_res == GRPC_SSL_ROOTS_OVERRIDE_OK) { |
||||
GPR_ASSERT(pem_root_certs != nullptr); |
||||
result = grpc_slice_from_copied_buffer( |
||||
pem_root_certs, |
||||
strlen(pem_root_certs) + 1); // nullptr terminator.
|
||||
} |
||||
gpr_free(pem_root_certs); |
||||
} |
||||
// Try loading roots from OS trust store if flag is enabled.
|
||||
if (GRPC_SLICE_IS_EMPTY(result) && !not_use_system_roots) { |
||||
result = LoadSystemRootCerts(); |
||||
} |
||||
// Fallback to roots manually shipped with gRPC.
|
||||
if (GRPC_SLICE_IS_EMPTY(result) && |
||||
ovrd_res != GRPC_SSL_ROOTS_OVERRIDE_FAIL_PERMANENTLY) { |
||||
GRPC_LOG_IF_ERROR("load_file", |
||||
grpc_load_file(installed_roots_path, 1, &result)); |
||||
} |
||||
return result; |
||||
} |
||||
|
||||
void DefaultSslRootStore::InitRootStore() { |
||||
static gpr_once once = GPR_ONCE_INIT; |
||||
gpr_once_init(&once, DefaultSslRootStore::InitRootStoreOnce); |
||||
} |
||||
|
||||
void DefaultSslRootStore::InitRootStoreOnce() { |
||||
default_pem_root_certs_ = ComputePemRootCerts(); |
||||
if (!GRPC_SLICE_IS_EMPTY(default_pem_root_certs_)) { |
||||
default_root_store_ = |
||||
tsi_ssl_root_certs_store_create(reinterpret_cast<const char*>( |
||||
GRPC_SLICE_START_PTR(default_pem_root_certs_))); |
||||
} |
||||
} |
||||
|
||||
} // namespace grpc_core
|
||||
@ -0,0 +1,93 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2015 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. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_CORE_LIB_SECURITY_SECURITY_CONNECTOR_SSL_UTILS_H |
||||
#define GRPC_CORE_LIB_SECURITY_SECURITY_CONNECTOR_SSL_UTILS_H |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include <stdbool.h> |
||||
|
||||
#include <grpc/grpc_security.h> |
||||
#include <grpc/slice_buffer.h> |
||||
|
||||
#include "src/core/tsi/ssl_transport_security.h" |
||||
#include "src/core/tsi/transport_security_interface.h" |
||||
|
||||
/* --- Util. --- */ |
||||
|
||||
/* --- URL schemes. --- */ |
||||
#define GRPC_SSL_URL_SCHEME "https" |
||||
|
||||
/* Return HTTP2-compliant cipher suites that gRPC accepts by default. */ |
||||
const char* grpc_get_ssl_cipher_suites(void); |
||||
|
||||
/* Map from grpc_ssl_client_certificate_request_type to
|
||||
* tsi_client_certificate_request_type. */ |
||||
tsi_client_certificate_request_type |
||||
grpc_get_tsi_client_certificate_request_type( |
||||
grpc_ssl_client_certificate_request_type grpc_request_type); |
||||
|
||||
/* Return an array of strings containing alpn protocols. */ |
||||
const char** grpc_fill_alpn_protocol_strings(size_t* num_alpn_protocols); |
||||
|
||||
/* Exposed for testing only. */ |
||||
grpc_auth_context* grpc_ssl_peer_to_auth_context(const tsi_peer* peer); |
||||
tsi_peer grpc_shallow_peer_from_ssl_auth_context( |
||||
const grpc_auth_context* auth_context); |
||||
void grpc_shallow_peer_destruct(tsi_peer* peer); |
||||
int grpc_ssl_host_matches_name(const tsi_peer* peer, const char* peer_name); |
||||
|
||||
/* --- Default SSL Root Store. --- */ |
||||
namespace grpc_core { |
||||
|
||||
// The class implements default SSL root store.
|
||||
class DefaultSslRootStore { |
||||
public: |
||||
// Gets the default SSL root store. Returns nullptr if not found.
|
||||
static const tsi_ssl_root_certs_store* GetRootStore(); |
||||
|
||||
// Gets the default PEM root certificate.
|
||||
static const char* GetPemRootCerts(); |
||||
|
||||
protected: |
||||
// Returns default PEM root certificates in nullptr terminated grpc_slice.
|
||||
// This function is protected instead of private, so that it can be tested.
|
||||
static grpc_slice ComputePemRootCerts(); |
||||
|
||||
private: |
||||
// Construct me not!
|
||||
DefaultSslRootStore(); |
||||
|
||||
// Initialization of default SSL root store.
|
||||
static void InitRootStore(); |
||||
|
||||
// One-time initialization of default SSL root store.
|
||||
static void InitRootStoreOnce(); |
||||
|
||||
// SSL root store in tsi_ssl_root_certs_store object.
|
||||
static tsi_ssl_root_certs_store* default_root_store_; |
||||
|
||||
// Default PEM root certificates.
|
||||
static grpc_slice default_pem_root_certs_; |
||||
}; |
||||
|
||||
} // namespace grpc_core
|
||||
|
||||
#endif /* GRPC_CORE_LIB_SECURITY_SECURITY_CONNECTOR_SSL_UTILS_H \ |
||||
*/ |
||||
@ -0,0 +1,3 @@ |
||||
# Install Python 2.7 |
||||
RUN apt-get update && apt-get install -y python2.7 python-all-dev |
||||
RUN curl https://bootstrap.pypa.io/get-pip.py | python2.7 |
||||
@ -0,0 +1,3 @@ |
||||
# Add Debian 'testing' repository |
||||
RUN echo 'deb http://ftp.de.debian.org/debian testing main' >> /etc/apt/sources.list |
||||
RUN echo 'APT::Default-Release "stable";' | tee -a /etc/apt/apt.conf.d/00local |
||||
@ -0,0 +1,9 @@ |
||||
FROM debian:stretch |
||||
|
||||
<%include file="./apt_get_basic.include"/> |
||||
<%include file="./gcp_api_libraries.include"/> |
||||
<%include file="./apt_get_python_27.include"/> |
||||
<%include file="./debian_testing_repo.include"/> |
||||
<%include file="./run_tests_addons.include"/> |
||||
# Define the default command. |
||||
CMD ["bash"] |
||||
@ -0,0 +1,17 @@ |
||||
%YAML 1.2 |
||||
--- | |
||||
# Copyright 2018 The 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 file="../../python_stretch.include"/> |
||||
@ -0,0 +1,20 @@ |
||||
%YAML 1.2 |
||||
--- | |
||||
# Copyright 2018 The 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 file="../../python_stretch.include"/> |
||||
|
||||
RUN apt-get update && apt-get -t testing install -y python3.6 python3-all-dev |
||||
RUN curl https://bootstrap.pypa.io/get-pip.py | python3.6 |
||||
@ -0,0 +1,20 @@ |
||||
%YAML 1.2 |
||||
--- | |
||||
# Copyright 2018 The 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 file="../../python_stretch.include"/> |
||||
|
||||
RUN apt-get update && apt-get -t testing install -y python3.7 python3-all-dev |
||||
RUN curl https://bootstrap.pypa.io/get-pip.py | python3.7 |
||||
@ -0,0 +1,6 @@ |
||||
%YAML 1.2 |
||||
--- | |
||||
<%! |
||||
import json |
||||
%> |
||||
${json.dumps(lb_interop_test_scenarios, indent=4, sort_keys=True)} |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue