OSSL_CMP_HDR_get0_transactionID.pod 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. =pod
  2. =head1 NAME
  3. OSSL_CMP_HDR_get0_transactionID,
  4. OSSL_CMP_HDR_get0_recipNonce,
  5. OSSL_CMP_HDR_get0_geninfo_ITAVs
  6. - functions manipulating CMP message headers
  7. =head1 SYNOPSIS
  8. #include <openssl/cmp.h>
  9. ASN1_OCTET_STRING *OSSL_CMP_HDR_get0_transactionID(const
  10. OSSL_CMP_PKIHEADER *hdr);
  11. ASN1_OCTET_STRING *OSSL_CMP_HDR_get0_recipNonce(const
  12. OSSL_CMP_PKIHEADER *hdr);
  13. STACK_OF(OSSL_CMP_ITAV)
  14. *OSSL_CMP_HDR_get0_geninfo_ITAVs(const OSSL_CMP_PKIHEADER *hdr);
  15. =head1 DESCRIPTION
  16. OSSL_CMP_HDR_get0_transactionID returns the transaction ID of the given
  17. PKIHeader.
  18. OSSL_CMP_HDR_get0_recipNonce returns the recipient nonce of the given PKIHeader.
  19. OSSL_CMP_HDR_get0_geninfo_ITAVs() returns the list of ITAVs
  20. in the generalInfo field of the given PKIHeader.
  21. =head1 NOTES
  22. CMP is defined in RFC 4210.
  23. =head1 RETURN VALUES
  24. The functions return the intended pointer value as described above
  25. or NULL if the respective entry does not exist and on error.
  26. =head1 HISTORY
  27. The OpenSSL CMP support was added in OpenSSL 3.0.
  28. OSSL_CMP_HDR_get0_geninfo_ITAVs() was added in OpenSSL 3.3.
  29. =head1 COPYRIGHT
  30. Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
  31. Licensed under the Apache License 2.0 (the "License"). You may not use
  32. this file except in compliance with the License. You can obtain a copy
  33. in the file LICENSE in the source distribution or at
  34. L<https://www.openssl.org/source/license.html>.
  35. =cut