feat: port to rustls 0.20

* attempt to port to rustls 0.20 * clippy * format * Fix test certificates (expired) and add a script to regenerate them. * Fix hanging and failing unit-tests UnexpectedEof errors are bubbled up from rustls. Tests needed to changed slightly, but are en par with tokio/tls. * Fix integration tests * Fix client and server examples * Update async-std version used for testing --------- Co-authored-by: Jason Mobarak <[email protected]>
zazabe · Feb 1, 2023 · 55f643c · 55f643c
1 parent a8ca3ca
commit 55f643c
Show file tree

Hide file tree

Showing 21 changed files with 442 additions and 318 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,12 @@
 [package]
 name = "async-tls"
 version = "0.11.0"
-authors = ["The async-rs developers", "Florian Gilcher <[email protected]>", "dignifiedquire <[email protected]>", "quininer kel <[email protected]>"]
+authors = [
+    "The async-rs developers",
+    "Florian Gilcher <[email protected]>",
+    "dignifiedquire <[email protected]>",
+    "quininer kel <[email protected]>",
+]
 license = "MIT/Apache-2.0"
 repository = "https://github.com/async-std/async-tls"
 homepage = "https://github.com/async-std/async-tls"
@@ -18,9 +23,10 @@ appveyor = { repository = "async-std/async-tls" }
 [dependencies]
 futures-io = "0.3.5"
 futures-core = "0.3.5"
-rustls = "0.19.0"
-webpki = { version = "0.21.3", optional = true }
-webpki-roots = { version = "0.21.0", optional = true }
+rustls = "0.20.6"
+rustls-pemfile = "1.0"
+webpki = { version = "0.22.0", optional = true }
+webpki-roots = { version = "0.22.3", optional = true }
 
 [features]
 default = ["client", "server"]
@@ -32,7 +38,7 @@ server = []
 lazy_static = "1"
 futures-executor = "0.3.5"
 futures-util = { version = "0.3.5", features = ["io"] }
-async-std = { version = "1.0", features = ["unstable"] }
+async-std = { version = "1.11", features = ["unstable"] }
 
 [[test]]
 name = "test"

diff --git a/examples/client/Cargo.toml b/examples/client/Cargo.toml
@@ -6,6 +6,7 @@ edition = "2018"
 
 [dependencies]
 structopt = "0.3.9"
-rustls    = "0.19.0"
-async-std = "1.5.0"
+rustls = "0.20.6"
+rustls-pemfile = "1.0"
+async-std = "1.11.0"
 async-tls = { path = "../.." }
diff --git a/examples/client/src/main.rs b/examples/client/src/main.rs
@@ -5,8 +5,9 @@ use async_std::task;
 use async_tls::TlsConnector;
 
 use rustls::ClientConfig;
+use rustls_pemfile::certs;
 
-use std::io::Cursor;
+use std::io::{BufReader, Cursor};
 use std::net::ToSocketAddrs;
 use std::path::{Path, PathBuf};
 use std::sync::Arc;
@@ -81,12 +82,14 @@ fn main() -> io::Result<()> {
 }
 
 async fn connector_for_ca_file(cafile: &Path) -> io::Result<TlsConnector> {
-    let mut config = ClientConfig::new();
-    let file = async_std::fs::read(cafile).await?;
-    let mut pem = Cursor::new(file);
-    config
-        .root_store
-        .add_pem_file(&mut pem)
-        .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid cert"))?;
+    let mut root_store = rustls::RootCertStore::empty();
+    let ca_bytes = async_std::fs::read(cafile).await?;
+    let cert = certs(&mut BufReader::new(Cursor::new(ca_bytes))).unwrap();
+    debug_assert_eq!((1, 0), root_store.add_parsable_certificates(&cert));
+
+    let config = ClientConfig::builder()
+        .with_safe_defaults()
+        .with_root_certificates(root_store)
+        .with_no_client_auth();
     Ok(TlsConnector::from(Arc::new(config)))
 }
diff --git a/examples/server/Cargo.toml b/examples/server/Cargo.toml
@@ -5,8 +5,9 @@ authors = ["The async-rs developers", "quininer <[email protected]>"]
 edition = "2018"
 
 [dependencies]
-structopt = "0.3.9"
-async-std = "1.5.0"
+async-std = "1.11.0"
 async-tls = { path = "../.." }
-rustls = "0.19.0"
-webpki = "0.21.3"
+futures-lite = "1.12.0"
+rustls = "0.20.6"
+rustls-pemfile = "1.0"
+structopt = "0.3.9"
diff --git a/examples/server/src/main.rs b/examples/server/src/main.rs
@@ -1,10 +1,11 @@
 use async_std::io;
 use async_std::net::{TcpListener, TcpStream};
-use async_std::prelude::*;
+use async_std::stream::StreamExt;
 use async_std::task;
 use async_tls::TlsAcceptor;
-use rustls::internal::pemfile::{certs, rsa_private_keys};
-use rustls::{Certificate, NoClientAuth, PrivateKey, ServerConfig};
+use futures_lite::io::AsyncWriteExt;
+use rustls::{Certificate, PrivateKey, ServerConfig};
+use rustls_pemfile::{certs, read_one, Item};
 
 use std::fs::File;
 use std::io::BufReader;
@@ -28,14 +29,23 @@ struct Options {
 
 /// Load the passed certificates file
 fn load_certs(path: &Path) -> io::Result<Vec<Certificate>> {
-    certs(&mut BufReader::new(File::open(path)?))
-        .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid cert"))
+    Ok(certs(&mut BufReader::new(File::open(path)?))
+        .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid cert"))?
+        .into_iter()
+        .map(Certificate)
+        .collect())
 }
 
 /// Load the passed keys file
-fn load_keys(path: &Path) -> io::Result<Vec<PrivateKey>> {
-    rsa_private_keys(&mut BufReader::new(File::open(path)?))
-        .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid key"))
+fn load_key(path: &Path) -> io::Result<PrivateKey> {
+    match read_one(&mut BufReader::new(File::open(path)?)) {
+        Ok(Some(Item::RSAKey(data) | Item::PKCS8Key(data))) => Ok(PrivateKey(data)),
+        Ok(_) => Err(io::Error::new(
+            io::ErrorKind::InvalidInput,
+            format!("invalid key in {}", path.display()),
+        )),
+        Err(e) => Err(io::Error::new(io::ErrorKind::InvalidInput, e)),
+    }
 }
 
 /// Configure the server using rusttls
@@ -44,13 +54,15 @@ fn load_keys(path: &Path) -> io::Result<Vec<PrivateKey>> {
 /// A TLS server needs a certificate and a fitting private key
 fn load_config(options: &Options) -> io::Result<ServerConfig> {
     let certs = load_certs(&options.cert)?;
-    let mut keys = load_keys(&options.key)?;
+    debug_assert_eq!(1, certs.len());
+    let key = load_key(&options.key)?;
 
     // we don't use client authentication
-    let mut config = ServerConfig::new(NoClientAuth::new());
-    config
+    let config = ServerConfig::builder()
+        .with_safe_defaults()
+        .with_no_client_auth()
         // set this server to use one cert together with the loaded private key
-        .set_single_cert(certs, keys.remove(0))
+        .with_single_cert(certs, key)
         .map_err(|err| io::Error::new(io::ErrorKind::InvalidInput, err))?;
 
     Ok(config)
@@ -78,7 +90,7 @@ async fn handle_connection(acceptor: &TlsAcceptor, tcp_stream: &mut TcpStream) -
         )
         .await?;
 
-    tls_stream.flush().await?;
+    tls_stream.close().await?;
 
     Ok(())
 }

diff --git a/src/acceptor.rs b/src/acceptor.rs
@@ -2,7 +2,7 @@ use crate::common::tls_state::TlsState;
 use crate::server;
 
 use futures_io::{AsyncRead, AsyncWrite};
-use rustls::{ServerConfig, ServerSession};
+use rustls::{ServerConfig, ServerConnection};
 use std::future::Future;
 use std::io;
 use std::pin::Pin;
@@ -39,17 +39,23 @@ impl TlsAcceptor {
         self.accept_with(stream, |_| ())
     }
 
-    // Currently private, as exposing ServerSessions exposes rusttls
+    // Currently private, as exposing ServerConnections exposes rusttls
     fn accept_with<IO, F>(&self, stream: IO, f: F) -> Accept<IO>
     where
         IO: AsyncRead + AsyncWrite + Unpin,
-        F: FnOnce(&mut ServerSession),
+        F: FnOnce(&mut ServerConnection),
     {
-        let mut session = ServerSession::new(&self.inner);
-        f(&mut session);
+        let mut conn = match ServerConnection::new(self.inner.clone()) {
+            Ok(conn) => conn,
+            Err(_) => {
+                return Accept(server::MidHandshake::End);
+            }
+        };
+
+        f(&mut conn);
 
         Accept(server::MidHandshake::Handshaking(server::TlsStream {
-            session,
+            conn,
             io: stream,
             state: TlsState::Stream,
         }))

diff --git a/src/client.rs b/src/client.rs
@@ -4,20 +4,18 @@ use crate::common::tls_state::TlsState;
 use crate::rusttls::stream::Stream;
 use futures_core::ready;
 use futures_io::{AsyncRead, AsyncWrite};
-use rustls::ClientSession;
+use rustls::ClientConnection;
 use std::future::Future;
 use std::pin::Pin;
 use std::task::{Context, Poll};
 use std::{io, mem};
 
-use rustls::Session;
-
 /// The client end of a TLS connection. Can be used like any other bidirectional IO stream.
 /// Wraps the underlying TCP stream.
 #[derive(Debug)]
 pub struct TlsStream<IO> {
     pub(crate) io: IO,
-    pub(crate) session: ClientSession,
+    pub(crate) session: ClientConnection,
     pub(crate) state: TlsState,
 
     #[cfg(feature = "early-data")]
@@ -58,11 +56,11 @@ where
             let (io, session) = (&mut stream.io, &mut stream.session);
             let mut stream = Stream::new(io, session).set_eof(eof);
 
-            if stream.session.is_handshaking() {
+            if stream.conn.is_handshaking() {
                 ready!(stream.complete_io(cx))?;
             }
 
-            if stream.session.wants_write() {
+            if stream.conn.wants_write() {
                 ready!(stream.complete_io(cx))?;
             }
         }
@@ -90,17 +88,20 @@ where
             TlsState::EarlyData => {
                 let this = self.get_mut();
 
+                let is_handshaking = this.session.is_handshaking();
+                let is_early_data_accepted = this.session.is_early_data_accepted();
+
                 let mut stream =
                     Stream::new(&mut this.io, &mut this.session).set_eof(!this.state.readable());
                 let (pos, data) = &mut this.early_data;
 
                 // complete handshake
-                if stream.session.is_handshaking() {
+                if is_handshaking {
                     ready!(stream.complete_io(cx))?;
                 }
 
                 // write early data (fallback)
-                if !stream.session.is_early_data_accepted() {
+                if !is_early_data_accepted {
                     while *pos < data.len() {
                         let len = ready!(stream.as_mut_pin().poll_write(cx, &data[*pos..]))?;
                         *pos += len;
@@ -127,7 +128,7 @@ where
                     Poll::Ready(Err(ref e)) if e.kind() == io::ErrorKind::ConnectionAborted => {
                         this.state.shutdown_read();
                         if this.state.writeable() {
-                            stream.session.send_close_notify();
+                            stream.conn.send_close_notify();
                             this.state.shutdown_write();
                         }
                         Poll::Ready(Ok(0))

diff --git a/src/connector.rs b/src/connector.rs
@@ -3,13 +3,13 @@ use crate::common::tls_state::TlsState;
 use crate::client;
 
 use futures_io::{AsyncRead, AsyncWrite};
-use rustls::{ClientConfig, ClientSession};
+use rustls::{ClientConfig, ClientConnection, OwnedTrustAnchor, RootCertStore, ServerName};
+use std::convert::TryFrom;
 use std::future::Future;
 use std::io;
 use std::pin::Pin;
 use std::sync::Arc;
 use std::task::{Context, Poll};
-use webpki::DNSNameRef;
 
 /// The TLS connecting part. The acceptor drives
 /// the client side of the TLS handshake process. It works
@@ -64,10 +64,18 @@ impl From<ClientConfig> for TlsConnector {
 
 impl Default for TlsConnector {
     fn default() -> Self {
-        let mut config = ClientConfig::new();
-        config
-            .root_store
-            .add_server_trust_anchors(&webpki_roots::TLS_SERVER_ROOTS);
+        let mut root_certs = RootCertStore::empty();
+        root_certs.add_server_trust_anchors(webpki_roots::TLS_SERVER_ROOTS.0.iter().map(|ta| {
+            OwnedTrustAnchor::from_subject_spki_name_constraints(
+                ta.subject,
+                ta.spki,
+                ta.name_constraints,
+            )
+        }));
+        let config = ClientConfig::builder()
+            .with_safe_defaults()
+            .with_root_certificates(root_certs)
+            .with_no_client_auth();
         Arc::new(config).into()
     }
 }
@@ -102,14 +110,14 @@ impl TlsConnector {
         self.connect_with(domain, stream, |_| ())
     }
 
-    // NOTE: Currently private, exposing ClientSession exposes rusttls
+    // NOTE: Currently private, exposing ClientConnection exposes rusttls
     // Early data should be exposed differently
     fn connect_with<'a, IO, F>(&self, domain: impl AsRef<str>, stream: IO, f: F) -> Connect<IO>
     where
         IO: AsyncRead + AsyncWrite + Unpin,
-        F: FnOnce(&mut ClientSession),
+        F: FnOnce(&mut ClientConnection),
     {
-        let domain = match DNSNameRef::try_from_ascii_str(domain.as_ref()) {
+        let domain = match ServerName::try_from(domain.as_ref()) {
             Ok(domain) => domain,
             Err(_) => {
                 return Connect(ConnectInner::Error(Some(io::Error::new(
@@ -119,7 +127,16 @@ impl TlsConnector {
             }
         };
 
-        let mut session = ClientSession::new(&self.inner, domain);
+        let mut session = match ClientConnection::new(self.inner.clone(), domain) {
+            Ok(session) => session,
+            Err(_) => {
+                return Connect(ConnectInner::Error(Some(io::Error::new(
+                    io::ErrorKind::Other,
+                    "invalid connection",
+                ))))
+            }
+        };
+
         f(&mut session);
 
         #[cfg(not(feature = "early-data"))]