Remove async-native-tls dependency

Author: link2xt

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Remove `async-native-tls` dependency. TLS streams should be created by the library users as documented in `lib.rs`. #68
 - Do not generate artificial "broken pipe" errors when attempting to send a request
   after reaching EOF on the response stream. #73
 - Do not attempt to track if the stream is closed or not.

Cargo.toml

@@ -21,8 +21,8 @@ is-it-maintained-open-issues = { repository = "async-email/async-imap" }
 [features]
 default = ["runtime-async-std"]
 
-runtime-async-std = ["async-std", "async-native-tls?/runtime-async-std"]
-runtime-tokio = ["tokio", "async-native-tls?/runtime-tokio"]
+runtime-async-std = ["async-std"]
+runtime-tokio = ["tokio"]
 
 [dependencies]
 imap-proto = "0.16.1"
@@ -39,7 +39,6 @@ log = "0.4.8"
 thiserror = "1.0.9"
 async-channel = "1.6.1"
 
-async-native-tls = { version = "0.4", default-features = false, optional = true }
 async-std = { version = "1.8.0", default-features = false, features = ["std", "unstable"], optional = true }
 tokio = { version = "1", features = ["net", "sync", "time", "io-util"], optional = true }
 
@@ -48,4 +47,3 @@ tokio = { version = "1", features = ["net", "sync", "time", "io-util"], optional
 pretty_assertions = "1.2"
 async-std = { version = "1.8.0", features = ["std", "attributes"] }
 tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
-

src/client.rs

@@ -4,15 +4,6 @@ use std::ops::{Deref, DerefMut};
 use std::pin::Pin;
 use std::str;
 
-#[cfg(feature = "async-native-tls")]
-use async_native_tls::{TlsConnector, TlsStream};
-
-#[cfg(all(feature = "async-native-tls", feature = "runtime-tokio"))]
-use tokio::net::{TcpStream, ToSocketAddrs};
-
-#[cfg(all(feature = "async-native-tls", feature = "runtime-async-std"))]
-use async_std::net::{TcpStream, ToSocketAddrs};
-
 use async_channel::{self as channel, bounded};
 #[cfg(feature = "runtime-async-std")]
 use async_std::io::{Read, Write, WriteExt};
@@ -118,68 +109,6 @@ impl<T: Read + Write + Unpin + fmt::Debug> DerefMut for Session<T> {
     }
 }
 
-/// Connect to a server using a TLS-encrypted connection.
-///
-/// The returned [`Client`] is unauthenticated; to access session-related methods (through
-/// [`Session`]), use [`Client::login`] or [`Client::authenticate`].
-///
-/// The domain must be passed in separately from the `TlsConnector` so that the certificate of the
-/// IMAP server can be validated.
-///
-/// # Examples
-///
-/// ```no_run
-/// # fn main() -> async_imap::error::Result<()> {
-/// # async_std::task::block_on(async {
-///
-/// let tls = async_native_tls::TlsConnector::new();
-/// let client = async_imap::connect(("imap.example.org", 993), "imap.example.org", tls).await?;
-///
-/// # Ok(())
-/// # }) }
-/// ```
-#[cfg(feature = "async-native-tls")]
-pub async fn connect<A: ToSocketAddrs, S: AsRef<str>>(
-    addr: A,
-    domain: S,
-    ssl_connector: TlsConnector,
-) -> Result<Client<TlsStream<TcpStream>>> {
-    let stream = TcpStream::connect(addr).await?;
-    let ssl_stream = ssl_connector.connect(domain.as_ref(), stream).await?;
-
-    let mut client = Client::new(ssl_stream);
-    let _greeting = match client.read_response().await {
-        Some(greeting) => greeting,
-        None => {
-            return Err(Error::Bad(
-                "could not read server Greeting after connect".into(),
-            ));
-        }
-    };
-
-    Ok(client)
-}
-
-impl<T: Read + Write + Unpin + fmt::Debug + Send> Client<T> {
-    /// This will upgrade an IMAP client from using a regular TCP connection to use TLS.
-    ///
-    /// The domain parameter is required to perform hostname verification.
-    #[cfg(feature = "async-native-tls")]
-    pub async fn secure<S: AsRef<str>>(
-        mut self,
-        domain: S,
-        ssl_connector: TlsConnector,
-    ) -> Result<Client<TlsStream<T>>> {
-        self.run_command_and_check_ok("STARTTLS", None).await?;
-        let ssl_stream = ssl_connector
-            .connect(domain.as_ref(), self.conn.stream.into_inner())
-            .await?;
-
-        let client = Client::new(ssl_stream);
-        Ok(client)
-    }
-}
-
 // As the pattern of returning the unauthenticated `Client` (a.k.a. `self`) back with a login error
 // is relatively common, it's abstacted away into a macro here.
 //

src/error.rs

@@ -31,10 +31,6 @@ pub enum Error {
     /// strings](https://tools.ietf.org/html/rfc3501#section-4.3).
     #[error("validate: {0}")]
     Validate(#[from] ValidateError),
-    /// `async_native_tls` error
-    #[cfg(feature = "async-native-tls")]
-    #[error("async_native_tls: {0}")]
-    NativeTlsError(#[from] async_native_tls::Error),
     /// Error appending an e-mail.
     #[error("could not append mail to mailbox")]
     Append,