git.notmuchmail.org Git - notmuch/blob - mime-node.c

   1 /* notmuch - Not much of an email program, (just index and search)
   2  *
   3  * Copyright © 2009 Carl Worth
   4  * Copyright © 2009 Keith Packard
   5  *
   6  * This program 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  * This program 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 https://www.gnu.org/licenses/ .
  18  *
  19  * Authors: Carl Worth <cworth@cworth.org>
  20  *          Keith Packard <keithp@keithp.com>
  21  *          Austin Clements <aclements@csail.mit.edu>
  22  */
  23
  24 #include "notmuch-client.h"
  25
  26 /* Context that gets inherited from the root node. */
  27 typedef struct mime_node_context {
  28     /* Per-message resources.  These are allocated internally and must
  29      * be destroyed. */
  30     FILE *file;
  31     GMimeStream *stream;
  32     GMimeParser *parser;
  33     GMimeMessage *mime_message;
  34
  35     /* Context provided by the caller. */
  36     notmuch_crypto_t *crypto;
  37 } mime_node_context_t;
  38
  39 static int
  40 _mime_node_context_free (mime_node_context_t *res)
  41 {
  42     if (res->mime_message)
  43         g_object_unref (res->mime_message);
  44
  45     if (res->parser)
  46         g_object_unref (res->parser);
  47
  48     if (res->stream)
  49         g_object_unref (res->stream);
  50
  51     if (res->file)
  52         fclose (res->file);
  53
  54     return 0;
  55 }
  56
  57 notmuch_status_t
  58 mime_node_open (const void *ctx, notmuch_message_t *message,
  59                 notmuch_crypto_t *crypto, mime_node_t **root_out)
  60 {
  61     const char *filename = notmuch_message_get_filename (message);
  62     mime_node_context_t *mctx;
  63     mime_node_t *root;
  64     notmuch_status_t status;
  65
  66     root = talloc_zero (ctx, mime_node_t);
  67     if (root == NULL) {
  68         fprintf (stderr, "Out of memory.\n");
  69         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
  70         goto DONE;
  71     }
  72
  73     /* Create the tree-wide context */
  74     mctx = talloc_zero (root, mime_node_context_t);
  75     if (mctx == NULL) {
  76         fprintf (stderr, "Out of memory.\n");
  77         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
  78         goto DONE;
  79     }
  80     talloc_set_destructor (mctx, _mime_node_context_free);
  81
  82     mctx->file = fopen (filename, "r");
  83     if (! mctx->file) {
  84         fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
  85         status = NOTMUCH_STATUS_FILE_ERROR;
  86         goto DONE;
  87     }
  88
  89     mctx->stream = g_mime_stream_file_new (mctx->file);
  90     if (!mctx->stream) {
  91         fprintf (stderr, "Out of memory.\n");
  92         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
  93         goto DONE;
  94     }
  95     g_mime_stream_file_set_owner (GMIME_STREAM_FILE (mctx->stream), FALSE);
  96
  97     mctx->parser = g_mime_parser_new_with_stream (mctx->stream);
  98     if (!mctx->parser) {
  99         fprintf (stderr, "Out of memory.\n");
 100         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
 101         goto DONE;
 102     }
 103
 104     mctx->mime_message = g_mime_parser_construct_message (mctx->parser);
 105     if (!mctx->mime_message) {
 106         fprintf (stderr, "Failed to parse %s\n", filename);
 107         status = NOTMUCH_STATUS_FILE_ERROR;
 108         goto DONE;
 109     }
 110
 111     mctx->crypto = crypto;
 112
 113     /* Create the root node */
 114     root->part = GMIME_OBJECT (mctx->mime_message);
 115     root->envelope_file = message;
 116     root->nchildren = 1;
 117     root->ctx = mctx;
 118
 119     root->parent = NULL;
 120     root->part_num = 0;
 121     root->next_child = 0;
 122     root->next_part_num = 1;
 123
 124     *root_out = root;
 125     return NOTMUCH_STATUS_SUCCESS;
 126
 127 DONE:
 128     talloc_free (root);
 129     return status;
 130 }
 131
 132 /* Signature list destructor (GMime 2.6) */
 133 static int
 134 _signature_list_free (GMimeSignatureList **proxy)
 135 {
 136     g_object_unref (*proxy);
 137     return 0;
 138 }
 139
 140 /* Set up signature list destructor (GMime 2.6) */
 141 static void
 142 set_signature_list_destructor (mime_node_t *node)
 143 {
 144     GMimeSignatureList **proxy = talloc (node, GMimeSignatureList *);
 145     if (proxy) {
 146         *proxy = node->sig_list;
 147         talloc_set_destructor (proxy, _signature_list_free);
 148     }
 149 }
 150
 151 /* Verify a signed mime node (GMime 2.6) */
 152 static void
 153 node_verify (mime_node_t *node, GMimeObject *part,
 154              notmuch_crypto_context_t *cryptoctx)
 155 {
 156     GError *err = NULL;
 157
 158     node->verify_attempted = TRUE;
 159     node->sig_list = g_mime_multipart_signed_verify
 160         (GMIME_MULTIPART_SIGNED (part), cryptoctx, &err);
 161
 162     if (node->sig_list)
 163         set_signature_list_destructor (node);
 164     else
 165         fprintf (stderr, "Failed to verify signed part: %s\n",
 166                  err ? err->message : "no error explanation given");
 167
 168     if (err)
 169         g_error_free (err);
 170 }
 171
 172 /* Decrypt and optionally verify an encrypted mime node (GMime 2.6) */
 173 static void
 174 node_decrypt_and_verify (mime_node_t *node, GMimeObject *part,
 175                          notmuch_crypto_context_t *cryptoctx)
 176 {
 177     GError *err = NULL;
 178     GMimeDecryptResult *decrypt_result = NULL;
 179     GMimeMultipartEncrypted *encrypteddata = GMIME_MULTIPART_ENCRYPTED (part);
 180
 181     node->decrypt_attempted = TRUE;
 182     node->decrypted_child = g_mime_multipart_encrypted_decrypt
 183         (encrypteddata, cryptoctx, &decrypt_result, &err);
 184     if (! node->decrypted_child) {
 185         fprintf (stderr, "Failed to decrypt part: %s\n",
 186                  err ? err->message : "no error explanation given");
 187         goto DONE;
 188     }
 189
 190     node->decrypt_success = TRUE;
 191     node->verify_attempted = TRUE;
 192
 193     /* This may be NULL if the part is not signed. */
 194     node->sig_list = g_mime_decrypt_result_get_signatures (decrypt_result);
 195     if (node->sig_list) {
 196         g_object_ref (node->sig_list);
 197         set_signature_list_destructor (node);
 198     }
 199     g_object_unref (decrypt_result);
 200
 201  DONE:
 202     if (err)
 203         g_error_free (err);
 204 }
 205
 206 static mime_node_t *
 207 _mime_node_create (mime_node_t *parent, GMimeObject *part)
 208 {
 209     mime_node_t *node = talloc_zero (parent, mime_node_t);
 210     notmuch_crypto_context_t *cryptoctx = NULL;
 211
 212     /* Set basic node properties */
 213     node->part = part;
 214     node->ctx = parent->ctx;
 215     if (!talloc_reference (node, node->ctx)) {
 216         fprintf (stderr, "Out of memory.\n");
 217         talloc_free (node);
 218         return NULL;
 219     }
 220     node->parent = parent;
 221     node->part_num = node->next_part_num = -1;
 222     node->next_child = 0;
 223
 224     /* Deal with the different types of parts */
 225     if (GMIME_IS_PART (part)) {
 226         node->nchildren = 0;
 227     } else if (GMIME_IS_MULTIPART (part)) {
 228         node->nchildren = g_mime_multipart_get_count (GMIME_MULTIPART (part));
 229     } else if (GMIME_IS_MESSAGE_PART (part)) {
 230         /* Promote part to an envelope and open it */
 231         GMimeMessagePart *message_part = GMIME_MESSAGE_PART (part);
 232         GMimeMessage *message = g_mime_message_part_get_message (message_part);
 233         node->envelope_part = message_part;
 234         node->part = GMIME_OBJECT (message);
 235         node->nchildren = 1;
 236     } else {
 237         fprintf (stderr, "Warning: Unknown mime part type: %s.\n",
 238                  g_type_name (G_OBJECT_TYPE (part)));
 239         talloc_free (node);
 240         return NULL;
 241     }
 242
 243     if ((GMIME_IS_MULTIPART_ENCRYPTED (part) && node->ctx->crypto->decrypt)
 244         || (GMIME_IS_MULTIPART_SIGNED (part) && node->ctx->crypto->verify)) {
 245         GMimeContentType *content_type = g_mime_object_get_content_type (part);
 246         const char *protocol = g_mime_content_type_get_parameter (content_type, "protocol");
 247         cryptoctx = notmuch_crypto_get_context (node->ctx->crypto, protocol);
 248     }
 249
 250     /* Handle PGP/MIME parts */
 251     if (GMIME_IS_MULTIPART_ENCRYPTED (part) && node->ctx->crypto->decrypt && cryptoctx) {
 252         if (node->nchildren != 2) {
 253             /* this violates RFC 3156 section 4, so we won't bother with it. */
 254             fprintf (stderr, "Error: %d part(s) for a multipart/encrypted "
 255                      "message (must be exactly 2)\n",
 256                      node->nchildren);
 257         } else {
 258             node_decrypt_and_verify (node, part, cryptoctx);
 259         }
 260     } else if (GMIME_IS_MULTIPART_SIGNED (part) && node->ctx->crypto->verify && cryptoctx) {
 261         if (node->nchildren != 2) {
 262             /* this violates RFC 3156 section 5, so we won't bother with it. */
 263             fprintf (stderr, "Error: %d part(s) for a multipart/signed message "
 264                      "(must be exactly 2)\n",
 265                      node->nchildren);
 266         } else {
 267             node_verify (node, part, cryptoctx);
 268         }
 269     }
 270
 271     return node;
 272 }
 273
 274 mime_node_t *
 275 mime_node_child (mime_node_t *parent, int child)
 276 {
 277     GMimeObject *sub;
 278     mime_node_t *node;
 279
 280     if (!parent || !parent->part || child < 0 || child >= parent->nchildren)
 281         return NULL;
 282
 283     if (GMIME_IS_MULTIPART (parent->part)) {
 284         if (child == 1 && parent->decrypted_child)
 285             sub = parent->decrypted_child;
 286         else
 287             sub = g_mime_multipart_get_part
 288                 (GMIME_MULTIPART (parent->part), child);
 289     } else if (GMIME_IS_MESSAGE (parent->part)) {
 290         sub = g_mime_message_get_mime_part (GMIME_MESSAGE (parent->part));
 291     } else {
 292         /* This should have been caught by message_part_create */
 293         INTERNAL_ERROR ("Unexpected GMimeObject type: %s",
 294                         g_type_name (G_OBJECT_TYPE (parent->part)));
 295     }
 296     node = _mime_node_create (parent, sub);
 297
 298     if (child == parent->next_child && parent->next_part_num != -1) {
 299         /* We're traversing in depth-first order.  Record the child's
 300          * depth-first numbering. */
 301         node->part_num = parent->next_part_num;
 302         node->next_part_num = node->part_num + 1;
 303
 304         /* Prepare the parent for its next depth-first child. */
 305         parent->next_child++;
 306         parent->next_part_num = -1;
 307
 308         if (node->nchildren == 0) {
 309             /* We've reached a leaf, so find the parent that has more
 310              * children and set it up to number its next child. */
 311             mime_node_t *iter = node->parent;
 312             while (iter && iter->next_child == iter->nchildren)
 313                 iter = iter->parent;
 314             if (iter)
 315                 iter->next_part_num = node->part_num + 1;
 316         }
 317     }
 318
 319     return node;
 320 }
 321
 322 static mime_node_t *
 323 _mime_node_seek_dfs_walk (mime_node_t *node, int *n)
 324 {
 325     mime_node_t *ret = NULL;
 326     int i;
 327
 328     if (*n == 0)
 329         return node;
 330
 331     *n -= 1;
 332     for (i = 0; i < node->nchildren && !ret; i++) {
 333         mime_node_t *child = mime_node_child (node, i);
 334         ret = _mime_node_seek_dfs_walk (child, n);
 335         if (!ret)
 336             talloc_free (child);
 337     }
 338     return ret;
 339 }
 340
 341 mime_node_t *
 342 mime_node_seek_dfs (mime_node_t *node, int n)
 343 {
 344     if (n < 0)
 345         return NULL;
 346     return _mime_node_seek_dfs_walk (node, &n);
 347 }