| 1 |
# Release Notes for ktls-utils 1.4.0 |
| 2 |
|
| 3 |
In-kernel TLS consumers need a mechanism to perform TLS handshakes |
| 4 |
on a connected socket to negotiate TLS session parameters that can |
| 5 |
then be programmed into the kernel's TLS record protocol engine. |
| 6 |
|
| 7 |
This package of software provides a TLS handshake user agent that |
| 8 |
listens for kernel requests and then materializes a user space |
| 9 |
socket endpoint on which to perform these handshakes. The resulting |
| 10 |
negotiated session parameters are passed back to the kernel via |
| 11 |
standard kTLS socket options. |
| 12 |
|
| 13 |
See [COPYING](COPYING) for the full text of the license under which |
| 14 |
this package is released. |
| 15 |
|
| 16 |
## Dependencies |
| 17 |
|
| 18 |
### Run-time dependencies |
| 19 |
|
| 20 |
The kernel must have net/handshake support (v6.5 or later) and be |
| 21 |
built with the following CONFIG options enabled: |
| 22 |
|
| 23 |
* CONFIG_TLS |
| 24 |
* CONFIG_KEYS |
| 25 |
* CONFIG_KEYS_REQUEST_CACHE |
| 26 |
|
| 27 |
### Build dependencies |
| 28 |
|
| 29 |
The build environment requires the development packages for the |
| 30 |
following libraries to be installed: |
| 31 |
|
| 32 |
* GnuTLS |
| 33 |
* keyutils |
| 34 |
* GLib-2.0 |
| 35 |
* libnl3 |
| 36 |
* libyaml |
| 37 |
|
| 38 |
## Installation |
| 39 |
|
| 40 |
See [NEWS](NEWS) to see what has changed in the latest release, |
| 41 |
and see [INSTALL](INSTALL) for build instructions. |
| 42 |
|
| 43 |
## Contributing |
| 44 |
|
| 45 |
This project welcomes contributions from the community. |
| 46 |
Before submitting a pull request, |
| 47 |
please [review our contribution guide](./CONTRIBUTING.md). |
| 48 |
|
| 49 |
See the GitHub Issue Tracker to review or open to-do items. |
| 50 |
|
| 51 |
## Security |
| 52 |
|
| 53 |
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process |
| 54 |
|
| 55 |
## License |
| 56 |
|
| 57 |
Copyright (c) 2023 Oracle and/or its affiliates. |
| 58 |
|
| 59 |
Released under the GNU GENERAL PUBLIC LICENSE version 2 |