summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/CMS_get1_ReceiptRequest.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/lib/libcrypto/man/CMS_get1_ReceiptRequest.3143
1 files changed, 0 insertions, 143 deletions
diff --git a/src/lib/libcrypto/man/CMS_get1_ReceiptRequest.3 b/src/lib/libcrypto/man/CMS_get1_ReceiptRequest.3
deleted file mode 100644
index ab19f87fab..0000000000
--- a/src/lib/libcrypto/man/CMS_get1_ReceiptRequest.3
+++ /dev/null
@@ -1,143 +0,0 @@
1.Dd $Mdocdate: November 11 2015 $
2.Dt CMS_GET1_RECEIPTREQUEST 3
3.Os
4.Sh NAME
5.Nm CMS_ReceiptRequest_create0 ,
6.Nm CMS_add1_ReceiptRequest ,
7.Nm CMS_get1_ReceiptRequest ,
8.Nm CMS_ReceiptRequest_get0_values
9.Nd CMS signed receipt request functions
10.Sh SYNOPSIS
11.In openssl/cms.h
12.Ft CMS_ReceiptRequest *
13.Fo CMS_ReceiptRequest_create0
14.Fa "unsigned char *id"
15.Fa "int idlen"
16.Fa "int allorfirst"
17.Fa "STACK_OF(GENERAL_NAMES) *receiptList"
18.Fa "STACK_OF(GENERAL_NAMES) *receiptsTo"
19.Fc
20.Ft int
21.Fo CMS_add1_ReceiptRequest
22.Fa "CMS_SignerInfo *si"
23.Fa "CMS_ReceiptRequest *rr"
24.Fc
25.Ft int
26.Fo CMS_get1_ReceiptRequest
27.Fa "CMS_SignerInfo *si"
28.Fa "CMS_ReceiptRequest **prr"
29.Fc
30.Ft void
31.Fo CMS_ReceiptRequest_get0_values
32.Fa "CMS_ReceiptRequest *rr"
33.Fa "ASN1_STRING **pcid"
34.Fa "int *pallorfirst"
35.Fa "STACK_OF(GENERAL_NAMES) **plist"
36.Fa "STACK_OF(GENERAL_NAMES) **prto"
37.Fc
38.Sh DESCRIPTION
39.Fn CMS_ReceiptRequest_create0
40creates a signed receipt request structure.
41The
42.Sy signedContentIdentifier
43field is set using
44.Fa id
45and
46.Fa idlen ,
47or it is set to 32 bytes of pseudo random data if
48.Fa id
49is
50.Dv NULL .
51If
52.Fa receiptList
53is
54.Dv NULL ,
55the
56.Sy allOrFirstTier
57option in
58.Sy receiptsFrom
59is used and set to the value of the
60.Fa allorfirst
61parameter.
62If
63.Fa receiptList
64is not
65.Dv NULL ,
66the
67.Sy receiptList
68option in
69.Sy receiptsFrom
70is used.
71The
72.Fa receiptsTo
73parameter specifies the
74.Sy receiptsTo
75field value.
76.Pp
77The
78.Fn CMS_add1_ReceiptRequest
79function adds a signed receipt request
80.Fa rr
81to the
82.Vt CMS_SignerInfo
83structure
84.Fa si .
85.Pp
86.Fn CMS_get1_ReceiptRequest
87looks for a signed receipt request in
88.Fa si .
89If any is found, it is decoded and written to
90.Fa prr .
91.Pp
92.Fn CMS_ReceiptRequest_get0_values
93retrieves the values of a receipt request.
94The signedContentIdentifier is copied to
95.Fa pcid .
96If the
97.Sy allOrFirstTier
98option of
99.Sy receiptsFrom
100is used, its value is copied to
101.Fa pallorfirst ;
102otherwise the
103.Sy receiptList
104field is copied to
105.Fa plist .
106The
107.Sy receiptsTo
108parameter is copied to
109.Fa prto .
110.Sh NOTES
111For more details of the meaning of the fields see RFC2634.
112.Pp
113The contents of a signed receipt should only be considered meaningful if
114the corresponding
115.Vt CMS_ContentInfo
116structure can be successfully verified using
117.Xr CMS_verify 3 .
118.Sh RETURN VALUES
119.Fn CMS_ReceiptRequest_create0
120returns a signed receipt request structure or
121.Dv NULL
122if an error occurred.
123.Pp
124.Fn CMS_add1_ReceiptRequest
125returns 1 for success or 0 is an error occurred.
126.Pp
127.Fn CMS_get1_ReceiptRequest
128returns 1 is a signed receipt request is found and decoded.
129It returns 0 if a signed receipt request is not present and -1 if it is
130present but malformed.
131.Sh SEE ALSO
132.Xr CMS_sign 3 ,
133.Xr CMS_sign_receipt 3 ,
134.Xr CMS_verify 3 ,
135.Xr CMS_verify_receipt 3 ,
136.Xr ERR_get_error 3
137.Sh HISTORY
138.Fn CMS_ReceiptRequest_create0 ,
139.Fn CMS_add1_ReceiptRequest ,
140.Fn CMS_get1_ReceiptRequest ,
141and
142.Fn CMS_ReceiptRequest_get0_values
143were added to OpenSSL 0.9.8.