// Copyright 2019 Parity Technologies (UK) Ltd. // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the "Software"), // to deal in the Software without restriction, including without limitation // the rights to use, copy, modify, merge, publish, distribute, sublicense, // and/or sell copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. use futures_rustls::{rustls, TlsAcceptor, TlsConnector}; use std::{fmt, io, sync::Arc}; /// TLS configuration. #[derive(Clone)] pub struct Config { pub(crate) client: TlsConnector, pub(crate) server: Option, } impl fmt::Debug for Config { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.write_str("Config") } } /// Private key, DER-encoded ASN.1 in either PKCS#8 or PKCS#1 format. pub struct PrivateKey(rustls::pki_types::PrivateKeyDer<'static>); impl PrivateKey { /// Assert the given bytes are DER-encoded ASN.1 in either PKCS#8 or PKCS#1 format. pub fn new(bytes: Vec) -> Self { PrivateKey( rustls::pki_types::PrivateKeyDer::try_from(bytes) .expect("unknown or invalid key format"), ) } } impl Clone for PrivateKey { fn clone(&self) -> Self { Self(self.0.clone_key()) } } /// Certificate, DER-encoded X.509 format. #[derive(Debug, Clone)] pub struct Certificate(rustls::pki_types::CertificateDer<'static>); impl Certificate { /// Assert the given bytes are in DER-encoded X.509 format. pub fn new(bytes: Vec) -> Self { Certificate(rustls::pki_types::CertificateDer::from(bytes)) } } impl Config { /// Create a new TLS configuration with the given server key and certificate chain. pub fn new(key: PrivateKey, certs: I) -> Result where I: IntoIterator, { let mut builder = Config::builder(); builder.server(key, certs)?; Ok(builder.finish()) } /// Create a client-only configuration. pub fn client() -> Self { let provider = rustls::crypto::ring::default_provider(); let client = rustls::ClientConfig::builder_with_provider(provider.into()) .with_safe_default_protocol_versions() .unwrap() .with_root_certificates(client_root_store()) .with_no_client_auth(); Config { client: Arc::new(client).into(), server: None, } } /// Create a new TLS configuration builder. pub fn builder() -> Builder { Builder { client_root_store: client_root_store(), server: None, } } } /// Setup the rustls client configuration. fn client_root_store() -> rustls::RootCertStore { let mut client_root_store = rustls::RootCertStore::empty(); client_root_store.extend(webpki_roots::TLS_SERVER_ROOTS.iter().map(|ta| { rustls::pki_types::TrustAnchor { subject: ta.subject.into(), subject_public_key_info: ta.spki.into(), name_constraints: ta.name_constraints.map(|v| v.into()), } })); client_root_store } /// TLS configuration builder. pub struct Builder { client_root_store: rustls::RootCertStore, server: Option, } impl Builder { /// Set server key and certificate chain. pub fn server(&mut self, key: PrivateKey, certs: I) -> Result<&mut Self, Error> where I: IntoIterator, { let certs = certs.into_iter().map(|c| c.0).collect(); let provider = rustls::crypto::ring::default_provider(); let server = rustls::ServerConfig::builder_with_provider(provider.into()) .with_safe_default_protocol_versions() .unwrap() .with_no_client_auth() .with_single_cert(certs, key.0) .map_err(|e| Error::Tls(Box::new(e)))?; self.server = Some(server); Ok(self) } /// Add an additional trust anchor. pub fn add_trust(&mut self, cert: &Certificate) -> Result<&mut Self, Error> { self.client_root_store .add(cert.0.to_owned()) .map_err(|e| Error::Tls(Box::new(e)))?; Ok(self) } /// Finish configuration. pub fn finish(self) -> Config { let provider = rustls::crypto::ring::default_provider(); let client = rustls::ClientConfig::builder_with_provider(provider.into()) .with_safe_default_protocol_versions() .unwrap() .with_root_certificates(self.client_root_store) .with_no_client_auth(); Config { client: Arc::new(client).into(), server: self.server.map(|s| Arc::new(s).into()), } } } pub(crate) fn dns_name_ref(name: &str) -> Result, Error> { rustls::pki_types::ServerName::try_from(String::from(name)) .map_err(|_| Error::InvalidDnsName(name.into())) } // Error ////////////////////////////////////////////////////////////////////////////////////////// /// TLS related errors. #[derive(Debug)] #[non_exhaustive] pub enum Error { /// An underlying I/O error. Io(io::Error), /// Actual TLS error. Tls(Box), /// The DNS name was invalid. InvalidDnsName(String), } impl fmt::Display for Error { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Error::Io(e) => write!(f, "i/o error: {e}"), Error::Tls(e) => write!(f, "tls error: {e}"), Error::InvalidDnsName(n) => write!(f, "invalid DNS name: {n}"), } } } impl std::error::Error for Error { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { match self { Error::Io(e) => Some(e), Error::Tls(e) => Some(&**e), Error::InvalidDnsName(_) => None, } } } impl From for Error { fn from(e: io::Error) -> Self { Error::Io(e) } }