TS_VERIFY_CTX_set_certs.pod 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. =pod
  2. =head1 NAME
  3. TS_VERIFY_CTX_set_certs, TS_VERIFY_CTS_set_certs
  4. - set certificates for TS response verification
  5. =head1 SYNOPSIS
  6. #include <openssl/ts.h>
  7. STACK_OF(X509) *TS_VERIFY_CTX_set_certs(TS_VERIFY_CTX *ctx,
  8. STACK_OF(X509) *certs);
  9. STACK_OF(X509) *TS_VERIFY_CTS_set_certs(TS_VERIFY_CTX *ctx,
  10. STACK_OF(X509) *certs);
  11. =head1 DESCRIPTION
  12. The Time-Stamp Protocol (TSP) is defined by RFC 3161. TSP is a protocol used to
  13. provide long term proof of the existence of a certain datum before a particular
  14. time. TSP defines a Time Stamping Authority (TSA) and an entity who shall make
  15. requests to the TSA. Usually the TSA is denoted as the server side and the
  16. requesting entity is denoted as the client.
  17. In TSP, when a server is sending a response to a client, the server normally
  18. needs to sign the response data - the TimeStampToken (TST) - with its private
  19. key. Then the client shall verify the received TST by the server's certificate
  20. chain.
  21. TS_VERIFY_CTX_set_certs() is used to set the server's certificate chain when
  22. verifying a TST. B<ctx> is the verification context created in advance and
  23. B<certs> is a stack of B<X509> certificates.
  24. TS_VERIFY_CTS_set_certs() is a misspelled version of TS_VERIFY_CTX_set_certs()
  25. which takes the same parameters and returns the same result.
  26. =head1 RETURN VALUES
  27. TS_VERIFY_CTX_set_certs() returns the stack of B<X509> certificates the user
  28. passes in via parameter B<certs>.
  29. =head1 SEE ALSO
  30. L<OSSL_ESS_check_signing_certs(3)>
  31. =head1 HISTORY
  32. The spelling of TS_VERIFY_CTX_set_certs() was corrected in OpenSSL 3.0.0.
  33. The misspelled version TS_VERIFY_CTS_set_certs() has been retained for
  34. compatibility reasons, but it is deprecated in OpenSSL 3.0.0.
  35. =head1 COPYRIGHT
  36. Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
  37. Licensed under the Apache License 2.0 (the "License"). You may not use
  38. this file except in compliance with the License. You can obtain a copy
  39. in the file LICENSE in the source distribution or at
  40. L<https://www.openssl.org/source/license.html>.
  41. =cut