commit the new man page.
This commit is contained in:
christos
parent
29d394bb59
commit
a6b0cd16cd
230
crypto/external/bsd/openssl/lib/libcrypto/man/EVP_PKEY_verify_recover.3
vendored
Normal file
230
crypto/external/bsd/openssl/lib/libcrypto/man/EVP_PKEY_verify_recover.3
vendored
Normal file
@ -0,0 +1,230 @@
|
||||
.\" $NetBSD: EVP_PKEY_verify_recover.3,v 1.1 2013/02/07 17:30:08 christos Exp $
|
||||
.\"
|
||||
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
|
||||
.\"
|
||||
.\" Standard preamble:
|
||||
.\" ========================================================================
|
||||
.de Sp \" Vertical space (when we can't use .PP)
|
||||
.if t .sp .5v
|
||||
.if n .sp
|
||||
..
|
||||
.de Vb \" Begin verbatim text
|
||||
.ft CW
|
||||
.nf
|
||||
.ne \\$1
|
||||
..
|
||||
.de Ve \" End verbatim text
|
||||
.ft R
|
||||
.fi
|
||||
..
|
||||
.\" Set up some character translations and predefined strings. \*(-- will
|
||||
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
||||
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
||||
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
||||
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
||||
.\" nothing in troff, for use with C<>.
|
||||
.tr \(*W-
|
||||
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
||||
.ie n \{\
|
||||
. ds -- \(*W-
|
||||
. ds PI pi
|
||||
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
||||
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
||||
. ds L" ""
|
||||
. ds R" ""
|
||||
. ds C` ""
|
||||
. ds C' ""
|
||||
'br\}
|
||||
.el\{\
|
||||
. ds -- \|\(em\|
|
||||
. ds PI \(*p
|
||||
. ds L" ``
|
||||
. ds R" ''
|
||||
'br\}
|
||||
.\"
|
||||
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
||||
.ie \n(.g .ds Aq \(aq
|
||||
.el .ds Aq '
|
||||
.\"
|
||||
.\" If the F register is turned on, we'll generate index entries on stderr for
|
||||
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
||||
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
||||
.\" output yourself in some meaningful fashion.
|
||||
.ie \nF \{\
|
||||
. de IX
|
||||
. tm Index:\\$1\t\\n%\t"\\$2"
|
||||
..
|
||||
. nr % 0
|
||||
. rr F
|
||||
.\}
|
||||
.el \{\
|
||||
. de IX
|
||||
..
|
||||
.\}
|
||||
.\"
|
||||
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
||||
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
||||
. \" fudge factors for nroff and troff
|
||||
.if n \{\
|
||||
. ds #H 0
|
||||
. ds #V .8m
|
||||
. ds #F .3m
|
||||
. ds #[ \f1
|
||||
. ds #] \fP
|
||||
.\}
|
||||
.if t \{\
|
||||
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
||||
. ds #V .6m
|
||||
. ds #F 0
|
||||
. ds #[ \&
|
||||
. ds #] \&
|
||||
.\}
|
||||
. \" simple accents for nroff and troff
|
||||
.if n \{\
|
||||
. ds ' \&
|
||||
. ds ` \&
|
||||
. ds ^ \&
|
||||
. ds , \&
|
||||
. ds ~ ~
|
||||
. ds /
|
||||
.\}
|
||||
.if t \{\
|
||||
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
||||
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
||||
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
||||
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
||||
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
||||
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
||||
.\}
|
||||
. \" troff and (daisy-wheel) nroff accents
|
||||
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
||||
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
||||
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
||||
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
||||
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
||||
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
||||
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
||||
.ds ae a\h'-(\w'a'u*4/10)'e
|
||||
.ds Ae A\h'-(\w'A'u*4/10)'E
|
||||
. \" corrections for vroff
|
||||
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
||||
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
||||
. \" for low resolution devices (crt and lpr)
|
||||
.if \n(.H>23 .if \n(.V>19 \
|
||||
\{\
|
||||
. ds : e
|
||||
. ds 8 ss
|
||||
. ds o a
|
||||
. ds d- d\h'-1'\(ga
|
||||
. ds D- D\h'-1'\(hy
|
||||
. ds th \o'bp'
|
||||
. ds Th \o'LP'
|
||||
. ds ae ae
|
||||
. ds Ae AE
|
||||
.\}
|
||||
.rm #[ #] #H #V #F C
|
||||
.\" ========================================================================
|
||||
.\"
|
||||
.IX Title "EVP_PKEY_verify_recover 3"
|
||||
.TH EVP_PKEY_verify_recover 3 "2013-02-05" "1.0.1d" "OpenSSL"
|
||||
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||||
.\" way too many mistakes in technical documents.
|
||||
.if n .ad l
|
||||
.nh
|
||||
.SH "NAME"
|
||||
EVP_PKEY_verify_recover_init, EVP_PKEY_verify_recover \- recover signature using a public key algorithm
|
||||
.SH "LIBRARY"
|
||||
libcrypto, -lcrypto
|
||||
.SH "SYNOPSIS"
|
||||
.IX Header "SYNOPSIS"
|
||||
.Vb 1
|
||||
\& #include <openssl/evp.h>
|
||||
\&
|
||||
\& int EVP_PKEY_verify_recover_init(EVP_PKEY_CTX *ctx);
|
||||
\& int EVP_PKEY_verify_recover(EVP_PKEY_CTX *ctx,
|
||||
\& unsigned char *rout, size_t *routlen,
|
||||
\& const unsigned char *sig, size_t siglen);
|
||||
.Ve
|
||||
.SH "DESCRIPTION"
|
||||
.IX Header "DESCRIPTION"
|
||||
The \fIEVP_PKEY_verify_recover_init()\fR function initializes a public key algorithm
|
||||
context using key \fBpkey\fR for a verify recover operation.
|
||||
.PP
|
||||
The \fIEVP_PKEY_verify_recover()\fR function recovers signed data
|
||||
using \fBctx\fR. The signature is specified using the \fBsig\fR and
|
||||
\&\fBsiglen\fR parameters. If \fBrout\fR is \fB\s-1NULL\s0\fR then the maximum size of the output
|
||||
buffer is written to the \fBroutlen\fR parameter. If \fBrout\fR is not \fB\s-1NULL\s0\fR then
|
||||
before the call the \fBroutlen\fR parameter should contain the length of the
|
||||
\&\fBrout\fR buffer, if the call is successful recovered data is written to
|
||||
\&\fBrout\fR and the amount of data written to \fBroutlen\fR.
|
||||
.SH "NOTES"
|
||||
.IX Header "NOTES"
|
||||
Normally an application is only interested in whether a signature verification
|
||||
operation is successful in those cases the \fIEVP_verify()\fR function should be
|
||||
used.
|
||||
.PP
|
||||
Sometimes however it is useful to obtain the data originally signed using a
|
||||
signing operation. Only certain public key algorithms can recover a signature
|
||||
in this way (for example \s-1RSA\s0 in \s-1PKCS\s0 padding mode).
|
||||
.PP
|
||||
After the call to \fIEVP_PKEY_verify_recover_init()\fR algorithm specific control
|
||||
operations can be performed to set any appropriate parameters for the
|
||||
operation.
|
||||
.PP
|
||||
The function \fIEVP_PKEY_verify_recover()\fR can be called more than once on the same
|
||||
context if several operations are performed using the same parameters.
|
||||
.SH "RETURN VALUES"
|
||||
.IX Header "RETURN VALUES"
|
||||
\&\fIEVP_PKEY_verify_recover_init()\fR and \fIEVP_PKEY_verify_recover()\fR return 1 for success
|
||||
and 0 or a negative value for failure. In particular a return value of \-2
|
||||
indicates the operation is not supported by the public key algorithm.
|
||||
.SH "EXAMPLE"
|
||||
.IX Header "EXAMPLE"
|
||||
Recover digest originally signed using PKCS#1 and \s-1SHA256\s0 digest:
|
||||
.PP
|
||||
.Vb 2
|
||||
\& #include <openssl/evp.h>
|
||||
\& #include <openssl/rsa.h>
|
||||
\&
|
||||
\& EVP_PKEY_CTX *ctx;
|
||||
\& unsigned char *rout, *sig;
|
||||
\& size_t routlen, siglen;
|
||||
\& EVP_PKEY *verify_key;
|
||||
\& /* NB: assumes verify_key, sig and siglen are already set up
|
||||
\& * and that verify_key is an RSA public key
|
||||
\& */
|
||||
\& ctx = EVP_PKEY_CTX_new(verify_key);
|
||||
\& if (!ctx)
|
||||
\& /* Error occurred */
|
||||
\& if (EVP_PKEY_verify_recover_init(ctx) <= 0)
|
||||
\& /* Error */
|
||||
\& if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PADDING) <= 0)
|
||||
\& /* Error */
|
||||
\& if (EVP_PKEY_CTX_set_signature_md(ctx, EVP_sha256()) <= 0)
|
||||
\& /* Error */
|
||||
\&
|
||||
\& /* Determine buffer length */
|
||||
\& if (EVP_PKEY_verify_recover(ctx, NULL, &routlen, sig, siglen) <= 0)
|
||||
\& /* Error */
|
||||
\&
|
||||
\& rout = OPENSSL_malloc(routlen);
|
||||
\&
|
||||
\& if (!rout)
|
||||
\& /* malloc failure */
|
||||
\&
|
||||
\& if (EVP_PKEY_verify_recover(ctx, rout, &routlen, sig, siglen) <= 0)
|
||||
\& /* Error */
|
||||
\&
|
||||
\& /* Recovered data is routlen bytes written to buffer rout */
|
||||
.Ve
|
||||
.SH "SEE ALSO"
|
||||
.IX Header "SEE ALSO"
|
||||
\&\fIEVP_PKEY_CTX_new\fR\|(3),
|
||||
\&\fIEVP_PKEY_encrypt\fR\|(3),
|
||||
\&\fIEVP_PKEY_decrypt\fR\|(3),
|
||||
\&\fIEVP_PKEY_sign\fR\|(3),
|
||||
\&\fIEVP_PKEY_verify\fR\|(3),
|
||||
\&\fIEVP_PKEY_derive\fR\|(3)
|
||||
.SH "HISTORY"
|
||||
.IX Header "HISTORY"
|
||||
These functions were first added to OpenSSL 1.0.0.
|
||||
Loading…
Reference in New Issue
Block a user