241 lines
7.7 KiB
Groff
241 lines
7.7 KiB
Groff
|
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
||
|
|
.\"
|
||
|
|
.\" 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_SIGN 3"
|
||
|
|
.TH EVP_PKEY_SIGN 3 "2020-03-02" "3.0.0-dev" "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_sign_init, EVP_PKEY_sign
|
||
|
|
\&\- sign using a public key algorithm
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.IX Header "SYNOPSIS"
|
||
|
|
.Vb 1
|
||
|
|
\& #include <openssl/evp.h>
|
||
|
|
\&
|
||
|
|
\& int EVP_PKEY_sign_init(EVP_PKEY_CTX *ctx);
|
||
|
|
\& int EVP_PKEY_sign(EVP_PKEY_CTX *ctx,
|
||
|
|
\& unsigned char *sig, size_t *siglen,
|
||
|
|
\& const unsigned char *tbs, size_t tbslen);
|
||
|
|
.Ve
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
\&\fIEVP_PKEY_sign_init()\fR initializes a public key algorithm context \fIctx\fR for
|
||
|
|
signing using the algorithm given when the context was created
|
||
|
|
using \fIEVP_PKEY_CTX_new\fR\|(3) or variants thereof. The algorithm is used to
|
||
|
|
fetch a \fB\s-1EVP_SIGNATURE\s0\fR method implicitly, see \*(L"Implicit fetch\*(R" in \fIprovider\fR\|(7)
|
||
|
|
for more information about implict fetches.
|
||
|
|
.PP
|
||
|
|
The \fIEVP_PKEY_sign()\fR function performs a public key signing operation
|
||
|
|
using \fIctx\fR. The data to be signed is specified using the \fItbs\fR and
|
||
|
|
\&\fItbslen\fR parameters. If \fIsig\fR is \s-1NULL\s0 then the maximum size of the output
|
||
|
|
buffer is written to the \fIsiglen\fR parameter. If \fIsig\fR is not \s-1NULL\s0 then
|
||
|
|
before the call the \fIsiglen\fR parameter should contain the length of the
|
||
|
|
\&\fIsig\fR buffer, if the call is successful the signature is written to
|
||
|
|
\&\fIsig\fR and the amount of data written to \fIsiglen\fR.
|
||
|
|
.SH "NOTES"
|
||
|
|
.IX Header "NOTES"
|
||
|
|
\&\fIEVP_PKEY_sign()\fR does not hash the data to be signed, and therefore is
|
||
|
|
normally used to sign digests. For signing arbitrary messages, see the
|
||
|
|
\&\fIEVP_DigestSignInit\fR\|(3) and
|
||
|
|
\&\fIEVP_SignInit\fR\|(3) signing interfaces instead.
|
||
|
|
.PP
|
||
|
|
After the call to \fIEVP_PKEY_sign_init()\fR algorithm specific control
|
||
|
|
operations can be performed to set any appropriate parameters for the
|
||
|
|
operation (see \fIEVP_PKEY_CTX_ctrl\fR\|(3)).
|
||
|
|
.PP
|
||
|
|
The function \fIEVP_PKEY_sign()\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_sign_init()\fR and \fIEVP_PKEY_sign()\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 "EXAMPLES"
|
||
|
|
.IX Header "EXAMPLES"
|
||
|
|
Sign data using \s-1RSA\s0 with PKCS#1 padding and \s-1SHA256\s0 digest:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& #include <openssl/evp.h>
|
||
|
|
\& #include <openssl/rsa.h>
|
||
|
|
\&
|
||
|
|
\& EVP_PKEY_CTX *ctx;
|
||
|
|
\& /* md is a SHA\-256 digest in this example. */
|
||
|
|
\& unsigned char *md, *sig;
|
||
|
|
\& size_t mdlen = 32, siglen;
|
||
|
|
\& EVP_PKEY *signing_key;
|
||
|
|
\&
|
||
|
|
\& /*
|
||
|
|
\& * NB: assumes signing_key and md are set up before the next
|
||
|
|
\& * step. signing_key must be an RSA private key and md must
|
||
|
|
\& * point to the SHA\-256 digest to be signed.
|
||
|
|
\& */
|
||
|
|
\& ctx = EVP_PKEY_CTX_new(signing_key, NULL /* no engine */);
|
||
|
|
\& if (!ctx)
|
||
|
|
\& /* Error occurred */
|
||
|
|
\& if (EVP_PKEY_sign_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_sign(ctx, NULL, &siglen, md, mdlen) <= 0)
|
||
|
|
\& /* Error */
|
||
|
|
\&
|
||
|
|
\& sig = OPENSSL_malloc(siglen);
|
||
|
|
\&
|
||
|
|
\& if (!sig)
|
||
|
|
\& /* malloc failure */
|
||
|
|
\&
|
||
|
|
\& if (EVP_PKEY_sign(ctx, sig, &siglen, md, mdlen) <= 0)
|
||
|
|
\& /* Error */
|
||
|
|
\&
|
||
|
|
\& /* Signature is siglen bytes written to buffer sig */
|
||
|
|
.Ve
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
\&\fIEVP_PKEY_CTX_new\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_CTX_ctrl\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_encrypt\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_decrypt\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_verify\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_verify_recover\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_derive\fR\|(3)
|
||
|
|
.SH "HISTORY"
|
||
|
|
.IX Header "HISTORY"
|
||
|
|
These functions were added in OpenSSL 1.0.0.
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.IX Header "COPYRIGHT"
|
||
|
|
Copyright 2006\-2016 The OpenSSL Project Authors. All Rights Reserved.
|
||
|
|
.PP
|
||
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
||
|
|
this file except in compliance with the License. You can obtain a copy
|
||
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
||
|
|
<https://www.openssl.org/source/license.html>.
|