OSSL_CRMF_MSG_set1_regInfo_certReq.pod 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. =pod
  2. =head1 NAME
  3. OSSL_CRMF_MSG_get0_regInfo_utf8Pairs,
  4. OSSL_CRMF_MSG_set1_regInfo_utf8Pairs,
  5. OSSL_CRMF_MSG_get0_regInfo_certReq,
  6. OSSL_CRMF_MSG_set1_regInfo_certReq
  7. - functions getting or setting CRMF Registration Info
  8. =head1 SYNOPSIS
  9. #include <openssl/crmf.h>
  10. ASN1_UTF8STRING
  11. *OSSL_CRMF_MSG_get0_regInfo_utf8Pairs(const OSSL_CRMF_MSG *msg);
  12. int OSSL_CRMF_MSG_set1_regInfo_utf8Pairs(OSSL_CRMF_MSG *msg,
  13. const ASN1_UTF8STRING *utf8pairs);
  14. OSSL_CRMF_CERTREQUEST
  15. *OSSL_CRMF_MSG_get0_regInfo_certReq(const OSSL_CRMF_MSG *msg);
  16. int OSSL_CRMF_MSG_set1_regInfo_certReq(OSSL_CRMF_MSG *msg,
  17. const OSSL_CRMF_CERTREQUEST *cr);
  18. =head1 DESCRIPTION
  19. OSSL_CRMF_MSG_get0_regInfo_utf8Pairs() returns the first utf8Pairs regInfo
  20. in the given I<msg>, if present.
  21. OSSL_CRMF_MSG_set1_regInfo_utf8Pairs() adds a copy of the given I<utf8pairs>
  22. value as utf8Pairs regInfo to the given I<msg>. See RFC 4211 section 7.1.
  23. OSSL_CRMF_MSG_get0_regInfo_certReq() returns the first certReq regInfo
  24. in the given I<msg>, if present.
  25. OSSL_CRMF_MSG_set1_regInfo_certReq() adds a copy of the given I<cr> value
  26. as certReq regInfo to the given I<msg>. See RFC 4211 section 7.2.
  27. =head1 RETURN VALUES
  28. All get0_*() functions return the respective pointer value, NULL if not present.
  29. All set1_*() functions return 1 on success, 0 on error.
  30. =head1 NOTES
  31. Calling the set1_*() functions multiple times
  32. adds multiple instances of the respective
  33. control to the regInfo structure of the given I<msg>. While RFC 4211 expects
  34. multiple utf8Pairs in one regInfo structure, it does not allow multiple certReq.
  35. =head1 SEE ALSO
  36. RFC 4211
  37. =head1 HISTORY
  38. The OpenSSL CRMF support was added in OpenSSL 3.0.
  39. =head1 COPYRIGHT
  40. Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
  41. Licensed under the Apache License 2.0 (the "License"). You may not use
  42. this file except in compliance with the License. You can obtain a copy
  43. in the file LICENSE in the source distribution or at
  44. L<https://www.openssl.org/source/license.html>.
  45. =cut