crypto.h File Reference

Cryptographic API. More...

#include <stdint.h>
#include <stddef.h>
#include <assert.h>
#include <ipxe/asn1.h>

Go to the source code of this file.

Data Structures
struct	digest_algorithm
	A message digest algorithm. More...
struct	cipher_algorithm
	A cipher algorithm. More...
struct	pubkey_algorithm
	A public key algorithm. More...
struct	exchange_algorithm
	A key exchange algorithm. More...
struct	elliptic_curve
	An elliptic curve. More...

Macros
#define	cipher_encrypt(cipher, ctx, src, dst, len)
#define	cipher_decrypt(cipher, ctx, src, dst, len)

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static void	digest_init (struct digest_algorithm *digest, void *ctx)
static void	digest_update (struct digest_algorithm *digest, void *ctx, const void *data, size_t len)
static void	digest_final (struct digest_algorithm *digest, void *ctx, void *out)
static int	cipher_setkey (struct cipher_algorithm *cipher, void *ctx, const void *key, size_t keylen)
static int	cipher_setiv (struct cipher_algorithm *cipher, void *ctx, const void *iv, size_t ivlen)
static void	cipher_encrypt (struct cipher_algorithm *cipher, void *ctx, const void *src, void *dst, size_t len)
static void	cipher_decrypt (struct cipher_algorithm *cipher, void *ctx, const void *src, void *dst, size_t len)
static void	cipher_auth (struct cipher_algorithm *cipher, void *ctx, void *auth)
static int	is_stream_cipher (struct cipher_algorithm *cipher)
static int	is_block_cipher (struct cipher_algorithm *cipher)
static int	is_auth_cipher (struct cipher_algorithm *cipher)
static int	pubkey_encrypt (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, const struct asn1_cursor *plaintext, struct asn1_builder *ciphertext)
static int	pubkey_decrypt (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, const struct asn1_cursor *ciphertext, struct asn1_builder *plaintext)
static int	pubkey_sign (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, struct digest_algorithm *digest, const void *value, struct asn1_builder *signature)
static int	pubkey_verify (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, struct digest_algorithm *digest, const void *value, const struct asn1_cursor *signature)
static int	pubkey_match (struct pubkey_algorithm *pubkey, const struct asn1_cursor *private_key, const struct asn1_cursor *public_key)
static int	exchange_share (struct exchange_algorithm *exchange, const void *private, void *public)
static int	exchange_agree (struct exchange_algorithm *exchange, const void *private, const void *partner, void *shared)
static int	is_key_transport (struct exchange_algorithm *exchange)
static int	elliptic_is_infinity (struct elliptic_curve *curve, const void *point)
static int	elliptic_multiply (struct elliptic_curve *curve, const void *base, const void *scalar, void *result)
static int	elliptic_add (struct elliptic_curve *curve, const void *addend, const void *augend, void *result)
void	digest_null_init (struct digest_algorithm *digest, void *ctx)
void	digest_null_update (struct digest_algorithm *digest, void *ctx, const void *src, size_t len)
void	digest_null_final (struct digest_algorithm *digest, void *ctx, void *out)
int	cipher_null_setkey (struct cipher_algorithm *cipher, void *ctx, const void *key, size_t keylen)
int	cipher_null_setiv (struct cipher_algorithm *cipehr, void *ctx, const void *iv, size_t ivlen)
void	cipher_null_encrypt (struct cipher_algorithm *cipher, void *ctx, const void *src, void *dst, size_t len)
void	cipher_null_decrypt (struct cipher_algorithm *cipher, void *ctx, const void *src, void *dst, size_t len)
void	cipher_null_auth (struct cipher_algorithm *cipher, void *ctx, void *auth)
int	pubkey_null_encrypt (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, const struct asn1_cursor *plaintext, struct asn1_builder *ciphertext)
int	pubkey_null_decrypt (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, const struct asn1_cursor *ciphertext, struct asn1_builder *plaintext)
int	pubkey_null_sign (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, struct digest_algorithm *digest, const void *value, struct asn1_builder *signature)
int	pubkey_null_verify (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, struct digest_algorithm *digest, const void *value, const struct asn1_cursor *signature)
int	pubkey_null_match (struct pubkey_algorithm *pubkey, const struct asn1_cursor *private_key, const struct asn1_cursor *public_key)
int	exchange_null_share (struct exchange_algorithm *exchange, const void *private, void *public)
int	exchange_null_agree (struct exchange_algorithm *exchange, const void *private, const void *partner, void *shared)

Variables
struct digest_algorithm	digest_null
struct cipher_algorithm	cipher_null
struct pubkey_algorithm	pubkey_null
struct exchange_algorithm	exchange_null

Detailed Description

Cryptographic API.

Definition in file crypto.h.

Macro Definition Documentation

cipher_encrypt

#define cipher_encrypt	(		cipher,
			ctx,
			src,
			dst,
			len )

Value:

do {            \
assert ( ( (len) & ( (cipher)->blocksize - 1 ) ) == 0 );        \
cipher_encrypt ( (cipher), (ctx), (src), (dst), (len) );        \
} while ( 0 )

Definition at line 326 of file crypto.h.

#define cipher_encrypt( cipher, ctx, src, dst, len ) do {               \
        assert ( ( (len) & ( (cipher)->blocksize - 1 ) ) == 0 );        \
        cipher_encrypt ( (cipher), (ctx), (src), (dst), (len) );        \
        } while ( 0 )

Referenced by aes_wrap(), cbc_encrypt(), ccmp_cbc_mac(), ccmp_ctr_xor(), ccmp_feed_cbc_mac(), cipher_cost_encrypt(), cipher_encrypt_okx(), cms_decrypt(), ecb_encrypt(), gcm_auth(), gcm_process(), gcm_setkey(), mschapv2_challenge_response(), tkip_encrypt(), tls_send_record(), and wep_encrypt().

cipher_decrypt

#define cipher_decrypt	(		cipher,
			ctx,
			src,
			dst,
			len )

Value:

do {            \
assert ( ( (len) & ( (cipher)->blocksize - 1 ) ) == 0 );        \
cipher_decrypt ( (cipher), (ctx), (src), (dst), (len) );        \
} while ( 0 )

Definition at line 336 of file crypto.h.

#define cipher_decrypt( cipher, ctx, src, dst, len ) do {               \
        assert ( ( (len) & ( (cipher)->blocksize - 1 ) ) == 0 );        \
        cipher_decrypt ( (cipher), (ctx), (src), (dst), (len) );        \
        } while ( 0 )

Referenced by aes_unwrap(), cbc_decrypt(), cipher_cost_decrypt(), cipher_decrypt_okx(), cms_decrypt(), ecb_decrypt(), peerblk_decrypt(), tkip_decrypt(), tls_new_ciphertext(), and wep_decrypt().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

digest_init()

void digest_init ( struct digest_algorithm * digest, void * ctx )

inlinestatic

Definition at line 294 of file crypto.h.

                                                           {
        digest->init ( digest, ctx );
}

References ctx, and digest_algorithm::init.

Referenced by asn1_okx(), chap_init(), cms_digest(), dbg_md5_da(), digest_cost(), digest_exec(), digest_frag_okx(), hash_df(), hmac_final(), hmac_init_key(), hmac_key(), http_digest_init(), icert_cert(), md5_sha1_init(), mschapv2_auth(), mschapv2_challenge_hash(), mschapv2_hash_hash(), mschapv2_password_hash(), ntlm_key(), ocsp_check_signature(), ocsp_compare_responder_key_hash(), ocsp_request(), peerblk_reset(), peerdist_info_passphrase_okx(), pubkey_sign_okx(), rsa_pss_encode(), rsa_xor_mask(), tls_set_digest(), tls_verify_dh_params(), x509_check_signature(), and x509_fingerprint().

digest_update()

void digest_update ( struct digest_algorithm * digest, void * ctx, const void * data, size_t len )

inlinestatic

Definition at line 299 of file crypto.h.

                                               {
        digest->update ( digest, ctx, data, len );
}

References ctx, data, len, and digest_algorithm::update.

Referenced by asn1_okx(), chap_update(), cms_digest(), dbg_md5_da(), digest_cost(), digest_exec(), digest_frag_okx(), hash_df(), hmac_final(), hmac_init_key(), hmac_key(), hmac_update(), http_digest_update(), icert_cert(), md5_sha1_update(), mschapv2_auth(), mschapv2_challenge_hash(), mschapv2_hash_hash(), mschapv2_password_hash(), ntlm_key(), ocsp_check_signature(), ocsp_compare_responder_key_hash(), ocsp_request(), peerblk_decrypt(), peerblk_raw_rx(), peerdist_info_passphrase_okx(), pubkey_sign_okx(), rsa_pss_encode(), rsa_xor_mask(), tls_add_handshake(), tls_verify_dh_params(), x509_check_signature(), and x509_fingerprint().

digest_final()

void digest_final ( struct digest_algorithm * digest, void * ctx, void * out )

inlinestatic

Definition at line 305 of file crypto.h.

                                                                       {
        digest->final ( digest, ctx, out );
}

References ctx, digest_algorithm::final, and out.

Referenced by asn1_okx(), chap_respond(), cms_digest(), dbg_md5_da(), digest_cost(), digest_exec(), digest_frag_okx(), hash_df(), hmac_final(), hmac_key(), http_digest_final(), icert_cert(), md5_sha1_final(), mschapv2_auth(), mschapv2_challenge_hash(), mschapv2_hash_hash(), mschapv2_password_hash(), ntlm_key(), ocsp_check_signature(), ocsp_compare_responder_key_hash(), ocsp_request(), peerblk_done(), peerdist_info_passphrase_okx(), pubkey_sign_okx(), rsa_pss_encode(), rsa_xor_mask(), tls_verify_dh_params(), tls_verify_handshake(), x509_check_signature(), and x509_fingerprint().

cipher_setkey()

int cipher_setkey ( struct cipher_algorithm * cipher, void * ctx, const void * key, size_t keylen )

inlinestatic

Definition at line 310 of file crypto.h.

                                                 {
        return cipher->setkey ( cipher, ctx, key, keylen );
}

References ctx, key, and cipher_algorithm::setkey.

Referenced by aes_unwrap(), aes_wrap(), cbc_setkey(), ccmp_init(), cipher_cost(), cipher_decrypt_okx(), cipher_encrypt_okx(), cms_cipher_key(), ecb_setkey(), gcm_setkey(), mschapv2_challenge_response(), peerblk_parse_header(), tkip_decrypt(), tkip_encrypt(), tls_generate_keys(), wep_decrypt(), and wep_encrypt().

cipher_setiv()

int cipher_setiv ( struct cipher_algorithm * cipher, void * ctx, const void * iv, size_t ivlen )

inlinestatic

Definition at line 316 of file crypto.h.

                                              {
        return cipher->setiv ( cipher, ctx, iv, ivlen );
}

References ctx, iv, and cipher_algorithm::setiv.

Referenced by cipher_cost(), cipher_decrypt_okx(), cipher_encrypt_okx(), cms_cipher_key(), peerblk_parse_iv(), tls_new_ciphertext(), and tls_send_record().

cipher_encrypt()

void cipher_encrypt ( struct cipher_algorithm * cipher, void * ctx, const void * src, void * dst, size_t len )

inlinestatic

Definition at line 322 of file crypto.h.

                                                          {
        cipher->encrypt ( cipher, ctx, src, dst, len );
}

References ctx, cipher_algorithm::encrypt, len, and src.

cipher_decrypt()

void cipher_decrypt ( struct cipher_algorithm * cipher, void * ctx, const void * src, void * dst, size_t len )

inlinestatic

Definition at line 332 of file crypto.h.

                                                          {
        cipher->decrypt ( cipher, ctx, src, dst, len );
}

References ctx, cipher_algorithm::decrypt, len, and src.

cipher_auth()

void cipher_auth ( struct cipher_algorithm * cipher, void * ctx, void * auth )

inlinestatic

Definition at line 342 of file crypto.h.

                                                                       {
        cipher->auth ( cipher, ctx, auth );
}

References cipher_algorithm::auth, and ctx.

Referenced by cipher_decrypt_okx(), cipher_encrypt_okx(), cms_decrypt(), tls_new_ciphertext(), and tls_send_record().

is_stream_cipher()

int is_stream_cipher ( struct cipher_algorithm * cipher )

inlinestatic

Definition at line 347 of file crypto.h.

                                                     {
        return ( cipher->blocksize == 1 );
}

References cipher_algorithm::blocksize.

is_block_cipher()

int is_block_cipher ( struct cipher_algorithm * cipher )

inlinestatic

Definition at line 352 of file crypto.h.

                                                    {
        return ( cipher->blocksize > 1 );
}

References cipher_algorithm::blocksize.

Referenced by cms_decrypt(), cms_verify_padding(), tls_iob_reserved(), tls_new_ciphertext(), and tls_send_record().

is_auth_cipher()

int is_auth_cipher ( struct cipher_algorithm * cipher )

inlinestatic

Definition at line 357 of file crypto.h.

                                                   {
        return cipher->authsize;
}

References cipher_algorithm::authsize.

Referenced by cipher_decrypt_okx(), cipher_encrypt_okx(), tls_new_ciphertext(), and tls_send_record().

pubkey_encrypt()

int pubkey_encrypt ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * key, const struct asn1_cursor * plaintext, struct asn1_builder * ciphertext )

inlinestatic

Definition at line 362 of file crypto.h.

                                                   {
        return pubkey->encrypt ( pubkey, key, plaintext, ciphertext );
}

References pubkey_algorithm::encrypt, and key.

Referenced by pubkey_okx(), and tls_send_client_key_exchange_pubkey().

pubkey_decrypt()

int pubkey_decrypt ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * key, const struct asn1_cursor * ciphertext, struct asn1_builder * plaintext )

inlinestatic

Definition at line 369 of file crypto.h.

                                                  {
        return pubkey->decrypt ( pubkey, key, ciphertext, plaintext );
}

References pubkey_algorithm::decrypt, and key.

Referenced by cms_cipher_key(), and pubkey_okx().

pubkey_sign()

int pubkey_sign ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * key, struct digest_algorithm * digest, const void * value, struct asn1_builder * signature )

inlinestatic

Definition at line 376 of file crypto.h.

                                               {
        return pubkey->sign ( pubkey, key, digest, value, signature );
}

References key, pubkey_algorithm::sign, signature, and value.

Referenced by icert_cert(), pubkey_sign_okx(), and tls_send_certificate_verify().

pubkey_verify()

int pubkey_verify ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * key, struct digest_algorithm * digest, const void * value, const struct asn1_cursor * signature )

inlinestatic

Definition at line 383 of file crypto.h.

                                                      {
        return pubkey->verify ( pubkey, key, digest, value, signature );
}

References key, signature, value, and pubkey_algorithm::verify.

Referenced by cms_verify_digest(), ocsp_check_signature(), pubkey_sign_okx(), tls_verify_dh_params(), and x509_check_signature().

pubkey_match()

int pubkey_match ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * private_key, const struct asn1_cursor * public_key )

inlinestatic

Definition at line 390 of file crypto.h.

                                                      {
        return pubkey->match ( pubkey, private_key, public_key );
}

References pubkey_algorithm::match.

Referenced by pubkey_okx(), pubkey_sign_okx(), and x509_find_key().

exchange_share()

int exchange_share ( struct exchange_algorithm * exchange, const void * private, void * public )

inlinestatic

Definition at line 397 of file crypto.h.

                                {
        return exchange->share ( exchange, private, public );
}

References exchange_algorithm::share.

Referenced by exchange_okx(), and tls_share_ephemeral().

exchange_agree()

int exchange_agree ( struct exchange_algorithm * exchange, const void * private, const void * partner, void * shared )

inlinestatic

Definition at line 403 of file crypto.h.

                                                     {
        return exchange->agree ( exchange, private, partner, shared );
}

References exchange_algorithm::agree, and partner.

Referenced by exchange_okx(), and tls_agree_ephemeral().

is_key_transport()

int is_key_transport ( struct exchange_algorithm * exchange )

inlinestatic

Definition at line 409 of file crypto.h.

                                                         {
        return ( exchange->pubsize == 0 );
}

References exchange_algorithm::pubsize.

Referenced by tls_send_client_key_exchange_pubkey().

elliptic_is_infinity()

int elliptic_is_infinity ( struct elliptic_curve * curve, const void * point )

inlinestatic

Definition at line 414 of file crypto.h.

                                                                         {
        return curve->is_infinity ( curve, point );
}

References elliptic_curve::is_infinity.

Referenced by ecdsa_parse_key(), ecdsa_verify_rs(), elliptic_agree(), and elliptic_curve_okx().

elliptic_multiply()

int elliptic_multiply ( struct elliptic_curve * curve, const void * base, const void * scalar, void * result )

inlinestatic

Definition at line 419 of file crypto.h.

                                                                         {
        return curve->multiply ( curve, base, scalar, result );
}

References base, elliptic_curve::multiply, and result.

Referenced by ecdsa_sign_rs(), ecdsa_verify_rs(), elliptic_agree(), elliptic_curve_okx(), elliptic_multiply_okx(), and elliptic_share().

elliptic_add()

int elliptic_add ( struct elliptic_curve * curve, const void * addend, const void * augend, void * result )

inlinestatic

Definition at line 425 of file crypto.h.

                                                  {
        return curve->add ( curve, addend, augend, result );
}

References elliptic_curve::add, and result.

Referenced by ecdsa_verify_rs(), and elliptic_add_okx().

digest_null_init()

void digest_null_init ( struct digest_algorithm * digest, void * ctx )

extern

References ctx.

digest_null_update()

void digest_null_update ( struct digest_algorithm * digest, void * ctx, const void * src, size_t len )

extern

References ctx, len, and src.

digest_null_final()

void digest_null_final ( struct digest_algorithm * digest, void * ctx, void * out )

extern

References ctx, and out.

cipher_null_setkey()

int cipher_null_setkey ( struct cipher_algorithm * cipher, void * ctx, const void * key, size_t keylen )

extern

References ctx, and key.

cipher_null_setiv()

int cipher_null_setiv ( struct cipher_algorithm * cipehr, void * ctx, const void * iv, size_t ivlen )

extern

References ctx, and iv.

cipher_null_encrypt()

void cipher_null_encrypt ( struct cipher_algorithm * cipher, void * ctx, const void * src, void * dst, size_t len )

extern

References ctx, len, and src.

cipher_null_decrypt()

void cipher_null_decrypt ( struct cipher_algorithm * cipher, void * ctx, const void * src, void * dst, size_t len )

extern

References ctx, len, and src.

cipher_null_auth()

void cipher_null_auth ( struct cipher_algorithm * cipher, void * ctx, void * auth )

extern

References ctx.

pubkey_null_encrypt()

int pubkey_null_encrypt ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * key, const struct asn1_cursor * plaintext, struct asn1_builder * ciphertext )

extern

References key.

pubkey_null_decrypt()

int pubkey_null_decrypt ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * key, const struct asn1_cursor * ciphertext, struct asn1_builder * plaintext )

extern

References key.

pubkey_null_sign()

int pubkey_null_sign ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * key, struct digest_algorithm * digest, const void * value, struct asn1_builder * signature )

extern

References key, signature, and value.

pubkey_null_verify()

int pubkey_null_verify ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * key, struct digest_algorithm * digest, const void * value, const struct asn1_cursor * signature )

extern

References key, signature, and value.

pubkey_null_match()

int pubkey_null_match ( struct pubkey_algorithm * pubkey, const struct asn1_cursor * private_key, const struct asn1_cursor * public_key )

extern

exchange_null_share()

int exchange_null_share ( struct exchange_algorithm * exchange, const void * private, void * public )

extern

exchange_null_agree()

int exchange_null_agree ( struct exchange_algorithm * exchange, const void * private, const void * partner, void * shared )

extern

References cipher_null, digest_null, exchange_null, partner, and pubkey_null.

Variable Documentation

digest_null

struct digest_algorithm digest_null

extern

Definition at line 53 of file crypto_null.c.

                                    {
        .name = "null",
        .ctxsize = 0,
        .blocksize = 1,
        .digestsize = 0,
        .init = digest_null_init,
        .update = digest_null_update,
        .final = digest_null_final,
};

Referenced by cms_parse_participants(), exchange_null_agree(), and tls_clear_digest().

cipher_null

struct cipher_algorithm cipher_null

extern

Definition at line 94 of file crypto_null.c.

                                    {
        .name = "null",
        .ctxsize = 0,
        .blocksize = 1,
        .alignsize = 1,
        .authsize = 0,
        .confidential = 0,
        .setkey = cipher_null_setkey,
        .setiv = cipher_null_setiv,
        .encrypt = cipher_null_encrypt,
        .decrypt = cipher_null_decrypt,
        .auth = cipher_null_auth,
};

Referenced by cms_message(), and exchange_null_agree().

pubkey_null

struct pubkey_algorithm pubkey_null

extern

Definition at line 144 of file crypto_null.c.

                                    {
        .name = "null",
        .encrypt = pubkey_null_encrypt,
        .decrypt = pubkey_null_decrypt,
        .sign = pubkey_null_sign,
        .verify = pubkey_null_verify,
        .match = pubkey_null_match,
};

Referenced by cms_parse_participants(), and exchange_null_agree().

exchange_null

struct exchange_algorithm exchange_null

extern

Definition at line 166 of file crypto_null.c.

                                        {
        .name = "null",
        .privsize = 0,
        .pubsize = 0,
        .sharedsize = 0,
        .share = exchange_null_share,
        .agree = exchange_null_agree,
};

Referenced by exchange_null_agree().