//! Async TLS streams backed by OpenSSL
//!
//! This library is an implementation of TLS streams using OpenSSL for
//! negotiating the connection. Each TLS stream implements the `Read` and
//! `Write` traits to interact and interoperate with the rest of the futures I/O
//! ecosystem. Client connections initiated from this crate verify hostnames
//! automatically and by default.
//!
//! This crate primarily exports this ability through two extension traits,
//! `SslConnectorExt` and `SslAcceptorExt`. These traits augment the
//! functionality provided by the `openssl` crate, on which this crate is
//! built. Configuration of TLS parameters is still primarily done through the
//! `openssl` crate.

#![deny(missing_docs)]

extern crate futures;
extern crate openssl;
extern crate tokio_core;
extern crate tokio_io;

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

use futures::{Poll, Future, Async};
use openssl::ssl::{self, SslAcceptor, SslConnector, ConnectConfiguration, Error, HandshakeError,
                   ShutdownResult};
use tokio_io::{AsyncRead, AsyncWrite};
#[allow(deprecated)]
use tokio_core::io::Io;

/// A wrapper around an underlying raw stream which implements the SSL
/// protocol.
///
/// A `SslStream<S>` represents a handshake that has been completed successfully
/// and both the server and the client are ready for receiving and sending
/// data. Bytes read from a `SslStream` are decrypted from `S` and bytes written
/// to a `SslStream` are encrypted when passing through to `S`.
#[derive(Debug)]
pub struct SslStream<S> {
    inner: ssl::SslStream<S>,
}

/// Future returned from `SslConnectorExt::connect_async` which will resolve
/// once the connection handshake has finished.
pub struct ConnectAsync<S> {
    inner: MidHandshake<S>,
}

/// Future returned from `SslAcceptorExt::accept_async` which will resolve
/// once the accept handshake has finished.
pub struct AcceptAsync<S> {
    inner: MidHandshake<S>,
}

struct MidHandshake<S> {
    inner: Option<Result<ssl::SslStream<S>, HandshakeError<S>>>,
}

/// Extension trait for the `SslConnector` type in the `openssl` crate.
pub trait SslConnectorExt {
    /// Connects the provided stream with this connector, assuming the provided
    /// domain.
    ///
    /// This function will internally call `SslConnector::connect` to connect
    /// the stream and returns a future representing the resolution of the
    /// connection operation. The returned future will resolve to either
    /// `SslStream<S>` or `Error` depending if it's successful or not.
    ///
    /// This is typically used for clients who have already established, for
    /// example, a TCP connection to a remote server. That stream is then
    /// provided here to perform the client half of a connection to a
    /// TLS-powered server.
    // TODO change to AsyncRead/Write on major bump all throughout this file
    fn connect_async<S>(&self, domain: &str, stream: S) -> ConnectAsync<S>
        where S: Read + Write;

    /// Connects the provided stream with this connector, without performing
    /// hostname verification.
    ///
    /// # Warning
    ///
    /// You should think very carefully before you use this method. If hostname
    /// verification is not used, *any* valid certificate for *any* site will
    /// be trusted for use from any other. This introduces a significant
    /// vulnerability to man-in-the-middle attacks.
    fn danger_connect_without_providing_domain_for_certificate_verification_and_server_name_indication_async
        <S>(&self, stream: S) -> ConnectAsync<S>
        where S: Read + Write;
}

/// Extension trait for the `ConnectConfiguration` type in the `openssl` crate.
pub trait ConnectConfigurationExt {
    /// Connects the provided stream with this connector, assuming the provided
    /// domain.
    ///
    /// This function will internally call `ConnectConfiguration::connect` to
    /// connect the stream and returns a future representing the resolution of
    /// the connection operation. The returned future will resolve to either
    /// `SslStream<S>` or `Error` depending if it's successful or not.
    ///
    /// This is typically used for clients who have already established, for
    /// example, a TCP connection to a remote server. That stream is then
    /// provided here to perform the client half of a connection to a
    /// TLS-powered server.
    // TODO change to AsyncRead/Write on major bump all throughout this file
    fn connect_async<S>(self, domain: &str, stream: S) -> ConnectAsync<S>
        where S: Read + Write;

    /// Connects the provided stream with this connector, without performing
    /// hostname verification.
    ///
    /// # Warning
    ///
    /// You should think very carefully before you use this method. If hostname
    /// verification is not used, *any* valid certificate for *any* site will
    /// be trusted for use from any other. This introduces a significant
    /// vulnerability to man-in-the-middle attacks.
    fn danger_connect_without_providing_domain_for_certificate_verification_and_server_name_indication_async
        <S>(self, stream: S) -> ConnectAsync<S>
        where S: Read + Write;
}

/// Extension trait for the `SslAcceptor` type in the `openssl` crate.
pub trait SslAcceptorExt {
    /// Accepts a new client connection with the provided stream.
    ///
    /// This function will internally call `SslAcceptor::accept` to connect
    /// the stream and returns a future representing the resolution of the
    /// connection operation. The returned future will resolve to either
    /// `SslStream<S>` or `Error` depending if it's successful or not.
    ///
    /// This is typically used after a new socket has been accepted from a
    /// `TcpListener`. That socket is then passed to this function to perform
    /// the server half of accepting a client connection.
    fn accept_async<S>(&self, stream: S) -> AcceptAsync<S>
        where S: Read + Write;
}

impl<S> SslStream<S> {
    /// Get access to the internal `openssl::SslStream` stream which also
    /// transitively allows access to `S`.
    pub fn get_ref(&self) -> &ssl::SslStream<S> {
        &self.inner
    }

    /// Get mutable access to the internal `openssl::SslStream` stream which
    /// also transitively allows mutable access to `S`.
    pub fn get_mut(&mut self) -> &mut ssl::SslStream<S> {
        &mut self.inner
    }
}
impl<S> From<ssl::SslStream<S>> for SslStream<S> {
    fn from(ssl: ssl::SslStream<S>) -> Self {
        Self {
            inner: ssl
        }
    }
}

impl<S: Read + Write> Read for SslStream<S> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        self.inner.read(buf)
    }
}

impl<S: Read + Write> Write for SslStream<S> {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        self.inner.write(buf)
    }

    fn flush(&mut self) -> io::Result<()> {
        self.inner.flush()
    }
}

#[allow(deprecated)]
impl<S: Io> Io for SslStream<S> {
}

impl<S: AsyncRead + AsyncWrite> AsyncRead for SslStream<S> {
    unsafe fn prepare_uninitialized_buffer(&self, _: &mut [u8]) -> bool {
        // Note that this does not forward to `S` because the buffer is
        // unconditionally filled in by OpenSSL, not the actual object `S`.
        // We're decrypting bytes from `S` into the buffer above!
        true
    }
}

impl<S: AsyncRead + AsyncWrite> AsyncWrite for SslStream<S> {
    fn shutdown(&mut self) -> Poll<(), io::Error> {
        match self.inner.shutdown() {
            Ok(ShutdownResult::Sent) |
            Ok(ShutdownResult::Received) |
            Err(ssl::Error::ZeroReturn) => Ok(Async::Ready(())),
            Err(ssl::Error::Stream(e)) => Err(e),
            Err(ssl::Error::WantRead(_e)) |
            Err(ssl::Error::WantWrite(_e)) => Ok(Async::NotReady),
            Err(e) => Err(io::Error::new(io::ErrorKind::Other, e)),
        }
    }
}

impl SslConnectorExt for SslConnector {
    fn connect_async<S>(&self, domain: &str, stream: S) -> ConnectAsync<S>
        where S: Read + Write,
    {
        ConnectAsync {
            inner: MidHandshake {
                inner: Some(self.connect(domain, stream)),
            },
        }
    }

    fn danger_connect_without_providing_domain_for_certificate_verification_and_server_name_indication_async
        <S>(&self, stream: S) -> ConnectAsync<S>
        where S: Read + Write
    {
        ConnectAsync {
            inner: MidHandshake {
                inner: Some(self.danger_connect_without_providing_domain_for_certificate_verification_and_server_name_indication(stream)),
            },
        }
    }
}

impl ConnectConfigurationExt for ConnectConfiguration {
    fn connect_async<S>(self, domain: &str, stream: S) -> ConnectAsync<S>
        where S: Read + Write,
    {
        ConnectAsync {
            inner: MidHandshake {
                inner: Some(self.connect(domain, stream)),
            },
        }
    }

    fn danger_connect_without_providing_domain_for_certificate_verification_and_server_name_indication_async
        <S>(self, stream: S) -> ConnectAsync<S>
        where S: Read + Write
    {
        ConnectAsync {
            inner: MidHandshake {
                inner: Some(self.danger_connect_without_providing_domain_for_certificate_verification_and_server_name_indication(stream)),
            },
        }
    }
}

impl SslAcceptorExt for SslAcceptor {
    fn accept_async<S>(&self, stream: S) -> AcceptAsync<S>
        where S: Read + Write,
    {
        AcceptAsync {
            inner: MidHandshake {
                inner: Some(self.accept(stream)),
            },
        }
    }
}

impl<S: Read + Write> Future for ConnectAsync<S> {
    type Item = SslStream<S>;
    type Error = Error;

    fn poll(&mut self) -> Poll<SslStream<S>, Error> {
        self.inner.poll()
    }
}

impl<S: Read + Write> Future for AcceptAsync<S> {
    type Item = SslStream<S>;
    type Error = Error;

    fn poll(&mut self) -> Poll<SslStream<S>, Error> {
        self.inner.poll()
    }
}

impl<S: Read + Write> Future for MidHandshake<S> {
    type Item = SslStream<S>;
    type Error = Error;

    fn poll(&mut self) -> Poll<SslStream<S>, Error> {
        match self.inner.take().expect("cannot poll MidHandshake twice") {
            Ok(stream) => Ok(SslStream { inner: stream }.into()),
            Err(HandshakeError::Failure(e)) => Err(e.into_error()),
            Err(HandshakeError::SetupFailure(e)) => Err(Error::Ssl(e)),
            Err(HandshakeError::Interrupted(s)) => {
                match s.handshake() {
                    Ok(stream) => Ok(SslStream { inner: stream }.into()),
                    Err(HandshakeError::Failure(e)) => Err(e.into_error()),
                    Err(HandshakeError::SetupFailure(e)) => Err(Error::Ssl(e)),
                    Err(HandshakeError::Interrupted(s)) => {
                        self.inner = Some(Err(HandshakeError::Interrupted(s)));
                        Ok(Async::NotReady)
                    }
                }
            }
        }
    }
}