test: add sha512 variants by sha512 general fallback test

2026-07-05 11:50:52 +02:00 · 2026-06-03 15:57:23 +02:00
parent 76962339c4
commit 5744df1c77
2 changed files with 187 additions and 1 deletions
@@ -874,3 +874,187 @@ int test_wc_Sha384_Flags(void)
    return EXPECT_RESULT();
 }

+/* The SHA-512/224 and SHA-512/256 variants are only available under these
+ * build conditions. */
+#if defined(WOLFSSL_SHA512) && !defined(WOLFSSL_NOSHA512_224) && \
+   (!defined(HAVE_FIPS) || FIPS_VERSION_GE(5, 3)) && !defined(HAVE_SELFTEST)
+    #define TEST_WC_SHA512_224_FALLBACK
+#endif
+#if defined(WOLFSSL_SHA512) && !defined(WOLFSSL_NOSHA512_256) && \
+   (!defined(HAVE_FIPS) || FIPS_VERSION_GE(5, 3)) && !defined(HAVE_SELFTEST)
+    #define TEST_WC_SHA512_256_FALLBACK
+#endif
+
+#if defined(WOLF_CRYPTO_CB) && defined(WOLFSSL_SHA512) && \
+    !defined(NO_SHA2_CRYPTO_CB) && \
+    ((!defined(WOLF_CRYPTO_CB_NO_SHA512_FALLBACK) && \
+      (defined(WOLFSSL_SHA384) || defined(TEST_WC_SHA512_224_FALLBACK) || \
+       defined(TEST_WC_SHA512_256_FALLBACK))) || \
+     defined(WOLF_CRYPTO_CB_ONLY_SHA512))
+
+#include <wolfssl/wolfcrypt/cryptocb.h>
+
+#define TEST_CRYPTOCB_SHA512_DEVID 2
+
+typedef struct {
+    int variantSeen; /* SHA-384 / SHA-512-224 / SHA-512-256 callback declined */
+    int sha512Seen;  /* generic SHA-512 callback the fallback lands on */
+#ifdef WOLF_CRYPTO_CB_FREE
+    int freeSeen;    /* SHA-512-family free callbacks the CB-only free routes to */
+#endif
+} Sha512DevCbCtx;
+
+/* Shared SHA-512 crypto-callback test device. For HASH ops it declines every
+ * SHA-512 variant callback so the cryptocb dispatcher falls back to the generic
+ * SHA-512 callback; that callback fills a recognisable digest and deliberately
+ * leaves the SHA-512 IV in the caller's state, forcing the dispatcher to reset
+ * the state back to the variant IV. */
+static int sha512_dev_cb(int devIdArg, wc_CryptoInfo* info, void* ctx)
+{
+    Sha512DevCbCtx* cbCtx = (Sha512DevCbCtx*)ctx;
+    int i;
+
+    (void)devIdArg;
+
+    if (info == NULL || cbCtx == NULL)
+        return BAD_FUNC_ARG;
+
+#ifdef WOLF_CRYPTO_CB_FREE
+    if (info->algo_type == WC_ALGO_TYPE_FREE) {
+        /* Count SHA-512-family frees so the test can confirm the
+         * CB-only free path reaches the callback instead of only zeroing the
+         * struct. Decline so the caller still performs its standard cleanup. */
+        if (info->free.algo == WC_ALGO_TYPE_HASH &&
+            (info->free.type == WC_HASH_TYPE_SHA512 ||
+             info->free.type == WC_HASH_TYPE_SHA384))
+            cbCtx->freeSeen++;
+        return CRYPTOCB_UNAVAILABLE;
+    }
+#endif
+
+    if (info->algo_type != WC_ALGO_TYPE_HASH)
+        return CRYPTOCB_UNAVAILABLE;
+
+    switch (info->hash.type) {
+        case WC_HASH_TYPE_SHA384:
+        case WC_HASH_TYPE_SHA512_224:
+        case WC_HASH_TYPE_SHA512_256:
+            cbCtx->variantSeen++;
+            return CRYPTOCB_UNAVAILABLE;
+
+        case WC_HASH_TYPE_SHA512:
+            cbCtx->sha512Seen++;
+            if (info->hash.digest != NULL) {
+                for (i = 0; i < WC_SHA512_DIGEST_SIZE; i++)
+                    info->hash.digest[i] = (byte)(0x80 + i);
+            }
+        #ifndef WOLF_CRYPTO_CB_NO_SHA512_FALLBACK
+            /* leave the SHA-512 IV in the caller's state to force the
+             * dispatcher's variant IV reset; backends that drop the digest[]
+             * field disable the fallback, so this only runs when it exists */
+            if (info->hash.sha512 != NULL) {
+                for (i = 0; i < (int)(sizeof(info->hash.sha512->digest) /
+                                sizeof(info->hash.sha512->digest[0])); i++) {
+                    info->hash.sha512->digest[i] = W64LIT(0xdeadbeefcafebabe);
+                }
+            }
+        #endif
+            return 0;
+
+        default:
+            return CRYPTOCB_UNAVAILABLE;
+    }
+}
+
+#endif
+
+int test_wc_sha512_cryptocb_fallback(void)
+{
+    EXPECT_DECLS;
+#if defined(WOLF_CRYPTO_CB) && defined(WOLFSSL_SHA512) && \
+    !defined(NO_SHA2_CRYPTO_CB) && \
+    !defined(WOLF_CRYPTO_CB_NO_SHA512_FALLBACK) && \
+    (defined(WOLFSSL_SHA384) || defined(TEST_WC_SHA512_224_FALLBACK) || \
+     defined(TEST_WC_SHA512_256_FALLBACK))
+    typedef struct {
+        const char* name;
+        int (*initFn)(wc_Sha512* sha, void* heap, int devId);
+        int (*finalFn)(wc_Sha512* sha, byte* hash);
+        word32 digestSz;
+    } Sha512FallbackCase;
+    static const Sha512FallbackCase sha512FallbackCases[] = {
+#ifdef WOLFSSL_SHA384
+        { "SHA-384", wc_InitSha384_ex, wc_Sha384Final, WC_SHA384_DIGEST_SIZE },
+#endif
+#ifdef TEST_WC_SHA512_224_FALLBACK
+        { "SHA-512/224", wc_InitSha512_224_ex, wc_Sha512_224Final,
+          WC_SHA512_224_DIGEST_SIZE },
+#endif
+#ifdef TEST_WC_SHA512_256_FALLBACK
+        { "SHA-512/256", wc_InitSha512_256_ex, wc_Sha512_256Final,
+          WC_SHA512_256_DIGEST_SIZE },
+#endif
+    };
+    wc_Sha512 sha;
+    wc_Sha512 refSha;
+    Sha512DevCbCtx cbCtx;
+    byte hash[WC_SHA512_DIGEST_SIZE];
+    byte devCtxMarker;
+    const Sha512FallbackCase* tc;
+    size_t c;
+    word32 i;
+
+    for (c = 0;
+         c < sizeof(sha512FallbackCases) / sizeof(sha512FallbackCases[0]);
+         c++) {
+        tc = &sha512FallbackCases[c];
+        devCtxMarker = 0;
+
+        XMEMSET(&sha, 0, sizeof(sha));
+        sha.devId = INVALID_DEVID;
+        sha.devCtx = NULL;
+        XMEMSET(&refSha, 0, sizeof(refSha));
+        XMEMSET(&cbCtx, 0, sizeof(cbCtx));
+        XMEMSET(hash, 0, sizeof(hash));
+
+        /* Reference struct capturing the freshly-initialised variant IV state,
+         * against which we verify the test struct after Final. */
+        ExpectIntEQ(tc->initFn(&refSha, HEAP_HINT, INVALID_DEVID), 0);
+
+        ExpectIntEQ(wc_CryptoCb_RegisterDevice(
+            TEST_CRYPTOCB_SHA512_DEVID, sha512_dev_cb,
+            &cbCtx), 0);
+
+        ExpectIntEQ(tc->initFn(&sha, HEAP_HINT,
+            TEST_CRYPTOCB_SHA512_DEVID), 0);
+        sha.devCtx = &devCtxMarker;
+
+        ExpectIntEQ(tc->finalFn(&sha, hash), 0);
+
+        /* the variant callback is declined, forcing the generic SHA-512
+         * fallback */
+        ExpectIntEQ(cbCtx.variantSeen, 1);
+        ExpectIntEQ(cbCtx.sha512Seen, 1);
+
+        /* devId and devCtx must be preserved across the SHA-512 fallback. */
+        ExpectIntEQ(sha.devId, TEST_CRYPTOCB_SHA512_DEVID);
+        ExpectPtrEq(sha.devCtx, &devCtxMarker);
+
+        /* the digest is the generic SHA-512 output truncated to the variant
+         * digest size */
+        for (i = 0; i < tc->digestSz; i++)
+            ExpectIntEQ(hash[i], (byte)(0x80 + i));
+
+        /* the SHA-512 fallback leaves the SHA-512 IV in the state buffer; the
+         * fallback must reset it back to the variant IV so the struct is ready
+         * to hash a new message */
+        ExpectIntEQ(XMEMCMP(sha.digest, refSha.digest, sizeof(sha.digest)), 0);
+
+        wc_Sha512Free(&sha);
+        wc_Sha512Free(&refSha);
+        wc_CryptoCb_UnRegisterDevice(TEST_CRYPTOCB_SHA512_DEVID);
+    }
+#endif
+    return EXPECT_RESULT();
+}
+
@@ -66,6 +66,7 @@ int test_wc_Sha384_other(void);
 int test_wc_Sha384Copy(void);
 int test_wc_Sha384GetHash(void);
 int test_wc_Sha384_Flags(void);
+int test_wc_sha512_cryptocb_fallback(void);

 #define TEST_SHA512_DECLS                               \
    TEST_DECL_GROUP("sha512", test_wc_InitSha512),      \
@@ -77,7 +78,8 @@ int test_wc_Sha384_Flags(void);
    TEST_DECL_GROUP("sha512", test_wc_Sha512Copy),      \
    TEST_DECL_GROUP("sha512", test_wc_Sha512GetHash),   \
    TEST_DECL_GROUP("sha512", test_wc_Sha512Transform), \
-    TEST_DECL_GROUP("sha512", test_wc_Sha512_Flags)
+    TEST_DECL_GROUP("sha512", test_wc_Sha512_Flags),    \
+    TEST_DECL_GROUP("sha512", test_wc_sha512_cryptocb_fallback)

 #define TEST_SHA512_224_DECLS                                   \
    TEST_DECL_GROUP("sha512_224", test_wc_InitSha512_224),      \