Add CMS signed receipt genration and verification docs.
[openssl.git] / doc / crypto / CMS_verify_receipt.pod
1 =pod
2
3 =head1 NAME
4
5 CMS_verify - verify a CMS signed receipt
6
7 =head1 SYNOPSIS
8
9  #include <openssl/cms.h>
10
11  int CMS_verify_receipt(CMS_ContentInfo *rcms, CMS_ContentInfo *ocms, STACK_OF(X509) *certs, X509_STORE *store, unsigned int flags);
12
13 =head1 DESCRIPTION
14
15 CMS_verify_receipt() verifies a CMS signed receipt. B<rcms> is the signed
16 receipt to verify. B<ocms> is the original SignedData structure containing the
17 receipt request B<certs> is a set of certificates in which to search for the
18 signer's certificate. B<store> is a trusted certificate store (used for chain
19 verification). 
20
21 B<flags> is an optional set of flags, which can be used to modify the verify
22 operation.
23
24 =head1 NOTES
25
26 This functions behaves in a similar way to CMS_verify() except the flag values
27 B<CMS_DETACHED>, B<CMS_BINARY>, B<CMS_TEXT> and B<CMS_STREAM> are not
28 supported since they do not make sense in the context of signed receipts.
29
30 =head1 RETURN VALUES
31
32 CMS_verify_receipt() returns 1 for a successful verification and zero if an
33 error occurred.
34
35 The error can be obtained from L<ERR_get_error(3)|ERR_get_error(3)>
36
37 =head1 SEE ALSO
38
39 L<ERR_get_error(3)|ERR_get_error(3)>,
40 L<CMS_sign_receipt(3)|CMS_sign_receipt(3)>,
41 L<CMS_verify(3)|CMS_verify(3)>,
42
43 =head1 HISTORY
44
45 CMS_verify() was added to OpenSSL 0.9.8
46
47 =cut