forked from torvalds/linux
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: crypto: convert api-intro.txt to ReST format
- Change title markups; - Mark literal blocks; - Use list markups at authors/credits; - Add blank lines when needed; - Remove trailing whitespaces. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Link: https://lore.kernel.org/r/c71e2c73a787ec7814db09bec3c1359779785bfa.1592203650.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <[email protected]>
- Loading branch information
Showing
2 changed files
with
100 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,11 @@ | ||
| .. SPDX-License-Identifier: GPL-2.0 | ||
| Scatterlist Cryptographic API | ||
|
|
||
| INTRODUCTION | ||
| ============================= | ||
| Scatterlist Cryptographic API | ||
| ============================= | ||
|
|
||
| Introduction | ||
| ============ | ||
|
|
||
| The Scatterlist Crypto API takes page vectors (scatterlists) as | ||
| arguments, and works directly on pages. In some cases (e.g. ECB | ||
|
|
@@ -13,22 +17,23 @@ so that processing can be applied to paged skb's without the need | |
| for linearization. | ||
|
|
||
|
|
||
| DETAILS | ||
| Details | ||
| ======= | ||
|
|
||
| At the lowest level are algorithms, which register dynamically with the | ||
| API. | ||
|
|
||
| 'Transforms' are user-instantiated objects, which maintain state, handle all | ||
| of the implementation logic (e.g. manipulating page vectors) and provide an | ||
| abstraction to the underlying algorithms. However, at the user | ||
| of the implementation logic (e.g. manipulating page vectors) and provide an | ||
| abstraction to the underlying algorithms. However, at the user | ||
| level they are very simple. | ||
|
|
||
| Conceptually, the API layering looks like this: | ||
| Conceptually, the API layering looks like this:: | ||
|
|
||
| [transform api] (user interface) | ||
| [transform ops] (per-type logic glue e.g. cipher.c, compress.c) | ||
| [algorithm api] (for registering algorithms) | ||
|
|
||
| The idea is to make the user interface and algorithm registration API | ||
| very simple, while hiding the core logic from both. Many good ideas | ||
| from existing APIs such as Cryptoapi and Nettle have been adapted for this. | ||
|
|
@@ -44,21 +49,21 @@ one block while the former can operate on an arbitrary amount of data, | |
| subject to block size requirements (i.e., non-stream ciphers can only | ||
| process multiples of blocks). | ||
|
|
||
| Here's an example of how to use the API: | ||
| Here's an example of how to use the API:: | ||
|
|
||
| #include <crypto/hash.h> | ||
| #include <linux/err.h> | ||
| #include <linux/scatterlist.h> | ||
|
|
||
| struct scatterlist sg[2]; | ||
| char result[128]; | ||
| struct crypto_ahash *tfm; | ||
| struct ahash_request *req; | ||
|
|
||
| tfm = crypto_alloc_ahash("md5", 0, CRYPTO_ALG_ASYNC); | ||
| if (IS_ERR(tfm)) | ||
| fail(); | ||
|
|
||
| /* ... set up the scatterlists ... */ | ||
|
|
||
| req = ahash_request_alloc(tfm, GFP_ATOMIC); | ||
|
|
@@ -67,18 +72,19 @@ Here's an example of how to use the API: | |
|
|
||
| ahash_request_set_callback(req, 0, NULL, NULL); | ||
| ahash_request_set_crypt(req, sg, result, 2); | ||
|
|
||
| if (crypto_ahash_digest(req)) | ||
| fail(); | ||
|
|
||
| ahash_request_free(req); | ||
| crypto_free_ahash(tfm); | ||
|
|
||
|
|
||
| Many real examples are available in the regression test module (tcrypt.c). | ||
|
|
||
|
|
||
| DEVELOPER NOTES | ||
| Developer Notes | ||
| =============== | ||
|
|
||
| Transforms may only be allocated in user context, and cryptographic | ||
| methods may only be called from softirq and user contexts. For | ||
|
|
@@ -91,7 +97,8 @@ size (typically 8 bytes). This prevents having to do any copying | |
| across non-aligned page fragment boundaries. | ||
|
|
||
|
|
||
| ADDING NEW ALGORITHMS | ||
| Adding New Algorithms | ||
| ===================== | ||
|
|
||
| When submitting a new algorithm for inclusion, a mandatory requirement | ||
| is that at least a few test vectors from known sources (preferably | ||
|
|
@@ -119,132 +126,137 @@ Also check the TODO list at the web site listed below to see what people | |
| might already be working on. | ||
|
|
||
|
|
||
| BUGS | ||
| Bugs | ||
| ==== | ||
|
|
||
| Send bug reports to: | ||
| [email protected] | ||
| Cc: Herbert Xu <[email protected]>, | ||
| [email protected] | ||
|
|
||
| Cc: | ||
| Herbert Xu <[email protected]>, | ||
| David S. Miller <[email protected]> | ||
|
|
||
|
|
||
| FURTHER INFORMATION | ||
| Further Information | ||
| =================== | ||
|
|
||
| For further patches and various updates, including the current TODO | ||
| list, see: | ||
| http://gondor.apana.org.au/~herbert/crypto/ | ||
|
|
||
|
|
||
| AUTHORS | ||
| Authors | ||
| ======= | ||
|
|
||
| James Morris | ||
| David S. Miller | ||
| Herbert Xu | ||
| - James Morris | ||
| - David S. Miller | ||
| - Herbert Xu | ||
|
|
||
|
|
||
| CREDITS | ||
| Credits | ||
| ======= | ||
|
|
||
| The following people provided invaluable feedback during the development | ||
| of the API: | ||
|
|
||
| Alexey Kuznetzov | ||
| Rusty Russell | ||
| Herbert Valerio Riedel | ||
| Jeff Garzik | ||
| Michael Richardson | ||
| Andrew Morton | ||
| Ingo Oeser | ||
| Christoph Hellwig | ||
| - Alexey Kuznetzov | ||
| - Rusty Russell | ||
| - Herbert Valerio Riedel | ||
| - Jeff Garzik | ||
| - Michael Richardson | ||
| - Andrew Morton | ||
| - Ingo Oeser | ||
| - Christoph Hellwig | ||
|
|
||
| Portions of this API were derived from the following projects: | ||
|
|
||
| Kerneli Cryptoapi (http://www.kerneli.org/) | ||
| Alexander Kjeldaas | ||
| Herbert Valerio Riedel | ||
| Kyle McMartin | ||
| Jean-Luc Cooke | ||
| David Bryson | ||
| Clemens Fruhwirth | ||
| Tobias Ringstrom | ||
| Harald Welte | ||
| - Alexander Kjeldaas | ||
| - Herbert Valerio Riedel | ||
| - Kyle McMartin | ||
| - Jean-Luc Cooke | ||
| - David Bryson | ||
| - Clemens Fruhwirth | ||
| - Tobias Ringstrom | ||
| - Harald Welte | ||
|
|
||
| and; | ||
|
|
||
| Nettle (http://www.lysator.liu.se/~nisse/nettle/) | ||
| Niels Möller | ||
| - Niels Möller | ||
|
|
||
| Original developers of the crypto algorithms: | ||
|
|
||
| Dana L. How (DES) | ||
| Andrew Tridgell and Steve French (MD4) | ||
| Colin Plumb (MD5) | ||
| Steve Reid (SHA1) | ||
| Jean-Luc Cooke (SHA256, SHA384, SHA512) | ||
| Kazunori Miyazawa / USAGI (HMAC) | ||
| Matthew Skala (Twofish) | ||
| Dag Arne Osvik (Serpent) | ||
| Brian Gladman (AES) | ||
| Kartikey Mahendra Bhatt (CAST6) | ||
| Jon Oberheide (ARC4) | ||
| Jouni Malinen (Michael MIC) | ||
| NTT(Nippon Telegraph and Telephone Corporation) (Camellia) | ||
| - Dana L. How (DES) | ||
| - Andrew Tridgell and Steve French (MD4) | ||
| - Colin Plumb (MD5) | ||
| - Steve Reid (SHA1) | ||
| - Jean-Luc Cooke (SHA256, SHA384, SHA512) | ||
| - Kazunori Miyazawa / USAGI (HMAC) | ||
| - Matthew Skala (Twofish) | ||
| - Dag Arne Osvik (Serpent) | ||
| - Brian Gladman (AES) | ||
| - Kartikey Mahendra Bhatt (CAST6) | ||
| - Jon Oberheide (ARC4) | ||
| - Jouni Malinen (Michael MIC) | ||
| - NTT(Nippon Telegraph and Telephone Corporation) (Camellia) | ||
|
|
||
| SHA1 algorithm contributors: | ||
| Jean-Francois Dive | ||
| - Jean-Francois Dive | ||
|
|
||
| DES algorithm contributors: | ||
| Raimar Falke | ||
| Gisle Sælensminde | ||
| Niels Möller | ||
| - Raimar Falke | ||
| - Gisle Sælensminde | ||
| - Niels Möller | ||
|
|
||
| Blowfish algorithm contributors: | ||
| Herbert Valerio Riedel | ||
| Kyle McMartin | ||
| - Herbert Valerio Riedel | ||
| - Kyle McMartin | ||
|
|
||
| Twofish algorithm contributors: | ||
| Werner Koch | ||
| Marc Mutz | ||
| - Werner Koch | ||
| - Marc Mutz | ||
|
|
||
| SHA256/384/512 algorithm contributors: | ||
| Andrew McDonald | ||
| Kyle McMartin | ||
| Herbert Valerio Riedel | ||
| - Andrew McDonald | ||
| - Kyle McMartin | ||
| - Herbert Valerio Riedel | ||
|
|
||
| AES algorithm contributors: | ||
| Alexander Kjeldaas | ||
| Herbert Valerio Riedel | ||
| Kyle McMartin | ||
| Adam J. Richter | ||
| Fruhwirth Clemens (i586) | ||
| Linus Torvalds (i586) | ||
| - Alexander Kjeldaas | ||
| - Herbert Valerio Riedel | ||
| - Kyle McMartin | ||
| - Adam J. Richter | ||
| - Fruhwirth Clemens (i586) | ||
| - Linus Torvalds (i586) | ||
|
|
||
| CAST5 algorithm contributors: | ||
| Kartikey Mahendra Bhatt (original developers unknown, FSF copyright). | ||
| - Kartikey Mahendra Bhatt (original developers unknown, FSF copyright). | ||
|
|
||
| TEA/XTEA algorithm contributors: | ||
| Aaron Grothe | ||
| Michael Ringe | ||
| - Aaron Grothe | ||
| - Michael Ringe | ||
|
|
||
| Khazad algorithm contributors: | ||
| Aaron Grothe | ||
| - Aaron Grothe | ||
|
|
||
| Whirlpool algorithm contributors: | ||
| Aaron Grothe | ||
| Jean-Luc Cooke | ||
| - Aaron Grothe | ||
| - Jean-Luc Cooke | ||
|
|
||
| Anubis algorithm contributors: | ||
| Aaron Grothe | ||
| - Aaron Grothe | ||
|
|
||
| Tiger algorithm contributors: | ||
| Aaron Grothe | ||
| - Aaron Grothe | ||
|
|
||
| VIA PadLock contributors: | ||
| Michal Ludvig | ||
| - Michal Ludvig | ||
|
|
||
| Camellia algorithm contributors: | ||
| NTT(Nippon Telegraph and Telephone Corporation) (Camellia) | ||
| - NTT(Nippon Telegraph and Telephone Corporation) (Camellia) | ||
|
|
||
| Generic scatterwalk code by Adam J. Richter <[email protected]> | ||
|
|
||
| Please send any credits updates or corrections to: | ||
| Herbert Xu <[email protected]> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters