1EVP_SIGNINIT(3)                     OpenSSL                    EVP_SIGNINIT(3)
2
3
4

NAME

6       EVP_PKEY_size, EVP_SignInit, EVP_SignInit_ex, EVP_SignUpdate,
7       EVP_SignFinal, EVP_PKEY_security_bits - EVP signing functions
8

SYNOPSIS

10        #include <openssl/evp.h>
11
12        int EVP_SignInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
13        int EVP_SignUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt);
14        int EVP_SignFinal(EVP_MD_CTX *ctx, unsigned char *sig, unsigned int *s, EVP_PKEY *pkey);
15
16        void EVP_SignInit(EVP_MD_CTX *ctx, const EVP_MD *type);
17
18        int EVP_PKEY_size(const EVP_PKEY *pkey);
19        int EVP_PKEY_security_bits(const EVP_PKEY *pkey);
20

DESCRIPTION

22       The EVP signature routines are a high level interface to digital
23       signatures.
24
25       EVP_SignInit_ex() sets up signing context ctx to use digest type from
26       ENGINE impl. ctx must be created with EVP_MD_CTX_new() before calling
27       this function.
28
29       EVP_SignUpdate() hashes cnt bytes of data at d into the signature
30       context ctx. This function can be called several times on the same ctx
31       to include additional data.
32
33       EVP_SignFinal() signs the data in ctx using the private key pkey and
34       places the signature in sig. sig must be at least EVP_PKEY_size(pkey)
35       bytes in size. s is an OUT parameter, and not used as an IN parameter.
36       The number of bytes of data written (i.e. the length of the signature)
37       will be written to the integer at s, at most EVP_PKEY_size(pkey) bytes
38       will be written.
39
40       EVP_SignInit() initializes a signing context ctx to use the default
41       implementation of digest type.
42
43       EVP_PKEY_size() returns the maximum size of a signature in bytes. The
44       actual signature returned by EVP_SignFinal() may be smaller.
45
46       EVP_PKEY_security_bits() returns the number of security bits of the
47       given pkey, bits of security is defined in NIST SP800-57.
48

RETURN VALUES

50       EVP_SignInit_ex(), EVP_SignUpdate() and EVP_SignFinal() return 1 for
51       success and 0 for failure.
52
53       EVP_PKEY_size() returns the maximum size of a signature in bytes.
54
55       The error codes can be obtained by ERR_get_error(3).
56
57       EVP_PKEY_security_bits() returns the number of security bits.
58

NOTES

60       The EVP interface to digital signatures should almost always be used in
61       preference to the low level interfaces. This is because the code then
62       becomes transparent to the algorithm used and much more flexible.
63
64       When signing with DSA private keys the random number generator must be
65       seeded.  If the automatic seeding or reseeding of the OpenSSL CSPRNG
66       fails due to external circumstances (see RAND(7)), the operation will
67       fail.  This requirement does not hold for RSA signatures.
68
69       The call to EVP_SignFinal() internally finalizes a copy of the digest
70       context.  This means that calls to EVP_SignUpdate() and EVP_SignFinal()
71       can be called later to digest and sign additional data.
72
73       Since only a copy of the digest context is ever finalized the context
74       must be cleaned up after use by calling EVP_MD_CTX_free() or a memory
75       leak will occur.
76

BUGS

78       Older versions of this documentation wrongly stated that calls to
79       EVP_SignUpdate() could not be made after calling EVP_SignFinal().
80
81       Since the private key is passed in the call to EVP_SignFinal() any
82       error relating to the private key (for example an unsuitable key and
83       digest combination) will not be indicated until after potentially large
84       amounts of data have been passed through EVP_SignUpdate().
85
86       It is not possible to change the signing parameters using these
87       function.
88
89       The previous two bugs are fixed in the newer EVP_SignDigest*()
90       function.
91

SEE ALSO

93       EVP_VerifyInit(3), EVP_DigestInit(3), evp(7), HMAC(3), MD2(3), MD5(3),
94       MDC2(3), RIPEMD160(3), SHA1(3), dgst(1)
95

97       Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
98
99       Licensed under the OpenSSL license (the "License").  You may not use
100       this file except in compliance with the License.  You can obtain a copy
101       in the file LICENSE in the source distribution or at
102       <https://www.openssl.org/source/license.html>.
103
104
105
1061.1.1d                            2019-10-03                   EVP_SIGNINIT(3)
Impressum