[crypto] Add SHA-512/224 algorithm

SHA-512/224 is almost identical to SHA-512, with differing initial
hash values and a truncated output length.

This implementation has been verified using the NIST SHA-512/224 test
vectors.

Signed-off-by: Michael Brown <mcb30@ipxe.org>

4 files changed, 122 insertions, 0 deletions

diff --git a/src/crypto/sha512_224.c b/src/crypto/sha512_224.c
new file mode 100644
index 00000000..8c37b566
--- /dev/null
+++ b/src/crypto/sha512_224.c
@@ -0,0 +1,83 @@
+/*
+ * Copyright (C) 2015 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+/** @file
+ *
+ * SHA-512/224 algorithm
+ *
+ */
+
+#include <stdint.h>
+#include <byteswap.h>
+#include <ipxe/crypto.h>
+#include <ipxe/asn1.h>
+#include <ipxe/sha512.h>
+
+/** SHA-512/224 initial digest values */
+static const struct sha512_digest sha512_224_init_digest = {
+	.h = {
+		cpu_to_be64 ( 0x8c3d37c819544da2ULL ),
+		cpu_to_be64 ( 0x73e1996689dcd4d6ULL ),
+		cpu_to_be64 ( 0x1dfab7ae32ff9c82ULL ),
+		cpu_to_be64 ( 0x679dd514582f9fcfULL ),
+		cpu_to_be64 ( 0x0f6d2b697bd44da8ULL ),
+		cpu_to_be64 ( 0x77e36f7304c48942ULL ),
+		cpu_to_be64 ( 0x3f9d85a86a1d36c8ULL ),
+		cpu_to_be64 ( 0x1112e6ad91d692a1ULL ),
+	},
+};
+
+/**
+ * Initialise SHA-512/224 algorithm
+ *
+ * @v ctx		SHA-512/224 context
+ */
+static void sha512_224_init ( void *ctx ) {
+	struct sha512_context *context = ctx;
+
+	sha512_family_init ( context, &sha512_224_init_digest,
+			     SHA512_224_DIGEST_SIZE );
+}
+
+/** SHA-512/224 algorithm */
+struct digest_algorithm sha512_224_algorithm = {
+	.name		= "sha512/224",
+	.ctxsize	= sizeof ( struct sha512_context ),
+	.blocksize	= sizeof ( union sha512_block ),
+	.digestsize	= SHA512_224_DIGEST_SIZE,
+	.init		= sha512_224_init,
+	.update		= sha512_update,
+	.final		= sha512_final,
+};
+
+/** "sha512_224" object identifier */
+static uint8_t oid_sha512_224[] = { ASN1_OID_SHA512_224 };
+
+/** "sha512_224" OID-identified algorithm */
+struct asn1_algorithm oid_sha512_224_algorithm __asn1_algorithm = {
+	.name = "sha512/224",
+	.digest = &sha512_224_algorithm,
+	.oid = ASN1_OID_CURSOR ( oid_sha512_224 ),
+};
diff --git a/src/include/ipxe/asn1.h b/src/include/ipxe/asn1.h
index f9ae3112..795fb570 100644
--- a/src/include/ipxe/asn1.h
+++ b/src/include/ipxe/asn1.h
@@ -181,6 +181,13 @@ struct asn1_builder_header {
 	ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ),		\
 	ASN1_OID_SINGLE ( 2 ), ASN1_OID_SINGLE ( 4 )
 
+/** ASN.1 OID for id-sha512-224 (2.16.840.1.101.3.4.2.5) */
+#define ASN1_OID_SHA512_224						\
+	ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ),	\
+	ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ),		\
+	ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ),		\
+	ASN1_OID_SINGLE ( 2 ), ASN1_OID_SINGLE ( 5 )
+
 /** ASN.1 OID for id-sha512-256 (2.16.840.1.101.3.4.2.6) */
 #define ASN1_OID_SHA512_256						\
 	ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ),	\
diff --git a/src/include/ipxe/sha512.h b/src/include/ipxe/sha512.h
index 8e9892bf..8e22d835 100644
--- a/src/include/ipxe/sha512.h
+++ b/src/include/ipxe/sha512.h
@@ -81,6 +81,9 @@ struct sha512_context {
 /** SHA-512/256 digest size */
 #define SHA512_256_DIGEST_SIZE ( SHA512_DIGEST_SIZE * 256 / 512 )
 
+/** SHA-512/224 digest size */
+#define SHA512_224_DIGEST_SIZE ( SHA512_DIGEST_SIZE * 224 / 512 )
+
 extern void sha512_family_init ( struct sha512_context *context,
 				 const struct sha512_digest *init,
 				 size_t digestsize );
@@ -90,5 +93,6 @@ extern void sha512_final ( void *ctx, void *out );
 extern struct digest_algorithm sha512_algorithm;
 extern struct digest_algorithm sha384_algorithm;
 extern struct digest_algorithm sha512_256_algorithm;
+extern struct digest_algorithm sha512_224_algorithm;
 
 #endif /* IPXE_SHA512_H */
diff --git a/src/tests/sha512_test.c b/src/tests/sha512_test.c
index f4293d6a..be530eba 100644
--- a/src/tests/sha512_test.c
+++ b/src/tests/sha512_test.c
@@ -32,6 +32,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  *  http://csrc.nist.gov/groups/ST/toolkit/documents/Examples/SHA512.pdf
  *  http://csrc.nist.gov/groups/ST/toolkit/documents/Examples/SHA384.pdf
  *  http://csrc.nist.gov/groups/ST/toolkit/documents/Examples/SHA512_256.pdf
+ *  http://csrc.nist.gov/groups/ST/toolkit/documents/Examples/SHA512_224.pdf
  *
  */
 
@@ -124,6 +125,28 @@ DIGEST_TEST ( sha512_256_nist_abc_stu, &sha512_256_algorithm,
 		       0x9d, 0x3e, 0xf8, 0x3e, 0xe6, 0x14, 0x6f, 0xea, 0xc8,
 		       0x61, 0xe1, 0x9b, 0x56, 0x3a ) );
 
+/* Empty test vector (digest obtained from "shasum -a 512224 /dev/null") */
+DIGEST_TEST ( sha512_224_empty, &sha512_224_algorithm, DIGEST_EMPTY,
+	      DIGEST ( 0x6e, 0xd0, 0xdd, 0x02, 0x80, 0x6f, 0xa8, 0x9e, 0x25,
+		       0xde, 0x06, 0x0c, 0x19, 0xd3, 0xac, 0x86, 0xca, 0xbb,
+		       0x87, 0xd6, 0xa0, 0xdd, 0xd0, 0x5c, 0x33, 0x3b, 0x84,
+		       0xf4 ) );
+
+/* NIST test vector "abc" */
+DIGEST_TEST ( sha512_224_nist_abc, &sha512_224_algorithm, DIGEST_NIST_ABC,
+	      DIGEST ( 0x46, 0x34, 0x27, 0x0f, 0x70, 0x7b, 0x6a, 0x54, 0xda,
+		       0xae, 0x75, 0x30, 0x46, 0x08, 0x42, 0xe2, 0x0e, 0x37,
+		       0xed, 0x26, 0x5c, 0xee, 0xe9, 0xa4, 0x3e, 0x89, 0x24,
+		       0xaa ) );
+
+/* NIST test vector "abc...stu" */
+DIGEST_TEST ( sha512_224_nist_abc_stu, &sha512_224_algorithm,
+	      DIGEST_NIST_ABC_STU,
+	      DIGEST ( 0x23, 0xfe, 0xc5, 0xbb, 0x94, 0xd6, 0x0b, 0x23, 0x30,
+		       0x81, 0x92, 0x64, 0x0b, 0x0c, 0x45, 0x33, 0x35, 0xd6,
+		       0x64, 0x73, 0x4f, 0xe4, 0x0e, 0x72, 0x68, 0x67, 0x4a,
+		       0xf9 ) );
+
 /**
  * Perform SHA-512 family self-test
  *
@@ -140,6 +163,9 @@ static void sha512_test_exec ( void ) {
 	digest_ok ( &sha512_256_empty );
 	digest_ok ( &sha512_256_nist_abc );
 	digest_ok ( &sha512_256_nist_abc_stu );
+	digest_ok ( &sha512_224_empty );
+	digest_ok ( &sha512_224_nist_abc );
+	digest_ok ( &sha512_224_nist_abc_stu );
 
 	/* Speed tests */
 	DBG ( "SHA512 required %ld cycles per byte\n",
@@ -148,6 +174,8 @@ static void sha512_test_exec ( void ) {
 	      digest_cost ( &sha384_algorithm ) );
 	DBG ( "SHA512/256 required %ld cycles per byte\n",
 	      digest_cost ( &sha512_256_algorithm ) );
+	DBG ( "SHA512/224 required %ld cycles per byte\n",
+	      digest_cost ( &sha512_224_algorithm ) );
 }
 
 /** SHA-512 family self-test */