OpenGrok

$NetBSD: openssl_sha.3,v 1.1.1.1 2018/02/03 22:43:39 christos Exp $

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\}
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "sha 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
.nh SHA1, SHA1_Init, SHA1_Update, SHA1_Final, SHA224, SHA224_Init, SHA224_Update, SHA224_Final, SHA256, SHA256_Init, SHA256_Update, SHA256_Final, SHA384, SHA384_Init, SHA384_Update, SHA384_Final, SHA512, SHA512_Init, SHA512_Update, SHA512_Final - Secure Hash Algorithm libcrypto, -lcrypto Header "SYNOPSIS" .Vb 1 #include <openssl/sha.h> \& int SHA1_Init(SHA_CTX *c); int SHA1_Update(SHA_CTX *c, const void *data, size_t len); int SHA1_Final(unsigned char *md, SHA_CTX *c); unsigned char *SHA1(const unsigned char *d, size_t n, unsigned char *md); \& int SHA224_Init(SHA256_CTX *c); int SHA224_Update(SHA256_CTX *c, const void *data, size_t len); int SHA224_Final(unsigned char *md, SHA256_CTX *c); unsigned char *SHA224(const unsigned char *d, size_t n, unsigned char *md); \& int SHA256_Init(SHA256_CTX *c); int SHA256_Update(SHA256_CTX *c, const void *data, size_t len); int SHA256_Final(unsigned char *md, SHA256_CTX *c); unsigned char *SHA256(const unsigned char *d, size_t n, unsigned char *md); \& int SHA384_Init(SHA512_CTX *c); int SHA384_Update(SHA512_CTX *c, const void *data, size_t len); int SHA384_Final(unsigned char *md, SHA512_CTX *c); unsigned char *SHA384(const unsigned char *d, size_t n, unsigned char *md); \& int SHA512_Init(SHA512_CTX *c); int SHA512_Update(SHA512_CTX *c, const void *data, size_t len); int SHA512_Final(unsigned char *md, SHA512_CTX *c); unsigned char *SHA512(const unsigned char *d, size_t n, unsigned char *md); .Ve Header "DESCRIPTION" Applications should use the higher level functions \fIEVP_DigestInit\|(3) etc. instead of calling the hash functions directly.

\s-1SHA-1 \s0(Secure Hash Algorithm) is a cryptographic hash function with a 160 bit output.

\s-1SHA1\s0() computes the \s-1SHA-1\s0 message digest of the n bytes at d and places it in md (which must have space for \s-1SHA_DIGEST_LENGTH\s0 == 20 bytes of output). If md is \s-1NULL,\s0 the digest is placed in a static array. Note: setting md to \s-1NULL\s0 is not thread safe.

The following functions may be used if the message is not completely stored in memory:

\fISHA1_Init() initializes a \s-1SHA_CTX\s0 structure.

\fISHA1_Update() can be called repeatedly with chunks of the message to be hashed (len bytes at data).

\fISHA1_Final() places the message digest in md, which must have space for \s-1SHA_DIGEST_LENGTH\s0 == 20 bytes of output, and erases the \s-1SHA_CTX\s0.

The \s-1SHA224, SHA256, SHA384\s0 and \s-1SHA512\s0 families of functions operate in the same way as for the \s-1SHA1\s0 functions. Note that \s-1SHA224\s0 and \s-1SHA256\s0 use a \fB\s-1SHA256_CTX\s0 object instead of \s-1SHA_CTX\s0. \s-1SHA384\s0 and \s-1SHA512\s0 use \s-1SHA512_CTX\s0. The buffer md must have space for the output from the \s-1SHA\s0 variant being used (defined by \s-1SHA224_DIGEST_LENGTH, SHA256_DIGEST_LENGTH, SHA384_DIGEST_LENGTH\s0 and \s-1SHA512_DIGEST_LENGTH\s0). Also note that, as for the \s-1SHA1\s0() function above, the \s-1SHA224\s0(), \s-1SHA256\s0(), \s-1SHA384\s0() and \s-1SHA512\s0() functions are not thread safe if \fBmd is \s-1NULL.\s0

The predecessor of \s-1SHA-1, SHA,\s0 is also implemented, but it should be used only when backward compatibility is required.

Header "RETURN VALUES" \s-1SHA1\s0(), \s-1SHA224\s0(), \s-1SHA256\s0(), \s-1SHA384\s0() and \s-1SHA512\s0() return a pointer to the hash value.

\fISHA1_Init(), SHA1_Update() and SHA1_Final() and equivalent \s-1SHA224, SHA256, SHA384\s0 and \s-1SHA512\s0 functions return 1 for success, 0 otherwise.

Header "CONFORMING TO" \s-1US\s0 Federal Information Processing Standard \s-1FIPS PUB 180-4 \s0(Secure Hash Standard), \s-1ANSI X9.30\s0 Header "SEE ALSO" \fIopenssl_ripemd\|(3), openssl_hmac\|(3), EVP_DigestInit\|(3) Header "HISTORY" \s-1SHA1\s0(), SHA1_Init(), SHA1_Update() and SHA1_Final() are available in all versions of SSLeay and OpenSSL.

Indexes created Sat Apr 25 00:22:52 UTC 2026