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 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
#![deny(missing_docs)]
#![warn(rust_2018_idioms)]
#![doc(html_root_url = "https://docs.rs/rustls-connector/0.19.2/")]
//! # Connector similar to openssl or native-tls for rustls
//!
//! rustls-connector is a library aiming at simplifying using rustls as
//! an alternative to openssl and native-tls
//!
//! # Examples
//!
//! To connect to a remote server:
//!
//! ```rust, no_run
//! use rustls_connector::RustlsConnector;
//!
//! use std::{
//! io::{Read, Write},
//! net::TcpStream,
//! };
//!
//! let connector = RustlsConnector::new_with_native_certs().unwrap();
//! let stream = TcpStream::connect("google.com:443").unwrap();
//! let mut stream = connector.connect("google.com", stream).unwrap();
//!
//! stream.write_all(b"GET / HTTP/1.0\r\n\r\n").unwrap();
//! let mut res = vec![];
//! stream.read_to_end(&mut res).unwrap();
//! println!("{}", String::from_utf8_lossy(&res));
//! ```
pub use rustls;
#[cfg(feature = "native-certs")]
pub use rustls_native_certs;
pub use rustls_pki_types;
pub use webpki;
#[cfg(feature = "webpki-roots-certs")]
pub use webpki_roots;
use rustls::{ClientConfig, ClientConnection, RootCertStore, StreamOwned};
use rustls_pki_types::{CertificateDer, PrivateKeyDer, ServerName};
use std::{
convert::TryFrom,
error::Error,
fmt::{self, Debug},
io::{self, Read, Write},
sync::Arc,
};
/// A TLS stream
pub type TlsStream<S> = StreamOwned<ClientConnection, S>;
/// Configuration helper for [`RustlsConnector`]
#[derive(Clone)]
pub struct RustlsConnectorConfig(RootCertStore);
impl RustlsConnectorConfig {
#[cfg(feature = "webpki-roots-certs")]
/// Create a new [`RustlsConnectorConfig`] using the webpki-roots certs (requires webpki-roots-certs feature enabled)
pub fn new_with_webpki_roots_certs() -> Self {
Self(RootCertStore {
roots: webpki_roots::TLS_SERVER_ROOTS.iter().cloned().collect(),
})
}
#[cfg(feature = "native-certs")]
/// Create a new [`RustlsConnectorConfig`] using the system certs (requires native-certs feature enabled)
///
/// # Errors
///
/// Returns an error if we fail to load the native certs.
pub fn new_with_native_certs() -> io::Result<Self> {
let mut root_store = RootCertStore::empty();
for cert in rustls_native_certs::load_native_certs().expect("could not load platform certs")
{
if let Err(err) = root_store.add(cert) {
log::warn!(
"Got error while importing some native certificates: {:?}",
err
);
}
}
Ok(Self(root_store))
}
/// Parse the given DER-encoded certificates and add all that can be parsed in a best-effort fashion.
///
/// This is because large collections of root certificates often include ancient or syntactically invalid certificates.
///
/// Returns the number of certificates added, and the number that were ignored.
pub fn add_parsable_certificates(
&mut self,
der_certs: Vec<CertificateDer<'_>>,
) -> (usize, usize) {
self.0.add_parsable_certificates(der_certs)
}
/// Create a new [`RustlsConnector`] from this config and no client certificate
pub fn connector_with_no_client_auth(self) -> RustlsConnector {
ClientConfig::builder()
.with_root_certificates(self.0)
.with_no_client_auth()
.into()
}
/// Create a new [`RustlsConnector`] from this config and the given client certificate
///
/// cert_chain is a vector of DER-encoded certificates. key_der is a DER-encoded RSA, ECDSA, or
/// Ed25519 private key.
///
/// This function fails if key_der is invalid.
pub fn connector_with_single_cert(
self,
cert_chain: Vec<CertificateDer<'static>>,
key_der: PrivateKeyDer<'static>,
) -> io::Result<RustlsConnector> {
Ok(ClientConfig::builder()
.with_root_certificates(self.0)
.with_client_auth_cert(cert_chain, key_der)
.map_err(|err| io::Error::new(io::ErrorKind::InvalidData, err))?
.into())
}
}
impl Default for RustlsConnectorConfig {
fn default() -> Self {
Self(RootCertStore::empty())
}
}
/// The connector
#[derive(Clone)]
pub struct RustlsConnector(Arc<ClientConfig>);
impl Default for RustlsConnector {
fn default() -> Self {
RustlsConnectorConfig::default().connector_with_no_client_auth()
}
}
impl From<ClientConfig> for RustlsConnector {
fn from(config: ClientConfig) -> Self {
Arc::new(config).into()
}
}
impl From<Arc<ClientConfig>> for RustlsConnector {
fn from(config: Arc<ClientConfig>) -> Self {
Self(config)
}
}
impl RustlsConnector {
#[cfg(feature = "webpki-roots-certs")]
/// Create a new RustlsConnector using the webpki-roots certs (requires webpki-roots-certs feature enabled)
pub fn new_with_webpki_roots_certs() -> Self {
RustlsConnectorConfig::new_with_webpki_roots_certs().connector_with_no_client_auth()
}
#[cfg(feature = "native-certs")]
/// Create a new [`RustlsConnector`] using the system certs (requires native-certs feature enabled)
///
/// # Errors
///
/// Returns an error if we fail to load the native certs.
pub fn new_with_native_certs() -> io::Result<Self> {
Ok(RustlsConnectorConfig::new_with_native_certs()?.connector_with_no_client_auth())
}
/// Connect to the given host
///
/// # Errors
///
/// Returns a [`HandshakeError`] containing either the current state of the handshake or the
/// failure when we couldn't complete the hanshake
pub fn connect<S: Debug + Read + Send + Sync + Write + 'static>(
&self,
domain: &str,
stream: S,
) -> Result<TlsStream<S>, HandshakeError<S>> {
let session = ClientConnection::new(
self.0.clone(),
ServerName::try_from(domain)
.map_err(|err| {
HandshakeError::Failure(io::Error::new(
io::ErrorKind::InvalidData,
format!("Invalid domain name ({:?}): {}", err, domain),
))
})?
.to_owned(),
)
.map_err(|err| io::Error::new(io::ErrorKind::ConnectionAborted, err))?;
MidHandshakeTlsStream { session, stream }.handshake()
}
}
/// A TLS stream which has been interrupted during the handshake
#[derive(Debug)]
pub struct MidHandshakeTlsStream<S: Read + Write> {
session: ClientConnection,
stream: S,
}
impl<S: Debug + Read + Send + Sync + Write + 'static> MidHandshakeTlsStream<S> {
/// Get a reference to the inner stream
pub fn get_ref(&self) -> &S {
&self.stream
}
/// Get a mutable reference to the inner stream
pub fn get_mut(&mut self) -> &mut S {
&mut self.stream
}
/// Retry the handshake
///
/// # Errors
///
/// Returns a [`HandshakeError`] containing either the current state of the handshake or the
/// failure when we couldn't complete the hanshake
pub fn handshake(mut self) -> Result<TlsStream<S>, HandshakeError<S>> {
if let Err(e) = self.session.complete_io(&mut self.stream) {
if e.kind() == io::ErrorKind::WouldBlock {
if self.session.is_handshaking() {
return Err(HandshakeError::WouldBlock(Box::new(self)));
}
} else {
return Err(e.into());
}
}
Ok(TlsStream::new(self.session, self.stream))
}
}
impl<S: Read + Write> fmt::Display for MidHandshakeTlsStream<S> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("MidHandshakeTlsStream")
}
}
/// An error returned while performing the handshake
#[derive(Debug)]
pub enum HandshakeError<S: Read + Send + Sync + Write + 'static> {
/// We hit WouldBlock during handshake.
/// Note that this is not a critical failure, you should be able to call handshake again once the stream is ready to perform I/O.
WouldBlock(Box<MidHandshakeTlsStream<S>>),
/// We hit a critical failure.
Failure(io::Error),
}
impl<S: Debug + Read + Send + Sync + Write + 'static> fmt::Display for HandshakeError<S> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
HandshakeError::WouldBlock(_) => f.write_str("WouldBlock hit during handshake"),
HandshakeError::Failure(err) => f.write_fmt(format_args!("IO error: {}", err)),
}
}
}
impl<S: Debug + Read + Send + Sync + Write + 'static> Error for HandshakeError<S> {
fn source(&self) -> Option<&(dyn Error + 'static)> {
match self {
HandshakeError::Failure(err) => Some(err),
_ => None,
}
}
}
impl<S: Debug + Read + Send + Sync + Write + 'static> From<io::Error> for HandshakeError<S> {
fn from(err: io::Error) -> Self {
HandshakeError::Failure(err)
}
}