-
Notifications
You must be signed in to change notification settings - Fork 3
fix(gateway): stop TLS from depending on which crates got linked #550
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
14 changes: 14 additions & 0 deletions
14
rsworkspace/crates/platform/trogon-gateway/tests/crypto_provider.rs
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 |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| //! Guards the dependency graph that made every TLS handshake panic at runtime. | ||
| //! | ||
| //! `trogon-gateway` reaches rustls through both provider features: `aws-lc-rs` | ||
| //! via the OTLP exporter and `ring` via async-nats and twilight. rustls refuses | ||
| //! to pick one, so anything building a TLS client panicked instead of | ||
| //! connecting. This fails if the explicit provider install stops happening or a | ||
| //! dependency change reintroduces the ambiguity. | ||
|
|
||
| #[test] | ||
| fn tls_clients_build_once_the_provider_is_installed() { | ||
| assert!(trogon_std::tls::install_default_crypto_provider().is_ok()); | ||
|
|
||
| let _ = rustls::ClientConfig::builder(); | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| //! Process-wide TLS provider selection for rustls. | ||
| //! | ||
| //! rustls only derives its process-level [`rustls::crypto::CryptoProvider`] from | ||
| //! crate features when exactly one provider feature is enabled. A dependency | ||
| //! graph that reaches both `aws-lc-rs` and `ring` leaves the choice ambiguous, | ||
| //! and rustls panics on the first handshake rather than guessing. Installing the | ||
| //! provider explicitly removes the dependency on feature unification, so adding | ||
| //! a dependency cannot change which cryptography a binary uses. | ||
| //! | ||
| //! Call [`install_default_crypto_provider`] before the first TLS handshake, | ||
| //! ahead of any client construction or task spawn. | ||
|
|
||
| /// A rustls [`rustls::crypto::CryptoProvider`] was already installed for this | ||
| /// process, so the caller has no guarantee which cryptography it now uses. | ||
| #[derive(Debug, thiserror::Error)] | ||
| #[error("a rustls CryptoProvider was already installed for this process")] | ||
| pub struct CryptoProviderAlreadyInstalledError; | ||
|
|
||
| /// Installs aws-lc-rs as the process-wide rustls | ||
| /// [`rustls::crypto::CryptoProvider`]. | ||
| /// | ||
| /// Fails rather than accepting whichever provider got there first, so a second | ||
| /// installer cannot silently downgrade the process to different cryptography. | ||
| pub fn install_default_crypto_provider() -> Result<(), CryptoProviderAlreadyInstalledError> { | ||
| rustls::crypto::aws_lc_rs::default_provider() | ||
| .install_default() | ||
| .map_err(|_| CryptoProviderAlreadyInstalledError) | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests; | ||
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 |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| use super::install_default_crypto_provider; | ||
| use rustls::crypto::CryptoProvider; | ||
|
|
||
| #[test] | ||
| fn installs_a_process_wide_provider() { | ||
| let _ = install_default_crypto_provider(); | ||
|
|
||
| assert!(CryptoProvider::get_default().is_some()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn refuses_to_replace_an_installed_provider() { | ||
| let _ = install_default_crypto_provider(); | ||
|
|
||
| assert!(install_default_crypto_provider().is_err()); | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.