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	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)
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 void	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 size_t	pubkey_max_len (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key)
static int	pubkey_encrypt (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, const void *data, size_t len, void *out)
static int	pubkey_decrypt (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, const void *data, size_t len, void *out)
static int	pubkey_sign (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, struct digest_algorithm *digest, const void *value, void *signature)
static int	pubkey_verify (struct pubkey_algorithm *pubkey, const struct asn1_cursor *key, struct digest_algorithm *digest, const void *value, const void *signature, size_t signature_len)
static int	pubkey_match (struct pubkey_algorithm *pubkey, const struct asn1_cursor *private_key, const struct asn1_cursor *public_key)
static int	elliptic_multiply (struct elliptic_curve *curve, const void *base, const void *scalar, void *result)
void	digest_null_init (void *ctx)
void	digest_null_update (void *ctx, const void *src, size_t len)
void	digest_null_final (void *ctx, void *out)
int	cipher_null_setkey (void *ctx, const void *key, size_t keylen)
void	cipher_null_setiv (void *ctx, const void *iv, size_t ivlen)
void	cipher_null_encrypt (void *ctx, const void *src, void *dst, size_t len)
void	cipher_null_decrypt (void *ctx, const void *src, void *dst, size_t len)
void	cipher_null_auth (void *ctx, void *auth)
size_t	pubkey_null_max_len (const struct asn1_cursor *key)
int	pubkey_null_encrypt (const struct asn1_cursor *key, const void *plaintext, size_t plaintext_len, void *ciphertext)
int	pubkey_null_decrypt (const struct asn1_cursor *key, const void *ciphertext, size_t ciphertext_len, void *plaintext)
int	pubkey_null_sign (const struct asn1_cursor *key, struct digest_algorithm *digest, const void *value, void *signature)
int	pubkey_null_verify (const struct asn1_cursor *key, struct digest_algorithm *digest, const void *value, const void *signature, size_t signature_len)

Variables
struct digest_algorithm	digest_null
struct cipher_algorithm	cipher_null
struct pubkey_algorithm	pubkey_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 235 of file crypto.h.

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 245 of file crypto.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

digest_init()

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

inlinestatic

Definition at line 203 of file crypto.h.

                                                           {
        digest->init ( 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(), 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(), tls_select_handshake(), tls_verify_dh_params(), x509_check_signature(), and x509_fingerprint().

digest_update()

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

inlinestatic

Definition at line 208 of file crypto.h.

                                               {
        digest->update ( 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(), 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(), tls_add_handshake(), tls_verify_dh_params(), x509_check_signature(), and x509_fingerprint().

digest_final()

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

inlinestatic

Definition at line 214 of file crypto.h.

                                                                       {
        digest->final ( 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_init(), 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(), tls_verify_dh_params(), tls_verify_handshake(), x509_check_signature(), and x509_fingerprint().

cipher_setkey()

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

inlinestatic

Definition at line 219 of file crypto.h.

                                                 {
        return cipher->setkey ( 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(), gcm_setkey(), mschapv2_challenge_response(), peerblk_parse_header(), tkip_decrypt(), tkip_encrypt(), tls_generate_keys(), wep_decrypt(), and wep_encrypt().

cipher_setiv()

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

inlinestatic

Definition at line 225 of file crypto.h.

                                              {
        cipher->setiv ( 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_plaintext().

cipher_encrypt()

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

inlinestatic

Definition at line 231 of file crypto.h.

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

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

cipher_decrypt()

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

inlinestatic

Definition at line 241 of file crypto.h.

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

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

cipher_auth()

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

inlinestatic

Definition at line 251 of file crypto.h.

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

References cipher_algorithm::auth, and ctx.

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

is_stream_cipher()

static int is_stream_cipher ( struct cipher_algorithm *  cipher )

inlinestatic

Definition at line 256 of file crypto.h.

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

References cipher_algorithm::blocksize.

is_block_cipher()

static int is_block_cipher ( struct cipher_algorithm *  cipher )

inlinestatic

Definition at line 261 of file crypto.h.

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

References cipher_algorithm::blocksize.

Referenced by cms_verify_padding(), tls_new_ciphertext(), and tls_send_plaintext().

is_auth_cipher()

static int is_auth_cipher ( struct cipher_algorithm *  cipher )

inlinestatic

Definition at line 266 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_plaintext().

pubkey_max_len()

static size_t pubkey_max_len ( struct pubkey_algorithm *  pubkey, const struct asn1_cursor *  key  )

inlinestatic

Definition at line 271 of file crypto.h.

                                                 {
        return pubkey->max_len ( key );
}

References key, and pubkey_algorithm::max_len.

Referenced by cms_cipher_key(), icert_cert(), pubkey_okx(), pubkey_sign_okx(), tls_send_certificate_verify(), and tls_send_client_key_exchange_pubkey().

pubkey_encrypt()

static int pubkey_encrypt ( struct pubkey_algorithm *  pubkey, const struct asn1_cursor *  key, const void *  data, size_t  len, void *  out  )

inlinestatic

Definition at line 277 of file crypto.h.

                                                           {
        return pubkey->encrypt ( key, data, len, out );
}

References data, pubkey_algorithm::encrypt, key, len, and out.

Referenced by pubkey_okx(), and tls_send_client_key_exchange_pubkey().

pubkey_decrypt()

static int pubkey_decrypt ( struct pubkey_algorithm *  pubkey, const struct asn1_cursor *  key, const void *  data, size_t  len, void *  out  )

inlinestatic

Definition at line 283 of file crypto.h.

                                                           {
        return pubkey->decrypt ( key, data, len, out );
}

References data, pubkey_algorithm::decrypt, key, len, and out.

Referenced by cms_cipher_key(), and pubkey_okx().

pubkey_sign()

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

inlinestatic

Definition at line 289 of file crypto.h.

                                {
        return pubkey->sign ( 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()

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

inlinestatic

Definition at line 296 of file crypto.h.

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

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()

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

inlinestatic

Definition at line 303 of file crypto.h.

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

References pubkey_algorithm::match.

Referenced by x509_find_key().

elliptic_multiply()

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

inlinestatic

Definition at line 310 of file crypto.h.

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

References base, elliptic_curve::multiply, and result.

Referenced by ecdhe_key(), and elliptic_okx().

digest_null_init()

void digest_null_init

(

void *

ctx

)

digest_null_update()

void digest_null_update	(	void *	ctx,
		const void *	src,
		size_t	len
	)

digest_null_final()

void digest_null_final	(	void *	ctx,
		void *	out
	)

cipher_null_setkey()

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

cipher_null_setiv()

void cipher_null_setiv	(	void *	ctx,
		const void *	iv,
		size_t	ivlen
	)

cipher_null_encrypt()

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

cipher_null_decrypt()

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

cipher_null_auth()

void cipher_null_auth	(	void *	ctx,
		void *	auth
	)

pubkey_null_max_len()

size_t pubkey_null_max_len

(

const struct asn1_cursor *

key

)

pubkey_null_encrypt()

int pubkey_null_encrypt	(	const struct asn1_cursor *	key,
		const void *	plaintext,
		size_t	plaintext_len,
		void *	ciphertext
	)

pubkey_null_decrypt()

int pubkey_null_decrypt	(	const struct asn1_cursor *	key,
		const void *	ciphertext,
		size_t	ciphertext_len,
		void *	plaintext
	)

pubkey_null_sign()

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

pubkey_null_verify()

int pubkey_null_verify	(	const struct asn1_cursor *	key,
		struct digest_algorithm *	digest,
		const void *	value,
		const void *	signature,
		size_t	signature_len
	)

Variable Documentation

digest_null

struct digest_algorithm digest_null

Definition at line 48 of file crypto_null.c.

Referenced by tls_clear_handshake().

cipher_null

struct cipher_algorithm cipher_null

Definition at line 83 of file crypto_null.c.

Referenced by cms_message().

pubkey_null

struct pubkey_algorithm pubkey_null

Definition at line 128 of file crypto_null.c.