2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 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(MIME_HEADER **a, MIME_HEADER **b);
98 static int mime_param_cmp(MIME_PARAM **a, MIME_PARAM **b);
99 static void mime_param_free(MIME_PARAM *param);
100 static int mime_bound_check(char *line, int linelen, char *bound, int blen);
101 static int multi_split(BIO *bio, char *bound, STACK_OF(BIO) **ret);
102 static int iscrlf(char c);
103 static MIME_HEADER *mime_hdr_find(STACK_OF(MIME_HEADER) *hdrs, char *name);
104 static MIME_PARAM *mime_param_find(MIME_HEADER *hdr, char *name);
105 static void mime_hdr_free(MIME_HEADER *hdr);
107 #define MAX_SMLEN 1024
108 #define mime_debug(x) /* x */
111 typedef void (*stkfree)();
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);
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);
149 int SMIME_write_PKCS7(BIO *bio, PKCS7 *p7, BIO *data, int flags)
151 char linebuf[MAX_SMLEN];
154 if((flags & PKCS7_DETACHED) && data) {
155 /* We want multipart/signed */
156 /* Generate a random boundary */
157 RAND_pseudo_bytes((unsigned char *)bound, 32);
158 for(i = 0; i < 32; i++) {
165 BIO_printf(bio, "MIME-Version: 1.0\n");
166 BIO_printf(bio, "Content-Type: multipart/signed ; ");
167 BIO_printf(bio, "protocol=\"application/x-pkcs7-signature\" ; ");
168 BIO_printf(bio, "micalg=sha1 ; boundary=\"----%s\"\n\n", bound);
169 BIO_printf(bio, "This is an S/MIME signed message\n\n");
170 /* Now write out the first part */
171 BIO_printf(bio, "------%s\r\n", bound);
172 if(flags & PKCS7_TEXT) BIO_printf(bio, "Content-Type: text/plain\n\n");
173 while((i = BIO_read(data, linebuf, MAX_SMLEN)) > 0)
174 BIO_write(bio, linebuf, i);
175 BIO_printf(bio, "\n------%s\n", bound);
177 /* Headers for signature */
179 BIO_printf(bio, "Content-Type: application/x-pkcs7-signature; name=\"smime.p7s\"\n");
180 BIO_printf(bio, "Content-Transfer-Encoding: base64\n");
181 BIO_printf(bio, "Content-Disposition: attachment; filename=\"smime.p7s\"\n\n");
182 B64_write_PKCS7(bio, p7);
183 BIO_printf(bio,"\n------%s--\n\n", bound);
187 BIO_printf(bio, "MIME-Version: 1.0\n");
188 BIO_printf(bio, "Content-Disposition: attachment; filename=\"smime.p7m\"\n");
189 BIO_printf(bio, "Content-Type: application/x-pkcs7-mime; name=\"smime.p7m\"\n");
190 BIO_printf(bio, "Content-Transfer-Encoding: base64\n\n");
191 B64_write_PKCS7(bio, p7);
192 BIO_printf(bio, "\n");
196 /* SMIME reader: handle multipart/signed and opaque signing.
197 * in multipart case the content is placed in a memory BIO
198 * pointed to by "bcont". In opaque this is set to NULL
201 PKCS7 *SMIME_read_PKCS7(BIO *bio, BIO **bcont)
204 STACK_OF(MIME_HEADER) *headers = NULL;
205 STACK_OF(BIO) *parts = NULL;
211 if(bcont) *bcont = NULL;
213 if (!(headers = mime_parse_hdr(bio))) {
214 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_MIME_PARSE_ERROR);
218 if(!(hdr = mime_hdr_find(headers, "content-type")) || !hdr->value) {
219 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
220 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_CONTENT_TYPE);
224 /* Handle multipart/signed */
226 if(!strcmp(hdr->value, "multipart/signed")) {
227 /* Split into two parts */
228 prm = mime_param_find(hdr, "boundary");
229 if(!prm || !prm->param_value) {
230 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
231 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_MULTIPART_BOUNDARY);
234 ret = multi_split(bio, prm->param_value, &parts);
235 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
236 if(!ret || (sk_BIO_num(parts) != 2) ) {
237 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_MULTIPART_BODY_FAILURE);
238 sk_BIO_pop_free(parts, BIO_vfree);
242 /* Parse the signature piece */
243 p7in = sk_BIO_value(parts, 1);
245 if (!(headers = mime_parse_hdr(p7in))) {
246 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_MIME_SIG_PARSE_ERROR);
247 sk_BIO_pop_free(parts, BIO_vfree);
251 /* Get content type */
253 if(!(hdr = mime_hdr_find(headers, "content-type")) ||
255 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
256 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_NO_SIG_CONTENT_TYPE);
260 if(strcmp(hdr->value, "application/x-pkcs7-signature") &&
261 strcmp(hdr->value, "application/pkcs7-signature")) {
262 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
263 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_SIG_INVALID_MIME_TYPE);
264 ERR_add_error_data(2, "type: ", hdr->value);
265 sk_BIO_pop_free(parts, BIO_vfree);
268 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
270 if(!(p7 = B64_read_PKCS7(p7in))) {
271 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_PKCS7_SIG_PARSE_ERROR);
272 sk_BIO_pop_free(parts, BIO_vfree);
277 *bcont = sk_BIO_value(parts, 0);
280 } else sk_BIO_pop_free(parts, BIO_vfree);
284 /* OK, if not multipart/signed try opaque signature */
286 if (strcmp (hdr->value, "application/x-pkcs7-mime") &&
287 strcmp (hdr->value, "application/pkcs7-mime")) {
288 PKCS7err(PKCS7_F_SMIME_READ_PKCS7,PKCS7_R_INVALID_MIME_TYPE);
289 ERR_add_error_data(2, "type: ", hdr->value);
290 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
294 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
296 if(!(p7 = B64_read_PKCS7(bio))) {
297 PKCS7err(PKCS7_F_SMIME_READ_PKCS7, PKCS7_R_PKCS7_PARSE_ERROR);
304 /* Copy text from one BIO to another making the output CRLF at EOL */
305 int SMIME_crlf_copy(BIO *in, BIO *out, int flags)
309 char linebuf[MAX_SMLEN];
310 if(flags & PKCS7_BINARY) {
311 while((len = BIO_read(in, linebuf, MAX_SMLEN)) > 0)
312 BIO_write(out, linebuf, len);
315 if(flags & PKCS7_TEXT) BIO_printf(out, "Content-Type: text/plain\r\n\r\n");
316 while ((len = BIO_gets(in, linebuf, MAX_SMLEN)) > 0) {
318 while(iscrlf(linebuf[len - 1])) {
322 BIO_write(out, linebuf, len);
323 if(eol) BIO_write(out, "\r\n", 2);
328 /* Strip off headers if they are text/plain */
329 int SMIME_text(BIO *in, BIO *out)
333 STACK_OF(MIME_HEADER) *headers;
336 if (!(headers = mime_parse_hdr(in))) {
337 PKCS7err(PKCS7_F_SMIME_TEXT,PKCS7_R_MIME_PARSE_ERROR);
340 if(!(hdr = mime_hdr_find(headers, "content-type")) || !hdr->value) {
341 PKCS7err(PKCS7_F_SMIME_TEXT,PKCS7_R_MIME_NO_CONTENT_TYPE);
342 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
345 if (strcmp (hdr->value, "text/plain")) {
346 PKCS7err(PKCS7_F_SMIME_TEXT,PKCS7_R_INVALID_MIME_TYPE);
347 ERR_add_error_data(2, "type: ", hdr->value);
348 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
351 sk_MIME_HEADER_pop_free(headers, mime_hdr_free);
352 while ((len = BIO_read(in, iobuf, sizeof(iobuf))) > 0)
353 BIO_write(out, iobuf, len);
357 /* Split a multipart/XXX message body into component parts: result is
358 * canonical parts in a STACK of bios
361 static int multi_split(BIO *bio, char *bound, STACK_OF(BIO) **ret)
363 char linebuf[MAX_SMLEN];
366 STACK_OF(BIO) *parts;
367 char state, part, first;
369 blen = strlen(bound);
373 parts = sk_BIO_new(NULL);
375 while ((len = BIO_gets(bio, linebuf, MAX_SMLEN)) > 0) {
376 state = mime_bound_check(linebuf, len, bound, blen);
380 } else if(state == 2) {
381 sk_BIO_push(parts, bpart);
386 if(bpart) sk_BIO_push(parts, bpart);
387 bpart = BIO_new(BIO_s_mem());
389 } else BIO_write(bpart, "\r\n", 2);
390 /* Strip CR+LF from linebuf */
391 while(iscrlf(linebuf[len - 1])) len--;
392 BIO_write(bpart, linebuf, len);
398 static int iscrlf(char c)
400 if(c == '\r' || c == '\n') return 1;
404 /* This is the big one: parse MIME header lines up to message body */
406 #define MIME_INVALID 0
412 #define MIME_COMMENT 6
415 static STACK_OF(MIME_HEADER) *mime_parse_hdr(BIO *bio)
419 char linebuf[MAX_SMLEN];
420 MIME_HEADER *mhdr = NULL;
421 STACK_OF(MIME_HEADER) *headers;
422 int len, state, save_state = 0;
424 headers = sk_MIME_HEADER_new(mime_hdr_cmp);
425 while ((len = BIO_gets(bio, linebuf, MAX_SMLEN)) > 0) {
426 /* If whitespace at line start then continuation line */
427 if(mhdr && isspace((unsigned char)linebuf[0])) state = MIME_NAME;
428 else state = MIME_START;
430 /* Go through all characters */
431 for(p = linebuf, q = linebuf; (c = *p) && (c!='\r') && (c!='\n'); p++) {
433 /* State machine to handle MIME headers
434 * if this looks horrible that's because it *is*
442 ntmp = strip_ends(q);
449 mime_debug("Found End Value\n");
451 mhdr = mime_hdr_new(ntmp, strip_ends(q));
452 sk_MIME_HEADER_push(headers, mhdr);
456 } else if(c == '(') {
458 state = MIME_COMMENT;
472 ntmp = strip_ends(q);
481 mime_hdr_addparam(mhdr, ntmp, strip_ends(q));
484 } else if (c == '"') {
485 mime_debug("Found Quote\n");
487 } else if(c == '(') {
489 state = MIME_COMMENT;
495 mime_debug("Found Match Quote\n");
502 if(state == MIME_TYPE) {
503 mhdr = mime_hdr_new(ntmp, strip_ends(q));
504 sk_MIME_HEADER_push(headers, mhdr);
505 } else if(state == MIME_VALUE)
506 mime_hdr_addparam(mhdr, ntmp, strip_ends(q));
507 if(p == linebuf) break; /* Blank line means end of headers */
514 static char *strip_ends(char *name)
516 return strip_end(strip_start(name));
519 /* Strip a parameter of whitespace from start of param */
520 static char *strip_start(char *name)
523 /* Look for first non white space or quote */
524 for(p = name; (c = *p) ;p++) {
526 /* Next char is start of string if non null */
527 if(p[1]) return p + 1;
528 /* Else null string */
531 if(!isspace((unsigned char)c)) return p;
536 /* As above but strip from end of string : maybe should handle brackets? */
537 static char *strip_end(char *name)
540 if(!name) return NULL;
541 /* Look for first non white space or quote */
542 for(p = name + strlen(name) - 1; p >= name ;p--) {
545 if(p - 1 == name) return NULL;
549 if(isspace((unsigned char)c)) *p = 0;
555 static MIME_HEADER *mime_hdr_new(char *name, char *value)
558 char *tmpname, *tmpval, *p;
561 if(!(tmpname = BUF_strdup(name))) return NULL;
562 for(p = tmpname ; *p; p++) {
569 } else tmpname = NULL;
571 if(!(tmpval = BUF_strdup(value))) return NULL;
572 for(p = tmpval ; *p; p++) {
579 } else tmpval = NULL;
580 mhdr = (MIME_HEADER *) Malloc(sizeof(MIME_HEADER));
581 if(!mhdr) return NULL;
582 mhdr->name = tmpname;
583 mhdr->value = tmpval;
584 if(!(mhdr->params = sk_MIME_PARAM_new(mime_param_cmp))) return NULL;
588 static int mime_hdr_addparam(MIME_HEADER *mhdr, char *name, char *value)
590 char *tmpname, *tmpval, *p;
594 tmpname = BUF_strdup(name);
595 if(!tmpname) return 0;
596 for(p = tmpname ; *p; p++) {
603 } else tmpname = NULL;
605 tmpval = BUF_strdup(value);
606 if(!tmpval) return 0;
607 } else tmpval = NULL;
608 /* Parameter values are case sensitive so leave as is */
609 mparam = (MIME_PARAM *) Malloc(sizeof(MIME_PARAM));
610 if(!mparam) return 0;
611 mparam->param_name = tmpname;
612 mparam->param_value = tmpval;
613 sk_MIME_PARAM_push(mhdr->params, mparam);
617 static int mime_hdr_cmp(MIME_HEADER **a, MIME_HEADER **b)
619 return(strcmp((*a)->name, (*b)->name));
622 static int mime_param_cmp(MIME_PARAM **a, MIME_PARAM **b)
624 return(strcmp((*a)->param_name, (*b)->param_name));
627 /* Find a header with a given name (if possible) */
629 static MIME_HEADER *mime_hdr_find(STACK_OF(MIME_HEADER) *hdrs, char *name)
634 idx = sk_MIME_HEADER_find(hdrs, &htmp);
635 if(idx < 0) return NULL;
636 return sk_MIME_HEADER_value(hdrs, idx);
639 static MIME_PARAM *mime_param_find(MIME_HEADER *hdr, char *name)
643 param.param_name = name;
644 idx = sk_MIME_PARAM_find(hdr->params, ¶m);
645 if(idx < 0) return NULL;
646 return sk_MIME_PARAM_value(hdr->params, idx);
649 static void mime_hdr_free(MIME_HEADER *hdr)
651 if(hdr->name) Free(hdr->name);
652 if(hdr->value) Free(hdr->value);
653 if(hdr->params) sk_MIME_PARAM_pop_free(hdr->params, mime_param_free);
657 static void mime_param_free(MIME_PARAM *param)
659 if(param->param_name) Free(param->param_name);
660 if(param->param_value) Free(param->param_value);
664 /* Check for a multipart boundary. Returns:
669 static int mime_bound_check(char *line, int linelen, char *bound, int blen)
671 if(linelen == -1) linelen = strlen(line);
672 if(blen == -1) blen = strlen(bound);
673 /* Quickly eliminate if line length too short */
674 if(blen + 2 > linelen) return 0;
675 /* Check for part boundary */
676 if(!strncmp(line, "--", 2) && !strncmp(line + 2, bound, blen)) {
677 if(!strncmp(line + blen + 2, "--", 2)) return 2;