OSSL_CMP_CTX_snprint_PKIStatus.pod 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. =pod
  2. =head1 NAME
  3. OSSL_CMP_CTX_snprint_PKIStatus
  4. - function(s) for managing the CMP PKIStatus
  5. =head1 SYNOPSIS
  6. #include <openssl/cmp.h>
  7. char *OSSL_CMP_CTX_snprint_PKIStatus(OSSL_CMP_CTX *ctx, char *buf, int bufsize);
  8. =head1 DESCRIPTION
  9. This is the PKIStatus API for using CMP (Certificate Management Protocol) with
  10. OpenSSL.
  11. OSSL_CMP_CTX_snprint_PKIStatus() takes the PKIStatusInfo components contained
  12. in the given CMP context and places a human-readable string created from them
  13. in the given buffer, with the given maximal length.
  14. On success it returns a copy of the buffer pointer containing the string.
  15. =head1 NOTES
  16. CMP is defined in RFC 4210 (and CRMF in RFC 4211).
  17. =head1 RETURN VALUES
  18. OSSL_CMP_CTX_snprint_PKIStatus()
  19. returns the intended pointer value as described above or NULL on error.
  20. =head1 HISTORY
  21. The OpenSSL CMP support was added in OpenSSL 3.0.
  22. =head1 COPYRIGHT
  23. Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
  24. Licensed under the Apache License 2.0 (the "License"). You may not use
  25. this file except in compliance with the License. You can obtain a copy
  26. in the file LICENSE in the source distribution or at
  27. L<https://www.openssl.org/source/license.html>.
  28. =cut