exchange_test.h File Reference

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

Go to the source code of this file.

Data Structures
struct	exchange_test
	A key exchange test. More...

Macros
#define	PRIVATE(...)
	Define inline private key.
#define	PARTNER(...)
	Define inline partner public key.
#define	PUBLIC(...)
	Define inline expected public key.
#define	SHARED(...)
	Define inline expected shared secret.
#define	SHARED_FAIL   SHARED()
	Define inline expected failure result.
#define	EXCHANGE_TEST(name, EXCHANGE, PRIVATE, PARTNER, PUBLIC, SHARED)
	Define a key exchange test.
#define	exchange_ok(test)
	Report a key exchange test result.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
void	exchange_okx (struct exchange_test *test, const char *file, unsigned int line)
	Report a key exchange test result.

Macro Definition Documentation

PRIVATE

#define PRIVATE

(

...

)

Value:

{ __VA_ARGS__ }

Define inline private key.

Definition at line 33 of file exchange_test.h.

Referenced by EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_TEST(), and PUBKEY_TEST().

PARTNER

#define PARTNER

(

...

)

Value:

{ __VA_ARGS__ }

Define inline partner public key.

Definition at line 36 of file exchange_test.h.

Referenced by EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), and EXCHANGE_TEST().

PUBLIC

#define PUBLIC

(

...

)

Value:

{ __VA_ARGS__ }

Define inline expected public key.

Definition at line 39 of file exchange_test.h.

Referenced by EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_TEST(), and PUBKEY_TEST().

SHARED

#define SHARED

(

...

)

Value:

{ __VA_ARGS__ }

Define inline expected shared secret.

Definition at line 42 of file exchange_test.h.

Referenced by EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), and EXCHANGE_TEST().

SHARED_FAIL

#define SHARED_FAIL   SHARED()

Define inline expected failure result.

Definition at line 45 of file exchange_test.h.

Referenced by EXCHANGE_TEST(), EXCHANGE_TEST(), EXCHANGE_TEST(), and EXCHANGE_TEST().

EXCHANGE_TEST

#define EXCHANGE_TEST	(		name,
			EXCHANGE,
			PRIVATE,
			PARTNER,
			PUBLIC,
			SHARED )

Value:

static const uint8_t name ## _private[] = PRIVATE;              \
static const uint8_t name ## _partner[] = PARTNER;              \
static const uint8_t name ## _public[] = PUBLIC;                \
static const uint8_t name ## _shared[] = SHARED;                \
static struct exchange_test name = {                            \
        .exchange = EXCHANGE,                                   \
        .private = name ## _private,                            \
        .private_len = sizeof ( name ## _private ),             \
        .partner = name ## _partner,                            \
        .partner_len = sizeof ( name ## _partner ),             \
        .public = name ## _public,                              \
        .public_len = sizeof ( name ## _public ),               \
        .shared = name ## _shared,                              \
        .shared_len = sizeof ( name ## _shared ),               \
};

Define a key exchange test.

Parameters

name	Test name
EXCHANGE	Key exchange algorithm
PRIVATE	Private key
PARTNER	Partner public key
PUBLIC	Expected public key
SHARED	Expected shared secret

Return values

test	Key exchange test

Definition at line 58 of file exchange_test.h.

exchange_ok

#define exchange_ok

(

test

)

Value:

exchange_okx ( test, __FILE__, __LINE__ )

Report a key exchange test result.

Parameters

test	Key exchange test

Definition at line 81 of file exchange_test.h.

Referenced by ffdhe_test_exec(), p256_test_exec(), p384_test_exec(), and x25519_test_exec().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

exchange_okx()

void exchange_okx ( struct exchange_test * test, const char * file, unsigned int line )

extern

Report a key exchange test result.

Parameters

test	Key exchange test
file	Test code file
line	Test code line

Definition at line 47 of file exchange_test.c.

                                        {
        struct exchange_algorithm *exchange = test->exchange;
        struct {
                uint8_t public[ exchange->pubsize ];
                uint8_t shared[ exchange->sharedsize ];
        } *actual;
        int rc;
 
        /* Sanity checks */
        okx ( test->private_len == exchange->privsize, file, line );
        okx ( test->partner_len == exchange->pubsize, file, line );
        okx ( test->public_len == exchange->pubsize, file, line );
        okx ( ( ( test->shared_len == 0 ) ||
                ( test->shared_len == exchange->sharedsize ) ), file, line );
 
        /* Allocate result buffer */
        actual = malloc ( sizeof ( *actual ) );
        okx ( actual != NULL, file, line );
 
        /* Verify calculation of public key */
        DBGC ( test, "KEX %s private key:\n", exchange->name );
        DBGC_HDA ( test, 0, test->private, exchange->privsize );
        okx ( exchange_share ( exchange, test->private, actual->public ) == 0,
              file, line );
        DBGC ( test, "KEX %s public key:\n", exchange->name );
        DBGC_HDA ( test, 0, actual->public, exchange->pubsize );
        okx ( memcmp ( actual->public, test->public, exchange->pubsize ) == 0,
              file, line );
 
        /* Verify calculation of shared secret */
        DBGC ( test, "KEX %s partner key:\n", exchange->name );
        DBGC_HDA ( test, 0, test->partner, exchange->pubsize );
        rc = exchange_agree ( exchange, test->private, test->partner,
                              actual->shared );
        if ( test->shared_len ) {
                /* Verify successful calculation */
                okx ( rc == 0, file, line );
                DBGC ( test, "KEX %s shared secret:\n", exchange->name );
                DBGC_HDA ( test, 0, actual->shared, exchange->sharedsize );
                okx ( memcmp ( actual->shared, test->shared,
                               exchange->sharedsize ) == 0, file, line );
        } else {
                /* Verify failure */
                okx ( rc != 0, file, line );
        }
 
        /* Free result buffer */
        free ( actual );
}

References DBGC, DBGC_HDA, exchange_agree(), exchange_share(), free, malloc(), memcmp(), exchange_algorithm::name, NULL, okx, exchange_algorithm::privsize, exchange_algorithm::pubsize, rc, exchange_algorithm::sharedsize, and test.