secure/lib/libcrypto/man/man3/SHA256_Init.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  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<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  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
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  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.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SHA256_INIT 3"
 136 .TH SHA256_INIT 3 "2020-03-17" "1.1.1e" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 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
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/sha.h>
 147 \&
 148 \& int SHA1_Init(SHA_CTX *c);
 149 \& int SHA1_Update(SHA_CTX *c, const void *data, size_t len);
 150 \& int SHA1_Final(unsigned char *md, SHA_CTX *c);
 151 \& unsigned char *SHA1(const unsigned char *d, size_t n,
 152 \&                     unsigned char *md);
 153 \&
 154 \& int SHA224_Init(SHA256_CTX *c);
 155 \& int SHA224_Update(SHA256_CTX *c, const void *data, size_t len);
 156 \& int SHA224_Final(unsigned char *md, SHA256_CTX *c);
 157 \& unsigned char *SHA224(const unsigned char *d, size_t n,
 158 \&                       unsigned char *md);
 159 \&
 160 \& int SHA256_Init(SHA256_CTX *c);
 161 \& int SHA256_Update(SHA256_CTX *c, const void *data, size_t len);
 162 \& int SHA256_Final(unsigned char *md, SHA256_CTX *c);
 163 \& unsigned char *SHA256(const unsigned char *d, size_t n,
 164 \&                       unsigned char *md);
 165 \&
 166 \& int SHA384_Init(SHA512_CTX *c);
 167 \& int SHA384_Update(SHA512_CTX *c, const void *data, size_t len);
 168 \& int SHA384_Final(unsigned char *md, SHA512_CTX *c);
 169 \& unsigned char *SHA384(const unsigned char *d, size_t n,
 170 \&                       unsigned char *md);
 171 \&
 172 \& int SHA512_Init(SHA512_CTX *c);
 173 \& int SHA512_Update(SHA512_CTX *c, const void *data, size_t len);
 174 \& int SHA512_Final(unsigned char *md, SHA512_CTX *c);
 175 \& unsigned char *SHA512(const unsigned char *d, size_t n,
 176 \&                       unsigned char *md);
 177 .Ve
 178 .SH "DESCRIPTION"
 179 .IX Header "DESCRIPTION"
 180 Applications should use the higher level functions
 181 \&\fBEVP_DigestInit\fR\|(3) etc. instead of calling the hash
 182 functions directly.
 183 .PP
 184 \&\s-1SHA\-1\s0 (Secure Hash Algorithm) is a cryptographic hash function with a
 185 160 bit output.
 186 .PP
 187 \&\s-1\fBSHA1\s0()\fR computes the \s-1SHA\-1\s0 message digest of the \fBn\fR
 188 bytes at \fBd\fR and places it in \fBmd\fR (which must have space for
 189 \&\s-1SHA_DIGEST_LENGTH\s0 == 20 bytes of output). If \fBmd\fR is \s-1NULL,\s0 the digest
 190 is placed in a static array. Note: setting \fBmd\fR to \s-1NULL\s0 is \fBnot thread safe\fR.
 191 .PP
 192 The following functions may be used if the message is not completely
 193 stored in memory:
 194 .PP
 195 \&\fBSHA1_Init()\fR initializes a \fB\s-1SHA_CTX\s0\fR structure.
 196 .PP
 197 \&\fBSHA1_Update()\fR can be called repeatedly with chunks of the message to
 198 be hashed (\fBlen\fR bytes at \fBdata\fR).
 199 .PP
 200 \&\fBSHA1_Final()\fR places the message digest in \fBmd\fR, which must have space
 201 for \s-1SHA_DIGEST_LENGTH\s0 == 20 bytes of output, and erases the \fB\s-1SHA_CTX\s0\fR.
 202 .PP
 203 The \s-1SHA224, SHA256, SHA384\s0 and \s-1SHA512\s0 families of functions operate in the
 204 same way as for the \s-1SHA1\s0 functions. Note that \s-1SHA224\s0 and \s-1SHA256\s0 use a
 205 \&\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.
 206 The buffer \fBmd\fR must have space for the output from the \s-1SHA\s0 variant being used
 207 (defined by \s-1SHA224_DIGEST_LENGTH, SHA256_DIGEST_LENGTH, SHA384_DIGEST_LENGTH\s0 and
 208 \&\s-1SHA512_DIGEST_LENGTH\s0). Also note that, as for the \s-1\fBSHA1\s0()\fR function above, the
 209 \&\s-1\fBSHA224\s0()\fR, \s-1\fBSHA256\s0()\fR, \s-1\fBSHA384\s0()\fR and \s-1\fBSHA512\s0()\fR functions are not thread safe if
 210 \&\fBmd\fR is \s-1NULL.\s0
 211 .PP
 212 The predecessor of \s-1SHA\-1, SHA,\s0 is also implemented, but it should be
 213 used only when backward compatibility is required.
 214 .SH "RETURN VALUES"
 215 .IX Header "RETURN VALUES"
 216 \&\s-1\fBSHA1\s0()\fR, \s-1\fBSHA224\s0()\fR, \s-1\fBSHA256\s0()\fR, \s-1\fBSHA384\s0()\fR and \s-1\fBSHA512\s0()\fR return a pointer to the hash
 217 value.
 218 .PP
 219 \&\fBSHA1_Init()\fR, \fBSHA1_Update()\fR and \fBSHA1_Final()\fR and equivalent \s-1SHA224, SHA256,
 220 SHA384\s0 and \s-1SHA512\s0 functions return 1 for success, 0 otherwise.
 221 .SH "CONFORMING TO"
 222 .IX Header "CONFORMING TO"
 223 \&\s-1US\s0 Federal Information Processing Standard \s-1FIPS PUB 180\-4\s0 (Secure Hash
 224 Standard),
 225 \&\s-1ANSI X9.30\s0
 226 .SH "SEE ALSO"
 227 .IX Header "SEE ALSO"
 228 \&\fBEVP_DigestInit\fR\|(3)
 229 .SH "COPYRIGHT"
 230 .IX Header "COPYRIGHT"
 231 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
 232 .PP
 233 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 234 this file except in compliance with the License.  You can obtain a copy
 235 in the file \s-1LICENSE\s0 in the source distribution or at
 236 <https://www.openssl.org/source/license.html>.