tcp_stream/
lib.rs

1#![deny(missing_docs)]
2#![allow(clippy::large_enum_variant, clippy::result_large_err)]
3
4//! # std::net::TCP stream on steroids
5//!
6//! tcp-stream is a library aiming at providing TLS support to std::net::TcpStream
7//!
8//! # Examples
9//!
10//! To connect to a remote server:
11//!
12//! ```rust
13//! use tcp_stream::{HandshakeError, TcpStream, TLSConfig};
14//!
15//! use std::io::{self, Read, Write};
16//!
17//! let mut stream = TcpStream::connect("www.rust-lang.org:443").unwrap();
18//! stream.set_nonblocking(true).unwrap();
19//!
20//! loop {
21//!     if stream.try_connect().unwrap() {
22//!         break;
23//!     }
24//! }
25//!
26//! let mut stream = stream.into_tls("www.rust-lang.org", TLSConfig::default());
27//!
28//! while let Err(HandshakeError::WouldBlock(mid_handshake)) = stream {
29//!     stream = mid_handshake.handshake();
30//! }
31//!
32//! let mut stream = stream.unwrap();
33//!
34//! while let Err(err) = stream.write_all(b"GET / HTTP/1.0\r\n\r\n") {
35//!     if err.kind() != io::ErrorKind::WouldBlock {
36//!         panic!("error: {:?}", err);
37//!     }
38//! }
39//!
40//! while let Err(err) = stream.flush() {
41//!     if err.kind() != io::ErrorKind::WouldBlock {
42//!         panic!("error: {:?}", err);
43//!     }
44//! }
45//!
46//! let mut res = vec![];
47//! while let Err(err) = stream.read_to_end(&mut res) {
48//!     if err.kind() != io::ErrorKind::WouldBlock {
49//!         panic!("stream error: {:?}", err);
50//!     }
51//! }
52//! println!("{}", String::from_utf8_lossy(&res));
53//! ```
54
55use cfg_if::cfg_if;
56use std::{
57    convert::TryFrom,
58    error::Error,
59    fmt,
60    io::{self, IoSlice, IoSliceMut, Read, Write},
61    net::{TcpStream as StdTcpStream, ToSocketAddrs},
62    ops::{Deref, DerefMut},
63    time::Duration,
64};
65
66#[cfg(feature = "rustls")]
67mod rustls_impl;
68#[cfg(feature = "rustls")]
69pub use rustls_impl::*;
70
71#[cfg(feature = "native-tls")]
72mod native_tls_impl;
73#[cfg(feature = "native-tls")]
74pub use native_tls_impl::*;
75
76#[cfg(feature = "openssl")]
77mod openssl_impl;
78#[cfg(feature = "openssl")]
79pub use openssl_impl::*;
80
81#[cfg(feature = "futures")]
82mod futures;
83#[cfg(feature = "futures")]
84pub use futures::*;
85
86/// Wrapper around plain or TLS TCP streams
87#[non_exhaustive]
88pub enum TcpStream {
89    /// Wrapper around std::net::TcpStream
90    Plain(StdTcpStream),
91    #[cfg(feature = "native-tls")]
92    /// Wrapper around a TLS stream hanled by native-tls
93    NativeTls(NativeTlsStream),
94    #[cfg(feature = "openssl")]
95    /// Wrapper around a TLS stream hanled by openssl
96    Openssl(OpensslStream),
97    #[cfg(feature = "rustls")]
98    /// Wrapper around a TLS stream hanled by rustls
99    Rustls(RustlsStream),
100}
101
102/// Holds extra TLS configuration
103#[derive(Default, Debug, PartialEq)]
104pub struct TLSConfig<'data, 'key, 'chain> {
105    /// Use for client certificate authentication
106    pub identity: Option<Identity<'data, 'key>>,
107    /// The custom certificates chain in PEM format
108    pub cert_chain: Option<&'chain str>,
109}
110
111/// Holds extra TLS configuration
112#[derive(Clone, Default, Debug, PartialEq)]
113pub struct OwnedTLSConfig {
114    /// Use for client certificate authentication
115    pub identity: Option<OwnedIdentity>,
116    /// The custom certificates chain in PEM format
117    pub cert_chain: Option<String>,
118}
119
120impl OwnedTLSConfig {
121    /// Get the ephemeral `TLSConfig` corresponding to the `OwnedTLSConfig`
122    #[must_use]
123    pub fn as_ref(&self) -> TLSConfig<'_, '_, '_> {
124        TLSConfig {
125            identity: self.identity.as_ref().map(OwnedIdentity::as_ref),
126            cert_chain: self.cert_chain.as_deref(),
127        }
128    }
129}
130
131/// Holds one of:
132/// - PKCS#12 DER-encoded identity and decryption password
133/// - PKCS#8 PEM-encoded certificate and key (without decryption password)
134#[derive(Debug, PartialEq)]
135pub enum Identity<'data, 'key> {
136    /// PKCS#12 DER-encoded identity with decryption password
137    PKCS12 {
138        /// PKCS#12 DER-encoded identity
139        der: &'data [u8],
140        /// Decryption password
141        password: &'key str,
142    },
143    /// PEM encoded DER private key with PEM encoded certificate
144    PKCS8 {
145        /// PEM-encoded certificate
146        pem: &'data [u8],
147        /// PEM-encoded key
148        key: &'key [u8],
149    },
150}
151
152/// Holds one of:
153/// - PKCS#12 DER-encoded identity and decryption password
154/// - PKCS#8 PEM-encoded certificate and key (without decryption password)
155#[derive(Clone, Debug, PartialEq)]
156pub enum OwnedIdentity {
157    /// PKCS#12 DER-encoded identity with decryption password
158    PKCS12 {
159        /// PKCS#12 DER-encoded identity
160        der: Vec<u8>,
161        /// Decryption password
162        password: String,
163    },
164    /// PKCS#8 encoded DER private key with PEM encoded certificate
165    PKCS8 {
166        /// PEM-encoded certificate
167        pem: Vec<u8>,
168        /// PEM-encoded key
169        key: Vec<u8>,
170    },
171}
172
173impl OwnedIdentity {
174    /// Get the ephemeral `Identity` corresponding to the `OwnedIdentity`
175    #[must_use]
176    pub fn as_ref(&self) -> Identity<'_, '_> {
177        match self {
178            Self::PKCS8 { pem, key } => Identity::PKCS8 { pem, key },
179            Self::PKCS12 { der, password } => Identity::PKCS12 { der, password },
180        }
181    }
182}
183
184/// Holds either the TLS `TcpStream` result or the current handshake state
185pub type HandshakeResult = Result<TcpStream, HandshakeError>;
186
187impl TcpStream {
188    /// Wrapper around `std::net::TcpStream::connect`
189    pub fn connect<A: ToSocketAddrs>(addr: A) -> io::Result<Self> {
190        connect_std(addr, None).and_then(Self::try_from)
191    }
192
193    /// Wrapper around `std::net::TcpStream::connect_timeout`
194    pub fn connect_timeout<A: ToSocketAddrs>(addr: A, timeout: Duration) -> io::Result<Self> {
195        connect_std(addr, Some(timeout)).and_then(Self::try_from)
196    }
197
198    /// Convert from a `std::net::TcpStream`
199    pub fn from_std(stream: StdTcpStream) -> io::Result<Self> {
200        Self::try_from(stream)
201    }
202
203    /// Attempt reading from underlying stream, returning Ok(()) if the stream is readable
204    pub fn is_readable(&self) -> io::Result<()> {
205        self.deref().read(&mut []).map(|_| ())
206    }
207
208    /// Attempt writing to underlying stream, returning Ok(()) if the stream is writable
209    pub fn is_writable(&self) -> io::Result<()> {
210        is_writable(self.deref())
211    }
212
213    /// Retry the connection. Returns:
214    /// - Ok(true) if connected
215    /// - Ok(false) if connecting
216    /// - Err(_) if an error is encountered
217    pub fn try_connect(&mut self) -> io::Result<bool> {
218        try_connect(self)
219    }
220
221    /// Enable TLS
222    pub fn into_tls(
223        self,
224        domain: &str,
225        config: TLSConfig<'_, '_, '_>,
226    ) -> Result<Self, HandshakeError> {
227        into_tls_impl(self, domain, config)
228    }
229
230    #[cfg(feature = "native-tls")]
231    /// Enable TLS using native-tls
232    pub fn into_native_tls(
233        self,
234        connector: &NativeTlsConnector,
235        domain: &str,
236    ) -> Result<Self, HandshakeError> {
237        Ok(connector.connect(domain, self.into_plain()?)?.into())
238    }
239
240    #[cfg(feature = "openssl")]
241    /// Enable TLS using openssl
242    pub fn into_openssl(
243        self,
244        connector: &OpensslConnector,
245        domain: &str,
246    ) -> Result<Self, HandshakeError> {
247        Ok(connector.connect(domain, self.into_plain()?)?.into())
248    }
249
250    #[cfg(feature = "rustls")]
251    /// Enable TLS using rustls
252    pub fn into_rustls(
253        self,
254        connector: &RustlsConnector,
255        domain: &str,
256    ) -> Result<Self, HandshakeError> {
257        Ok(connector.connect(domain, self.into_plain()?)?.into())
258    }
259
260    #[allow(irrefutable_let_patterns)]
261    fn into_plain(self) -> Result<StdTcpStream, io::Error> {
262        if let Self::Plain(plain) = self {
263            Ok(plain)
264        } else {
265            Err(io::Error::new(
266                io::ErrorKind::AlreadyExists,
267                "already a TLS stream",
268            ))
269        }
270    }
271}
272
273fn connect_std<A: ToSocketAddrs>(addr: A, timeout: Option<Duration>) -> io::Result<StdTcpStream> {
274    if let Some(timeout) = timeout {
275        let addrs = addr.to_socket_addrs()?;
276        let mut err = None;
277        for addr in addrs {
278            match StdTcpStream::connect_timeout(&addr, timeout) {
279                Ok(stream) => return Ok(stream),
280                Err(error) => err = Some(error),
281            }
282        }
283        Err(err.unwrap_or_else(|| {
284            io::Error::new(io::ErrorKind::AddrNotAvailable, "couldn't resolve host")
285        }))
286    } else {
287        StdTcpStream::connect(addr)
288    }
289}
290
291fn try_connect(stream: &mut StdTcpStream) -> io::Result<bool> {
292    match is_writable(stream) {
293        Ok(()) => Ok(true),
294        Err(err)
295            if [io::ErrorKind::WouldBlock, io::ErrorKind::NotConnected].contains(&err.kind()) =>
296        {
297            Ok(false)
298        }
299        Err(err) => Err(err),
300    }
301}
302
303fn is_writable(mut stream: &StdTcpStream) -> io::Result<()> {
304    stream.write(&[]).map(|_| ())
305}
306
307fn into_tls_impl(s: TcpStream, domain: &str, config: TLSConfig<'_, '_, '_>) -> HandshakeResult {
308    cfg_if! {
309        if #[cfg(feature = "rustls-platform-verifier")] {
310            into_rustls_impl(s, RustlsConnectorConfig::new_with_platform_verifier(), domain, config)
311        } else if #[cfg(feature = "rustls-native-certs")] {
312            into_rustls_impl(s, RustlsConnectorConfig::new_with_native_certs()?, domain, config)
313        } else if #[cfg(feature = "rustls-webpki-roots-certs")] {
314            into_rustls_impl(s, RustlsConnectorConfig::new_with_webpki_root_certs(), domain, config)
315        } else if #[cfg(feature = "rustls")] {
316            into_rustls_impl(s, RustlsConnectorConfig::default(), domain, config)
317        } else if #[cfg(feature = "openssl")] {
318            into_openssl_impl(s, domain, config)
319        } else if #[cfg(feature = "native-tls")] {
320            into_native_tls_impl(s, domain, config)
321        } else {
322            let _ = (domain, config);
323            Ok(TcpStream::Plain(s.into_plain()?))
324        }
325    }
326}
327
328impl TryFrom<StdTcpStream> for TcpStream {
329    type Error = io::Error;
330
331    fn try_from(s: StdTcpStream) -> io::Result<Self> {
332        s.set_nodelay(true)?;
333        let mut this = Self::Plain(s);
334        this.try_connect()?;
335        Ok(this)
336    }
337}
338
339impl Deref for TcpStream {
340    type Target = StdTcpStream;
341
342    fn deref(&self) -> &Self::Target {
343        match self {
344            Self::Plain(plain) => plain,
345            #[cfg(feature = "native-tls")]
346            Self::NativeTls(tls) => tls.get_ref(),
347            #[cfg(feature = "openssl")]
348            Self::Openssl(tls) => tls.get_ref(),
349            #[cfg(feature = "rustls")]
350            Self::Rustls(tls) => tls.get_ref(),
351        }
352    }
353}
354
355impl DerefMut for TcpStream {
356    fn deref_mut(&mut self) -> &mut Self::Target {
357        match self {
358            Self::Plain(plain) => plain,
359            #[cfg(feature = "native-tls")]
360            Self::NativeTls(tls) => tls.get_mut(),
361            #[cfg(feature = "openssl")]
362            Self::Openssl(tls) => tls.get_mut(),
363            #[cfg(feature = "rustls")]
364            Self::Rustls(tls) => tls.get_mut(),
365        }
366    }
367}
368
369macro_rules! fwd_impl {
370    ($self:ident, $method:ident, $($args:expr),*) => {
371        match $self {
372            Self::Plain(plain) => plain.$method($($args),*),
373            #[cfg(feature = "native-tls")]
374            Self::NativeTls(tls) => tls.$method($($args),*),
375            #[cfg(feature = "openssl")]
376            Self::Openssl(tls) => tls.$method($($args),*),
377            #[cfg(feature = "rustls")]
378            Self::Rustls(tls) => tls.$method($($args),*),
379        }
380    };
381}
382
383impl Read for TcpStream {
384    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
385        fwd_impl!(self, read, buf)
386    }
387
388    fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> io::Result<usize> {
389        fwd_impl!(self, read_vectored, bufs)
390    }
391
392    fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
393        fwd_impl!(self, read_to_end, buf)
394    }
395
396    fn read_to_string(&mut self, buf: &mut String) -> io::Result<usize> {
397        fwd_impl!(self, read_to_string, buf)
398    }
399
400    fn read_exact(&mut self, buf: &mut [u8]) -> io::Result<()> {
401        fwd_impl!(self, read_exact, buf)
402    }
403}
404
405impl Write for TcpStream {
406    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
407        fwd_impl!(self, write, buf)
408    }
409
410    fn flush(&mut self) -> io::Result<()> {
411        fwd_impl!(self, flush,)
412    }
413
414    fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
415        fwd_impl!(self, write_vectored, bufs)
416    }
417
418    fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
419        fwd_impl!(self, write_all, buf)
420    }
421
422    fn write_fmt(&mut self, fmt: fmt::Arguments<'_>) -> io::Result<()> {
423        fwd_impl!(self, write_fmt, fmt)
424    }
425}
426
427impl fmt::Debug for TcpStream {
428    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
429        f.debug_struct("TcpStream")
430            .field("inner", self.deref())
431            .finish()
432    }
433}
434
435/// A TLS stream which has been interrupted during the handshake
436#[derive(Debug)]
437pub enum MidHandshakeTlsStream {
438    /// Not a TLS stream
439    Plain(TcpStream),
440    #[cfg(feature = "native-tls")]
441    /// A native-tls MidHandshakeTlsStream
442    NativeTls(NativeTlsMidHandshakeTlsStream),
443    #[cfg(feature = "openssl")]
444    /// An openssl MidHandshakeTlsStream
445    Openssl(OpensslMidHandshakeTlsStream),
446    #[cfg(feature = "rustls")]
447    /// A rustls-connector MidHandshakeTlsStream
448    Rustls(RustlsMidHandshakeTlsStream),
449}
450
451impl MidHandshakeTlsStream {
452    /// Get a reference to the inner stream
453    #[must_use]
454    pub fn get_ref(&self) -> &StdTcpStream {
455        match self {
456            Self::Plain(mid) => mid,
457            #[cfg(feature = "native-tls")]
458            Self::NativeTls(mid) => mid.get_ref(),
459            #[cfg(feature = "openssl")]
460            Self::Openssl(mid) => mid.get_ref(),
461            #[cfg(feature = "rustls")]
462            Self::Rustls(mid) => mid.get_ref(),
463        }
464    }
465
466    /// Get a mutable reference to the inner stream
467    #[must_use]
468    pub fn get_mut(&mut self) -> &mut StdTcpStream {
469        match self {
470            Self::Plain(mid) => mid,
471            #[cfg(feature = "native-tls")]
472            Self::NativeTls(mid) => mid.get_mut(),
473            #[cfg(feature = "openssl")]
474            Self::Openssl(mid) => mid.get_mut(),
475            #[cfg(feature = "rustls")]
476            Self::Rustls(mid) => mid.get_mut(),
477        }
478    }
479
480    /// Retry the handshake
481    pub fn handshake(mut self) -> HandshakeResult {
482        if !try_connect(self.get_mut())? {
483            return Err(HandshakeError::WouldBlock(self));
484        }
485
486        Ok(match self {
487            Self::Plain(mid) => mid,
488            #[cfg(feature = "native-tls")]
489            Self::NativeTls(mid) => mid.handshake()?.into(),
490            #[cfg(feature = "openssl")]
491            Self::Openssl(mid) => mid.handshake()?.into(),
492            #[cfg(feature = "rustls")]
493            Self::Rustls(mid) => mid.handshake()?.into(),
494        })
495    }
496}
497
498impl From<TcpStream> for MidHandshakeTlsStream {
499    fn from(mid: TcpStream) -> Self {
500        Self::Plain(mid)
501    }
502}
503
504impl fmt::Display for MidHandshakeTlsStream {
505    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
506        f.write_str("MidHandshakeTlsStream")
507    }
508}
509
510/// An error returned while performing the handshake
511#[derive(Debug)]
512pub enum HandshakeError {
513    /// We hit WouldBlock during handshake
514    WouldBlock(MidHandshakeTlsStream),
515    /// We hit a critical failure
516    Failure(io::Error),
517}
518
519impl HandshakeError {
520    /// Try and get the inner mid handshake TLS stream from this error
521    pub fn into_mid_handshake_tls_stream(self) -> io::Result<MidHandshakeTlsStream> {
522        match self {
523            Self::WouldBlock(mid) => Ok(mid),
524            Self::Failure(error) => Err(error),
525        }
526    }
527}
528
529impl fmt::Display for HandshakeError {
530    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
531        match self {
532            Self::WouldBlock(_) => f.write_str("WouldBlock hit during handshake"),
533            Self::Failure(err) => f.write_fmt(format_args!("IO error: {err}")),
534        }
535    }
536}
537
538impl Error for HandshakeError {
539    fn source(&self) -> Option<&(dyn Error + 'static)> {
540        match self {
541            Self::Failure(err) => Some(err),
542            _ => None,
543        }
544    }
545}
546
547impl From<io::Error> for HandshakeError {
548    fn from(err: io::Error) -> Self {
549        Self::Failure(err)
550    }
551}
552
553mod sys;
tcp_stream/lib.rs

tcp_stream/
lib.rs
