1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
132 .TH sha 3 "2017-05-25" "1.0.2l" "OpenSSL"
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 SHA1, SHA1_Init, SHA1_Update, SHA1_Final, SHA224, SHA224_Init, SHA224_Update,
139 SHA224_Final, SHA256, SHA256_Init, SHA256_Update, SHA256_Final, SHA384,
140 SHA384_Init, SHA384_Update, SHA384_Final, SHA512, SHA512_Init, SHA512_Update,
141 SHA512_Final \- Secure Hash Algorithm
143 .IX Header "SYNOPSIS"
145 \& #include <openssl/sha.h>
147 \& int SHA1_Init(SHA_CTX *c);
148 \& int SHA1_Update(SHA_CTX *c, const void *data, size_t len);
149 \& int SHA1_Final(unsigned char *md, SHA_CTX *c);
150 \& unsigned char *SHA1(const unsigned char *d, size_t n,
151 \& unsigned char *md);
153 \& int SHA224_Init(SHA256_CTX *c);
154 \& int SHA224_Update(SHA256_CTX *c, const void *data, size_t len);
155 \& int SHA224_Final(unsigned char *md, SHA256_CTX *c);
156 \& unsigned char *SHA224(const unsigned char *d, size_t n,
157 \& unsigned char *md);
159 \& int SHA256_Init(SHA256_CTX *c);
160 \& int SHA256_Update(SHA256_CTX *c, const void *data, size_t len);
161 \& int SHA256_Final(unsigned char *md, SHA256_CTX *c);
162 \& unsigned char *SHA256(const unsigned char *d, size_t n,
163 \& unsigned char *md);
165 \& int SHA384_Init(SHA512_CTX *c);
166 \& int SHA384_Update(SHA512_CTX *c, const void *data, size_t len);
167 \& int SHA384_Final(unsigned char *md, SHA512_CTX *c);
168 \& unsigned char *SHA384(const unsigned char *d, size_t n,
169 \& unsigned char *md);
171 \& int SHA512_Init(SHA512_CTX *c);
172 \& int SHA512_Update(SHA512_CTX *c, const void *data, size_t len);
173 \& int SHA512_Final(unsigned char *md, SHA512_CTX *c);
174 \& unsigned char *SHA512(const unsigned char *d, size_t n,
175 \& unsigned char *md);
178 .IX Header "DESCRIPTION"
179 Applications should use the higher level functions
180 \&\fIEVP_DigestInit\fR\|(3) etc. instead of calling the hash
183 \&\s-1SHA\-1 \s0(Secure Hash Algorithm) is a cryptographic hash function with a
186 \&\s-1\fISHA1\s0()\fR computes the \s-1SHA\-1\s0 message digest of the \fBn\fR
187 bytes at \fBd\fR and places it in \fBmd\fR (which must have space for
188 \&\s-1SHA_DIGEST_LENGTH\s0 == 20 bytes of output). If \fBmd\fR is \s-1NULL,\s0 the digest
189 is placed in a static array. Note: setting \fBmd\fR to \s-1NULL\s0 is \fBnot thread safe\fR.
191 The following functions may be used if the message is not completely
194 \&\fISHA1_Init()\fR initializes a \fB\s-1SHA_CTX\s0\fR structure.
196 \&\fISHA1_Update()\fR can be called repeatedly with chunks of the message to
197 be hashed (\fBlen\fR bytes at \fBdata\fR).
199 \&\fISHA1_Final()\fR places the message digest in \fBmd\fR, which must have space
200 for \s-1SHA_DIGEST_LENGTH\s0 == 20 bytes of output, and erases the \fB\s-1SHA_CTX\s0\fR.
202 The \s-1SHA224, SHA256, SHA384\s0 and \s-1SHA512\s0 families of functions operate in the
203 same way as for the \s-1SHA1\s0 functions. Note that \s-1SHA224\s0 and \s-1SHA256\s0 use a
204 \&\fB\s-1SHA256_CTX\s0\fR object instead of \fB\s-1SHA_CTX\s0\fR. \s-1SHA384\s0 and \s-1SHA512\s0 use \fB\s-1SHA512_CTX\s0\fR.
205 The buffer \fBmd\fR must have space for the output from the \s-1SHA\s0 variant being used
206 (defined by \s-1SHA224_DIGEST_LENGTH, SHA256_DIGEST_LENGTH, SHA384_DIGEST_LENGTH\s0 and
207 \&\s-1SHA512_DIGEST_LENGTH\s0). Also note that, as for the \s-1\fISHA1\s0()\fR function above, the
208 \&\s-1\fISHA224\s0()\fR, \s-1\fISHA256\s0()\fR, \s-1\fISHA384\s0()\fR and \s-1\fISHA512\s0()\fR functions are not thread safe if
209 \&\fBmd\fR is \s-1NULL.\s0
211 The predecessor of \s-1SHA\-1, SHA,\s0 is also implemented, but it should be
212 used only when backward compatibility is required.
214 .IX Header "RETURN VALUES"
215 \&\s-1\fISHA1\s0()\fR, \s-1\fISHA224\s0()\fR, \s-1\fISHA256\s0()\fR, \s-1\fISHA384\s0()\fR and \s-1\fISHA512\s0()\fR return a pointer to the hash
218 \&\fISHA1_Init()\fR, \fISHA1_Update()\fR and \fISHA1_Final()\fR and equivalent \s-1SHA224, SHA256,
219 SHA384\s0 and \s-1SHA512\s0 functions return 1 for success, 0 otherwise.
221 .IX Header "CONFORMING TO"
222 \&\s-1US\s0 Federal Information Processing Standard \s-1FIPS PUB 180\-4 \s0(Secure Hash
226 .IX Header "SEE ALSO"
227 \&\fIripemd\fR\|(3), \fIhmac\fR\|(3), \fIEVP_DigestInit\fR\|(3)
230 \&\s-1\fISHA1\s0()\fR, \fISHA1_Init()\fR, \fISHA1_Update()\fR and \fISHA1_Final()\fR are available in all
231 versions of SSLeay and OpenSSL.