987526c4e42fe075a622f39100f4f6d6ad2fbd9d
[openssl.git] / doc / man3 / EVP_SignInit.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_PKEY_size,
6 EVP_SignInit, EVP_SignInit_ex, EVP_SignUpdate, EVP_SignFinal,
7 EVP_PKEY_security_bits - EVP signing
8 functions
9
10 =head1 SYNOPSIS
11
12  #include <openssl/evp.h>
13
14  int EVP_SignInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
15  int EVP_SignUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt);
16  int EVP_SignFinal(EVP_MD_CTX *ctx, unsigned char *sig, unsigned int *s, EVP_PKEY *pkey);
17
18  void EVP_SignInit(EVP_MD_CTX *ctx, const EVP_MD *type);
19
20  int EVP_PKEY_size(EVP_PKEY *pkey);
21  int EVP_PKEY_security_bits(const EVP_PKEY *pkey);
22
23 =head1 DESCRIPTION
24
25 The EVP signature routines are a high level interface to digital
26 signatures.
27
28 EVP_SignInit_ex() sets up signing context B<ctx> to use digest
29 B<type> from ENGINE B<impl>. B<ctx> must be created with
30 EVP_MD_CTX_new() before calling this function.
31
32 EVP_SignUpdate() hashes B<cnt> bytes of data at B<d> into the
33 signature context B<ctx>. This function can be called several times on the
34 same B<ctx> to include additional data.
35
36 EVP_SignFinal() signs the data in B<ctx> using the private key B<pkey> and
37 places the signature in B<sig>. B<sig> must be at least EVP_PKEY_size(pkey)
38 bytes in size. B<s> is an OUT parameter, and not used as an IN parameter.
39 The number of bytes of data written (i.e. the length of the signature)
40 will be written to the integer at B<s>, at most EVP_PKEY_size(pkey) bytes
41 will be written.
42
43 EVP_SignInit() initializes a signing context B<ctx> to use the default
44 implementation of digest B<type>.
45
46 EVP_PKEY_size() returns the maximum size of a signature in bytes. The actual
47 signature returned by EVP_SignFinal() may be smaller.
48
49 EVP_PKEY_security_bits() returns the number of security bits of the given B<pkey>,
50 bits of security is defined in NIST SP800-57.
51
52 =head1 RETURN VALUES
53
54 EVP_SignInit_ex(), EVP_SignUpdate() and EVP_SignFinal() return 1
55 for success and 0 for failure.
56
57 EVP_PKEY_size() returns the maximum size of a signature in bytes.
58
59 The error codes can be obtained by L<ERR_get_error(3)>.
60
61 EVP_PKEY_security_bits() returns the number of security bits.
62
63 =head1 NOTES
64
65 The B<EVP> interface to digital signatures should almost always be used in
66 preference to the low level interfaces. This is because the code then becomes
67 transparent to the algorithm used and much more flexible.
68
69 Due to the link between message digests and public key algorithms the correct
70 digest algorithm must be used with the correct public key type. A list of
71 algorithms and associated public key algorithms appears in
72 L<EVP_DigestInit(3)>.
73
74 When signing with DSA private keys the random number generator must be seeded
75 or the operation will fail. The random number generator does not need to be
76 seeded for RSA signatures.
77
78 The call to EVP_SignFinal() internally finalizes a copy of the digest context.
79 This means that calls to EVP_SignUpdate() and EVP_SignFinal() can be called
80 later to digest and sign additional data.
81
82 Since only a copy of the digest context is ever finalized the context must
83 be cleaned up after use by calling EVP_MD_CTX_cleanup() or a memory leak
84 will occur.
85
86 =head1 BUGS
87
88 Older versions of this documentation wrongly stated that calls to
89 EVP_SignUpdate() could not be made after calling EVP_SignFinal().
90
91 Since the private key is passed in the call to EVP_SignFinal() any error
92 relating to the private key (for example an unsuitable key and digest
93 combination) will not be indicated until after potentially large amounts of
94 data have been passed through EVP_SignUpdate().
95
96 It is not possible to change the signing parameters using these function.
97
98 The previous two bugs are fixed in the newer EVP_SignDigest*() function.
99
100 =head1 SEE ALSO
101
102 L<EVP_VerifyInit(3)>,
103 L<EVP_DigestInit(3)>,
104 L<evp(7)>, L<HMAC(3)>, L<MD2(3)>,
105 L<MD5(3)>, L<MDC2(3)>, L<RIPEMD160(3)>,
106 L<SHA1(3)>, L<dgst(1)>
107
108 =head1 COPYRIGHT
109
110 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
111
112 Licensed under the OpenSSL license (the "License").  You may not use
113 this file except in compliance with the License.  You can obtain a copy
114 in the file LICENSE in the source distribution or at
115 L<https://www.openssl.org/source/license.html>.
116
117 =cut