pubkey_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	pubkey_test
	A public-key encryption and decryption test. More...
struct	pubkey_sign_test
	A public-key signature test. More...

Macros
#define	PRIVATE(...)   { __VA_ARGS__ }
	Define inline private key data. More...
#define	PUBLIC(...)   { __VA_ARGS__ }
	Define inline public key data. More...
#define	PLAINTEXT(...)   { __VA_ARGS__ }
	Define inline plaintext data. More...
#define	CIPHERTEXT(...)   { __VA_ARGS__ }
	Define inline ciphertext data. More...
#define	SIGNATURE(...)   { __VA_ARGS__ }
	Define inline signature data. More...
#define	PUBKEY_TEST(name, PUBKEY, PRIVATE, PUBLIC, PLAINTEXT, CIPHERTEXT)
	Define a public-key encryption and decryption test. More...
#define	PUBKEY_SIGN_TEST(name, PUBKEY, PRIVATE, PUBLIC, PLAINTEXT, DIGEST, SIGNATURE)
	Define a public-key signature test. More...
#define	pubkey_ok(test)   pubkey_okx ( test, __FILE__, __LINE__ )
	Report a public key encryption and decryption test result. More...
#define	pubkey_sign_ok(test)   pubkey_sign_okx ( test, __FILE__, __LINE__ )
	Report a public key signature test result. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
void	pubkey_okx (struct pubkey_test *test, const char *file, unsigned int line)
	Report public key encryption and decryption test result. More...
void	pubkey_sign_okx (struct pubkey_sign_test *test, const char *file, unsigned int line)
	Report public key signature test result. More...

Macro Definition Documentation

PRIVATE

#define PRIVATE

(

...

)

{ __VA_ARGS__ }

Define inline private key data.

Definition at line 48 of file pubkey_test.h.

PUBLIC

#define PUBLIC

(

...

)

{ __VA_ARGS__ }

Define inline public key data.

Definition at line 51 of file pubkey_test.h.

PLAINTEXT

#define PLAINTEXT

(

...

)

{ __VA_ARGS__ }

Define inline plaintext data.

Definition at line 54 of file pubkey_test.h.

CIPHERTEXT

#define CIPHERTEXT

(

...

)

{ __VA_ARGS__ }

Define inline ciphertext data.

Definition at line 57 of file pubkey_test.h.

SIGNATURE

#define SIGNATURE

(

...

)

{ __VA_ARGS__ }

Define inline signature data.

Definition at line 60 of file pubkey_test.h.

PUBKEY_TEST

#define PUBKEY_TEST	(		name,
			PUBKEY,
			PRIVATE,
			PUBLIC,
			PLAINTEXT,
			CIPHERTEXT
	)

Value:

static const uint8_t name ## _private[] = PRIVATE;              \
        static const uint8_t name ## _public[] = PUBLIC;                \
        static const uint8_t name ## _plaintext[] = PLAINTEXT;          \
        static const uint8_t name ## _ciphertext[] = CIPHERTEXT;        \
        static struct pubkey_test name = {                              \
                .pubkey = PUBKEY,                                       \
                .private = {                                            \
                        .data = name ## _private,                       \
                        .len = sizeof ( name ## _private ),             \
                },                                                      \
                .public = {                                             \
                        .data = name ## _public,                        \
                        .len = sizeof ( name ## _public ),              \
                },                                                      \
                .plaintext = {                                          \
                        .data = name ## _plaintext,                     \
                        .len = sizeof ( name ## _plaintext ),           \
                },                                                      \
                .ciphertext = {                                         \
                        .data = name ## _ciphertext,                    \
                        .len = sizeof ( name ## _ciphertext ),          \
                },                                                      \
        }

Define a public-key encryption and decryption test.

Parameters

name	Test name
PUBKEY	Public-key algorithm
PRIVATE	Private key
PUBLIC	Public key
PLAINTEXT	Plaintext
CIPHERTEXT	Ciphertext

Return values

test	Encryption and decryption test

Definition at line 73 of file pubkey_test.h.

PUBKEY_SIGN_TEST

#define PUBKEY_SIGN_TEST	(		name,
			PUBKEY,
			PRIVATE,
			PUBLIC,
			PLAINTEXT,
			DIGEST,
			SIGNATURE
	)

Value:

static const uint8_t name ## _private[] = PRIVATE;              \
        static const uint8_t name ## _public[] = PUBLIC;                \
        static const uint8_t name ## _plaintext[] = PLAINTEXT;          \
        static const uint8_t name ## _signature[] = SIGNATURE;          \
        static struct pubkey_sign_test name = {                         \
                .pubkey = PUBKEY,                                       \
                .private = {                                            \
                        .data = name ## _private,                       \
                        .len = sizeof ( name ## _private ),             \
                },                                                      \
                .public = {                                             \
                        .data = name ## _public,                        \
                        .len = sizeof ( name ## _public ),              \
                },                                                      \
                .plaintext = name ## _plaintext,                        \
                .plaintext_len = sizeof ( name ## _plaintext ),         \
                .digest = DIGEST,                                       \
                .signature = {                                          \
                        .data = name ## _signature,                     \
                        .len = sizeof ( name ## _signature ),           \
                },                                                      \
        }

Define a public-key signature test.

Parameters

name	Test name
PUBKEY	Public-key algorithm
PRIVATE	Private key
PUBLIC	Public key
PLAINTEXT	Plaintext
DIGEST	Digest algorithm
SIGNATURE	Signature

Return values

test	Signature test

Definition at line 111 of file pubkey_test.h.

pubkey_ok

#define pubkey_ok

(

test

)

pubkey_okx ( test, __FILE__, __LINE__ )

Report a public key encryption and decryption test result.

Parameters

test	Public key encryption and decryption test

Definition at line 146 of file pubkey_test.h.

pubkey_sign_ok

#define pubkey_sign_ok

(

test

)

pubkey_sign_okx ( test, __FILE__, __LINE__ )

Report a public key signature test result.

Parameters

test	Public key signature test

Definition at line 154 of file pubkey_test.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

pubkey_okx()

void pubkey_okx	(	struct pubkey_test *	test,
		const char *	file,
		unsigned int	line
	)

Report public key encryption and decryption test result.

Parameters

test	Public key encryption and decryption test
file	Test code file
line	Test code line

Definition at line 50 of file pubkey_test.c.

                                      {
        struct pubkey_algorithm *pubkey = test->pubkey;
        struct asn1_builder plaintext;
        struct asn1_builder ciphertext;

        /* Test key matching */
        okx ( pubkey_match ( pubkey, &test->private, &test->public ) == 0,
              file, line );

        /* Test decrypting with private key to obtain known plaintext */
        plaintext.data = NULL;
        plaintext.len = 0;
        okx ( pubkey_decrypt ( pubkey, &test->private, &test->ciphertext,
                               &plaintext ) == 0, file, line );
        okx ( asn1_compare ( asn1_built ( &plaintext ),
                             &test->plaintext ) == 0, file, line );
        free ( plaintext.data );

        /* Test encrypting with private key and decrypting with public key */
        ciphertext.data = NULL;
        ciphertext.len = 0;
        plaintext.data = NULL;
        plaintext.len = 0;
        okx ( pubkey_encrypt ( pubkey, &test->private, &test->plaintext,
                               &ciphertext ) == 0, file, line );
        okx ( pubkey_decrypt ( pubkey, &test->public,
                               asn1_built ( &ciphertext ),
                               &plaintext ) == 0, file, line );
        okx ( asn1_compare ( asn1_built ( &plaintext ),
                             &test->plaintext ) == 0, file, line );
        free ( ciphertext.data );
        free ( plaintext.data );

        /* Test encrypting with public key and decrypting with private key */
        ciphertext.data = NULL;
        ciphertext.len = 0;
        plaintext.data = NULL;
        plaintext.len = 0;
        okx ( pubkey_encrypt ( pubkey, &test->public, &test->plaintext,
                               &ciphertext ) == 0, file, line );
        okx ( pubkey_decrypt ( pubkey, &test->private,
                               asn1_built ( &ciphertext ),
                               &plaintext ) == 0, file, line );
        okx ( asn1_compare ( asn1_built ( &plaintext ),
                             &test->plaintext ) == 0, file, line );
        free ( ciphertext.data );
        free ( plaintext.data );
}

References asn1_built(), asn1_compare(), asn1_builder::data, free, asn1_builder::len, NULL, okx, pubkey_decrypt(), pubkey_encrypt(), pubkey_match(), and test.

pubkey_sign_okx()

void pubkey_sign_okx	(	struct pubkey_sign_test *	test,
		const char *	file,
		unsigned int	line
	)

Report public key signature test result.

Parameters

test	Public key signature test
file	Test code file
line	Test code line

Definition at line 107 of file pubkey_test.c.

                                           {
        struct pubkey_algorithm *pubkey = test->pubkey;
        struct digest_algorithm *digest = test->digest;
        uint8_t digestctx[digest->ctxsize ];
        uint8_t digestout[digest->digestsize];
        struct asn1_builder signature = { NULL, 0 };
        uint8_t *bad;

        /* Test key matching */
        okx ( pubkey_match ( pubkey, &test->private, &test->public ) == 0,
              file, line );

        /* Construct digest over plaintext */
        digest_init ( digest, digestctx );
        digest_update ( digest, digestctx, test->plaintext,
                        test->plaintext_len );
        digest_final ( digest, digestctx, digestout );

        /* Test signing using private key */
        okx ( pubkey_sign ( pubkey, &test->private, digest, digestout,
                            &signature ) == 0, file, line );
        okx ( signature.len != 0, file, line );
        okx ( asn1_compare ( asn1_built ( &signature ),
                             &test->signature ) == 0, file, line );

        /* Test verification using public key */
        okx ( pubkey_verify ( pubkey, &test->public, digest, digestout,
                              &test->signature ) == 0, file, line );

        /* Test verification failure of modified signature */
        bad = ( signature.data + ( test->signature.len / 2 ) );
        okx ( pubkey_verify ( pubkey, &test->public, digest, digestout,
                              asn1_built ( &signature ) ) == 0, file, line );
        *bad ^= 0x40;
        okx ( pubkey_verify ( pubkey, &test->public, digest, digestout,
                              asn1_built ( &signature ) ) != 0, file, line );

        /* Free signature */
        free ( signature.data );
}

References asn1_built(), asn1_compare(), digest_algorithm::ctxsize, digest_final(), digest_init(), digest_update(), digest_algorithm::digestsize, free, NULL, okx, pubkey_match(), pubkey_sign(), pubkey_verify(), signature, and test.