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 {
89 } PKCS7_ISSUER_AND_SERIAL;
91 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 ] */
99 /* The private key to sign with */
103 DECLARE_STACK_OF(PKCS7_SIGNER_INFO)
104 DECLARE_ASN1_SET_OF(PKCS7_SIGNER_INFO)
106 typedef struct pkcs7_recip_info_st {
107 ASN1_INTEGER *version; /* version 0 */
108 PKCS7_ISSUER_AND_SERIAL *issuer_and_serial;
109 X509_ALGOR *key_enc_algor;
110 ASN1_OCTET_STRING *enc_key;
111 X509 *cert; /* get the pub-key from this */
114 DECLARE_STACK_OF(PKCS7_RECIP_INFO)
115 DECLARE_ASN1_SET_OF(PKCS7_RECIP_INFO)
117 typedef struct pkcs7_signed_st {
118 ASN1_INTEGER *version; /* version 1 */
119 STACK_OF(X509_ALGOR) *md_algs; /* md used */
120 STACK_OF(X509) *cert; /* [ 0 ] */
121 STACK_OF(X509_CRL) *crl; /* [ 1 ] */
122 STACK_OF(PKCS7_SIGNER_INFO) *signer_info;
123 struct pkcs7_st *contents;
126 * The above structure is very very similar to PKCS7_SIGN_ENVELOPE. How about
130 typedef struct pkcs7_enc_content_st {
131 ASN1_OBJECT *content_type;
132 X509_ALGOR *algorithm;
133 ASN1_OCTET_STRING *enc_data; /* [ 0 ] */
134 const EVP_CIPHER *cipher;
137 typedef struct pkcs7_enveloped_st {
138 ASN1_INTEGER *version; /* version 0 */
139 STACK_OF(PKCS7_RECIP_INFO) *recipientinfo;
140 PKCS7_ENC_CONTENT *enc_data;
143 typedef struct pkcs7_signedandenveloped_st {
144 ASN1_INTEGER *version; /* version 1 */
145 STACK_OF(X509_ALGOR) *md_algs; /* md used */
146 STACK_OF(X509) *cert; /* [ 0 ] */
147 STACK_OF(X509_CRL) *crl; /* [ 1 ] */
148 STACK_OF(PKCS7_SIGNER_INFO) *signer_info;
149 PKCS7_ENC_CONTENT *enc_data;
150 STACK_OF(PKCS7_RECIP_INFO) *recipientinfo;
151 } PKCS7_SIGN_ENVELOPE;
153 typedef struct pkcs7_digest_st {
154 ASN1_INTEGER *version; /* version 0 */
155 X509_ALGOR *md; /* md used */
156 struct pkcs7_st *contents;
157 ASN1_OCTET_STRING *digest;
160 typedef struct pkcs7_encrypted_st {
161 ASN1_INTEGER *version; /* version 0 */
162 PKCS7_ENC_CONTENT *enc_data;
165 typedef struct pkcs7_st {
167 * The following is non NULL if it contains ASN1 encoding of this
172 # define PKCS7_S_HEADER 0
173 # define PKCS7_S_BODY 1
174 # define PKCS7_S_TAIL 2
175 int state; /* used during processing */
178 /* content as defined by the type */
180 * all encryption/message digests are applied to the 'contents', leaving
181 * out the 'type' field.
186 ASN1_OCTET_STRING *data;
187 /* NID_pkcs7_signed */
189 /* NID_pkcs7_enveloped */
190 PKCS7_ENVELOPE *enveloped;
191 /* NID_pkcs7_signedAndEnveloped */
192 PKCS7_SIGN_ENVELOPE *signed_and_enveloped;
193 /* NID_pkcs7_digest */
194 PKCS7_DIGEST *digest;
195 /* NID_pkcs7_encrypted */
196 PKCS7_ENCRYPT *encrypted;
202 DECLARE_STACK_OF(PKCS7)
203 DECLARE_ASN1_SET_OF(PKCS7)
204 DECLARE_PKCS12_STACK_OF(PKCS7)
206 # define PKCS7_OP_SET_DETACHED_SIGNATURE 1
207 # define PKCS7_OP_GET_DETACHED_SIGNATURE 2
209 # define PKCS7_get_signed_attributes(si) ((si)->auth_attr)
210 # define PKCS7_get_attributes(si) ((si)->unauth_attr)
212 # define PKCS7_type_is_signed(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_signed)
213 # define PKCS7_type_is_encrypted(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_encrypted)
214 # define PKCS7_type_is_enveloped(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_enveloped)
215 # define PKCS7_type_is_signedAndEnveloped(a) \
216 (OBJ_obj2nid((a)->type) == NID_pkcs7_signedAndEnveloped)
217 # define PKCS7_type_is_data(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_data)
219 # define PKCS7_type_is_digest(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_digest)
221 # define PKCS7_set_detached(p,v) \
222 PKCS7_ctrl(p,PKCS7_OP_SET_DETACHED_SIGNATURE,v,NULL)
223 # define PKCS7_get_detached(p) \
224 PKCS7_ctrl(p,PKCS7_OP_GET_DETACHED_SIGNATURE,0,NULL)
226 # define PKCS7_is_detached(p7) (PKCS7_type_is_signed(p7) && PKCS7_get_detached(p7))
228 # ifdef SSLEAY_MACROS
229 # ifndef PKCS7_ISSUER_AND_SERIAL_digest
230 # define PKCS7_ISSUER_AND_SERIAL_digest(data,type,md,len) \
231 ASN1_digest((int (*)())i2d_PKCS7_ISSUER_AND_SERIAL,type,\
236 /* S/MIME related flags */
238 # define PKCS7_TEXT 0x1
239 # define PKCS7_NOCERTS 0x2
240 # define PKCS7_NOSIGS 0x4
241 # define PKCS7_NOCHAIN 0x8
242 # define PKCS7_NOINTERN 0x10
243 # define PKCS7_NOVERIFY 0x20
244 # define PKCS7_DETACHED 0x40
245 # define PKCS7_BINARY 0x80
246 # define PKCS7_NOATTR 0x100
247 # define PKCS7_NOSMIMECAP 0x200
248 # define PKCS7_NOOLDMIMETYPE 0x400
249 # define PKCS7_CRLFEOL 0x800
250 # define PKCS7_STREAM 0x1000
251 # define PKCS7_NOCRL 0x2000
253 /* Flags: for compatibility with older code */
255 # define SMIME_TEXT PKCS7_TEXT
256 # define SMIME_NOCERTS PKCS7_NOCERTS
257 # define SMIME_NOSIGS PKCS7_NOSIGS
258 # define SMIME_NOCHAIN PKCS7_NOCHAIN
259 # define SMIME_NOINTERN PKCS7_NOINTERN
260 # define SMIME_NOVERIFY PKCS7_NOVERIFY
261 # define SMIME_DETACHED PKCS7_DETACHED
262 # define SMIME_BINARY PKCS7_BINARY
263 # define SMIME_NOATTR PKCS7_NOATTR
265 DECLARE_ASN1_FUNCTIONS(PKCS7_ISSUER_AND_SERIAL)
267 # ifndef SSLEAY_MACROS
268 int PKCS7_ISSUER_AND_SERIAL_digest(PKCS7_ISSUER_AND_SERIAL *data,
269 const EVP_MD *type, unsigned char *md,
271 # ifndef OPENSSL_NO_FP_API
272 PKCS7 *d2i_PKCS7_fp(FILE *fp, PKCS7 **p7);
273 int i2d_PKCS7_fp(FILE *fp, PKCS7 *p7);
275 PKCS7 *PKCS7_dup(PKCS7 *p7);
276 PKCS7 *d2i_PKCS7_bio(BIO *bp, PKCS7 **p7);
277 int i2d_PKCS7_bio(BIO *bp, PKCS7 *p7);
280 DECLARE_ASN1_FUNCTIONS(PKCS7_SIGNER_INFO)
281 DECLARE_ASN1_FUNCTIONS(PKCS7_RECIP_INFO)
282 DECLARE_ASN1_FUNCTIONS(PKCS7_SIGNED)
283 DECLARE_ASN1_FUNCTIONS(PKCS7_ENC_CONTENT)
284 DECLARE_ASN1_FUNCTIONS(PKCS7_ENVELOPE)
285 DECLARE_ASN1_FUNCTIONS(PKCS7_SIGN_ENVELOPE)
286 DECLARE_ASN1_FUNCTIONS(PKCS7_DIGEST)
287 DECLARE_ASN1_FUNCTIONS(PKCS7_ENCRYPT)
288 DECLARE_ASN1_FUNCTIONS(PKCS7)
290 DECLARE_ASN1_ITEM(PKCS7_ATTR_SIGN)
291 DECLARE_ASN1_ITEM(PKCS7_ATTR_VERIFY)
293 DECLARE_ASN1_NDEF_FUNCTION(PKCS7)
295 long PKCS7_ctrl(PKCS7 *p7, int cmd, long larg, char *parg);
297 int PKCS7_set_type(PKCS7 *p7, int type);
298 int PKCS7_set0_type_other(PKCS7 *p7, int type, ASN1_TYPE *other);
299 int PKCS7_set_content(PKCS7 *p7, PKCS7 *p7_data);
300 int PKCS7_SIGNER_INFO_set(PKCS7_SIGNER_INFO *p7i, X509 *x509, EVP_PKEY *pkey,
302 int PKCS7_add_signer(PKCS7 *p7, PKCS7_SIGNER_INFO *p7i);
303 int PKCS7_add_certificate(PKCS7 *p7, X509 *x509);
304 int PKCS7_add_crl(PKCS7 *p7, X509_CRL *x509);
305 int PKCS7_content_new(PKCS7 *p7, int nid);
306 int PKCS7_dataVerify(X509_STORE *cert_store, X509_STORE_CTX *ctx,
307 BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si);
308 int PKCS7_signatureVerify(BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si,
311 BIO *PKCS7_dataInit(PKCS7 *p7, BIO *bio);
312 int PKCS7_dataFinal(PKCS7 *p7, BIO *bio);
313 BIO *PKCS7_dataDecode(PKCS7 *p7, EVP_PKEY *pkey, BIO *in_bio, X509 *pcert);
315 PKCS7_SIGNER_INFO *PKCS7_add_signature(PKCS7 *p7, X509 *x509,
316 EVP_PKEY *pkey, const EVP_MD *dgst);
317 X509 *PKCS7_cert_from_signer_info(PKCS7 *p7, PKCS7_SIGNER_INFO *si);
318 int PKCS7_set_digest(PKCS7 *p7, const EVP_MD *md);
319 STACK_OF(PKCS7_SIGNER_INFO) *PKCS7_get_signer_info(PKCS7 *p7);
321 PKCS7_RECIP_INFO *PKCS7_add_recipient(PKCS7 *p7, X509 *x509);
322 int PKCS7_add_recipient_info(PKCS7 *p7, PKCS7_RECIP_INFO *ri);
323 int PKCS7_RECIP_INFO_set(PKCS7_RECIP_INFO *p7i, X509 *x509);
324 int PKCS7_set_cipher(PKCS7 *p7, const EVP_CIPHER *cipher);
326 PKCS7_ISSUER_AND_SERIAL *PKCS7_get_issuer_and_serial(PKCS7 *p7, int idx);
327 ASN1_OCTET_STRING *PKCS7_digest_from_attributes(STACK_OF(X509_ATTRIBUTE) *sk);
328 int PKCS7_add_signed_attribute(PKCS7_SIGNER_INFO *p7si, int nid, int type,
330 int PKCS7_add_attribute(PKCS7_SIGNER_INFO *p7si, int nid, int atrtype,
332 ASN1_TYPE *PKCS7_get_attribute(PKCS7_SIGNER_INFO *si, int nid);
333 ASN1_TYPE *PKCS7_get_signed_attribute(PKCS7_SIGNER_INFO *si, int nid);
334 int PKCS7_set_signed_attributes(PKCS7_SIGNER_INFO *p7si,
335 STACK_OF(X509_ATTRIBUTE) *sk);
336 int PKCS7_set_attributes(PKCS7_SIGNER_INFO *p7si,
337 STACK_OF(X509_ATTRIBUTE) *sk);
339 PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs,
340 BIO *data, int flags);
341 int PKCS7_verify(PKCS7 *p7, STACK_OF(X509) *certs, X509_STORE *store,
342 BIO *indata, BIO *out, int flags);
343 STACK_OF(X509) *PKCS7_get0_signers(PKCS7 *p7, STACK_OF(X509) *certs,
345 PKCS7 *PKCS7_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher,
347 int PKCS7_decrypt(PKCS7 *p7, EVP_PKEY *pkey, X509 *cert, BIO *data,
350 int PKCS7_add_attrib_smimecap(PKCS7_SIGNER_INFO *si,
351 STACK_OF(X509_ALGOR) *cap);
352 STACK_OF(X509_ALGOR) *PKCS7_get_smimecap(PKCS7_SIGNER_INFO *si);
353 int PKCS7_simple_smimecap(STACK_OF(X509_ALGOR) *sk, int nid, int arg);
355 int SMIME_write_PKCS7(BIO *bio, PKCS7 *p7, BIO *data, int flags);
356 PKCS7 *SMIME_read_PKCS7(BIO *bio, BIO **bcont);
357 int SMIME_crlf_copy(BIO *in, BIO *out, int flags);
358 int SMIME_text(BIO *in, BIO *out);
360 /* BEGIN ERROR CODES */
362 * The following lines are auto generated by the script mkerr.pl. Any changes
363 * made after this point may be overwritten when the script is next run.
365 void ERR_load_PKCS7_strings(void);
367 /* Error codes for the PKCS7 functions. */
369 /* Function codes. */
370 # define PKCS7_F_B64_READ_PKCS7 120
371 # define PKCS7_F_B64_WRITE_PKCS7 121
372 # define PKCS7_F_PKCS7_ADD_ATTRIB_SMIMECAP 118
373 # define PKCS7_F_PKCS7_ADD_CERTIFICATE 100
374 # define PKCS7_F_PKCS7_ADD_CRL 101
375 # define PKCS7_F_PKCS7_ADD_RECIPIENT_INFO 102
376 # define PKCS7_F_PKCS7_ADD_SIGNER 103
377 # define PKCS7_F_PKCS7_BIO_ADD_DIGEST 125
378 # define PKCS7_F_PKCS7_CTRL 104
379 # define PKCS7_F_PKCS7_DATADECODE 112
380 # define PKCS7_F_PKCS7_DATAFINAL 128
381 # define PKCS7_F_PKCS7_DATAINIT 105
382 # define PKCS7_F_PKCS7_DATASIGN 106
383 # define PKCS7_F_PKCS7_DATAVERIFY 107
384 # define PKCS7_F_PKCS7_DECRYPT 114
385 # define PKCS7_F_PKCS7_ENCRYPT 115
386 # define PKCS7_F_PKCS7_FIND_DIGEST 127
387 # define PKCS7_F_PKCS7_GET0_SIGNERS 124
388 # define PKCS7_F_PKCS7_SET_CIPHER 108
389 # define PKCS7_F_PKCS7_SET_CONTENT 109
390 # define PKCS7_F_PKCS7_SET_DIGEST 126
391 # define PKCS7_F_PKCS7_SET_TYPE 110
392 # define PKCS7_F_PKCS7_SIGN 116
393 # define PKCS7_F_PKCS7_SIGNATUREVERIFY 113
394 # define PKCS7_F_PKCS7_SIMPLE_SMIMECAP 119
395 # define PKCS7_F_PKCS7_VERIFY 117
396 # define PKCS7_F_SMIME_READ_PKCS7 122
397 # define PKCS7_F_SMIME_TEXT 123
400 # define PKCS7_R_CERTIFICATE_VERIFY_ERROR 117
401 # define PKCS7_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER 144
402 # define PKCS7_R_CIPHER_NOT_INITIALIZED 116
403 # define PKCS7_R_CONTENT_AND_DATA_PRESENT 118
404 # define PKCS7_R_DECODE_ERROR 130
405 # define PKCS7_R_DECRYPTED_KEY_IS_WRONG_LENGTH 100
406 # define PKCS7_R_DECRYPT_ERROR 119
407 # define PKCS7_R_DIGEST_FAILURE 101
408 # define PKCS7_R_ERROR_ADDING_RECIPIENT 120
409 # define PKCS7_R_ERROR_SETTING_CIPHER 121
410 # define PKCS7_R_INVALID_MIME_TYPE 131
411 # define PKCS7_R_INVALID_NULL_POINTER 143
412 # define PKCS7_R_MIME_NO_CONTENT_TYPE 132
413 # define PKCS7_R_MIME_PARSE_ERROR 133
414 # define PKCS7_R_MIME_SIG_PARSE_ERROR 134
415 # define PKCS7_R_MISSING_CERIPEND_INFO 103
416 # define PKCS7_R_NO_CONTENT 122
417 # define PKCS7_R_NO_CONTENT_TYPE 135
418 # define PKCS7_R_NO_MULTIPART_BODY_FAILURE 136
419 # define PKCS7_R_NO_MULTIPART_BOUNDARY 137
420 # define PKCS7_R_NO_RECIPIENT_MATCHES_CERTIFICATE 115
421 # define PKCS7_R_NO_RECIPIENT_MATCHES_KEY 146
422 # define PKCS7_R_NO_SIGNATURES_ON_DATA 123
423 # define PKCS7_R_NO_SIGNERS 142
424 # define PKCS7_R_NO_SIG_CONTENT_TYPE 138
425 # define PKCS7_R_OPERATION_NOT_SUPPORTED_ON_THIS_TYPE 104
426 # define PKCS7_R_PKCS7_ADD_SIGNATURE_ERROR 124
427 # define PKCS7_R_PKCS7_DATAFINAL 126
428 # define PKCS7_R_PKCS7_DATAFINAL_ERROR 125
429 # define PKCS7_R_PKCS7_DATASIGN 145
430 # define PKCS7_R_PKCS7_PARSE_ERROR 139
431 # define PKCS7_R_PKCS7_SIG_PARSE_ERROR 140
432 # define PKCS7_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 127
433 # define PKCS7_R_SIGNATURE_FAILURE 105
434 # define PKCS7_R_SIGNER_CERTIFICATE_NOT_FOUND 128
435 # define PKCS7_R_SIG_INVALID_MIME_TYPE 141
436 # define PKCS7_R_SMIME_TEXT_ERROR 129
437 # define PKCS7_R_UNABLE_TO_FIND_CERTIFICATE 106
438 # define PKCS7_R_UNABLE_TO_FIND_MEM_BIO 107
439 # define PKCS7_R_UNABLE_TO_FIND_MESSAGE_DIGEST 108
440 # define PKCS7_R_UNKNOWN_DIGEST_TYPE 109
441 # define PKCS7_R_UNKNOWN_OPERATION 110
442 # define PKCS7_R_UNSUPPORTED_CIPHER_TYPE 111
443 # define PKCS7_R_UNSUPPORTED_CONTENT_TYPE 112
444 # define PKCS7_R_WRONG_CONTENT_TYPE 113
445 # define PKCS7_R_WRONG_PKCS7_TYPE 114