summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/lib/libcrypto/man/CMS_get1_ReceiptRequest.364
1 files changed, 42 insertions, 22 deletions
diff --git a/src/lib/libcrypto/man/CMS_get1_ReceiptRequest.3 b/src/lib/libcrypto/man/CMS_get1_ReceiptRequest.3
index f012ca129b..c9c8a191e7 100644
--- a/src/lib/libcrypto/man/CMS_get1_ReceiptRequest.3
+++ b/src/lib/libcrypto/man/CMS_get1_ReceiptRequest.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: CMS_get1_ReceiptRequest.3,v 1.4 2019/08/11 12:46:38 schwarze Exp $ 1.\" $OpenBSD: CMS_get1_ReceiptRequest.3,v 1.5 2019/08/18 10:54:57 schwarze Exp $
2.\" full merge up to: OpenSSL 83cf7abf May 29 13:07:08 2018 +0100 2.\" full merge up to: OpenSSL 83cf7abf May 29 13:07:08 2018 +0100
3.\" 3.\"
4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -48,7 +48,7 @@
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\" 50.\"
51.Dd $Mdocdate: August 11 2019 $ 51.Dd $Mdocdate: August 18 2019 $
52.Dt CMS_GET1_RECEIPTREQUEST 3 52.Dt CMS_GET1_RECEIPTREQUEST 3
53.Os 53.Os
54.Sh NAME 54.Sh NAME
@@ -87,8 +87,12 @@
87.Fc 87.Fc
88.Sh DESCRIPTION 88.Sh DESCRIPTION
89.Fn CMS_ReceiptRequest_create0 89.Fn CMS_ReceiptRequest_create0
90creates a signed receipt request structure. 90creates a new
91The signedContentIdentifier field is set using 91.Vt ReceiptRequest
92structure.
93The
94.Fa signedContentIdentifier
95field is set using
92.Fa id 96.Fa id
93and 97and
94.Fa idlen , 98.Fa idlen ,
@@ -100,26 +104,32 @@ If
100.Fa receiptList 104.Fa receiptList
101is 105is
102.Dv NULL , 106.Dv NULL ,
103the allOrFirstTier option in receiptsFrom 107the
104is used and set to the value of the 108.Fa allOrFirstTier
109option in the
110.Fa receiptsFrom
111field is set to the value of the
105.Fa allorfirst 112.Fa allorfirst
106parameter. 113argument.
107If 114If
108.Fa receiptList 115.Fa receiptList
109is not 116is not
110.Dv NULL , 117.Dv NULL ,
111the receiptList option in receiptsFrom is used. 118the
119.Fa receiptList
120option in the
121.Fa receiptsFrom
122field is used.
112The 123The
113.Fa receiptsTo 124.Fa receiptsTo
114parameter specifies the receiptsTo field value. 125argument specifies the value of the
126.Fa receiptsTo
127field.
115.Pp 128.Pp
116The
117.Fn CMS_add1_ReceiptRequest 129.Fn CMS_add1_ReceiptRequest
118function adds a signed receipt request 130adds a BER-encoded copy of
119.Fa rr 131.Fa rr
120to the 132to
121.Vt CMS_SignerInfo
122structure
123.Fa si . 133.Fa si .
124.Pp 134.Pp
125.Fn CMS_get1_ReceiptRequest 135.Fn CMS_get1_ReceiptRequest
@@ -130,18 +140,25 @@ If any is found, it is decoded and written to
130.Pp 140.Pp
131.Fn CMS_ReceiptRequest_get0_values 141.Fn CMS_ReceiptRequest_get0_values
132retrieves the values of a receipt request. 142retrieves the values of a receipt request.
133The signedContentIdentifier is copied to 143The
144.Fa signedContentIdentifier
145is copied to
134.Fa pcid . 146.Fa pcid .
135If the allOrFirstTier option of receiptsFrom is used, 147If the
136its value is copied to 148.Fa allOrFirstTier
149option is used in the
150.Fa receiptsFrom
151field, its value is copied to
137.Fa pallorfirst ; 152.Fa pallorfirst ;
138otherwise the receiptList field is copied to 153otherwise the
154.Fa receiptList
155field is copied to
139.Fa plist . 156.Fa plist .
140The receiptsTo parameter is copied to 157The
158.Fa receiptsTo
159field is copied to
141.Fa prto . 160.Fa prto .
142.Pp 161.Pp
143For more details on the meaning of the fields see RFC2634.
144.Pp
145The contents of a signed receipt should only be considered meaningful if 162The contents of a signed receipt should only be considered meaningful if
146the corresponding 163the corresponding
147.Vt CMS_ContentInfo 164.Vt CMS_ContentInfo
@@ -149,7 +166,7 @@ structure can be successfully verified using
149.Xr CMS_verify 3 . 166.Xr CMS_verify 3 .
150.Sh RETURN VALUES 167.Sh RETURN VALUES
151.Fn CMS_ReceiptRequest_create0 168.Fn CMS_ReceiptRequest_create0
152returns a signed receipt request structure or 169returns the new signed receipt request structure or
153.Dv NULL 170.Dv NULL
154if an error occurred. 171if an error occurred.
155.Pp 172.Pp
@@ -166,6 +183,9 @@ present but malformed.
166.Xr CMS_verify 3 , 183.Xr CMS_verify 3 ,
167.Xr CMS_verify_receipt 3 , 184.Xr CMS_verify_receipt 3 ,
168.Xr ERR_get_error 3 185.Xr ERR_get_error 3
186.Sh STANDARDS
187RFC 2634: Enhanced Security Services for S/MIME,
188section 2.7: Receipt Request Syntax
169.Sh HISTORY 189.Sh HISTORY
170.Fn CMS_ReceiptRequest_create0 , 190.Fn CMS_ReceiptRequest_create0 ,
171.Fn CMS_add1_ReceiptRequest , 191.Fn CMS_add1_ReceiptRequest ,