tokio-tls

An implementation of TLS/SSL streams for Tokio built on top of the native-tls crate

Documentation

Usage

First, add this to your Cargo.toml:

[dependencies]
native-tls = "0.1"
tokio-tls = "0.1"

Next, add this to your crate:

extern crate tls_api;
extern crate tokio_tls_api;

use tokio_tls::{TlsConnectorExt, TlsAcceptorExt};

You can find an example of using this crate at https://tokio.rs along with a detailed explanation of what's happening.

This crate provides two extension traits, TlsConnectorExt and TlsAcceptorExt, which augment the functionality provided by the native-tls crate. These extension traits provide the ability to connect a stream asynchronously and accept a socket asynchronously. Configuration of TLS parameters is still done through the support in the native-tls crate.

By default the native-tls crate currently uses the "platform appropriate" backend for a TLS implementation. This means:

• On Windows, SChannel is used
• On OSX, SecureTransport is used
• Everywhere else, OpenSSL is used

Typically these selections mean that you don't have to worry about a portability when using TLS, these libraries are all normally installed by default.

Interaction with tokio-proto

If you're working with a protocol that starts out with a TLS negotation on either the client or server side then you can use the proto::Client and proto::Server types in this crate for performing those tasks. To do so, you can update your dependency as such:

[dependencies]
tokio-tls = { version = "0.1", features = ["tokio-proto"] }

License

tokio-tls is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.