1
/* crypto/pkcs7/pkcs7.h */
2
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5
* This package is an SSL implementation written
6
* by Eric Young (eay@cryptsoft.com).
7
* The implementation was written so as to conform with Netscapes SSL.
9
* This library is free for commercial and non-commercial use as long as
10
* the following conditions are aheared to. The following conditions
11
* apply to all code found in this distribution, be it the RC4, RSA,
12
* lhash, DES, etc., code; not just the SSL code. The SSL documentation
13
* included with this distribution is covered by the same copyright terms
14
* except that the holder is Tim Hudson (tjh@cryptsoft.com).
16
* Copyright remains Eric Young's, and as such any Copyright notices in
17
* the code are not to be removed.
18
* If this package is used in a product, Eric Young should be given attribution
19
* as the author of the parts of the library used.
20
* This can be in the form of a textual message at program startup or
21
* in documentation (online or textual) provided with the package.
23
* Redistribution and use in source and binary forms, with or without
24
* modification, are permitted provided that the following conditions
26
* 1. Redistributions of source code must retain the copyright
27
* notice, this list of conditions and the following disclaimer.
28
* 2. Redistributions in binary form must reproduce the above copyright
29
* notice, this list of conditions and the following disclaimer in the
30
* documentation and/or other materials provided with the distribution.
31
* 3. All advertising materials mentioning features or use of this software
32
* must display the following acknowledgement:
33
* "This product includes cryptographic software written by
34
* Eric Young (eay@cryptsoft.com)"
35
* The word 'cryptographic' can be left out if the rouines from the library
36
* being used are not cryptographic related :-).
37
* 4. If you include any Windows specific code (or a derivative thereof) from
38
* the apps directory (application code) you must include an acknowledgement:
39
* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41
* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53
* The licence and distribution terms for any publically available version or
54
* derivative of this code cannot be changed. i.e. this code cannot simply be
55
* copied and put under another distribution licence
56
* [including the GNU Public Licence.]
59
#ifndef HEADER_PKCS7_H
60
#define HEADER_PKCS7_H
62
#include <openssl/asn1.h>
63
#include <openssl/bio.h>
64
#include <openssl/e_os2.h>
66
#include <openssl/symhacks.h>
67
#include <openssl/ossl_typ.h>
73
#ifdef OPENSSL_SYS_WIN32
74
/* Under Win32 thes are defined in wincrypt.h */
75
#undef PKCS7_ISSUER_AND_SERIAL
76
#undef PKCS7_SIGNER_INFO
82
Digest_Encryption_ID rsaEncryption
83
Key_Encryption_ID rsaEncryption
86
typedef struct pkcs7_issuer_and_serial_st
90
} PKCS7_ISSUER_AND_SERIAL;
92
typedef struct pkcs7_signer_info_st
94
ASN1_INTEGER *version; /* version 1 */
95
PKCS7_ISSUER_AND_SERIAL *issuer_and_serial;
96
X509_ALGOR *digest_alg;
97
STACK_OF(X509_ATTRIBUTE) *auth_attr; /* [ 0 ] */
98
X509_ALGOR *digest_enc_alg;
99
ASN1_OCTET_STRING *enc_digest;
100
STACK_OF(X509_ATTRIBUTE) *unauth_attr; /* [ 1 ] */
102
/* The private key to sign with */
106
DECLARE_STACK_OF(PKCS7_SIGNER_INFO)
107
DECLARE_ASN1_SET_OF(PKCS7_SIGNER_INFO)
109
typedef struct pkcs7_recip_info_st
111
ASN1_INTEGER *version; /* version 0 */
112
PKCS7_ISSUER_AND_SERIAL *issuer_and_serial;
113
X509_ALGOR *key_enc_algor;
114
ASN1_OCTET_STRING *enc_key;
115
X509 *cert; /* get the pub-key from this */
118
DECLARE_STACK_OF(PKCS7_RECIP_INFO)
119
DECLARE_ASN1_SET_OF(PKCS7_RECIP_INFO)
121
typedef struct pkcs7_signed_st
123
ASN1_INTEGER *version; /* version 1 */
124
STACK_OF(X509_ALGOR) *md_algs; /* md used */
125
STACK_OF(X509) *cert; /* [ 0 ] */
126
STACK_OF(X509_CRL) *crl; /* [ 1 ] */
127
STACK_OF(PKCS7_SIGNER_INFO) *signer_info;
129
struct pkcs7_st *contents;
131
/* The above structure is very very similar to PKCS7_SIGN_ENVELOPE.
132
* How about merging the two */
134
typedef struct pkcs7_enc_content_st
136
ASN1_OBJECT *content_type;
137
X509_ALGOR *algorithm;
138
ASN1_OCTET_STRING *enc_data; /* [ 0 ] */
139
const EVP_CIPHER *cipher;
142
typedef struct pkcs7_enveloped_st
144
ASN1_INTEGER *version; /* version 0 */
145
STACK_OF(PKCS7_RECIP_INFO) *recipientinfo;
146
PKCS7_ENC_CONTENT *enc_data;
149
typedef struct pkcs7_signedandenveloped_st
151
ASN1_INTEGER *version; /* version 1 */
152
STACK_OF(X509_ALGOR) *md_algs; /* md used */
153
STACK_OF(X509) *cert; /* [ 0 ] */
154
STACK_OF(X509_CRL) *crl; /* [ 1 ] */
155
STACK_OF(PKCS7_SIGNER_INFO) *signer_info;
157
PKCS7_ENC_CONTENT *enc_data;
158
STACK_OF(PKCS7_RECIP_INFO) *recipientinfo;
159
} PKCS7_SIGN_ENVELOPE;
161
typedef struct pkcs7_digest_st
163
ASN1_INTEGER *version; /* version 0 */
164
X509_ALGOR *md; /* md used */
165
struct pkcs7_st *contents;
166
ASN1_OCTET_STRING *digest;
169
typedef struct pkcs7_encrypted_st
171
ASN1_INTEGER *version; /* version 0 */
172
PKCS7_ENC_CONTENT *enc_data;
175
typedef struct pkcs7_st
177
/* The following is non NULL if it contains ASN1 encoding of
182
#define PKCS7_S_HEADER 0
183
#define PKCS7_S_BODY 1
184
#define PKCS7_S_TAIL 2
185
int state; /* used during processing */
190
/* content as defined by the type */
191
/* all encryption/message digests are applied to the 'contents',
192
* leaving out the 'type' field. */
197
ASN1_OCTET_STRING *data;
199
/* NID_pkcs7_signed */
202
/* NID_pkcs7_enveloped */
203
PKCS7_ENVELOPE *enveloped;
205
/* NID_pkcs7_signedAndEnveloped */
206
PKCS7_SIGN_ENVELOPE *signed_and_enveloped;
208
/* NID_pkcs7_digest */
209
PKCS7_DIGEST *digest;
211
/* NID_pkcs7_encrypted */
212
PKCS7_ENCRYPT *encrypted;
219
DECLARE_STACK_OF(PKCS7)
220
DECLARE_ASN1_SET_OF(PKCS7)
221
DECLARE_PKCS12_STACK_OF(PKCS7)
223
#define PKCS7_OP_SET_DETACHED_SIGNATURE 1
224
#define PKCS7_OP_GET_DETACHED_SIGNATURE 2
226
#define PKCS7_get_signed_attributes(si) ((si)->auth_attr)
227
#define PKCS7_get_attributes(si) ((si)->unauth_attr)
229
#define PKCS7_type_is_signed(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_signed)
230
#define PKCS7_type_is_encrypted(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_encrypted)
231
#define PKCS7_type_is_enveloped(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_enveloped)
232
#define PKCS7_type_is_signedAndEnveloped(a) \
233
(OBJ_obj2nid((a)->type) == NID_pkcs7_signedAndEnveloped)
234
#define PKCS7_type_is_data(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_data)
236
#define PKCS7_type_is_digest(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_digest)
238
#define PKCS7_set_detached(p,v) \
239
PKCS7_ctrl(p,PKCS7_OP_SET_DETACHED_SIGNATURE,v,NULL)
240
#define PKCS7_get_detached(p) \
241
PKCS7_ctrl(p,PKCS7_OP_GET_DETACHED_SIGNATURE,0,NULL)
243
#define PKCS7_is_detached(p7) (PKCS7_type_is_signed(p7) && PKCS7_get_detached(p7))
246
#ifndef PKCS7_ISSUER_AND_SERIAL_digest
247
#define PKCS7_ISSUER_AND_SERIAL_digest(data,type,md,len) \
248
ASN1_digest((int (*)())i2d_PKCS7_ISSUER_AND_SERIAL,type,\
253
/* S/MIME related flags */
255
#define PKCS7_TEXT 0x1
256
#define PKCS7_NOCERTS 0x2
257
#define PKCS7_NOSIGS 0x4
258
#define PKCS7_NOCHAIN 0x8
259
#define PKCS7_NOINTERN 0x10
260
#define PKCS7_NOVERIFY 0x20
261
#define PKCS7_DETACHED 0x40
262
#define PKCS7_BINARY 0x80
263
#define PKCS7_NOATTR 0x100
264
#define PKCS7_NOSMIMECAP 0x200
265
#define PKCS7_NOOLDMIMETYPE 0x400
266
#define PKCS7_CRLFEOL 0x800
267
#define PKCS7_STREAM 0x1000
268
#define PKCS7_NOCRL 0x2000
270
/* Flags: for compatibility with older code */
272
#define SMIME_TEXT PKCS7_TEXT
273
#define SMIME_NOCERTS PKCS7_NOCERTS
274
#define SMIME_NOSIGS PKCS7_NOSIGS
275
#define SMIME_NOCHAIN PKCS7_NOCHAIN
276
#define SMIME_NOINTERN PKCS7_NOINTERN
277
#define SMIME_NOVERIFY PKCS7_NOVERIFY
278
#define SMIME_DETACHED PKCS7_DETACHED
279
#define SMIME_BINARY PKCS7_BINARY
280
#define SMIME_NOATTR PKCS7_NOATTR
282
DECLARE_ASN1_FUNCTIONS(PKCS7_ISSUER_AND_SERIAL)
284
#ifndef SSLEAY_MACROS
285
int PKCS7_ISSUER_AND_SERIAL_digest(PKCS7_ISSUER_AND_SERIAL *data,const EVP_MD *type,
286
unsigned char *md,unsigned int *len);
287
#ifndef OPENSSL_NO_FP_API
288
PKCS7 *d2i_PKCS7_fp(FILE *fp,PKCS7 **p7);
289
int i2d_PKCS7_fp(FILE *fp,PKCS7 *p7);
291
PKCS7 *PKCS7_dup(PKCS7 *p7);
292
PKCS7 *d2i_PKCS7_bio(BIO *bp,PKCS7 **p7);
293
int i2d_PKCS7_bio(BIO *bp,PKCS7 *p7);
296
DECLARE_ASN1_FUNCTIONS(PKCS7_SIGNER_INFO)
297
DECLARE_ASN1_FUNCTIONS(PKCS7_RECIP_INFO)
298
DECLARE_ASN1_FUNCTIONS(PKCS7_SIGNED)
299
DECLARE_ASN1_FUNCTIONS(PKCS7_ENC_CONTENT)
300
DECLARE_ASN1_FUNCTIONS(PKCS7_ENVELOPE)
301
DECLARE_ASN1_FUNCTIONS(PKCS7_SIGN_ENVELOPE)
302
DECLARE_ASN1_FUNCTIONS(PKCS7_DIGEST)
303
DECLARE_ASN1_FUNCTIONS(PKCS7_ENCRYPT)
304
DECLARE_ASN1_FUNCTIONS(PKCS7)
306
DECLARE_ASN1_ITEM(PKCS7_ATTR_SIGN)
307
DECLARE_ASN1_ITEM(PKCS7_ATTR_VERIFY)
309
DECLARE_ASN1_NDEF_FUNCTION(PKCS7)
311
long PKCS7_ctrl(PKCS7 *p7, int cmd, long larg, char *parg);
313
int PKCS7_set_type(PKCS7 *p7, int type);
314
int PKCS7_set0_type_other(PKCS7 *p7, int type, ASN1_TYPE *other);
315
int PKCS7_set_content(PKCS7 *p7, PKCS7 *p7_data);
316
int PKCS7_SIGNER_INFO_set(PKCS7_SIGNER_INFO *p7i, X509 *x509, EVP_PKEY *pkey,
318
int PKCS7_add_signer(PKCS7 *p7, PKCS7_SIGNER_INFO *p7i);
319
int PKCS7_add_certificate(PKCS7 *p7, X509 *x509);
320
int PKCS7_add_crl(PKCS7 *p7, X509_CRL *x509);
321
int PKCS7_content_new(PKCS7 *p7, int nid);
322
int PKCS7_dataVerify(X509_STORE *cert_store, X509_STORE_CTX *ctx,
323
BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si);
324
int PKCS7_signatureVerify(BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si,
327
BIO *PKCS7_dataInit(PKCS7 *p7, BIO *bio);
328
int PKCS7_dataFinal(PKCS7 *p7, BIO *bio);
329
BIO *PKCS7_dataDecode(PKCS7 *p7, EVP_PKEY *pkey, BIO *in_bio, X509 *pcert);
332
PKCS7_SIGNER_INFO *PKCS7_add_signature(PKCS7 *p7, X509 *x509,
333
EVP_PKEY *pkey, const EVP_MD *dgst);
334
X509 *PKCS7_cert_from_signer_info(PKCS7 *p7, PKCS7_SIGNER_INFO *si);
335
int PKCS7_set_digest(PKCS7 *p7, const EVP_MD *md);
336
STACK_OF(PKCS7_SIGNER_INFO) *PKCS7_get_signer_info(PKCS7 *p7);
338
PKCS7_RECIP_INFO *PKCS7_add_recipient(PKCS7 *p7, X509 *x509);
339
int PKCS7_add_recipient_info(PKCS7 *p7, PKCS7_RECIP_INFO *ri);
340
int PKCS7_RECIP_INFO_set(PKCS7_RECIP_INFO *p7i, X509 *x509);
341
int PKCS7_set_cipher(PKCS7 *p7, const EVP_CIPHER *cipher);
343
PKCS7_ISSUER_AND_SERIAL *PKCS7_get_issuer_and_serial(PKCS7 *p7, int idx);
344
ASN1_OCTET_STRING *PKCS7_digest_from_attributes(STACK_OF(X509_ATTRIBUTE) *sk);
345
int PKCS7_add_signed_attribute(PKCS7_SIGNER_INFO *p7si,int nid,int type,
347
int PKCS7_add_attribute (PKCS7_SIGNER_INFO *p7si, int nid, int atrtype,
349
ASN1_TYPE *PKCS7_get_attribute(PKCS7_SIGNER_INFO *si, int nid);
350
ASN1_TYPE *PKCS7_get_signed_attribute(PKCS7_SIGNER_INFO *si, int nid);
351
int PKCS7_set_signed_attributes(PKCS7_SIGNER_INFO *p7si,
352
STACK_OF(X509_ATTRIBUTE) *sk);
353
int PKCS7_set_attributes(PKCS7_SIGNER_INFO *p7si,STACK_OF(X509_ATTRIBUTE) *sk);
356
PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs,
357
BIO *data, int flags);
358
int PKCS7_verify(PKCS7 *p7, STACK_OF(X509) *certs, X509_STORE *store,
359
BIO *indata, BIO *out, int flags);
360
STACK_OF(X509) *PKCS7_get0_signers(PKCS7 *p7, STACK_OF(X509) *certs, int flags);
361
PKCS7 *PKCS7_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher,
363
int PKCS7_decrypt(PKCS7 *p7, EVP_PKEY *pkey, X509 *cert, BIO *data, int flags);
365
int PKCS7_add_attrib_smimecap(PKCS7_SIGNER_INFO *si,
366
STACK_OF(X509_ALGOR) *cap);
367
STACK_OF(X509_ALGOR) *PKCS7_get_smimecap(PKCS7_SIGNER_INFO *si);
368
int PKCS7_simple_smimecap(STACK_OF(X509_ALGOR) *sk, int nid, int arg);
370
int SMIME_write_PKCS7(BIO *bio, PKCS7 *p7, BIO *data, int flags);
371
PKCS7 *SMIME_read_PKCS7(BIO *bio, BIO **bcont);
372
int SMIME_crlf_copy(BIO *in, BIO *out, int flags);
373
int SMIME_text(BIO *in, BIO *out);
375
/* BEGIN ERROR CODES */
376
/* The following lines are auto generated by the script mkerr.pl. Any changes
377
* made after this point may be overwritten when the script is next run.
379
void ERR_load_PKCS7_strings(void);
381
/* Error codes for the PKCS7 functions. */
383
/* Function codes. */
384
#define PKCS7_F_B64_READ_PKCS7 120
385
#define PKCS7_F_B64_WRITE_PKCS7 121
386
#define PKCS7_F_PKCS7_ADD_ATTRIB_SMIMECAP 118
387
#define PKCS7_F_PKCS7_ADD_CERTIFICATE 100
388
#define PKCS7_F_PKCS7_ADD_CRL 101
389
#define PKCS7_F_PKCS7_ADD_RECIPIENT_INFO 102
390
#define PKCS7_F_PKCS7_ADD_SIGNER 103
391
#define PKCS7_F_PKCS7_BIO_ADD_DIGEST 125
392
#define PKCS7_F_PKCS7_CTRL 104
393
#define PKCS7_F_PKCS7_DATADECODE 112
394
#define PKCS7_F_PKCS7_DATAFINAL 128
395
#define PKCS7_F_PKCS7_DATAINIT 105
396
#define PKCS7_F_PKCS7_DATASIGN 106
397
#define PKCS7_F_PKCS7_DATAVERIFY 107
398
#define PKCS7_F_PKCS7_DECRYPT 114
399
#define PKCS7_F_PKCS7_ENCRYPT 115
400
#define PKCS7_F_PKCS7_FIND_DIGEST 127
401
#define PKCS7_F_PKCS7_GET0_SIGNERS 124
402
#define PKCS7_F_PKCS7_SET_CIPHER 108
403
#define PKCS7_F_PKCS7_SET_CONTENT 109
404
#define PKCS7_F_PKCS7_SET_DIGEST 126
405
#define PKCS7_F_PKCS7_SET_TYPE 110
406
#define PKCS7_F_PKCS7_SIGN 116
407
#define PKCS7_F_PKCS7_SIGNATUREVERIFY 113
408
#define PKCS7_F_PKCS7_SIMPLE_SMIMECAP 119
409
#define PKCS7_F_PKCS7_VERIFY 117
410
#define PKCS7_F_SMIME_READ_PKCS7 122
411
#define PKCS7_F_SMIME_TEXT 123
414
#define PKCS7_R_CERTIFICATE_VERIFY_ERROR 117
415
#define PKCS7_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER 144
416
#define PKCS7_R_CIPHER_NOT_INITIALIZED 116
417
#define PKCS7_R_CONTENT_AND_DATA_PRESENT 118
418
#define PKCS7_R_DECODE_ERROR 130
419
#define PKCS7_R_DECRYPTED_KEY_IS_WRONG_LENGTH 100
420
#define PKCS7_R_DECRYPT_ERROR 119
421
#define PKCS7_R_DIGEST_FAILURE 101
422
#define PKCS7_R_ERROR_ADDING_RECIPIENT 120
423
#define PKCS7_R_ERROR_SETTING_CIPHER 121
424
#define PKCS7_R_INVALID_MIME_TYPE 131
425
#define PKCS7_R_INVALID_NULL_POINTER 143
426
#define PKCS7_R_MIME_NO_CONTENT_TYPE 132
427
#define PKCS7_R_MIME_PARSE_ERROR 133
428
#define PKCS7_R_MIME_SIG_PARSE_ERROR 134
429
#define PKCS7_R_MISSING_CERIPEND_INFO 103
430
#define PKCS7_R_NO_CONTENT 122
431
#define PKCS7_R_NO_CONTENT_TYPE 135
432
#define PKCS7_R_NO_MULTIPART_BODY_FAILURE 136
433
#define PKCS7_R_NO_MULTIPART_BOUNDARY 137
434
#define PKCS7_R_NO_RECIPIENT_MATCHES_CERTIFICATE 115
435
#define PKCS7_R_NO_RECIPIENT_MATCHES_KEY 146
436
#define PKCS7_R_NO_SIGNATURES_ON_DATA 123
437
#define PKCS7_R_NO_SIGNERS 142
438
#define PKCS7_R_NO_SIG_CONTENT_TYPE 138
439
#define PKCS7_R_OPERATION_NOT_SUPPORTED_ON_THIS_TYPE 104
440
#define PKCS7_R_PKCS7_ADD_SIGNATURE_ERROR 124
441
#define PKCS7_R_PKCS7_DATAFINAL 126
442
#define PKCS7_R_PKCS7_DATAFINAL_ERROR 125
443
#define PKCS7_R_PKCS7_DATASIGN 145
444
#define PKCS7_R_PKCS7_PARSE_ERROR 139
445
#define PKCS7_R_PKCS7_SIG_PARSE_ERROR 140
446
#define PKCS7_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 127
447
#define PKCS7_R_SIGNATURE_FAILURE 105
448
#define PKCS7_R_SIGNER_CERTIFICATE_NOT_FOUND 128
449
#define PKCS7_R_SIG_INVALID_MIME_TYPE 141
450
#define PKCS7_R_SMIME_TEXT_ERROR 129
451
#define PKCS7_R_UNABLE_TO_FIND_CERTIFICATE 106
452
#define PKCS7_R_UNABLE_TO_FIND_MEM_BIO 107
453
#define PKCS7_R_UNABLE_TO_FIND_MESSAGE_DIGEST 108
454
#define PKCS7_R_UNKNOWN_DIGEST_TYPE 109
455
#define PKCS7_R_UNKNOWN_OPERATION 110
456
#define PKCS7_R_UNSUPPORTED_CIPHER_TYPE 111
457
#define PKCS7_R_UNSUPPORTED_CONTENT_TYPE 112
458
#define PKCS7_R_WRONG_CONTENT_TYPE 113
459
#define PKCS7_R_WRONG_PKCS7_TYPE 114