doc/man3/EVP_SignInit.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_SignInit, EVP_SignInit_ex, EVP_SignUpdate, EVP_SignFinal
   6 - EVP signing functions
   7
   8 =head1 SYNOPSIS
   9
  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 =head1 DESCRIPTION
  19
  20 The EVP signature routines are a high level interface to digital
  21 signatures.
  22
  23 EVP_SignInit_ex() sets up signing context B<ctx> to use digest
  24 B<type> from ENGINE B<impl>. B<ctx> must be created with
  25 EVP_MD_CTX_new() before calling this function.
  26
  27 EVP_SignUpdate() hashes B<cnt> bytes of data at B<d> into the
  28 signature context B<ctx>. This function can be called several times on the
  29 same B<ctx> to include additional data.
  30
  31 EVP_SignFinal() signs the data in B<ctx> using the private key B<pkey> and
  32 places the signature in B<sig>. B<sig> must be at least C<EVP_PKEY_size(pkey)>
  33 bytes in size. B<s> is an OUT parameter, and not used as an IN parameter.
  34 The number of bytes of data written (i.e. the length of the signature)
  35 will be written to the integer at B<s>, at most C<EVP_PKEY_size(pkey)> bytes
  36 will be written.
  37
  38 EVP_SignInit() initializes a signing context B<ctx> to use the default
  39 implementation of digest B<type>.
  40
  41 =head1 RETURN VALUES
  42
  43 EVP_SignInit_ex(), EVP_SignUpdate() and EVP_SignFinal() return 1
  44 for success and 0 for failure.
  45
  46 The error codes can be obtained by L<ERR_get_error(3)>.
  47
  48 =head1 NOTES
  49
  50 The B<EVP> interface to digital signatures should almost always be used in
  51 preference to the low level interfaces. This is because the code then becomes
  52 transparent to the algorithm used and much more flexible.
  53
  54 When signing with DSA private keys the random number generator must be seeded.
  55 If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
  56 external circumstances (see L<RAND(7)>), the operation will fail.
  57 This requirement does not hold for RSA signatures.
  58
  59 The call to EVP_SignFinal() internally finalizes a copy of the digest context.
  60 This means that calls to EVP_SignUpdate() and EVP_SignFinal() can be called
  61 later to digest and sign additional data.
  62
  63 Since only a copy of the digest context is ever finalized the context must
  64 be cleaned up after use by calling EVP_MD_CTX_free() or a memory leak
  65 will occur.
  66
  67 =head1 BUGS
  68
  69 Older versions of this documentation wrongly stated that calls to
  70 EVP_SignUpdate() could not be made after calling EVP_SignFinal().
  71
  72 Since the private key is passed in the call to EVP_SignFinal() any error
  73 relating to the private key (for example an unsuitable key and digest
  74 combination) will not be indicated until after potentially large amounts of
  75 data have been passed through EVP_SignUpdate().
  76
  77 It is not possible to change the signing parameters using these function.
  78
  79 The previous two bugs are fixed in the newer EVP_SignDigest*() function.
  80
  81 =head1 SEE ALSO
  82
  83 L<EVP_PKEY_size(3)>, L<EVP_PKEY_bits(3)>, L<EVP_PKEY_security_bits(3)>,
  84 L<EVP_VerifyInit(3)>,
  85 L<EVP_DigestInit(3)>,
  86 L<evp(7)>, L<HMAC(3)>, L<MD2(3)>,
  87 L<MD5(3)>, L<MDC2(3)>, L<RIPEMD160(3)>,
  88 L<SHA1(3)>, L<openssl-dgst(1)>
  89
  90 =head1 COPYRIGHT
  91
  92 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
  93
  94 Licensed under the Apache License 2.0 (the "License").  You may not use
  95 this file except in compliance with the License.  You can obtain a copy
  96 in the file LICENSE in the source distribution or at
  97 L<https://www.openssl.org/source/license.html>.
  98
  99 =cut