secure/lib/libcrypto/man/EVP_PKEY_verify.3

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   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 turned on, 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_PKEY_verify 3"
 136 .TH EVP_PKEY_verify 3 "2016-03-01" "1.0.1s" "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_PKEY_verify_init, EVP_PKEY_verify \- signature verification using a public key algorithm
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/evp.h>
 147 \&
 148 \& int EVP_PKEY_verify_init(EVP_PKEY_CTX *ctx);
 149 \& int EVP_PKEY_verify(EVP_PKEY_CTX *ctx,
 150 \&                        const unsigned char *sig, size_t siglen,
 151 \&                        const unsigned char *tbs, size_t tbslen);
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 The \fIEVP_PKEY_verify_init()\fR function initializes a public key algorithm
 156 context using key \fBpkey\fR for a signature verification operation.
 157 .PP
 158 The \fIEVP_PKEY_verify()\fR function performs a public key verification operation
 159 using \fBctx\fR. The signature is specified using the \fBsig\fR and
 160 \&\fBsiglen\fR parameters. The verified data (i.e. the data believed originally
 161 signed) is specified using the \fBtbs\fR and \fBtbslen\fR parameters.
 162 .SH "NOTES"
 163 .IX Header "NOTES"
 164 After the call to \fIEVP_PKEY_verify_init()\fR algorithm specific control
 165 operations can be performed to set any appropriate parameters for the
 166 operation.
 167 .PP
 168 The function \fIEVP_PKEY_verify()\fR can be called more than once on the same
 169 context if several operations are performed using the same parameters.
 170 .SH "RETURN VALUES"
 171 .IX Header "RETURN VALUES"
 172 \&\fIEVP_PKEY_verify_init()\fR and \fIEVP_PKEY_verify()\fR return 1 if the verification was
 173 successful and 0 if it failed. Unlike other functions the return value 0 from
 174 \&\fIEVP_PKEY_verify()\fR only indicates that the signature did not not verify
 175 successfully (that is tbs did not match the original data or the signature was
 176 of invalid form) it is not an indication of a more serious error.
 177 .PP
 178 A negative value indicates an error other that signature verification failure.
 179 In particular a return value of \-2 indicates the operation is not supported by
 180 the public key algorithm.
 181 .SH "EXAMPLE"
 182 .IX Header "EXAMPLE"
 183 Verify signature using PKCS#1 and \s-1SHA256\s0 digest:
 184 .PP
 185 .Vb 2
 186 \& #include <openssl/evp.h>
 187 \& #include <openssl/rsa.h>
 188 \&
 189 \& EVP_PKEY_CTX *ctx;
 190 \& unsigned char *md, *sig;
 191 \& size_t mdlen, siglen;
 192 \& EVP_PKEY *verify_key;
 193 \& /* NB: assumes verify_key, sig, siglen md and mdlen are already set up
 194 \&  * and that verify_key is an RSA public key
 195 \&  */
 196 \& ctx = EVP_PKEY_CTX_new(verify_key);
 197 \& if (!ctx)
 198 \&        /* Error occurred */
 199 \& if (EVP_PKEY_verify_init(ctx) <= 0)
 200 \&        /* Error */
 201 \& if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PADDING) <= 0)
 202 \&        /* Error */
 203 \& if (EVP_PKEY_CTX_set_signature_md(ctx, EVP_sha256()) <= 0)
 204 \&        /* Error */
 205 \&
 206 \& /* Perform operation */
 207 \& ret = EVP_PKEY_verify(ctx, sig, siglen, md, mdlen);
 208 \&
 209 \& /* ret == 1 indicates success, 0 verify failure and < 0 for some
 210 \&  * other error.
 211 \&  */
 212 .Ve
 213 .SH "SEE ALSO"
 214 .IX Header "SEE ALSO"
 215 \&\fIEVP_PKEY_CTX_new\fR\|(3),
 216 \&\fIEVP_PKEY_encrypt\fR\|(3),
 217 \&\fIEVP_PKEY_decrypt\fR\|(3),
 218 \&\fIEVP_PKEY_sign\fR\|(3),
 219 \&\fIEVP_PKEY_verify_recover\fR\|(3),
 220 \&\fIEVP_PKEY_derive\fR\|(3)
 221 .SH "HISTORY"
 222 .IX Header "HISTORY"
 223 These functions were first added to OpenSSL 1.0.0.