Documentation: add TLS offload documentation

Browse source

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>

...

This commit is contained in:

Jakub Kicinski 2019-05-21 18:57:14 -07:00 • committed by David S. Miller

parent f3c0f3c6c2

commit f42c104f2e

6 changed files with 488 additions and 0 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

1

Documentation/networking/index.rst

View file

1

Documentation/networking/tls-offload-layers.svg

View file

File diff suppressed because one or more lines are too long

Side by side After Width:  |  Height:  |  Size: 49 KiB

1

Documentation/networking/tls-offload-reorder-bad.svg

View file

File diff suppressed because one or more lines are too long

Side by side After Width:  |  Height:  |  Size: 6.4 KiB

1

Documentation/networking/tls-offload-reorder-good.svg

View file

File diff suppressed because one or more lines are too long

Side by side After Width:  |  Height:  |  Size: 6.4 KiB

482

Documentation/networking/tls-offload.rst

View file

2

Documentation/networking/tls.rst

View file