secure/lib/libcrypto/man/man3/EVP_DigestVerifyInit.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 "EVP_DIGESTVERIFYINIT 3"
 136 .TH EVP_DIGESTVERIFYINIT 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 EVP_DigestVerifyInit, EVP_DigestVerifyUpdate, EVP_DigestVerifyFinal, EVP_DigestVerify \- EVP signature verification functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/evp.h>
 147 \&
 148 \& int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
 149 \&                          const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey);
 150 \& int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
 151 \& int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
 152 \&                           size_t siglen);
 153 \& int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
 154 \&                      size_t siglen, const unsigned char *tbs, size_t tbslen);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 The \s-1EVP\s0 signature routines are a high level interface to digital signatures.
 159 .PP
 160 \&\fBEVP_DigestVerifyInit()\fR sets up verification context \fBctx\fR to use digest
 161 \&\fBtype\fR from \s-1ENGINE\s0 \fBe\fR and public key \fBpkey\fR. \fBctx\fR must be created
 162 with \fBEVP_MD_CTX_new()\fR before calling this function. If \fBpctx\fR is not \s-1NULL,\s0 the
 163 \&\s-1EVP_PKEY_CTX\s0 of the verification operation will be written to \fB*pctx\fR: this
 164 can be used to set alternative verification options. Note that any existing
 165 value in \fB*pctx\fR is overwritten. The \s-1EVP_PKEY_CTX\s0 value returned must not be freed
 166 directly by the application if \fBctx\fR is not assigned an \s-1EVP_PKEY_CTX\s0 value before
 167 being passed to \fBEVP_DigestVerifyInit()\fR (which means the \s-1EVP_PKEY_CTX\s0 is created
 168 inside \fBEVP_DigestVerifyInit()\fR and it will be freed automatically when the
 169 \&\s-1EVP_MD_CTX\s0 is freed).
 170 .PP
 171 No \fB\s-1EVP_PKEY_CTX\s0\fR will be created by \fBEVP_DigestSignInit()\fR if the passed \fBctx\fR
 172 has already been assigned one via \fBEVP_MD_CTX_set_pkey_ctx\fR\|(3). See also \s-1\fBSM2\s0\fR\|(7).
 173 .PP
 174 \&\fBEVP_DigestVerifyUpdate()\fR hashes \fBcnt\fR bytes of data at \fBd\fR into the
 175 verification context \fBctx\fR. This function can be called several times on the
 176 same \fBctx\fR to include additional data. This function is currently implemented
 177 using a macro.
 178 .PP
 179 \&\fBEVP_DigestVerifyFinal()\fR verifies the data in \fBctx\fR against the signature in
 180 \&\fBsig\fR of length \fBsiglen\fR.
 181 .PP
 182 \&\fBEVP_DigestVerify()\fR verifies \fBtbslen\fR bytes at \fBtbs\fR against the signature
 183 in \fBsig\fR of length \fBsiglen\fR.
 184 .SH "RETURN VALUES"
 185 .IX Header "RETURN VALUES"
 186 \&\fBEVP_DigestVerifyInit()\fR and \fBEVP_DigestVerifyUpdate()\fR return 1 for success and 0
 187 for failure.
 188 .PP
 189 \&\fBEVP_DigestVerifyFinal()\fR and \fBEVP_DigestVerify()\fR return 1 for success; any other
 190 value indicates failure.  A return value of zero indicates that the signature
 191 did not verify successfully (that is, \fBtbs\fR did not match the original data or
 192 the signature had an invalid form), while other values indicate a more serious
 193 error (and sometimes also indicate an invalid signature form).
 194 .PP
 195 The error codes can be obtained from \fBERR_get_error\fR\|(3).
 196 .SH "NOTES"
 197 .IX Header "NOTES"
 198 The \fB\s-1EVP\s0\fR interface to digital signatures should almost always be used in
 199 preference to the low level interfaces. This is because the code then becomes
 200 transparent to the algorithm used and much more flexible.
 201 .PP
 202 \&\fBEVP_DigestVerify()\fR is a one shot operation which verifies a single block of
 203 data in one function. For algorithms that support streaming it is equivalent
 204 to calling \fBEVP_DigestVerifyUpdate()\fR and \fBEVP_DigestVerifyFinal()\fR. For
 205 algorithms which do not support streaming (e.g. PureEdDSA) it is the only way
 206 to verify data.
 207 .PP
 208 In previous versions of OpenSSL there was a link between message digest types
 209 and public key algorithms. This meant that \*(L"clone\*(R" digests such as \fBEVP_dss1()\fR
 210 needed to be used to sign using \s-1SHA1\s0 and \s-1DSA.\s0 This is no longer necessary and
 211 the use of clone digest is now discouraged.
 212 .PP
 213 For some key types and parameters the random number generator must be seeded.
 214 If the automatic seeding or reseeding of the OpenSSL \s-1CSPRNG\s0 fails due to
 215 external circumstances (see \s-1\fBRAND\s0\fR\|(7)), the operation will fail.
 216 .PP
 217 The call to \fBEVP_DigestVerifyFinal()\fR internally finalizes a copy of the digest
 218 context. This means that \fBEVP_VerifyUpdate()\fR and \fBEVP_VerifyFinal()\fR can
 219 be called later to digest and verify additional data.
 220 .PP
 221 Since only a copy of the digest context is ever finalized, the context must
 222 be cleaned up after use by calling \fBEVP_MD_CTX_free()\fR or a memory leak
 223 will occur.
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fBEVP_DigestSignInit\fR\|(3),
 227 \&\fBEVP_DigestInit\fR\|(3),
 228 \&\fBevp\fR\|(7), \s-1\fBHMAC\s0\fR\|(3), \s-1\fBMD2\s0\fR\|(3),
 229 \&\s-1\fBMD5\s0\fR\|(3), \s-1\fBMDC2\s0\fR\|(3), \s-1\fBRIPEMD160\s0\fR\|(3),
 230 \&\s-1\fBSHA1\s0\fR\|(3), \fBdgst\fR\|(1),
 231 \&\s-1\fBRAND\s0\fR\|(7)
 232 .SH "HISTORY"
 233 .IX Header "HISTORY"
 234 \&\fBEVP_DigestVerifyInit()\fR, \fBEVP_DigestVerifyUpdate()\fR and \fBEVP_DigestVerifyFinal()\fR
 235 were added in OpenSSL 1.0.0.
 236 .SH "COPYRIGHT"
 237 .IX Header "COPYRIGHT"
 238 Copyright 2006\-2019 The OpenSSL Project Authors. All Rights Reserved.
 239 .PP
 240 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 241 this file except in compliance with the License.  You can obtain a copy
 242 in the file \s-1LICENSE\s0 in the source distribution or at
 243 <https://www.openssl.org/source/license.html>.