99185cfefd5ffe9e4ba5f7f0a6513dbc0e40ad3c
[gnupg.git] / tools / mime-maker.c
1 /* mime-maker.c - Create MIME structures
2  * Copyright (C) 2016 g10 Code GmbH
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24
25 #include "util.h"
26 #include "zb32.h"
27 #include "mime-maker.h"
28
29
30 /* All valid characters in a header name.  */
31 #define HEADER_NAME_CHARS  ("abcdefghijklmnopqrstuvwxyz" \
32                             "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
33                             "-01234567890")
34
35 /* An object to store an header.  Also used for a list of headers.  */
36 struct header_s
37 {
38   struct header_s *next;
39   char *value;   /* Malloced value.  */
40   char name[1]; /* Name.  */
41 };
42 typedef struct header_s *header_t;
43
44
45 /* An object to store a MIME part.  A part is the header plus the
46  * content (body). */
47 struct part_s
48 {
49   struct part_s *next;  /* Next part in the current container.  */
50   struct part_s *child; /* Child container.  */
51   char *boundary;       /* Malloced boundary string.  */
52   header_t headers;     /* List of headers.  */
53   header_t *headers_tail;/* Address of last header in chain.  */
54   size_t bodylen;       /* Length of BODY.   */
55   char *body;           /* Malloced buffer with the body.  This is the
56                          * non-encoded value.  */
57   unsigned int partid;   /* The part ID.  */
58 };
59 typedef struct part_s *part_t;
60
61
62
63 /* Definition of the mime parser object.  */
64 struct mime_maker_context_s
65 {
66   void *cookie;                /* Cookie passed to all callbacks.  */
67
68   unsigned int verbose:1;      /* Enable verbose mode.  */
69   unsigned int debug:1;        /* Enable debug mode.  */
70
71   part_t mail;                 /* The MIME tree.  */
72   part_t current_part;
73
74   unsigned int partid_counter; /* Counter assign part ids.  */
75
76   int boundary_counter;  /* Used to create easy to read boundaries.  */
77   char *boundary_suffix; /* Random string used in the boundaries.  */
78
79   struct b64state *b64state;     /* NULL or malloced Base64 decoder state.  */
80
81   /* Helper to convey the output stream to recursive functions. */
82   estream_t outfp;
83 };
84
85
86 /* Create a new mime make object.  COOKIE is a values woich will be
87  * used as first argument for all callbacks registered with this
88  * object.  */
89 gpg_error_t
90 mime_maker_new (mime_maker_t *r_maker, void *cookie)
91 {
92   mime_maker_t ctx;
93
94   *r_maker = NULL;
95
96   ctx = xtrycalloc (1, sizeof *ctx);
97   if (!ctx)
98     return gpg_error_from_syserror ();
99   ctx->cookie = cookie;
100
101   *r_maker = ctx;
102   return 0;
103 }
104
105
106 static void
107 release_parts (part_t part)
108 {
109   while (part)
110     {
111       part_t partnext = part->next;
112       while (part->headers)
113         {
114           header_t hdrnext = part->headers->next;
115           xfree (part->headers);
116           part->headers = hdrnext;
117         }
118       release_parts (part->child);
119       xfree (part->boundary);
120       xfree (part->body);
121       xfree (part);
122       part = partnext;
123     }
124 }
125
126
127 /* Release a mime maker object.  */
128 void
129 mime_maker_release (mime_maker_t ctx)
130 {
131   if (!ctx)
132     return;
133
134   release_parts (ctx->mail);
135   xfree (ctx->boundary_suffix);
136   xfree (ctx);
137 }
138
139
140 /* Set verbose and debug mode.  */
141 void
142 mime_maker_set_verbose (mime_maker_t ctx, int level)
143 {
144   if (!level)
145     {
146       ctx->verbose = 0;
147       ctx->debug = 0;
148     }
149   else
150     {
151       ctx->verbose = 1;
152       if (level > 10)
153         ctx->debug = 1;
154     }
155 }
156
157
158 static void
159 dump_parts (part_t part, int level)
160 {
161   header_t hdr;
162
163   for (; part; part = part->next)
164     {
165       log_debug ("%*s[part %u]\n", level*2, "", part->partid);
166       for (hdr = part->headers; hdr; hdr = hdr->next)
167         {
168           log_debug ("%*s%s: %s\n", level*2, "", hdr->name, hdr->value);
169         }
170       if (part->body)
171         log_debug ("%*s[body %zu bytes]\n", level*2, "", part->bodylen);
172       if (part->child)
173         {
174           log_debug ("%*s[container]\n", level*2, "");
175           dump_parts (part->child, level+1);
176         }
177     }
178 }
179
180
181 /* Dump the mime tree for debugging.  */
182 void
183 mime_maker_dump_tree (mime_maker_t ctx)
184 {
185   dump_parts (ctx->mail, 0);
186 }
187
188
189 /* Find the parent node for NEEDLE starting at ROOT.  */
190 static part_t
191 find_parent (part_t root, part_t needle)
192 {
193   part_t node, n;
194
195   for (node = root->child; node; node = node->next)
196     {
197       if (node == needle)
198         return root;
199       if ((n = find_parent (node, needle)))
200         return n;
201     }
202   return NULL;
203 }
204
205
206 /* Create a boundary string.  Outr codes is aware of the general
207  * structure of that string (gebins with "=-=") so that
208  * it can protect against accidentally-used boundaries within the
209  * content.   */
210 static char *
211 generate_boundary (mime_maker_t ctx)
212 {
213   if (!ctx->boundary_suffix)
214     {
215       char buffer[12];
216
217       gcry_create_nonce (buffer, sizeof buffer);
218       ctx->boundary_suffix = zb32_encode (buffer, 8 * sizeof buffer);
219       if (!ctx->boundary_suffix)
220         return NULL;
221     }
222
223   ctx->boundary_counter++;
224   return es_bsprintf ("=-=%02d-%s=-=",
225                       ctx->boundary_counter, ctx->boundary_suffix);
226 }
227
228
229 /* Ensure that the context has a MAIL and CURRENT_PART object and
230  * return the parent object if available  */
231 static gpg_error_t
232 ensure_part (mime_maker_t ctx, part_t *r_parent)
233 {
234   if (!ctx->mail)
235     {
236       ctx->mail = xtrycalloc (1, sizeof *ctx->mail);
237       if (!ctx->mail)
238         return gpg_error_from_syserror ();
239       log_assert (!ctx->current_part);
240       ctx->current_part = ctx->mail;
241       ctx->current_part->headers_tail = &ctx->current_part->headers;
242     }
243   log_assert (ctx->current_part);
244   if (r_parent)
245     *r_parent = find_parent (ctx->mail, ctx->current_part);
246
247   return 0;
248 }
249
250
251 /* Transform a header name into a standard capitalized format.
252  * "Content-Type".  Conversion stops at the colon. */
253 static void
254 capitalize_header_name (char *name)
255 {
256   unsigned char *p = name;
257   int first = 1;
258
259   /* Special cases first.  */
260   if (!ascii_strcasecmp (name, "MIME-Version"))
261     {
262       strcpy (name, "MIME-Version");
263       return;
264     }
265
266   /* Regular cases.  */
267   for (; *p && *p != ':'; p++)
268     {
269       if (*p == '-')
270         first = 1;
271       else if (first)
272         {
273           if (*p >= 'a' && *p <= 'z')
274             *p = *p - 'a' + 'A';
275           first = 0;
276         }
277       else if (*p >= 'A' && *p <= 'Z')
278         *p = *p - 'A' + 'a';
279     }
280 }
281
282
283 /* Check whether a header with NAME has already been set into PART.
284  * NAME must be in canonical capitalized format.  Return true or
285  * false. */
286 static int
287 have_header (part_t part, const char *name)
288 {
289   header_t hdr;
290
291   for (hdr = part->headers; hdr; hdr = hdr->next)
292     if (!strcmp (hdr->name, name))
293       return 1;
294   return 0;
295 }
296
297
298 /* Helper to add a header to a part.  */
299 static gpg_error_t
300 add_header (part_t part, const char *name, const char *value)
301 {
302   gpg_error_t err;
303   header_t hdr;
304   size_t namelen;
305   const char *s;
306   char *p;
307
308   if (!value)
309     {
310       s = strchr (name, '=');
311       if (!s)
312         return gpg_error (GPG_ERR_INV_ARG);
313       namelen = s - name;
314       value = s+1;
315     }
316   else
317     namelen = strlen (name);
318
319   hdr = xtrymalloc (sizeof *hdr + namelen);
320   if (!hdr)
321     return gpg_error_from_syserror ();
322   hdr->next = NULL;
323   memcpy (hdr->name, name, namelen);
324   hdr->name[namelen] = 0;
325
326   /* Check that the header name is valid.  We allow all lower and
327    * uppercase letters and, except for the first character, digits and
328    * the dash.  */
329   if (strspn (hdr->name, HEADER_NAME_CHARS) != namelen
330       || strchr ("-0123456789", *hdr->name))
331     {
332       xfree (hdr);
333       return gpg_error (GPG_ERR_INV_NAME);
334     }
335
336   capitalize_header_name (hdr->name);
337   hdr->value = xtrystrdup (value);
338   if (!hdr->value)
339     {
340       err = gpg_error_from_syserror ();
341       xfree (hdr);
342       return err;
343     }
344
345   for (p = hdr->value + strlen (hdr->value) - 1;
346        (p >= hdr->value
347         && (*p == ' ' || *p == '\t' || *p == '\n' || *p == '\r'));
348        p--)
349     *p = 0;
350   if (!(p >= hdr->value))
351     {
352       xfree (hdr->value);
353       xfree (hdr);
354       return gpg_error (GPG_ERR_INV_VALUE);  /* Only spaces.  */
355     }
356
357   if (part)
358     {
359       *part->headers_tail = hdr;
360       part->headers_tail = &hdr->next;
361     }
362   else
363     xfree (hdr);
364
365   return 0;
366 }
367
368
369 /* Add a header with NAME and VALUE to the current mail.  A LF in the
370  * VALUE will be handled automagically.  If NULL is used for VALUE it
371  * is expected that the NAME has the format "NAME=VALUE" and VALUE is
372  * taken from there.
373  *
374  * If no container has been added, the header will be used for the
375  * regular mail headers and not for a MIME part.  If the current part
376  * is in a container and a body has been added, we append a new part
377  * to the current container.  Thus for a non-MIME mail the caller
378  * needs to call this function followed by a call to add a body.  When
379  * adding a Content-Type the boundary parameter must not be included.
380  */
381 gpg_error_t
382 mime_maker_add_header (mime_maker_t ctx, const char *name, const char *value)
383 {
384   gpg_error_t err;
385   part_t part, parent;
386
387   /* Hack to use this function for a syntax check of NAME and VALUE.  */
388   if (!ctx)
389     return add_header (NULL, name, value);
390
391   err = ensure_part (ctx, &parent);
392   if (err)
393     return err;
394   part = ctx->current_part;
395
396   if ((part->body || part->child) && !parent)
397     {
398       /* We already have a body but no parent.  Adding another part is
399        * thus not possible.  */
400       return gpg_error (GPG_ERR_CONFLICT);
401     }
402   if (part->body || part->child)
403     {
404       /* We already have a body and there is a parent.  We now append
405        * a new part to the current container.  */
406       part = xtrycalloc (1, sizeof *part);
407       if (!part)
408         return gpg_error_from_syserror ();
409       part->partid = ++ctx->partid_counter;
410       part->headers_tail = &part->headers;
411       log_assert (!ctx->current_part->next);
412       ctx->current_part->next = part;
413       ctx->current_part = part;
414     }
415
416   /* If no NAME and no VALUE has been given we do not add a header.
417    * This can be used to create a new part without any header.  */
418   if (!name && !value)
419     return 0;
420
421   /* If we add Content-Type, make sure that we have a MIME-version
422    * header first; this simply looks better.  */
423   if (!ascii_strcasecmp (name, "Content-Type")
424       && !have_header (ctx->mail, "MIME-Version"))
425     {
426       err = add_header (ctx->mail, "MIME-Version", "1.0");
427       if (err)
428         return err;
429     }
430   return add_header (part, name, value);
431 }
432
433
434 /* Helper for mime_maker_add_{body,stream}.  */
435 static gpg_error_t
436 add_body (mime_maker_t ctx, const void *data, size_t datalen)
437 {
438   gpg_error_t err;
439   part_t part, parent;
440
441   err = ensure_part (ctx, &parent);
442   if (err)
443     return err;
444   part = ctx->current_part;
445   if (part->body)
446     return gpg_error (GPG_ERR_CONFLICT);
447
448   part->body = xtrymalloc (datalen? datalen : 1);
449   if (!part->body)
450     return gpg_error_from_syserror ();
451   part->bodylen = datalen;
452   if (data)
453     memcpy (part->body, data, datalen);
454
455   return 0;
456 }
457
458
459 /* Add STRING as body to the mail or the current MIME container.  A
460  * second call to this function is not allowed.
461  *
462  * FIXME: We may want to have an append_body to add more data to a body.
463  */
464 gpg_error_t
465 mime_maker_add_body (mime_maker_t ctx, const char *string)
466 {
467   return add_body (ctx, string, strlen (string));
468 }
469
470
471 /* This is the same as mime_maker_add_body but takes a stream as
472  * argument.  As of now the stream is copied to the MIME object but
473  * eventually we may delay that and read the stream only at the time
474  * it is needed.  Note that the address of the stream object must be
475  * passed and that the ownership of the stream is transferred to this
476  * MIME object.  To indicate the latter the function will store NULL
477  * at the ADDR_STREAM so that a caller can't use that object anymore
478  * except for es_fclose which accepts a NULL pointer.  */
479 gpg_error_t
480 mime_maker_add_stream (mime_maker_t ctx, estream_t *stream_addr)
481 {
482   void *data;
483   size_t datalen;
484
485   es_rewind (*stream_addr);
486   if (es_fclose_snatch (*stream_addr, &data, &datalen))
487     return gpg_error_from_syserror ();
488   *stream_addr = NULL;
489   return add_body (ctx, data, datalen);
490 }
491
492
493 /* Add a new MIME container.  A container can be used instead of a
494  * body.  */
495 gpg_error_t
496 mime_maker_add_container (mime_maker_t ctx)
497 {
498   gpg_error_t err;
499   part_t part;
500
501   err = ensure_part (ctx, NULL);
502   if (err)
503     return err;
504   part = ctx->current_part;
505
506   if (part->body)
507     return gpg_error (GPG_ERR_CONFLICT); /* There is already a body. */
508   if (part->child || part->boundary)
509     return gpg_error (GPG_ERR_CONFLICT); /* There is already a container. */
510
511   /* Create a child node.  */
512   part->child = xtrycalloc (1, sizeof *part->child);
513   if (!part->child)
514     return gpg_error_from_syserror ();
515   part->child->headers_tail = &part->child->headers;
516
517   part->boundary = generate_boundary (ctx);
518   if (!part->boundary)
519     {
520       err = gpg_error_from_syserror ();
521       xfree (part->child);
522       part->child = NULL;
523       return err;
524     }
525
526   part = part->child;
527   part->partid = ++ctx->partid_counter;
528   ctx->current_part = part;
529
530   return 0;
531 }
532
533
534 /* Finish the current container.  */
535 gpg_error_t
536 mime_maker_end_container (mime_maker_t ctx)
537 {
538   gpg_error_t err;
539   part_t parent;
540
541   err = ensure_part (ctx, &parent);
542   if (err)
543     return err;
544   if (!parent)
545     return gpg_error (GPG_ERR_CONFLICT); /* No container.  */
546   while (parent->next)
547     parent = parent->next;
548   ctx->current_part = parent;
549   return 0;
550 }
551
552
553 /* Return the part-ID of the current part. */
554 unsigned int
555 mime_maker_get_partid (mime_maker_t ctx)
556 {
557   if (ensure_part (ctx, NULL))
558     return 0; /* Ooops.  */
559   return ctx->current_part->partid;
560 }
561
562
563 /* Write a header and handle emdedded LFs.  If BOUNDARY is not NULL it
564  * is appended to the value.  */
565 /* Fixme: Add automatic line wrapping.  */
566 static gpg_error_t
567 write_header (mime_maker_t ctx, const char *name, const char *value,
568               const char *boundary)
569 {
570   const char *s;
571
572   es_fprintf (ctx->outfp, "%s: ", name);
573
574   /* Note that add_header made sure that VALUE does not end with a LF.
575    * Thus we can assume that a LF is followed by non-whitespace.  */
576   for (s = value; *s; s++)
577     {
578       if (*s == '\n')
579         es_fputs ("\r\n\t", ctx->outfp);
580       else
581         es_fputc (*s, ctx->outfp);
582     }
583   if (boundary)
584     {
585       if (s > value && s[-1] != ';')
586         es_fputc (';', ctx->outfp);
587       es_fprintf (ctx->outfp, "\r\n\tboundary=\"%s\"", boundary);
588     }
589
590   es_fputs ("\r\n", ctx->outfp);
591
592   return es_ferror (ctx->outfp)? gpg_error_from_syserror () : 0;
593 }
594
595
596 static gpg_error_t
597 write_gap (mime_maker_t ctx)
598 {
599   es_fputs ("\r\n", ctx->outfp);
600   return es_ferror (ctx->outfp)? gpg_error_from_syserror () : 0;
601 }
602
603
604 static gpg_error_t
605 write_boundary (mime_maker_t ctx, const char *boundary, int last)
606 {
607   es_fprintf (ctx->outfp, "\r\n--%s%s\r\n", boundary, last?"--":"");
608   return es_ferror (ctx->outfp)? gpg_error_from_syserror () : 0;
609 }
610
611
612 /* Fixme: Apply required encoding.  */
613 static gpg_error_t
614 write_body (mime_maker_t ctx, const void *body, size_t bodylen)
615 {
616   const char *s;
617
618   for (s = body; bodylen; s++, bodylen--)
619     {
620       if (*s == '\n' && !(s > (const char *)body && s[-1] == '\r'))
621         es_fputc ('\r', ctx->outfp);
622       es_fputc (*s, ctx->outfp);
623     }
624
625   return es_ferror (ctx->outfp)? gpg_error_from_syserror () : 0;
626 }
627
628
629 /* Recursive worker for mime_maker_make.  */
630 static gpg_error_t
631 write_tree (mime_maker_t ctx, part_t parent, part_t part)
632 {
633   gpg_error_t err;
634   header_t hdr;
635
636   for (; part; part = part->next)
637     {
638       for (hdr = part->headers; hdr; hdr = hdr->next)
639         {
640           if (part->child && !strcmp (hdr->name, "Content-Type"))
641             err = write_header (ctx, hdr->name, hdr->value, part->boundary);
642           else
643             err = write_header (ctx, hdr->name, hdr->value, NULL);
644           if (err)
645             return err;
646         }
647       err = write_gap (ctx);
648       if (err)
649         return err;
650       if (part->body)
651         {
652           err = write_body (ctx, part->body, part->bodylen);
653           if (err)
654             return err;
655         }
656       if (part->child)
657         {
658           log_assert (part->boundary);
659           err = write_boundary (ctx, part->boundary, 0);
660           if (!err)
661             err = write_tree (ctx, part, part->child);
662           if (!err)
663             err = write_boundary (ctx, part->boundary, 1);
664           if (err)
665             return err;
666         }
667
668       if (part->next)
669         {
670           log_assert (parent && parent->boundary);
671           err = write_boundary (ctx, parent->boundary, 0);
672           if (err)
673             return err;
674         }
675     }
676   return 0;
677 }
678
679
680 /* Add headers we always require.  */
681 static gpg_error_t
682 add_missing_headers (mime_maker_t ctx)
683 {
684   gpg_error_t err;
685
686   if (!ctx->mail)
687     return gpg_error (GPG_ERR_NO_DATA);
688   if (!have_header (ctx->mail, "MIME-Version"))
689     {
690       /* Even if a Content-Type has never been set, we want to
691        * announce that we do MIME.  */
692       err = add_header (ctx->mail, "MIME-Version", "1.0");
693       if (err)
694         goto leave;
695     }
696
697   if (!have_header (ctx->mail, "Date"))
698     {
699       char *p = rfctimestamp (make_timestamp ());
700       if (!p)
701         err = gpg_error_from_syserror ();
702       else
703         err = add_header (ctx->mail, "Date", p);
704       xfree (p);
705       if (err)
706         goto leave;
707     }
708
709
710  leave:
711   return err;
712 }
713
714
715 /* Create message from the tree MIME and write it to FP.  Note that
716  * the output uses only a LF and a later called sendmail(1) is
717  * expected to convert them to network line endings.  */
718 gpg_error_t
719 mime_maker_make (mime_maker_t ctx, estream_t fp)
720 {
721   gpg_error_t err;
722
723   err = add_missing_headers (ctx);
724   if (err)
725     return err;
726
727   ctx->outfp = fp;
728   err = write_tree (ctx, NULL, ctx->mail);
729
730   ctx->outfp = NULL;
731   return err;
732 }