ktls-core 0.0.0

Abstraction for implementing Linux kernel TLS (kTLS) offload in Rust.
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# ktls-core

[![Crates.io](https://img.shields.io/crates/v/ktls-core)](https://crates.io/crates/ktls-core)
[![Docs.rs](https://docs.rs/ktls-core/badge.svg)](https://docs.rs/ktls-core)
[![Code Coverage](https://codecov.io/github/hanyu-dev/ktls/graph/badge.svg?token=vwYtOhk2cV)](https://codecov.io/github/hanyu-dev/ktls)
[![Test pipeline](https://github.com/hanyu-dev/ktls/actions/workflows/ci.yml/badge.svg)](https://github.com/hanyu-dev/ktls/actions/workflows/ci.yml?query=branch%3Amain)
[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE-MIT)

Abstraction for implementing Linux kernel TLS (kTLS) offload in Rust.

## Overview

This crate provides a low-level interface for setting up kernel TLS (kTLS) regardless of your preferred TLS library.

## Implementation Guide

Setting up kTLS generally involves these steps:

1. Creates a `TcpStream` (or something else like `UnixStream`).
1. Configures the TLS User Level Protocol (ULP) on the stream.
1. Performs the TLS handshake using your preferred TLS library over the stream.
1. Creates the `KtlsStream` using the configured stream and crypto materials.

Then you can use the `KtlsStream` as a drop-in replacement of the original `TcpStream`.

## Kernel Compatibility

[![Test pipeline](https://github.com/hanyu-dev/ktls/actions/workflows/kernel-compatibility-test.yml/badge.svg)](https://github.com/hanyu-dev/ktls/actions/workflows/kernel-compatibility-test.yml?query=branch%3Amain)

We perform daily CI tests against the following kernel versions:

|   Version    |
| :----------: |
|   mainline   |
|    stable    |
| 6.6.x (LTS)  |
| 6.1.x (LTS)  |
| 5.15.x (LTS) |
| 5.10.x (LTS) |
| 5.4.x (LTS)  |

(For LTS kernels, we test against the latest patch version)

For examples and tests details, please refer to the [ktls-tests](../ktls-tests/README.md).

## License

Licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT License ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.