]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/cms.h
make error tables const and separate header file
[thirdparty/openssl.git] / include / openssl / cms.h
CommitLineData
0f113f3e 1/*
21dcbebc 2 * Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved.
8931b30d 3 *
21dcbebc
RS
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8931b30d
DSH
8 */
9
8931b30d 10#ifndef HEADER_CMS_H
0f113f3e 11# define HEADER_CMS_H
8931b30d 12
3c27208f
RS
13# include <openssl/opensslconf.h>
14
15# ifndef OPENSSL_NO_CMS
0f113f3e 16# include <openssl/x509.h>
4a640fb6 17# include <openssl/x509v3.h>
52df25cf 18# include <openssl/cmserr.h>
3c27208f 19# ifdef __cplusplus
8931b30d 20extern "C" {
3c27208f 21# endif
8931b30d 22
8931b30d
DSH
23typedef struct CMS_ContentInfo_st CMS_ContentInfo;
24typedef struct CMS_SignerInfo_st CMS_SignerInfo;
25typedef struct CMS_CertificateChoices CMS_CertificateChoices;
26typedef struct CMS_RevocationInfoChoice_st CMS_RevocationInfoChoice;
4f1aa191 27typedef struct CMS_RecipientInfo_st CMS_RecipientInfo;
be86c7fc
DSH
28typedef struct CMS_ReceiptRequest_st CMS_ReceiptRequest;
29typedef struct CMS_Receipt_st CMS_Receipt;
17c2764d
DSH
30typedef struct CMS_RecipientEncryptedKey_st CMS_RecipientEncryptedKey;
31typedef struct CMS_OtherKeyAttribute_st CMS_OtherKeyAttribute;
8931b30d 32
85885715
DSH
33DEFINE_STACK_OF(CMS_SignerInfo)
34DEFINE_STACK_OF(CMS_RecipientEncryptedKey)
35DEFINE_STACK_OF(CMS_RecipientInfo)
36DEFINE_STACK_OF(CMS_RevocationInfoChoice)
8931b30d 37DECLARE_ASN1_FUNCTIONS(CMS_ContentInfo)
f4cc56f4 38DECLARE_ASN1_FUNCTIONS(CMS_ReceiptRequest)
8931b30d
DSH
39DECLARE_ASN1_PRINT_FUNCTION(CMS_ContentInfo)
40
0f113f3e
MC
41# define CMS_SIGNERINFO_ISSUER_SERIAL 0
42# define CMS_SIGNERINFO_KEYIDENTIFIER 1
8931b30d 43
0f113f3e
MC
44# define CMS_RECIPINFO_NONE -1
45# define CMS_RECIPINFO_TRANS 0
46# define CMS_RECIPINFO_AGREE 1
47# define CMS_RECIPINFO_KEK 2
48# define CMS_RECIPINFO_PASS 3
49# define CMS_RECIPINFO_OTHER 4
4f1aa191 50
8931b30d
DSH
51/* S/MIME related flags */
52
0f113f3e
MC
53# define CMS_TEXT 0x1
54# define CMS_NOCERTS 0x2
55# define CMS_NO_CONTENT_VERIFY 0x4
56# define CMS_NO_ATTR_VERIFY 0x8
57# define CMS_NOSIGS \
58 (CMS_NO_CONTENT_VERIFY|CMS_NO_ATTR_VERIFY)
59# define CMS_NOINTERN 0x10
60# define CMS_NO_SIGNER_CERT_VERIFY 0x20
61# define CMS_NOVERIFY 0x20
62# define CMS_DETACHED 0x40
63# define CMS_BINARY 0x80
64# define CMS_NOATTR 0x100
65# define CMS_NOSMIMECAP 0x200
66# define CMS_NOOLDMIMETYPE 0x400
67# define CMS_CRLFEOL 0x800
68# define CMS_STREAM 0x1000
69# define CMS_NOCRL 0x2000
70# define CMS_PARTIAL 0x4000
71# define CMS_REUSE_DIGEST 0x8000
72# define CMS_USE_KEYID 0x10000
73# define CMS_DEBUG_DECRYPT 0x20000
74# define CMS_KEY_PARAM 0x40000
75# define CMS_ASCIICRLF 0x80000
8931b30d 76
dc423f89 77const ASN1_OBJECT *CMS_get0_type(const CMS_ContentInfo *cms);
8931b30d
DSH
78
79BIO *CMS_dataInit(CMS_ContentInfo *cms, BIO *icont);
80int CMS_dataFinal(CMS_ContentInfo *cms, BIO *bio);
81
82ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms);
83int CMS_is_detached(CMS_ContentInfo *cms);
84int CMS_set_detached(CMS_ContentInfo *cms, int detached);
85
0f113f3e 86# ifdef HEADER_PEM_H
8931b30d 87DECLARE_PEM_rw_const(CMS, CMS_ContentInfo)
0f113f3e 88# endif
8931b30d
DSH
89int CMS_stream(unsigned char ***boundary, CMS_ContentInfo *cms);
90CMS_ContentInfo *d2i_CMS_bio(BIO *bp, CMS_ContentInfo **cms);
91int i2d_CMS_bio(BIO *bp, CMS_ContentInfo *cms);
92
93BIO *BIO_new_CMS(BIO *out, CMS_ContentInfo *cms);
94int i2d_CMS_bio_stream(BIO *out, CMS_ContentInfo *cms, BIO *in, int flags);
0f113f3e
MC
95int PEM_write_bio_CMS_stream(BIO *out, CMS_ContentInfo *cms, BIO *in,
96 int flags);
8931b30d
DSH
97CMS_ContentInfo *SMIME_read_CMS(BIO *bio, BIO **bcont);
98int SMIME_write_CMS(BIO *bio, CMS_ContentInfo *cms, BIO *data, int flags);
99
0f113f3e
MC
100int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont,
101 unsigned int flags);
8931b30d 102
0f113f3e
MC
103CMS_ContentInfo *CMS_sign(X509 *signcert, EVP_PKEY *pkey,
104 STACK_OF(X509) *certs, BIO *data,
105 unsigned int flags);
8931b30d 106
36309aa2 107CMS_ContentInfo *CMS_sign_receipt(CMS_SignerInfo *si,
0f113f3e
MC
108 X509 *signcert, EVP_PKEY *pkey,
109 STACK_OF(X509) *certs, unsigned int flags);
36309aa2 110
8931b30d
DSH
111int CMS_data(CMS_ContentInfo *cms, BIO *out, unsigned int flags);
112CMS_ContentInfo *CMS_data_create(BIO *in, unsigned int flags);
113
114int CMS_digest_verify(CMS_ContentInfo *cms, BIO *dcont, BIO *out,
0f113f3e 115 unsigned int flags);
8931b30d 116CMS_ContentInfo *CMS_digest_create(BIO *in, const EVP_MD *md,
0f113f3e 117 unsigned int flags);
8931b30d 118
b820455c 119int CMS_EncryptedData_decrypt(CMS_ContentInfo *cms,
0f113f3e
MC
120 const unsigned char *key, size_t keylen,
121 BIO *dcont, BIO *out, unsigned int flags);
b820455c 122
d9f5f07e 123CMS_ContentInfo *CMS_EncryptedData_encrypt(BIO *in, const EVP_CIPHER *cipher,
0f113f3e
MC
124 const unsigned char *key,
125 size_t keylen, unsigned int flags);
d9f5f07e 126
320bfc1b 127int CMS_EncryptedData_set1_key(CMS_ContentInfo *cms, const EVP_CIPHER *ciph,
0f113f3e 128 const unsigned char *key, size_t keylen);
b820455c 129
8931b30d 130int CMS_verify(CMS_ContentInfo *cms, STACK_OF(X509) *certs,
0f113f3e 131 X509_STORE *store, BIO *dcont, BIO *out, unsigned int flags);
8931b30d 132
eb9d8d8c 133int CMS_verify_receipt(CMS_ContentInfo *rcms, CMS_ContentInfo *ocms,
0f113f3e
MC
134 STACK_OF(X509) *certs,
135 X509_STORE *store, unsigned int flags);
eb9d8d8c 136
8931b30d
DSH
137STACK_OF(X509) *CMS_get0_signers(CMS_ContentInfo *cms);
138
139CMS_ContentInfo *CMS_encrypt(STACK_OF(X509) *certs, BIO *in,
0f113f3e 140 const EVP_CIPHER *cipher, unsigned int flags);
8931b30d 141
4f1aa191 142int CMS_decrypt(CMS_ContentInfo *cms, EVP_PKEY *pkey, X509 *cert,
0f113f3e
MC
143 BIO *dcont, BIO *out, unsigned int flags);
144
eeb9cdfc 145int CMS_decrypt_set1_pkey(CMS_ContentInfo *cms, EVP_PKEY *pk, X509 *cert);
0f113f3e
MC
146int CMS_decrypt_set1_key(CMS_ContentInfo *cms,
147 unsigned char *key, size_t keylen,
c17dd597 148 const unsigned char *id, size_t idlen);
0f113f3e
MC
149int CMS_decrypt_set1_password(CMS_ContentInfo *cms,
150 unsigned char *pass, ossl_ssize_t passlen);
8931b30d 151
4f1aa191
DSH
152STACK_OF(CMS_RecipientInfo) *CMS_get0_RecipientInfos(CMS_ContentInfo *cms);
153int CMS_RecipientInfo_type(CMS_RecipientInfo *ri);
e365352d 154EVP_PKEY_CTX *CMS_RecipientInfo_get0_pkey_ctx(CMS_RecipientInfo *ri);
761ffa72
DSH
155CMS_ContentInfo *CMS_EnvelopedData_create(const EVP_CIPHER *cipher);
156CMS_RecipientInfo *CMS_add1_recipient_cert(CMS_ContentInfo *cms,
0f113f3e 157 X509 *recip, unsigned int flags);
6e3bc4f0 158int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey);
4f1aa191
DSH
159int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert);
160int CMS_RecipientInfo_ktri_get0_algs(CMS_RecipientInfo *ri,
0f113f3e
MC
161 EVP_PKEY **pk, X509 **recip,
162 X509_ALGOR **palg);
4f1aa191 163int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri,
0f113f3e
MC
164 ASN1_OCTET_STRING **keyid,
165 X509_NAME **issuer,
166 ASN1_INTEGER **sno);
4f1aa191 167
ab124380 168CMS_RecipientInfo *CMS_add0_recipient_key(CMS_ContentInfo *cms, int nid,
0f113f3e
MC
169 unsigned char *key, size_t keylen,
170 unsigned char *id, size_t idlen,
171 ASN1_GENERALIZEDTIME *date,
172 ASN1_OBJECT *otherTypeId,
173 ASN1_TYPE *otherType);
eeb9cdfc 174
f5e2354c 175int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo *ri,
0f113f3e
MC
176 X509_ALGOR **palg,
177 ASN1_OCTET_STRING **pid,
178 ASN1_GENERALIZEDTIME **pdate,
179 ASN1_OBJECT **potherid,
180 ASN1_TYPE **pothertype);
f5e2354c 181
0f113f3e
MC
182int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri,
183 unsigned char *key, size_t keylen);
eeb9cdfc 184
0f113f3e
MC
185int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo *ri,
186 const unsigned char *id, size_t idlen);
eeb9cdfc 187
0f113f3e
MC
188int CMS_RecipientInfo_set0_password(CMS_RecipientInfo *ri,
189 unsigned char *pass,
190 ossl_ssize_t passlen);
d2a53c22
DSH
191
192CMS_RecipientInfo *CMS_add0_recipient_password(CMS_ContentInfo *cms,
0f113f3e
MC
193 int iter, int wrap_nid,
194 int pbe_nid,
195 unsigned char *pass,
196 ossl_ssize_t passlen,
197 const EVP_CIPHER *kekciph);
d2a53c22 198
6e3bc4f0 199int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri);
e1f1d28f 200int CMS_RecipientInfo_encrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri);
0f113f3e 201
a5db50d0 202int CMS_uncompress(CMS_ContentInfo *cms, BIO *dcont, BIO *out,
0f113f3e 203 unsigned int flags);
8931b30d
DSH
204CMS_ContentInfo *CMS_compress(BIO *in, int comp_nid, unsigned int flags);
205
206int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid);
207const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms);
208
209CMS_CertificateChoices *CMS_add0_CertificateChoices(CMS_ContentInfo *cms);
210int CMS_add0_cert(CMS_ContentInfo *cms, X509 *cert);
211int CMS_add1_cert(CMS_ContentInfo *cms, X509 *cert);
212STACK_OF(X509) *CMS_get1_certs(CMS_ContentInfo *cms);
213
214CMS_RevocationInfoChoice *CMS_add0_RevocationInfoChoice(CMS_ContentInfo *cms);
215int CMS_add0_crl(CMS_ContentInfo *cms, X509_CRL *crl);
19048b5c 216int CMS_add1_crl(CMS_ContentInfo *cms, X509_CRL *crl);
8931b30d
DSH
217STACK_OF(X509_CRL) *CMS_get1_crls(CMS_ContentInfo *cms);
218
219int CMS_SignedData_init(CMS_ContentInfo *cms);
220CMS_SignerInfo *CMS_add1_signer(CMS_ContentInfo *cms,
0f113f3e
MC
221 X509 *signer, EVP_PKEY *pk, const EVP_MD *md,
222 unsigned int flags);
e365352d
DSH
223EVP_PKEY_CTX *CMS_SignerInfo_get0_pkey_ctx(CMS_SignerInfo *si);
224EVP_MD_CTX *CMS_SignerInfo_get0_md_ctx(CMS_SignerInfo *si);
8931b30d
DSH
225STACK_OF(CMS_SignerInfo) *CMS_get0_SignerInfos(CMS_ContentInfo *cms);
226
227void CMS_SignerInfo_set1_signer_cert(CMS_SignerInfo *si, X509 *signer);
228int CMS_SignerInfo_get0_signer_id(CMS_SignerInfo *si,
0f113f3e
MC
229 ASN1_OCTET_STRING **keyid,
230 X509_NAME **issuer, ASN1_INTEGER **sno);
8931b30d
DSH
231int CMS_SignerInfo_cert_cmp(CMS_SignerInfo *si, X509 *cert);
232int CMS_set1_signers_certs(CMS_ContentInfo *cms, STACK_OF(X509) *certs,
0f113f3e
MC
233 unsigned int flags);
234void CMS_SignerInfo_get0_algs(CMS_SignerInfo *si, EVP_PKEY **pk,
235 X509 **signer, X509_ALGOR **pdig,
236 X509_ALGOR **psig);
da15c616 237ASN1_OCTET_STRING *CMS_SignerInfo_get0_signature(CMS_SignerInfo *si);
8931b30d
DSH
238int CMS_SignerInfo_sign(CMS_SignerInfo *si);
239int CMS_SignerInfo_verify(CMS_SignerInfo *si);
240int CMS_SignerInfo_verify_content(CMS_SignerInfo *si, BIO *chain);
241
242int CMS_add_smimecap(CMS_SignerInfo *si, STACK_OF(X509_ALGOR) *algs);
243int CMS_add_simple_smimecap(STACK_OF(X509_ALGOR) **algs,
0f113f3e 244 int algnid, int keysize);
8931b30d
DSH
245int CMS_add_standard_smimecap(STACK_OF(X509_ALGOR) **smcap);
246
247int CMS_signed_get_attr_count(const CMS_SignerInfo *si);
248int CMS_signed_get_attr_by_NID(const CMS_SignerInfo *si, int nid,
0f113f3e 249 int lastpos);
c47ba4e9 250int CMS_signed_get_attr_by_OBJ(const CMS_SignerInfo *si, const ASN1_OBJECT *obj,
0f113f3e 251 int lastpos);
8931b30d
DSH
252X509_ATTRIBUTE *CMS_signed_get_attr(const CMS_SignerInfo *si, int loc);
253X509_ATTRIBUTE *CMS_signed_delete_attr(CMS_SignerInfo *si, int loc);
254int CMS_signed_add1_attr(CMS_SignerInfo *si, X509_ATTRIBUTE *attr);
255int CMS_signed_add1_attr_by_OBJ(CMS_SignerInfo *si,
0f113f3e
MC
256 const ASN1_OBJECT *obj, int type,
257 const void *bytes, int len);
8931b30d 258int CMS_signed_add1_attr_by_NID(CMS_SignerInfo *si,
0f113f3e
MC
259 int nid, int type,
260 const void *bytes, int len);
8931b30d 261int CMS_signed_add1_attr_by_txt(CMS_SignerInfo *si,
0f113f3e
MC
262 const char *attrname, int type,
263 const void *bytes, int len);
c47ba4e9 264void *CMS_signed_get0_data_by_OBJ(CMS_SignerInfo *si, const ASN1_OBJECT *oid,
0f113f3e 265 int lastpos, int type);
8931b30d
DSH
266
267int CMS_unsigned_get_attr_count(const CMS_SignerInfo *si);
268int CMS_unsigned_get_attr_by_NID(const CMS_SignerInfo *si, int nid,
0f113f3e 269 int lastpos);
c47ba4e9
F
270int CMS_unsigned_get_attr_by_OBJ(const CMS_SignerInfo *si,
271 const ASN1_OBJECT *obj, int lastpos);
8931b30d
DSH
272X509_ATTRIBUTE *CMS_unsigned_get_attr(const CMS_SignerInfo *si, int loc);
273X509_ATTRIBUTE *CMS_unsigned_delete_attr(CMS_SignerInfo *si, int loc);
274int CMS_unsigned_add1_attr(CMS_SignerInfo *si, X509_ATTRIBUTE *attr);
275int CMS_unsigned_add1_attr_by_OBJ(CMS_SignerInfo *si,
0f113f3e
MC
276 const ASN1_OBJECT *obj, int type,
277 const void *bytes, int len);
8931b30d 278int CMS_unsigned_add1_attr_by_NID(CMS_SignerInfo *si,
0f113f3e
MC
279 int nid, int type,
280 const void *bytes, int len);
8931b30d 281int CMS_unsigned_add1_attr_by_txt(CMS_SignerInfo *si,
0f113f3e
MC
282 const char *attrname, int type,
283 const void *bytes, int len);
8931b30d 284void *CMS_unsigned_get0_data_by_OBJ(CMS_SignerInfo *si, ASN1_OBJECT *oid,
0f113f3e 285 int lastpos, int type);
8931b30d 286
0f113f3e 287# ifdef HEADER_X509V3_H
f4cc56f4
DSH
288
289int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr);
f5e2354c 290CMS_ReceiptRequest *CMS_ReceiptRequest_create0(unsigned char *id, int idlen,
0f113f3e
MC
291 int allorfirst,
292 STACK_OF(GENERAL_NAMES)
293 *receiptList, STACK_OF(GENERAL_NAMES)
294 *receiptsTo);
f5e2354c 295int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr);
f4cc56f4 296void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr,
0f113f3e
MC
297 ASN1_STRING **pcid,
298 int *pallorfirst,
299 STACK_OF(GENERAL_NAMES) **plist,
300 STACK_OF(GENERAL_NAMES) **prto);
301# endif
17c2764d 302int CMS_RecipientInfo_kari_get0_alg(CMS_RecipientInfo *ri,
0f113f3e
MC
303 X509_ALGOR **palg,
304 ASN1_OCTET_STRING **pukm);
305STACK_OF(CMS_RecipientEncryptedKey)
306*CMS_RecipientInfo_kari_get0_reks(CMS_RecipientInfo *ri);
17c2764d
DSH
307
308int CMS_RecipientInfo_kari_get0_orig_id(CMS_RecipientInfo *ri,
0f113f3e
MC
309 X509_ALGOR **pubalg,
310 ASN1_BIT_STRING **pubkey,
311 ASN1_OCTET_STRING **keyid,
312 X509_NAME **issuer,
313 ASN1_INTEGER **sno);
17c2764d
DSH
314
315int CMS_RecipientInfo_kari_orig_id_cmp(CMS_RecipientInfo *ri, X509 *cert);
0f113f3e 316
17c2764d 317int CMS_RecipientEncryptedKey_get0_id(CMS_RecipientEncryptedKey *rek,
0f113f3e
MC
318 ASN1_OCTET_STRING **keyid,
319 ASN1_GENERALIZEDTIME **tm,
320 CMS_OtherKeyAttribute **other,
321 X509_NAME **issuer, ASN1_INTEGER **sno);
17c2764d 322int CMS_RecipientEncryptedKey_cert_cmp(CMS_RecipientEncryptedKey *rek,
0f113f3e 323 X509 *cert);
17c2764d
DSH
324int CMS_RecipientInfo_kari_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pk);
325EVP_CIPHER_CTX *CMS_RecipientInfo_kari_get0_ctx(CMS_RecipientInfo *ri);
0f113f3e
MC
326int CMS_RecipientInfo_kari_decrypt(CMS_ContentInfo *cms,
327 CMS_RecipientInfo *ri,
328 CMS_RecipientEncryptedKey *rek);
f4cc56f4 329
0f113f3e
MC
330int CMS_SharedInfo_encode(unsigned char **pder, X509_ALGOR *kekalg,
331 ASN1_OCTET_STRING *ukm, int keylen);
dc1ce3bc 332
52df25cf
RS
333/* Backward compatibility for spelling errors. */
334# define CMS_R_UNKNOWN_DIGEST_ALGORITM CMS_R_UNKNOWN_DIGEST_ALGORITHM
335# define CMS_R_UNSUPPORTED_RECPIENTINFO_TYPE \
336 CMS_R_UNSUPPORTED_RECIPIENTINFO_TYPE
0cd0a820 337
69588edb 338int ERR_load_CMS_strings(void);
0cd0a820 339# ifdef __cplusplus
8931b30d 340}
0cd0a820 341# endif
3c27208f 342# endif
8931b30d 343#endif