#tokio #tls #openssl #api #non-blocking #stream

tokio-tls-api

An implementation of TLS/SSL streams for Tokio giving an implementation of TLS for nonblocking I/O streams

19 releases

Uses old Rust 2015

0.2.1 Jan 1, 2020
0.2.0 May 26, 2019
0.1.22 Apr 28, 2019
0.1.20 Jul 15, 2018
0.1.8 Jun 17, 2017

#2192 in Network programming

Download history 1921/week @ 2022-11-30 1406/week @ 2022-12-07 2214/week @ 2022-12-14 2747/week @ 2022-12-21 2759/week @ 2022-12-28 2993/week @ 2023-01-04 2695/week @ 2023-01-11 2905/week @ 2023-01-18 2965/week @ 2023-01-25 2971/week @ 2023-02-01 2393/week @ 2023-02-08 2940/week @ 2023-02-15 4214/week @ 2023-02-22 4646/week @ 2023-03-01 7448/week @ 2023-03-08 6130/week @ 2023-03-15

23,076 downloads per month
Used in 12 crates (via lapin-futures-tls-api)

MIT/Apache

95KB
2K SLoC

tokio-tls

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

Build Status Build status

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:

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.

Dependencies

~0.5–1.4MB
~24K SLoC