secure/lib/libcrypto/man/EVP_PKEY_verify_recover.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  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
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  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'
 101 .\}
 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 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "EVP_PKEY_VERIFY_RECOVER 3"
 132 .TH EVP_PKEY_VERIFY_RECOVER 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 EVP_PKEY_verify_recover_init, EVP_PKEY_verify_recover \- recover signature using a public key algorithm
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/evp.h>
 143 \&
 144 \& int EVP_PKEY_verify_recover_init(EVP_PKEY_CTX *ctx);
 145 \& int EVP_PKEY_verify_recover(EVP_PKEY_CTX *ctx,
 146 \&                             unsigned char *rout, size_t *routlen,
 147 \&                             const unsigned char *sig, size_t siglen);
 148 .Ve
 149 .SH "DESCRIPTION"
 150 .IX Header "DESCRIPTION"
 151 The \fIEVP_PKEY_verify_recover_init()\fR function initializes a public key algorithm
 152 context using key \fBpkey\fR for a verify recover operation.
 153 .PP
 154 The \fIEVP_PKEY_verify_recover()\fR function recovers signed data
 155 using \fBctx\fR. The signature is specified using the \fBsig\fR and
 156 \&\fBsiglen\fR parameters. If \fBrout\fR is \fB\s-1NULL\s0\fR then the maximum size of the output
 157 buffer is written to the \fBroutlen\fR parameter. If \fBrout\fR is not \fB\s-1NULL\s0\fR then
 158 before the call the \fBroutlen\fR parameter should contain the length of the
 159 \&\fBrout\fR buffer, if the call is successful recovered data is written to
 160 \&\fBrout\fR and the amount of data written to \fBroutlen\fR.
 161 .SH "NOTES"
 162 .IX Header "NOTES"
 163 Normally an application is only interested in whether a signature verification
 164 operation is successful in those cases the \fIEVP_verify()\fR function should be
 165 used.
 166 .PP
 167 Sometimes however it is useful to obtain the data originally signed using a
 168 signing operation. Only certain public key algorithms can recover a signature
 169 in this way (for example \s-1RSA\s0 in \s-1PKCS\s0 padding mode).
 170 .PP
 171 After the call to \fIEVP_PKEY_verify_recover_init()\fR algorithm specific control
 172 operations can be performed to set any appropriate parameters for the
 173 operation.
 174 .PP
 175 The function \fIEVP_PKEY_verify_recover()\fR can be called more than once on the same
 176 context if several operations are performed using the same parameters.
 177 .SH "RETURN VALUES"
 178 .IX Header "RETURN VALUES"
 179 \&\fIEVP_PKEY_verify_recover_init()\fR and \fIEVP_PKEY_verify_recover()\fR return 1 for success
 180 and 0 or a negative value for failure. In particular a return value of \-2
 181 indicates the operation is not supported by the public key algorithm.
 182 .SH "EXAMPLE"
 183 .IX Header "EXAMPLE"
 184 Recover digest originally signed using PKCS#1 and \s-1SHA256\s0 digest:
 185 .PP
 186 .Vb 2
 187 \& #include <openssl/evp.h>
 188 \& #include <openssl/rsa.h>
 189 \&
 190 \& EVP_PKEY_CTX *ctx;
 191 \& unsigned char *rout, *sig;
 192 \& size_t routlen, siglen;
 193 \& EVP_PKEY *verify_key;
 194 \&
 195 \& /*
 196 \&  * NB: assumes verify_key, sig and siglen are already set up
 197 \&  * and that verify_key is an RSA public key
 198 \&  */
 199 \& ctx = EVP_PKEY_CTX_new(verify_key, NULL /* no engine */);
 200 \& if (!ctx)
 201 \&     /* Error occurred */
 202 \& if (EVP_PKEY_verify_recover_init(ctx) <= 0)
 203 \&     /* Error */
 204 \& if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PADDING) <= 0)
 205 \&     /* Error */
 206 \& if (EVP_PKEY_CTX_set_signature_md(ctx, EVP_sha256()) <= 0)
 207 \&     /* Error */
 208 \&
 209 \& /* Determine buffer length */
 210 \& if (EVP_PKEY_verify_recover(ctx, NULL, &routlen, sig, siglen) <= 0)
 211 \&     /* Error */
 212 \&
 213 \& rout = OPENSSL_malloc(routlen);
 214 \&
 215 \& if (!rout)
 216 \&     /* malloc failure */
 217 \&
 218 \& if (EVP_PKEY_verify_recover(ctx, rout, &routlen, sig, siglen) <= 0)
 219 \&     /* Error */
 220 \&
 221 \& /* Recovered data is routlen bytes written to buffer rout */
 222 .Ve
 223 .SH "SEE ALSO"
 224 .IX Header "SEE ALSO"
 225 \&\fIEVP_PKEY_CTX_new\fR\|(3),
 226 \&\fIEVP_PKEY_encrypt\fR\|(3),
 227 \&\fIEVP_PKEY_decrypt\fR\|(3),
 228 \&\fIEVP_PKEY_sign\fR\|(3),
 229 \&\fIEVP_PKEY_verify\fR\|(3),
 230 \&\fIEVP_PKEY_derive\fR\|(3)
 231 .SH "HISTORY"
 232 .IX Header "HISTORY"
 233 These functions were first added to OpenSSL 1.0.0.
 234 .SH "COPYRIGHT"
 235 .IX Header "COPYRIGHT"
 236 Copyright 2013\-2018 The OpenSSL Project Authors. All Rights Reserved.
 237 .PP
 238 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 239 this file except in compliance with the License.  You can obtain a copy
 240 in the file \s-1LICENSE\s0 in the source distribution or at
 241 <https://www.openssl.org/source/license.html>.