doc/man3/EVP_DigestSignInit.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_DigestSignInit_with_libctx, EVP_DigestSignInit, EVP_DigestSignUpdate,
   6 EVP_DigestSignFinal, EVP_DigestSign - EVP signing functions
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/evp.h>
  11
  12  int EVP_DigestSignInit_with_libctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
  13                                     const char *mdname,
  14                                     OPENSSL_CTX *libctx, const char *props,
  15                                     EVP_PKEY *pkey);
  16  int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
  17                         const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey);
  18  int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
  19  int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen);
  20
  21  int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret,
  22                     size_t *siglen, const unsigned char *tbs,
  23                     size_t tbslen);
  24
  25 =head1 DESCRIPTION
  26
  27 The EVP signature routines are a high-level interface to digital signatures.
  28 Input data is digested first before the signing takes place.
  29
  30 EVP_DigestSignInit_with_libctx() sets up signing context I<ctx> to use a digest
  31 with the name I<mdname> and private key I<pkey>. The name of the digest to be
  32 used is passed to the provider of the signature algorithm in use. How that
  33 provider interprets the digest name is provider specific. The provider may
  34 implement that digest directly itself or it may (optionally) choose to fetch it
  35 (which could result in a digest from a different provider being selected). If the
  36 provider supports fetching the digest then it may use the I<props> argument for
  37 the properties to be used during the fetch.
  38
  39 The I<pkey> algorithm is used to fetch a B<EVP_SIGNATURE> method implicitly, to
  40 be used for the actual signing. See L<provider(7)/Implicit fetch> for
  41 more information about implicit fetches.
  42
  43 The OpenSSL default and legacy providers support fetching digests and can fetch
  44 those digests from any available provider. The OpenSSL fips provider also
  45 supports fetching digests but will only fetch digests that are themselves
  46 implemented inside the fips provider.
  47
  48 I<ctx> must be created with EVP_MD_CTX_new() before calling this function. If
  49 I<pctx> is not NULL, the EVP_PKEY_CTX of the signing operation will be written
  50 to I<*pctx>: this can be used to set alternative signing options. Note that any
  51 existing value in I<*pctx> is overwritten. The EVP_PKEY_CTX value returned must
  52 not be freed directly by the application if I<ctx> is not assigned an
  53 EVP_PKEY_CTX value before being passed to EVP_DigestSignInit_with_libctx()
  54 (which means the EVP_PKEY_CTX is created inside EVP_DigestSignInit_with_libctx()
  55 and it will be freed automatically when the EVP_MD_CTX is freed). If the
  56 EVP_PKEY_CTX to be used is created by EVP_DigestSignInit_with_libctx then it
  57 will use the B<OPENSSL_CTX> specified in I<libctx> and the property query string
  58 specified in I<props>.
  59
  60 The digest I<mdname> may be NULL if the signing algorithm supports it. The
  61 I<props> argument can always be NULL.
  62
  63 No B<EVP_PKEY_CTX> will be created by EVP_DigestSignInit_with_libctx() if the
  64 passed I<ctx> has already been assigned one via L<EVP_MD_CTX_set_pkey_ctx(3)>.
  65 See also L<SM2(7)>.
  66
  67 Only EVP_PKEY types that support signing can be used with these functions. This
  68 includes MAC algorithms where the MAC generation is considered as a form of
  69 "signing". Built-in EVP_PKEY types supported by these functions are CMAC,
  70 Poly1305, DSA, ECDSA, HMAC, RSA, SipHash, Ed25519 and Ed448.
  71
  72 Not all digests can be used for all key types. The following combinations apply.
  73
  74 =over 4
  75
  76 =item DSA
  77
  78 Supports SHA1, SHA224, SHA256, SHA384 and SHA512
  79
  80 =item ECDSA
  81
  82 Supports SHA1, SHA224, SHA256, SHA384, SHA512 and SM3
  83
  84 =item RSA with no padding
  85
  86 Supports no digests (the digest I<type> must be NULL)
  87
  88 =item RSA with X931 padding
  89
  90 Supports SHA1, SHA256, SHA384 and SHA512
  91
  92 =item All other RSA padding types
  93
  94 Support SHA1, SHA224, SHA256, SHA384, SHA512, MD5, MD5_SHA1, MD2, MD4, MDC2,
  95 SHA3-224, SHA3-256, SHA3-384, SHA3-512
  96
  97 =item Ed25519 and Ed448
  98
  99 Support no digests (the digest I<type> must be NULL)
 100
 101 =item HMAC
 102
 103 Supports any digest
 104
 105 =item CMAC, Poly1305 and SipHash
 106
 107 Will ignore any digest provided.
 108
 109 =back
 110
 111 If RSA-PSS is used and restrictions apply then the digest must match.
 112
 113 EVP_DigestSignInit() works in the same way as EVP_DigestSignInit_with_libctx()
 114 except that the I<mdname> parameter will be inferred from the supplied
 115 digest I<type>, and I<props> will be NULL. Where supplied the ENGINE I<e> will
 116 be used for the signing and digest algorithm implementations. I<e> may be NULL.
 117
 118 EVP_DigestSignUpdate() hashes I<cnt> bytes of data at I<d> into the
 119 signature context I<ctx>. This function can be called several times on the
 120 same I<ctx> to include additional data.
 121
 122 EVP_DigestSignFinal() signs the data in I<ctx> and places the signature in I<sig>.
 123 If I<sig> is NULL then the maximum size of the output buffer is written to
 124 the I<siglen> parameter. If I<sig> is not NULL then before the call the
 125 I<siglen> parameter should contain the length of the I<sig> buffer. If the
 126 call is successful the signature is written to I<sig> and the amount of data
 127 written to I<siglen>.
 128
 129 EVP_DigestSign() signs I<tbslen> bytes of data at I<tbs> and places the
 130 signature in I<sig> and its length in I<siglen> in a similar way to
 131 EVP_DigestSignFinal().
 132
 133 =head1 RETURN VALUES
 134
 135 EVP_DigestSignInit(), EVP_DigestSignUpdate(), EVP_DigestSignFinal() and
 136 EVP_DigestSign() return 1 for success and 0 for failure.
 137
 138 The error codes can be obtained from L<ERR_get_error(3)>.
 139
 140 =head1 NOTES
 141
 142 The B<EVP> interface to digital signatures should almost always be used in
 143 preference to the low-level interfaces. This is because the code then becomes
 144 transparent to the algorithm used and much more flexible.
 145
 146 EVP_DigestSign() is a one shot operation which signs a single block of data
 147 in one function. For algorithms that support streaming it is equivalent to
 148 calling EVP_DigestSignUpdate() and EVP_DigestSignFinal(). For algorithms which
 149 do not support streaming (e.g. PureEdDSA) it is the only way to sign data.
 150
 151 In previous versions of OpenSSL there was a link between message digest types
 152 and public key algorithms. This meant that "clone" digests such as EVP_dss1()
 153 needed to be used to sign using SHA1 and DSA. This is no longer necessary and
 154 the use of clone digest is now discouraged.
 155
 156 For some key types and parameters the random number generator must be seeded.
 157 If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
 158 external circumstances (see L<RAND(7)>), the operation will fail.
 159
 160 The call to EVP_DigestSignFinal() internally finalizes a copy of the digest
 161 context. This means that calls to EVP_DigestSignUpdate() and
 162 EVP_DigestSignFinal() can be called later to digest and sign additional data.
 163
 164 Since only a copy of the digest context is ever finalized, the context must
 165 be cleaned up after use by calling EVP_MD_CTX_free() or a memory leak
 166 will occur.
 167
 168 The use of EVP_PKEY_size() with these functions is discouraged because some
 169 signature operations may have a signature length which depends on the
 170 parameters set. As a result EVP_PKEY_size() would have to return a value
 171 which indicates the maximum possible signature for any set of parameters.
 172
 173 =head1 SEE ALSO
 174
 175 L<EVP_DigestVerifyInit(3)>,
 176 L<EVP_DigestInit(3)>,
 177 L<evp(7)>, L<HMAC(3)>, L<MD2(3)>,
 178 L<MD5(3)>, L<MDC2(3)>, L<RIPEMD160(3)>,
 179 L<SHA1(3)>, L<openssl-dgst(1)>,
 180 L<RAND(7)>
 181
 182 =head1 HISTORY
 183
 184 EVP_DigestSignInit(), EVP_DigestSignUpdate() and EVP_DigestSignFinal()
 185 were added in OpenSSL 1.0.0.
 186
 187 EVP_DigestSignInit_with_libctx() was added in OpenSSL 3.0.
 188
 189 EVP_DigestSignUpdate() was converted from a macro to a function in OpenSSL 3.0.
 190
 191 =head1 COPYRIGHT
 192
 193 Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
 194
 195 Licensed under the Apache License 2.0 (the "License").  You may not use
 196 this file except in compliance with the License.  You can obtain a copy
 197 in the file LICENSE in the source distribution or at
 198 L<https://www.openssl.org/source/license.html>.
 199
 200 =cut