diff options
author | Martin Robinson <mrobinson@igalia.com> | 2023-08-08 16:00:10 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-08-08 14:00:10 +0000 |
commit | bce7622cde4cd10f6b3edf852d97ae9a540a0076 (patch) | |
tree | e8c09178e875b63e64b32a290840c6ff80d2c4e0 /components/net/tests | |
parent | ab0f48f8e8a72542269c9e563fad4fa03273d2f3 (diff) | |
download | servo-bce7622cde4cd10f6b3edf852d97ae9a540a0076.tar.gz servo-bce7622cde4cd10f6b3edf852d97ae9a540a0076.zip |
Switch to rustls and webpki-roots (#30025)
This change replaces OpenSSL with rustls and also the manually curated
CA certs file with webpki-roots (effectively the same thing, but as a
crate).
Generally speaking the design of the network stack is the same. Changes:
- Code around certificate overrides needed to be refactored to work with
rustls so the various thread-safe list of certificates is refactored
into `CertificateErrorOverrideManager`
- hyper-rustls takes care of setting ALPN protocols for HTTP requests,
so for WebSockets this is moved to the WebSocket code.
- The safe set of cypher suites is chosen, which seem to correspond to
the "Modern" configuration from [1]. This can be adjusted later.
- Instead of passing a string of PEM CA certificates around, an enum is
used that includes parsed Certificates (or the default which reads
them from webpki-roots).
- Code for starting up an SSL server for testing is cleaned up a little,
due to the fact that the certificates need to be overriden explicitly
now. This is due to the fact that the `webpki` crate is more stringent
with self-signed certificates than SSL (CA certificates cannot used as
end-entity certificates). [2]
1. https://wiki.mozilla.org/Security/Server_Side_TLS
2. https://github.com/briansmith/webpki/issues/114
Fixes #7888.
Fixes #13749.
Fixes #26835.
Fixes #29291.
Diffstat (limited to 'components/net/tests')
-rw-r--r-- | components/net/tests/fetch.rs | 88 | ||||
-rw-r--r-- | components/net/tests/main.rs | 112 | ||||
-rw-r--r-- | components/net/tests/resource_thread.rs | 4 |
3 files changed, 102 insertions, 102 deletions
diff --git a/components/net/tests/fetch.rs b/components/net/tests/fetch.rs index 3b0f18f1950..b5c34a91f3b 100644 --- a/components/net/tests/fetch.rs +++ b/components/net/tests/fetch.rs @@ -24,7 +24,6 @@ use hyper::Body; use hyper::{Request as HyperRequest, Response as HyperResponse}; use mime::{self, Mime}; use msg::constellation_msg::TEST_PIPELINE_ID; -use net::connector::{create_tls_config, ConnectionCerts, ExtraCerts, ALPN_H2_H1}; use net::fetch::cors_cache::CorsCache; use net::fetch::methods::{self, CancellationListener, FetchContext}; use net::filemanager_thread::FileManager; @@ -756,24 +755,10 @@ fn test_fetch_with_hsts() { *response.body_mut() = MESSAGE.to_vec().into(); }; - let cert_path = Path::new("../../resources/self_signed_certificate_for_testing.crt") - .canonicalize() - .unwrap(); - let key_path = Path::new("../../resources/privatekey_for_testing.key") - .canonicalize() - .unwrap(); - let (server, url) = make_ssl_server(handler, cert_path.clone(), key_path.clone()); - - let certs = fs::read_to_string(cert_path).expect("Couldn't find certificate file"); - let tls_config = create_tls_config( - &certs, - ALPN_H2_H1, - ExtraCerts::new(), - ConnectionCerts::new(), - ); + let (server, url) = make_ssl_server(handler); let mut context = FetchContext { - state: Arc::new(HttpState::new(tls_config)), + state: Arc::new(HttpState::new()), user_agent: DEFAULT_USER_AGENT.into(), devtools_chan: None, filemanager: Arc::new(Mutex::new(FileManager::new( @@ -787,6 +772,12 @@ fn test_fetch_with_hsts() { ))), }; + // The server certificate is self-signed, so we need to add an override + // so that the connection works properly. + for certificate in server.certificates.as_ref().unwrap().iter() { + context.state.override_manager.add_override(certificate); + } + { let mut list = context.state.hsts_list.write().unwrap(); list.push( @@ -821,25 +812,12 @@ fn test_load_adds_host_to_hsts_list_when_url_is_https() { )); *response.body_mut() = b"Yay!".to_vec().into(); }; - let cert_path = Path::new("../../resources/self_signed_certificate_for_testing.crt") - .canonicalize() - .unwrap(); - let key_path = Path::new("../../resources/privatekey_for_testing.key") - .canonicalize() - .unwrap(); - let (server, mut url) = make_ssl_server(handler, cert_path.clone(), key_path.clone()); - url.as_mut_url().set_scheme("https").unwrap(); - let certs = fs::read_to_string(cert_path).expect("Couldn't find certificate file"); - let tls_config = create_tls_config( - &certs, - ALPN_H2_H1, - ExtraCerts::new(), - ConnectionCerts::new(), - ); + let (server, mut url) = make_ssl_server(handler); + url.as_mut_url().set_scheme("https").unwrap(); let mut context = FetchContext { - state: Arc::new(HttpState::new(tls_config)), + state: Arc::new(HttpState::new()), user_agent: DEFAULT_USER_AGENT.into(), devtools_chan: None, filemanager: Arc::new(Mutex::new(FileManager::new( @@ -853,6 +831,12 @@ fn test_load_adds_host_to_hsts_list_when_url_is_https() { ))), }; + // The server certificate is self-signed, so we need to add an override + // so that the connection works properly. + for certificate in server.certificates.as_ref().unwrap().iter() { + context.state.override_manager.add_override(certificate); + } + let mut request = RequestBuilder::new(url.clone(), Referrer::NoReferrer) .method(Method::GET) .body(None) @@ -885,29 +869,12 @@ fn test_fetch_self_signed() { let handler = move |_: HyperRequest<Body>, response: &mut HyperResponse<Body>| { *response.body_mut() = b"Yay!".to_vec().into(); }; - let client_cert_path = Path::new("../../resources/certs").canonicalize().unwrap(); - let cert_path = Path::new("../../resources/self_signed_certificate_for_testing.crt") - .canonicalize() - .unwrap(); - let key_path = Path::new("../../resources/privatekey_for_testing.key") - .canonicalize() - .unwrap(); - let (_server, mut url) = make_ssl_server(handler, cert_path.clone(), key_path.clone()); - url.as_mut_url().set_scheme("https").unwrap(); - let cert_data = fs::read_to_string(cert_path.clone()).expect("Couldn't find certificate file"); - let client_cert_data = - fs::read_to_string(client_cert_path.clone()).expect("Couldn't find certificate file"); - let extra_certs = ExtraCerts::new(); - let tls_config = create_tls_config( - &client_cert_data, - ALPN_H2_H1, - extra_certs.clone(), - ConnectionCerts::new(), - ); + let (server, mut url) = make_ssl_server(handler); + url.as_mut_url().set_scheme("https").unwrap(); let mut context = FetchContext { - state: Arc::new(HttpState::new(tls_config)), + state: Arc::new(HttpState::new()), user_agent: DEFAULT_USER_AGENT.into(), devtools_chan: None, filemanager: Arc::new(Mutex::new(FileManager::new( @@ -936,16 +903,11 @@ fn test_fetch_self_signed() { Some(NetworkError::SslValidation(..)) )); - extra_certs.add(cert_data.as_bytes().into()); - - // FIXME: something weird happens inside the SSL server after the first - // connection encounters a verification error, and it no longer - // accepts new connections that should work fine. We are forced - // to start a new server and connect to that to verfiy that - // the self-signed cert is now accepted. - - let (server, mut url) = make_ssl_server(handler, cert_path.clone(), key_path.clone()); - url.as_mut_url().set_scheme("https").unwrap(); + // The server certificate is self-signed, so we need to add an override + // so that the connection works properly. + for certificate in server.certificates.as_ref().unwrap().iter() { + context.state.override_manager.add_override(certificate); + } let mut request = RequestBuilder::new(url.clone(), Referrer::NoReferrer) .method(Method::GET) diff --git a/components/net/tests/main.rs b/components/net/tests/main.rs index 46f3eb1bb05..7a0f4955cd5 100644 --- a/components/net/tests/main.rs +++ b/components/net/tests/main.rs @@ -22,10 +22,8 @@ mod resource_thread; mod subresource_integrity; use core::convert::Infallible; -use core::pin::Pin; use crossbeam_channel::{unbounded, Sender}; use devtools_traits::DevtoolsControlMsg; -use embedder_traits::resources::{self, Resource}; use embedder_traits::{EmbedderProxy, EventLoopWaker}; use futures::future::ready; use futures::StreamExt; @@ -33,7 +31,6 @@ use hyper::server::conn::Http; use hyper::server::Server as HyperServer; use hyper::service::{make_service_fn, service_fn}; use hyper::{Body, Request as HyperRequest, Response as HyperResponse}; -use net::connector::{create_tls_config, ConnectionCerts, ExtraCerts, ALPN_H2_H1}; use net::fetch::cors_cache::CorsCache; use net::fetch::methods::{self, CancellationListener, FetchContext}; use net::filemanager_thread::FileManager; @@ -43,16 +40,19 @@ use net_traits::filemanager_thread::FileTokenCheck; use net_traits::request::Request; use net_traits::response::Response; use net_traits::{FetchTaskTarget, ResourceFetchTiming, ResourceTimingType}; -use openssl::ssl::{Ssl, SslAcceptor, SslFiletype, SslMethod}; +use rustls::{self, Certificate, PrivateKey}; +use rustls_pemfile::{certs, pkcs8_private_keys}; use servo_arc::Arc as ServoArc; use servo_url::ServoUrl; +use std::fs::File; +use std::io::{self, BufReader}; use std::net::TcpListener as StdTcpListener; -use std::path::PathBuf; +use std::path::{Path, PathBuf}; use std::sync::{Arc, Mutex, Weak}; use tokio::net::TcpListener; use tokio::net::TcpStream; use tokio::runtime::{Builder, Runtime}; -use tokio_openssl::SslStream; +use tokio_rustls::{self, TlsAcceptor}; use tokio_stream::wrappers::TcpListenerStream; use tokio_test::block_on; @@ -102,17 +102,10 @@ fn new_fetch_context( fc: Option<EmbedderProxy>, pool_handle: Option<Weak<CoreResourceThreadPool>>, ) -> FetchContext { - let certs = resources::read_string(Resource::SSLCertificates); - let tls_config = create_tls_config( - &certs, - ALPN_H2_H1, - ExtraCerts::new(), - ConnectionCerts::new(), - ); let sender = fc.unwrap_or_else(|| create_embedder_proxy()); FetchContext { - state: Arc::new(HttpState::new(tls_config)), + state: Arc::new(HttpState::new()), user_agent: DEFAULT_USER_AGENT.into(), devtools_chan: dc.map(|dc| Arc::new(Mutex::new(dc))), filemanager: Arc::new(Mutex::new(FileManager::new( @@ -167,6 +160,7 @@ fn fetch_with_cors_cache(request: &mut Request, cache: &mut CorsCache) -> Respon pub(crate) struct Server { pub close_channel: tokio::sync::oneshot::Sender<()>, + pub certificates: Option<Vec<Certificate>>, } impl Server { @@ -205,11 +199,39 @@ where }; HANDLE.lock().unwrap().spawn(server); - let server = Server { close_channel: tx }; - (server, url) + ( + Server { + close_channel: tx, + certificates: None, + }, + url, + ) +} + +/// Given a path to a file containing PEM certificates, load and parse them into +/// a vector of RusTLS [Certificate]s. +fn load_certificates_from_pem(path: &PathBuf) -> std::io::Result<Vec<Certificate>> { + let file = File::open(path)?; + let mut reader = BufReader::new(file); + let certs = certs(&mut reader)?; + Ok(certs.into_iter().map(Certificate).collect()) +} + +/// Given a path to a file containing PEM keys, load and parse them into +/// a vector of RusTLS [PrivateKey]s. +fn load_private_key_from_file(path: &PathBuf) -> Result<PrivateKey, Box<dyn std::error::Error>> { + let file = File::open(&path)?; + let mut reader = BufReader::new(file); + let mut keys = pkcs8_private_keys(&mut reader)?; + + match keys.len() { + 0 => Err(format!("No PKCS8-encoded private key found in {path:?}").into()), + 1 => Ok(PrivateKey(keys.remove(0))), + _ => Err(format!("More than one PKCS8-encoded private key found in {path:?}").into()), + } } -fn make_ssl_server<H>(handler: H, cert_path: PathBuf, key_path: PathBuf) -> (Server, ServoUrl) +fn make_ssl_server<H>(handler: H) -> (Server, ServoUrl) where H: Fn(HyperRequest<Body>, &mut HyperResponse<Body>) + Send + Sync + 'static, { @@ -219,13 +241,28 @@ where .lock() .unwrap() .block_on(async move { TcpListener::from_std(listener).unwrap() }); - let url_string = format!("http://localhost:{}", listener.local_addr().unwrap().port()); - let mut listener = TcpListenerStream::new(listener); - let url = ServoUrl::parse(&url_string).unwrap(); - let (tx, mut rx) = tokio::sync::oneshot::channel::<()>(); + let cert_path = Path::new("../../resources/self_signed_certificate_for_testing.crt") + .canonicalize() + .unwrap(); + let key_path = Path::new("../../resources/privatekey_for_testing.key") + .canonicalize() + .unwrap(); + let certificates = load_certificates_from_pem(&cert_path).expect("Invalid certificate"); + let key = load_private_key_from_file(&key_path).expect("Invalid key"); + + let config = rustls::ServerConfig::builder() + .with_safe_defaults() + .with_no_client_auth() + .with_single_cert(certificates.clone(), key) + .map_err(|err| io::Error::new(io::ErrorKind::InvalidInput, err)) + .expect("Could not create rustls ServerConfig"); + let acceptor = TlsAcceptor::from(Arc::new(config)); + + let mut listener = TcpListenerStream::new(listener); + let (tx, mut rx) = tokio::sync::oneshot::channel::<()>(); let server = async move { loop { let stream = tokio::select! { @@ -244,22 +281,16 @@ where .unwrap(); let stream = TcpStream::from_std(stream).unwrap(); - let mut tls_server_config = - SslAcceptor::mozilla_intermediate_v5(SslMethod::tls()).unwrap(); - tls_server_config - .set_certificate_file(&cert_path, SslFiletype::PEM) - .unwrap(); - tls_server_config - .set_private_key_file(&key_path, SslFiletype::PEM) - .unwrap(); - - let tls_server_config = tls_server_config.build(); - let ssl = Ssl::new(tls_server_config.context()).unwrap(); - let mut stream = SslStream::new(ssl, stream).unwrap(); - - let _ = Pin::new(&mut stream).accept().await; - let handler = handler.clone(); + let acceptor = acceptor.clone(); + + let stream = match acceptor.accept(stream).await { + Ok(stream) => stream, + Err(_) => { + eprintln!("Error handling TLS stream."); + continue; + }, + }; let _ = Http::new() .serve_connection( @@ -276,6 +307,11 @@ where HANDLE.lock().unwrap().spawn(server); - let server = Server { close_channel: tx }; - (server, url) + ( + Server { + close_channel: tx, + certificates: Some(certificates), + }, + url, + ) } diff --git a/components/net/tests/resource_thread.rs b/components/net/tests/resource_thread.rs index 7951e7e10da..11aac7efc49 100644 --- a/components/net/tests/resource_thread.rs +++ b/components/net/tests/resource_thread.rs @@ -4,6 +4,7 @@ use crate::create_embedder_proxy; use ipc_channel::ipc; +use net::connector::CACertificates; use net::resource_thread::new_core_resource_thread; use net::test::parse_hostsfile; use net_traits::CoreResourceMsg; @@ -27,7 +28,8 @@ fn test_exit() { MemProfilerChan(mtx), create_embedder_proxy(), None, - None, + CACertificates::Default, + false, /* ignore_certificate_errors */ ); resource_thread.send(CoreResourceMsg::Exit(sender)).unwrap(); receiver.recv().unwrap(); |