CMS_get1_ReceiptRequest.pod 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. =pod
  2. =head1 NAME
  3. CMS_ReceiptRequest_create0_ex, CMS_ReceiptRequest_create0,
  4. CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, CMS_ReceiptRequest_get0_values
  5. - CMS signed receipt request functions
  6. =head1 SYNOPSIS
  7. #include <openssl/cms.h>
  8. CMS_ReceiptRequest *CMS_ReceiptRequest_create0_ex(
  9. unsigned char *id, int idlen, int allorfirst,
  10. STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo,
  11. OPENSSL_CTX *libctx, const char *propq);
  12. CMS_ReceiptRequest *CMS_ReceiptRequest_create0(
  13. unsigned char *id, int idlen, int allorfirst,
  14. STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo);
  15. int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr);
  16. int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr);
  17. void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr, ASN1_STRING **pcid,
  18. int *pallorfirst,
  19. STACK_OF(GENERAL_NAMES) **plist,
  20. STACK_OF(GENERAL_NAMES) **prto);
  21. =head1 DESCRIPTION
  22. CMS_ReceiptRequest_create0_ex() creates a signed receipt request
  23. structure. The B<signedContentIdentifier> field is set using I<id> and I<idlen>,
  24. or it is set to 32 bytes of pseudo random data if I<id> is NULL.
  25. If I<receiptList> is NULL the allOrFirstTier option in I<receiptsFrom> is used
  26. and set to the value of the I<allorfirst> parameter. If I<receiptList> is not
  27. NULL the I<receiptList> option in I<receiptsFrom> is used. The I<receiptsTo>
  28. parameter specifies the I<receiptsTo> field value. The library context I<libctx>
  29. and the property query I<propq> are used when retrieving algorithms from providers.
  30. CMS_ReceiptRequest_create0() is similar to
  31. CMS_ReceiptRequest_create0_ex() but uses default values of NULL for the
  32. library context I<libctx> and the property query I<propq>.
  33. The CMS_add1_ReceiptRequest() function adds a signed receipt request B<rr>
  34. to SignerInfo structure B<si>.
  35. int CMS_get1_ReceiptRequest() looks for a signed receipt request in B<si>, if
  36. any is found it is decoded and written to B<prr>.
  37. CMS_ReceiptRequest_get0_values() retrieves the values of a receipt request.
  38. The signedContentIdentifier is copied to B<pcid>. If the B<allOrFirstTier>
  39. option of B<receiptsFrom> is used its value is copied to B<pallorfirst>
  40. otherwise the B<receiptList> field is copied to B<plist>. The B<receiptsTo>
  41. parameter is copied to B<prto>.
  42. =head1 NOTES
  43. For more details of the meaning of the fields see RFC2634.
  44. The contents of a signed receipt should only be considered meaningful if the
  45. corresponding CMS_ContentInfo structure can be successfully verified using
  46. CMS_verify().
  47. =head1 RETURN VALUES
  48. CMS_ReceiptRequest_create0_ex() and CMS_ReceiptRequest_create0() return
  49. a signed receipt request structure or NULL if an error occurred.
  50. CMS_add1_ReceiptRequest() returns 1 for success or 0 if an error occurred.
  51. CMS_get1_ReceiptRequest() returns 1 is a signed receipt request is found and
  52. decoded. It returns 0 if a signed receipt request is not present and -1 if
  53. it is present but malformed.
  54. =head1 SEE ALSO
  55. L<ERR_get_error(3)>, L<CMS_sign(3)>,
  56. L<CMS_sign_receipt(3)>, L<CMS_verify(3)>
  57. L<CMS_verify_receipt(3)>
  58. =head1 HISTORY
  59. The function CMS_ReceiptRequest_create0_ex() was added in OpenSSL 3.0.
  60. =head1 COPYRIGHT
  61. Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
  62. Licensed under the Apache License 2.0 (the "License"). You may not use
  63. this file except in compliance with the License. You can obtain a copy
  64. in the file LICENSE in the source distribution or at
  65. L<https://www.openssl.org/source/license.html>.
  66. =cut