forked from cory/tildefriends
Cory McWilliams
09ddfffa6b
git-svn-id: https://www.unprompted.com/svn/projects/tildefriends/trunk@4088 ed5197a5-7fde-0310-b194-c3ffbd925b24
284 lines
11 KiB
Groff
284 lines
11 KiB
Groff
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
|
|
.\"
|
|
.\" 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" ''
|
|
. ds C`
|
|
. ds C'
|
|
'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 >0, 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.
|
|
.\"
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
|
.de IX
|
|
..
|
|
.nr rF 0
|
|
.if \n(.g .if rF .nr rF 1
|
|
.if (\n(rF:(\n(.g==0)) \{\
|
|
. if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{\
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
. \}
|
|
.\}
|
|
.rr rF
|
|
.\"
|
|
.\" 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_DIGESTSIGNINIT 3"
|
|
.TH EVP_DIGESTSIGNINIT 3 "2020-04-21" "1.1.1g" "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_DigestSignInit, EVP_DigestSignUpdate, EVP_DigestSignFinal, EVP_DigestSign \- EVP signing functions
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/evp.h>
|
|
\&
|
|
\& int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
|
|
\& const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey);
|
|
\& int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
|
|
\& int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen);
|
|
\&
|
|
\& int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret,
|
|
\& size_t *siglen, const unsigned char *tbs,
|
|
\& size_t tbslen);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \s-1EVP\s0 signature routines are a high level interface to digital signatures.
|
|
.PP
|
|
\&\fBEVP_DigestSignInit()\fR sets up signing context \fBctx\fR to use digest \fBtype\fR from
|
|
\&\s-1ENGINE\s0 \fBe\fR and private key \fBpkey\fR. \fBctx\fR must be created with
|
|
\&\fBEVP_MD_CTX_new()\fR before calling this function. If \fBpctx\fR is not \s-1NULL,\s0 the
|
|
\&\s-1EVP_PKEY_CTX\s0 of the signing operation will be written to \fB*pctx\fR: this can
|
|
be used to set alternative signing options. Note that any existing value in
|
|
\&\fB*pctx\fR is overwritten. The \s-1EVP_PKEY_CTX\s0 value returned must not be freed
|
|
directly by the application if \fBctx\fR is not assigned an \s-1EVP_PKEY_CTX\s0 value before
|
|
being passed to \fBEVP_DigestSignInit()\fR (which means the \s-1EVP_PKEY_CTX\s0 is created
|
|
inside \fBEVP_DigestSignInit()\fR and it will be freed automatically when the
|
|
\&\s-1EVP_MD_CTX\s0 is freed).
|
|
.PP
|
|
The digest \fBtype\fR may be \s-1NULL\s0 if the signing algorithm supports it.
|
|
.PP
|
|
No \fB\s-1EVP_PKEY_CTX\s0\fR will be created by \fBEVP_DigestSignInit()\fR if the passed \fBctx\fR
|
|
has already been assigned one via \fBEVP_MD_CTX_set_pkey_ctx\fR\|(3). See also \s-1\fBSM2\s0\fR\|(7).
|
|
.PP
|
|
Only \s-1EVP_PKEY\s0 types that support signing can be used with these functions. This
|
|
includes \s-1MAC\s0 algorithms where the \s-1MAC\s0 generation is considered as a form of
|
|
\&\*(L"signing\*(R". Built-in \s-1EVP_PKEY\s0 types supported by these functions are \s-1CMAC,\s0
|
|
Poly1305, \s-1DSA, ECDSA, HMAC, RSA,\s0 SipHash, Ed25519 and Ed448.
|
|
.PP
|
|
Not all digests can be used for all key types. The following combinations apply.
|
|
.IP "\s-1DSA\s0" 4
|
|
.IX Item "DSA"
|
|
Supports \s-1SHA1, SHA224, SHA256, SHA384\s0 and \s-1SHA512\s0
|
|
.IP "\s-1ECDSA\s0" 4
|
|
.IX Item "ECDSA"
|
|
Supports \s-1SHA1, SHA224, SHA256, SHA384, SHA512\s0 and \s-1SM3\s0
|
|
.IP "\s-1RSA\s0 with no padding" 4
|
|
.IX Item "RSA with no padding"
|
|
Supports no digests (the digest \fBtype\fR must be \s-1NULL\s0)
|
|
.IP "\s-1RSA\s0 with X931 padding" 4
|
|
.IX Item "RSA with X931 padding"
|
|
Supports \s-1SHA1, SHA256, SHA384\s0 and \s-1SHA512\s0
|
|
.IP "All other \s-1RSA\s0 padding types" 4
|
|
.IX Item "All other RSA padding types"
|
|
Support \s-1SHA1, SHA224, SHA256, SHA384, SHA512, MD5, MD5_SHA1, MD2, MD4, MDC2,
|
|
SHA3\-224, SHA3\-256, SHA3\-384, SHA3\-512\s0
|
|
.IP "Ed25519 and Ed448" 4
|
|
.IX Item "Ed25519 and Ed448"
|
|
Support no digests (the digest \fBtype\fR must be \s-1NULL\s0)
|
|
.IP "\s-1HMAC\s0" 4
|
|
.IX Item "HMAC"
|
|
Supports any digest
|
|
.IP "\s-1CMAC,\s0 Poly1305 and SipHash" 4
|
|
.IX Item "CMAC, Poly1305 and SipHash"
|
|
Will ignore any digest provided.
|
|
.PP
|
|
If RSA-PSS is used and restrictions apply then the digest must match.
|
|
.PP
|
|
\&\fBEVP_DigestSignUpdate()\fR hashes \fBcnt\fR bytes of data at \fBd\fR into the
|
|
signature context \fBctx\fR. This function can be called several times on the
|
|
same \fBctx\fR to include additional data. This function is currently implemented
|
|
using a macro.
|
|
.PP
|
|
\&\fBEVP_DigestSignFinal()\fR signs the data in \fBctx\fR and places the signature in \fBsig\fR.
|
|
If \fBsig\fR is \fB\s-1NULL\s0\fR then the maximum size of the output buffer is written to
|
|
the \fBsiglen\fR parameter. If \fBsig\fR is not \fB\s-1NULL\s0\fR then before the call the
|
|
\&\fBsiglen\fR parameter should contain the length of the \fBsig\fR buffer. If the
|
|
call is successful the signature is written to \fBsig\fR and the amount of data
|
|
written to \fBsiglen\fR.
|
|
.PP
|
|
\&\fBEVP_DigestSign()\fR signs \fBtbslen\fR bytes of data at \fBtbs\fR and places the
|
|
signature in \fBsig\fR and its length in \fBsiglen\fR in a similar way to
|
|
\&\fBEVP_DigestSignFinal()\fR.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fBEVP_DigestSignInit()\fR, \fBEVP_DigestSignUpdate()\fR, \fBEVP_DigestSignFinal()\fR and
|
|
\&\fBEVP_DigestSign()\fR return 1 for success and 0 for failure.
|
|
.PP
|
|
The error codes can be obtained from \fBERR_get_error\fR\|(3).
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
The \fB\s-1EVP\s0\fR interface to digital signatures should almost always be used in
|
|
preference to the low level interfaces. This is because the code then becomes
|
|
transparent to the algorithm used and much more flexible.
|
|
.PP
|
|
\&\fBEVP_DigestSign()\fR is a one shot operation which signs a single block of data
|
|
in one function. For algorithms that support streaming it is equivalent to
|
|
calling \fBEVP_DigestSignUpdate()\fR and \fBEVP_DigestSignFinal()\fR. For algorithms which
|
|
do not support streaming (e.g. PureEdDSA) it is the only way to sign data.
|
|
.PP
|
|
In previous versions of OpenSSL there was a link between message digest types
|
|
and public key algorithms. This meant that \*(L"clone\*(R" digests such as \fBEVP_dss1()\fR
|
|
needed to be used to sign using \s-1SHA1\s0 and \s-1DSA.\s0 This is no longer necessary and
|
|
the use of clone digest is now discouraged.
|
|
.PP
|
|
For some key types and parameters the random number generator must be seeded.
|
|
If the automatic seeding or reseeding of the OpenSSL \s-1CSPRNG\s0 fails due to
|
|
external circumstances (see \s-1\fBRAND\s0\fR\|(7)), the operation will fail.
|
|
.PP
|
|
The call to \fBEVP_DigestSignFinal()\fR internally finalizes a copy of the digest
|
|
context. This means that calls to \fBEVP_DigestSignUpdate()\fR and
|
|
\&\fBEVP_DigestSignFinal()\fR can be called later to digest and sign additional data.
|
|
.PP
|
|
Since only a copy of the digest context is ever finalized, the context must
|
|
be cleaned up after use by calling \fBEVP_MD_CTX_free()\fR or a memory leak
|
|
will occur.
|
|
.PP
|
|
The use of \fBEVP_PKEY_size()\fR with these functions is discouraged because some
|
|
signature operations may have a signature length which depends on the
|
|
parameters set. As a result \fBEVP_PKEY_size()\fR would have to return a value
|
|
which indicates the maximum possible signature for any set of parameters.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fBEVP_DigestVerifyInit\fR\|(3),
|
|
\&\fBEVP_DigestInit\fR\|(3),
|
|
\&\fBevp\fR\|(7), \s-1\fBHMAC\s0\fR\|(3), \s-1\fBMD2\s0\fR\|(3),
|
|
\&\s-1\fBMD5\s0\fR\|(3), \s-1\fBMDC2\s0\fR\|(3), \s-1\fBRIPEMD160\s0\fR\|(3),
|
|
\&\s-1\fBSHA1\s0\fR\|(3), \fBdgst\fR\|(1),
|
|
\&\s-1\fBRAND\s0\fR\|(7)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
\&\fBEVP_DigestSignInit()\fR, \fBEVP_DigestSignUpdate()\fR and \fBEVP_DigestSignFinal()\fR
|
|
were added in OpenSSL 1.0.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2006\-2020 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the OpenSSL license (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>.
|