| 1 |
.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35) |
| 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 |
.if !\nF .nr F 0 |
| 58 |
.if \nF>0 \{\ |
| 59 |
. de IX |
| 60 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 61 |
.. |
| 62 |
. if !\nF==2 \{\ |
| 63 |
. nr % 0 |
| 64 |
. nr F 2 |
| 65 |
. \} |
| 66 |
.\} |
| 67 |
.\" |
| 68 |
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 |
.\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 |
. \" fudge factors for nroff and troff |
| 71 |
.if n \{\ |
| 72 |
. ds #H 0 |
| 73 |
. ds #V .8m |
| 74 |
. ds #F .3m |
| 75 |
. ds #[ \f1 |
| 76 |
. ds #] \fP |
| 77 |
.\} |
| 78 |
.if t \{\ |
| 79 |
. ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 |
. ds #V .6m |
| 81 |
. ds #F 0 |
| 82 |
. ds #[ \& |
| 83 |
. ds #] \& |
| 84 |
.\} |
| 85 |
. \" simple accents for nroff and troff |
| 86 |
.if n \{\ |
| 87 |
. ds ' \& |
| 88 |
. ds ` \& |
| 89 |
. ds ^ \& |
| 90 |
. ds , \& |
| 91 |
. ds ~ ~ |
| 92 |
. ds / |
| 93 |
.\} |
| 94 |
.if t \{\ |
| 95 |
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 |
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 |
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 |
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 |
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 |
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 |
.\} |
| 102 |
. \" troff and (daisy-wheel) nroff accents |
| 103 |
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 |
.ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 |
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 |
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 |
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 |
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 |
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 |
.ds ae a\h'-(\w'a'u*4/10)'e |
| 111 |
.ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 |
. \" corrections for vroff |
| 113 |
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 |
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 |
. \" for low resolution devices (crt and lpr) |
| 116 |
.if \n(.H>23 .if \n(.V>19 \ |
| 117 |
\{\ |
| 118 |
. ds : e |
| 119 |
. ds 8 ss |
| 120 |
. ds o a |
| 121 |
. ds d- d\h'-1'\(ga |
| 122 |
. ds D- D\h'-1'\(hy |
| 123 |
. ds th \o'bp' |
| 124 |
. ds Th \o'LP' |
| 125 |
. ds ae ae |
| 126 |
. ds Ae AE |
| 127 |
.\} |
| 128 |
.rm #[ #] #H #V #F C |
| 129 |
.\" ======================================================================== |
| 130 |
.\" |
| 131 |
.IX Title "CMS_get0_RecipientInfos 3" |
| 132 |
.TH CMS_get0_RecipientInfos 3 "2017-12-07" "1.0.2n" "OpenSSL" |
| 133 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 134 |
.\" way too many mistakes in technical documents. |
| 135 |
.if n .ad l |
| 136 |
.nh |
| 137 |
.SH "NAME" |
| 138 |
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 |
| 139 |
.SH "SYNOPSIS" |
| 140 |
.IX Header "SYNOPSIS" |
| 141 |
.Vb 1 |
| 142 |
\& #include <openssl/cms.h> |
| 143 |
\& |
| 144 |
\& STACK_OF(CMS_RecipientInfo) *CMS_get0_RecipientInfos(CMS_ContentInfo *cms); |
| 145 |
\& int CMS_RecipientInfo_type(CMS_RecipientInfo *ri); |
| 146 |
\& |
| 147 |
\& int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri, ASN1_OCTET_STRING **keyid, X509_NAME **issuer, ASN1_INTEGER **sno); |
| 148 |
\& int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert); |
| 149 |
\& int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey); |
| 150 |
\& |
| 151 |
\& int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo *ri, X509_ALGOR **palg, ASN1_OCTET_STRING **pid, ASN1_GENERALIZEDTIME **pdate, ASN1_OBJECT **potherid, ASN1_TYPE **pothertype); |
| 152 |
\& int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo *ri, const unsigned char *id, size_t idlen); |
| 153 |
\& int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri, unsigned char *key, size_t keylen); |
| 154 |
\& |
| 155 |
\& int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri); |
| 156 |
\& int CMS_RecipientInfo_encrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri); |
| 157 |
.Ve |
| 158 |
.SH "DESCRIPTION" |
| 159 |
.IX Header "DESCRIPTION" |
| 160 |
The function \fICMS_get0_RecipientInfos()\fR returns all the CMS_RecipientInfo |
| 161 |
structures associated with a \s-1CMS\s0 EnvelopedData structure. |
| 162 |
.PP |
| 163 |
\&\fICMS_RecipientInfo_type()\fR returns the type of CMS_RecipientInfo structure \fBri\fR. |
| 164 |
It will currently return \s-1CMS_RECIPINFO_TRANS, CMS_RECIPINFO_AGREE, |
| 165 |
CMS_RECIPINFO_KEK, CMS_RECIPINFO_PASS,\s0 or \s-1CMS_RECIPINFO_OTHER.\s0 |
| 166 |
.PP |
| 167 |
\&\fICMS_RecipientInfo_ktri_get0_signer_id()\fR retrieves the certificate recipient |
| 168 |
identifier associated with a specific CMS_RecipientInfo structure \fBri\fR, which |
| 169 |
must be of type \s-1CMS_RECIPINFO_TRANS.\s0 Either the keyidentifier will be set in |
| 170 |
\&\fBkeyid\fR or \fBboth\fR issuer name and serial number in \fBissuer\fR and \fBsno\fR. |
| 171 |
.PP |
| 172 |
\&\fICMS_RecipientInfo_ktri_cert_cmp()\fR compares the certificate \fBcert\fR against the |
| 173 |
CMS_RecipientInfo structure \fBri\fR, which must be of type \s-1CMS_RECIPINFO_TRANS.\s0 |
| 174 |
It returns zero if the comparison is successful and non zero if not. |
| 175 |
.PP |
| 176 |
\&\fICMS_RecipientInfo_set0_pkey()\fR associates the private key \fBpkey\fR with |
| 177 |
the CMS_RecipientInfo structure \fBri\fR, which must be of type |
| 178 |
\&\s-1CMS_RECIPINFO_TRANS.\s0 |
| 179 |
.PP |
| 180 |
\&\fICMS_RecipientInfo_kekri_get0_id()\fR retrieves the key information from the |
| 181 |
CMS_RecipientInfo structure \fBri\fR which must be of type \s-1CMS_RECIPINFO_KEK. \s0 Any |
| 182 |
of the remaining parameters can be \s-1NULL\s0 if the application is not interested in |
| 183 |
the value of a field. Where a field is optional and absent \s-1NULL\s0 will be written |
| 184 |
to the corresponding parameter. The keyEncryptionAlgorithm field is written to |
| 185 |
\&\fBpalg\fR, the \fBkeyIdentifier\fR field is written to \fBpid\fR, the \fBdate\fR field if |
| 186 |
present is written to \fBpdate\fR, if the \fBother\fR field is present the components |
| 187 |
\&\fBkeyAttrId\fR and \fBkeyAttr\fR are written to parameters \fBpotherid\fR and |
| 188 |
\&\fBpothertype\fR. |
| 189 |
.PP |
| 190 |
\&\fICMS_RecipientInfo_kekri_id_cmp()\fR compares the \s-1ID\s0 in the \fBid\fR and \fBidlen\fR |
| 191 |
parameters against the \fBkeyIdentifier\fR CMS_RecipientInfo structure \fBri\fR, |
| 192 |
which must be of type \s-1CMS_RECIPINFO_KEK. \s0 It returns zero if the comparison is |
| 193 |
successful and non zero if not. |
| 194 |
.PP |
| 195 |
\&\fICMS_RecipientInfo_set0_key()\fR associates the symmetric key \fBkey\fR of length |
| 196 |
\&\fBkeylen\fR with the CMS_RecipientInfo structure \fBri\fR, which must be of type |
| 197 |
\&\s-1CMS_RECIPINFO_KEK.\s0 |
| 198 |
.PP |
| 199 |
\&\fICMS_RecipientInfo_decrypt()\fR attempts to decrypt CMS_RecipientInfo structure |
| 200 |
\&\fBri\fR in structure \fBcms\fR. A key must have been associated with the structure |
| 201 |
first. |
| 202 |
.PP |
| 203 |
\&\fICMS_RecipientInfo_encrypt()\fR attempts to encrypt CMS_RecipientInfo structure |
| 204 |
\&\fBri\fR in structure \fBcms\fR. A key must have been associated with the structure |
| 205 |
first and the content encryption key must be available: for example by a |
| 206 |
previous call to \fICMS_RecipientInfo_decrypt()\fR. |
| 207 |
.SH "NOTES" |
| 208 |
.IX Header "NOTES" |
| 209 |
The main purpose of these functions is to enable an application to lookup |
| 210 |
recipient keys using any appropriate technique when the simpler method |
| 211 |
of \fICMS_decrypt()\fR is not appropriate. |
| 212 |
.PP |
| 213 |
In typical usage and application will retrieve all CMS_RecipientInfo structures |
| 214 |
using \fICMS_get0_RecipientInfos()\fR and check the type of each using |
| 215 |
\&\fICMS_RecpientInfo_type()\fR. Depending on the type the CMS_RecipientInfo structure |
| 216 |
can be ignored or its key identifier data retrieved using an appropriate |
| 217 |
function. Then if the corresponding secret or private key can be obtained by |
| 218 |
any appropriate means it can then associated with the structure and |
| 219 |
\&\fICMS_RecpientInfo_decrypt()\fR called. If successful \fICMS_decrypt()\fR can be called |
| 220 |
with a \s-1NULL\s0 key to decrypt the enveloped content. |
| 221 |
.PP |
| 222 |
The \fICMS_RecipientInfo_encrypt()\fR can be used to add a new recipient to an |
| 223 |
existing enveloped data structure. Typically an application will first decrypt |
| 224 |
an appropriate CMS_RecipientInfo structure to make the content encrypt key |
| 225 |
available, it will then add a new recipient using a function such as |
| 226 |
\&\fICMS_add1_recipient_cert()\fR and finally encrypt the content encryption key |
| 227 |
using \fICMS_RecipientInfo_encrypt()\fR. |
| 228 |
.SH "RETURN VALUES" |
| 229 |
.IX Header "RETURN VALUES" |
| 230 |
\&\fICMS_get0_RecipientInfos()\fR returns all CMS_RecipientInfo structures, or \s-1NULL\s0 if |
| 231 |
an error occurs. |
| 232 |
.PP |
| 233 |
\&\fICMS_RecipientInfo_ktri_get0_signer_id()\fR, \fICMS_RecipientInfo_set0_pkey()\fR, |
| 234 |
\&\fICMS_RecipientInfo_kekri_get0_id()\fR, \fICMS_RecipientInfo_set0_key()\fR and |
| 235 |
\&\fICMS_RecipientInfo_decrypt()\fR return 1 for success or 0 if an error occurs. |
| 236 |
\&\fICMS_RecipientInfo_encrypt()\fR return 1 for success or 0 if an error occurs. |
| 237 |
.PP |
| 238 |
\&\fICMS_RecipientInfo_ktri_cert_cmp()\fR and \fICMS_RecipientInfo_kekri_cmp()\fR return 0 |
| 239 |
for a successful comparison and non zero otherwise. |
| 240 |
.PP |
| 241 |
Any error can be obtained from \fIERR_get_error\fR\|(3). |
| 242 |
.SH "SEE ALSO" |
| 243 |
.IX Header "SEE ALSO" |
| 244 |
\&\fIERR_get_error\fR\|(3), \fICMS_decrypt\fR\|(3) |
| 245 |
.SH "HISTORY" |
| 246 |
.IX Header "HISTORY" |
| 247 |
These functions were first was added to OpenSSL 0.9.8 |
Parent Directory
| 
Revision Log