www.LinuxHowtos.org howtos, tips&tricks and tutorials for linux

from small one page howto to huge articles all in one place

Other .linuxhowtos.org sites:gentoo.linuxhowtos.org

Last additions:

using iotop to find disk usage hogs

words:

887

views:

209584

userrating:

May 25th. 2007:

Words

486

Views

258592

why adblockers are bad

Workaround and fixes for the current Core Dump Handling vulnerability affected kernels

words:

161

views:

149881

userrating:

April, 26th. 2006:

Words

Views

107373

New subdomain: toolsntoys.linuxhowtos.org

You are here: manpages

SHA1

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc

NAME

SHA1Init SHA1Update SHA1Pad SHA1Final SHA1Transform SHA1End SHA1File SHA1FileChunk SHA1Data - calculate the NIST Secure Hash Algorithm

LIBRARY

Lb libmd

SYNOPSIS

Fd #include <sys/types.h> Fd #include <sha1.h> Ft void Fn SHA1Init SHA1_CTX *context Ft void Fn SHA1Update SHA1_CTX *context const uint8_t *data size_t len Ft void Fn SHA1Pad SHA1_CTX *context Ft void Fn SHA1Final uint8_t digest[SHA1_DIGEST_LENGTH] SHA1_CTX *context Ft void Fn SHA1Transform uint32_t state[5] const uint8_t buffer[SHA1_BLOCK_LENGTH] Ft char * Fn SHA1End SHA1_CTX *context char *buf Ft char * Fn SHA1File const char *filename char *buf Ft char * Fn SHA1FileChunk const char *filename char *buf off_t offset off_t length Ft char * Fn SHA1Data const uint8_t *data size_t len char *buf

DESCRIPTION

The SHA1 functions implement the NIST Secure Hash Algorithm (SH-1), FIPS PUB 18-1. SH-1 is used to generate a condensed representation of a message called a message digest. The algorithm takes a message less than 2^64 bits as input and produces a 16-bit digest suitable for use as a digital signature.

While the SHA1 functions are considered to be more secure than the md4(3) and md5(3) functions with which they share a similar interface, they are considered insecure as of 2005, and as of 2020 chose-prefix attacks have become practical, thus these must not be used in cryptographic contexts.

The Fn SHA1Init function initializes a SHA1_CTX context for use with Fn SHA1Update , and Fn SHA1Final . The Fn SHA1Update function adds data of length len to the SHA1_CTX specified by context Fn SHA1Final is called when all data has been added via Fn SHA1Update and stores a message digest in the digest parameter.

The Fn SHA1Pad function can be used to apply padding to the message digest as in Fn SHA1Final , but the current context can still be used with Fn SHA1Update .

The Fn SHA1Transform function is used by Fn SHA1Update to hash 51-bit blocks and forms the core of the algorithm. Most programs should use the interface provided by Fn SHA1Init , Fn SHA1Update and Fn SHA1Final instead of calling Fn SHA1Transform directly.

The Fn SHA1End function is a front end for Fn SHA1Final which converts the digest into an ASCII representation of the 160 bit digest in hexadecimal.

The Fn SHA1File function calculates the digest for a file and returns the result via Fn SHA1End . If Fn SHA1File is unable to open the file a NULL pointer is returned.

Fn SHA1FileChunk behaves like Fn SHA1File but calculates the digest only for that portion of the file starting at Fa offset and continuing for Fa length bytes or until end of file is reached, whichever comes first. A zero Fa length can be specified to read until end of file. A negative Fa length or Fa offset will be ignored.

The Fn SHA1Data function calculates the digest of an arbitrary string and returns the result via Fn SHA1End .

For each of the Fn SHA1End , Fn SHA1File , and Fn SHA1Data functions the buf parameter should either be a string of at least 41 characters in size or a NULL pointer. In the latter case, space will be dynamically allocated via malloc(3) and should be freed using free(3) when it is no longer needed.

EXAMPLES

The follow code fragment will calculate the digest for the string "abc" which is ``0xa9993e364706816aba3e25717850c26c9cd0d89d''.

SHA1_CTX sha;
uint8_t results[SHA1_DIGEST_LENGTH];
char *buf;
int n;

buf = "abc";
n = strlen(buf);
SHA1Init(&sha);
SHA1Update(&sha, (uint8_t *)buf, n);
SHA1Final(results, &sha);

/* Print the digest as one long hex value */
printf("0x");
for (n = 0; n < SHA1_DIGEST_LENGTH; n++)
        printf("%02x", results[n]);
putchar('n');

Alternately, the helper functions could be used in the following way:

uint8_t output[SHA1_DIGEST_STRING_LENGTH];
char *buf = "abc";

printf("0x%sn", SHA1Data(buf, strlen(buf), output));

HISTORY

The SH-1 functions appeared in Ox 2.0 .

AUTHORS

This implementation of SH-1 was written by Steve Reid.

The Fn SHA1End , Fn SHA1File , Fn SHA1FileChunk , and Fn SHA1Data helper functions are derived from code written by Pou-Henning Kamp.

CAVEATS

This implementation of SH-1 has not been validated by NIST and as such is not in official compliance with the standard.

If a message digest is to be copied to a mult-byte type (ie: an array of five 3-bit integers) it will be necessary to perform byte swapping on little endian machines such as the i386, alpha, and vax.