OSSL_CRMF_MSG_get0_tmpl.pod 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. =pod
  2. =head1 NAME
  3. OSSL_CRMF_MSG_get0_tmpl,
  4. OSSL_CRMF_CERTTEMPLATE_get0_serialNumber,
  5. OSSL_CRMF_CERTTEMPLATE_get0_issuer,
  6. OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert,
  7. OSSL_CRMF_MSG_get_certReqId
  8. - functions reading from CRMF CertReqMsg structures
  9. =head1 SYNOPSIS
  10. #include <openssl/crmf.h>
  11. OSSL_CRMF_CERTTEMPLATE *OSSL_CRMF_MSG_get0_tmpl(const OSSL_CRMF_MSG *crm);
  12. ASN1_INTEGER
  13. *OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(OSSL_CRMF_CERTTEMPLATE *tmpl);
  14. X509_NAME *OSSL_CRMF_CERTTEMPLATE_get0_issuer(OSSL_CRMF_CERTTEMPLATE *tmpl);
  15. X509 *OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(OSSL_CRMF_ENCRYPTEDVALUE *ecert,
  16. EVP_PKEY *pkey);
  17. int OSSL_CRMF_MSG_get_certReqId(OSSL_CRMF_MSG *crm);
  18. =head1 DESCRIPTION
  19. OSSL_CRMF_MSG_get0_tmpl() retrieves the certificate template of B<crm>.
  20. OSSL_CRMF_CERTTEMPLATE_get0_serialNumber() retrieves the serialNumber of the
  21. given certificate template B<tmpl>.
  22. OSSL_CRMF_CERTTEMPLATE_get0_issuer() retrieves the issuer name of the
  23. given certificate template B<tmpl>.
  24. OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert() decrypts the certificate in the given
  25. encryptedValue B<ecert>, using the private key B<pkey>.
  26. This is needed for the indirect PoP method as in RFC 4210 section 5.2.8.2.
  27. The function returns the decrypted certificate as a copy, leaving its ownership
  28. with the caller, who is responsible for freeing it.
  29. OSSL_CRMF_MSG_get_certReqId() retrieves the certReqId of B<crm>.
  30. =head1 RETURN VALUES
  31. OSSL_CRMF_MSG_get_certReqId() returns the certificate request ID as a
  32. non-negative integer or -1 on error.
  33. All other functions return a pointer with the intended result or NULL on error.
  34. =head1 SEE ALSO
  35. B<RFC 4211>
  36. =head1 COPYRIGHT
  37. Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
  38. Licensed under the Apache License 2.0 (the "License"). You may not use
  39. this file except in compliance with the License. You can obtain a copy
  40. in the file LICENSE in the source distribution or at
  41. L<https://www.openssl.org/source/license.html>.
  42. =cut