sha1.h File Reference

#include <stdint.h>

Include dependency graph for sha1.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	HKDFContext
struct	HMACContext
struct	SHA1Context
struct	SHA256Context
struct	SHA512Context
struct	USHAContext

Macros
#define	_SHA_enum_
#define	SHA_Ch(x, y, z)   (((x) & (y)) ^ ((~(x)) & (z)))
#define	SHA_Maj(x, y, z)   (((x) & (y)) ^ ((x) & (z)) ^ ((y) & (z)))
#define	SHA_Parity(x, y, z)   ((x) ^ (y) ^ (z))

Typedefs
typedef struct HKDFContext	HKDFContext
typedef struct HMACContext	HMACContext
typedef struct SHA1Context	SHA1Context
typedef struct SHA256Context	SHA224Context
typedef struct SHA256Context	SHA256Context
typedef struct SHA512Context	SHA384Context
typedef struct SHA512Context	SHA512Context
typedef enum SHAversion	SHAversion
typedef struct USHAContext	USHAContext

Enumerations
enum	{   shaSuccess = 0, shaNull, shaInputTooLong, shaStateError,   shaBadParam }
enum	{   SHA1_Message_Block_Size = 64, SHA224_Message_Block_Size = 64, SHA256_Message_Block_Size = 64, SHA384_Message_Block_Size = 128,   SHA512_Message_Block_Size = 128, USHA_Max_Message_Block_Size = SHA512_Message_Block_Size, SHA1HashSize = 20, SHA224HashSize = 28,   SHA256HashSize = 32, SHA384HashSize = 48, SHA512HashSize = 64, USHAMaxHashSize = SHA512HashSize,   SHA1HashSizeBits = 160, SHA224HashSizeBits = 224, SHA256HashSizeBits = 256, SHA384HashSizeBits = 384,   SHA512HashSizeBits = 512, USHAMaxHashSizeBits = SHA512HashSizeBits }
enum	SHAversion {   SHA1, SHA224, SHA256, SHA384,   SHA512 }

Functions
int	hkdf (SHAversion whichSha, const unsigned char *salt, int salt_len, const unsigned char *ikm, int ikm_len, const unsigned char *info, int info_len, uint8_t okm[], int okm_len)
int	hkdfExpand (SHAversion whichSha, const uint8_t prk[], int prk_len, const unsigned char *info, int info_len, uint8_t okm[], int okm_len)
int	hkdfExtract (SHAversion whichSha, const unsigned char *salt, int salt_len, const unsigned char *ikm, int ikm_len, uint8_t prk[USHAMaxHashSize])
int	hkdfFinalBits (HKDFContext *context, uint8_t ikm_bits, unsigned int ikm_bit_count)
int	hkdfInput (HKDFContext *context, const unsigned char *ikm, int ikm_len)
int	hkdfReset (HKDFContext *context, enum SHAversion whichSha, const unsigned char *salt, int salt_len)
int	hkdfResult (HKDFContext *context, uint8_t prk[USHAMaxHashSize], const unsigned char *info, int info_len, uint8_t okm[USHAMaxHashSize], int okm_len)
int	hmac (SHAversion whichSha, const unsigned char *text, int text_len, const unsigned char *key, int key_len, uint8_t digest[USHAMaxHashSize])
int	hmacFinalBits (HMACContext *context, uint8_t bits, unsigned int bit_count)
int	hmacInput (HMACContext *context, const unsigned char *text, int text_len)
int	hmacReset (HMACContext *context, enum SHAversion whichSha, const unsigned char *key, int key_len)
int	hmacResult (HMACContext *context, uint8_t digest[USHAMaxHashSize])
int	SHA1FinalBits (SHA1Context *, uint8_t bits, unsigned int bit_count)
	SHA1FinalBits Add in any final bits of the message. More...
int	SHA1Input (SHA1Context *, const uint8_t *bytes, unsigned int bytecount)
int	SHA1Reset (SHA1Context *)
	SHA1Reset. More...
int	SHA1Result (SHA1Context *, uint8_t Message_Digest[SHA1HashSize])
int	SHA224FinalBits (SHA224Context *, uint8_t bits, unsigned int bit_count)
int	SHA224Input (SHA224Context *, const uint8_t *bytes, unsigned int bytecount)
int	SHA224Reset (SHA224Context *)
int	SHA224Result (SHA224Context *, uint8_t Message_Digest[SHA224HashSize])
int	SHA256FinalBits (SHA256Context *, uint8_t bits, unsigned int bit_count)
int	SHA256Input (SHA256Context *, const uint8_t *bytes, unsigned int bytecount)
int	SHA256Reset (SHA256Context *)
int	SHA256Result (SHA256Context *, uint8_t Message_Digest[SHA256HashSize])
int	SHA384FinalBits (SHA384Context *, uint8_t bits, unsigned int bit_count)
int	SHA384Input (SHA384Context *, const uint8_t *bytes, unsigned int bytecount)
int	SHA384Reset (SHA384Context *)
int	SHA384Result (SHA384Context *, uint8_t Message_Digest[SHA384HashSize])
int	SHA512FinalBits (SHA512Context *, uint8_t bits, unsigned int bit_count)
int	SHA512Input (SHA512Context *, const uint8_t *bytes, unsigned int bytecount)
int	SHA512Reset (SHA512Context *)
int	SHA512Result (SHA512Context *, uint8_t Message_Digest[SHA512HashSize])
int	USHABlockSize (enum SHAversion whichSha)
int	USHAFinalBits (USHAContext *context, uint8_t bits, unsigned int bit_count)
const char *	USHAHashName (enum SHAversion whichSha)
int	USHAHashSize (enum SHAversion whichSha)
int	USHAHashSizeBits (enum SHAversion whichSha)
int	USHAInput (USHAContext *context, const uint8_t *bytes, unsigned int bytecount)
int	USHAReset (USHAContext *context, SHAversion whichSha)
int	USHAResult (USHAContext *context, uint8_t Message_Digest[USHAMaxHashSize])

Macro Definition Documentation

_SHA_enum_

#define _SHA_enum_

Definition at line 87 of file sha1.h.

SHA_Ch

#define SHA_Ch	(		x,
			y,
			z
	)		(((x) & (y)) ^ ((~(x)) & (z)))

Definition at line 365 of file sha1.h.

Referenced by SHA1ProcessMessageBlock().

SHA_Maj

#define SHA_Maj	(		x,
			y,
			z
	)		(((x) & (y)) ^ ((x) & (z)) ^ ((y) & (z)))

Definition at line 366 of file sha1.h.

Referenced by SHA1ProcessMessageBlock().

SHA_Parity

#define SHA_Parity	(		x,
			y,
			z
	)		((x) ^ (y) ^ (z))

Definition at line 377 of file sha1.h.

Referenced by SHA1ProcessMessageBlock().

Typedef Documentation

HKDFContext

typedef struct HKDFContext HKDFContext

HMACContext

typedef struct HMACContext HMACContext

SHA1Context

typedef struct SHA1Context SHA1Context

SHA224Context

typedef struct SHA256Context SHA224Context

Definition at line 185 of file sha1.h.

SHA256Context

typedef struct SHA256Context SHA256Context

SHA384Context

typedef struct SHA512Context SHA384Context

Definition at line 191 of file sha1.h.

SHA512Context

typedef struct SHA512Context SHA512Context

SHAversion

typedef enum SHAversion SHAversion

USHAContext

typedef struct USHAContext USHAContext

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
shaSuccess
shaNull
shaInputTooLong
shaStateError
shaBadParam

Definition at line 91 of file sha1.h.

     {
    shaSuccess = 0,
    shaNull,            /* Null pointer parameter */
    shaInputTooLong,    /* input data too long */
    shaStateError,      /* called Input after FinalBits or Result */
    shaBadParam         /* passed a bad parameter */
};

anonymous enum

anonymous enum

Enumerator
SHA1_Message_Block_Size
SHA224_Message_Block_Size
SHA256_Message_Block_Size
SHA384_Message_Block_Size
SHA512_Message_Block_Size
USHA_Max_Message_Block_Size
SHA1HashSize
SHA224HashSize
SHA256HashSize
SHA384HashSize
SHA512HashSize
USHAMaxHashSize
SHA1HashSizeBits
SHA224HashSizeBits
SHA256HashSizeBits
SHA384HashSizeBits
SHA512HashSizeBits
USHAMaxHashSizeBits

Definition at line 104 of file sha1.h.

     {
   SHA1_Message_Block_Size = 64, SHA224_Message_Block_Size = 64,
   SHA256_Message_Block_Size = 64, SHA384_Message_Block_Size = 128,
   SHA512_Message_Block_Size = 128,
   USHA_Max_Message_Block_Size = SHA512_Message_Block_Size,
   SHA1HashSize = 20, SHA224HashSize = 28, SHA256HashSize = 32,
   SHA384HashSize = 48, SHA512HashSize = 64,
   USHAMaxHashSize = SHA512HashSize,

   SHA1HashSizeBits = 160, SHA224HashSizeBits = 224,
   SHA256HashSizeBits = 256, SHA384HashSizeBits = 384,
   SHA512HashSizeBits = 512, USHAMaxHashSizeBits = SHA512HashSizeBits
};

SHAversion

enum SHAversion

Enumerator
SHA1
SHA224
SHA256
SHA384
SHA512

Definition at line 121 of file sha1.h.

                        {
   SHA1, SHA224, SHA256, SHA384, SHA512
} SHAversion;

Function Documentation

hkdf()

int hkdf	(	SHAversion	whichSha,
		const unsigned char *	salt,
		int	salt_len,
		const unsigned char *	ikm,
		int	ikm_len,
		const unsigned char *	info,
		int	info_len,
		uint8_t	okm[],
		int	okm_len
	)

hkdfExpand()

int hkdfExpand	(	SHAversion	whichSha,
		const uint8_t	prk[],
		int	prk_len,
		const unsigned char *	info,
		int	info_len,
		uint8_t	okm[],
		int	okm_len
	)

hkdfExtract()

int hkdfExtract	(	SHAversion	whichSha,
		const unsigned char *	salt,
		int	salt_len,
		const unsigned char *	ikm,
		int	ikm_len,
		uint8_t	prk[USHAMaxHashSize]
	)

hkdfFinalBits()

int hkdfFinalBits	(	HKDFContext *	context,
		uint8_t	ikm_bits,
		unsigned int	ikm_bit_count
	)

hkdfInput()

int hkdfInput	(	HKDFContext *	context,
		const unsigned char *	ikm,
		int	ikm_len
	)

hkdfReset()

int hkdfReset	(	HKDFContext *	context,
		enum SHAversion	whichSha,
		const unsigned char *	salt,
		int	salt_len
	)

hkdfResult()

int hkdfResult	(	HKDFContext *	context,
		uint8_t	prk[USHAMaxHashSize],
		const unsigned char *	info,
		int	info_len,
		uint8_t	okm[USHAMaxHashSize],
		int	okm_len
	)

hmac()

int hmac	(	SHAversion	whichSha,
		const unsigned char *	text,
		int	text_len,
		const unsigned char *	key,
		int	key_len,
		uint8_t	digest[USHAMaxHashSize]
	)

hmacFinalBits()

int hmacFinalBits	(	HMACContext *	context,
		uint8_t	bits,
		unsigned int	bit_count
	)

hmacInput()

int hmacInput	(	HMACContext *	context,
		const unsigned char *	text,
		int	text_len
	)

hmacReset()

int hmacReset	(	HMACContext *	context,
		enum SHAversion	whichSha,
		const unsigned char *	key,
		int	key_len
	)

hmacResult()

int hmacResult	(	HMACContext *	context,
		uint8_t	digest[USHAMaxHashSize]
	)

SHA1FinalBits()

int SHA1FinalBits	(	SHA1Context *	context,
		uint8_t	message_bits,
		unsigned int	length
	)

SHA1FinalBits Add in any final bits of the message.

Parameters

context	[in/out] The SHA context to update.
message_bits	[in] The final bits of the message, in the upper portion of the byte. (Use 0b###00000 instead of 0b00000### to input the three bits ###.)
length	[in] * The number of bits in message_bits, between 1 and 7.

Returns

sha Error Code.

Definition at line 179 of file sha1.c.

References SHA1Context::Computed, SHA1Context::Corrupted, SHA1AddLength, SHA1Finalize(), shaBadParam, shaNull, shaStateError, and shaSuccess.

{
   static uint8_t masks[8] = {
      /* 0 0b00000000 */ 0x00, /* 1 0b10000000 */ 0x80,
      /* 2 0b11000000 */ 0xC0, /* 3 0b11100000 */ 0xE0,
      /* 4 0b11110000 */ 0xF0, /* 5 0b11111000 */ 0xF8,
      /* 6 0b11111100 */ 0xFC, /* 7 0b11111110 */ 0xFE
   };

   static uint8_t markbit[8] = {
      /* 0 0b10000000 */ 0x80, /* 1 0b01000000 */ 0x40,
      /* 2 0b00100000 */ 0x20, /* 3 0b00010000 */ 0x10,
      /* 4 0b00001000 */ 0x08, /* 5 0b00000100 */ 0x04,
      /* 6 0b00000010 */ 0x02, /* 7 0b00000001 */ 0x01
   };

   if (!context)
      return shaNull;
   if (!length)
      return shaSuccess;
   if (context->Corrupted)
      return context->Corrupted;
   if (context->Computed)
      return context->Corrupted = shaStateError;
   if (length >= 8)
      return context->Corrupted = shaBadParam;

   SHA1AddLength(context, length);
   SHA1Finalize(context,
             (uint8_t) ((message_bits & masks[length]) |
                     markbit[length]));

   return context->Corrupted;
}

SHA1Input()

int SHA1Input	(	SHA1Context *	,
		const uint8_t *	bytes,
		unsigned int	bytecount
	)

Referenced by ast_sha1_hash(), and ast_sha1_hash_uint().

SHA1Reset()

int SHA1Reset

(

SHA1Context *

context

)

SHA1Reset.

Parameters

context

the context to be reset. This function will initialize the SHA1Context in preparation for computing a new SHA1 message digest.

Returns

sha Error Code.

Definition at line 101 of file sha1.c.

References SHA1Context::Computed, SHA1Context::Corrupted, SHA1Context::Intermediate_Hash, SHA1Context::Length_High, SHA1Context::Length_Low, SHA1Context::Message_Block_Index, shaNull, and shaSuccess.

Referenced by ast_sha1_hash(), and ast_sha1_hash_uint().

{
   if (!context) {
      return shaNull;
   }

   context->Length_High = context->Length_Low = 0;
   context->Message_Block_Index = 0;

   /* Initial Hash Values: FIPS 180-3 section 5.3.1 */
   context->Intermediate_Hash[0] = 0x67452301;
   context->Intermediate_Hash[1] = 0xEFCDAB89;
   context->Intermediate_Hash[2] = 0x98BADCFE;
   context->Intermediate_Hash[3] = 0x10325476;
   context->Intermediate_Hash[4] = 0xC3D2E1F0;

   context->Computed = 0;
   context->Corrupted = shaSuccess;

   return shaSuccess;
}

SHA1Result()

int SHA1Result	(	SHA1Context *	,
		uint8_t	Message_Digest[SHA1HashSize]
	)

Definition at line 226 of file sha1.c.

References SHA1Context::Computed, SHA1Context::Corrupted, SHA1Context::Intermediate_Hash, SHA1Finalize(), SHA1HashSize, shaNull, and shaSuccess.

Referenced by ast_sha1_hash(), and ast_sha1_hash_uint().

{
   int i;

   if (!context) {
      return shaNull;
   }
   if (!Message_Digest) {
      return shaNull;
   }
   if (context->Corrupted) {
      return context->Corrupted;
   }

   if (!context->Computed) {
      SHA1Finalize(context, 0x80);
   }

   for (i = 0; i < SHA1HashSize; ++i) {
      Message_Digest[i] = (uint8_t) (context->Intermediate_Hash[i >> 2]
            >> (8 * (3 - (i & 0x03))));
   }

   return shaSuccess;
}

SHA224FinalBits()

int SHA224FinalBits	(	SHA224Context *	,
		uint8_t	bits,
		unsigned int	bit_count
	)

SHA224Input()

int SHA224Input	(	SHA224Context *	,
		const uint8_t *	bytes,
		unsigned int	bytecount
	)

SHA224Reset()

int SHA224Reset

(

SHA224Context *

)

SHA224Result()

int SHA224Result	(	SHA224Context *	,
		uint8_t	Message_Digest[SHA224HashSize]
	)

SHA256FinalBits()

int SHA256FinalBits	(	SHA256Context *	,
		uint8_t	bits,
		unsigned int	bit_count
	)

SHA256Input()

int SHA256Input	(	SHA256Context *	,
		const uint8_t *	bytes,
		unsigned int	bytecount
	)

SHA256Reset()

int SHA256Reset

(

SHA256Context *

)

SHA256Result()

int SHA256Result	(	SHA256Context *	,
		uint8_t	Message_Digest[SHA256HashSize]
	)

SHA384FinalBits()

int SHA384FinalBits	(	SHA384Context *	,
		uint8_t	bits,
		unsigned int	bit_count
	)

SHA384Input()

int SHA384Input	(	SHA384Context *	,
		const uint8_t *	bytes,
		unsigned int	bytecount
	)

SHA384Reset()

int SHA384Reset

(

SHA384Context *

)

SHA384Result()

int SHA384Result	(	SHA384Context *	,
		uint8_t	Message_Digest[SHA384HashSize]
	)

SHA512FinalBits()

int SHA512FinalBits	(	SHA512Context *	,
		uint8_t	bits,
		unsigned int	bit_count
	)

SHA512Input()

int SHA512Input	(	SHA512Context *	,
		const uint8_t *	bytes,
		unsigned int	bytecount
	)

SHA512Reset()

int SHA512Reset

(

SHA512Context *

)

SHA512Result()

int SHA512Result	(	SHA512Context *	,
		uint8_t	Message_Digest[SHA512HashSize]
	)

USHABlockSize()

int USHABlockSize

(

enum SHAversion

whichSha

)

USHAFinalBits()

int USHAFinalBits	(	USHAContext *	context,
		uint8_t	bits,
		unsigned int	bit_count
	)

USHAHashName()

const char* USHAHashName

(

enum SHAversion

whichSha

)

USHAHashSize()

int USHAHashSize

(

enum SHAversion

whichSha

)

USHAHashSizeBits()

int USHAHashSizeBits

(

enum SHAversion

whichSha

)

USHAInput()

int USHAInput	(	USHAContext *	context,
		const uint8_t *	bytes,
		unsigned int	bytecount
	)

USHAReset()

int USHAReset	(	USHAContext *	context,
		SHAversion	whichSha
	)

USHAResult()

int USHAResult	(	USHAContext *	context,
		uint8_t	Message_Digest[USHAMaxHashSize]
	)