secure/lib/libcrypto/man/man3/CMS_get0_RecipientInfos.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "CMS_GET0_RECIPIENTINFOS 3"
 136 .TH CMS_GET0_RECIPIENTINFOS 3 "2020-09-22" "1.1.1h" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 CMS_get0_RecipientInfos, CMS_RecipientInfo_type, CMS_RecipientInfo_ktri_get0_signer_id, CMS_RecipientInfo_ktri_cert_cmp, CMS_RecipientInfo_set0_pkey, CMS_RecipientInfo_kekri_get0_id, CMS_RecipientInfo_kekri_id_cmp, CMS_RecipientInfo_set0_key, CMS_RecipientInfo_decrypt, CMS_RecipientInfo_encrypt \&\- CMS envelopedData RecipientInfo routines
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/cms.h>
 147 \&
 148 \& STACK_OF(CMS_RecipientInfo) *CMS_get0_RecipientInfos(CMS_ContentInfo *cms);
 149 \& int CMS_RecipientInfo_type(CMS_RecipientInfo *ri);
 150 \&
 151 \& int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri,
 152 \&                                           ASN1_OCTET_STRING **keyid,
 153 \&                                           X509_NAME **issuer,
 154 \&                                           ASN1_INTEGER **sno);
 155 \& int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert);
 156 \& int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey);
 157 \&
 158 \& int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo *ri, X509_ALGOR **palg,
 159 \&                                     ASN1_OCTET_STRING **pid,
 160 \&                                     ASN1_GENERALIZEDTIME **pdate,
 161 \&                                     ASN1_OBJECT **potherid,
 162 \&                                     ASN1_TYPE **pothertype);
 163 \& int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo *ri,
 164 \&                                    const unsigned char *id, size_t idlen);
 165 \& int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri,
 166 \&                                unsigned char *key, size_t keylen);
 167 \&
 168 \& int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri);
 169 \& int CMS_RecipientInfo_encrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri);
 170 .Ve
 171 .SH "DESCRIPTION"
 172 .IX Header "DESCRIPTION"
 173 The function \fBCMS_get0_RecipientInfos()\fR returns all the CMS_RecipientInfo
 174 structures associated with a \s-1CMS\s0 EnvelopedData structure.
 175 .PP
 176 \&\fBCMS_RecipientInfo_type()\fR returns the type of CMS_RecipientInfo structure \fBri\fR.
 177 It will currently return \s-1CMS_RECIPINFO_TRANS, CMS_RECIPINFO_AGREE,
 178 CMS_RECIPINFO_KEK, CMS_RECIPINFO_PASS,\s0 or \s-1CMS_RECIPINFO_OTHER.\s0
 179 .PP
 180 \&\fBCMS_RecipientInfo_ktri_get0_signer_id()\fR retrieves the certificate recipient
 181 identifier associated with a specific CMS_RecipientInfo structure \fBri\fR, which
 182 must be of type \s-1CMS_RECIPINFO_TRANS.\s0 Either the keyidentifier will be set in
 183 \&\fBkeyid\fR or \fBboth\fR issuer name and serial number in \fBissuer\fR and \fBsno\fR.
 184 .PP
 185 \&\fBCMS_RecipientInfo_ktri_cert_cmp()\fR compares the certificate \fBcert\fR against the
 186 CMS_RecipientInfo structure \fBri\fR, which must be of type \s-1CMS_RECIPINFO_TRANS.\s0
 187 It returns zero if the comparison is successful and non zero if not.
 188 .PP
 189 \&\fBCMS_RecipientInfo_set0_pkey()\fR associates the private key \fBpkey\fR with
 190 the CMS_RecipientInfo structure \fBri\fR, which must be of type
 191 \&\s-1CMS_RECIPINFO_TRANS.\s0
 192 .PP
 193 \&\fBCMS_RecipientInfo_kekri_get0_id()\fR retrieves the key information from the
 194 CMS_RecipientInfo structure \fBri\fR which must be of type \s-1CMS_RECIPINFO_KEK.\s0  Any
 195 of the remaining parameters can be \s-1NULL\s0 if the application is not interested in
 196 the value of a field. Where a field is optional and absent \s-1NULL\s0 will be written
 197 to the corresponding parameter. The keyEncryptionAlgorithm field is written to
 198 \&\fBpalg\fR, the \fBkeyIdentifier\fR field is written to \fBpid\fR, the \fBdate\fR field if
 199 present is written to \fBpdate\fR, if the \fBother\fR field is present the components
 200 \&\fBkeyAttrId\fR and \fBkeyAttr\fR are written to parameters \fBpotherid\fR and
 201 \&\fBpothertype\fR.
 202 .PP
 203 \&\fBCMS_RecipientInfo_kekri_id_cmp()\fR compares the \s-1ID\s0 in the \fBid\fR and \fBidlen\fR
 204 parameters against the \fBkeyIdentifier\fR CMS_RecipientInfo structure \fBri\fR,
 205 which must be of type \s-1CMS_RECIPINFO_KEK.\s0  It returns zero if the comparison is
 206 successful and non zero if not.
 207 .PP
 208 \&\fBCMS_RecipientInfo_set0_key()\fR associates the symmetric key \fBkey\fR of length
 209 \&\fBkeylen\fR with the CMS_RecipientInfo structure \fBri\fR, which must be of type
 210 \&\s-1CMS_RECIPINFO_KEK.\s0
 211 .PP
 212 \&\fBCMS_RecipientInfo_decrypt()\fR attempts to decrypt CMS_RecipientInfo structure
 213 \&\fBri\fR in structure \fBcms\fR. A key must have been associated with the structure
 214 first.
 215 .PP
 216 \&\fBCMS_RecipientInfo_encrypt()\fR attempts to encrypt CMS_RecipientInfo structure
 217 \&\fBri\fR in structure \fBcms\fR. A key must have been associated with the structure
 218 first and the content encryption key must be available: for example by a
 219 previous call to \fBCMS_RecipientInfo_decrypt()\fR.
 220 .SH "NOTES"
 221 .IX Header "NOTES"
 222 The main purpose of these functions is to enable an application to lookup
 223 recipient keys using any appropriate technique when the simpler method
 224 of \fBCMS_decrypt()\fR is not appropriate.
 225 .PP
 226 In typical usage and application will retrieve all CMS_RecipientInfo structures
 227 using \fBCMS_get0_RecipientInfos()\fR and check the type of each using
 228 \&\fBCMS_RecipientInfo_type()\fR. Depending on the type the CMS_RecipientInfo structure
 229 can be ignored or its key identifier data retrieved using an appropriate
 230 function. Then if the corresponding secret or private key can be obtained by
 231 any appropriate means it can then associated with the structure and
 232 \&\fBCMS_RecipientInfo_decrypt()\fR called. If successful \fBCMS_decrypt()\fR can be called
 233 with a \s-1NULL\s0 key to decrypt the enveloped content.
 234 .PP
 235 The \fBCMS_RecipientInfo_encrypt()\fR can be used to add a new recipient to an
 236 existing enveloped data structure. Typically an application will first decrypt
 237 an appropriate CMS_RecipientInfo structure to make the content encrypt key
 238 available, it will then add a new recipient using a function such as
 239 \&\fBCMS_add1_recipient_cert()\fR and finally encrypt the content encryption key
 240 using \fBCMS_RecipientInfo_encrypt()\fR.
 241 .SH "RETURN VALUES"
 242 .IX Header "RETURN VALUES"
 243 \&\fBCMS_get0_RecipientInfos()\fR returns all CMS_RecipientInfo structures, or \s-1NULL\s0 if
 244 an error occurs.
 245 .PP
 246 \&\fBCMS_RecipientInfo_ktri_get0_signer_id()\fR, \fBCMS_RecipientInfo_set0_pkey()\fR,
 247 \&\fBCMS_RecipientInfo_kekri_get0_id()\fR, \fBCMS_RecipientInfo_set0_key()\fR and
 248 \&\fBCMS_RecipientInfo_decrypt()\fR return 1 for success or 0 if an error occurs.
 249 \&\fBCMS_RecipientInfo_encrypt()\fR return 1 for success or 0 if an error occurs.
 250 .PP
 251 \&\fBCMS_RecipientInfo_ktri_cert_cmp()\fR and \fBCMS_RecipientInfo_kekri_cmp()\fR return 0
 252 for a successful comparison and non zero otherwise.
 253 .PP
 254 Any error can be obtained from \fBERR_get_error\fR\|(3).
 255 .SH "SEE ALSO"
 256 .IX Header "SEE ALSO"
 257 \&\fBERR_get_error\fR\|(3), \fBCMS_decrypt\fR\|(3)
 258 .SH "COPYRIGHT"
 259 .IX Header "COPYRIGHT"
 260 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
 261 .PP
 262 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 263 this file except in compliance with the License.  You can obtain a copy
 264 in the file \s-1LICENSE\s0 in the source distribution or at
 265 <https://www.openssl.org/source/license.html>.