openssl-ktls 0.2.1

Openssl KTLS support (with tokio)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# openssl-ktls
![ci](https://github.com/youyuanwu/rust-openssl-ktls/actions/workflows/CI.yml/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/youyuanwu/rust-openssl-ktls/main/LICENSE)
[![Crates.io](https://img.shields.io/crates/v/openssl-ktls)](https://crates.io/crates/openssl-ktls)
[![Documentation](https://docs.rs/openssl-ktls/badge.svg)](https://docs.rs/openssl-ktls)

Use openssl with [kernel TLS offload](https://www.kernel.org/doc/html/latest/networking/tls-offload.html), optionally with tokio.

This crate implements sync SslStream and async tokio SslStream that are ktls capable, extending the [openssl](https://crates.io/crates/openssl) crate.

## Get started
Add to Cargo.toml
```toml
openssl-ktls = { version = "*", default-features = false, features = ["tokio", "vendored"]}
```
* feature `tokio` enables tokio based async SslStream.
* feature `vendored` enableds build openssl from source with ktls enabled. If your system openssl is already built with ktls enabled, you can skip this feature.

## Examples
SslStream works the same way as `openssl::ssl::SslStream`.
```rs
let mut connector =
    openssl::ssl::SslConnector::builder(openssl::ssl::SslMethod::tls()).unwrap();
let connector = connector.set_options(openssl_ktls::option::SSL_OP_ENABLE_KTLS)
    .set_cipher_list(openssl_ktls::option::ECDHE_RSA_AES128_GCM_SHA256).unwrap()
    .configure().unwrap();
let ssl = connector.into_ssl("localhost").unwrap();
let tcp_stream = tokio::net::TcpStream::connect("localhost:8080").await.unwrap();
let mut ssl_stream = openssl_ktls::TokioSslStream::new(tcp_stream, ssl).unwrap();
// read and write data on ssl_stream...
// check ktls is used.
let receive_enabled = ssl_s.ktls_recv_enabled();
let send_enabled = ssl_s.ktls_send_enabled();
```

# License
This project is licensed under the MIT license.