Commit 8bc79ab6 authored by Eric Biggers's avatar Eric Biggers
Browse files

crypto: sha1 - Wrap library and add HMAC support 



Like I did for crypto/sha512.c, rework crypto/sha1_generic.c (renamed to
crypto/sha1.c) to simply wrap the normal library functions instead of
accessing the low-level block function directly.  Also add support for
HMAC-SHA1, again just wrapping the library functions.

Since the replacement crypto_shash algorithms are implemented using the
(potentially arch-optimized) library functions, give them driver names
ending with "-lib" rather than "-generic".  Update crypto/testmgr.c and
an odd driver to take this change in driver name into account.

Note: to see the diff from crypto/sha1_generic.c to crypto/sha1.c, view
this commit with 'git show -M10'.

Reviewed-by: default avatarArd Biesheuvel <ardb@kernel.org>
Link: https://lore.kernel.org/r/20250712232329.818226-6-ebiggers@kernel.org


Signed-off-by: default avatarEric Biggers <ebiggers@kernel.org>
parent 4cbc8447

crypto/Kconfig

+2 −1
Original line number Diff line number Diff line
@@ -986,7 +986,8 @@ config CRYPTO_SHA1 
	select CRYPTO_HASH

	select CRYPTO_LIB_SHA1

	help

	  SHA-1 secure hash algorithm (FIPS 180, ISO/IEC 10118-3)

	  SHA-1 secure hash algorithm (FIPS 180, ISO/IEC 10118-3), including

	  HMAC support.



config CRYPTO_SHA256

	tristate "SHA-224 and SHA-256"

crypto/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -75,7 +75,7 @@ obj-$(CONFIG_CRYPTO_NULL) += crypto_null.o 
obj-$(CONFIG_CRYPTO_MD4) += md4.o

obj-$(CONFIG_CRYPTO_MD5) += md5.o

obj-$(CONFIG_CRYPTO_RMD160) += rmd160.o

obj-$(CONFIG_CRYPTO_SHA1) += sha1_generic.o

obj-$(CONFIG_CRYPTO_SHA1) += sha1.o

obj-$(CONFIG_CRYPTO_SHA256) += sha256.o

obj-$(CONFIG_CRYPTO_SHA512) += sha512.o

obj-$(CONFIG_CRYPTO_SHA3) += sha3_generic.o

crypto/sha1.c

0 → 100644
+135 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-or-later

/*

 * Crypto API support for SHA-1 and HMAC-SHA1

 *

 * Copyright (c) Alan Smithee.

 * Copyright (c) Andrew McDonald <andrew@mcdonald.org.uk>

 * Copyright (c) Jean-Francois Dive <jef@linuxbe.org>

 * Copyright 2025 Google LLC

 */

#include <crypto/internal/hash.h>

#include <crypto/sha1.h>

#include <linux/kernel.h>

#include <linux/module.h>



const u8 sha1_zero_message_hash[SHA1_DIGEST_SIZE] = {

	0xda, 0x39, 0xa3, 0xee, 0x5e, 0x6b, 0x4b, 0x0d,

	0x32, 0x55, 0xbf, 0xef, 0x95, 0x60, 0x18, 0x90,

	0xaf, 0xd8, 0x07, 0x09

};

EXPORT_SYMBOL_GPL(sha1_zero_message_hash);



#define SHA1_CTX(desc) ((struct sha1_ctx *)shash_desc_ctx(desc))



static int crypto_sha1_init(struct shash_desc *desc)

{

	sha1_init(SHA1_CTX(desc));

	return 0;

}



static int crypto_sha1_update(struct shash_desc *desc,

			      const u8 *data, unsigned int len)

{

	sha1_update(SHA1_CTX(desc), data, len);

	return 0;

}



static int crypto_sha1_final(struct shash_desc *desc, u8 *out)

{

	sha1_final(SHA1_CTX(desc), out);

	return 0;

}



static int crypto_sha1_digest(struct shash_desc *desc,

			      const u8 *data, unsigned int len, u8 *out)

{

	sha1(data, len, out);

	return 0;

}



#define HMAC_SHA1_KEY(tfm) ((struct hmac_sha1_key *)crypto_shash_ctx(tfm))

#define HMAC_SHA1_CTX(desc) ((struct hmac_sha1_ctx *)shash_desc_ctx(desc))



static int crypto_hmac_sha1_setkey(struct crypto_shash *tfm,

				   const u8 *raw_key, unsigned int keylen)

{

	hmac_sha1_preparekey(HMAC_SHA1_KEY(tfm), raw_key, keylen);

	return 0;

}



static int crypto_hmac_sha1_init(struct shash_desc *desc)

{

	hmac_sha1_init(HMAC_SHA1_CTX(desc), HMAC_SHA1_KEY(desc->tfm));

	return 0;

}



static int crypto_hmac_sha1_update(struct shash_desc *desc,

				   const u8 *data, unsigned int len)

{

	hmac_sha1_update(HMAC_SHA1_CTX(desc), data, len);

	return 0;

}



static int crypto_hmac_sha1_final(struct shash_desc *desc, u8 *out)

{

	hmac_sha1_final(HMAC_SHA1_CTX(desc), out);

	return 0;

}



static int crypto_hmac_sha1_digest(struct shash_desc *desc,

				   const u8 *data, unsigned int len, u8 *out)

{

	hmac_sha1(HMAC_SHA1_KEY(desc->tfm), data, len, out);

	return 0;

}



static struct shash_alg algs[] = {

	{

		.base.cra_name		= "sha1",

		.base.cra_driver_name	= "sha1-lib",

		.base.cra_priority	= 300,

		.base.cra_blocksize	= SHA1_BLOCK_SIZE,

		.base.cra_module	= THIS_MODULE,

		.digestsize		= SHA1_DIGEST_SIZE,

		.init			= crypto_sha1_init,

		.update			= crypto_sha1_update,

		.final			= crypto_sha1_final,

		.digest			= crypto_sha1_digest,

		.descsize		= sizeof(struct sha1_ctx),

	},

	{

		.base.cra_name		= "hmac(sha1)",

		.base.cra_driver_name	= "hmac-sha1-lib",

		.base.cra_priority	= 300,

		.base.cra_blocksize	= SHA1_BLOCK_SIZE,

		.base.cra_ctxsize	= sizeof(struct hmac_sha1_key),

		.base.cra_module	= THIS_MODULE,

		.digestsize		= SHA1_DIGEST_SIZE,

		.setkey			= crypto_hmac_sha1_setkey,

		.init			= crypto_hmac_sha1_init,

		.update			= crypto_hmac_sha1_update,

		.final			= crypto_hmac_sha1_final,

		.digest			= crypto_hmac_sha1_digest,

		.descsize		= sizeof(struct hmac_sha1_ctx),

	},

};



static int __init crypto_sha1_mod_init(void)

{

	return crypto_register_shashes(algs, ARRAY_SIZE(algs));

}

module_init(crypto_sha1_mod_init);



static void __exit crypto_sha1_mod_exit(void)

{

	crypto_unregister_shashes(algs, ARRAY_SIZE(algs));

}

module_exit(crypto_sha1_mod_exit);



MODULE_LICENSE("GPL");

MODULE_DESCRIPTION("Crypto API support for SHA-1 and HMAC-SHA1");



MODULE_ALIAS_CRYPTO("sha1");

MODULE_ALIAS_CRYPTO("sha1-lib");

MODULE_ALIAS_CRYPTO("hmac(sha1)");

MODULE_ALIAS_CRYPTO("hmac-sha1-lib");

crypto/sha1_generic.c

deleted100644 → 0
+0 −87
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-or-later

/*

 * Cryptographic API.

 *

 * SHA1 Secure Hash Algorithm.

 *

 * Derived from cryptoapi implementation, adapted for in-place

 * scatterlist interface.

 *

 * Copyright (c) Alan Smithee.

 * Copyright (c) Andrew McDonald <andrew@mcdonald.org.uk>

 * Copyright (c) Jean-Francois Dive <jef@linuxbe.org>

 */

#include <crypto/internal/hash.h>

#include <crypto/sha1.h>

#include <crypto/sha1_base.h>

#include <linux/kernel.h>

#include <linux/module.h>

#include <linux/string.h>



const u8 sha1_zero_message_hash[SHA1_DIGEST_SIZE] = {

	0xda, 0x39, 0xa3, 0xee, 0x5e, 0x6b, 0x4b, 0x0d,

	0x32, 0x55, 0xbf, 0xef, 0x95, 0x60, 0x18, 0x90,

	0xaf, 0xd8, 0x07, 0x09

};

EXPORT_SYMBOL_GPL(sha1_zero_message_hash);



static void sha1_generic_block_fn(struct sha1_state *sst, u8 const *src,

				  int blocks)

{

	u32 temp[SHA1_WORKSPACE_WORDS];



	while (blocks--) {

		sha1_transform(sst->state, src, temp);

		src += SHA1_BLOCK_SIZE;

	}

	memzero_explicit(temp, sizeof(temp));

}



static int crypto_sha1_update(struct shash_desc *desc, const u8 *data,

			      unsigned int len)

{

	return sha1_base_do_update_blocks(desc, data, len,

					  sha1_generic_block_fn);

}



static int crypto_sha1_finup(struct shash_desc *desc, const u8 *data,

			     unsigned int len, u8 *out)

{

	sha1_base_do_finup(desc, data, len, sha1_generic_block_fn);

	return sha1_base_finish(desc, out);

}



static struct shash_alg alg = {

	.digestsize	=	SHA1_DIGEST_SIZE,

	.init		=	sha1_base_init,

	.update		=	crypto_sha1_update,

	.finup		=	crypto_sha1_finup,

	.descsize	=	SHA1_STATE_SIZE,

	.base		=	{

		.cra_name	=	"sha1",

		.cra_driver_name=	"sha1-generic",

		.cra_priority	=	100,

		.cra_flags	=	CRYPTO_AHASH_ALG_BLOCK_ONLY,

		.cra_blocksize	=	SHA1_BLOCK_SIZE,

		.cra_module	=	THIS_MODULE,

	}

};



static int __init sha1_generic_mod_init(void)

{

	return crypto_register_shash(&alg);

}



static void __exit sha1_generic_mod_fini(void)

{

	crypto_unregister_shash(&alg);

}



module_init(sha1_generic_mod_init);

module_exit(sha1_generic_mod_fini);



MODULE_LICENSE("GPL");

MODULE_DESCRIPTION("SHA1 Secure Hash Algorithm");



MODULE_ALIAS_CRYPTO("sha1");

MODULE_ALIAS_CRYPTO("sha1-generic");

crypto/testmgr.c

+6 −0
Original line number Diff line number Diff line
@@ -4237,6 +4237,7 @@ static const struct alg_test_desc alg_test_descs[] = { 
		}

	}, {

		.alg = "authenc(hmac(sha1),cbc(aes))",

		.generic_driver = "authenc(hmac-sha1-lib,cbc(aes-generic))",

		.test = alg_test_aead,

		.fips_allowed = 1,

		.suite = {
@@ -4244,12 +4245,14 @@ static const struct alg_test_desc alg_test_descs[] = { 
		}

	}, {

		.alg = "authenc(hmac(sha1),cbc(des))",

		.generic_driver = "authenc(hmac-sha1-lib,cbc(des-generic))",

		.test = alg_test_aead,

		.suite = {

			.aead = __VECS(hmac_sha1_des_cbc_tv_temp)

		}

	}, {

		.alg = "authenc(hmac(sha1),cbc(des3_ede))",

		.generic_driver = "authenc(hmac-sha1-lib,cbc(des3_ede-generic))",

		.test = alg_test_aead,

		.suite = {

			.aead = __VECS(hmac_sha1_des3_ede_cbc_tv_temp)
@@ -4260,6 +4263,7 @@ static const struct alg_test_desc alg_test_descs[] = { 
		.fips_allowed = 1,

	}, {

		.alg = "authenc(hmac(sha1),ecb(cipher_null))",

		.generic_driver = "authenc(hmac-sha1-lib,ecb-cipher_null)",

		.test = alg_test_aead,

		.suite = {

			.aead = __VECS(hmac_sha1_ecb_cipher_null_tv_temp)
@@ -5122,6 +5126,7 @@ static const struct alg_test_desc alg_test_descs[] = { 
		}

	}, {

		.alg = "hmac(sha1)",

		.generic_driver = "hmac-sha1-lib",

		.test = alg_test_hash,

		.fips_allowed = 1,

		.suite = {
@@ -5462,6 +5467,7 @@ static const struct alg_test_desc alg_test_descs[] = { 
		}

	}, {

		.alg = "sha1",

		.generic_driver = "sha1-lib",

		.test = alg_test_hash,

		.fips_allowed = 1,

		.suite = {