natas_hw
/
grpc
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

security and subchannel: implement UniqueTypeName and use it in these interfaces (#29709) 

* implement UniqueTypeName API

* convert security code to use UniqueTypeName

* change subchannel data producer API to use UniqueTypeName

* sanitize

* add missing build dep

* fix credentials_test

* fix certificate_provider_store_test

* fix tls_security_connector_test

* attempt to fix windows build

* avoid unnecessary allocation

* work around MSVC 2017 bug

* sanity

* change factory to not be templated

* fix sanity

* fix bug in chttp2 connector that used server creds instead of channel creds

* add missing build dep

* simplify API
This commit is contained in:
Mark D. Roth 2022-05-23 09:45:20 -07:00 committed by GitHub
parent 9a46171833
commit 709dff9ca8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
59 changed files with 566 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
BUILD
View File

@ -956,6 +956,16 @@ grpc_cc_library(
tags = ["grpc-autodeps"],
)
grpc_cc_library(
name = "unique_type_name",
hdrs = ["src/core/lib/gprpp/unique_type_name.h"],
external_deps = [
"absl/strings",
],
language = "c++",
deps = ["useful"],
)
grpc_cc_library(
name = "gpr_codegen",
language = "c++",
@ -2921,6 +2931,7 @@ grpc_cc_library(
"slice_refcount",
"sockaddr_utils",
"time",
"unique_type_name",
"uri_parser",
"useful",
"xds_orca_service_upb",
@ -3546,6 +3557,7 @@ grpc_cc_library(
"ref_counted_ptr",
"server_address",
"time",
"unique_type_name",
],
)
@ -4922,6 +4934,7 @@ grpc_cc_library(
"resource_quota_trace",
"try_seq",
"tsi_base",
"unique_type_name",
],
)
@ -5380,6 +5393,7 @@ grpc_cc_library(
"slice",
"sockaddr_utils",
"tcp_connect_handshaker",
"unique_type_name",
"uri_parser",
],
)
@ -5426,6 +5440,7 @@ grpc_cc_library(
"slice",
"sockaddr_utils",
"time",
"unique_type_name",
"uri_parser",
"useful",
],

37
CMakeLists.txt generated
View File

@ -1172,6 +1172,7 @@ if(gRPC_BUILD_TESTS)
add_dependencies(buildtests_cxx try_join_test)
add_dependencies(buildtests_cxx try_seq_metadata_test)
add_dependencies(buildtests_cxx try_seq_test)
add_dependencies(buildtests_cxx unique_type_name_test)
add_dependencies(buildtests_cxx unknown_frame_bad_client_test)
add_dependencies(buildtests_cxx uri_parser_test)
add_dependencies(buildtests_cxx useful_test)
@ -17117,6 +17118,42 @@ target_link_libraries(try_seq_test
)
endif()
if(gRPC_BUILD_TESTS)
add_executable(unique_type_name_test
test/core/gprpp/unique_type_name_test.cc
third_party/googletest/googletest/src/gtest-all.cc
third_party/googletest/googlemock/src/gmock-all.cc
)
target_include_directories(unique_type_name_test
PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/include
${_gRPC_ADDRESS_SORTING_INCLUDE_DIR}
${_gRPC_RE2_INCLUDE_DIR}
${_gRPC_SSL_INCLUDE_DIR}
${_gRPC_UPB_GENERATED_DIR}
${_gRPC_UPB_GRPC_GENERATED_DIR}
${_gRPC_UPB_INCLUDE_DIR}
${_gRPC_XXHASH_INCLUDE_DIR}
${_gRPC_ZLIB_INCLUDE_DIR}
third_party/googletest/googletest/include
third_party/googletest/googletest
third_party/googletest/googlemock/include
third_party/googletest/googlemock
${_gRPC_PROTO_GENS_DIR}
)
target_link_libraries(unique_type_name_test
${_gRPC_PROTOBUF_LIBRARIES}
${_gRPC_ALLTARGETS_LIBRARIES}
absl::str_format
absl::strings
)
endif()
if(gRPC_BUILD_TESTS)

15
build_autogenerated.yaml generated
View File

@ -744,6 +744,7 @@ libs:
- src/core/lib/gprpp/single_set_ptr.h
- src/core/lib/gprpp/table.h
- src/core/lib/gprpp/time.h
- src/core/lib/gprpp/unique_type_name.h
- src/core/lib/http/format_request.h
- src/core/lib/http/httpcli.h
- src/core/lib/http/httpcli_ssl_credentials.h
@ -1927,6 +1928,7 @@ libs:
- src/core/lib/gprpp/single_set_ptr.h
- src/core/lib/gprpp/table.h
- src/core/lib/gprpp/time.h
- src/core/lib/gprpp/unique_type_name.h
- src/core/lib/http/format_request.h
- src/core/lib/http/httpcli.h
- src/core/lib/http/parser.h
@ -8493,6 +8495,19 @@ targets:
- absl/types:variant
- absl/utility:utility
uses_polling: false
- name: unique_type_name_test
gtest: true
build: test
language: c++
headers:
- src/core/lib/gpr/useful.h
- src/core/lib/gprpp/unique_type_name.h
src:
- test/core/gprpp/unique_type_name_test.cc
deps:
- absl/strings:str_format
- absl/strings:strings
uses_polling: false
- name: unknown_frame_bad_client_test
gtest: true
build: test

2
gRPC-C++.podspec generated
View File

@ -713,6 +713,7 @@ Pod::Spec.new do |s|
'src/core/lib/gprpp/thd.h',
'src/core/lib/gprpp/time.h',
'src/core/lib/gprpp/time_util.h',
'src/core/lib/gprpp/unique_type_name.h',
'src/core/lib/http/format_request.h',
'src/core/lib/http/httpcli.h',
'src/core/lib/http/httpcli_ssl_credentials.h',
@ -1528,6 +1529,7 @@ Pod::Spec.new do |s|
'src/core/lib/gprpp/thd.h',
'src/core/lib/gprpp/time.h',
'src/core/lib/gprpp/time_util.h',
'src/core/lib/gprpp/unique_type_name.h',
'src/core/lib/http/format_request.h',
'src/core/lib/http/httpcli.h',
'src/core/lib/http/httpcli_ssl_credentials.h',

2
gRPC-Core.podspec generated
View File

@ -1124,6 +1124,7 @@ Pod::Spec.new do |s|
'src/core/lib/gprpp/time.h',
'src/core/lib/gprpp/time_util.cc',
'src/core/lib/gprpp/time_util.h',
'src/core/lib/gprpp/unique_type_name.h',
'src/core/lib/http/format_request.cc',
'src/core/lib/http/format_request.h',
'src/core/lib/http/httpcli.cc',
@ -2127,6 +2128,7 @@ Pod::Spec.new do |s|
'src/core/lib/gprpp/thd.h',
'src/core/lib/gprpp/time.h',
'src/core/lib/gprpp/time_util.h',
'src/core/lib/gprpp/unique_type_name.h',
'src/core/lib/http/format_request.h',
'src/core/lib/http/httpcli.h',
'src/core/lib/http/httpcli_ssl_credentials.h',

1
grpc.gemspec generated
View File

@ -1037,6 +1037,7 @@ Gem::Specification.new do |s|
s.files += %w( src/core/lib/gprpp/time.h )
s.files += %w( src/core/lib/gprpp/time_util.cc )
s.files += %w( src/core/lib/gprpp/time_util.h )
s.files += %w( src/core/lib/gprpp/unique_type_name.h )
s.files += %w( src/core/lib/http/format_request.cc )
s.files += %w( src/core/lib/http/format_request.h )
s.files += %w( src/core/lib/http/httpcli.cc )

1
package.xml generated
View File

@ -1019,6 +1019,7 @@
<file baseinstalldir="/" name="src/core/lib/gprpp/time.h" role="src" />
<file baseinstalldir="/" name="src/core/lib/gprpp/time_util.cc" role="src" />
<file baseinstalldir="/" name="src/core/lib/gprpp/time_util.h" role="src" />
<file baseinstalldir="/" name="src/core/lib/gprpp/unique_type_name.h" role="src" />
<file baseinstalldir="/" name="src/core/lib/http/format_request.cc" role="src" />
<file baseinstalldir="/" name="src/core/lib/http/format_request.h" role="src" />
<file baseinstalldir="/" name="src/core/lib/http/httpcli.cc" role="src" />

14
src/core/ext/filters/client_channel/lb_policy/oob_backend_metric.cc
View File

@ -55,6 +55,7 @@
#include "src/core/lib/gprpp/ref_counted_ptr.h"
#include "src/core/lib/gprpp/sync.h"
#include "src/core/lib/gprpp/time.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/iomgr/closure.h"
#include "src/core/lib/iomgr/error.h"
#include "src/core/lib/iomgr/exec_ctx.h"
@ -68,8 +69,6 @@ namespace {
TraceFlag grpc_orca_client_trace(false, "orca_client");
constexpr char kProducerType[] = "orca";
class OrcaWatcher;
// This producer is registered with a subchannel. It creates a
@ -81,7 +80,12 @@ class OrcaProducer : public Subchannel::DataProducerInterface {
void Orphan() override;
const char* type() override { return kProducerType; }
static UniqueTypeName Type() {
static UniqueTypeName::Factory kFactory("orca");
return kFactory.Create();
}
UniqueTypeName type() const override { return Type(); }
// Adds and removes watchers.
void AddWatcher(OrcaWatcher* watcher);
@ -383,8 +387,8 @@ OrcaWatcher::~OrcaWatcher() {
void OrcaWatcher::SetSubchannel(Subchannel* subchannel) {
// Check if our producer is already registered with the subchannel.
// If not, create a new one, which will register itself with the subchannel.
auto* p =
static_cast<OrcaProducer*>(subchannel->GetDataProducer(kProducerType));
auto* p = static_cast<OrcaProducer*>(
subchannel->GetDataProducer(OrcaProducer::Type()));
if (p != nullptr) producer_ = p->RefIfNonZero();
if (producer_ == nullptr) {
producer_ = MakeRefCounted<OrcaProducer>(subchannel->Ref());

1
src/core/ext/filters/client_channel/lb_policy/xds/cds.cc
View File

@ -55,6 +55,7 @@
#include "src/core/lib/gprpp/orphanable.h"
#include "src/core/lib/gprpp/ref_counted_ptr.h"
#include "src/core/lib/gprpp/time.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/iomgr/error.h"
#include "src/core/lib/iomgr/pollset_set.h"
#include "src/core/lib/iomgr/work_serializer.h"

3
src/core/ext/filters/client_channel/subchannel.cc
View File

@ -25,6 +25,7 @@
#include <cstring>
#include <memory>
#include <new>
#include <type_traits>
#include <utility>
#include "absl/status/statusor.h"
@ -838,7 +839,7 @@ void Subchannel::RemoveDataProducer(DataProducerInterface* data_producer) {
}
Subchannel::DataProducerInterface* Subchannel::GetDataProducer(
const char* type) {
UniqueTypeName type) {
MutexLock lock(&mu_);
auto it = data_producer_map_.find(type);
if (it == data_producer_map_.end()) return nullptr;

7
src/core/ext/filters/client_channel/subchannel.h
View File

@ -46,6 +46,7 @@
#include "src/core/lib/gprpp/ref_counted_ptr.h"
#include "src/core/lib/gprpp/sync.h"
#include "src/core/lib/gprpp/time.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/iomgr/call_combiner.h"
#include "src/core/lib/iomgr/closure.h"
#include "src/core/lib/iomgr/error.h"
@ -217,7 +218,7 @@ class Subchannel : public DualRefCounted<Subchannel> {
// contents for uniqueness; all instances for a given implementation
// are expected to return the same string *instance*, not just the
// same string contents.
virtual const char* type() = 0;
virtual UniqueTypeName type() const = 0;
};
// Creates a subchannel.
@ -292,7 +293,7 @@ class Subchannel : public DualRefCounted<Subchannel> {
ABSL_LOCKS_EXCLUDED(mu_);
void RemoveDataProducer(DataProducerInterface* data_producer)
ABSL_LOCKS_EXCLUDED(mu_);
DataProducerInterface* GetDataProducer(const char* type)
DataProducerInterface* GetDataProducer(UniqueTypeName type)
ABSL_LOCKS_EXCLUDED(mu_);
private:
@ -432,7 +433,7 @@ class Subchannel : public DualRefCounted<Subchannel> {
int keepalive_time_ ABSL_GUARDED_BY(mu_) = -1;
// Data producer map.
std::map<const char* /*type*/, DataProducerInterface*> data_producer_map_
std::map<UniqueTypeName, DataProducerInterface*> data_producer_map_
ABSL_GUARDED_BY(mu_);
};

3
src/core/ext/transport/chttp2/client/chttp2_connector.cc
View File

@ -51,6 +51,7 @@
#include "src/core/lib/debug/trace.h"
#include "src/core/lib/gprpp/debug_location.h"
#include "src/core/lib/gprpp/orphanable.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/iomgr/endpoint.h"
#include "src/core/lib/iomgr/exec_ctx.h"
#include "src/core/lib/iomgr/resolved_address.h"
@ -411,7 +412,7 @@ grpc_channel* grpc_channel_create_from_fd(const char* target, int fd,
(target, fd, creds, args));
// For now, we only support insecure channel credentials.
if (creds == nullptr ||
creds->type() != grpc_core::InsecureServerCredentials::Type()) {
creds->type() != grpc_core::InsecureCredentials::Type()) {
return grpc_lame_client_channel_create(
target, GRPC_STATUS_INTERNAL,
"Failed to create client channel due to invalid creds");

5
src/core/ext/transport/chttp2/server/chttp2_server.cc
View File

@ -62,6 +62,7 @@
#include "src/core/lib/gprpp/ref_counted_ptr.h"
#include "src/core/lib/gprpp/sync.h"
#include "src/core/lib/gprpp/time.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/iomgr/closure.h"
#include "src/core/lib/iomgr/endpoint.h"
#include "src/core/lib/iomgr/iomgr_fwd.h"
@ -1012,7 +1013,7 @@ grpc_channel_args* ModifyArgsForConnection(grpc_channel_args* args,
if (security_connector == nullptr) {
*error = GRPC_ERROR_CREATE_FROM_CPP_STRING(
absl::StrCat("Unable to create secure server with credentials of type ",
server_credentials->type()));
server_credentials->type().name()));
return args;
}
grpc_arg arg_to_add =
@ -1061,7 +1062,7 @@ int grpc_server_add_http2_port(grpc_server* server, const char* addr,
if (sc == nullptr) {
err = GRPC_ERROR_CREATE_FROM_CPP_STRING(absl::StrCat(
"Unable to create secure server with credentials of type ",
creds->type()));
creds->type().name()));
goto done;
}
grpc_arg args_to_add[2];

6
src/core/ext/xds/certificate_provider_store.cc
View File

@ -28,8 +28,10 @@ namespace grpc_core {
// CertificateProviderStore::CertificateProviderWrapper
//
const char* CertificateProviderStore::CertificateProviderWrapper::type() const {
return "Wrapper";
UniqueTypeName CertificateProviderStore::CertificateProviderWrapper::type()
const {
static UniqueTypeName::Factory kFactory("Wrapper");
return kFactory.Create();
}
// If a certificate provider is created, the CertificateProviderStore

2
src/core/ext/xds/certificate_provider_store.h
View File

@ -90,7 +90,7 @@ class CertificateProviderStore
static_cast<const grpc_tls_certificate_provider*>(this), other);
}
const char* type() const override;
UniqueTypeName type() const override;
absl::string_view key() const { return key_; }

5
src/core/ext/xds/xds_certificate_provider.cc
View File

@ -263,7 +263,10 @@ XdsCertificateProvider::~XdsCertificateProvider() {
distributor_->SetWatchStatusCallback(nullptr);
}
const char* XdsCertificateProvider::type() const { return "Xds"; }
UniqueTypeName XdsCertificateProvider::type() const {
static UniqueTypeName::Factory kFactory("Xds");
return kFactory.Create();
}
bool XdsCertificateProvider::ProvidesRootCerts(const std::string& cert_name) {
MutexLock lock(&mu_);

2
src/core/ext/xds/xds_certificate_provider.h
View File

@ -39,7 +39,7 @@ class XdsCertificateProvider : public grpc_tls_certificate_provider {
return distributor_;
}
const char* type() const override;
UniqueTypeName type() const override;
bool ProvidesRootCerts(const std::string& cert_name);
void UpdateRootCertNameAndDistributor(

104
src/core/lib/gprpp/unique_type_name.h Normal file
View File

@ -0,0 +1,104 @@
//
// Copyright 2022 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_GPRPP_UNIQUE_TYPE_NAME_H
#define GRPC_CORE_LIB_GPRPP_UNIQUE_TYPE_NAME_H
#include <grpc/support/port_platform.h>
#include <string>
#include "absl/strings/string_view.h"
#include "src/core/lib/gpr/useful.h"
// Provides a type name that is unique by instance rather than by
// string content. This is useful in cases where there are different
// implementations of a given interface that need to be differentiated from
// each other for down-casting purposes, where it is undesirable to provide
// a registry to avoid name collisions.
//
// Expected usage:
/*
// Interface has a virtual method that returns a UniqueTypeName.
class Interface {
public:
virtual ~Interface() = default;
virtual UniqueTypeName type() const = 0;
};
// Implementation uses a static factory instance to return the same
// UniqueTypeName for every instance.
class FooImplementation : public Interface {
public:
UniqueTypeName type() const override {
static UniqueTypeName::Factory kFactory("Foo");
return kFactory.Create();
}
};
*/
namespace grpc_core {
class UniqueTypeName {
public:
// Factory class. There should be a single static instance of this
// for each unique type name.
class Factory {
public:
explicit Factory(absl::string_view name) : name_(new std::string(name)) {}
Factory(const Factory&) = delete;
Factory& operator=(const Factory&) = delete;
UniqueTypeName Create() { return UniqueTypeName(*name_); }
private:
std::string* name_;
};
// Copyable.
UniqueTypeName(const UniqueTypeName& other) : name_(other.name_) {}
UniqueTypeName& operator=(const UniqueTypeName& other) {
name_ = other.name_;
return *this;
}
bool operator==(const UniqueTypeName& other) const {
return name_.data() == other.name_.data();
}
bool operator!=(const UniqueTypeName& other) const {
return name_.data() != other.name_.data();
}
bool operator<(const UniqueTypeName& other) const {
return name_.data() < other.name_.data();
}
int Compare(const UniqueTypeName& other) const {
return QsortCompare(name_.data(), other.name_.data());
}
absl::string_view name() const { return name_; }
private:
explicit UniqueTypeName(absl::string_view name) : name_(name) {}
absl::string_view name_;
};
} // namespace grpc_core
#endif // GRPC_CORE_LIB_GPRPP_UNIQUE_TYPE_NAME_H

5
src/core/lib/http/httpcli_security_connector.cc
View File

@ -178,7 +178,10 @@ class HttpRequestSSLCredentials : public grpc_channel_credentials {
return Ref();
}
const char* type() const override { return "HttpRequestSSL"; }
UniqueTypeName type() const override {
static UniqueTypeName::Factory kFactory("HttpRequestSSL");
return kFactory.Create();
}
private:
int cmp_impl(const grpc_channel_credentials* /* other */) const override {

10
src/core/lib/security/credentials/alts/alts_credentials.cc
View File

@ -56,7 +56,10 @@ grpc_alts_credentials::create_security_connector(
this->Ref(), std::move(call_creds), target_name);
}
const char* grpc_alts_credentials::type() const { return "Alts"; }
grpc_core::UniqueTypeName grpc_alts_credentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("Alts");
return kFactory.Create();
}
grpc_alts_server_credentials::grpc_alts_server_credentials(
const grpc_alts_credentials_options* options,
@ -79,7 +82,10 @@ grpc_alts_server_credentials::~grpc_alts_server_credentials() {
gpr_free(handshaker_service_url_);
}
const char* grpc_alts_server_credentials::type() const { return "Alts"; }
grpc_core::UniqueTypeName grpc_alts_server_credentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("Alts");
return kFactory.Create();
}
grpc_channel_credentials* grpc_alts_credentials_create_customized(
const grpc_alts_credentials_options* options,

4
src/core/lib/security/credentials/alts/alts_credentials.h
View File

@ -39,7 +39,7 @@ class grpc_alts_credentials final : public grpc_channel_credentials {
const char* target_name, const grpc_channel_args* args,
grpc_channel_args** new_args) override;
const char* type() const override;
grpc_core::UniqueTypeName type() const override;
const grpc_alts_credentials_options* options() const { return options_; }
grpc_alts_credentials_options* mutable_options() { return options_; }
@ -66,7 +66,7 @@ class grpc_alts_server_credentials final : public grpc_server_credentials {
grpc_core::RefCountedPtr<grpc_server_security_connector>
create_security_connector(const grpc_channel_args* /* args */) override;
const char* type() const override;
grpc_core::UniqueTypeName type() const override;
const grpc_alts_credentials_options* options() const { return options_; }
grpc_alts_credentials_options* mutable_options() { return options_; }

10
src/core/lib/security/credentials/composite/composite_credentials.cc
View File

@ -41,8 +41,9 @@
// grpc_composite_channel_credentials
//
const char* grpc_composite_channel_credentials::type() const {
return "Composite";
grpc_core::UniqueTypeName grpc_composite_channel_credentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("Composite");
return kFactory.Create();
}
/* -- Composite call credentials. -- */
@ -60,7 +61,10 @@ grpc_composite_call_credentials::GetRequestMetadata(
});
}
const char* grpc_composite_call_credentials::Type() { return "Composite"; }
grpc_core::UniqueTypeName grpc_composite_call_credentials::Type() {
static grpc_core::UniqueTypeName::Factory kFactory("Composite");
return kFactory.Create();
}
std::string grpc_composite_call_credentials::debug_string() {
std::vector<std::string> outputs;

6
src/core/lib/security/credentials/composite/composite_credentials.h
View File

@ -56,7 +56,7 @@ class grpc_composite_channel_credentials : public grpc_channel_credentials {
return inner_creds_->update_arguments(args);
}
const char* type() const override;
grpc_core::UniqueTypeName type() const override;
const grpc_channel_credentials* inner_creds() const {
return inner_creds_.get();
@ -99,9 +99,9 @@ class grpc_composite_call_credentials : public grpc_call_credentials {
const CallCredentialsList& inner() const { return inner_; }
std::string debug_string() override;
static const char* Type();
static grpc_core::UniqueTypeName Type();
const char* type() const override { return Type(); }
grpc_core::UniqueTypeName type() const override { return Type(); }
private:
int cmp_impl(const grpc_call_credentials* other) const override {

15
src/core/lib/security/credentials/credentials.h
View File

@ -31,6 +31,7 @@
#include "src/core/lib/channel/channel_args.h"
#include "src/core/lib/gprpp/ref_counted.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/iomgr/polling_entity.h"
#include "src/core/lib/promise/arena_promise.h"
#include "src/core/lib/security/context/security_context.h"
@ -139,9 +140,7 @@ struct grpc_channel_credentials
// as equal (assuming other channel args match).
int cmp(const grpc_channel_credentials* other) const {
GPR_ASSERT(other != nullptr);
// Intentionally uses grpc_core::QsortCompare instead of strcmp as a safety
// against different grpc_channel_credentials types using the same name.
int r = grpc_core::QsortCompare(type(), other->type());
int r = type().Compare(other->type());
if (r != 0) return r;
return cmp_impl(other);
}
@ -150,7 +149,7 @@ struct grpc_channel_credentials
// implementation for down-casting purposes. Every creds implementation should
// use a unique string instance, which should be returned by all instances of
// that creds implementation.
virtual const char* type() const = 0;
virtual grpc_core::UniqueTypeName type() const = 0;
private:
// Implementation for `cmp` method intended to be overridden by subclasses.
@ -222,9 +221,7 @@ struct grpc_call_credentials
// credentials as effectively the same..
int cmp(const grpc_call_credentials* other) const {
GPR_ASSERT(other != nullptr);
// Intentionally uses grpc_core::QsortCompare instead of strcmp as a safety
// against different grpc_call_credentials types using the same name.
int r = grpc_core::QsortCompare(type(), other->type());
int r = type().Compare(other->type());
if (r != 0) return r;
return cmp_impl(other);
}
@ -237,7 +234,7 @@ struct grpc_call_credentials
// implementation for down-casting purposes. Every creds implementation should
// use a unique string instance, which should be returned by all instances of
// that creds implementation.
virtual const char* type() const = 0;
virtual grpc_core::UniqueTypeName type() const = 0;
private:
// Implementation for `cmp` method intended to be overridden by subclasses.
@ -266,7 +263,7 @@ struct grpc_server_credentials
virtual grpc_core::RefCountedPtr<grpc_server_security_connector>
create_security_connector(const grpc_channel_args* args) = 0;
virtual const char* type() const = 0;
virtual grpc_core::UniqueTypeName type() const = 0;
const grpc_auth_metadata_processor& auth_metadata_processor() const {
return processor_;

16
src/core/lib/security/credentials/fake/fake_credentials.cc
View File

@ -35,6 +35,7 @@
/* -- Fake transport security credentials. -- */
namespace {
class grpc_fake_channel_credentials final : public grpc_channel_credentials {
public:
grpc_core::RefCountedPtr<grpc_channel_security_connector>
@ -46,7 +47,10 @@ class grpc_fake_channel_credentials final : public grpc_channel_credentials {
this->Ref(), std::move(call_creds), target, args);
}
const char* type() const override { return "Fake"; }
grpc_core::UniqueTypeName type() const override {
static grpc_core::UniqueTypeName::Factory kFactory("Fake");
return kFactory.Create();
}
private:
int cmp_impl(const grpc_channel_credentials* other) const override {
@ -63,7 +67,10 @@ class grpc_fake_server_credentials final : public grpc_server_credentials {
return grpc_fake_server_security_connector_create(this->Ref());
}
const char* type() const override { return "Fake"; }
grpc_core::UniqueTypeName type() const override {
static grpc_core::UniqueTypeName::Factory kFactory("Fake");
return kFactory.Create();
}
};
} // namespace
@ -101,7 +108,10 @@ grpc_md_only_test_credentials::GetRequestMetadata(
return grpc_core::Immediate(std::move(initial_metadata));
}
const char* grpc_md_only_test_credentials::Type() { return "MdOnlyTest"; }
grpc_core::UniqueTypeName grpc_md_only_test_credentials::Type() {
static grpc_core::UniqueTypeName::Factory kFactory("MdOnlyTest");
return kFactory.Create();
}
grpc_call_credentials* grpc_md_only_test_credentials_create(
const char* md_key, const char* md_value) {

4
src/core/lib/security/credentials/fake/fake_credentials.h
View File

@ -70,9 +70,9 @@ class grpc_md_only_test_credentials : public grpc_call_credentials {
std::string debug_string() override { return "MD only Test Credentials"; }
static const char* Type();
static grpc_core::UniqueTypeName Type();
const char* type() const override { return Type(); }
grpc_core::UniqueTypeName type() const override { return Type(); }
private:
int cmp_impl(const grpc_call_credentials* other) const override {

6
src/core/lib/security/credentials/google_default/google_default_credentials.cc
View File

@ -131,8 +131,10 @@ grpc_google_default_channel_credentials::update_arguments(
return args.SetIfUnset(GRPC_ARG_DNS_ENABLE_SRV_QUERIES, true);
}
const char* grpc_google_default_channel_credentials::type() const {
return "GoogleDefault";
grpc_core::UniqueTypeName grpc_google_default_channel_credentials::type()
const {
static grpc_core::UniqueTypeName::Factory kFactory("GoogleDefault");
return kFactory.Create();
}
static void on_metadata_server_detection_http_response(

2
src/core/lib/security/credentials/google_default/google_default_credentials.h
View File

@ -58,7 +58,7 @@ class grpc_google_default_channel_credentials
grpc_core::ChannelArgs update_arguments(grpc_core::ChannelArgs args) override;
const char* type() const override;
grpc_core::UniqueTypeName type() const override;
const grpc_channel_credentials* alts_creds() const {
return alts_creds_.get();

5
src/core/lib/security/credentials/iam/iam_credentials.cc
View File

@ -56,7 +56,10 @@ grpc_google_iam_credentials::grpc_google_iam_credentials(
"GoogleIAMCredentials{Token:%s,AuthoritySelector:%s}",
token != nullptr ? "present" : "absent", authority_selector)) {}
const char* grpc_google_iam_credentials::Type() { return "Iam"; }
grpc_core::UniqueTypeName grpc_google_iam_credentials::Type() {
static grpc_core::UniqueTypeName::Factory kFactory("Iam");
return kFactory.Create();
}
grpc_call_credentials* grpc_google_iam_credentials_create(
const char* token, const char* authority_selector, void* reserved) {

4
src/core/lib/security/credentials/iam/iam_credentials.h
View File

@ -36,9 +36,9 @@ class grpc_google_iam_credentials : public grpc_call_credentials {
std::string debug_string() override { return debug_string_; }
static const char* Type();
static grpc_core::UniqueTypeName Type();
const char* type() const override { return Type(); }
grpc_core::UniqueTypeName type() const override { return Type(); }
private:
int cmp_impl(const grpc_call_credentials* other) const override {

10
src/core/lib/security/credentials/insecure/insecure_credentials.cc
View File

@ -33,7 +33,10 @@ InsecureCredentials::create_security_connector(
Ref(), std::move(request_metadata_creds));
}
const char* InsecureCredentials::Type() { return "Insecure"; }
UniqueTypeName InsecureCredentials::Type() {
static UniqueTypeName::Factory kFactory("Insecure");
return kFactory.Create();
}
int InsecureCredentials::cmp_impl(
const grpc_channel_credentials* /* other */) const {
@ -47,7 +50,10 @@ InsecureServerCredentials::create_security_connector(
return MakeRefCounted<InsecureServerSecurityConnector>(Ref());
}
const char* InsecureServerCredentials::Type() { return "Insecure"; }
UniqueTypeName InsecureServerCredentials::Type() {
static auto* kFactory = new UniqueTypeName::Factory("Insecure");
return kFactory->Create();
}
} // namespace grpc_core

8
src/core/lib/security/credentials/insecure/insecure_credentials.h
View File

@ -34,9 +34,9 @@ class InsecureCredentials final : public grpc_channel_credentials {
const char* /* target_name */, const grpc_channel_args* /* args */,
grpc_channel_args** /* new_args */) override;
static const char* Type();
static UniqueTypeName Type();
const char* type() const override { return Type(); }
UniqueTypeName type() const override { return Type(); }
private:
int cmp_impl(const grpc_channel_credentials* other) const override;
@ -47,9 +47,9 @@ class InsecureServerCredentials final : public grpc_server_credentials {
RefCountedPtr<grpc_server_security_connector> create_security_connector(
const grpc_channel_args* /* args */) override;
static const char* Type();
static UniqueTypeName Type();
const char* type() const override { return Type(); }
UniqueTypeName type() const override { return Type(); }
};
} // namespace grpc_core

5
src/core/lib/security/credentials/jwt/jwt_credentials.cc
View File

@ -118,8 +118,9 @@ grpc_service_account_jwt_access_credentials::
gpr_mu_init(&cache_mu_);
}
const char* grpc_service_account_jwt_access_credentials::Type() {
return "Jwt";
grpc_core::UniqueTypeName grpc_service_account_jwt_access_credentials::Type() {
static grpc_core::UniqueTypeName::Factory kFactory("Jwt");
return kFactory.Create();
}
grpc_core::RefCountedPtr<grpc_call_credentials>

4
src/core/lib/security/credentials/jwt/jwt_credentials.h
View File

@ -52,9 +52,9 @@ class grpc_service_account_jwt_access_credentials
static_cast<int64_t>(gpr_timespec_to_micros(jwt_lifetime_)))));
};
static const char* Type();
static grpc_core::UniqueTypeName Type();
const char* type() const override { return Type(); }
grpc_core::UniqueTypeName type() const override { return Type(); }
private:
int cmp_impl(const grpc_call_credentials* other) const override {

10
src/core/lib/security/credentials/local/local_credentials.cc
View File

@ -36,7 +36,10 @@ grpc_local_credentials::create_security_connector(
this->Ref(), std::move(request_metadata_creds), args, target_name);
}
const char* grpc_local_credentials::type() const { return "Local"; }
grpc_core::UniqueTypeName grpc_local_credentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("Local");
return kFactory.Create();
}
grpc_core::RefCountedPtr<grpc_server_security_connector>
grpc_local_server_credentials::create_security_connector(
@ -44,7 +47,10 @@ grpc_local_server_credentials::create_security_connector(
return grpc_local_server_security_connector_create(this->Ref());
}
const char* grpc_local_server_credentials::type() const { return "Local"; }
grpc_core::UniqueTypeName grpc_local_server_credentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("Local");
return kFactory.Create();
}
grpc_local_credentials::grpc_local_credentials(
grpc_local_connect_type connect_type)

4
src/core/lib/security/credentials/local/local_credentials.h
View File

@ -37,7 +37,7 @@ class grpc_local_credentials final : public grpc_channel_credentials {
const char* target_name, const grpc_channel_args* args,
grpc_channel_args** new_args) override;
const char* type() const override;
grpc_core::UniqueTypeName type() const override;
grpc_local_connect_type connect_type() const { return connect_type_; }
@ -60,7 +60,7 @@ class grpc_local_server_credentials final : public grpc_server_credentials {
grpc_core::RefCountedPtr<grpc_server_security_connector>
create_security_connector(const grpc_channel_args* /* args */) override;
const char* type() const override;
grpc_core::UniqueTypeName type() const override;
grpc_local_connect_type connect_type() const { return connect_type_; }

15
src/core/lib/security/credentials/oauth2/oauth2_credentials.cc
View File

@ -346,8 +346,9 @@ std::string grpc_oauth2_token_fetcher_credentials::debug_string() {
return "OAuth2TokenFetcherCredentials";
}
const char* grpc_oauth2_token_fetcher_credentials::type() const {
return "Oauth2";
grpc_core::UniqueTypeName grpc_oauth2_token_fetcher_credentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("Oauth2");
return kFactory.Create();
}
//
@ -475,8 +476,9 @@ std::string grpc_google_refresh_token_credentials::debug_string() {
grpc_oauth2_token_fetcher_credentials::debug_string());
}
const char* grpc_google_refresh_token_credentials::type() const {
return "GoogleRefreshToken";
grpc_core::UniqueTypeName grpc_google_refresh_token_credentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("GoogleRefreshToken");
return kFactory.Create();
}
static std::string create_loggable_refresh_token(
@ -712,7 +714,10 @@ grpc_access_token_credentials::GetRequestMetadata(
return grpc_core::Immediate(std::move(initial_metadata));
}
const char* grpc_access_token_credentials::Type() { return "AccessToken"; }
grpc_core::UniqueTypeName grpc_access_token_credentials::Type() {
static grpc_core::UniqueTypeName::Factory kFactory("AccessToken");
return kFactory.Create();
}
grpc_access_token_credentials::grpc_access_token_credentials(
const char* access_token)

8
src/core/lib/security/credentials/oauth2/oauth2_credentials.h
View File

@ -102,7 +102,7 @@ class grpc_oauth2_token_fetcher_credentials : public grpc_call_credentials {
grpc_error_handle error);
std::string debug_string() override;
const char* type() const override;
grpc_core::UniqueTypeName type() const override;
protected:
virtual void fetch_oauth2(grpc_credentials_metadata_request* req,
@ -138,7 +138,7 @@ class grpc_google_refresh_token_credentials final
std::string debug_string() override;
const char* type() const override;
grpc_core::UniqueTypeName type() const override;
protected:
void fetch_oauth2(grpc_credentials_metadata_request* req,
@ -162,9 +162,9 @@ class grpc_access_token_credentials final : public grpc_call_credentials {
std::string debug_string() override;
static const char* Type();
static grpc_core::UniqueTypeName Type();
const char* type() const override { return Type(); }
grpc_core::UniqueTypeName type() const override { return Type(); }
private:
int cmp_impl(const grpc_call_credentials* other) const override {

5
src/core/lib/security/credentials/plugin/plugin_credentials.cc
View File

@ -60,7 +60,10 @@ std::string grpc_plugin_credentials::debug_string() {
return debug_str;
}
const char* grpc_plugin_credentials::type() const { return "Plugin"; }
grpc_core::UniqueTypeName grpc_plugin_credentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("Plugin");
return kFactory.Create();
}
absl::StatusOr<grpc_core::ClientMetadataHandle>
grpc_plugin_credentials::PendingRequest::ProcessPluginResult(

2
src/core/lib/security/credentials/plugin/plugin_credentials.h
View File

@ -41,7 +41,7 @@ struct grpc_plugin_credentials final : public grpc_call_credentials {
std::string debug_string() override;
const char* type() const override;
grpc_core::UniqueTypeName type() const override;
private:
class PendingRequest : public grpc_core::RefCounted<PendingRequest> {

10
src/core/lib/security/credentials/ssl/ssl_credentials.cc
View File

@ -82,7 +82,10 @@ grpc_ssl_credentials::create_security_connector(
return sc;
}
const char* grpc_ssl_credentials::Type() { return "Ssl"; }
grpc_core::UniqueTypeName grpc_ssl_credentials::Type() {
static grpc_core::UniqueTypeName::Factory kFactory("Ssl");
return kFactory.Create();
}
void grpc_ssl_credentials::build_config(
const char* pem_root_certs, grpc_ssl_pem_key_cert_pair* pem_key_cert_pair,
@ -186,7 +189,10 @@ grpc_ssl_server_credentials::create_security_connector(
return grpc_ssl_server_security_connector_create(this->Ref());
}
const char* grpc_ssl_server_credentials::Type() { return "Ssl"; }
grpc_core::UniqueTypeName grpc_ssl_server_credentials::Type() {
static grpc_core::UniqueTypeName::Factory kFactory("Ssl");
return kFactory.Create();
}
tsi_ssl_pem_key_cert_pair* grpc_convert_grpc_to_tsi_cert_pairs(
const grpc_ssl_pem_key_cert_pair* pem_key_cert_pairs,

8
src/core/lib/security/credentials/ssl/ssl_credentials.h
View File

@ -37,9 +37,9 @@ class grpc_ssl_credentials : public grpc_channel_credentials {
const char* target, const grpc_channel_args* args,
grpc_channel_args** new_args) override;
static const char* Type();
static grpc_core::UniqueTypeName Type();
const char* type() const override { return Type(); }
grpc_core::UniqueTypeName type() const override { return Type(); }
// TODO(mattstev): Plumb to wrapped languages. Until then, setting the TLS
// version should be done for testing purposes only.
@ -80,9 +80,9 @@ class grpc_ssl_server_credentials final : public grpc_server_credentials {
grpc_core::RefCountedPtr<grpc_server_security_connector>
create_security_connector(const grpc_channel_args* /* args */) override;
static const char* Type();
static grpc_core::UniqueTypeName Type();
const char* type() const override { return Type(); }
grpc_core::UniqueTypeName type() const override { return Type(); }
bool has_cert_config_fetcher() const {
return certificate_config_fetcher_.cb != nullptr;

10
src/core/lib/security/credentials/tls/grpc_tls_certificate_provider.cc
View File

@ -85,6 +85,11 @@ StaticDataCertificateProvider::~StaticDataCertificateProvider() {
distributor_->SetWatchStatusCallback(nullptr);
}
UniqueTypeName StaticDataCertificateProvider::type() const {
static UniqueTypeName::Factory kFactory("StaticData");
return kFactory.Create();
}
namespace {
gpr_timespec TimeoutSecondsToDeadline(int64_t seconds) {
@ -177,6 +182,11 @@ FileWatcherCertificateProvider::~FileWatcherCertificateProvider() {
refresh_thread_.Join();
}
UniqueTypeName FileWatcherCertificateProvider::type() const {
static UniqueTypeName::Factory kFactory("FileWatcher");
return kFactory.Create();
}
void FileWatcherCertificateProvider::ForceUpdate() {
absl::optional<std::string> root_certificate;
absl::optional<PemKeyCertPairList> pem_key_cert_pairs;

12
src/core/lib/security/credentials/tls/grpc_tls_certificate_provider.h
View File

@ -30,6 +30,7 @@
#include "src/core/lib/gprpp/ref_counted.h"
#include "src/core/lib/gprpp/ref_counted_ptr.h"
#include "src/core/lib/gprpp/thd.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/iomgr/load_file.h"
#include "src/core/lib/iomgr/pollset_set.h"
#include "src/core/lib/security/credentials/tls/grpc_tls_certificate_distributor.h"
@ -62,10 +63,7 @@ struct grpc_tls_certificate_provider
// used but they compare as equal (assuming other channel args match).
int Compare(const grpc_tls_certificate_provider* other) const {
GPR_ASSERT(other != nullptr);
// Intentionally uses grpc_core::QsortCompare instead of strcmp as a safety
// against different grpc_tls_certificate_provider types using the same
// name.
int r = grpc_core::QsortCompare(type(), other->type());
int r = type().Compare(other->type());
if (r != 0) return r;
return CompareImpl(other);
}
@ -74,7 +72,7 @@ struct grpc_tls_certificate_provider
// implementation for down-casting purposes. Every provider implementation
// should use a unique string instance, which should be returned by all
// instances of that provider implementation.
virtual const char* type() const = 0;
virtual grpc_core::UniqueTypeName type() const = 0;
private:
// Implementation for `Compare` method intended to be overridden by
@ -99,7 +97,7 @@ class StaticDataCertificateProvider final
return distributor_;
}
const char* type() const override { return "StaticData"; }
UniqueTypeName type() const override;
private:
struct WatcherInfo {
@ -138,7 +136,7 @@ class FileWatcherCertificateProvider final
return distributor_;
}
const char* type() const override { return "FileWatcher"; }
UniqueTypeName type() const override;
private:
struct WatcherInfo {

19
src/core/lib/security/credentials/tls/grpc_tls_certificate_verifier.cc
View File

@ -60,6 +60,11 @@ bool ExternalCertificateVerifier::Verify(
return is_done;
}
UniqueTypeName ExternalCertificateVerifier::type() const {
static UniqueTypeName::Factory kFactory("External");
return kFactory.Create();
}
void ExternalCertificateVerifier::OnVerifyDone(
grpc_tls_custom_verification_check_request* request, void* callback_arg,
grpc_status_code status, const char* error_details) {
@ -84,6 +89,15 @@ void ExternalCertificateVerifier::OnVerifyDone(
}
}
//
// NoOpCertificateVerifier
//
UniqueTypeName NoOpCertificateVerifier::type() const {
static UniqueTypeName::Factory kFactory("NoOp");
return kFactory.Create();
}
//
// HostNameCertificateVerifier
//
@ -152,6 +166,11 @@ bool HostNameCertificateVerifier::Verify(
return true; // synchronous check
}
UniqueTypeName HostNameCertificateVerifier::type() const {
static UniqueTypeName::Factory kFactory("Hostname");
return kFactory.Create();
}
} // namespace grpc_core
//

11
src/core/lib/security/credentials/tls/grpc_tls_certificate_verifier.h
View File

@ -29,6 +29,7 @@
#include "src/core/lib/gprpp/ref_counted.h"
#include "src/core/lib/gprpp/ref_counted_ptr.h"
#include "src/core/lib/gprpp/thd.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/iomgr/load_file.h"
#include "src/core/lib/iomgr/pollset_set.h"
#include "src/core/lib/security/credentials/tls/grpc_tls_certificate_distributor.h"
@ -57,7 +58,7 @@ struct grpc_tls_certificate_verifier
// verifiers as effectively the same.
int Compare(const grpc_tls_certificate_verifier* other) const {
GPR_ASSERT(other != nullptr);
int r = grpc_core::QsortCompare(type(), other->type());
int r = type().Compare(other->type());
if (r != 0) return r;
return CompareImpl(other);
}
@ -66,7 +67,7 @@ struct grpc_tls_certificate_verifier
// implementation for down-casting purposes. Every verifier implementation
// should use a unique string instance, which should be returned by all
// instances of that verifier implementation.
virtual const char* type() const = 0;
virtual grpc_core::UniqueTypeName type() const = 0;
private:
// Implementation for `Compare` method intended to be overridden by
@ -99,7 +100,7 @@ class ExternalCertificateVerifier : public grpc_tls_certificate_verifier {
external_verifier_->cancel(external_verifier_->user_data, request);
}
const char* type() const override { return "External"; }
UniqueTypeName type() const override;
private:
int CompareImpl(const grpc_tls_certificate_verifier* other) const override {
@ -133,7 +134,7 @@ class NoOpCertificateVerifier : public grpc_tls_certificate_verifier {
};
void Cancel(grpc_tls_custom_verification_check_request*) override {}
const char* type() const override { return "NoOp"; }
UniqueTypeName type() const override;
private:
int CompareImpl(
@ -152,7 +153,7 @@ class HostNameCertificateVerifier : public grpc_tls_certificate_verifier {
absl::Status* sync_status) override;
void Cancel(grpc_tls_custom_verification_check_request*) override {}
const char* type() const override { return "Hostname"; }
UniqueTypeName type() const override;
private:
int CompareImpl(

10
src/core/lib/security/credentials/tls/tls_credentials.cc
View File

@ -106,6 +106,11 @@ TlsCredentials::create_security_connector(
return sc;
}
grpc_core::UniqueTypeName TlsCredentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("Tls");
return kFactory.Create();
}
int TlsCredentials::cmp_impl(const grpc_channel_credentials* other) const {
const TlsCredentials* o = static_cast<const TlsCredentials*>(other);
if (*options_ == *o->options_) return 0;
@ -126,6 +131,11 @@ TlsServerCredentials::create_security_connector(
CreateTlsServerSecurityConnector(this->Ref(), options_);
}
grpc_core::UniqueTypeName TlsServerCredentials::type() const {
static grpc_core::UniqueTypeName::Factory kFactory("Tls");
return kFactory.Create();
}
/** -- Wrapper APIs declared in grpc_security.h -- **/
grpc_channel_credentials* grpc_tls_credentials_create(

4
src/core/lib/security/credentials/tls/tls_credentials.h
View File

@ -38,7 +38,7 @@ class TlsCredentials final : public grpc_channel_credentials {
const char* target_name, const grpc_channel_args* args,
grpc_channel_args** new_args) override;
const char* type() const override { return "Tls"; }
grpc_core::UniqueTypeName type() const override;
grpc_tls_credentials_options* options() const { return options_.get(); }
@ -57,7 +57,7 @@ class TlsServerCredentials final : public grpc_server_credentials {
grpc_core::RefCountedPtr<grpc_server_security_connector>
create_security_connector(const grpc_channel_args* /* args */) override;
const char* type() const override { return "Tls"; }
grpc_core::UniqueTypeName type() const override;
grpc_tls_credentials_options* options() const { return options_.get(); }

15
src/core/lib/security/credentials/xds/xds_credentials.cc
View File

@ -105,7 +105,10 @@ int XdsCertificateVerifier::CompareImpl(
return cluster_name_.compare(o->cluster_name_);
}
const char* XdsCertificateVerifier::type() const { return "Xds"; }
UniqueTypeName XdsCertificateVerifier::type() const {
static UniqueTypeName::Factory kFactory("Xds");
return kFactory.Create();
}
bool TestOnlyXdsVerifySubjectAlternativeNames(
const char* const* subject_alternative_names,
@ -182,7 +185,10 @@ XdsCredentials::create_security_connector(
std::move(call_creds), target_name, temp_args.args, new_args);
}
const char* XdsCredentials::Type() { return "Xds"; }
UniqueTypeName XdsCredentials::Type() {
static UniqueTypeName::Factory kFactory("Xds");
return kFactory.Create();
}
//
// XdsServerCredentials
@ -220,7 +226,10 @@ XdsServerCredentials::create_security_connector(const grpc_channel_args* args) {
return fallback_credentials_->create_security_connector(args);
}
const char* XdsServerCredentials::Type() { return "Xds"; }
UniqueTypeName XdsServerCredentials::Type() {
static UniqueTypeName::Factory kFactory("Xds");
return kFactory.Create();
}
} // namespace grpc_core

10
src/core/lib/security/credentials/xds/xds_credentials.h
View File

@ -41,7 +41,7 @@ class XdsCertificateVerifier : public grpc_tls_certificate_verifier {
absl::Status* sync_status) override;
void Cancel(grpc_tls_custom_verification_check_request*) override;
const char* type() const override;
UniqueTypeName type() const override;
private:
int CompareImpl(const grpc_tls_certificate_verifier* other) const override;
@ -60,9 +60,9 @@ class XdsCredentials final : public grpc_channel_credentials {
RefCountedPtr<grpc_call_credentials> call_creds, const char* target_name,
const grpc_channel_args* args, grpc_channel_args** new_args) override;
static const char* Type();
static UniqueTypeName Type();
const char* type() const override { return Type(); }
UniqueTypeName type() const override { return Type(); }
private:
int cmp_impl(const grpc_channel_credentials* other) const override {
@ -82,9 +82,9 @@ class XdsServerCredentials final : public grpc_server_credentials {
RefCountedPtr<grpc_server_security_connector> create_security_connector(
const grpc_channel_args* /* args */) override;
static const char* Type();
static UniqueTypeName Type();
const char* type() const override { return Type(); }
UniqueTypeName type() const override { return Type(); }
private:
RefCountedPtr<grpc_server_credentials> fallback_credentials_;

16
test/core/gprpp/BUILD
View File

@ -358,3 +358,19 @@ grpc_cc_test(
"//test/core/util:grpc_suppressions",
],
)
grpc_cc_test(
name = "unique_type_name_test",
srcs = ["unique_type_name_test.cc"],
external_deps = [
"gtest",
"absl/strings:str_format",
],
language = "c++",
uses_event_engine = False,
uses_polling = False,
deps = [
"//:unique_type_name",
"//test/core/util:grpc_suppressions",
],
)

100
test/core/gprpp/unique_type_name_test.cc Normal file
View File

@ -0,0 +1,100 @@
// Copyright 2022 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 "src/core/lib/gprpp/unique_type_name.h"
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include "absl/strings/str_format.h"
namespace grpc_core {
// Teach gtest to print names usefully.
std::ostream& operator<<(std::ostream& os, const UniqueTypeName& name) {
return os << absl::StrFormat("%s (%p)", name.name(), name.name().data());
}
namespace {
class Interface {
public:
virtual ~Interface() = default;
virtual UniqueTypeName type() const = 0;
};
class Foo : public Interface {
public:
UniqueTypeName type() const override {
static UniqueTypeName::Factory kFactory("Foo");
return kFactory.Create();
}
};
class Bar : public Interface {
public:
UniqueTypeName type() const override {
static UniqueTypeName::Factory kFactory("Bar");
return kFactory.Create();
}
};
// Uses the same string as Foo.
class Foo2 : public Interface {
public:
UniqueTypeName type() const override {
static UniqueTypeName::Factory kFactory("Foo");
return kFactory.Create();
}
};
TEST(UniqueTypeNameTest, MultipleInstancesShareName) {
Foo foo1;
Foo foo2;
EXPECT_EQ(foo1.type(), foo2.type());
EXPECT_EQ(0, foo1.type().Compare(foo2.type()));
}
TEST(UniqueTypeNameTest, DifferentImplsDoNotShareName) {
Foo foo;
Bar bar;
EXPECT_NE(foo.type(), bar.type());
EXPECT_NE(0, foo.type().Compare(bar.type()));
}
TEST(UniqueTypeNameTest, MultipleInstancesOfSameStringAreNotEqual) {
Foo foo1;
Foo2 foo2;
EXPECT_NE(foo1.type(), foo2.type());
EXPECT_NE(0, foo1.type().Compare(foo2.type()));
}
TEST(UniqueTypeNameTest, CanUseAsMapKey) {
Foo foo;
Bar bar;
std::map<UniqueTypeName, int> m;
m[foo.type()] = 1;
m[bar.type()] = 2;
EXPECT_THAT(m,
::testing::UnorderedElementsAre(::testing::Pair(foo.type(), 1),
::testing::Pair(bar.type(), 2)));
}
} // namespace
} // namespace grpc_core
int main(int argc, char** argv) {
::testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}

34
test/core/security/credentials_test.cc
View File

@ -45,6 +45,7 @@
#include "src/core/lib/gpr/tmpfile.h"
#include "src/core/lib/gprpp/host_port.h"
#include "src/core/lib/gprpp/time.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/http/httpcli.h"
#include "src/core/lib/http/httpcli_ssl_credentials.h"
#include "src/core/lib/iomgr/error.h"
@ -432,8 +433,6 @@ TEST(CredentialsTest, TestOauth2TokenFetcherCredsParsingMissingTokenLifetime) {
grpc_http_response_destroy(&response);
}
namespace {
class RequestMetadataState : public RefCounted<RequestMetadataState> {
public:
static RefCountedPtr<RequestMetadataState> NewInstance(
@ -548,8 +547,6 @@ class RequestMetadataState : public RefCounted<RequestMetadataState> {
ActivityPtr activity_;
};
} // namespace
TEST(CredentialsTest, TestGoogleIamCreds) {
ExecCtx exec_ctx;
auto state = RequestMetadataState::NewInstance(
@ -574,7 +571,7 @@ TEST(CredentialsTest, TestAccessTokenCreds) {
"authorization: Bearer blah");
grpc_call_credentials* creds =
grpc_access_token_credentials_create("blah", nullptr);
GPR_ASSERT(strcmp(creds->type(), grpc_access_token_credentials::Type()) == 0);
GPR_ASSERT(creds->type() == grpc_access_token_credentials::Type());
/* Check security level. */
GPR_ASSERT(creds->min_security_level() == GRPC_PRIVACY_AND_INTEGRITY);
state->RunRequestMetadataTest(creds, kTestUrlScheme, kTestAuthority,
@ -582,20 +579,24 @@ TEST(CredentialsTest, TestAccessTokenCreds) {
creds->Unref();
}
namespace {
class check_channel_oauth2 final : public grpc_channel_credentials {
public:
RefCountedPtr<grpc_channel_security_connector> create_security_connector(
RefCountedPtr<grpc_call_credentials> call_creds, const char* /*target*/,
const grpc_channel_args* /*args*/,
grpc_channel_args** /*new_args*/) override {
GPR_ASSERT(strcmp(type(), "check_channel_oauth2") == 0);
GPR_ASSERT(type() == Type());
GPR_ASSERT(call_creds != nullptr);
GPR_ASSERT(call_creds->type() == grpc_access_token_credentials::Type());
return nullptr;
}
const char* type() const override { return "check_channel_oauth2"; }
static UniqueTypeName Type() {
static UniqueTypeName::Factory kFactory("check_channel_oauth2");
return kFactory.Create();
}
UniqueTypeName type() const override { return Type(); }
private:
int cmp_impl(const grpc_channel_credentials* other) const override {
@ -604,7 +605,6 @@ class check_channel_oauth2 final : public grpc_channel_credentials {
other);
}
};
} // namespace
TEST(CredentialsTest, TestChannelOauth2CompositeCreds) {
ExecCtx exec_ctx;
@ -663,14 +663,13 @@ TEST(CredentialsTest, TestOauth2GoogleIamCompositeCreds) {
composite_creds->Unref();
}
namespace {
class check_channel_oauth2_google_iam final : public grpc_channel_credentials {
public:
RefCountedPtr<grpc_channel_security_connector> create_security_connector(
RefCountedPtr<grpc_call_credentials> call_creds, const char* /*target*/,
const grpc_channel_args* /*args*/,
grpc_channel_args** /*new_args*/) override {
GPR_ASSERT(strcmp(type(), "check_channel_oauth2_google_iam") == 0);
GPR_ASSERT(type() == Type());
GPR_ASSERT(call_creds != nullptr);
GPR_ASSERT(call_creds->type() == grpc_composite_call_credentials::Type());
const grpc_composite_call_credentials::CallCredentialsList& creds_list =
@ -681,10 +680,13 @@ class check_channel_oauth2_google_iam final : public grpc_channel_credentials {
return nullptr;
}
const char* type() const override {
return "check_channel_oauth2_google_iam";
static UniqueTypeName Type() {
static UniqueTypeName::Factory kFactory("check_channel_oauth2_google_iam");
return kFactory.Create();
}
UniqueTypeName type() const override { return Type(); }
private:
int cmp_impl(const grpc_channel_credentials* other) const override {
// TODO(yashykt): Check if we can do something better here
@ -692,7 +694,6 @@ class check_channel_oauth2_google_iam final : public grpc_channel_credentials {
other);
}
};
} // namespace
TEST(CredentialsTest, TestChannelOauth2GoogleIamCompositeCreds) {
ExecCtx exec_ctx;
@ -1813,7 +1814,10 @@ struct fake_call_creds : public grpc_call_credentials {
return Immediate(std::move(initial_metadata));
}
const char* type() const override { return "fake"; }
UniqueTypeName type() const override {
static UniqueTypeName::Factory kFactory("fake");
return kFactory.Create();
}
private:
int cmp_impl(const grpc_call_credentials* other) const override {

6
test/core/security/tls_security_connector_test.cc
View File

@ -28,6 +28,7 @@
#include <grpc/support/log.h>
#include <grpc/support/string_util.h>
#include "src/core/lib/gprpp/unique_type_name.h"
#include "src/core/lib/iomgr/load_file.h"
#include "src/core/lib/security/credentials/tls/grpc_tls_certificate_provider.h"
#include "src/core/lib/security/credentials/tls/tls_credentials.h"
@ -120,7 +121,10 @@ class TlsTestCertificateProvider : public grpc_tls_certificate_provider {
return distributor_;
}
const char* type() const override { return "tls_test"; }
UniqueTypeName type() const override {
static UniqueTypeName::Factory kFactory("tls_test");
return kFactory.Create();
}
private:
int CompareImpl(const grpc_tls_certificate_provider* other) const override {

6
test/core/xds/certificate_provider_store_test.cc
View File

@ -23,6 +23,7 @@
#include <gmock/gmock.h>
#include "src/core/ext/xds/certificate_provider_registry.h"
#include "src/core/lib/gprpp/unique_type_name.h"
#include "test/core/util/test_config.h"
namespace grpc_core {
@ -44,7 +45,10 @@ class FakeCertificateProvider : public grpc_tls_certificate_provider {
return nullptr;
}
const char* type() const override { return "fake"; }
UniqueTypeName type() const override {
static UniqueTypeName::Factory kFactory("fake");
return kFactory.Create();
}
private:
int CompareImpl(const grpc_tls_certificate_provider* other) const override {

5
test/cpp/end2end/xds/xds_end2end_test.cc
View File

@ -200,7 +200,10 @@ class FakeCertificateProvider final : public grpc_tls_certificate_provider {
return distributor_;
}
const char* type() const override { return "fake"; }
grpc_core::UniqueTypeName type() const override {
static grpc_core::UniqueTypeName::Factory kFactory("fake");
return kFactory.Create();
}
private:
int CompareImpl(const grpc_tls_certificate_provider* other) const override {

1
tools/doxygen/Doxyfile.c++.internal generated
View File

@ -2020,6 +2020,7 @@ src/core/lib/gprpp/time.cc \
src/core/lib/gprpp/time.h \
src/core/lib/gprpp/time_util.cc \
src/core/lib/gprpp/time_util.h \
src/core/lib/gprpp/unique_type_name.h \
src/core/lib/http/format_request.cc \
src/core/lib/http/format_request.h \
src/core/lib/http/httpcli.cc \

1
tools/doxygen/Doxyfile.core.internal generated
View File

@ -1813,6 +1813,7 @@ src/core/lib/gprpp/time.cc \
src/core/lib/gprpp/time.h \
src/core/lib/gprpp/time_util.cc \
src/core/lib/gprpp/time_util.h \
src/core/lib/gprpp/unique_type_name.h \
src/core/lib/http/format_request.cc \
src/core/lib/http/format_request.h \
src/core/lib/http/httpcli.cc \

24
tools/run_tests/generated/tests.json generated
View File

@ -7427,6 +7427,30 @@
],
"uses_polling": false
},
{
"args": [],
"benchmark": false,
"ci_platforms": [
"linux",
"mac",
"posix",
"windows"
],
"cpu_cost": 1.0,
"exclude_configs": [],
"exclude_iomgrs": [],
"flaky": false,
"gtest": true,
"language": "c++",
"name": "unique_type_name_test",
"platforms": [
"linux",
"mac",
"posix",
"windows"
],
"uses_polling": false
},
{
"args": [],
"benchmark": false,