summaryrefslogtreecommitdiff
path: root/Documentation/networking/tls.rst
diff options
context:
space:
mode:
authorJakub Kicinski <jakub.kicinski@netronome.com>2019-05-22 04:57:14 +0300
committerDavid S. Miller <davem@davemloft.net>2019-05-22 22:18:20 +0300
commitf42c104f2ec94a9255a835cd4cd1bd76279d4d06 (patch)
tree8091f73788033c91ca169a2711d97a0f19c7511a /Documentation/networking/tls.rst
parentf3c0f3c6c2013e6caa7ab9c3c6a9fb12f6832c43 (diff)
downloadlinux-f42c104f2ec94a9255a835cd4cd1bd76279d4d06.tar.xz
Documentation: add TLS offload documentation
Describe existing kernel TLS offload (added back in Linux 4.19) - the mechanism, the expected behavior and the notable corner cases. This documentation is mostly targeting hardware vendors who want to implement offload, to ensure consistency between implementations. v2: - add emphasis around TLS_SW/TLS_HW/TLS_HW_RECORD; - remove mentions of ongoing work (Boris); - split the flow of data in SW vs. HW cases in TX overview (Boris); - call out which fields are updated by the device and which are filled by the stack (Boris); - move error handling into it's own section (Boris); - add more words about fallback (Boris); - note that checksum validation is required (Alexei); - note that drivers shouldn't pay attention to the TLS device features. Signed-off-by: Jakub Kicinski <jakub.kicinski@netronome.com> Acked-by: Dave Watson <davejwatson@fb.com> Acked-by: Alexei Starovoitov <ast@kernel.org> Acked-by: Boris Pismenny <borisp@mellanox.com> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'Documentation/networking/tls.rst')
-rw-r--r--Documentation/networking/tls.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/networking/tls.rst b/Documentation/networking/tls.rst
index 482bd73f18a2..5bcbf75e2025 100644
--- a/Documentation/networking/tls.rst
+++ b/Documentation/networking/tls.rst
@@ -1,3 +1,5 @@
+.. _kernel_tls:
+
==========
Kernel TLS
==========