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/bio.h>
63 #include <openssl/x509.h>
65 #include <openssl/symhacks.h>
72 /* Under Win32 thes are defined in wincrypt.h */
73 #undef PKCS7_ISSUER_AND_SERIAL
74 #undef PKCS7_SIGNER_INFO
80 Digest_Encryption_ID rsaEncryption
81 Key_Encryption_ID rsaEncryption
84 typedef struct pkcs7_issuer_and_serial_st
88 } PKCS7_ISSUER_AND_SERIAL;
90 typedef struct pkcs7_signer_info_st
92 ASN1_INTEGER *version; /* version 1 */
93 PKCS7_ISSUER_AND_SERIAL *issuer_and_serial;
94 X509_ALGOR *digest_alg;
95 STACK_OF(X509_ATTRIBUTE) *auth_attr; /* [ 0 ] */
96 X509_ALGOR *digest_enc_alg;
97 ASN1_OCTET_STRING *enc_digest;
98 STACK_OF(X509_ATTRIBUTE) *unauth_attr; /* [ 1 ] */
100 /* The private key to sign with */
104 DECLARE_STACK_OF(PKCS7_SIGNER_INFO)
105 DECLARE_ASN1_SET_OF(PKCS7_SIGNER_INFO)
107 typedef struct pkcs7_recip_info_st
109 ASN1_INTEGER *version; /* version 0 */
110 PKCS7_ISSUER_AND_SERIAL *issuer_and_serial;
111 X509_ALGOR *key_enc_algor;
112 ASN1_OCTET_STRING *enc_key;
113 X509 *cert; /* get the pub-key from this */
116 DECLARE_STACK_OF(PKCS7_RECIP_INFO)
117 DECLARE_ASN1_SET_OF(PKCS7_RECIP_INFO)
119 typedef struct pkcs7_signed_st
121 ASN1_INTEGER *version; /* version 1 */
122 STACK_OF(X509_ALGOR) *md_algs; /* md used */
123 STACK_OF(X509) *cert; /* [ 0 ] */
124 STACK_OF(X509_CRL) *crl; /* [ 1 ] */
125 STACK_OF(PKCS7_SIGNER_INFO) *signer_info;
127 struct pkcs7_st *contents;
129 /* The above structure is very very similar to PKCS7_SIGN_ENVELOPE.
130 * How about merging the two */
132 typedef struct pkcs7_enc_content_st
134 ASN1_OBJECT *content_type;
135 X509_ALGOR *algorithm;
136 ASN1_OCTET_STRING *enc_data; /* [ 0 ] */
137 const EVP_CIPHER *cipher;
140 typedef struct pkcs7_enveloped_st
142 ASN1_INTEGER *version; /* version 0 */
143 STACK_OF(PKCS7_RECIP_INFO) *recipientinfo;
144 PKCS7_ENC_CONTENT *enc_data;
147 typedef struct pkcs7_signedandenveloped_st
149 ASN1_INTEGER *version; /* version 1 */
150 STACK_OF(X509_ALGOR) *md_algs; /* md used */
151 STACK_OF(X509) *cert; /* [ 0 ] */
152 STACK_OF(X509_CRL) *crl; /* [ 1 ] */
153 STACK_OF(PKCS7_SIGNER_INFO) *signer_info;
155 PKCS7_ENC_CONTENT *enc_data;
156 STACK_OF(PKCS7_RECIP_INFO) *recipientinfo;
157 } PKCS7_SIGN_ENVELOPE;
159 typedef struct pkcs7_digest_st
161 ASN1_INTEGER *version; /* version 0 */
162 X509_ALGOR *md; /* md used */
163 struct pkcs7_st *contents;
164 ASN1_OCTET_STRING *digest;
167 typedef struct pkcs7_encrypted_st
169 ASN1_INTEGER *version; /* version 0 */
170 PKCS7_ENC_CONTENT *enc_data;
173 typedef struct pkcs7_st
175 /* The following is non NULL if it contains ASN1 encoding of
180 #define PKCS7_S_HEADER 0
181 #define PKCS7_S_BODY 1
182 #define PKCS7_S_TAIL 2
183 int state; /* used during processing */
188 /* content as defined by the type */
189 /* all encryption/message digests are applied to the 'contents',
190 * leaving out the 'type' field. */
195 ASN1_OCTET_STRING *data;
197 /* NID_pkcs7_signed */
200 /* NID_pkcs7_enveloped */
201 PKCS7_ENVELOPE *enveloped;
203 /* NID_pkcs7_signedAndEnveloped */
204 PKCS7_SIGN_ENVELOPE *signed_and_enveloped;
206 /* NID_pkcs7_digest */
207 PKCS7_DIGEST *digest;
209 /* NID_pkcs7_encrypted */
210 PKCS7_ENCRYPT *encrypted;
217 DECLARE_STACK_OF(PKCS7)
218 DECLARE_ASN1_SET_OF(PKCS7)
219 DECLARE_PKCS12_STACK_OF(PKCS7)
221 #define PKCS7_OP_SET_DETACHED_SIGNATURE 1
222 #define PKCS7_OP_GET_DETACHED_SIGNATURE 2
224 #define PKCS7_get_signed_attributes(si) ((si)->auth_attr)
225 #define PKCS7_get_attributes(si) ((si)->unauth_attr)
227 #define PKCS7_type_is_signed(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_signed)
228 #define PKCS7_type_is_encrypted(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_encrypted)
229 #define PKCS7_type_is_enveloped(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_enveloped)
230 #define PKCS7_type_is_signedAndEnveloped(a) \
231 (OBJ_obj2nid((a)->type) == NID_pkcs7_signedAndEnveloped)
232 #define PKCS7_type_is_data(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_data)
234 #define PKCS7_set_detached(p,v) \
235 PKCS7_ctrl(p,PKCS7_OP_SET_DETACHED_SIGNATURE,v,NULL)
236 #define PKCS7_get_detached(p) \
237 PKCS7_ctrl(p,PKCS7_OP_GET_DETACHED_SIGNATURE,0,NULL)
239 #define PKCS7_is_detached(p7) (PKCS7_type_is_signed(p7) && PKCS7_get_detached(p7))
242 #ifndef PKCS7_ISSUER_AND_SERIAL_digest
243 #define PKCS7_ISSUER_AND_SERIAL_digest(data,type,md,len) \
244 ASN1_digest((int (*)())i2d_PKCS7_ISSUER_AND_SERIAL,type,\
249 /* S/MIME related flags */
251 #define PKCS7_TEXT 0x1
252 #define PKCS7_NOCERTS 0x2
253 #define PKCS7_NOSIGS 0x4
254 #define PKCS7_NOCHAIN 0x8
255 #define PKCS7_NOINTERN 0x10
256 #define PKCS7_NOVERIFY 0x20
257 #define PKCS7_DETACHED 0x40
258 #define PKCS7_BINARY 0x80
259 #define PKCS7_NOATTR 0x100
260 #define PKCS7_NOSMIMECAP 0x200
262 /* Flags: for compatibility with older code */
264 #define SMIME_TEXT PKCS7_TEXT
265 #define SMIME_NOCERTS PKCS7_NOCERTS
266 #define SMIME_NOSIGS PKCS7_NOSIGS
267 #define SMIME_NOCHAIN PKCS7_NOCHAIN
268 #define SMIME_NOINTERN PKCS7_NOINTERN
269 #define SMIME_NOVERIFY PKCS7_NOVERIFY
270 #define SMIME_DETACHED PKCS7_DETACHED
271 #define SMIME_BINARY PKCS7_BINARY
272 #define SMIME_NOATTR PKCS7_NOATTR
274 DECLARE_ASN1_FUNCTIONS(PKCS7_ISSUER_AND_SERIAL)
276 #ifndef SSLEAY_MACROS
277 int PKCS7_ISSUER_AND_SERIAL_digest(PKCS7_ISSUER_AND_SERIAL *data,const EVP_MD *type,
278 unsigned char *md,unsigned int *len);
280 PKCS7 *d2i_PKCS7_fp(FILE *fp,PKCS7 **p7);
281 int i2d_PKCS7_fp(FILE *fp,PKCS7 *p7);
283 PKCS7 *PKCS7_dup(PKCS7 *p7);
284 PKCS7 *d2i_PKCS7_bio(BIO *bp,PKCS7 **p7);
285 int i2d_PKCS7_bio(BIO *bp,PKCS7 *p7);
288 DECLARE_ASN1_FUNCTIONS(PKCS7_SIGNER_INFO)
289 DECLARE_ASN1_FUNCTIONS(PKCS7_RECIP_INFO)
290 DECLARE_ASN1_FUNCTIONS(PKCS7_SIGNED)
291 DECLARE_ASN1_FUNCTIONS(PKCS7_ENC_CONTENT)
292 DECLARE_ASN1_FUNCTIONS(PKCS7_ENVELOPE)
293 DECLARE_ASN1_FUNCTIONS(PKCS7_SIGN_ENVELOPE)
294 DECLARE_ASN1_FUNCTIONS(PKCS7_DIGEST)
295 DECLARE_ASN1_FUNCTIONS(PKCS7_ENCRYPT)
296 DECLARE_ASN1_FUNCTIONS(PKCS7)
298 void ERR_load_PKCS7_strings(void);
301 long PKCS7_ctrl(PKCS7 *p7, int cmd, long larg, char *parg);
303 int PKCS7_set_type(PKCS7 *p7, int type);
304 int PKCS7_set_content(PKCS7 *p7, PKCS7 *p7_data);
305 int PKCS7_SIGNER_INFO_set(PKCS7_SIGNER_INFO *p7i, X509 *x509, EVP_PKEY *pkey,
307 int PKCS7_add_signer(PKCS7 *p7, PKCS7_SIGNER_INFO *p7i);
308 int PKCS7_add_certificate(PKCS7 *p7, X509 *x509);
309 int PKCS7_add_crl(PKCS7 *p7, X509_CRL *x509);
310 int PKCS7_content_new(PKCS7 *p7, int nid);
311 int PKCS7_dataVerify(X509_STORE *cert_store, X509_STORE_CTX *ctx,
312 BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si);
313 int PKCS7_signatureVerify(BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si,
316 BIO *PKCS7_dataInit(PKCS7 *p7, BIO *bio);
317 int PKCS7_dataFinal(PKCS7 *p7, BIO *bio);
318 BIO *PKCS7_dataDecode(PKCS7 *p7, EVP_PKEY *pkey, BIO *in_bio, X509 *pcert);
321 PKCS7_SIGNER_INFO *PKCS7_add_signature(PKCS7 *p7, X509 *x509,
322 EVP_PKEY *pkey, EVP_MD *dgst);
323 X509 *PKCS7_cert_from_signer_info(PKCS7 *p7, PKCS7_SIGNER_INFO *si);
324 STACK_OF(PKCS7_SIGNER_INFO) *PKCS7_get_signer_info(PKCS7 *p7);
326 PKCS7_RECIP_INFO *PKCS7_add_recipient(PKCS7 *p7, X509 *x509);
327 int PKCS7_add_recipient_info(PKCS7 *p7, PKCS7_RECIP_INFO *ri);
328 int PKCS7_RECIP_INFO_set(PKCS7_RECIP_INFO *p7i, X509 *x509);
329 int PKCS7_set_cipher(PKCS7 *p7, const EVP_CIPHER *cipher);
331 PKCS7_ISSUER_AND_SERIAL *PKCS7_get_issuer_and_serial(PKCS7 *p7, int idx);
332 ASN1_OCTET_STRING *PKCS7_digest_from_attributes(STACK_OF(X509_ATTRIBUTE) *sk);
333 int PKCS7_add_signed_attribute(PKCS7_SIGNER_INFO *p7si,int nid,int type,
335 int PKCS7_add_attribute (PKCS7_SIGNER_INFO *p7si, int nid, int atrtype,
337 ASN1_TYPE *PKCS7_get_attribute(PKCS7_SIGNER_INFO *si, int nid);
338 ASN1_TYPE *PKCS7_get_signed_attribute(PKCS7_SIGNER_INFO *si, int nid);
339 int PKCS7_set_signed_attributes(PKCS7_SIGNER_INFO *p7si,
340 STACK_OF(X509_ATTRIBUTE) *sk);
341 int PKCS7_set_attributes(PKCS7_SIGNER_INFO *p7si,STACK_OF(X509_ATTRIBUTE) *sk);
344 PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs,
345 BIO *data, int flags);
346 int PKCS7_verify(PKCS7 *p7, STACK_OF(X509) *certs, X509_STORE *store,
347 BIO *indata, BIO *out, int flags);
348 STACK_OF(X509) *PKCS7_get0_signers(PKCS7 *p7, STACK_OF(X509) *certs, int flags);
349 PKCS7 *PKCS7_encrypt(STACK_OF(X509) *certs, BIO *in, EVP_CIPHER *cipher,
351 int PKCS7_decrypt(PKCS7 *p7, EVP_PKEY *pkey, X509 *cert, BIO *data, int flags);
353 int PKCS7_add_attrib_smimecap(PKCS7_SIGNER_INFO *si,
354 STACK_OF(X509_ALGOR) *cap);
355 STACK_OF(X509_ALGOR) *PKCS7_get_smimecap(PKCS7_SIGNER_INFO *si);
356 int PKCS7_simple_smimecap(STACK_OF(X509_ALGOR) *sk, int nid, int arg);
358 int SMIME_write_PKCS7(BIO *bio, PKCS7 *p7, BIO *data, int flags);
359 PKCS7 *SMIME_read_PKCS7(BIO *bio, BIO **bcont);
360 int SMIME_crlf_copy(BIO *in, BIO *out, int flags);
361 int SMIME_text(BIO *in, BIO *out);
363 /* BEGIN ERROR CODES */
364 /* The following lines are auto generated by the script mkerr.pl. Any changes
365 * made after this point may be overwritten when the script is next run.
368 /* Error codes for the PKCS7 functions. */
370 /* Function codes. */
371 #define PKCS7_F_B64_READ_PKCS7 120
372 #define PKCS7_F_B64_WRITE_PKCS7 121
373 #define PKCS7_F_PKCS7_ADD_ATTRIB_SMIMECAP 118
374 #define PKCS7_F_PKCS7_ADD_CERTIFICATE 100
375 #define PKCS7_F_PKCS7_ADD_CRL 101
376 #define PKCS7_F_PKCS7_ADD_RECIPIENT_INFO 102
377 #define PKCS7_F_PKCS7_ADD_SIGNER 103
378 #define PKCS7_F_PKCS7_CTRL 104
379 #define PKCS7_F_PKCS7_DATADECODE 112
380 #define PKCS7_F_PKCS7_DATAINIT 105
381 #define PKCS7_F_PKCS7_DATASIGN 106
382 #define PKCS7_F_PKCS7_DATAVERIFY 107
383 #define PKCS7_F_PKCS7_DECRYPT 114
384 #define PKCS7_F_PKCS7_ENCRYPT 115
385 #define PKCS7_F_PKCS7_GET0_SIGNERS 124
386 #define PKCS7_F_PKCS7_SET_CIPHER 108
387 #define PKCS7_F_PKCS7_SET_CONTENT 109
388 #define PKCS7_F_PKCS7_SET_TYPE 110
389 #define PKCS7_F_PKCS7_SIGN 116
390 #define PKCS7_F_PKCS7_SIGNATUREVERIFY 113
391 #define PKCS7_F_PKCS7_SIMPLE_SMIMECAP 119
392 #define PKCS7_F_PKCS7_VERIFY 117
393 #define PKCS7_F_SMIME_READ_PKCS7 122
394 #define PKCS7_F_SMIME_TEXT 123
397 #define PKCS7_R_CERTIFICATE_VERIFY_ERROR 117
398 #define PKCS7_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER 144
399 #define PKCS7_R_CIPHER_NOT_INITIALIZED 116
400 #define PKCS7_R_CONTENT_AND_DATA_PRESENT 118
401 #define PKCS7_R_DECODE_ERROR 130
402 #define PKCS7_R_DECRYPTED_KEY_IS_WRONG_LENGTH 100
403 #define PKCS7_R_DECRYPT_ERROR 119
404 #define PKCS7_R_DIGEST_FAILURE 101
405 #define PKCS7_R_ERROR_ADDING_RECIPIENT 120
406 #define PKCS7_R_ERROR_SETTING_CIPHER 121
407 #define PKCS7_R_INTERNAL_ERROR 102
408 #define PKCS7_R_INVALID_MIME_TYPE 131
409 #define PKCS7_R_INVALID_NULL_POINTER 143
410 #define PKCS7_R_MIME_NO_CONTENT_TYPE 132
411 #define PKCS7_R_MIME_PARSE_ERROR 133
412 #define PKCS7_R_MIME_SIG_PARSE_ERROR 134
413 #define PKCS7_R_MISSING_CERIPEND_INFO 103
414 #define PKCS7_R_NO_CONTENT 122
415 #define PKCS7_R_NO_CONTENT_TYPE 135
416 #define PKCS7_R_NO_MULTIPART_BODY_FAILURE 136
417 #define PKCS7_R_NO_MULTIPART_BOUNDARY 137
418 #define PKCS7_R_NO_RECIPIENT_MATCHES_CERTIFICATE 115
419 #define PKCS7_R_NO_SIGNATURES_ON_DATA 123
420 #define PKCS7_R_NO_SIGNERS 142
421 #define PKCS7_R_NO_SIG_CONTENT_TYPE 138
422 #define PKCS7_R_OPERATION_NOT_SUPPORTED_ON_THIS_TYPE 104
423 #define PKCS7_R_PKCS7_ADD_SIGNATURE_ERROR 124
424 #define PKCS7_R_PKCS7_DATAFINAL_ERROR 125
425 #define PKCS7_R_PKCS7_DATASIGN 126
426 #define PKCS7_R_PKCS7_PARSE_ERROR 139
427 #define PKCS7_R_PKCS7_SIG_PARSE_ERROR 140
428 #define PKCS7_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 127
429 #define PKCS7_R_SIGNATURE_FAILURE 105
430 #define PKCS7_R_SIGNER_CERTIFICATE_NOT_FOUND 128
431 #define PKCS7_R_SIG_INVALID_MIME_TYPE 141
432 #define PKCS7_R_SMIME_TEXT_ERROR 129
433 #define PKCS7_R_UNABLE_TO_FIND_CERTIFICATE 106
434 #define PKCS7_R_UNABLE_TO_FIND_MEM_BIO 107
435 #define PKCS7_R_UNABLE_TO_FIND_MESSAGE_DIGEST 108
436 #define PKCS7_R_UNKNOWN_DIGEST_TYPE 109
437 #define PKCS7_R_UNKNOWN_OPERATION 110
438 #define PKCS7_R_UNSUPPORTED_CIPHER_TYPE 111
439 #define PKCS7_R_UNSUPPORTED_CONTENT_TYPE 112
440 #define PKCS7_R_WRONG_CONTENT_TYPE 113
441 #define PKCS7_R_WRONG_PKCS7_TYPE 114