summaryrefslogtreecommitdiffstats
path: root/lib/libcrypto/man
diff options
context:
space:
mode:
authorschwarze <schwarze@openbsd.org>2019-08-18 10:54:57 +0000
committerschwarze <schwarze@openbsd.org>2019-08-18 10:54:57 +0000
commit9a71524d88ef2cd467c45621c02e1278feb4204d (patch)
treef05ddb7d62e9e3473bed9d0bf5365f463d6ed08f /lib/libcrypto/man
parentsome cleanup: (diff)
downloadwireguard-openbsd-9a71524d88ef2cd467c45621c02e1278feb4204d.tar.xz
wireguard-openbsd-9a71524d88ef2cd467c45621c02e1278feb4204d.zip
minor cleanup:
* mark up ASN.1 type and field names * move the RFC reference to STANDARDS * and minor wording improvements
Diffstat (limited to 'lib/libcrypto/man')
-rw-r--r--lib/libcrypto/man/CMS_get1_ReceiptRequest.364
1 files changed, 42 insertions, 22 deletions
diff --git a/lib/libcrypto/man/CMS_get1_ReceiptRequest.3 b/lib/libcrypto/man/CMS_get1_ReceiptRequest.3
index f012ca129b5..c9c8a191e76 100644
--- a/lib/libcrypto/man/CMS_get1_ReceiptRequest.3
+++ b/lib/libcrypto/man/CMS_get1_ReceiptRequest.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: CMS_get1_ReceiptRequest.3,v 1.4 2019/08/11 12:46:38 schwarze Exp $
+.\" $OpenBSD: CMS_get1_ReceiptRequest.3,v 1.5 2019/08/18 10:54:57 schwarze Exp $
.\" full merge up to: OpenSSL 83cf7abf May 29 13:07:08 2018 +0100
.\"
.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -48,7 +48,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: August 11 2019 $
+.Dd $Mdocdate: August 18 2019 $
.Dt CMS_GET1_RECEIPTREQUEST 3
.Os
.Sh NAME
@@ -87,8 +87,12 @@
.Fc
.Sh DESCRIPTION
.Fn CMS_ReceiptRequest_create0
-creates a signed receipt request structure.
-The signedContentIdentifier field is set using
+creates a new
+.Vt ReceiptRequest
+structure.
+The
+.Fa signedContentIdentifier
+field is set using
.Fa id
and
.Fa idlen ,
@@ -100,26 +104,32 @@ If
.Fa receiptList
is
.Dv NULL ,
-the allOrFirstTier option in receiptsFrom
-is used and set to the value of the
+the
+.Fa allOrFirstTier
+option in the
+.Fa receiptsFrom
+field is set to the value of the
.Fa allorfirst
-parameter.
+argument.
If
.Fa receiptList
is not
.Dv NULL ,
-the receiptList option in receiptsFrom is used.
+the
+.Fa receiptList
+option in the
+.Fa receiptsFrom
+field is used.
The
.Fa receiptsTo
-parameter specifies the receiptsTo field value.
+argument specifies the value of the
+.Fa receiptsTo
+field.
.Pp
-The
.Fn CMS_add1_ReceiptRequest
-function adds a signed receipt request
+adds a BER-encoded copy of
.Fa rr
-to the
-.Vt CMS_SignerInfo
-structure
+to
.Fa si .
.Pp
.Fn CMS_get1_ReceiptRequest
@@ -130,18 +140,25 @@ If any is found, it is decoded and written to
.Pp
.Fn CMS_ReceiptRequest_get0_values
retrieves the values of a receipt request.
-The signedContentIdentifier is copied to
+The
+.Fa signedContentIdentifier
+is copied to
.Fa pcid .
-If the allOrFirstTier option of receiptsFrom is used,
-its value is copied to
+If the
+.Fa allOrFirstTier
+option is used in the
+.Fa receiptsFrom
+field, its value is copied to
.Fa pallorfirst ;
-otherwise the receiptList field is copied to
+otherwise the
+.Fa receiptList
+field is copied to
.Fa plist .
-The receiptsTo parameter is copied to
+The
+.Fa receiptsTo
+field is copied to
.Fa prto .
.Pp
-For more details on the meaning of the fields see RFC2634.
-.Pp
The contents of a signed receipt should only be considered meaningful if
the corresponding
.Vt CMS_ContentInfo
@@ -149,7 +166,7 @@ structure can be successfully verified using
.Xr CMS_verify 3 .
.Sh RETURN VALUES
.Fn CMS_ReceiptRequest_create0
-returns a signed receipt request structure or
+returns the new signed receipt request structure or
.Dv NULL
if an error occurred.
.Pp
@@ -166,6 +183,9 @@ present but malformed.
.Xr CMS_verify 3 ,
.Xr CMS_verify_receipt 3 ,
.Xr ERR_get_error 3
+.Sh STANDARDS
+RFC 2634: Enhanced Security Services for S/MIME,
+section 2.7: Receipt Request Syntax
.Sh HISTORY
.Fn CMS_ReceiptRequest_create0 ,
.Fn CMS_add1_ReceiptRequest ,