New utility functions for encryptedData content type which will also be used
[openssl.git] / crypto / cms / cms.h
1 /* crypto/cms/cms.h */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project.
4  */
5 /* ====================================================================
6  * Copyright (c) 2008 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  */
53
54
55 #ifndef HEADER_CMS_H
56 #define HEADER_CMS_H
57
58 #include <openssl/x509.h>
59
60 #ifdef OPENSSL_NO_CMS
61 #error CMS is disabled.
62 #endif
63
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67
68
69 typedef struct CMS_ContentInfo_st CMS_ContentInfo;
70 typedef struct CMS_SignerInfo_st CMS_SignerInfo;
71 typedef struct CMS_CertificateChoices CMS_CertificateChoices;
72 typedef struct CMS_RevocationInfoChoice_st CMS_RevocationInfoChoice;
73
74 DECLARE_STACK_OF(CMS_SignerInfo)
75 DECLARE_ASN1_FUNCTIONS(CMS_ContentInfo)
76 DECLARE_ASN1_PRINT_FUNCTION(CMS_ContentInfo)
77
78 #define CMS_SIGNERINFO_ISSUER_SERIAL    0
79 #define CMS_SIGNERINFO_KEYIDENTIFIER    1
80
81 /* S/MIME related flags */
82
83 #define CMS_TEXT                        0x1
84 #define CMS_NOCERTS                     0x2
85 #define CMS_NO_CONTENT_VERIFY           0x4
86 #define CMS_NO_ATTR_VERIFY              0x8
87 #define CMS_NOSIGS                      \
88                         (CMS_NO_CONTENT_VERIFY|CMS_NO_ATTR_VERIFY)
89 #define CMS_NOINTERN                    0x10
90 #define CMS_NO_SIGNER_CERT_VERIFY       0x20
91 #define CMS_NOVERIFY                    0x20
92 #define CMS_DETACHED                    0x40
93 #define CMS_BINARY                      0x80
94 #define CMS_NOATTR                      0x100
95 #define CMS_NOSMIMECAP                  0x200
96 #define CMS_NOOLDMIMETYPE               0x400
97 #define CMS_CRLFEOL                     0x800
98 #define CMS_STREAM                      0x1000
99 #define CMS_NOCRL                       0x2000
100 #define CMS_PARTIAL                     0x4000
101 #define CMS_REUSE_DIGEST                0x8000
102 #define CMS_USE_KEYID                   0x10000
103
104 const ASN1_OBJECT *CMS_get0_type(CMS_ContentInfo *cms);
105 CMS_ContentInfo *CMS_Data_Create(void);
106
107 BIO *CMS_dataInit(CMS_ContentInfo *cms, BIO *icont);
108 int CMS_dataFinal(CMS_ContentInfo *cms, BIO *bio);
109
110 ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms);
111 int CMS_is_detached(CMS_ContentInfo *cms);
112 int CMS_set_detached(CMS_ContentInfo *cms, int detached);
113
114 #ifdef HEADER_PEM_H
115 DECLARE_PEM_rw_const(CMS, CMS_ContentInfo)
116 #endif
117
118 int CMS_stream(unsigned char ***boundary, CMS_ContentInfo *cms);
119 CMS_ContentInfo *d2i_CMS_bio(BIO *bp, CMS_ContentInfo **cms);
120 int i2d_CMS_bio(BIO *bp, CMS_ContentInfo *cms);
121
122 BIO *BIO_new_CMS(BIO *out, CMS_ContentInfo *cms);
123 int i2d_CMS_bio_stream(BIO *out, CMS_ContentInfo *cms, BIO *in, int flags);
124 int PEM_write_bio_CMS_stream(BIO *out, CMS_ContentInfo *cms, BIO *in, int flags);
125 CMS_ContentInfo *SMIME_read_CMS(BIO *bio, BIO **bcont);
126 int SMIME_write_CMS(BIO *bio, CMS_ContentInfo *cms, BIO *data, int flags);
127
128 int CMS_final(CMS_ContentInfo *cms, BIO *data, int flags);
129
130 CMS_ContentInfo *CMS_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs,
131                                                 BIO *data, unsigned int flags);
132
133 int CMS_data(CMS_ContentInfo *cms, BIO *out, unsigned int flags);
134 CMS_ContentInfo *CMS_data_create(BIO *in, unsigned int flags);
135
136 int CMS_digest_verify(CMS_ContentInfo *cms, BIO *dcont, BIO *out,
137                                                         unsigned int flags);
138 CMS_ContentInfo *CMS_digest_create(BIO *in, const EVP_MD *md,
139                                                         unsigned int flags);
140
141 int CMS_verify(CMS_ContentInfo *cms, STACK_OF(X509) *certs,
142                  X509_STORE *store, BIO *dcont, BIO *out, unsigned int flags);
143
144 STACK_OF(X509) *CMS_get0_signers(CMS_ContentInfo *cms);
145
146 CMS_ContentInfo *CMS_encrypt(STACK_OF(X509) *certs, BIO *in,
147                                 const EVP_CIPHER *cipher, unsigned int flags);
148
149 int CMS_decrypt(CMS_ContentInfo *cms, EVP_PKEY *pkey, X509 *cert, BIO *data,
150                                 unsigned int flags);
151
152 int CMS_uncompress(CMS_ContentInfo *cms, BIO *dcont, BIO *out,
153                                                         unsigned int flags);
154 CMS_ContentInfo *CMS_compress(BIO *in, int comp_nid, unsigned int flags);
155
156 int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid);
157 const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms);
158
159 CMS_CertificateChoices *CMS_add0_CertificateChoices(CMS_ContentInfo *cms);
160 int CMS_add0_cert(CMS_ContentInfo *cms, X509 *cert);
161 int CMS_add1_cert(CMS_ContentInfo *cms, X509 *cert);
162 STACK_OF(X509) *CMS_get1_certs(CMS_ContentInfo *cms);
163
164 CMS_RevocationInfoChoice *CMS_add0_RevocationInfoChoice(CMS_ContentInfo *cms);
165 int CMS_add0_crl(CMS_ContentInfo *cms, X509_CRL *crl);
166 STACK_OF(X509_CRL) *CMS_get1_crls(CMS_ContentInfo *cms);
167
168 int CMS_SignedData_init(CMS_ContentInfo *cms);
169 CMS_SignerInfo *CMS_add1_signer(CMS_ContentInfo *cms,
170                         X509 *signer, EVP_PKEY *pk, const EVP_MD *md,
171                         unsigned int flags);
172 STACK_OF(CMS_SignerInfo) *CMS_get0_SignerInfos(CMS_ContentInfo *cms);
173
174 void CMS_SignerInfo_set1_signer_cert(CMS_SignerInfo *si, X509 *signer);
175 int CMS_SignerInfo_get0_signer_id(CMS_SignerInfo *si,
176                                         ASN1_OCTET_STRING **keyid,
177                                         X509_NAME **issuer, ASN1_INTEGER **sno);
178 int CMS_SignerInfo_cert_cmp(CMS_SignerInfo *si, X509 *cert);
179 int CMS_set1_signers_certs(CMS_ContentInfo *cms, STACK_OF(X509) *certs,
180                                         unsigned int flags);
181 void CMS_SignerInfo_get0_algs(CMS_SignerInfo *si, EVP_PKEY **pk, X509 **signer,
182                                         X509_ALGOR **pdig, X509_ALGOR **psig);
183 int CMS_SignerInfo_sign(CMS_SignerInfo *si);
184 int CMS_SignerInfo_verify(CMS_SignerInfo *si);
185 int CMS_SignerInfo_verify_content(CMS_SignerInfo *si, BIO *chain);
186
187 int CMS_add_smimecap(CMS_SignerInfo *si, STACK_OF(X509_ALGOR) *algs);
188 int CMS_add_simple_smimecap(STACK_OF(X509_ALGOR) **algs,
189                                 int algnid, int keysize);
190 int CMS_add_standard_smimecap(STACK_OF(X509_ALGOR) **smcap);
191
192 int CMS_signed_get_attr_count(const CMS_SignerInfo *si);
193 int CMS_signed_get_attr_by_NID(const CMS_SignerInfo *si, int nid,
194                           int lastpos);
195 int CMS_signed_get_attr_by_OBJ(const CMS_SignerInfo *si, ASN1_OBJECT *obj,
196                           int lastpos);
197 X509_ATTRIBUTE *CMS_signed_get_attr(const CMS_SignerInfo *si, int loc);
198 X509_ATTRIBUTE *CMS_signed_delete_attr(CMS_SignerInfo *si, int loc);
199 int CMS_signed_add1_attr(CMS_SignerInfo *si, X509_ATTRIBUTE *attr);
200 int CMS_signed_add1_attr_by_OBJ(CMS_SignerInfo *si,
201                         const ASN1_OBJECT *obj, int type,
202                         const void *bytes, int len);
203 int CMS_signed_add1_attr_by_NID(CMS_SignerInfo *si,
204                         int nid, int type,
205                         const void *bytes, int len);
206 int CMS_signed_add1_attr_by_txt(CMS_SignerInfo *si,
207                         const char *attrname, int type,
208                         const void *bytes, int len);
209 void *CMS_signed_get0_data_by_OBJ(CMS_SignerInfo *si, ASN1_OBJECT *oid,
210                                         int lastpos, int type);
211
212 int CMS_unsigned_get_attr_count(const CMS_SignerInfo *si);
213 int CMS_unsigned_get_attr_by_NID(const CMS_SignerInfo *si, int nid,
214                           int lastpos);
215 int CMS_unsigned_get_attr_by_OBJ(const CMS_SignerInfo *si, ASN1_OBJECT *obj,
216                           int lastpos);
217 X509_ATTRIBUTE *CMS_unsigned_get_attr(const CMS_SignerInfo *si, int loc);
218 X509_ATTRIBUTE *CMS_unsigned_delete_attr(CMS_SignerInfo *si, int loc);
219 int CMS_unsigned_add1_attr(CMS_SignerInfo *si, X509_ATTRIBUTE *attr);
220 int CMS_unsigned_add1_attr_by_OBJ(CMS_SignerInfo *si,
221                         const ASN1_OBJECT *obj, int type,
222                         const void *bytes, int len);
223 int CMS_unsigned_add1_attr_by_NID(CMS_SignerInfo *si,
224                         int nid, int type,
225                         const void *bytes, int len);
226 int CMS_unsigned_add1_attr_by_txt(CMS_SignerInfo *si,
227                         const char *attrname, int type,
228                         const void *bytes, int len);
229 void *CMS_unsigned_get0_data_by_OBJ(CMS_SignerInfo *si, ASN1_OBJECT *oid,
230                                         int lastpos, int type);
231
232 /* BEGIN ERROR CODES */
233 /* The following lines are auto generated by the script mkerr.pl. Any changes
234  * made after this point may be overwritten when the script is next run.
235  */
236 void ERR_load_CMS_strings(void);
237
238 /* Error codes for the CMS functions. */
239
240 /* Function codes. */
241 #define CMS_F_CMS_ADD1_RECIPIENT_CERT                    99
242 #define CMS_F_CMS_ADD1_SIGNER                            100
243 #define CMS_F_CMS_ADD1_SIGNINGTIME                       101
244 #define CMS_F_CMS_BIO_TO_ENCRYPTEDCONTENT                137
245 #define CMS_F_CMS_COMPRESS                               102
246 #define CMS_F_CMS_COMPRESSEDDATA_CREATE                  103
247 #define CMS_F_CMS_COMPRESSEDDATA_INIT_BIO                104
248 #define CMS_F_CMS_COPY_CONTENT                           105
249 #define CMS_F_CMS_COPY_MESSAGEDIGEST                     106
250 #define CMS_F_CMS_DATA                                   107
251 #define CMS_F_CMS_DATAFINAL                              108
252 #define CMS_F_CMS_DATAINIT                               109
253 #define CMS_F_CMS_DIGESTALGORITHM_FIND_CTX               110
254 #define CMS_F_CMS_DIGESTALGORITHM_INIT_BIO               111
255 #define CMS_F_CMS_DIGESTEDDATA_DO_FINAL                  112
256 #define CMS_F_CMS_DIGEST_VERIFY                          113
257 #define CMS_F_CMS_ENCRYPTEDCONTENT_TO_BIO                138
258 #define CMS_F_CMS_ENVELOPED_DATA_INIT                    114
259 #define CMS_F_CMS_FINAL                                  115
260 #define CMS_F_CMS_GET0_CERTIFICATE_CHOICES               116
261 #define CMS_F_CMS_GET0_CONTENT                           117
262 #define CMS_F_CMS_GET0_ECONTENT_TYPE                     118
263 #define CMS_F_CMS_GET0_ENVELOPED                         119
264 #define CMS_F_CMS_GET0_REVOCATION_CHOICES                120
265 #define CMS_F_CMS_GET0_SIGNED                            121
266 #define CMS_F_CMS_RECIPIENTINFO_KTRI_CERT_CMP            122
267 #define CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_ALGS           123
268 #define CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_SIGNER_ID      124
269 #define CMS_F_CMS_SET1_SIGNERIDENTIFIER                  125
270 #define CMS_F_CMS_SET_DETACHED                           126
271 #define CMS_F_CMS_SIGN                                   127
272 #define CMS_F_CMS_SIGNED_DATA_INIT                       128
273 #define CMS_F_CMS_SIGNERINFO_CONTENT_SIGN                129
274 #define CMS_F_CMS_SIGNERINFO_SIGN                        130
275 #define CMS_F_CMS_SIGNERINFO_VERIFY                      131
276 #define CMS_F_CMS_SIGNERINFO_VERIFY_CERT                 132
277 #define CMS_F_CMS_SIGNERINFO_VERIFY_CONTENT              133
278 #define CMS_F_CMS_STREAM                                 134
279 #define CMS_F_CMS_UNCOMPRESS                             135
280 #define CMS_F_CMS_VERIFY                                 136
281
282 /* Reason codes. */
283 #define CMS_R_ADD_SIGNER_ERROR                           99
284 #define CMS_R_CERTIFICATE_VERIFY_ERROR                   100
285 #define CMS_R_CIPHER_INITIALISATION_ERROR                138
286 #define CMS_R_CIPHER_PARAMETER_INITIALISATION_ERROR      139
287 #define CMS_R_CMS_DATAFINAL_ERROR                        101
288 #define CMS_R_CONTENT_NOT_FOUND                          102
289 #define CMS_R_CONTENT_TYPE_NOT_COMPRESSED_DATA           103
290 #define CMS_R_CONTENT_TYPE_NOT_ENVELOPED_DATA            104
291 #define CMS_R_CONTENT_TYPE_NOT_SIGNED_DATA               105
292 #define CMS_R_CONTENT_VERIFY_ERROR                       106
293 #define CMS_R_CTRL_ERROR                                 107
294 #define CMS_R_CTRL_FAILURE                               108
295 #define CMS_R_ERROR_GETTING_PUBLIC_KEY                   109
296 #define CMS_R_ERROR_READING_MESSAGEDIGEST_ATTRIBUTE      110
297 #define CMS_R_INVALID_KEY_LENGTH                         140
298 #define CMS_R_MD_BIO_INIT_ERROR                          111
299 #define CMS_R_MESSAGEDIGEST_ATTRIBUTE_WRONG_LENGTH       112
300 #define CMS_R_MESSAGEDIGEST_WRONG_LENGTH                 113
301 #define CMS_R_NOT_KEY_TRANSPORT                          114
302 #define CMS_R_NOT_SUPPORTED_FOR_THIS_KEY_TYPE            115
303 #define CMS_R_NO_CONTENT                                 116
304 #define CMS_R_NO_DEFAULT_DIGEST                          117
305 #define CMS_R_NO_DIGEST_SET                              118
306 #define CMS_R_NO_MATCHING_DIGEST                         119
307 #define CMS_R_NO_PRIVATE_KEY                             120
308 #define CMS_R_NO_PUBLIC_KEY                              121
309 #define CMS_R_NO_SIGNERS                                 122
310 #define CMS_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE     123
311 #define CMS_R_SIGNER_CERTIFICATE_NOT_FOUND               124
312 #define CMS_R_SIGNFINAL_ERROR                            125
313 #define CMS_R_SMIME_TEXT_ERROR                           126
314 #define CMS_R_STORE_INIT_ERROR                           127
315 #define CMS_R_TYPE_NOT_COMPRESSED_DATA                   128
316 #define CMS_R_TYPE_NOT_DATA                              129
317 #define CMS_R_TYPE_NOT_DIGESTED_DATA                     130
318 #define CMS_R_UNABLE_TO_FINALIZE_CONTEXT                 131
319 #define CMS_R_UNKNOWN_CIPHER                             141
320 #define CMS_R_UNKNOWN_DIGEST_ALGORIHM                    132
321 #define CMS_R_UNKNOWN_ID                                 133
322 #define CMS_R_UNSUPPORTED_COMPRESSION_ALGORITHM          134
323 #define CMS_R_UNSUPPORTED_CONTENT_TYPE                   135
324 #define CMS_R_UNSUPPORTED_TYPE                           136
325 #define CMS_R_VERIFICATION_FAILURE                       137
326
327 #ifdef  __cplusplus
328 }
329 #endif
330 #endif