Home | History | Annotate | Line # | Download | only in man 
 $NetBSD: CMS_get1_ReceiptRequest.3,v 1.1.1.2 2023/04/18 14:19:13 christos Exp $

 Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)

 Standard preamble:
 ========================================================================
..

..


..
 Set up some character translations and predefined strings. \*(-- will
 give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 double quote, and \*(R" will give a right double quote. \*(C+ will
 give a nicer C++. Capital omega is used to do unbreakable dashes and
 therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
 nothing in troff, for use with C<>.
.tr \(*W-
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 If the F register is >0, we'll generate index entries on stderr for
 titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 entries marked with X<> in POD. Of course, you'll have to process the
 output yourself in some meaningful fashion.

 Avoid warning from groff about undefined register 'F'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF

 Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] 
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
 ========================================================================

 Title "CMS_get1_ReceiptRequest 3" 
 CMS_get1_ReceiptRequest 3 "2018-09-23" "1.1.1i" "OpenSSL"
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh

 "NAME"
CMS_ReceiptRequest_create0, CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, CMS_ReceiptRequest_get0_values - CMS signed receipt request functions

 "LIBRARY"
libcrypto, -lcrypto

 "SYNOPSIS"
 Header "SYNOPSIS" .Vb 1
 #include <openssl/cms.h>
\&
 CMS_ReceiptRequest *CMS_ReceiptRequest_create0(unsigned char *id, int idlen,
  int allorfirst,
  STACK_OF(GENERAL_NAMES) *receiptList,
  STACK_OF(GENERAL_NAMES) *receiptsTo);
 int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr);
 int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr);
 void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr, ASN1_STRING **pcid,
  int *pallorfirst,
  STACK_OF(GENERAL_NAMES) **plist,
  STACK_OF(GENERAL_NAMES) **prto);
.Ve

 "DESCRIPTION"
 Header "DESCRIPTION" \fBCMS_ReceiptRequest_create0() creates a signed receipt request structure. The
\fBsignedContentIdentifier field is set using id and idlen, or it is set
to 32 bytes of pseudo random data if id is \s-1NULL.\s0 If receiptList is \s-1NULL\s0
the allOrFirstTier option in receiptsFrom is used and set to the value of
the allorfirst parameter. If receiptList is not \s-1NULL\s0 the receiptList
option in receiptsFrom is used. The receiptsTo parameter specifies the
\fBreceiptsTo field value.


The CMS_add1_ReceiptRequest() function adds a signed receipt request rr
to SignerInfo structure si.


int CMS_get1_ReceiptRequest() looks for a signed receipt request in si, if
any is found it is decoded and written to prr.


\fBCMS_ReceiptRequest_get0_values() retrieves the values of a receipt request.
The signedContentIdentifier is copied to pcid. If the allOrFirstTier
option of receiptsFrom is used its value is copied to pallorfirst
otherwise the receiptList field is copied to plist. The receiptsTo
parameter is copied to prto.

 "NOTES"
 Header "NOTES" For more details of the meaning of the fields see \s-1RFC2634.\s0


The contents of a signed receipt should only be considered meaningful if the
corresponding CMS_ContentInfo structure can be successfully verified using
\fBCMS_verify().

 "RETURN VALUES"
 Header "RETURN VALUES" \fBCMS_ReceiptRequest_create0() returns a signed receipt request structure or
\s-1NULL\s0 if an error occurred.


\fBCMS_add1_ReceiptRequest() returns 1 for success or 0 if an error occurred.


\fBCMS_get1_ReceiptRequest() returns 1 is a signed receipt request is found and
decoded. It returns 0 if a signed receipt request is not present and -1 if
it is present but malformed.

 "SEE ALSO"
 Header "SEE ALSO" \fBERR_get_error\|(3), CMS_sign\|(3),
\fBCMS_sign_receipt\|(3), CMS_verify\|(3)
\fBCMS_verify_receipt\|(3)

 "COPYRIGHT"
 Header "COPYRIGHT" Copyright 2008-2018 The OpenSSL Project Authors. All Rights Reserved.


Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.