]> 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
CAdES : lowercase name for now internal methods.
[thirdparty/openssl.git] / include / openssl / cms.h
CommitLineData
0f113f3e 1/*
e85d19c6 2 * Copyright 2008-2019 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
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
e85d19c6 76# define CMS_CADES 0x100000
8931b30d 77
dc423f89 78const ASN1_OBJECT *CMS_get0_type(const CMS_ContentInfo *cms);
8931b30d
DSH		 79
80BIO *CMS_dataInit(CMS_ContentInfo *cms, BIO *icont);
81int CMS_dataFinal(CMS_ContentInfo *cms, BIO *bio);
82
83ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms);
84int CMS_is_detached(CMS_ContentInfo *cms);
85int CMS_set_detached(CMS_ContentInfo *cms, int detached);
86
0f113f3e 87# ifdef HEADER_PEM_H
8931b30d 88DECLARE_PEM_rw_const(CMS, CMS_ContentInfo)
0f113f3e 89# endif
8931b30d
DSH		 90int CMS_stream(unsigned char ***boundary, CMS_ContentInfo *cms);
91CMS_ContentInfo *d2i_CMS_bio(BIO *bp, CMS_ContentInfo **cms);
92int i2d_CMS_bio(BIO *bp, CMS_ContentInfo *cms);
93
94BIO *BIO_new_CMS(BIO *out, CMS_ContentInfo *cms);
95int i2d_CMS_bio_stream(BIO *out, CMS_ContentInfo *cms, BIO *in, int flags);
0f113f3e
MC		 96int PEM_write_bio_CMS_stream(BIO *out, CMS_ContentInfo *cms, BIO *in,
97 int flags);
8931b30d
DSH		 98CMS_ContentInfo *SMIME_read_CMS(BIO *bio, BIO **bcont);
99int SMIME_write_CMS(BIO *bio, CMS_ContentInfo *cms, BIO *data, int flags);
100
0f113f3e
MC		 101int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont,
102 unsigned int flags);
8931b30d 103
0f113f3e
MC		 104CMS_ContentInfo *CMS_sign(X509 *signcert, EVP_PKEY *pkey,
105 STACK_OF(X509) *certs, BIO *data,
106 unsigned int flags);
8931b30d 107
36309aa2 108CMS_ContentInfo *CMS_sign_receipt(CMS_SignerInfo *si,
0f113f3e
MC		 109 X509 *signcert, EVP_PKEY *pkey,
110 STACK_OF(X509) *certs, unsigned int flags);
36309aa2 111
8931b30d
DSH		 112int CMS_data(CMS_ContentInfo *cms, BIO *out, unsigned int flags);
113CMS_ContentInfo *CMS_data_create(BIO *in, unsigned int flags);
114
115int CMS_digest_verify(CMS_ContentInfo *cms, BIO *dcont, BIO *out,
0f113f3e 116 unsigned int flags);
8931b30d 117CMS_ContentInfo *CMS_digest_create(BIO *in, const EVP_MD *md,
0f113f3e 118 unsigned int flags);
8931b30d 119
b820455c 120int CMS_EncryptedData_decrypt(CMS_ContentInfo *cms,
0f113f3e
MC		 121 const unsigned char *key, size_t keylen,
122 BIO *dcont, BIO *out, unsigned int flags);
b820455c 123
d9f5f07e 124CMS_ContentInfo *CMS_EncryptedData_encrypt(BIO *in, const EVP_CIPHER *cipher,
0f113f3e
MC		 125 const unsigned char *key,
126 size_t keylen, unsigned int flags);
d9f5f07e 127
320bfc1b 128int CMS_EncryptedData_set1_key(CMS_ContentInfo *cms, const EVP_CIPHER *ciph,
0f113f3e 129 const unsigned char *key, size_t keylen);
b820455c 130
8931b30d 131int CMS_verify(CMS_ContentInfo *cms, STACK_OF(X509) *certs,
0f113f3e 132 X509_STORE *store, BIO *dcont, BIO *out, unsigned int flags);
8931b30d 133
eb9d8d8c 134int CMS_verify_receipt(CMS_ContentInfo *rcms, CMS_ContentInfo *ocms,
0f113f3e
MC		 135 STACK_OF(X509) *certs,
136 X509_STORE *store, unsigned int flags);
eb9d8d8c 137
8931b30d
DSH		 138STACK_OF(X509) *CMS_get0_signers(CMS_ContentInfo *cms);
139
140CMS_ContentInfo *CMS_encrypt(STACK_OF(X509) *certs, BIO *in,
0f113f3e 141 const EVP_CIPHER *cipher, unsigned int flags);
8931b30d 142
4f1aa191 143int CMS_decrypt(CMS_ContentInfo *cms, EVP_PKEY *pkey, X509 *cert,
0f113f3e
MC		 144 BIO *dcont, BIO *out, unsigned int flags);
145
eeb9cdfc 146int CMS_decrypt_set1_pkey(CMS_ContentInfo *cms, EVP_PKEY *pk, X509 *cert);
0f113f3e
MC		 147int CMS_decrypt_set1_key(CMS_ContentInfo *cms,
148 unsigned char *key, size_t keylen,
c17dd597 149 const unsigned char *id, size_t idlen);
0f113f3e
MC		 150int CMS_decrypt_set1_password(CMS_ContentInfo *cms,
151 unsigned char *pass, ossl_ssize_t passlen);
8931b30d 152
4f1aa191
DSH		 153STACK_OF(CMS_RecipientInfo) *CMS_get0_RecipientInfos(CMS_ContentInfo *cms);
154int CMS_RecipientInfo_type(CMS_RecipientInfo *ri);
e365352d 155EVP_PKEY_CTX *CMS_RecipientInfo_get0_pkey_ctx(CMS_RecipientInfo *ri);
761ffa72
DSH		 156CMS_ContentInfo *CMS_EnvelopedData_create(const EVP_CIPHER *cipher);
157CMS_RecipientInfo *CMS_add1_recipient_cert(CMS_ContentInfo *cms,
0f113f3e 158 X509 *recip, unsigned int flags);
6e3bc4f0 159int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey);
4f1aa191
DSH		 160int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert);
161int CMS_RecipientInfo_ktri_get0_algs(CMS_RecipientInfo *ri,
0f113f3e
MC		 162 EVP_PKEY **pk, X509 **recip,
163 X509_ALGOR **palg);
4f1aa191 164int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri,
0f113f3e
MC		 165 ASN1_OCTET_STRING **keyid,
166 X509_NAME **issuer,
167 ASN1_INTEGER **sno);
4f1aa191 168
ab124380 169CMS_RecipientInfo *CMS_add0_recipient_key(CMS_ContentInfo *cms, int nid,
0f113f3e
MC		 170 unsigned char *key, size_t keylen,
171 unsigned char *id, size_t idlen,
172 ASN1_GENERALIZEDTIME *date,
173 ASN1_OBJECT *otherTypeId,
174 ASN1_TYPE *otherType);
eeb9cdfc 175
f5e2354c 176int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo *ri,
0f113f3e
MC		 177 X509_ALGOR **palg,
178 ASN1_OCTET_STRING **pid,
179 ASN1_GENERALIZEDTIME **pdate,
180 ASN1_OBJECT **potherid,
181 ASN1_TYPE **pothertype);
f5e2354c 182
0f113f3e
MC		 183int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri,
184 unsigned char *key, size_t keylen);
eeb9cdfc 185
0f113f3e
MC		 186int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo *ri,
187 const unsigned char *id, size_t idlen);
eeb9cdfc 188
0f113f3e
MC		 189int CMS_RecipientInfo_set0_password(CMS_RecipientInfo *ri,
190 unsigned char *pass,
191 ossl_ssize_t passlen);
d2a53c22
DSH		 192
193CMS_RecipientInfo *CMS_add0_recipient_password(CMS_ContentInfo *cms,
0f113f3e
MC		 194 int iter, int wrap_nid,
195 int pbe_nid,
196 unsigned char *pass,
197 ossl_ssize_t passlen,
198 const EVP_CIPHER *kekciph);
d2a53c22 199
6e3bc4f0 200int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri);
9fdcc21f 201int CMS_RecipientInfo_encrypt(const CMS_ContentInfo *cms, CMS_RecipientInfo *ri);
0f113f3e 202
a5db50d0 203int CMS_uncompress(CMS_ContentInfo *cms, BIO *dcont, BIO *out,
0f113f3e 204 unsigned int flags);
8931b30d
DSH		 205CMS_ContentInfo *CMS_compress(BIO *in, int comp_nid, unsigned int flags);
206
207int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid);
208const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms);
209
210CMS_CertificateChoices *CMS_add0_CertificateChoices(CMS_ContentInfo *cms);
211int CMS_add0_cert(CMS_ContentInfo *cms, X509 *cert);
212int CMS_add1_cert(CMS_ContentInfo *cms, X509 *cert);
213STACK_OF(X509) *CMS_get1_certs(CMS_ContentInfo *cms);
214
215CMS_RevocationInfoChoice *CMS_add0_RevocationInfoChoice(CMS_ContentInfo *cms);
216int CMS_add0_crl(CMS_ContentInfo *cms, X509_CRL *crl);
19048b5c 217int CMS_add1_crl(CMS_ContentInfo *cms, X509_CRL *crl);
8931b30d
DSH		 218STACK_OF(X509_CRL) *CMS_get1_crls(CMS_ContentInfo *cms);
219
220int CMS_SignedData_init(CMS_ContentInfo *cms);
221CMS_SignerInfo *CMS_add1_signer(CMS_ContentInfo *cms,
0f113f3e
MC		 222 X509 *signer, EVP_PKEY *pk, const EVP_MD *md,
223 unsigned int flags);
e365352d
DSH		 224EVP_PKEY_CTX *CMS_SignerInfo_get0_pkey_ctx(CMS_SignerInfo *si);
225EVP_MD_CTX *CMS_SignerInfo_get0_md_ctx(CMS_SignerInfo *si);
8931b30d
DSH		 226STACK_OF(CMS_SignerInfo) *CMS_get0_SignerInfos(CMS_ContentInfo *cms);
227
228void CMS_SignerInfo_set1_signer_cert(CMS_SignerInfo *si, X509 *signer);
229int CMS_SignerInfo_get0_signer_id(CMS_SignerInfo *si,
0f113f3e
MC		 230 ASN1_OCTET_STRING **keyid,
231 X509_NAME **issuer, ASN1_INTEGER **sno);
8931b30d
DSH		 232int CMS_SignerInfo_cert_cmp(CMS_SignerInfo *si, X509 *cert);
233int CMS_set1_signers_certs(CMS_ContentInfo *cms, STACK_OF(X509) *certs,
0f113f3e
MC		 234 unsigned int flags);
235void CMS_SignerInfo_get0_algs(CMS_SignerInfo *si, EVP_PKEY **pk,
236 X509 **signer, X509_ALGOR **pdig,
237 X509_ALGOR **psig);
da15c616 238ASN1_OCTET_STRING *CMS_SignerInfo_get0_signature(CMS_SignerInfo *si);
8931b30d
DSH		 239int CMS_SignerInfo_sign(CMS_SignerInfo *si);
240int CMS_SignerInfo_verify(CMS_SignerInfo *si);
241int CMS_SignerInfo_verify_content(CMS_SignerInfo *si, BIO *chain);
242
243int CMS_add_smimecap(CMS_SignerInfo *si, STACK_OF(X509_ALGOR) *algs);
244int CMS_add_simple_smimecap(STACK_OF(X509_ALGOR) **algs,
0f113f3e 245 int algnid, int keysize);
8931b30d
DSH		 246int CMS_add_standard_smimecap(STACK_OF(X509_ALGOR) **smcap);
247
248int CMS_signed_get_attr_count(const CMS_SignerInfo *si);
249int CMS_signed_get_attr_by_NID(const CMS_SignerInfo *si, int nid,
0f113f3e 250 int lastpos);
c47ba4e9 251int CMS_signed_get_attr_by_OBJ(const CMS_SignerInfo *si, const ASN1_OBJECT *obj,
0f113f3e 252 int lastpos);
8931b30d
DSH		 253X509_ATTRIBUTE *CMS_signed_get_attr(const CMS_SignerInfo *si, int loc);
254X509_ATTRIBUTE *CMS_signed_delete_attr(CMS_SignerInfo *si, int loc);
255int CMS_signed_add1_attr(CMS_SignerInfo *si, X509_ATTRIBUTE *attr);
256int CMS_signed_add1_attr_by_OBJ(CMS_SignerInfo *si,
0f113f3e
MC		 257 const ASN1_OBJECT *obj, int type,
258 const void *bytes, int len);
8931b30d 259int CMS_signed_add1_attr_by_NID(CMS_SignerInfo *si,
0f113f3e
MC		 260 int nid, int type,
261 const void *bytes, int len);
8931b30d 262int CMS_signed_add1_attr_by_txt(CMS_SignerInfo *si,
0f113f3e
MC		 263 const char *attrname, int type,
264 const void *bytes, int len);
c47ba4e9 265void *CMS_signed_get0_data_by_OBJ(CMS_SignerInfo *si, const ASN1_OBJECT *oid,
0f113f3e 266 int lastpos, int type);
8931b30d
DSH		 267
268int CMS_unsigned_get_attr_count(const CMS_SignerInfo *si);
269int CMS_unsigned_get_attr_by_NID(const CMS_SignerInfo *si, int nid,
0f113f3e 270 int lastpos);
c47ba4e9
F		 271int CMS_unsigned_get_attr_by_OBJ(const CMS_SignerInfo *si,
272 const ASN1_OBJECT *obj, int lastpos);
8931b30d
DSH		 273X509_ATTRIBUTE *CMS_unsigned_get_attr(const CMS_SignerInfo *si, int loc);
274X509_ATTRIBUTE *CMS_unsigned_delete_attr(CMS_SignerInfo *si, int loc);
275int CMS_unsigned_add1_attr(CMS_SignerInfo *si, X509_ATTRIBUTE *attr);
276int CMS_unsigned_add1_attr_by_OBJ(CMS_SignerInfo *si,
0f113f3e
MC		 277 const ASN1_OBJECT *obj, int type,
278 const void *bytes, int len);
8931b30d 279int CMS_unsigned_add1_attr_by_NID(CMS_SignerInfo *si,
0f113f3e
MC		 280 int nid, int type,
281 const void *bytes, int len);
8931b30d 282int CMS_unsigned_add1_attr_by_txt(CMS_SignerInfo *si,
0f113f3e
MC		 283 const char *attrname, int type,
284 const void *bytes, int len);
8931b30d 285void *CMS_unsigned_get0_data_by_OBJ(CMS_SignerInfo *si, ASN1_OBJECT *oid,
0f113f3e 286 int lastpos, int type);
8931b30d 287
f4cc56f4 288int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr);
f5e2354c 289CMS_ReceiptRequest *CMS_ReceiptRequest_create0(unsigned char *id, int idlen,
0f113f3e
MC		 290 int allorfirst,
291 STACK_OF(GENERAL_NAMES)
292 *receiptList, STACK_OF(GENERAL_NAMES)
293 *receiptsTo);
f5e2354c 294int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr);
f4cc56f4 295void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr,
0f113f3e
MC		 296 ASN1_STRING **pcid,
297 int *pallorfirst,
298 STACK_OF(GENERAL_NAMES) **plist,
299 STACK_OF(GENERAL_NAMES) **prto);
17c2764d 300int CMS_RecipientInfo_kari_get0_alg(CMS_RecipientInfo *ri,
0f113f3e
MC		 301 X509_ALGOR **palg,
302 ASN1_OCTET_STRING **pukm);
303STACK_OF(CMS_RecipientEncryptedKey)
304*CMS_RecipientInfo_kari_get0_reks(CMS_RecipientInfo *ri);
17c2764d
DSH		 305
306int CMS_RecipientInfo_kari_get0_orig_id(CMS_RecipientInfo *ri,
0f113f3e
MC		 307 X509_ALGOR **pubalg,
308 ASN1_BIT_STRING **pubkey,
309 ASN1_OCTET_STRING **keyid,
310 X509_NAME **issuer,
311 ASN1_INTEGER **sno);
17c2764d
DSH		 312
313int CMS_RecipientInfo_kari_orig_id_cmp(CMS_RecipientInfo *ri, X509 *cert);
0f113f3e 314
17c2764d 315int CMS_RecipientEncryptedKey_get0_id(CMS_RecipientEncryptedKey *rek,
0f113f3e
MC		 316 ASN1_OCTET_STRING **keyid,
317 ASN1_GENERALIZEDTIME **tm,
318 CMS_OtherKeyAttribute **other,
319 X509_NAME **issuer, ASN1_INTEGER **sno);
17c2764d 320int CMS_RecipientEncryptedKey_cert_cmp(CMS_RecipientEncryptedKey *rek,
0f113f3e 321 X509 *cert);
17c2764d
DSH		 322int CMS_RecipientInfo_kari_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pk);
323EVP_CIPHER_CTX *CMS_RecipientInfo_kari_get0_ctx(CMS_RecipientInfo *ri);
0f113f3e
MC		 324int CMS_RecipientInfo_kari_decrypt(CMS_ContentInfo *cms,
325 CMS_RecipientInfo *ri,
326 CMS_RecipientEncryptedKey *rek);
f4cc56f4 327
0f113f3e
MC		 328int CMS_SharedInfo_encode(unsigned char **pder, X509_ALGOR *kekalg,
329 ASN1_OCTET_STRING *ukm, int keylen);
dc1ce3bc 330
52df25cf
RS		 331/* Backward compatibility for spelling errors. */
332# define CMS_R_UNKNOWN_DIGEST_ALGORITM CMS_R_UNKNOWN_DIGEST_ALGORITHM
333# define CMS_R_UNSUPPORTED_RECPIENTINFO_TYPE \
334 CMS_R_UNSUPPORTED_RECIPIENTINFO_TYPE
0cd0a820 335
0cd0a820 336# ifdef __cplusplus
8931b30d 337}
0cd0a820 338# endif
3c27208f 339# endif
8931b30d 340#endif
A mirror of the official openssl repository