Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

sds: refactor to use shared target for init manager registration #14356

Merged
merged 1 commit into from
Dec 12, 2020
Merged

sds: refactor to use shared target for init manager registration #14356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions include/envoy/secret/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ envoy_cc_library(
hdrs = ["secret_manager.h"],
deps = [
":secret_provider_interface",
"//include/envoy/init:target_interface",
"@envoy_api//envoy/config/core/v3:pkg_cc_proto",
"@envoy_api//envoy/extensions/transport_sockets/tls/v3:pkg_cc_proto",
],
Expand Down
7 changes: 7 additions & 0 deletions include/envoy/secret/secret_provider.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#include "envoy/common/callback.h"
#include "envoy/common/pure.h"
#include "envoy/extensions/transport_sockets/tls/v3/cert.pb.h"
#include "envoy/init/target.h"
#include "envoy/ssl/certificate_validation_context_config.h"
#include "envoy/ssl/tls_certificate_config.h"

Expand Down Expand Up @@ -41,6 +42,12 @@ template <class SecretType> class SecretProvider {
* @return CallbackHandle the handle which can remove that update callback.
*/
virtual Common::CallbackHandle* addUpdateCallback(std::function<void()> callback) PURE;

/**
* @return const Init::Target* A shared init target that can be used by multiple init managers.
* nullptr if the provider isn't dynamic.
*/
virtual const Init::Target* initTarget() { return nullptr; }
};

using TlsCertificatePtr =
Expand Down
26 changes: 9 additions & 17 deletions source/common/secret/sds_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,9 @@ class SdsApi : public Envoy::Config::SubscriptionBase<
Config::SubscriptionFactory& subscription_factory, TimeSource& time_source,
ProtobufMessage::ValidationVisitor& validation_visitor, Stats::Store& stats,
std::function<void()> destructor_cb, Event::Dispatcher& dispatcher, Api::Api& api);
~SdsApi() override {
RELEASE_ASSERT(registered_init_target_,
"Init target was not registered with an init manager. registerInitTarget() must "
"be called after Sds api concrete class instantiation.");
};

SecretData secretData();

void registerInitTarget(Init::Manager& init_manager) {
init_manager.add(init_target_);
registered_init_target_ = true;
}

protected:
// Ordered for hash stability.
using FileContentMap = std::map<std::string, std::string>;
Expand All @@ -97,7 +87,7 @@ class SdsApi : public Envoy::Config::SubscriptionBase<
void resolveDataSource(const FileContentMap& files,
envoy::config::core::v3::DataSource& data_source);

Init::TargetImpl init_target_;
Init::SharedTargetImpl init_target_;
Event::Dispatcher& dispatcher_;
Api::Api& api_;

Expand All @@ -124,7 +114,6 @@ class SdsApi : public Envoy::Config::SubscriptionBase<
TimeSource& time_source_;
SecretData secret_data_;
std::unique_ptr<Filesystem::Watcher> watcher_;
bool registered_init_target_{false};
};

class TlsCertificateSdsApi;
Expand Down Expand Up @@ -154,7 +143,7 @@ class TlsCertificateSdsApi : public SdsApi, public TlsCertificateConfigProvider
secret_provider_context.dispatcher().timeSource(),
secret_provider_context.messageValidationVisitor(), secret_provider_context.stats(),
destructor_cb, secret_provider_context.dispatcher(), secret_provider_context.api());
ret->registerInitTarget(secret_provider_context.initManager());
secret_provider_context.initManager().add(*ret->initTarget());
return ret;
}

Expand Down Expand Up @@ -182,6 +171,7 @@ class TlsCertificateSdsApi : public SdsApi, public TlsCertificateConfigProvider
}
return update_callback_manager_.add(callback);
}
const Init::Target* initTarget() override { return &init_target_; }

protected:
void setSecret(const envoy::extensions::transport_sockets::tls::v3::Secret& secret) override {
Expand Down Expand Up @@ -238,7 +228,7 @@ class CertificateValidationContextSdsApi : public SdsApi,
secret_provider_context.dispatcher().timeSource(),
secret_provider_context.messageValidationVisitor(), secret_provider_context.stats(),
destructor_cb, secret_provider_context.dispatcher(), secret_provider_context.api());
ret->registerInitTarget(secret_provider_context.initManager());
secret_provider_context.initManager().add(*ret->initTarget());
return ret;
}
CertificateValidationContextSdsApi(const envoy::config::core::v3::ConfigSource& sds_config,
Expand All @@ -262,13 +252,13 @@ class CertificateValidationContextSdsApi : public SdsApi,
}
return update_callback_manager_.add(callback);
}

Common::CallbackHandle* addValidationCallback(
std::function<
void(const envoy::extensions::transport_sockets::tls::v3::CertificateValidationContext&)>
callback) override {
return validation_callback_manager_.add(callback);
}
const Init::Target* initTarget() override { return &init_target_; }

protected:
void setSecret(const envoy::extensions::transport_sockets::tls::v3::Secret& secret) override {
Expand Down Expand Up @@ -333,7 +323,7 @@ class TlsSessionTicketKeysSdsApi : public SdsApi, public TlsSessionTicketKeysCon
secret_provider_context.dispatcher().timeSource(),
secret_provider_context.messageValidationVisitor(), secret_provider_context.stats(),
destructor_cb, secret_provider_context.dispatcher(), secret_provider_context.api());
ret->registerInitTarget(secret_provider_context.initManager());
secret_provider_context.initManager().add(*ret->initTarget());
return ret;
}

Expand Down Expand Up @@ -366,6 +356,7 @@ class TlsSessionTicketKeysSdsApi : public SdsApi, public TlsSessionTicketKeysCon
callback) override {
return validation_callback_manager_.add(callback);
}
const Init::Target* initTarget() override { return &init_target_; }

protected:
void setSecret(const envoy::extensions::transport_sockets::tls::v3::Secret& secret) override {
Expand Down Expand Up @@ -405,7 +396,7 @@ class GenericSecretSdsApi : public SdsApi, public GenericSecretConfigProvider {
secret_provider_context.dispatcher().timeSource(),
secret_provider_context.messageValidationVisitor(), secret_provider_context.stats(),
destructor_cb, secret_provider_context.dispatcher(), secret_provider_context.api());
ret->registerInitTarget(secret_provider_context.initManager());
secret_provider_context.initManager().add(*ret->initTarget());
return ret;
}

Expand All @@ -430,6 +421,7 @@ class GenericSecretSdsApi : public SdsApi, public GenericSecretConfigProvider {
callback) override {
return validation_callback_manager_.add(callback);
}
const Init::Target* initTarget() override { return &init_target_; }

protected:
void setSecret(const envoy::extensions::transport_sockets::tls::v3::Secret& secret) override {
Expand Down
26 changes: 13 additions & 13 deletions test/common/secret/sds_api_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ TEST_F(SdsApiTest, BasicTest) {
TlsCertificateSdsApi sds_api(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, *dispatcher_, *api_);
sds_api.registerInitTarget(init_manager_);
init_manager_.add(*sds_api.initTarget());
initialize();
}

Expand Down Expand Up @@ -126,7 +126,7 @@ TEST_F(SdsApiTest, InitManagerInitialised) {
TlsCertificateSdsApi sds_api(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, *dispatcher_, *api_);
EXPECT_NO_THROW(sds_api.registerInitTarget(init_manager));
EXPECT_NO_THROW(init_manager.add(*sds_api.initTarget()));
}

// Validate that bad ConfigSources are caught at construction time. This is a regression test for
Expand All @@ -153,7 +153,7 @@ TEST_F(SdsApiTest, DynamicTlsCertificateUpdateSuccess) {
TlsCertificateSdsApi sds_api(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, *dispatcher_, *api_);
sds_api.registerInitTarget(init_manager_);
init_manager_.add(*sds_api.initTarget());
initialize();
NiceMock<Secret::MockSecretCallbacks> secret_callback;
auto handle =
Expand Down Expand Up @@ -217,7 +217,7 @@ class TlsCertificateSdsRotationApiTest : public testing::TestWithParam<bool>,
sds_api_ = std::make_unique<TlsCertificateSdsApi>(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, mock_dispatcher_, *api_);
sds_api_->registerInitTarget(init_manager_);
init_manager_.add(*sds_api_->initTarget());
initialize();
handle_ = sds_api_->addUpdateCallback([this]() { secret_callback_.onAddOrUpdateSecret(); });
}
Expand Down Expand Up @@ -287,7 +287,7 @@ class CertificateValidationContextSdsRotationApiTest : public testing::TestWithP
sds_api_ = std::make_unique<CertificateValidationContextSdsApi>(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, mock_dispatcher_, *api_);
sds_api_->registerInitTarget(init_manager_);
init_manager_.add(*sds_api_->initTarget());
initialize();
handle_ = sds_api_->addUpdateCallback([this]() { secret_callback_.onAddOrUpdateSecret(); });
}
Expand Down Expand Up @@ -500,7 +500,7 @@ class PartialMockSds : public SdsApi {
: SdsApi(
config_source, "abc.com", subscription_factory, time_source, validation_visitor_, stats,
[]() {}, dispatcher, api) {
registerInitTarget(init_manager);
init_manager.add(init_target_);
}

MOCK_METHOD(void, onConfigUpdate,
Expand Down Expand Up @@ -554,7 +554,7 @@ TEST_F(SdsApiTest, DeltaUpdateSuccess) {
TlsCertificateSdsApi sds_api(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, *dispatcher_, *api_);
sds_api.registerInitTarget(init_manager_);
init_manager_.add(*sds_api.initTarget());

NiceMock<Secret::MockSecretCallbacks> secret_callback;
auto handle =
Expand Down Expand Up @@ -599,7 +599,7 @@ TEST_F(SdsApiTest, DynamicCertificateValidationContextUpdateSuccess) {
CertificateValidationContextSdsApi sds_api(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, *dispatcher_, *api_);
sds_api.registerInitTarget(init_manager_);
init_manager_.add(*sds_api.initTarget());

NiceMock<Secret::MockSecretCallbacks> secret_callback;
auto handle =
Expand Down Expand Up @@ -653,7 +653,7 @@ TEST_F(SdsApiTest, DefaultCertificateValidationContextTest) {
CertificateValidationContextSdsApi sds_api(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, *dispatcher_, *api_);
sds_api.registerInitTarget(init_manager_);
init_manager_.add(*sds_api.initTarget());

NiceMock<Secret::MockSecretCallbacks> secret_callback;
auto handle =
Expand Down Expand Up @@ -741,7 +741,7 @@ TEST_F(SdsApiTest, GenericSecretSdsApiTest) {
GenericSecretSdsApi sds_api(
config_source, "encryption_key", subscription_factory_, time_system_, validation_visitor_,
stats_, []() {}, *dispatcher_, *api_);
sds_api.registerInitTarget(init_manager_);
init_manager_.add(*sds_api.initTarget());

NiceMock<Secret::MockSecretCallbacks> secret_callback;
auto handle =
Expand Down Expand Up @@ -786,7 +786,7 @@ TEST_F(SdsApiTest, EmptyResource) {
TlsCertificateSdsApi sds_api(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, *dispatcher_, *api_);
sds_api.registerInitTarget(init_manager_);
init_manager_.add(*sds_api.initTarget());

initialize();
EXPECT_THROW_WITH_MESSAGE(subscription_factory_.callbacks_->onConfigUpdate({}, ""),
Expand All @@ -801,7 +801,7 @@ TEST_F(SdsApiTest, SecretUpdateWrongSize) {
TlsCertificateSdsApi sds_api(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, *dispatcher_, *api_);
sds_api.registerInitTarget(init_manager_);
init_manager_.add(*sds_api.initTarget());

std::string yaml =
R"EOF(
Expand Down Expand Up @@ -831,7 +831,7 @@ TEST_F(SdsApiTest, SecretUpdateWrongSecretName) {
TlsCertificateSdsApi sds_api(
config_source, "abc.com", subscription_factory_, time_system_, validation_visitor_, stats_,
[]() {}, *dispatcher_, *api_);
sds_api.registerInitTarget(init_manager_);
init_manager_.add(*sds_api.initTarget());

std::string yaml =
R"EOF(
Expand Down