From d94451fe244de2ec8ee02e9ffa4f17aa89bdd90d Mon Sep 17 00:00:00 2001 From: Lucio Franco Date: Fri, 13 Dec 2019 20:23:51 -0500 Subject: [PATCH] fix(transport): Remove with_rustls for tls config --- examples/src/gcp/client.rs | 2 +- examples/src/tls/client.rs | 2 +- examples/src/tls/server.rs | 2 +- examples/src/tls_client_auth/client.rs | 2 +- examples/src/tls_client_auth/server.rs | 2 +- interop/src/bin/client.rs | 2 +- interop/src/bin/server.rs | 2 +- tonic/src/transport/channel/endpoint.rs | 1 + tonic/src/transport/channel/mod.rs | 1 + tonic/src/transport/channel/tls.rs | 3 ++- tonic/src/transport/mod.rs | 2 ++ tonic/src/transport/server/mod.rs | 2 ++ tonic/src/transport/server/tls.rs | 3 ++- 13 files changed, 17 insertions(+), 9 deletions(-) diff --git a/examples/src/gcp/client.rs b/examples/src/gcp/client.rs index 9138de599..9c441de8c 100644 --- a/examples/src/gcp/client.rs +++ b/examples/src/gcp/client.rs @@ -27,7 +27,7 @@ async fn main() -> Result<(), Box> { let certs = tokio::fs::read("tonic-examples/data/gcp/roots.pem").await?; - let tls_config = ClientTlsConfig::with_rustls() + let tls_config = ClientTlsConfig::new() .ca_certificate(Certificate::from_pem(certs.as_slice())) .domain_name("pubsub.googleapis.com"); diff --git a/examples/src/tls/client.rs b/examples/src/tls/client.rs index b40929e11..4d4315151 100644 --- a/examples/src/tls/client.rs +++ b/examples/src/tls/client.rs @@ -10,7 +10,7 @@ async fn main() -> Result<(), Box> { let pem = tokio::fs::read("tonic-examples/data/tls/ca.pem").await?; let ca = Certificate::from_pem(pem); - let tls = ClientTlsConfig::with_rustls() + let tls = ClientTlsConfig::new() .ca_certificate(ca) .domain_name("example.com"); diff --git a/examples/src/tls/server.rs b/examples/src/tls/server.rs index 1fb01e442..e238d7ce2 100644 --- a/examples/src/tls/server.rs +++ b/examples/src/tls/server.rs @@ -60,7 +60,7 @@ async fn main() -> Result<(), Box> { let server = EchoServer::default(); Server::builder() - .tls_config(ServerTlsConfig::with_rustls().identity(identity)) + .tls_config(ServerTlsConfig::new().identity(identity)) .add_service(pb::echo_server::EchoServer::new(server)) .serve(addr) .await?; diff --git a/examples/src/tls_client_auth/client.rs b/examples/src/tls_client_auth/client.rs index 44806edab..e6ba4a5a7 100644 --- a/examples/src/tls_client_auth/client.rs +++ b/examples/src/tls_client_auth/client.rs @@ -13,7 +13,7 @@ async fn main() -> Result<(), Box> { let client_key = tokio::fs::read("tonic-examples/data/tls/client1.key").await?; let client_identity = Identity::from_pem(client_cert, client_key); - let tls = ClientTlsConfig::with_rustls() + let tls = ClientTlsConfig::new() .domain_name("localhost") .ca_certificate(server_root_ca_cert) .identity(client_identity); diff --git a/examples/src/tls_client_auth/server.rs b/examples/src/tls_client_auth/server.rs index 5bff8c8d5..4786e00c1 100644 --- a/examples/src/tls_client_auth/server.rs +++ b/examples/src/tls_client_auth/server.rs @@ -37,7 +37,7 @@ async fn main() -> Result<(), Box> { let addr = "[::1]:50051".parse().unwrap(); let server = EchoServer::default(); - let tls = ServerTlsConfig::with_rustls() + let tls = ServerTlsConfig::new() .identity(server_identity) .client_ca_root(client_ca_cert); diff --git a/interop/src/bin/client.rs b/interop/src/bin/client.rs index 487e0eced..a4c13d06f 100644 --- a/interop/src/bin/client.rs +++ b/interop/src/bin/client.rs @@ -35,7 +35,7 @@ async fn main() -> Result<(), Box> { let pem = tokio::fs::read("interop/data/ca.pem").await?; let ca = Certificate::from_pem(pem); endpoint = endpoint.tls_config( - ClientTlsConfig::with_rustls() + ClientTlsConfig::new() .ca_certificate(ca) .domain_name("foo.test.google.fr"), ); diff --git a/interop/src/bin/server.rs b/interop/src/bin/server.rs index 67102e588..d8aec0870 100644 --- a/interop/src/bin/server.rs +++ b/interop/src/bin/server.rs @@ -53,7 +53,7 @@ async fn main() -> std::result::Result<(), Box> { let key = tokio::fs::read("interop/data/server1.key").await?; let identity = Identity::from_pem(cert, key); - builder = builder.tls_config(ServerTlsConfig::with_rustls().identity(identity)); + builder = builder.tls_config(ServerTlsConfig::new().identity(identity)); } let test_service = server::TestServiceServer::new(server::TestService::default()); diff --git a/tonic/src/transport/channel/endpoint.rs b/tonic/src/transport/channel/endpoint.rs index eb04f3314..1cb017564 100644 --- a/tonic/src/transport/channel/endpoint.rs +++ b/tonic/src/transport/channel/endpoint.rs @@ -167,6 +167,7 @@ impl Endpoint { /// Configures TLS for the endpoint. #[cfg(feature = "tls")] + #[cfg_attr(docsrs, doc(cfg(feature = "tls")))] pub fn tls_config(self, tls_config: ClientTlsConfig) -> Self { Endpoint { tls: Some(tls_config.tls_connector(self.uri.clone()).unwrap()), diff --git a/tonic/src/transport/channel/mod.rs b/tonic/src/transport/channel/mod.rs index cb1ec7f00..da22f1c8a 100644 --- a/tonic/src/transport/channel/mod.rs +++ b/tonic/src/transport/channel/mod.rs @@ -2,6 +2,7 @@ mod endpoint; #[cfg(feature = "tls")] +#[cfg_attr(docsrs, doc(cfg(feature = "tls")))] mod tls; pub use endpoint::Endpoint; diff --git a/tonic/src/transport/channel/tls.rs b/tonic/src/transport/channel/tls.rs index f8e3f04d5..8a44cff14 100644 --- a/tonic/src/transport/channel/tls.rs +++ b/tonic/src/transport/channel/tls.rs @@ -7,6 +7,7 @@ use std::fmt; /// Configures TLS settings for endpoints. #[cfg(feature = "tls")] +#[cfg_attr(docsrs, doc(cfg(feature = "tls")))] #[derive(Clone)] pub struct ClientTlsConfig { domain: Option, @@ -29,7 +30,7 @@ impl fmt::Debug for ClientTlsConfig { #[cfg(feature = "tls")] impl ClientTlsConfig { /// Creates a new `ClientTlsConfig` using Rustls. - pub fn with_rustls() -> Self { + pub fn new() -> Self { ClientTlsConfig { domain: None, cert: None, diff --git a/tonic/src/transport/mod.rs b/tonic/src/transport/mod.rs index e4cabda69..c1c04249b 100644 --- a/tonic/src/transport/mod.rs +++ b/tonic/src/transport/mod.rs @@ -107,8 +107,10 @@ pub use self::tls::{Certificate, Identity}; pub use hyper::Body; #[cfg(feature = "tls")] +#[cfg_attr(docsrs, doc(cfg(feature = "tls")))] pub use self::channel::ClientTlsConfig; #[cfg(feature = "tls")] +#[cfg_attr(docsrs, doc(cfg(feature = "tls")))] pub use self::server::ServerTlsConfig; pub(crate) use self::error::ErrorKind; diff --git a/tonic/src/transport/server/mod.rs b/tonic/src/transport/server/mod.rs index e1bd03b8f..1f987f3e5 100644 --- a/tonic/src/transport/server/mod.rs +++ b/tonic/src/transport/server/mod.rs @@ -2,6 +2,7 @@ mod incoming; #[cfg(feature = "tls")] +#[cfg_attr(docsrs, doc(cfg(feature = "tls")))] mod tls; #[cfg(feature = "tls")] @@ -96,6 +97,7 @@ impl Server { impl Server { /// Configure TLS for this server. #[cfg(feature = "tls")] + #[cfg_attr(docsrs, doc(cfg(feature = "tls")))] pub fn tls_config(self, tls_config: ServerTlsConfig) -> Self { Server { tls: Some(tls_config.tls_acceptor().unwrap()), diff --git a/tonic/src/transport/server/tls.rs b/tonic/src/transport/server/tls.rs index c2977ff43..42facbbb4 100644 --- a/tonic/src/transport/server/tls.rs +++ b/tonic/src/transport/server/tls.rs @@ -6,6 +6,7 @@ use std::fmt; /// Configures TLS settings for servers. #[cfg(feature = "tls")] +#[cfg_attr(docsrs, doc(cfg(feature = "tls")))] #[derive(Clone)] pub struct ServerTlsConfig { identity: Option, @@ -23,7 +24,7 @@ impl fmt::Debug for ServerTlsConfig { #[cfg(feature = "tls")] impl ServerTlsConfig { /// Creates a new `ServerTlsConfig`. - pub fn with_rustls() -> Self { + pub fn new() -> Self { ServerTlsConfig { identity: None, client_ca_root: None,