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