2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999-2005 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
62 #include <openssl/rand.h>
63 #include <openssl/x509.h>
65 /* MIME and related routines */
67 /* MIME format structures
68 * Note that all are translated to lower case apart from
69 * parameter values. Quotes are stripped off
73 char *param_name; /* Param name e.g. "micalg" */
74 char *param_value; /* Param value e.g. "sha1" */
77 DECLARE_STACK_OF(MIME_PARAM)
78 IMPLEMENT_STACK_OF(MIME_PARAM)
81 char *name; /* Name of line e.g. "content-type" */
82 char *value; /* Value of line e.g. "text/plain" */
83 STACK_OF(MIME_PARAM) *params; /* Zero or more parameters */
86 DECLARE_STACK_OF(MIME_HEADER)
87 IMPLEMENT_STACK_OF(MIME_HEADER)
89 static int pkcs7_output_data(BIO *bio, BIO *data, PKCS7 *p7, int flags);
90 static int B64_write_PKCS7(BIO *bio, PKCS7 *p7);
91 static PKCS7 *B64_read_PKCS7(BIO *bio);
92 static char * strip_ends(char *name);
93 static char * strip_start(char *name);
94 static char * strip_end(char *name);
95 static MIME_HEADER *mime_hdr_new(char *name, char *value);
96 static int mime_hdr_addparam(MIME_HEADER *mhdr, char *name, char *value);
97 static STACK_OF(MIME_HEADER) *mime_parse_hdr(BIO *bio);
98 static int mime_hdr_cmp(const MIME_HEADER * const *a,
99 const MIME_HEADER * const *b);
100 static int mime_param_cmp(const MIME_PARAM * const *a,
101 const MIME_PARAM * const *b);
102 static void mime_param_free(MIME_PARAM *param);
103 static int mime_bound_check(char *line, int linelen, char *bound, int blen);
104 static int multi_split(BIO *bio, char *bound, STACK_OF(BIO) **ret);
105 static int strip_eol(char *linebuf, int *plen);
106 static MIME_HEADER *mime_hdr_find(STACK_OF(MIME_HEADER) *hdrs, char *name);
107 static MIME_PARAM *mime_param_find(MIME_HEADER *hdr, char *name);
108 static void mime_hdr_free(MIME_HEADER *hdr);
110 #define MAX_SMLEN 1024
111 #define mime_debug(x) /* x */
113 /* Base 64 read and write of PKCS#7 structure */
115 static int B64_write_PKCS7(BIO *bio, PKCS7 *p7)
118 if(!(b64 = BIO_new(BIO_f_base64()))) {
119 PKCS7err(PKCS7_F_B64_WRITE_PKCS7,ERR_R_MALLOC_FAILURE);
122 bio = BIO_push(b64, bio);
123 i2d_PKCS7_bio(bio, p7);
124 (void)BIO_flush(bio);
130 static PKCS7 *B64_read_PKCS7(BIO *bio)
134 if(!(b64 = BIO_new(BIO_f_base64()))) {
135 PKCS7err(PKCS7_F_B64_READ_PKCS7,ERR_R_MALLOC_FAILURE);
138 bio = BIO_push(b64, bio);
139 if(!(p7 = d2i_PKCS7_bio(bio, NULL)))
140 PKCS7err(PKCS7_F_B64_READ_PKCS7,PKCS7_R_DECODE_ERROR);
141 (void)BIO_flush(bio);
149 int SMIME_write_PKCS7(BIO *bio, PKCS7 *p7, BIO *data, int flags)
153 char *mime_prefix, *mime_eol, *msg_type=NULL;
154 if (flags & PKCS7_NOOLDMIMETYPE)
155 mime_prefix = "application/pkcs7-";
157 mime_prefix = "application/x-pkcs7-";
159 if (flags & PKCS7_CRLFEOL)
163 if((flags & PKCS7_DETACHED) && data) {
164 /* We want multipart/signed */
165 /* Generate a random boundary */
166 RAND_pseudo_bytes((unsigned char *)bound, 32);
167 for(i = 0; i < 32; i++) {
174 BIO_printf(bio, "MIME-Version: 1.0%s", mime_eol);
175 BIO_printf(bio, "Content-Type: multipart/signed;");
176 BIO_printf(bio, " protocol=\"%ssignature\";", mime_prefix);
177 BIO_printf(bio, " micalg=sha1; boundary=\"----%s\"%s%s",
178 bound, mime_eol, mime_eol);
179 BIO_printf(bio, "This is an S/MIME signed message%s%s",
181 /* Now write out the first part */
182 BIO_printf(bio, "------%s%s", bound, mime_eol);
183 pkcs7_output_data(bio, data, p7, flags);
184 BIO_printf(bio, "%s------%s%s", mime_eol, bound, mime_eol);
186 /* Headers for signature */
188 BIO_printf(bio, "Content-Type: %ssignature;", mime_prefix);
189 BIO_printf(bio, " name=\"smime.p7s\"%s", mime_eol);
190 BIO_printf(bio, "Content-Transfer-Encoding: base64%s",
192 BIO_printf(bio, "Content-Disposition: attachment;");
193 BIO_printf(bio, " filename=\"smime.p7s\"%s%s",
195 B64_write_PKCS7(bio, p7);
196 BIO_printf(bio,"%s------%s--%s%s", mime_eol, bound,
201 /* Determine smime-type header */
203 if (PKCS7_type_is_enveloped(p7))
204 msg_type = "enveloped-data";
205 else if (PKCS7_type_is_signed(p7))
207 /* If we have any signers it is signed-data othewise
210 STACK_OF(PKCS7_SIGNER_INFO) *sinfos;
211 sinfos = PKCS7_get_signer_info(p7);
212 if (sk_PKCS7_SIGNER_INFO_num(sinfos) > 0)
213 msg_type = "signed-data";
215 msg_type = "certs-only";
218 BIO_printf(bio, "MIME-Version: 1.0%s", mime_eol);
219 BIO_printf(bio, "Content-Disposition: attachment;");
220 BIO_printf(bio, " filename=\"smime.p7m\"%s", mime_eol);
221 BIO_printf(bio, "Content-Type: %smime;", mime_prefix);
223 BIO_printf(bio, " smime-type=%s;", msg_type);
224 BIO_printf(bio, " name=\"smime.p7m\"%s", mime_eol);
225 BIO_printf(bio, "Content-Transfer-Encoding: base64%s%s",
227 B64_write_PKCS7(bio, p7);
228 BIO_printf(bio, "%s", mime_eol);
232 /* Handle output of PKCS#7 data */
235 static int pkcs7_output_data(BIO *out, BIO *data, PKCS7 *p7, int flags)
239 if (!(flags & PKCS7_STREAM))
241 SMIME_crlf_copy(data, out, flags);
245 /* Partial sign operation */
247 /* Initialize sign operation */
248 p7bio = PKCS7_dataInit(p7, out);
250 /* Copy data across, computing digests etc */
251 SMIME_crlf_copy(data, p7bio, flags);
253 /* Must be detached */
254 PKCS7_set_detached(p7, 1);
256 /* Finalize signatures */
257 PKCS7_dataFinal(p7, p7bio);
259 /* Now remove any digests prepended to the BIO */
263 tmpbio = BIO_pop(p7bio);
272 /* SMIME reader: handle multipart/signed and opaque signing.
273 * in multipart case the content is placed in a memory BIO
274 * pointed to by "bcont". In opaque this is set to NULL
277 PKCS7 *SMIME_read_PKCS7(BIO *bio, BIO **bcont)
280 STACK_OF(MIME_HEADER) *headers = NULL;
281 STACK_OF(BIO) *parts = NULL;
287 if(bcont) *bcont = NULL;
289 if (!(headers = mime_parse_hdr(bio))) {
290 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_MIME_PARSE_ERROR);
294 if(!(hdr = mime_hdr_find(headers, "content-type")) || !hdr->value) {
295 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
296 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_CONTENT_TYPE);
300 /* Handle multipart/signed */
302 if(!strcmp(hdr->value, "multipart/signed")) {
303 /* Split into two parts */
304 prm = mime_param_find(hdr, "boundary");
305 if(!prm || !prm->param_value) {
306 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
307 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_MULTIPART_BOUNDARY);
310 ret = multi_split(bio, prm->param_value, &parts);
311 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
312 if(!ret || (sk_BIO_num(parts) != 2) ) {
313 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_MULTIPART_BODY_FAILURE);
314 sk_BIO_pop_free(parts, BIO_vfree);
318 /* Parse the signature piece */
319 p7in = sk_BIO_value(parts, 1);
321 if (!(headers = mime_parse_hdr(p7in))) {
322 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_MIME_SIG_PARSE_ERROR);
323 sk_BIO_pop_free(parts, BIO_vfree);
327 /* Get content type */
329 if(!(hdr = mime_hdr_find(headers, "content-type")) ||
331 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
332 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_SIG_CONTENT_TYPE);
336 if(strcmp(hdr->value, "application/x-pkcs7-signature") &&
337 strcmp(hdr->value, "application/pkcs7-signature")) {
338 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
339 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_SIG_INVALID_MIME_TYPE);
340 ERR_add_error_data(2, "type: ", hdr->value);
341 sk_BIO_pop_free(parts, BIO_vfree);
344 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
346 if(!(p7 = B64_read_PKCS7(p7in))) {
347 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_PKCS7_SIG_PARSE_ERROR);
348 sk_BIO_pop_free(parts, BIO_vfree);
353 *bcont = sk_BIO_value(parts, 0);
356 } else sk_BIO_pop_free(parts, BIO_vfree);
360 /* OK, if not multipart/signed try opaque signature */
362 if (strcmp (hdr->value, "application/x-pkcs7-mime") &&
363 strcmp (hdr->value, "application/pkcs7-mime")) {
364 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_INVALID_MIME_TYPE);
365 ERR_add_error_data(2, "type: ", hdr->value);
366 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
370 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
372 if(!(p7 = B64_read_PKCS7(bio))) {
373 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_PKCS7_PARSE_ERROR);
380 /* Copy text from one BIO to another making the output CRLF at EOL */
381 int SMIME_crlf_copy(BIO *in, BIO *out, int flags)
385 char linebuf[MAX_SMLEN];
386 if(flags & PKCS7_BINARY) {
387 while((len = BIO_read(in, linebuf, MAX_SMLEN)) > 0)
388 BIO_write(out, linebuf, len);
391 if(flags & PKCS7_TEXT)
392 BIO_printf(out, "Content-Type: text/plain\r\n\r\n");
393 while ((len = BIO_gets(in, linebuf, MAX_SMLEN)) > 0) {
394 eol = strip_eol(linebuf, &len);
396 BIO_write(out, linebuf, len);
397 if(eol) BIO_write(out, "\r\n", 2);
402 /* Strip off headers if they are text/plain */
403 int SMIME_text(BIO *in, BIO *out)
407 STACK_OF(MIME_HEADER) *headers;
410 if (!(headers = mime_parse_hdr(in))) {
411 PKCS7err(PKCS7_F_SMIME_TEXT,PKCS7_R_MIME_PARSE_ERROR);
414 if(!(hdr = mime_hdr_find(headers, "content-type")) || !hdr->value) {
415 PKCS7err(PKCS7_F_SMIME_TEXT,PKCS7_R_MIME_NO_CONTENT_TYPE);
416 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
419 if (strcmp (hdr->value, "text/plain")) {
420 PKCS7err(PKCS7_F_SMIME_TEXT,PKCS7_R_INVALID_MIME_TYPE);
421 ERR_add_error_data(2, "type: ", hdr->value);
422 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
425 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
426 while ((len = BIO_read(in, iobuf, sizeof(iobuf))) > 0)
427 BIO_write(out, iobuf, len);
431 /* Split a multipart/XXX message body into component parts: result is
432 * canonical parts in a STACK of bios
435 static int multi_split(BIO *bio, char *bound, STACK_OF(BIO) **ret)
437 char linebuf[MAX_SMLEN];
439 int eol = 0, next_eol = 0;
441 STACK_OF(BIO) *parts;
442 char state, part, first;
444 blen = strlen(bound);
448 parts = sk_BIO_new_null();
450 while ((len = BIO_gets(bio, linebuf, MAX_SMLEN)) > 0) {
451 state = mime_bound_check(linebuf, len, bound, blen);
455 } else if(state == 2) {
456 sk_BIO_push(parts, bpart);
459 /* Strip CR+LF from linebuf */
460 next_eol = strip_eol(linebuf, &len);
463 if(bpart) sk_BIO_push(parts, bpart);
464 bpart = BIO_new(BIO_s_mem());
465 BIO_set_mem_eof_return(bpart, 0);
467 BIO_write(bpart, "\r\n", 2);
470 BIO_write(bpart, linebuf, len);
476 /* This is the big one: parse MIME header lines up to message body */
478 #define MIME_INVALID 0
484 #define MIME_COMMENT 6
487 static STACK_OF(MIME_HEADER) *mime_parse_hdr(BIO *bio)
491 char linebuf[MAX_SMLEN];
492 MIME_HEADER *mhdr = NULL;
493 STACK_OF(MIME_HEADER) *headers;
494 int len, state, save_state = 0;
496 headers = sk_MIME_HEADER_new(mime_hdr_cmp);
497 while ((len = BIO_gets(bio, linebuf, MAX_SMLEN)) > 0) {
498 /* If whitespace at line start then continuation line */
499 if(mhdr && isspace((unsigned char)linebuf[0])) state = MIME_NAME;
500 else state = MIME_START;
502 /* Go through all characters */
503 for(p = linebuf, q = linebuf; (c = *p) && (c!='\r') && (c!='\n'); p++) {
505 /* State machine to handle MIME headers
506 * if this looks horrible that's because it *is*
514 ntmp = strip_ends(q);
521 mime_debug("Found End Value\n");
523 mhdr = mime_hdr_new(ntmp, strip_ends(q));
524 sk_MIME_HEADER_push(headers, mhdr);
528 } else if(c == '(') {
530 state = MIME_COMMENT;
544 ntmp = strip_ends(q);
553 mime_hdr_addparam(mhdr, ntmp, strip_ends(q));
556 } else if (c == '"') {
557 mime_debug("Found Quote\n");
559 } else if(c == '(') {
561 state = MIME_COMMENT;
567 mime_debug("Found Match Quote\n");
574 if(state == MIME_TYPE) {
575 mhdr = mime_hdr_new(ntmp, strip_ends(q));
576 sk_MIME_HEADER_push(headers, mhdr);
577 } else if(state == MIME_VALUE)
578 mime_hdr_addparam(mhdr, ntmp, strip_ends(q));
579 if(p == linebuf) break; /* Blank line means end of headers */
586 static char *strip_ends(char *name)
588 return strip_end(strip_start(name));
591 /* Strip a parameter of whitespace from start of param */
592 static char *strip_start(char *name)
595 /* Look for first non white space or quote */
596 for(p = name; (c = *p) ;p++) {
598 /* Next char is start of string if non null */
599 if(p[1]) return p + 1;
600 /* Else null string */
603 if(!isspace((unsigned char)c)) return p;
608 /* As above but strip from end of string : maybe should handle brackets? */
609 static char *strip_end(char *name)
612 if(!name) return NULL;
613 /* Look for first non white space or quote */
614 for(p = name + strlen(name) - 1; p >= name ;p--) {
617 if(p - 1 == name) return NULL;
621 if(isspace((unsigned char)c)) *p = 0;
627 static MIME_HEADER *mime_hdr_new(char *name, char *value)
630 char *tmpname, *tmpval, *p;
633 if(!(tmpname = BUF_strdup(name))) return NULL;
634 for(p = tmpname ; *p; p++) {
641 } else tmpname = NULL;
643 if(!(tmpval = BUF_strdup(value))) return NULL;
644 for(p = tmpval ; *p; p++) {
651 } else tmpval = NULL;
652 mhdr = (MIME_HEADER *) OPENSSL_malloc(sizeof(MIME_HEADER));
653 if(!mhdr) return NULL;
654 mhdr->name = tmpname;
655 mhdr->value = tmpval;
656 if(!(mhdr->params = sk_MIME_PARAM_new(mime_param_cmp))) return NULL;
660 static int mime_hdr_addparam(MIME_HEADER *mhdr, char *name, char *value)
662 char *tmpname, *tmpval, *p;
666 tmpname = BUF_strdup(name);
667 if(!tmpname) return 0;
668 for(p = tmpname ; *p; p++) {
675 } else tmpname = NULL;
677 tmpval = BUF_strdup(value);
678 if(!tmpval) return 0;
679 } else tmpval = NULL;
680 /* Parameter values are case sensitive so leave as is */
681 mparam = (MIME_PARAM *) OPENSSL_malloc(sizeof(MIME_PARAM));
682 if(!mparam) return 0;
683 mparam->param_name = tmpname;
684 mparam->param_value = tmpval;
685 sk_MIME_PARAM_push(mhdr->params, mparam);
689 static int mime_hdr_cmp(const MIME_HEADER * const *a,
690 const MIME_HEADER * const *b)
692 return(strcmp((*a)->name, (*b)->name));
695 static int mime_param_cmp(const MIME_PARAM * const *a,
696 const MIME_PARAM * const *b)
698 return(strcmp((*a)->param_name, (*b)->param_name));
701 /* Find a header with a given name (if possible) */
703 static MIME_HEADER *mime_hdr_find(STACK_OF(MIME_HEADER) *hdrs, char *name)
708 idx = sk_MIME_HEADER_find(hdrs, &htmp);
709 if(idx < 0) return NULL;
710 return sk_MIME_HEADER_value(hdrs, idx);
713 static MIME_PARAM *mime_param_find(MIME_HEADER *hdr, char *name)
717 param.param_name = name;
718 idx = sk_MIME_PARAM_find(hdr->params, ¶m);
719 if(idx < 0) return NULL;
720 return sk_MIME_PARAM_value(hdr->params, idx);
723 static void mime_hdr_free(MIME_HEADER *hdr)
725 if(hdr->name) OPENSSL_free(hdr->name);
726 if(hdr->value) OPENSSL_free(hdr->value);
727 if(hdr->params) sk_MIME_PARAM_pop_free(hdr->params, mime_param_free);
731 static void mime_param_free(MIME_PARAM *param)
733 if(param->param_name) OPENSSL_free(param->param_name);
734 if(param->param_value) OPENSSL_free(param->param_value);
738 /* Check for a multipart boundary. Returns:
743 static int mime_bound_check(char *line, int linelen, char *bound, int blen)
745 if(linelen == -1) linelen = strlen(line);
746 if(blen == -1) blen = strlen(bound);
747 /* Quickly eliminate if line length too short */
748 if(blen + 2 > linelen) return 0;
749 /* Check for part boundary */
750 if(!strncmp(line, "--", 2) && !strncmp(line + 2, bound, blen)) {
751 if(!strncmp(line + blen + 2, "--", 2)) return 2;
757 static int strip_eol(char *linebuf, int *plen)
762 p = linebuf + len - 1;
763 for (p = linebuf + len - 1; len > 0; len--, p--)