tls: inline delivery of TLS certificates and private keys. #2248
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,13 +41,20 @@ ContextConfigImpl::ContextConfigImpl(const envoy::api::v2::CommonTlsContext& con | |
| RepeatedPtrUtil::join(config.tls_params().cipher_suites(), ":"), DEFAULT_CIPHER_SUITES)), | ||
| ecdh_curves_(StringUtil::nonEmptyStringOrDefault( | ||
| RepeatedPtrUtil::join(config.tls_params().ecdh_curves(), ":"), DEFAULT_ECDH_CURVES)), | ||
| ca_cert_(readDataSource(config.validation_context().trusted_ca(), true)), | ||
| ca_cert_path_(getDataSourcePath(config.validation_context().trusted_ca())), | ||
| cert_chain_(config.tls_certificates().empty() | ||
| ? "" | ||
| : readDataSource(config.tls_certificates()[0].certificate_chain(), true)), | ||
| cert_chain_path_(config.tls_certificates().empty() | ||
| ? "" | ||
| : getDataSourcePath(config.tls_certificates()[0].certificate_chain())), | ||
| private_key_(config.tls_certificates().empty() | ||
| ? "" | ||
| : readDataSource(config.tls_certificates()[0].private_key(), true)), | ||
| private_key_path_(config.tls_certificates().empty() | ||
| ? "" | ||
| : getDataSourcePath(config.tls_certificates()[0].private_key())), | ||
| verify_subject_alt_name_list_(config.validation_context().verify_subject_alt_name().begin(), | ||
| config.validation_context().verify_subject_alt_name().end()), | ||
| verify_certificate_hash_(config.validation_context().verify_certificate_hash().empty() | ||
|
|
@@ -61,6 +68,28 @@ ContextConfigImpl::ContextConfigImpl(const envoy::api::v2::CommonTlsContext& con | |
| ASSERT(config.validation_context().verify_certificate_hash().size() <= 1); | ||
| } | ||
|
|
||
| const std::string ContextConfigImpl::readDataSource(const envoy::api::v2::DataSource& source, | ||
| bool allow_empty) { | ||
| switch (source.specifier_case()) { | ||
| case envoy::api::v2::DataSource::kFilename: | ||
| return Filesystem::fileReadToEnd(source.filename()); | ||
| case envoy::api::v2::DataSource::kInlineBytes: | ||
| return source.inline_bytes(); | ||
| case envoy::api::v2::DataSource::kInlineString: | ||
| return source.inline_string(); | ||
| default: | ||
| if (!allow_empty) { | ||
| throw EnvoyException( | ||
| fmt::format("Unexpected DataSource::specifier_case(): {}", source.specifier_case())); | ||
| } | ||
| return ""; | ||
| } | ||
| } | ||
|
|
||
| const std::string ContextConfigImpl::getDataSourcePath(const envoy::api::v2::DataSource& source) { | ||
| return source.specifier_case() == envoy::api::v2::DataSource::kFilename ? source.filename() : ""; | ||
| } | ||
|
|
||
| unsigned | ||
| ContextConfigImpl::tlsVersionFromProto(const envoy::api::v2::TlsParameters_TlsProtocol& version, | ||
| unsigned default_version) { | ||
|
|
@@ -105,23 +134,7 @@ ServerContextConfigImpl::ServerContextConfigImpl(const envoy::api::v2::Downstrea | |
| switch (config.session_ticket_keys_type_case()) { | ||
| case envoy::api::v2::DownstreamTlsContext::kSessionTicketKeys: | ||
| for (const auto& datasource : config.session_ticket_keys().keys()) { | ||
| validateAndAppendKey(ret, readDataSource(datasource, false)); | ||
| } | ||
| break; | ||
| case envoy::api::v2::DownstreamTlsContext::kSessionTicketKeysSdsSecretConfig: | ||
|
|
@@ -139,12 +152,7 @@ ServerContextConfigImpl::ServerContextConfigImpl(const envoy::api::v2::Downstrea | |
| // TODO(PiotrSikora): Support multiple TLS certificates. | ||
| // TODO(mattklein123): All of the ASSERTs in this file need to be converted to exceptions with | ||
|
Member
There was a problem hiding this comment. @PiotrSikora as long as you are in here, can you take a look at the rest of the asserts in this file? I think some of them could potentially happen/crash with native v2 config. I might be wrong, but could you take a look and potentially fix to throw/add tests? (Follow up is fine if that is better).
Contributor
Author
There was a problem hiding this comment. Sure, I'll do in a separate PR. |
||
| // proper error handling. | ||
| ASSERT(config.common_tls_context().tls_certificates().size() == 1); | ||
| } | ||
|
|
||
| ServerContextConfigImpl::ServerContextConfigImpl(const Json::Object& config) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quick comment which unfortunately is going to make this more complicated: We are going to need to fix config_test to work with some type of mock loader that doesn't read files from disk. Optimally it would verify everything else in SSL and possibly just use fake valid cert data. The reason this is going to be needed is we run at Lyft config tests for configs where the certs are not available on the box where the tests are run.
Ultimately I think we know this is working when none of the example config stuff here changed as part of this diff.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have mixed feelings about validity of this approach, but I'll add this if you need it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm sorry, but we definitely need it. I would just figure out whatever is easiest in that test, even if you have to mock out more stuff.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I think I might have misunderstood what you were saying.
I assumed that you meant letting
//test/config_test:example_configs_testpass without reading certificates from disk, but after some digging, I've noticed that//test/tools/config_load_check:config_load_check_tooluses the same code, so you probably meant that you're using this tool to verify production configs and want to test them without access to the real certificates? Is that correct?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We actually use both a private version of the config test as well as the config load check tool (in different places). We need both to run in a mode that doesn't require the actual cert files to exist (because yes we test prod configs where the certs don't live). IMO it's fine to just have them both work the same way for now (don't load) which is not a regression from what happened before, so any kind of mock is fine. The optimal solution would be to not use a full mock TLS context loader so we can check other config options, but to only mock the actual cert loading part. I have no idea if that is easy or not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can open an issue to do what you describe, but if we want to merge this sooner we need to not break existing behavior. IMO having a flag on whether to check the cert or not makes a lot of sense.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @ggreenway, it's one thing to mock things in tests, but faking certificates when testing production config sounds like a really bad idea, and if you're testing those on a machine without access to real certificates, then you should provide self-signed certs. Otherwise, you might refer to certificates that don't exist (e.g. typo).
Furthermore, we'd need to add same hacks to
--mode validate, which sounds even worse.Yes, it's change of current behavior, but I don't see how this justifies adding error-prone hacks to the code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hear what you are saying, but, that's the way it works today, and this PR will break us. If we want to hold this PR until we fix the way we test things, we can do that, but it will take 1-2 weeks since we will need to schedule the work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer to wait, then.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright I will make an internal ticket and get someone to work on cutting us over to fake certs for testing next week.