EVP_DigestSignInit.pod 5.9 KB
Newer Older
1 2 3 4
=pod

=head1 NAME

5 6
EVP_DigestSignInit, EVP_DigestSignUpdate, EVP_DigestSignFinal,
EVP_DigestSign - EVP signing functions
7 8 9 10 11 12

=head1 SYNOPSIS

 #include <openssl/evp.h>

 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
R
Rich Salz 已提交
13
                        const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey);
14
 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
15 16
 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen);

17 18 19 20
 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret,
                    size_t *siglen, const unsigned char *tbs,
                    size_t tbslen);

21 22 23 24 25
=head1 DESCRIPTION

The EVP signature routines are a high level interface to digital signatures.

EVP_DigestSignInit() sets up signing context B<ctx> to use digest B<type> from
P
Paul Yang 已提交
26
ENGINE B<e> and private key B<pkey>. B<ctx> must be created with
27
EVP_MD_CTX_new() before calling this function. If B<pctx> is not NULL, the
28
EVP_PKEY_CTX of the signing operation will be written to B<*pctx>: this can
29 30
be used to set alternative signing options. Note that any existing value in
B<*pctx> is overwritten. The EVP_PKEY_CTX value returned must not be freed
P
Paul Yang 已提交
31 32 33 34 35 36 37
directly by the application if B<ctx> is not assigned an EVP_PKEY_CTX value before
being passed to EVP_DigestSignInit() (which means the EVP_PKEY_CTX is created
inside EVP_DigestSignInit() and it will be freed automatically when the
EVP_MD_CTX is freed).

The digest B<type> may be NULL if the signing algorithm supports it.

A
Antoine Cœur 已提交
38
No B<EVP_PKEY_CTX> will be created by EVP_DigestSignInit() if the passed B<ctx>
M
moehuster 已提交
39
has already been assigned one via L<EVP_MD_CTX_set_pkey_ctx(3)>. See also L<SM2(7)>.
M
Matt Caswell 已提交
40 41 42

Only EVP_PKEY types that support signing can be used with these functions. This
includes MAC algorithms where the MAC generation is considered as a form of
P
parasssh 已提交
43
"signing". Built-in EVP_PKEY types supported by these functions are CMAC,
44
Poly1305, DSA, ECDSA, HMAC, RSA, SipHash, Ed25519 and Ed448.
M
Matt Caswell 已提交
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85

Not all digests can be used for all key types. The following combinations apply.

=over 4

=item DSA

Supports SHA1, SHA224, SHA256, SHA384 and SHA512

=item ECDSA

Supports SHA1, SHA224, SHA256, SHA384, SHA512 and SM3

=item RSA with no padding

Supports no digests (the digest B<type> must be NULL)

=item RSA with X931 padding

Supports SHA1, SHA256, SHA384 and SHA512

=item All other RSA padding types

Support SHA1, SHA224, SHA256, SHA384, SHA512, MD5, MD5_SHA1, MD2, MD4, MDC2,
SHA3-224, SHA3-256, SHA3-384, SHA3-512

=item Ed25519 and Ed448

Support no digests (the digest B<type> must be NULL)

=item HMAC

Supports any digest

=item CMAC, Poly1305 and SipHash

Will ignore any digest provided.

=back

If RSA-PSS is used and restrictions apply then the digest must match.
86 87 88 89

EVP_DigestSignUpdate() hashes B<cnt> bytes of data at B<d> into the
signature context B<ctx>. This function can be called several times on the
same B<ctx> to include additional data. This function is currently implemented
90
using a macro.
91

P
parasssh 已提交
92
EVP_DigestSignFinal() signs the data in B<ctx> and places the signature in B<sig>.
93 94
If B<sig> is B<NULL> then the maximum size of the output buffer is written to
the B<siglen> parameter. If B<sig> is not B<NULL> then before the call the
P
parasssh 已提交
95
B<siglen> parameter should contain the length of the B<sig> buffer. If the
96 97 98
call is successful the signature is written to B<sig> and the amount of data
written to B<siglen>.

99
EVP_DigestSign() signs B<tbslen> bytes of data at B<tbs> and places the
J
Josh Soref 已提交
100
signature in B<sig> and its length in B<siglen> in a similar way to
101 102
EVP_DigestSignFinal().

103 104
=head1 RETURN VALUES

105
EVP_DigestSignInit(), EVP_DigestSignUpdate(), EVP_DigestSignaFinal() and
106
EVP_DigestSign() return 1 for success and 0 for failure.
107

R
Rich Salz 已提交
108
The error codes can be obtained from L<ERR_get_error(3)>.
109 110 111 112 113 114 115

=head1 NOTES

The B<EVP> 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.

D
Dr. Stephen Henson 已提交
116 117 118 119
EVP_DigestSign() 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 EVP_DigestSignUpdate() and EVP_DigestSignFinal(). For algorithms which
do not support streaming (e.g. PureEdDSA) it is the only way to sign data.
120

121 122 123 124 125
In previous versions of OpenSSL there was a link between message digest types
and public key algorithms. This meant that "clone" digests such as EVP_dss1()
needed to be used to sign using SHA1 and DSA. This is no longer necessary and
the use of clone digest is now discouraged.

126 127 128
For some key types and parameters the random number generator must be seeded.
If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
external circumstances (see L<RAND(7)>), the operation will fail.
129 130 131 132 133

The call to EVP_DigestSignFinal() internally finalizes a copy of the digest
context. This means that calls to EVP_DigestSignUpdate() and
EVP_DigestSignFinal() can be called later to digest and sign additional data.

P
parasssh 已提交
134
Since only a copy of the digest context is ever finalized, the context must
135
be cleaned up after use by calling EVP_MD_CTX_free() or a memory leak
136 137 138 139 140 141 142 143 144
will occur.

The use of EVP_PKEY_size() with these functions is discouraged because some
signature operations may have a signature length which depends on the
parameters set. As a result EVP_PKEY_size() would have to return a value
which indicates the maximum possible signature for any set of parameters.

=head1 SEE ALSO

R
Rich Salz 已提交
145
L<EVP_DigestVerifyInit(3)>,
146
L<EVP_DigestInit(3)>,
147 148
L<evp(7)>, L<HMAC(3)>, L<MD2(3)>,
L<MD5(3)>, L<MDC2(3)>, L<RIPEMD160(3)>,
149 150
L<SHA1(3)>, L<dgst(1)>,
L<RAND(7)>
151 152 153

=head1 HISTORY

R
Rich Salz 已提交
154
EVP_DigestSignInit(), EVP_DigestSignUpdate() and EVP_DigestSignFinal()
155
were added in OpenSSL 1.0.0.
156

R
Rich Salz 已提交
157 158
=head1 COPYRIGHT

M
Matt Caswell 已提交
159
Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved.
R
Rich Salz 已提交
160 161 162 163 164 165 166

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut