Coverage Report

Created: 2024-06-06 05:25

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