hmac_test.h File Reference

HMAC self-tests. More...

#include <stdint.h>
#include <ipxe/crypto.h>
#include <ipxe/test.h>

Go to the source code of this file.

Data Structures
struct	hmac_test
	An HMAC test. More...

Macros
#define	KEY(...)
	Define inline key data.
#define	DATA(...)
	Define inline data.
#define	EXPECTED(...)
	Define inline expected HMAC.
#define	HMAC_TEST(name, DIGEST, KEY, DATA, EXPECTED)
	Define an HMAC test.
#define	hmac_ok(test)
	Report an HMAC test result.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
void	hmac_okx (struct hmac_test *test, const char *file, unsigned int line)
	Report an HMAC test result.

Detailed Description

HMAC self-tests.

Definition in file hmac_test.h.

Macro Definition Documentation

KEY

#define KEY

(

...

)

Value:

{ __VA_ARGS__ }

Define inline key data.

Definition at line 17 of file hmac_test.h.

DATA

#define DATA

(

...

)

Value:

{ __VA_ARGS__ }

Define inline data.

Definition at line 20 of file hmac_test.h.

EXPECTED

#define EXPECTED

(

...

)

Value:

{ __VA_ARGS__ }

Define inline expected HMAC.

Definition at line 23 of file hmac_test.h.

HMAC_TEST

#define HMAC_TEST	(		name,
			DIGEST,
			KEY,
			DATA,
			EXPECTED )

Value:

static const uint8_t name ## _key[] = KEY;                      \
static const uint8_t name ## _data[] = DATA;                    \
static const uint8_t name ## _expected[] = EXPECTED;            \
static struct hmac_test name = {                                \
        .digest = DIGEST,                                       \
        .key = name ## _key,                                    \
        .key_len = sizeof ( name ## _key ),                     \
        .data = name ## _data,                                  \
        .data_len = sizeof ( name ## _data ),                   \
        .expected = name ## _expected,                          \
        .expected_len = sizeof ( name ## _expected ),           \
}

Define an HMAC test.

Parameters

name	Test name
DIGEST	Digest algorithm
KEY	Key
DATA	Data
EXPECTED	Expected HMAC

Return values

test

HMAC test

Definition at line 53 of file hmac_test.h.

#define HMAC_TEST( name, DIGEST, KEY, DATA, EXPECTED )                  \
        static const uint8_t name ## _key[] = KEY;                      \
        static const uint8_t name ## _data[] = DATA;                    \
        static const uint8_t name ## _expected[] = EXPECTED;            \
        static struct hmac_test name = {                                \
                .digest = DIGEST,                                       \
                .key = name ## _key,                                    \
                .key_len = sizeof ( name ## _key ),                     \
                .data = name ## _data,                                  \
                .data_len = sizeof ( name ## _data ),                   \
                .expected = name ## _expected,                          \
                .expected_len = sizeof ( name ## _expected ),           \
        }

hmac_ok

#define hmac_ok

(

test

)

Value:

hmac_okx ( test, __FILE__, __LINE__ )

Report an HMAC test result.

Parameters

test

HMAC test

Definition at line 75 of file hmac_test.h.

Referenced by hmac_test_exec(), wycheproof_hmac_sha1_exec(), wycheproof_hmac_sha224_exec(), wycheproof_hmac_sha256_exec(), wycheproof_hmac_sha384_exec(), wycheproof_hmac_sha512_224_exec(), wycheproof_hmac_sha512_256_exec(), and wycheproof_hmac_sha512_exec().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

hmac_okx()

void hmac_okx ( struct hmac_test * test, const char * file, unsigned int line )

extern

Report an HMAC test result.

Parameters

test	HMAC test
file	Test code file
line	Test code line

Definition at line 50 of file hmac_test.c.

                                    {
        struct digest_algorithm *digest = test->digest;
        uint8_t ctx[ hmac_ctxsize ( digest ) ];
        uint8_t key[ hmac_keysize ( digest ) ];
        uint8_t hmac[digest->digestsize];
 
        /* Sanity checks */
        okx ( sizeof ( ctx ) == ( digest->ctxsize + digest->blocksize ),
              file, line );
        okx ( sizeof ( key ) == digest->blocksize, file, line );
        okx ( test->expected_len > 0, file, line );
        okx ( test->expected_len <= digest->digestsize, file, line );
 
        /* Calculate HMAC */
        DBGC ( test, "HMAC-%s key:\n", digest->name );
        DBGC_HDA ( test, 0, test->key, test->key_len );
        DBGC ( test, "HMAC-%s data:\n", digest->name );
        DBGC_HDA ( test, 0, test->data, test->data_len );
        hmac_init ( digest, ctx, test->key, test->key_len );
        hmac_update ( digest, ctx, test->data, test->data_len );
        hmac_final ( digest, ctx, hmac );
        DBGC ( test, "HMAC-%s result:\n", digest->name );
        DBGC_HDA ( test, 0, hmac, sizeof ( hmac ) );
        okx ( memcmp ( hmac, test->expected, test->expected_len ) == 0,
              file, line );
 
        /* Calculate HMAC using reduced key */
        hmac_key ( digest, ctx, test->key, test->key_len, key );
        DBGC ( test, "HMAC-%s key:\n", digest->name );
        DBGC_HDA ( test, 0, key, sizeof ( key ) );
        hmac_init_key ( digest, ctx, key );
        hmac_update ( digest, ctx, test->data, test->data_len );
        hmac_final ( digest, ctx, hmac );
        DBGC ( test, "HMAC-%s result:\n", digest->name );
        DBGC_HDA ( test, 0, hmac, sizeof ( hmac ) );
        okx ( memcmp ( hmac, test->expected, test->expected_len ) == 0,
              file, line );
}

References digest_algorithm::blocksize, ctx, digest_algorithm::ctxsize, DBGC, DBGC_HDA, digest_algorithm::digestsize, hmac_ctxsize(), hmac_final(), hmac_init(), hmac_init_key(), hmac_key(), hmac_keysize(), hmac_update(), key, memcmp(), digest_algorithm::name, okx, and test.