CMS_verify_receipt.3ossl 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "CMS_VERIFY_RECEIPT 3ossl"
  58. .TH CMS_VERIFY_RECEIPT 3ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. CMS_verify_receipt \- verify a CMS signed receipt
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/cms.h>
  69. \&
  70. \& int CMS_verify_receipt(CMS_ContentInfo *rcms, CMS_ContentInfo *ocms,
  71. \& STACK_OF(X509) *certs, X509_STORE *store,
  72. \& unsigned int flags);
  73. .Ve
  74. .SH DESCRIPTION
  75. .IX Header "DESCRIPTION"
  76. \&\fBCMS_verify_receipt()\fR verifies a CMS signed receipt. \fBrcms\fR is the signed
  77. receipt to verify. \fBocms\fR is the original SignedData structure containing the
  78. receipt request. \fBcerts\fR is a set of certificates in which to search for the
  79. signing certificate. \fBstore\fR is a trusted certificate store (used for chain
  80. verification).
  81. .PP
  82. \&\fBflags\fR is an optional set of flags, which can be used to modify the verify
  83. operation.
  84. .SH NOTES
  85. .IX Header "NOTES"
  86. This functions behaves in a similar way to \fBCMS_verify()\fR except the flag values
  87. \&\fBCMS_DETACHED\fR, \fBCMS_BINARY\fR, \fBCMS_TEXT\fR and \fBCMS_STREAM\fR are not
  88. supported since they do not make sense in the context of signed receipts.
  89. .SH "RETURN VALUES"
  90. .IX Header "RETURN VALUES"
  91. \&\fBCMS_verify_receipt()\fR returns 1 for a successful verification and zero if an
  92. error occurred.
  93. .PP
  94. The error can be obtained from \fBERR_get_error\fR\|(3)
  95. .SH "SEE ALSO"
  96. .IX Header "SEE ALSO"
  97. \&\fBERR_get_error\fR\|(3),
  98. \&\fBCMS_sign_receipt\fR\|(3),
  99. \&\fBCMS_verify\fR\|(3),
  100. .SH COPYRIGHT
  101. .IX Header "COPYRIGHT"
  102. Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
  103. .PP
  104. Licensed under the Apache License 2.0 (the "License"). You may not use
  105. this file except in compliance with the License. You can obtain a copy
  106. in the file LICENSE in the source distribution or at
  107. <https://www.openssl.org/source/license.html>.