1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
// 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::convert::TryFrom;
use std::{fmt, io, sync::Arc};
/// TLS configuration.
#[derive(Clone)]
pub struct Config {
pub(crate) client: TlsConnector,
pub(crate) server: Option<TlsAcceptor>,
}
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.
#[derive(Clone)]
pub struct PrivateKey(rustls::PrivateKey);
impl PrivateKey {
/// Assert the given bytes are DER-encoded ASN.1 in either PKCS#8 or PKCS#1 format.
pub fn new(bytes: Vec<u8>) -> Self {
PrivateKey(rustls::PrivateKey(bytes))
}
}
/// Certificate, DER-encoded X.509 format.
#[derive(Debug, Clone)]
pub struct Certificate(rustls::Certificate);
impl Certificate {
/// Assert the given bytes are in DER-encoded X.509 format.
pub fn new(bytes: Vec<u8>) -> Self {
Certificate(rustls::Certificate(bytes))
}
}
impl Config {
/// Create a new TLS configuration with the given server key and certificate chain.
pub fn new<I>(key: PrivateKey, certs: I) -> Result<Self, Error>
where
I: IntoIterator<Item = Certificate>,
{
let mut builder = Config::builder();
builder.server(key, certs)?;
Ok(builder.finish())
}
/// Create a client-only configuration.
pub fn client() -> Self {
let client = rustls::ClientConfig::builder()
.with_safe_defaults()
.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.add_trust_anchors(webpki_roots::TLS_SERVER_ROOTS.iter().map(|ta| {
rustls::OwnedTrustAnchor::from_subject_spki_name_constraints(
ta.subject,
ta.spki,
ta.name_constraints,
)
}));
client_root_store
}
/// TLS configuration builder.
pub struct Builder {
client_root_store: rustls::RootCertStore,
server: Option<rustls::ServerConfig>,
}
impl Builder {
/// Set server key and certificate chain.
pub fn server<I>(&mut self, key: PrivateKey, certs: I) -> Result<&mut Self, Error>
where
I: IntoIterator<Item = Certificate>,
{
let certs = certs.into_iter().map(|c| c.0).collect();
let server = rustls::ServerConfig::builder()
.with_safe_defaults()
.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)
.map_err(|e| Error::Tls(Box::new(e)))?;
Ok(self)
}
/// Finish configuration.
pub fn finish(self) -> Config {
let client = rustls::ClientConfig::builder()
.with_safe_defaults()
.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<rustls::ServerName, Error> {
rustls::ServerName::try_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<dyn std::error::Error + Send + Sync>),
/// 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<io::Error> for Error {
fn from(e: io::Error) -> Self {
Error::Io(e)
}
}