EVP_PKEY_verify.pod 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. =pod
  2. =head1 NAME
  3. EVP_PKEY_verify_init, EVP_PKEY_verify - signature verification using a public key algorithm
  4. =head1 SYNOPSIS
  5. #include <openssl/evp.h>
  6. int EVP_PKEY_verify_init(EVP_PKEY_CTX *ctx);
  7. int EVP_PKEY_verify(EVP_PKEY_CTX *ctx,
  8. const unsigned char *sig, size_t siglen,
  9. const unsigned char *tbs, size_t tbslen);
  10. =head1 DESCRIPTION
  11. The EVP_PKEY_verify_init() function initializes a public key algorithm
  12. context using key B<pkey> for a signature verification operation.
  13. The EVP_PKEY_verify() function performs a public key verification operation
  14. using B<ctx>. The signature is specified using the B<sig> and
  15. B<siglen> parameters. The verified data (i.e. the data believed originally
  16. signed) is specified using the B<tbs> and B<tbslen> parameters.
  17. =head1 NOTES
  18. After the call to EVP_PKEY_verify_init() algorithm specific control
  19. operations can be performed to set any appropriate parameters for the
  20. operation.
  21. The function EVP_PKEY_verify() can be called more than once on the same
  22. context if several operations are performed using the same parameters.
  23. =head1 RETURN VALUES
  24. EVP_PKEY_verify_init() and EVP_PKEY_verify() return 1 if the verification was
  25. successful and 0 if it failed. Unlike other functions the return value 0 from
  26. EVP_PKEY_verify() only indicates that the signature did not not verify
  27. successfully (that is tbs did not match the original data or the signature was
  28. of invalid form) it is not an indication of a more serious error.
  29. A negative value indicates an error other that signature verification failure.
  30. In particular a return value of -2 indicates the operation is not supported by
  31. the public key algorithm.
  32. =head1 EXAMPLE
  33. Verify signature using PKCS#1 and SHA256 digest:
  34. #include <openssl/evp.h>
  35. #include <openssl/rsa.h>
  36. EVP_PKEY_CTX *ctx;
  37. unsigned char *md, *sig;
  38. size_t mdlen, siglen;
  39. EVP_PKEY *verify_key;
  40. /* NB: assumes verify_key, sig, siglen md and mdlen are already set up
  41. * and that verify_key is an RSA public key
  42. */
  43. ctx = EVP_PKEY_CTX_new(verify_key);
  44. if (!ctx)
  45. /* Error occurred */
  46. if (EVP_PKEY_verify_init(ctx) <= 0)
  47. /* Error */
  48. if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PADDING) <= 0)
  49. /* Error */
  50. if (EVP_PKEY_CTX_set_signature_md(ctx, EVP_sha256()) <= 0)
  51. /* Error */
  52. /* Perform operation */
  53. ret = EVP_PKEY_verify(ctx, sig, siglen, md, mdlen);
  54. /* ret == 1 indicates success, 0 verify failure and < 0 for some
  55. * other error.
  56. */
  57. =head1 SEE ALSO
  58. L<EVP_PKEY_CTX_new(3)>,
  59. L<EVP_PKEY_encrypt(3)>,
  60. L<EVP_PKEY_decrypt(3)>,
  61. L<EVP_PKEY_sign(3)>,
  62. L<EVP_PKEY_verify_recover(3)>,
  63. L<EVP_PKEY_derive(3)>
  64. =head1 HISTORY
  65. These functions were first added to OpenSSL 1.0.0.
  66. =head1 COPYRIGHT
  67. Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
  68. Licensed under the OpenSSL license (the "License"). You may not use
  69. this file except in compliance with the License. You can obtain a copy
  70. in the file LICENSE in the source distribution or at
  71. L<https://www.openssl.org/source/license.html>.
  72. =cut