2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999-2003 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 B64_write_PKCS7(BIO *bio, PKCS7 *p7);
90 static PKCS7 *B64_read_PKCS7(BIO *bio);
91 static char * strip_ends(char *name);
92 static char * strip_start(char *name);
93 static char * strip_end(char *name);
94 static MIME_HEADER *mime_hdr_new(char *name, char *value);
95 static int mime_hdr_addparam(MIME_HEADER *mhdr, char *name, char *value);
96 static STACK_OF(MIME_HEADER) *mime_parse_hdr(BIO *bio);
97 static int mime_hdr_cmp(const MIME_HEADER * const *a,
98 const MIME_HEADER * const *b);
99 static int mime_param_cmp(const MIME_PARAM * const *a,
100 const MIME_PARAM * const *b);
101 static void mime_param_free(MIME_PARAM *param);
102 static int mime_bound_check(char *line, int linelen, char *bound, int blen);
103 static int multi_split(BIO *bio, char *bound, STACK_OF(BIO) **ret);
104 static int strip_eol(char *linebuf, int *plen);
105 static MIME_HEADER *mime_hdr_find(STACK_OF(MIME_HEADER) *hdrs, char *name);
106 static MIME_PARAM *mime_param_find(MIME_HEADER *hdr, char *name);
107 static void mime_hdr_free(MIME_HEADER *hdr);
109 #define MAX_SMLEN 1024
110 #define mime_debug(x) /* x */
113 typedef void (*stkfree)();
115 /* Base 64 read and write of PKCS#7 structure */
117 static int B64_write_PKCS7(BIO *bio, PKCS7 *p7)
120 if(!(b64 = BIO_new(BIO_f_base64()))) {
121 PKCS7err(PKCS7_F_B64_WRITE_PKCS7,ERR_R_MALLOC_FAILURE);
124 bio = BIO_push(b64, bio);
125 i2d_PKCS7_bio(bio, p7);
132 static PKCS7 *B64_read_PKCS7(BIO *bio)
136 if(!(b64 = BIO_new(BIO_f_base64()))) {
137 PKCS7err(PKCS7_F_B64_READ_PKCS7,ERR_R_MALLOC_FAILURE);
140 bio = BIO_push(b64, bio);
141 if(!(p7 = d2i_PKCS7_bio(bio, NULL)))
142 PKCS7err(PKCS7_F_B64_READ_PKCS7,PKCS7_R_DECODE_ERROR);
151 int SMIME_write_PKCS7(BIO *bio, PKCS7 *p7, BIO *data, int flags)
155 char *mime_prefix, *mime_eol;
156 if (flags & PKCS7_NOOLDMIMETYPE)
157 mime_prefix = "application/pkcs7-";
159 mime_prefix = "application/x-pkcs7-";
160 if (flags & PKCS7_CRLFEOL)
164 if((flags & PKCS7_DETACHED) && data) {
165 /* We want multipart/signed */
166 /* Generate a random boundary */
167 RAND_pseudo_bytes((unsigned char *)bound, 32);
168 for(i = 0; i < 32; i++) {
175 BIO_printf(bio, "MIME-Version: 1.0%s", mime_eol);
176 BIO_printf(bio, "Content-Type: multipart/signed;");
177 BIO_printf(bio, " protocol=\"%ssignature\";", mime_prefix);
178 BIO_printf(bio, " micalg=sha1; boundary=\"----%s\"%s%s",
179 bound, mime_eol, mime_eol);
180 BIO_printf(bio, "This is an S/MIME signed message%s%s",
182 /* Now write out the first part */
183 BIO_printf(bio, "------%s%s", bound, mime_eol);
184 SMIME_crlf_copy(data, bio, flags);
185 BIO_printf(bio, "%s------%s%s", mime_eol, bound, mime_eol);
187 /* Headers for signature */
189 BIO_printf(bio, "Content-Type: %ssignature;", mime_prefix);
190 BIO_printf(bio, " name=\"smime.p7s\"%s", mime_eol);
191 BIO_printf(bio, "Content-Transfer-Encoding: base64%s",
193 BIO_printf(bio, "Content-Disposition: attachment;");
194 BIO_printf(bio, " filename=\"smime.p7s\"%s%s",
196 B64_write_PKCS7(bio, p7);
197 BIO_printf(bio,"%s------%s--%s%s", mime_eol, bound,
202 BIO_printf(bio, "MIME-Version: 1.0%s", mime_eol);
203 BIO_printf(bio, "Content-Disposition: attachment;");
204 BIO_printf(bio, " filename=\"smime.p7m\"%s", mime_eol);
205 BIO_printf(bio, "Content-Type: %smime;", mime_prefix);
206 BIO_printf(bio, " name=\"smime.p7m\"%s", mime_eol);
207 BIO_printf(bio, "Content-Transfer-Encoding: base64%s%s",
209 B64_write_PKCS7(bio, p7);
210 BIO_printf(bio, "%s", mime_eol);
214 /* SMIME reader: handle multipart/signed and opaque signing.
215 * in multipart case the content is placed in a memory BIO
216 * pointed to by "bcont". In opaque this is set to NULL
219 PKCS7 *SMIME_read_PKCS7(BIO *bio, BIO **bcont)
222 STACK_OF(MIME_HEADER) *headers = NULL;
223 STACK_OF(BIO) *parts = NULL;
229 if(bcont) *bcont = NULL;
231 if (!(headers = mime_parse_hdr(bio))) {
232 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_MIME_PARSE_ERROR);
236 if(!(hdr = mime_hdr_find(headers, "content-type")) || !hdr->value) {
237 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
238 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_CONTENT_TYPE);
242 /* Handle multipart/signed */
244 if(!strcmp(hdr->value, "multipart/signed")) {
245 /* Split into two parts */
246 prm = mime_param_find(hdr, "boundary");
247 if(!prm || !prm->param_value) {
248 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
249 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_MULTIPART_BOUNDARY);
252 ret = multi_split(bio, prm->param_value, &parts);
253 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
254 if(!ret || (sk_BIO_num(parts) != 2) ) {
255 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_MULTIPART_BODY_FAILURE);
256 sk_BIO_pop_free(parts, BIO_vfree);
260 /* Parse the signature piece */
261 p7in = sk_BIO_value(parts, 1);
263 if (!(headers = mime_parse_hdr(p7in))) {
264 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_MIME_SIG_PARSE_ERROR);
265 sk_BIO_pop_free(parts, BIO_vfree);
269 /* Get content type */
271 if(!(hdr = mime_hdr_find(headers, "content-type")) ||
273 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
274 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_SIG_CONTENT_TYPE);
278 if(strcmp(hdr->value, "application/x-pkcs7-signature") &&
279 strcmp(hdr->value, "application/pkcs7-signature")) {
280 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
281 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_SIG_INVALID_MIME_TYPE);
282 ERR_add_error_data(2, "type: ", hdr->value);
283 sk_BIO_pop_free(parts, BIO_vfree);
286 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
288 if(!(p7 = B64_read_PKCS7(p7in))) {
289 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_PKCS7_SIG_PARSE_ERROR);
290 sk_BIO_pop_free(parts, BIO_vfree);
295 *bcont = sk_BIO_value(parts, 0);
298 } else sk_BIO_pop_free(parts, BIO_vfree);
302 /* OK, if not multipart/signed try opaque signature */
304 if (strcmp (hdr->value, "application/x-pkcs7-mime") &&
305 strcmp (hdr->value, "application/pkcs7-mime")) {
306 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_INVALID_MIME_TYPE);
307 ERR_add_error_data(2, "type: ", hdr->value);
308 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
312 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
314 if(!(p7 = B64_read_PKCS7(bio))) {
315 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_PKCS7_PARSE_ERROR);
322 /* Copy text from one BIO to another making the output CRLF at EOL */
323 int SMIME_crlf_copy(BIO *in, BIO *out, int flags)
327 char linebuf[MAX_SMLEN];
328 if(flags & PKCS7_BINARY) {
329 while((len = BIO_read(in, linebuf, MAX_SMLEN)) > 0)
330 BIO_write(out, linebuf, len);
333 if(flags & PKCS7_TEXT) BIO_printf(out, "Content-Type: text/plain\r\n\r\n");
334 while ((len = BIO_gets(in, linebuf, MAX_SMLEN)) > 0) {
335 eol = strip_eol(linebuf, &len);
337 BIO_write(out, linebuf, len);
338 if(eol) BIO_write(out, "\r\n", 2);
343 /* Strip off headers if they are text/plain */
344 int SMIME_text(BIO *in, BIO *out)
348 STACK_OF(MIME_HEADER) *headers;
351 if (!(headers = mime_parse_hdr(in))) {
352 PKCS7err(PKCS7_F_SMIME_TEXT,PKCS7_R_MIME_PARSE_ERROR);
355 if(!(hdr = mime_hdr_find(headers, "content-type")) || !hdr->value) {
356 PKCS7err(PKCS7_F_SMIME_TEXT,PKCS7_R_MIME_NO_CONTENT_TYPE);
357 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
360 if (strcmp (hdr->value, "text/plain")) {
361 PKCS7err(PKCS7_F_SMIME_TEXT,PKCS7_R_INVALID_MIME_TYPE);
362 ERR_add_error_data(2, "type: ", hdr->value);
363 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
366 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
367 while ((len = BIO_read(in, iobuf, sizeof(iobuf))) > 0)
368 BIO_write(out, iobuf, len);
372 /* Split a multipart/XXX message body into component parts: result is
373 * canonical parts in a STACK of bios
376 static int multi_split(BIO *bio, char *bound, STACK_OF(BIO) **ret)
378 char linebuf[MAX_SMLEN];
380 int eol = 0, next_eol = 0;
382 STACK_OF(BIO) *parts;
383 char state, part, first;
385 blen = strlen(bound);
389 parts = sk_BIO_new_null();
391 while ((len = BIO_gets(bio, linebuf, MAX_SMLEN)) > 0) {
392 state = mime_bound_check(linebuf, len, bound, blen);
396 } else if(state == 2) {
397 sk_BIO_push(parts, bpart);
400 /* Strip CR+LF from linebuf */
401 next_eol = strip_eol(linebuf, &len);
404 if(bpart) sk_BIO_push(parts, bpart);
405 bpart = BIO_new(BIO_s_mem());
406 BIO_set_mem_eof_return(bpart, 0);
408 BIO_write(bpart, "\r\n", 2);
411 BIO_write(bpart, linebuf, len);
417 /* This is the big one: parse MIME header lines up to message body */
419 #define MIME_INVALID 0
425 #define MIME_COMMENT 6
428 static STACK_OF(MIME_HEADER) *mime_parse_hdr(BIO *bio)
432 char linebuf[MAX_SMLEN];
433 MIME_HEADER *mhdr = NULL;
434 STACK_OF(MIME_HEADER) *headers;
435 int len, state, save_state = 0;
437 headers = sk_MIME_HEADER_new(mime_hdr_cmp);
438 while ((len = BIO_gets(bio, linebuf, MAX_SMLEN)) > 0) {
439 /* If whitespace at line start then continuation line */
440 if(mhdr && isspace((unsigned char)linebuf[0])) state = MIME_NAME;
441 else state = MIME_START;
443 /* Go through all characters */
444 for(p = linebuf, q = linebuf; (c = *p) && (c!='\r') && (c!='\n'); p++) {
446 /* State machine to handle MIME headers
447 * if this looks horrible that's because it *is*
455 ntmp = strip_ends(q);
462 mime_debug("Found End Value\n");
464 mhdr = mime_hdr_new(ntmp, strip_ends(q));
465 sk_MIME_HEADER_push(headers, mhdr);
469 } else if(c == '(') {
471 state = MIME_COMMENT;
485 ntmp = strip_ends(q);
494 mime_hdr_addparam(mhdr, ntmp, strip_ends(q));
497 } else if (c == '"') {
498 mime_debug("Found Quote\n");
500 } else if(c == '(') {
502 state = MIME_COMMENT;
508 mime_debug("Found Match Quote\n");
515 if(state == MIME_TYPE) {
516 mhdr = mime_hdr_new(ntmp, strip_ends(q));
517 sk_MIME_HEADER_push(headers, mhdr);
518 } else if(state == MIME_VALUE)
519 mime_hdr_addparam(mhdr, ntmp, strip_ends(q));
520 if(p == linebuf) break; /* Blank line means end of headers */
527 static char *strip_ends(char *name)
529 return strip_end(strip_start(name));
532 /* Strip a parameter of whitespace from start of param */
533 static char *strip_start(char *name)
536 /* Look for first non white space or quote */
537 for(p = name; (c = *p) ;p++) {
539 /* Next char is start of string if non null */
540 if(p[1]) return p + 1;
541 /* Else null string */
544 if(!isspace((unsigned char)c)) return p;
549 /* As above but strip from end of string : maybe should handle brackets? */
550 static char *strip_end(char *name)
553 if(!name) return NULL;
554 /* Look for first non white space or quote */
555 for(p = name + strlen(name) - 1; p >= name ;p--) {
558 if(p - 1 == name) return NULL;
562 if(isspace((unsigned char)c)) *p = 0;
568 static MIME_HEADER *mime_hdr_new(char *name, char *value)
571 char *tmpname, *tmpval, *p;
574 if(!(tmpname = BUF_strdup(name))) return NULL;
575 for(p = tmpname ; *p; p++) {
582 } else tmpname = NULL;
584 if(!(tmpval = BUF_strdup(value))) return NULL;
585 for(p = tmpval ; *p; p++) {
592 } else tmpval = NULL;
593 mhdr = (MIME_HEADER *) OPENSSL_malloc(sizeof(MIME_HEADER));
594 if(!mhdr) return NULL;
595 mhdr->name = tmpname;
596 mhdr->value = tmpval;
597 if(!(mhdr->params = sk_MIME_PARAM_new(mime_param_cmp))) return NULL;
601 static int mime_hdr_addparam(MIME_HEADER *mhdr, char *name, char *value)
603 char *tmpname, *tmpval, *p;
607 tmpname = BUF_strdup(name);
608 if(!tmpname) return 0;
609 for(p = tmpname ; *p; p++) {
616 } else tmpname = NULL;
618 tmpval = BUF_strdup(value);
619 if(!tmpval) return 0;
620 } else tmpval = NULL;
621 /* Parameter values are case sensitive so leave as is */
622 mparam = (MIME_PARAM *) OPENSSL_malloc(sizeof(MIME_PARAM));
623 if(!mparam) return 0;
624 mparam->param_name = tmpname;
625 mparam->param_value = tmpval;
626 sk_MIME_PARAM_push(mhdr->params, mparam);
630 static int mime_hdr_cmp(const MIME_HEADER * const *a,
631 const MIME_HEADER * const *b)
633 return(strcmp((*a)->name, (*b)->name));
636 static int mime_param_cmp(const MIME_PARAM * const *a,
637 const MIME_PARAM * const *b)
639 return(strcmp((*a)->param_name, (*b)->param_name));
642 /* Find a header with a given name (if possible) */
644 static MIME_HEADER *mime_hdr_find(STACK_OF(MIME_HEADER) *hdrs, char *name)
649 idx = sk_MIME_HEADER_find(hdrs, &htmp);
650 if(idx < 0) return NULL;
651 return sk_MIME_HEADER_value(hdrs, idx);
654 static MIME_PARAM *mime_param_find(MIME_HEADER *hdr, char *name)
658 param.param_name = name;
659 idx = sk_MIME_PARAM_find(hdr->params, ¶m);
660 if(idx < 0) return NULL;
661 return sk_MIME_PARAM_value(hdr->params, idx);
664 static void mime_hdr_free(MIME_HEADER *hdr)
666 if(hdr->name) OPENSSL_free(hdr->name);
667 if(hdr->value) OPENSSL_free(hdr->value);
668 if(hdr->params) sk_MIME_PARAM_pop_free(hdr->params, mime_param_free);
672 static void mime_param_free(MIME_PARAM *param)
674 if(param->param_name) OPENSSL_free(param->param_name);
675 if(param->param_value) OPENSSL_free(param->param_value);
679 /* Check for a multipart boundary. Returns:
684 static int mime_bound_check(char *line, int linelen, char *bound, int blen)
686 if(linelen == -1) linelen = strlen(line);
687 if(blen == -1) blen = strlen(bound);
688 /* Quickly eliminate if line length too short */
689 if(blen + 2 > linelen) return 0;
690 /* Check for part boundary */
691 if(!strncmp(line, "--", 2) && !strncmp(line + 2, bound, blen)) {
692 if(!strncmp(line + blen + 2, "--", 2)) return 2;
698 static int strip_eol(char *linebuf, int *plen)
703 p = linebuf + len - 1;
704 for (p = linebuf + len - 1; len > 0; len--, p--)