elliptic_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	elliptic_test
	An elliptic curve point multiplication test. More...

Macros
#define	BASE(...)   { __VA_ARGS__ }
	Define inline base point. More...
#define	BASE_GENERATOR   BASE()
	Define base point to be curve's generator. More...
#define	SCALAR(...)   { __VA_ARGS__ }
	Define inline scalar multiple. More...
#define	EXPECTED(...)   { __VA_ARGS__ }
	Define inline expected result point. More...
#define	EXPECTED_FAIL   EXPECTED()
	Define result as an expected failure. More...
#define	ELLIPTIC_TEST(name, CURVE, BASE, SCALAR, EXPECTED)
	Define an elliptic curve point multiplication test. More...
#define	elliptic_ok(test)   elliptic_okx ( test, __FILE__, __LINE__ )
	Report an elliptic curve point multiplication test result. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
void	elliptic_okx (struct elliptic_test *test, const char *file, unsigned int line)
	Report elliptic curve point multiplication test result. More...

Macro Definition Documentation

BASE

#define BASE

(

...

)

{ __VA_ARGS__ }

Define inline base point.

Definition at line 29 of file elliptic_test.h.

BASE_GENERATOR

#define BASE_GENERATOR   BASE()

Define base point to be curve's generator.

Definition at line 32 of file elliptic_test.h.

SCALAR

#define SCALAR

(

...

)

{ __VA_ARGS__ }

Define inline scalar multiple.

Definition at line 35 of file elliptic_test.h.

EXPECTED

#define EXPECTED

(

...

)

{ __VA_ARGS__ }

Define inline expected result point.

Definition at line 38 of file elliptic_test.h.

EXPECTED_FAIL

#define EXPECTED_FAIL   EXPECTED()

Define result as an expected failure.

Definition at line 41 of file elliptic_test.h.

ELLIPTIC_TEST

#define ELLIPTIC_TEST	(		name,
			CURVE,
			BASE,
			SCALAR,
			EXPECTED
	)

Value:

static const uint8_t name ## _base[] = BASE;                    \
        static const uint8_t name ## _scalar[] = SCALAR;                \
        static const uint8_t name ## _expected[] = EXPECTED;            \
        static struct elliptic_test name = {                            \
                .curve = CURVE,                                         \
                .base = name ## _base,                                  \
                .base_len = sizeof ( name ## _base ),                   \
                .scalar = name ## _scalar,                              \
                .scalar_len = sizeof ( name ## _scalar ),               \
                .expected = name ## _expected,                          \
                .expected_len = sizeof ( name ## _expected ),           \
        };

Define an elliptic curve point multiplication test.

Parameters

name	Test name
CURVE	Elliptic curve
BASE	Base point
SCALAR	Scalar multiple
EXPECTED	Expected result point

Return values

test	Elliptic curve point multiplication test

Definition at line 53 of file elliptic_test.h.

elliptic_ok

#define elliptic_ok

(

test

)

elliptic_okx ( test, __FILE__, __LINE__ )

Report an elliptic curve point multiplication test result.

Parameters

test	Elliptic curve point multiplication test

Definition at line 75 of file elliptic_test.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

elliptic_okx()

void elliptic_okx	(	struct elliptic_test *	test,
		const char *	file,
		unsigned int	line
	)

Report elliptic curve point multiplication test result.

Parameters

test	Elliptic curve point multiplication test
file	Test code file
line	Test code line

Definition at line 49 of file elliptic_test.c.

                                        {
        struct elliptic_curve *curve = test->curve;
        size_t pointsize = curve->pointsize;
        size_t keysize = curve->keysize;
        uint8_t actual[pointsize];
        int rc;

        /* Sanity checks */
        okx ( ( test->base_len == pointsize ) || ( ! test->base_len ),
              file, line );
        okx ( test->scalar_len == keysize, file, line );
        okx ( ( test->expected_len == pointsize ) || ( ! test->expected_len ),
              file, line );

        /* Perform point multiplication */
        rc = elliptic_multiply ( curve, ( test->base_len ? test->base : NULL ),
                                 test->scalar, actual );
        if ( test->expected_len ) {
                okx ( rc == 0, file, line );
        } else {
                okx ( rc != 0, file, line );
        }

        /* Check expected result */
        okx ( memcmp ( actual, test->expected, test->expected_len ) == 0,
              file, line );
}

References elliptic_multiply(), keysize, elliptic_curve::keysize, memcmp(), NULL, okx, elliptic_curve::pointsize, rc, and test.