6c33c224e9b062d8e7167dfb0d7cdd9478fd5f67
[openssl.git] / doc / man3 / CMS_get0_RecipientInfos.pod
1 =pod
2
3 =head1 NAME
4
5 CMS_get0_RecipientInfos, CMS_RecipientInfo_type,
6 CMS_RecipientInfo_ktri_get0_signer_id, CMS_RecipientInfo_ktri_cert_cmp,
7 CMS_RecipientInfo_set0_pkey, CMS_RecipientInfo_kekri_get0_id,
8 CMS_RecipientInfo_kekri_id_cmp, CMS_RecipientInfo_set0_key,
9 CMS_RecipientInfo_decrypt, CMS_RecipientInfo_encrypt
10 - CMS envelopedData RecipientInfo routines
11
12 =head1 SYNOPSIS
13
14  #include <openssl/cms.h>
15
16  STACK_OF(CMS_RecipientInfo) *CMS_get0_RecipientInfos(CMS_ContentInfo *cms);
17  int CMS_RecipientInfo_type(CMS_RecipientInfo *ri);
18
19  int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri, ASN1_OCTET_STRING **keyid, X509_NAME **issuer, ASN1_INTEGER **sno);
20  int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert);
21  int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey);
22
23  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);
24  int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo *ri, const unsigned char *id, size_t idlen);
25  int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri, unsigned char *key, size_t keylen);
26
27  int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri);
28  int CMS_RecipientInfo_encrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri);
29
30 =head1 DESCRIPTION
31
32 The function CMS_get0_RecipientInfos() returns all the CMS_RecipientInfo
33 structures associated with a CMS EnvelopedData structure.
34
35 CMS_RecipientInfo_type() returns the type of CMS_RecipientInfo structure B<ri>.
36 It will currently return CMS_RECIPINFO_TRANS, CMS_RECIPINFO_AGREE,
37 CMS_RECIPINFO_KEK, CMS_RECIPINFO_PASS, or CMS_RECIPINFO_OTHER.
38
39 CMS_RecipientInfo_ktri_get0_signer_id() retrieves the certificate recipient
40 identifier associated with a specific CMS_RecipientInfo structure B<ri>, which
41 must be of type CMS_RECIPINFO_TRANS. Either the keyidentifier will be set in
42 B<keyid> or B<both> issuer name and serial number in B<issuer> and B<sno>.
43
44 CMS_RecipientInfo_ktri_cert_cmp() compares the certificate B<cert> against the
45 CMS_RecipientInfo structure B<ri>, which must be of type CMS_RECIPINFO_TRANS.
46 It returns zero if the comparison is successful and non zero if not.
47
48 CMS_RecipientInfo_set0_pkey() associates the private key B<pkey> with
49 the CMS_RecipientInfo structure B<ri>, which must be of type
50 CMS_RECIPINFO_TRANS.
51
52 CMS_RecipientInfo_kekri_get0_id() retrieves the key information from the
53 CMS_RecipientInfo structure B<ri> which must be of type CMS_RECIPINFO_KEK.  Any
54 of the remaining parameters can be NULL if the application is not interested in
55 the value of a field. Where a field is optional and absent NULL will be written
56 to the corresponding parameter. The keyEncryptionAlgorithm field is written to
57 B<palg>, the B<keyIdentifier> field is written to B<pid>, the B<date> field if
58 present is written to B<pdate>, if the B<other> field is present the components
59 B<keyAttrId> and B<keyAttr> are written to parameters B<potherid> and
60 B<pothertype>.
61
62 CMS_RecipientInfo_kekri_id_cmp() compares the ID in the B<id> and B<idlen>
63 parameters against the B<keyIdentifier> CMS_RecipientInfo structure B<ri>,
64 which must be of type CMS_RECIPINFO_KEK.  It returns zero if the comparison is
65 successful and non zero if not.
66
67 CMS_RecipientInfo_set0_key() associates the symmetric key B<key> of length
68 B<keylen> with the CMS_RecipientInfo structure B<ri>, which must be of type
69 CMS_RECIPINFO_KEK.
70
71 CMS_RecipientInfo_decrypt() attempts to decrypt CMS_RecipientInfo structure
72 B<ri> in structure B<cms>. A key must have been associated with the structure
73 first.
74
75 CMS_RecipientInfo_encrypt() attempts to encrypt CMS_RecipientInfo structure
76 B<ri> in structure B<cms>. A key must have been associated with the structure
77 first and the content encryption key must be available: for example by a
78 previous call to CMS_RecipientInfo_decrypt().
79
80 =head1 NOTES
81
82 The main purpose of these functions is to enable an application to lookup
83 recipient keys using any appropriate technique when the simpler method
84 of CMS_decrypt() is not appropriate.
85
86 In typical usage and application will retrieve all CMS_RecipientInfo structures
87 using CMS_get0_RecipientInfos() and check the type of each using
88 CMS_RecpientInfo_type(). Depending on the type the CMS_RecipientInfo structure
89 can be ignored or its key identifier data retrieved using an appropriate
90 function. Then if the corresponding secret or private key can be obtained by
91 any appropriate means it can then associated with the structure and
92 CMS_RecpientInfo_decrypt() called. If successful CMS_decrypt() can be called
93 with a NULL key to decrypt the enveloped content.
94
95 The CMS_RecipientInfo_encrypt() can be used to add a new recipient to an
96 existing enveloped data structure. Typically an application will first decrypt
97 an appropriate CMS_RecipientInfo structure to make the content encrypt key
98 available, it will then add a new recipient using a function such as
99 CMS_add1_recipient_cert() and finally encrypt the content encryption key
100 using CMS_RecipientInfo_encrypt().
101
102 =head1 RETURN VALUES
103
104 CMS_get0_RecipientInfos() returns all CMS_RecipientInfo structures, or NULL if
105 an error occurs.
106
107 CMS_RecipientInfo_ktri_get0_signer_id(), CMS_RecipientInfo_set0_pkey(),
108 CMS_RecipientInfo_kekri_get0_id(), CMS_RecipientInfo_set0_key() and
109 CMS_RecipientInfo_decrypt() return 1 for success or 0 if an error occurs.
110 CMS_RecipientInfo_encrypt() return 1 for success or 0 if an error occurs.
111
112 CMS_RecipientInfo_ktri_cert_cmp() and CMS_RecipientInfo_kekri_cmp() return 0
113 for a successful comparison and non zero otherwise.
114
115 Any error can be obtained from L<ERR_get_error(3)>.
116
117 =head1 SEE ALSO
118
119 L<ERR_get_error(3)>, L<CMS_decrypt(3)>
120
121 =head1 COPYRIGHT
122
123 Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved.
124
125 Licensed under the OpenSSL license (the "License").  You may not use
126 this file except in compliance with the License.  You can obtain a copy
127 in the file LICENSE in the source distribution or at
128 L<https://www.openssl.org/source/license.html>.
129
130 =cut