doc/crypto/EVP_DigestVerifyInit.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_DigestVerifyInit, EVP_DigestVerifyUpdate, EVP_DigestVerifyFinal - EVP signature verification functions
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/evp.h>
  10
  11  int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
  12                         const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey);
  13  int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
  14  int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig, size_t siglen);
  15
  16 =head1 DESCRIPTION
  17
  18 The EVP signature routines are a high level interface to digital signatures.
  19
  20 EVP_DigestVerifyInit() sets up verification context B<ctx> to use digest
  21 B<type> from ENGINE B<impl> and public key B<pkey>. B<ctx> must be created
  22 with EVP_MD_CTX_new() before calling this function. If B<pctx> is not NULL, the
  23 EVP_PKEY_CTX of the verification operation will be written to B<*pctx>: this
  24 can be used to set alternative verification options. Note that any existing
  25 value in B<*pctx> is overwritten. The EVP_PKEY_CTX value returned must not be
  26 freed directly by the application (it will be freed automatically when the
  27 EVP_MD_CTX is freed).
  28
  29 EVP_DigestVerifyUpdate() hashes B<cnt> bytes of data at B<d> into the
  30 verification context B<ctx>. This function can be called several times on the
  31 same B<ctx> to include additional data. This function is currently implemented
  32 using a macro.
  33
  34 EVP_DigestVerifyFinal() verifies the data in B<ctx> against the signature in
  35 B<sig> of length B<siglen>.
  36
  37 =head1 RETURN VALUES
  38
  39 EVP_DigestVerifyInit() and EVP_DigestVerifyUpdate() return 1 for success and 0
  40 for failure.
  41
  42 EVP_DigestVerifyFinal() returns 1 for success; any other value indicates
  43 failure.  A return value of zero indicates that the signature did not verify
  44 successfully (that is, tbs did not match the original data or the signature had
  45 an invalid form), while other values indicate a more serious error (and
  46 sometimes also indicate an invalid signature form).
  47
  48 The error codes can be obtained from L<ERR_get_error(3)>.
  49
  50 =head1 NOTES
  51
  52 The B<EVP> interface to digital signatures should almost always be used in
  53 preference to the low level interfaces. This is because the code then becomes
  54 transparent to the algorithm used and much more flexible.
  55
  56 In previous versions of OpenSSL there was a link between message digest types
  57 and public key algorithms. This meant that "clone" digests such as EVP_dss1()
  58 needed to be used to sign using SHA1 and DSA. This is no longer necessary and
  59 the use of clone digest is now discouraged.
  60
  61 For some key types and parameters the random number generator must be seeded
  62 or the operation will fail.
  63
  64 The call to EVP_DigestVerifyFinal() internally finalizes a copy of the digest
  65 context. This means that EVP_VerifyUpdate() and EVP_VerifyFinal() can
  66 be called later to digest and verify additional data.
  67
  68 Since only a copy of the digest context is ever finalized, the context must
  69 be cleaned up after use by calling EVP_MD_CTX_cleanup() or a memory leak
  70 will occur.
  71
  72 =head1 SEE ALSO
  73
  74 L<EVP_DigestSignInit(3)>,
  75 L<EVP_DigestInit(3)>,
  76 L<evp(7)>, L<HMAC(3)>, L<MD2(3)>,
  77 L<MD5(3)>, L<MDC2(3)>, L<RIPEMD160(3)>,
  78 L<SHA1(3)>, L<dgst(1)>
  79
  80 =head1 HISTORY
  81
  82 EVP_DigestVerifyInit(), EVP_DigestVerifyUpdate() and EVP_DigestVerifyFinal()
  83 were first added to OpenSSL 1.0.0.
  84
  85 =head1 COPYRIGHT
  86
  87 Copyright 2006-2017 The OpenSSL Project Authors. All Rights Reserved.
  88
  89 Licensed under the OpenSSL license (the "License").  You may not use
  90 this file except in compliance with the License.  You can obtain a copy
  91 in the file LICENSE in the source distribution or at
  92 L<https://www.openssl.org/source/license.html>.
  93
  94 =cut