hmac.h File Reference

Keyed-Hashing for Message Authentication. More...

#include <ipxe/crypto.h>

Go to the source code of this file.

Macros
#define	hmac_key_t(digest)
	HMAC reduced key type.
#define	hmac_context_t(digest)
	HMAC context type.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static size_t	hmac_keysize (struct digest_algorithm *digest)
	Calculate HMAC reduced key size.
static size_t	hmac_ctxsize (struct digest_algorithm *digest)
	Calculate HMAC context size.
static void	hmac_update (struct digest_algorithm *digest, void *ctx, const void *data, size_t len)
	Update HMAC.
void	hmac_key (struct digest_algorithm *digest, void *ctx, const void *secret, size_t len, void *key)
	Construct HMAC reduced key.
void	hmac_init_key (struct digest_algorithm *digest, void *ctx, const void *key)
	Initialise HMAC from reduced key.
void	hmac_init (struct digest_algorithm *digest, void *ctx, const void *secret, size_t len)
	Initialise HMAC.
void	hmac_final (struct digest_algorithm *digest, void *ctx, void *hmac)
	Finalise HMAC.

Detailed Description

Keyed-Hashing for Message Authentication.

Definition in file hmac.h.

Macro Definition Documentation

hmac_key_t

#define hmac_key_t

(

digest

)

Value:

        struct {                                        \
        /** HMAC input/output padding */                        \
        uint8_t pad[ digest->blocksize ];                       \
} __attribute__ (( packed ))

HMAC reduced key type.

Definition at line 15 of file hmac.h.

#define hmac_key_t( digest ) struct {                                   \
                /** HMAC input/output padding */                        \
                uint8_t pad[ digest->blocksize ];                       \
        } __attribute__ (( packed ))

Referenced by hmac_init_key(), hmac_key(), and hmac_keysize().

hmac_context_t

#define hmac_context_t

(

digest

)

Value:

        struct {                                \
        /** Digest context */                                   \
        uint8_t ctx[ digest->ctxsize ];                         \
        /** HMAC input/output padding */                        \
        uint8_t pad[ digest->blocksize ];                       \
} __attribute__ (( packed ))

HMAC context type.

Definition at line 21 of file hmac.h.

#define hmac_context_t( digest ) struct {                               \
                /** Digest context */                                   \
                uint8_t ctx[ digest->ctxsize ];                         \
                /** HMAC input/output padding */                        \
                uint8_t pad[ digest->blocksize ];                       \
        } __attribute__ (( packed ))

Referenced by hmac_ctxsize(), hmac_final(), hmac_init(), hmac_init_key(), hmac_key(), and hmac_update().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

hmac_keysize()

size_t hmac_keysize ( struct digest_algorithm * digest )

inlinestatic

Calculate HMAC reduced key size.

Parameters

digest

Digest algorithm to use

Return values

len	HMAC key pad size

Definition at line 35 of file hmac.h.

                                                 {
        hmac_key_t ( digest ) *hkey;
 
        return sizeof ( hkey->pad );
}

References hmac_key_t.

Referenced by hmac_okx(), tls_generate_resumption_master(), and tls_set_digest().

hmac_ctxsize()

size_t hmac_ctxsize ( struct digest_algorithm * digest )

inlinestatic

Calculate HMAC context size.

Parameters

digest

Digest algorithm to use

Return values

len	HMAC context size

Definition at line 48 of file hmac.h.

                                                 {
        hmac_context_t ( digest ) *hctx;
 
        return sizeof ( *hctx );
}

References hmac_context_t.

Referenced by hkdf_expand(), hkdf_extract(), hmac_drbg_update_key(), hmac_drbg_update_value(), hmac_okx(), peerdist_info_passphrase_okx(), peerdist_info_segment_hash(), tls_hmac(), tls_hmac_list(), tls_p_hash_va(), and tls_set_kdf_master().

hmac_update()

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

inlinestatic

Update HMAC.

Parameters

digest	Digest algorithm to use
ctx	HMAC context
data	Data
len	Length of data

Definition at line 62 of file hmac.h.

                                                                {
        hmac_context_t ( digest ) *hctx = ctx;
 
        digest_update ( digest, hctx->ctx, data, len );
}

References ctx, data, digest_update(), hmac_context_t, and len.

Referenced by ccmp_kie_mic(), hkdf_expand(), hkdf_extract(), hmac_drbg_update_key(), hmac_drbg_update_value(), hmac_okx(), ntlm_key(), ntlm_response(), pbkdf2_sha1_f(), peerdist_info_passphrase_okx(), peerdist_info_segment_hash(), prf_sha1(), tkip_kie_mic(), tls_hmac_init(), tls_hmac_update(), tls_hmac_update_va(), and tls_p_hash_va().

hmac_key()

void hmac_key ( struct digest_algorithm * digest, void * ctx, const void * secret, size_t len, void * key )

extern

Construct HMAC reduced key.

Parameters

digest	Digest algorithm to use
ctx	HMAC context
secret	Secret key
len	Length of secret key
key	HMAC reduced key to fill in

Definition at line 59 of file hmac.c.

                                        {
        hmac_context_t ( digest ) *hctx = ctx;
        hmac_key_t ( digest ) *hkey = key;
 
        /* Reduce key (if applicable) and zero-pad to block size */
        memset ( hkey->pad, 0, sizeof ( hkey->pad ) );
        if ( len <= sizeof ( hkey->pad ) ) {
                memcpy ( hkey->pad, secret, len );
        } else {
                digest_init ( digest, hctx->ctx );
                digest_update ( digest, hctx->ctx, secret, len );
                digest_final ( digest, hctx->ctx, hkey->pad );
        }
}

References ctx, digest_final(), digest_init(), digest_update(), hmac_context_t, hmac_key_t, key, len, memcpy(), and memset().

Referenced by hmac_init(), hmac_okx(), and tls_set_kdf_master().

hmac_init_key()

void hmac_init_key ( struct digest_algorithm * digest, void * ctx, const void * key )

extern

Initialise HMAC from reduced key.

Parameters

digest	Digest algorithm
ctx	HMAC context
hkey	HMAC key

Definition at line 82 of file hmac.c.

                                       {
        hmac_context_t ( digest ) *hctx = ctx;
        const hmac_key_t ( digest ) *hkey = key;
        unsigned int i;
 
        /* Construct input pad */
        for ( i = 0 ; i < sizeof ( hkey->pad ) ; i++ ) {
                hctx->pad[i] = ( hkey->pad[i] ^ 0x36 );
        }
 
        /* Start inner hash */
        digest_init ( digest, hctx->ctx );
        digest_update ( digest, hctx->ctx, hctx->pad, sizeof ( hctx->pad ) );
}

References ctx, digest_init(), digest_update(), hmac_context_t, hmac_key_t, and key.

Referenced by hmac_init(), hmac_okx(), and tls_p_hash_va().

hmac_init()

void hmac_init ( struct digest_algorithm * digest, void * ctx, const void * secret, size_t len )

extern

Initialise HMAC.

Parameters

digest	Digest algorithm to use
ctx	HMAC context
secret	Secret key
len	Length of secret key

Definition at line 106 of file hmac.c.

                                                  {
        hmac_context_t ( digest ) *hctx = ctx;
 
        /* Construct reduced key (in input pad) */
        hmac_key ( digest, hctx->ctx, secret, len, hctx->pad );
 
        /* Initialise HMAC */
        hmac_init_key ( digest, hctx->ctx, hctx->pad );
}

References ctx, hmac_context_t, hmac_init_key(), hmac_key(), and len.

Referenced by ccmp_kie_mic(), hkdf_expand(), hkdf_extract(), hmac_drbg_update_key(), hmac_drbg_update_value(), hmac_okx(), ntlm_key(), ntlm_response(), pbkdf2_sha1_f(), peerdist_info_passphrase_okx(), peerdist_info_segment_hash(), prf_sha1(), tkip_kie_mic(), and tls_hmac_init().

hmac_final()

void hmac_final ( struct digest_algorithm * digest, void * ctx, void * hmac )

extern

Finalise HMAC.

Parameters

digest	Digest algorithm to use
ctx	HMAC context
hmac	HMAC digest to fill in

Definition at line 124 of file hmac.c.

                                                                           {
        hmac_context_t ( digest ) *hctx = ctx;
        unsigned int i;
 
        /* Construct output pad from input pad */
        for ( i = 0 ; i < sizeof ( hctx->pad ) ; i++ ) {
                hctx->pad[i] ^= 0x6a;
        }
 
        /* Finish inner hash */
        digest_final ( digest, hctx->ctx, hmac );
 
        /* Perform outer hash */
        digest_init ( digest, hctx->ctx );
        digest_update ( digest, hctx->ctx, hctx->pad, sizeof ( hctx->pad ) );
        digest_update ( digest, hctx->ctx, hmac, digest->digestsize );
        digest_final ( digest, hctx->ctx, hmac );
 
        /* Erase output pad (from which the key may be derivable) */
        memset ( hctx->pad, 0, sizeof ( hctx->pad ) );
}

References ctx, digest_final(), digest_init(), digest_update(), digest_algorithm::digestsize, hmac_context_t, and memset().

Referenced by ccmp_kie_mic(), hkdf_expand(), hkdf_extract(), hmac_drbg_update_key(), hmac_drbg_update_value(), hmac_okx(), ntlm_key(), ntlm_response(), pbkdf2_sha1_f(), peerdist_info_passphrase_okx(), peerdist_info_segment_hash(), prf_sha1(), tkip_kie_mic(), tls_hmac_final(), and tls_p_hash_va().