sha1.h File Reference

SHA-1 algorithm. More...

#include <stdint.h>
#include <ipxe/crypto.h>

Go to the source code of this file.

Data Structures
struct	sha1_digest
	An SHA-1 digest. More...
union	sha1_block
	An SHA-1 data block. More...
struct	sha1_digest_data
	SHA-1 digest and data block. More...
union	sha1_digest_data_dwords
	SHA-1 digest and data block. More...
struct	sha1_context
	An SHA-1 context. More...

Macros
#define	SHA1_CTX_SIZE   sizeof ( struct sha1_context )
	SHA-1 context size. More...
#define	SHA1_BLOCK_SIZE   sizeof ( union sha1_block )
	SHA-1 block size. More...
#define	SHA1_DIGEST_SIZE   sizeof ( struct sha1_digest )
	SHA-1 digest size. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER)
struct sha1_digest_data	__attribute__ ((packed))
void	prf_sha1 (const void *key, size_t key_len, const char *label, const void *data, size_t data_len, void *prf, size_t prf_len)
	SHA1 pseudorandom function for creating derived keys. More...
void	pbkdf2_sha1 (const void *passphrase, size_t pass_len, const void *salt, size_t salt_len, int iterations, void *key, size_t key_len)
	PBKDF2 key derivation function using SHA1. More...

Variables
struct sha1_digest	digest
	Digest of data already processed. More...
union sha1_block	data
	Accumulated data. More...
union sha1_digest_data_dwords	__attribute__
size_t	len
	Amount of accumulated data. More...
union sha1_digest_data_dwords	ddd
	Digest and accumulated data. More...
struct digest_algorithm	sha1_algorithm
	SHA-1 algorithm. More...

Detailed Description

SHA-1 algorithm.

Definition in file sha1.h.

Macro Definition Documentation

SHA1_CTX_SIZE

#define SHA1_CTX_SIZE   sizeof ( struct sha1_context )

SHA-1 context size.

Definition at line 66 of file sha1.h.

SHA1_BLOCK_SIZE

#define SHA1_BLOCK_SIZE   sizeof ( union sha1_block )

SHA-1 block size.

Definition at line 69 of file sha1.h.

SHA1_DIGEST_SIZE

#define SHA1_DIGEST_SIZE   sizeof ( struct sha1_digest )

SHA-1 digest size.

Definition at line 72 of file sha1.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER

)

__attribute__()

struct sha1_digest_data __attribute__

(

(packed)

)

prf_sha1()

void prf_sha1	(	const void *	key,
		size_t	key_len,
		const char *	label,
		const void *	data,
		size_t	data_len,
		void *	prf,
		size_t	prf_len
	)

SHA1 pseudorandom function for creating derived keys.

Parameters

key	Master key with which this call is associated
key_len	Length of key
label	NUL-terminated ASCII string describing purpose of PRF data
data	Further data that should be included in the PRF
data_len	Length of further PRF data
prf_len	Bytes of PRF to generate

Return values

prf	Pseudorandom function bytes

This is the PRF variant used by 802.11, defined in IEEE 802.11-2007 8.5.5.1. EAP-FAST uses a different SHA1-based PRF, and TLS uses an MD5-based PRF.

Definition at line 44 of file sha1extra.c.

{
        u32 blk;
        u8 keym[key_len];       /* modifiable copy of key */
        u8 in[strlen ( label ) + 1 + data_len + 1]; /* message to HMAC */
        u8 *in_blknr;           /* pointer to last byte of in, block number */
        u8 out[SHA1_DIGEST_SIZE]; /* HMAC-SHA1 result */
        u8 ctx[SHA1_CTX_SIZE + SHA1_BLOCK_SIZE]; /* HMAC-SHA1 context */
        const size_t label_len = strlen ( label );

        /* The HMAC-SHA-1 is calculated using the given key on the
           message text `label', followed by a NUL, followed by one
           byte indicating the block number (0 for first). */

        memcpy ( keym, key, key_len );

        memcpy ( in, label, strlen ( label ) + 1 );
        memcpy ( in + label_len + 1, data, data_len );
        in_blknr = in + label_len + 1 + data_len;

        for ( blk = 0 ;; blk++ ) {
                *in_blknr = blk;

                hmac_init ( &sha1_algorithm, ctx, keym, key_len );
                hmac_update ( &sha1_algorithm, ctx, in, sizeof ( in ) );
                hmac_final ( &sha1_algorithm, ctx, out );

                if ( prf_len <= sizeof ( out ) ) {
                        memcpy ( prf, out, prf_len );
                        break;
                }

                memcpy ( prf, out, sizeof ( out ) );
                prf_len -= sizeof ( out );
                prf += sizeof ( out );
        }
}

References ctx, data, hmac_final(), hmac_init(), hmac_update(), in, key, memcpy(), out, sha1_algorithm, SHA1_BLOCK_SIZE, SHA1_CTX_SIZE, SHA1_DIGEST_SIZE, and strlen().

Referenced by wpa_derive_ptk().

pbkdf2_sha1()

void pbkdf2_sha1	(	const void *	passphrase,
		size_t	pass_len,
		const void *	salt,
		size_t	salt_len,
		int	iterations,
		void *	key,
		size_t	key_len
	)

PBKDF2 key derivation function using SHA1.

Parameters

passphrase	Passphrase from which to derive key
pass_len	Length of passphrase
salt	Salt to include in key
salt_len	Length of salt
iterations	Number of iterations of SHA1 to perform
key_len	Length of key to generate

Return values

key	Generated key bytes

This is used most notably in 802.11 WPA passphrase hashing, in which case the salt is the SSID, 4096 iterations are used, and a 32-byte key is generated that serves as the Pairwise Master Key for EAPOL authentication.

The operation of this function is further described in RFC 2898.

Definition at line 148 of file sha1extra.c.

{
        u32 blocks = ( key_len + SHA1_DIGEST_SIZE - 1 ) / SHA1_DIGEST_SIZE;
        u32 blk;
        u8 buf[SHA1_DIGEST_SIZE];

        for ( blk = 1; blk <= blocks; blk++ ) {
                pbkdf2_sha1_f ( passphrase, pass_len, salt, salt_len,
                                iterations, blk, buf );
                if ( key_len <= sizeof ( buf ) ) {
                        memcpy ( key, buf, key_len );
                        break;
                }

                memcpy ( key, buf, sizeof ( buf ) );
                key_len -= sizeof ( buf );
                key += sizeof ( buf );
        }
}

References blocks, key, memcpy(), pbkdf2_sha1_f(), and SHA1_DIGEST_SIZE.

Referenced by wpa_psk_start().

Variable Documentation

digest

struct sha1_digest digest

Digest of data already processed.

Definition at line 12 of file sha1.h.

data

union sha1_block data

Accumulated data.

Definition at line 14 of file sha1.h.

__attribute__

union sha1_digest_data_dwords __attribute__

len

size_t len

Amount of accumulated data.

Definition at line 12 of file sha1.h.

ddd

union sha1_digest_data_dwords ddd

Digest and accumulated data.

Definition at line 14 of file sha1.h.

sha1_algorithm

struct digest_algorithm sha1_algorithm

SHA-1 algorithm.

Definition at line 257 of file sha1.c.

Referenced by ccmp_kie_mic(), certstat(), md5_sha1_final(), md5_sha1_init(), md5_sha1_update(), ocsp_compare_responder_key_hash(), pbkdf2_sha1_f(), prf_sha1(), sha1_test_exec(), sha1sum_exec(), tls_prf(), and x509_name().