Multiple verifier reference identities.
[openssl.git] / doc / crypto / CMS_get1_ReceiptRequest.pod
1 =pod
2
3 =head1 NAME
4
5  CMS_ReceiptRequest_create0, CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, CMS_ReceiptRequest_get0_values - CMS signed receipt request functions.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/cms.h>
10
11  CMS_ReceiptRequest *CMS_ReceiptRequest_create0(unsigned char *id, int idlen, int allorfirst, STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo);
12  int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr);
13  int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr);
14  void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr, ASN1_STRING **pcid, int *pallorfirst, STACK_OF(GENERAL_NAMES) **plist, STACK_OF(GENERAL_NAMES) **prto);
15
16 =head1 DESCRIPTION
17
18 CMS_ReceiptRequest_create0() creates a signed receipt request structure. The
19 B<signedContentIdentifier> field is set using B<id> and B<idlen>, or it is set
20 to 32 bytes of pseudo random data if B<id> is NULL. If B<receiptList> is NULL
21 the allOrFirstTier option in B<receiptsFrom> is used and set to the value of
22 the B<allorfirst> parameter. If B<receiptList> is not NULL the B<receiptList>
23 option in B<receiptsFrom> is used. The B<receiptsTo> parameter specifies the
24 B<receiptsTo> field value.
25
26 The CMS_add1_ReceiptRequest() function adds a signed receipt request B<rr>
27 to SignerInfo structure B<si>.
28
29 int CMS_get1_ReceiptRequest() looks for a signed receipt request in B<si>, if
30 any is found it is decoded and written to B<prr>.
31
32 CMS_ReceiptRequest_get0_values() retrieves the values of a receipt request.
33 The signedContentIdentifier is copied to B<pcid>. If the B<allOrFirstTier>
34 option of B<receiptsFrom> is used its value is copied to B<pallorfirst>
35 otherwise the B<receiptList> field is copied to B<plist>. The B<receiptsTo>
36 parameter is copied to B<prto>.
37
38 =head1 NOTES
39
40 For more details of the meaning of the fields see RFC2634.
41
42 The contents of a signed receipt should only be considered meaningful if the
43 corresponding CMS_ContentInfo structure can be successfully verified using
44 CMS_verify().
45
46 =head1 RETURN VALUES
47
48 CMS_ReceiptRequest_create0() returns a signed receipt request structure or 
49 NULL if an error occurred.
50
51 CMS_add1_ReceiptRequest() returns 1 for success or 0 is an error occurred.
52
53 CMS_get1_ReceiptRequest() returns 1 is a signed receipt request is found and
54 decoded. It returns 0 if a signed receipt request is not present and -1 if
55 it is present but malformed.
56
57 =head1 SEE ALSO
58
59 L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)>,
60 L<CMS_sign_receipt(3)|CMS_sign_receipt(3)>, L<CMS_verify(3)|CMS_verify(3)>
61 L<CMS_verify_receipt(3)|CMS_verify_receipt(3)>
62
63 =head1 HISTORY
64
65 CMS_ReceiptRequest_create0(), CMS_add1_ReceiptRequest(),
66 CMS_get1_ReceiptRequest() and CMS_ReceiptRequest_get0_values() were added to
67 OpenSSL 0.9.8
68
69 =cut