mirror of https://github.com/grpc/grpc.git
Merge pull request #24408 from yashykt/castore
Certificate Provider Store implementationpull/24513/head
Yash Tibrewal
4 years ago
committed by
GitHub
commit
cf26660f44
20 changed files with 403 additions and 23 deletions
@ -0,0 +1,84 @@ |
||||
//
|
||||
//
|
||||
// Copyright 2020 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/ext/xds/certificate_provider_store.h" |
||||
|
||||
#include "src/core/ext/xds/certificate_provider_registry.h" |
||||
|
||||
namespace grpc_core { |
||||
|
||||
// If a certificate provider is created, the CertificateProviderStore
|
||||
// maintains a raw pointer to the created CertificateProviderWrapper so that
|
||||
// future calls to `CreateOrGetCertificateProvider()` with the same key result
|
||||
// in returning a ref to this created certificate provider. This entry is
|
||||
// deleted when the refcount to this provider reaches zero.
|
||||
RefCountedPtr<grpc_tls_certificate_provider> |
||||
CertificateProviderStore::CreateOrGetCertificateProvider( |
||||
absl::string_view key) { |
||||
RefCountedPtr<CertificateProviderWrapper> result; |
||||
MutexLock lock(&mu_); |
||||
auto it = certificate_providers_map_.find(key); |
||||
if (it == certificate_providers_map_.end()) { |
||||
it = certificate_providers_map_.insert({key, nullptr}).first; |
||||
} else { |
||||
result = it->second->RefIfNonZero(); |
||||
} |
||||
if (result == nullptr) { |
||||
result = CreateCertificateProviderLocked(key); |
||||
it->second = result.get(); |
||||
} |
||||
return result; |
||||
} |
||||
|
||||
RefCountedPtr<CertificateProviderStore::CertificateProviderWrapper> |
||||
CertificateProviderStore::CreateCertificateProviderLocked( |
||||
absl::string_view key) { |
||||
auto plugin_config_it = plugin_config_map_.find(std::string(key)); |
||||
if (plugin_config_it == plugin_config_map_.end()) { |
||||
return nullptr; |
||||
} |
||||
CertificateProviderFactory* factory = |
||||
CertificateProviderRegistry::LookupCertificateProviderFactory( |
||||
plugin_config_it->second.plugin_name); |
||||
if (factory == nullptr) { |
||||
// This should never happen since an entry is only inserted in the
|
||||
// plugin_config_map_ if the corresponding factory was found when parsing
|
||||
// the xDS bootstrap file.
|
||||
gpr_log(GPR_ERROR, "Certificate provider factory %s not found", |
||||
plugin_config_it->second.plugin_name.c_str()); |
||||
return nullptr; |
||||
} |
||||
return MakeRefCounted<CertificateProviderWrapper>( |
||||
factory->CreateCertificateProvider(plugin_config_it->second.config), this, |
||||
plugin_config_it->first); |
||||
} |
||||
|
||||
void CertificateProviderStore::ReleaseCertificateProvider( |
||||
absl::string_view key, CertificateProviderWrapper* wrapper) { |
||||
MutexLock lock(&mu_); |
||||
auto it = certificate_providers_map_.find(key); |
||||
if (it != certificate_providers_map_.end()) { |
||||
if (it->second == wrapper) { |
||||
certificate_providers_map_.erase(it); |
||||
} |
||||
} |
||||
} |
||||
|
||||
} // namespace grpc_core
|
||||
@ -0,0 +1,164 @@ |
||||
//
|
||||
//
|
||||
// Copyright 2020 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 <thread> |
||||
|
||||
#include <gmock/gmock.h> |
||||
|
||||
#include "src/core/ext/xds/certificate_provider_registry.h" |
||||
#include "src/core/ext/xds/certificate_provider_store.h" |
||||
|
||||
#include "test/core/util/test_config.h" |
||||
|
||||
namespace grpc_core { |
||||
namespace testing { |
||||
namespace { |
||||
|
||||
class CertificateProviderStoreTest : public ::testing::Test { |
||||
public: |
||||
CertificateProviderStoreTest() { grpc_init(); } |
||||
|
||||
~CertificateProviderStoreTest() override { grpc_shutdown_blocking(); } |
||||
}; |
||||
|
||||
class FakeCertificateProvider : public grpc_tls_certificate_provider { |
||||
public: |
||||
RefCountedPtr<grpc_tls_certificate_distributor> distributor() const override { |
||||
// never called
|
||||
GPR_ASSERT(0); |
||||
return nullptr; |
||||
} |
||||
}; |
||||
|
||||
class FakeCertificateProviderFactory1 : public CertificateProviderFactory { |
||||
public: |
||||
class Config : public CertificateProviderFactory::Config { |
||||
public: |
||||
const char* name() const override { return "fake1"; } |
||||
}; |
||||
|
||||
const char* name() const override { return "fake1"; } |
||||
|
||||
RefCountedPtr<CertificateProviderFactory::Config> |
||||
CreateCertificateProviderConfig(const Json& config_json, |
||||
grpc_error** error) override { |
||||
return MakeRefCounted<Config>(); |
||||
} |
||||
|
||||
RefCountedPtr<grpc_tls_certificate_provider> CreateCertificateProvider( |
||||
RefCountedPtr<CertificateProviderFactory::Config> config) override { |
||||
return MakeRefCounted<FakeCertificateProvider>(); |
||||
} |
||||
}; |
||||
|
||||
class FakeCertificateProviderFactory2 : public CertificateProviderFactory { |
||||
public: |
||||
class Config : public CertificateProviderFactory::Config { |
||||
public: |
||||
const char* name() const override { return "fake2"; } |
||||
}; |
||||
|
||||
const char* name() const override { return "fake2"; } |
||||
|
||||
RefCountedPtr<CertificateProviderFactory::Config> |
||||
CreateCertificateProviderConfig(const Json& config_json, |
||||
grpc_error** error) override { |
||||
return MakeRefCounted<Config>(); |
||||
} |
||||
|
||||
RefCountedPtr<grpc_tls_certificate_provider> CreateCertificateProvider( |
||||
RefCountedPtr<CertificateProviderFactory::Config> config) override { |
||||
return MakeRefCounted<FakeCertificateProvider>(); |
||||
} |
||||
}; |
||||
|
||||
TEST_F(CertificateProviderStoreTest, Basic) { |
||||
// Set up factories. (Register only one of the factories.)
|
||||
auto* fake_factory_1 = new FakeCertificateProviderFactory1; |
||||
CertificateProviderRegistry::RegisterCertificateProviderFactory( |
||||
std::unique_ptr<CertificateProviderFactory>(fake_factory_1)); |
||||
auto fake_factory_2 = absl::make_unique<FakeCertificateProviderFactory2>(); |
||||
// Set up store
|
||||
CertificateProviderStore::PluginDefinitionMap map = { |
||||
{"fake_plugin_1", |
||||
{"fake1", fake_factory_1->CreateCertificateProviderConfig(Json::Object(), |
||||
nullptr)}}, |
||||
{"fake_plugin_2", |
||||
{"fake2", fake_factory_2->CreateCertificateProviderConfig(Json::Object(), |
||||
nullptr)}}, |
||||
{"fake_plugin_3", |
||||
{"fake1", fake_factory_1->CreateCertificateProviderConfig(Json::Object(), |
||||
nullptr)}}, |
||||
}; |
||||
CertificateProviderStore store(std::move(map)); |
||||
// Test for creating certificate providers with known plugin configuration.
|
||||
auto cert_provider_1 = store.CreateOrGetCertificateProvider("fake_plugin_1"); |
||||
ASSERT_NE(cert_provider_1, nullptr); |
||||
auto cert_provider_3 = store.CreateOrGetCertificateProvider("fake_plugin_3"); |
||||
ASSERT_NE(cert_provider_3, nullptr); |
||||
// Test for creating certificate provider with known plugin configuration but
|
||||
// unregistered factory.
|
||||
ASSERT_EQ(store.CreateOrGetCertificateProvider("fake_plugin_2"), nullptr); |
||||
// Test for creating certificate provider with unknown plugin configuration.
|
||||
ASSERT_EQ(store.CreateOrGetCertificateProvider("unknown"), nullptr); |
||||
// Test for getting previously created certificate providers.
|
||||
ASSERT_EQ(store.CreateOrGetCertificateProvider("fake_plugin_1"), |
||||
cert_provider_1); |
||||
ASSERT_EQ(store.CreateOrGetCertificateProvider("fake_plugin_3"), |
||||
cert_provider_3); |
||||
// Release previously created certificate providers so that the store outlasts
|
||||
// the certificate providers.
|
||||
cert_provider_1.reset(); |
||||
cert_provider_3.reset(); |
||||
} |
||||
|
||||
TEST_F(CertificateProviderStoreTest, Multithreaded) { |
||||
auto* fake_factory_1 = new FakeCertificateProviderFactory1; |
||||
CertificateProviderRegistry::RegisterCertificateProviderFactory( |
||||
std::unique_ptr<CertificateProviderFactory>(fake_factory_1)); |
||||
CertificateProviderStore::PluginDefinitionMap map = { |
||||
{"fake_plugin_1", |
||||
{"fake1", fake_factory_1->CreateCertificateProviderConfig(Json::Object(), |
||||
nullptr)}}}; |
||||
CertificateProviderStore store(std::move(map)); |
||||
// Test concurrent `CreateOrGetCertificateProvider()` with the same key.
|
||||
std::vector<std::thread> threads; |
||||
threads.reserve(1000); |
||||
for (auto i = 0; i < 1000; i++) { |
||||
threads.emplace_back([&store]() { |
||||
for (auto i = 0; i < 10; ++i) { |
||||
ASSERT_NE(store.CreateOrGetCertificateProvider("fake_plugin_1"), |
||||
nullptr); |
||||
} |
||||
}); |
||||
} |
||||
for (auto& thread : threads) { |
||||
thread.join(); |
||||
} |
||||
} |
||||
|
||||
} // namespace
|
||||
} // namespace testing
|
||||
} // namespace grpc_core
|
||||
|
||||
int main(int argc, char** argv) { |
||||
::testing::InitGoogleTest(&argc, argv); |
||||
grpc::testing::TestEnvironment env(argc, argv); |
||||
auto result = RUN_ALL_TESTS(); |
||||
return result; |
||||
} |
||||
Loading…
Reference in new issue