A TcpStream with pluggable TLS support.

Wraps std::net::TcpStream in a TcpStream enum that can be upgraded to a TLS-encrypted stream via TcpStream::into_tls. Supported backends are rustls (default), native-tls, and OpenSSL. Async futures-io trait implementations are provided when the futures feature is enabled.

Feature flags

Async runtime (pick exactly one)

Flag	Notes
tokio (default)	Requires a running Tokio runtime
smol	Uses the smol executor
async-global-executor	Uses async-global-executor

TLS backend (pick at most one)

Flag	Notes
rustls (default)	TLS via rustls
native-tls	TLS via the platform's native library
openssl	TLS via OpenSSL

Rustls certificate store (when rustls is active)

Flag	Notes
rustls-platform-verifier (default)	Uses the platform trust store
rustls-native-certs	Loads native root certificates
rustls-webpki-roots-certs	Uses the webpki bundled root set

Rustls crypto provider (at least one required)

Flag	Notes
rustls--aws_lc_rs (default)	Uses aws-lc-rs
rustls--ring	Uses ring (more portable, e.g. builds on Windows)

Miscellaneous

Flag	Notes
futures	Enable futures-io async trait impls on the encrypted stream
vendored-openssl	Build a vendored OpenSSL (requires openssl feature)

Example

To connect to a remote server:

use tcp_stream::{HandshakeError, TcpStream, TLSConfig};

use std::io::{self, Read, Write};

fn main() {
    let stream = TcpStream::connect("google.com:443").unwrap();
    let mut stream = stream.into_tls("google.com", TLSConfig::default());

    while let Err(HandshakeError::WouldBlock(mid_handshake)) = stream {
        stream = mid_handshake.handshake();
    }

    let mut stream = stream.unwrap();

    while let Err(err) = stream.write_all(b"GET / HTTP/1.0\r\n\r\n") {
        if err.kind() != io::ErrorKind::WouldBlock {
            panic!("error: {:?}", err);
        }
    }
    stream.flush().unwrap();
    let mut res = vec![];
    while let Err(err) = stream.read_to_end(&mut res) {
        if err.kind() != io::ErrorKind::WouldBlock {
            panic!("stream error: {:?}", err);
        }
    }
    println!("{}", String::from_utf8_lossy(&res));
}