Add RAND_UNIMPLEMENTED error code
[openssl.git] / doc / man3 / CMS_verify_receipt.pod
1 =pod
2
3 =head1 NAME
4
5 CMS_verify_receipt - 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,
12                         STACK_OF(X509) *certs, X509_STORE *store,
13                         unsigned int flags);
14
15 =head1 DESCRIPTION
16
17 CMS_verify_receipt() verifies a CMS signed receipt. B<rcms> is the signed
18 receipt to verify. B<ocms> is the original SignedData structure containing the
19 receipt request. B<certs> is a set of certificates in which to search for the
20 signing certificate. B<store> is a trusted certificate store (used for chain
21 verification).
22
23 B<flags> is an optional set of flags, which can be used to modify the verify
24 operation.
25
26 =head1 NOTES
27
28 This functions behaves in a similar way to CMS_verify() except the flag values
29 B<CMS_DETACHED>, B<CMS_BINARY>, B<CMS_TEXT> and B<CMS_STREAM> are not
30 supported since they do not make sense in the context of signed receipts.
31
32 =head1 RETURN VALUES
33
34 CMS_verify_receipt() returns 1 for a successful verification and zero if an
35 error occurred.
36
37 The error can be obtained from L<ERR_get_error(3)>
38
39 =head1 SEE ALSO
40
41 L<ERR_get_error(3)>,
42 L<CMS_sign_receipt(3)>,
43 L<CMS_verify(3)>,
44
45 =head1 COPYRIGHT
46
47 Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved.
48
49 Licensed under the OpenSSL license (the "License").  You may not use
50 this file except in compliance with the License.  You can obtain a copy
51 in the file LICENSE in the source distribution or at
52 L<https://www.openssl.org/source/license.html>.
53
54 =cut