linux/Documentation/crypto
Eric Biggers b73abee375 lib: Move SipHash into lib/crypto/
The addition of SipHash to lib/ predated the existence of the
lib/crypto/ directory.  Since SipHash is a cryptographic algorithm, move
it from the top-level lib/ directory to lib/crypto/.

(This does mean HalfSipHash comes with it too, as it's in the same
files.  But lib/crypto/ still seems like the proper place for both.)

Specifically:

- Move both siphash.c and siphash_kunit.c.  Keep the header
  <linux/siphash.h> as-is for now.

- Drop the dedicated MAINTAINERS entry for SipHash, as per the
  suggestion from Jason
  (https://lore.kernel.org/r/asB7QVFMlgKgbje2@zx2c4.com/).  The C files
  now just fold up to the "CRYPTO LIBRARY" entry.  Add the header
  explicitly, as it otherwise would be left unmaintained.

- Move the kconfig option that controls the KUnit test.  Put
  "CRYPTO_LIB" in its name and update the prompt and help text to make
  it consistent with the other crypto library test options.

- Enable the KUnit test in lib/crypto/.kunitconfig.

- Link to siphash.rst from the appropriate place in libcrypto-hash.rst.

- Use obj-y instead of lib-y, for consistency with the fact that
  currently lib/crypto/ doesn't use kbuild's support for library file
  goals.  We could keep it as lib-y, but virtually every kernel needs
  SipHash support anyway (with vsprintf, printk, IPv4, IPv6, etc.
  depending on it) so there is no practical difference in this case.

Acked-by: Ard Biesheuvel <ardb@kernel.org>
Acked-by: Jason A. Donenfeld <Jason@zx2c4.com>
Link: https://patch.msgid.link/20261003162827.155527-1-ebiggers@kernel.org
Signed-off-by: Eric Biggers <ebiggers@kernel.org>
2026-10-03 18:30:12 +02:00
..
device_drivers
api-aead.rst crypto: doc - Add explicit title heading to API docs 2025-09-28 11:54:48 +08:00
api-akcipher.rst crypto: doc - Add explicit title heading to API docs 2025-09-28 11:54:48 +08:00
api-digest.rst crypto: doc - Add explicit title heading to API docs 2025-09-28 11:54:48 +08:00
api-intro.rst
api-kpp.rst crypto: doc - Add explicit title heading to API docs 2025-09-28 11:54:48 +08:00
api-rng.rst crypto: doc - Add explicit title heading to API docs 2025-09-28 11:54:48 +08:00
api-samples.rst crypto: drbg - Remove support for HASH_DRBG 2026-05-07 16:10:00 +08:00
api-sig.rst crypto: doc - Add explicit title heading to API docs 2025-09-28 11:54:48 +08:00
api-skcipher.rst crypto: doc - Add explicit title heading to API docs 2025-09-28 11:54:48 +08:00
api.rst crypto: sig - Introduce sig_alg backend 2024-10-05 13:22:04 +08:00
architecture.rst crypto: doc - Remove extra parenthesis 2026-07-17 18:09:22 +10:00
asymmetric-keys.rst
async-tx-api.rst raid6: improve the public interface 2026-05-28 21:24:54 -07:00
crypto_engine.rst crypto: engine - remove {prepare,unprepare}_crypt_hardware callbacks 2025-07-18 20:52:00 +10:00
descore-readme.rst
devel-algos.rst
index.rst lib/crypto: docs: Add rst documentation to Documentation/crypto/ 2026-04-18 17:32:02 -07:00
intro.rst
krb5.rst crypto/krb5, rxrpc: Fix lack of pre-decrypt/pre-verify length checks 2026-05-20 16:36:45 -07:00
libcrypto-auth-encryption.rst lib/crypto: aes: Add CCM support 2026-07-22 12:01:20 -07:00
libcrypto-blockcipher.rst lib/crypto: docs: Fix some sentence fragments 2026-07-09 11:05:54 -04:00
libcrypto-hash.rst lib: Move SipHash into lib/crypto/ 2026-10-03 18:30:12 +02:00
libcrypto-signature.rst lib/crypto: docs: Fix some sentence fragments 2026-07-09 11:05:54 -04:00
libcrypto-unauth-encryption.rst lib/crypto: aes: Add XTS support 2026-07-19 17:34:16 -07:00
libcrypto-utils.rst lib/crypto: docs: Add rst documentation to Documentation/crypto/ 2026-04-18 17:32:02 -07:00
libcrypto-zeroization.rst lib/crypto: Add documentation about zeroization of key and context data 2026-09-30 09:42:09 -07:00
libcrypto.rst Documentation: libcrypto: Add additional testing information 2026-09-30 09:42:09 -07:00
sha3.rst lib/crypto: docs: Add rst documentation to Documentation/crypto/ 2026-04-18 17:32:02 -07:00
userspace-if.rst crypto: af_alg - Add af_alg_restrict sysctl, defaulting to 1 2026-07-05 13:27:15 +08:00