Documentation/networking/tls-handshake.rst

1 .. SPDX-License-Identifier: GPL-2.0
4 In-Kernel TLS Handshake
11 over TCP. TLS provides end-to-end data integrity and confidentiality in
21 implementations so that in-kernel TLS consumers do not need to be
46 A kernel TLS consumer initiates a client-side TLS handshake on an open
50 .. code-block:: c
68 instantiated a struct file in sock->file.
75 The consumer can provide a NUL-terminated hostname in the @ta_peername
85 keys, and pre-shared keys are provided to the handshake agent in keys
91 To request an x.509-authenticated TLS session, the consumer fills in
96 .. code-block:: c
107 To initiate a client-side TLS handshake with a pre-shared key, use:
109 .. code-block:: c
116 entries it has filled in. The other fields are filled in as above.
119 To initiate an anonymous client-side TLS handshake use:
121 .. code-block:: c
131 Consumers that are in-kernel servers use:
133 .. code-block:: c
139 .. code-block:: c
143 The argument structure is filled in as above.
149 .. code-block:: c
169 .. code-block:: c
182 +------------+----------------------------------------------+
186 +------------+----------------------------------------------+
187 |  -EACCESS  |  Remote peer rejected the handshake or       |
189 +------------+----------------------------------------------+
190 |  -ENOMEM   |  Temporary resource allocation failure       |
191 +------------+----------------------------------------------+
192 |  -EINVAL   |  Consumer provided an invalid argument       |
193 +------------+----------------------------------------------+
194 |  -ENOKEY   |  Missing authentication material             |
195 +------------+----------------------------------------------+
196 |  -EIO      |  An unexpected fault occurred                |
197 +------------+----------------------------------------------+
208 --------------------