sha2.h File Reference

#include <basetsd.h>

Include dependency graph for sha2.h:

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

Go to the source code of this file.

Classes
struct	_SHA256_CTX
struct	_SHA512_CTX

Macros
#define	SHA256_BLOCK_LENGTH   64
#define	SHA256_DIGEST_LENGTH   32
#define	SHA256_DIGEST_STRING_LENGTH   (SHA256_DIGEST_LENGTH * 2 + 1)
#define	SHA384_BLOCK_LENGTH   128
#define	SHA384_DIGEST_LENGTH   48
#define	SHA384_DIGEST_STRING_LENGTH   (SHA384_DIGEST_LENGTH * 2 + 1)
#define	SHA512_BLOCK_LENGTH   128
#define	SHA512_DIGEST_LENGTH   64
#define	SHA512_DIGEST_STRING_LENGTH   (SHA512_DIGEST_LENGTH * 2 + 1)

Typedefs
typedef UINT8	sha2_byte
typedef UINT32	sha2_word32
typedef UINT64	sha2_word64
typedef struct _SHA256_CTX	SHA256_CTX
typedef struct _SHA512_CTX	SHA512_CTX
typedef SHA512_CTX	SHA384_CTX

Functions
void	SHA256_Init (SHA256_CTX *)
void	SHA256_Update (SHA256_CTX *, const sha2_byte *, size_t)
void	SHA256_Final (sha2_byte[SHA256_DIGEST_LENGTH], SHA256_CTX *)
char *	SHA256_End (SHA256_CTX *, char[SHA256_DIGEST_STRING_LENGTH])
char *	SHA256_Data (const sha2_byte *, size_t, char[SHA256_DIGEST_STRING_LENGTH])
void	SHA384_Init (SHA384_CTX *)
void	SHA384_Update (SHA384_CTX *, const sha2_byte *, size_t)
void	SHA384_Final (sha2_byte[SHA384_DIGEST_LENGTH], SHA384_CTX *)
char *	SHA384_End (SHA384_CTX *, char[SHA384_DIGEST_STRING_LENGTH])
char *	SHA384_Data (const sha2_byte *, size_t, char[SHA384_DIGEST_STRING_LENGTH])
void	SHA512_Init (SHA512_CTX *)
void	SHA512_Update (SHA512_CTX *, const sha2_byte *, size_t)
void	SHA512_Final (sha2_byte[SHA512_DIGEST_LENGTH], SHA512_CTX *)
char *	SHA512_End (SHA512_CTX *, char[SHA512_DIGEST_STRING_LENGTH])
char *	SHA512_Data (const sha2_byte *, size_t, char[SHA512_DIGEST_STRING_LENGTH])

Macro Definition Documentation

SHA256_BLOCK_LENGTH

#define SHA256_BLOCK_LENGTH   64

Definition at line 39 of file sha2.h.

SHA256_DIGEST_LENGTH

#define SHA256_DIGEST_LENGTH   32

Definition at line 40 of file sha2.h.

SHA256_DIGEST_STRING_LENGTH

#define SHA256_DIGEST_STRING_LENGTH   (SHA256_DIGEST_LENGTH * 2 + 1)

Definition at line 41 of file sha2.h.

SHA384_BLOCK_LENGTH

#define SHA384_BLOCK_LENGTH   128

Definition at line 42 of file sha2.h.

SHA384_DIGEST_LENGTH

#define SHA384_DIGEST_LENGTH   48

Definition at line 43 of file sha2.h.

SHA384_DIGEST_STRING_LENGTH

#define SHA384_DIGEST_STRING_LENGTH   (SHA384_DIGEST_LENGTH * 2 + 1)

Definition at line 44 of file sha2.h.

SHA512_BLOCK_LENGTH

#define SHA512_BLOCK_LENGTH   128

Definition at line 45 of file sha2.h.

SHA512_DIGEST_LENGTH

#define SHA512_DIGEST_LENGTH   64

Definition at line 46 of file sha2.h.

SHA512_DIGEST_STRING_LENGTH

#define SHA512_DIGEST_STRING_LENGTH   (SHA512_DIGEST_LENGTH * 2 + 1)

Definition at line 47 of file sha2.h.

Typedef Documentation

SHA256_CTX

typedef struct _SHA256_CTX SHA256_CTX

sha2_byte

typedef UINT8 sha2_byte

Definition at line 51 of file sha2.h.

sha2_word32

typedef UINT32 sha2_word32

Definition at line 52 of file sha2.h.

sha2_word64

typedef UINT64 sha2_word64

Definition at line 53 of file sha2.h.

SHA384_CTX

typedef SHA512_CTX SHA384_CTX

Definition at line 66 of file sha2.h.

SHA512_CTX

typedef struct _SHA512_CTX SHA512_CTX

Function Documentation

SHA256_Data()

char * SHA256_Data	(	const sha2_byte *	data,
		size_t	len,
		char	digest[SHA256_DIGEST_STRING_LENGTH]
	)

Definition at line 593 of file sha2.c.

                                                                                               {
    SHA256_CTX  context;
 
    SHA256_Init(&context);
    SHA256_Update(&context, data, len);
    return SHA256_End(&context, digest);
}

SHA256_End()

char * SHA256_End	(	SHA256_CTX *	context,
		char	buffer[SHA256_DIGEST_STRING_LENGTH]
	)

Definition at line 570 of file sha2.c.

                                                                                {
    sha2_byte   digest[SHA256_DIGEST_LENGTH], *d = digest;
    int     i;
 
    /* Sanity check: */
    assert(context != NULL);
 
    if (buffer != NULL) {
        SHA256_Final(digest, context);
 
        for (i = 0; i < SHA256_DIGEST_LENGTH; i++) {
            *buffer++ = sha2_hex_digits[(*d & 0xf0) >> 4];
            *buffer++ = sha2_hex_digits[*d & 0x0f];
            d++;
        }
        *buffer = 0;
    } else {
        MEMSET_BZERO(context, sizeof(*context));
    }
    MEMSET_BZERO(digest, SHA256_DIGEST_LENGTH);
    return buffer;
}

Referenced by SHA256_Data().

SHA256_Final()

void SHA256_Final	(	sha2_byte	digest[SHA256_DIGEST_LENGTH],
		SHA256_CTX *	context
	)

Definition at line 507 of file sha2.c.

                                                                               {
    sha2_word32 *d = (sha2_word32*)digest;
    unsigned int    usedspace;
 
    /* Sanity check: */
    assert(context != NULL);
 
    /* If no digest buffer is passed, we don't bother doing this: */
    if (digest != NULL) {
        usedspace = (context->bitcount >> 3) % SHA256_BLOCK_LENGTH;
#ifndef WORDS_BIGENDIAN
        /* Convert FROM host byte order */
        REVERSE64(context->bitcount,context->bitcount);
#endif
        if (usedspace > 0) {
            /* Begin padding with a 1 bit: */
            context->buffer[usedspace++] = 0x80;
 
            if (usedspace <= SHA256_SHORT_BLOCK_LENGTH) {
                /* Set-up for the last transform: */
                MEMSET_BZERO(&context->buffer[usedspace], SHA256_SHORT_BLOCK_LENGTH - usedspace);
            } else {
                if (usedspace < SHA256_BLOCK_LENGTH) {
                    MEMSET_BZERO(&context->buffer[usedspace], SHA256_BLOCK_LENGTH - usedspace);
                }
                /* Do second-to-last transform: */
                SHA256_Transform(context, (sha2_word32*)context->buffer);
 
                /* And set-up for the last transform: */
                MEMSET_BZERO(context->buffer, SHA256_SHORT_BLOCK_LENGTH);
            }
        } else {
            /* Set-up for the last transform: */
            MEMSET_BZERO(context->buffer, SHA256_SHORT_BLOCK_LENGTH);
 
            /* Begin padding with a 1 bit: */
            *context->buffer = 0x80;
        }
        /* Set the bit count: */
        *(sha2_word64*)&context->buffer[SHA256_SHORT_BLOCK_LENGTH] = context->bitcount;
 
        /* Final transform: */
        SHA256_Transform(context, (sha2_word32*)context->buffer);
 
#ifndef WORDS_BIGENDIAN
        {
            /* Convert TO host byte order */
            int j;
            for (j = 0; j < 8; j++) {
                REVERSE32(context->state[j],context->state[j]);
                *d++ = context->state[j];
            }
        }
#else
        MEMCPY_BCOPY(d, context->state, SHA256_DIGEST_LENGTH);
#endif
    }
 
    /* Clean up state data: */
    MEMSET_BZERO(context, sizeof(*context));
    usedspace = 0;
}

Referenced by finalize_hash_impl(), and SHA256_End().

SHA256_Init()

void SHA256_Init

(

SHA256_CTX *

context

)

Definition at line 275 of file sha2.c.

                                      {
    if (context == NULL) {
        return;
    }
    MEMCPY_BCOPY(context->state, sha256_initial_hash_value, SHA256_DIGEST_LENGTH);
    MEMSET_BZERO(context->buffer, SHA256_BLOCK_LENGTH);
    context->bitcount = 0;
}

Referenced by init_hash_impl(), and SHA256_Data().

SHA256_Update()

void SHA256_Update	(	SHA256_CTX *	context,
		const sha2_byte *	data,
		size_t	len
	)

Definition at line 459 of file sha2.c.

                                                                           {
    unsigned int    freespace, usedspace;
 
    if (len == 0) {
        /* Calling with no data is valid - we do nothing */
        return;
    }
 
    /* Sanity check: */
    assert(context != NULL && data != NULL);
 
    usedspace = (context->bitcount >> 3) % SHA256_BLOCK_LENGTH;
    if (usedspace > 0) {
        /* Calculate how much free space is available in the buffer */
        freespace = SHA256_BLOCK_LENGTH - usedspace;
 
        if (len >= freespace) {
            /* Fill the buffer completely and process it */
            MEMCPY_BCOPY(&context->buffer[usedspace], data, freespace);
            context->bitcount += freespace << 3;
            len -= freespace;
            data += freespace;
            SHA256_Transform(context, (sha2_word32*)context->buffer);
        } else {
            /* The buffer is not yet full */
            MEMCPY_BCOPY(&context->buffer[usedspace], data, len);
            context->bitcount += len << 3;
            /* Clean up: */
            usedspace = freespace = 0;
            return;
        }
    }
    while (len >= SHA256_BLOCK_LENGTH) {
        /* Process as many complete blocks as we can */
        SHA256_Transform(context, (const sha2_word32*)data);
        context->bitcount += SHA256_BLOCK_LENGTH << 3;
        len -= SHA256_BLOCK_LENGTH;
        data += SHA256_BLOCK_LENGTH;
    }
    if (len > 0) {
        /* There's left-overs, so save 'em */
        MEMCPY_BCOPY(context->buffer, data, len);
        context->bitcount += len << 3;
    }
    /* Clean up: */
    usedspace = freespace = 0;
}

Referenced by SHA256_Data(), and update_hash_impl().

SHA384_Data()

char * SHA384_Data	(	const sha2_byte *	data,
		size_t	len,
		char	digest[SHA384_DIGEST_STRING_LENGTH]
	)

Definition at line 997 of file sha2.c.

                                                                                               {
    SHA384_CTX  context;
 
    SHA384_Init(&context);
    SHA384_Update(&context, data, len);
    return SHA384_End(&context, digest);
}

SHA384_End()

char * SHA384_End	(	SHA384_CTX *	context,
		char	buffer[SHA384_DIGEST_STRING_LENGTH]
	)

Definition at line 974 of file sha2.c.

                                                                                {
    sha2_byte   digest[SHA384_DIGEST_LENGTH], *d = digest;
    int     i;
 
    /* Sanity check: */
    assert(context != NULL);
 
    if (buffer != NULL) {
        SHA384_Final(digest, context);
 
        for (i = 0; i < SHA384_DIGEST_LENGTH; i++) {
            *buffer++ = sha2_hex_digits[(*d & 0xf0) >> 4];
            *buffer++ = sha2_hex_digits[*d & 0x0f];
            d++;
        }
        *buffer = 0;
    } else {
        MEMSET_BZERO(context, sizeof(*context));
    }
    MEMSET_BZERO(digest, SHA384_DIGEST_LENGTH);
    return buffer;
}

Referenced by SHA384_Data().

SHA384_Final()

void SHA384_Final	(	sha2_byte	digest[SHA384_DIGEST_LENGTH],
		SHA384_CTX *	context
	)

Definition at line 945 of file sha2.c.

                                                                               {
    sha2_word64 *d = (sha2_word64*)digest;
 
    /* Sanity check: */
    assert(context != NULL);
 
    /* If no digest buffer is passed, we don't bother doing this: */
    if (digest != NULL) {
        SHA512_Last((SHA512_CTX*)context);
 
        /* Save the hash data for output: */
#ifndef WORDS_BIGENDIAN
        {
            /* Convert TO host byte order */
            int j;
            for (j = 0; j < 6; j++) {
                REVERSE64(context->state[j],context->state[j]);
                *d++ = context->state[j];
            }
        }
#else
        MEMCPY_BCOPY(d, context->state, SHA384_DIGEST_LENGTH);
#endif
    }
 
    /* Zero out state data */
    MEMSET_BZERO(context, sizeof(*context));
}

Referenced by finalize_hash_impl(), and SHA384_End().

SHA384_Init()

void SHA384_Init

(

SHA384_CTX *

context

)

Definition at line 932 of file sha2.c.

                                      {
    if (context == NULL) {
        return;
    }
    MEMCPY_BCOPY(context->state, sha384_initial_hash_value, SHA512_DIGEST_LENGTH);
    MEMSET_BZERO(context->buffer, SHA384_BLOCK_LENGTH);
    context->bitcount[0] = context->bitcount[1] = 0;
}

Referenced by init_hash_impl(), and SHA384_Data().

SHA384_Update()

void SHA384_Update	(	SHA384_CTX *	context,
		const sha2_byte *	data,
		size_t	len
	)

Definition at line 941 of file sha2.c.

                                                                           {
    SHA512_Update((SHA512_CTX*)context, data, len);
}

Referenced by SHA384_Data(), and update_hash_impl().

SHA512_Data()

char * SHA512_Data	(	const sha2_byte *	data,
		size_t	len,
		char	digest[SHA512_DIGEST_STRING_LENGTH]
	)

Definition at line 922 of file sha2.c.

                                                                                               {
    SHA512_CTX  context;
 
    SHA512_Init(&context);
    SHA512_Update(&context, data, len);
    return SHA512_End(&context, digest);
}

SHA512_End()

char * SHA512_End	(	SHA512_CTX *	context,
		char	buffer[SHA512_DIGEST_STRING_LENGTH]
	)

Definition at line 899 of file sha2.c.

                                                                                {
    sha2_byte   digest[SHA512_DIGEST_LENGTH], *d = digest;
    int     i;
 
    /* Sanity check: */
    assert(context != NULL);
 
    if (buffer != NULL) {
        SHA512_Final(digest, context);
 
        for (i = 0; i < SHA512_DIGEST_LENGTH; i++) {
            *buffer++ = sha2_hex_digits[(*d & 0xf0) >> 4];
            *buffer++ = sha2_hex_digits[*d & 0x0f];
            d++;
        }
        *buffer = 0;
    } else {
        MEMSET_BZERO(context, sizeof(*context));
    }
    MEMSET_BZERO(digest, SHA512_DIGEST_LENGTH);
    return buffer;
}

Referenced by SHA512_Data().

SHA512_Final()

void SHA512_Final	(	sha2_byte	digest[SHA512_DIGEST_LENGTH],
		SHA512_CTX *	context
	)

Definition at line 870 of file sha2.c.

                                                                               {
    sha2_word64 *d = (sha2_word64*)digest;
 
    /* Sanity check: */
    assert(context != NULL);
 
    /* If no digest buffer is passed, we don't bother doing this: */
    if (digest != NULL) {
        SHA512_Last(context);
 
        /* Save the hash data for output: */
#ifndef WORDS_BIGENDIAN
        {
            /* Convert TO host byte order */
            int j;
            for (j = 0; j < 8; j++) {
                REVERSE64(context->state[j],context->state[j]);
                *d++ = context->state[j];
            }
        }
#else
        MEMCPY_BCOPY(d, context->state, SHA512_DIGEST_LENGTH);
#endif
    }
 
    /* Zero out state data */
    MEMSET_BZERO(context, sizeof(*context));
}

Referenced by finalize_hash_impl(), and SHA512_End().

SHA512_Init()

void SHA512_Init

(

SHA512_CTX *

context

)

Definition at line 603 of file sha2.c.

                                      {
    if (context == NULL) {
        return;
    }
    MEMCPY_BCOPY(context->state, sha512_initial_hash_value, SHA512_DIGEST_LENGTH);
    MEMSET_BZERO(context->buffer, SHA512_BLOCK_LENGTH);
    context->bitcount[0] = context->bitcount[1] =  0;
}

Referenced by init_hash_impl(), and SHA512_Data().

SHA512_Update()

void SHA512_Update	(	SHA512_CTX *	context,
		const sha2_byte *	data,
		size_t	len
	)

Definition at line 781 of file sha2.c.

                                                                           {
    unsigned int    freespace, usedspace;
 
    if (len == 0) {
        /* Calling with no data is valid - we do nothing */
        return;
    }
 
    /* Sanity check: */
    assert(context != NULL && data != NULL);
 
    usedspace = (context->bitcount[0] >> 3) % SHA512_BLOCK_LENGTH;
    if (usedspace > 0) {
        /* Calculate how much free space is available in the buffer */
        freespace = SHA512_BLOCK_LENGTH - usedspace;
 
        if (len >= freespace) {
            /* Fill the buffer completely and process it */
            MEMCPY_BCOPY(&context->buffer[usedspace], data, freespace);
            ADDINC128(context->bitcount, freespace << 3);
            len -= freespace;
            data += freespace;
            SHA512_Transform(context, (sha2_word64*)context->buffer);
        } else {
            /* The buffer is not yet full */
            MEMCPY_BCOPY(&context->buffer[usedspace], data, len);
            ADDINC128(context->bitcount, len << 3);
            /* Clean up: */
            usedspace = freespace = 0;
            return;
        }
    }
    while (len >= SHA512_BLOCK_LENGTH) {
        /* Process as many complete blocks as we can */
        SHA512_Transform(context, (const sha2_word64*)data);
        ADDINC128(context->bitcount, SHA512_BLOCK_LENGTH << 3);
        len -= SHA512_BLOCK_LENGTH;
        data += SHA512_BLOCK_LENGTH;
    }
    if (len > 0) {
        /* There's left-overs, so save 'em */
        MEMCPY_BCOPY(context->buffer, data, len);
        ADDINC128(context->bitcount, len << 3);
    }
    /* Clean up: */
    usedspace = freespace = 0;
}

Referenced by SHA384_Update(), SHA512_Data(), and update_hash_impl().