Make sure the packet length isn't > WTAP_MAX_PACKET_SIZE.
[metze/wireshark/wip.git] / wiretap / mime_file.c
1 /* mime_file.c
2  *
3  * MIME file format decoder for the Wiretap library.
4  *
5  * This is for use with Wireshark dissectors that handle file
6  * formats (e.g., because they handle a particular MIME media type).
7  * It breaks the file into chunks of at most WTAP_MAX_PACKET_SIZE,
8  * each of which is reported as a packet, so that files larger than
9  * WTAP_MAX_PACKET_SIZE can be handled by reassembly.
10  *
11  * The "MIME file" dissector does the reassembly, and hands the result
12  * off to heuristic dissectors to try to identify the file's contents.
13  *
14  * Wiretap Library
15  * This program is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU General Public License
17  * as published by the Free Software Foundation; either version 2
18  * of the License, or (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28  */
29
30 #include "config.h"
31
32 #ifdef HAVE_SYS_TYPES_H
33 #include <sys/types.h>
34 #endif
35
36 #ifdef HAVE_UNISTD_H
37 #include <unistd.h>
38 #endif
39
40 #include <errno.h>
41 #include <stdlib.h>
42 #include <string.h>
43 #include <time.h>
44
45 #include "wtap-int.h"
46 #include "file_wrappers.h"
47 #include <wsutil/buffer.h>
48 #include "mime_file.h"
49
50 typedef struct {
51         const guint8 *magic;
52         guint magic_len;
53 } mime_files_t;
54
55 /*
56  * Written by Marton Nemeth <nm127@freemail.hu>
57  * Copyright 2009 Marton Nemeth
58  * The JPEG and JFIF specification can be found at:
59  *
60  * http://www.jpeg.org/public/jfif.pdf
61  * http://www.w3.org/Graphics/JPEG/itu-t81.pdf
62  */
63 static const guint8 jpeg_jfif_magic[] = { 0xFF, 0xD8, /* SOF */
64                                           0xFF        /* start of the next marker */
65                                         };
66
67 /* <?xml */
68 static const guint8 xml_magic[]    = { '<', '?', 'x', 'm', 'l' };
69 static const guint8 png_magic[]    = { 0x89, 'P', 'N', 'G', '\r', '\n', 0x1A, '\n' };
70 static const guint8 gif87a_magic[] = { 'G', 'I', 'F', '8', '7', 'a'};
71 static const guint8 gif89a_magic[] = { 'G', 'I', 'F', '8', '9', 'a'};
72 static const guint8 elf_magic[]    = { 0x7F, 'E', 'L', 'F'};
73 static const guint8 btsnoop_magic[]    = { 'b', 't', 's', 'n', 'o', 'o', 'p', 0};
74 static const guint8 pcap_magic[]           = { 0xA1, 0xB2, 0xC3, 0xD4 };
75 static const guint8 pcap_swapped_magic[]   = { 0xD4, 0xC3, 0xB2, 0xA1 };
76 static const guint8 pcapng_premagic[]      = { 0x0A, 0x0D, 0x0D, 0x0A };
77
78 /* File does not start with it */
79 static const guint8 pcapng_xmagic[]         = { 0x1A, 0x2B, 0x3C, 0x4D };
80 static const guint8 pcapng_swapped_xmagic[] = { 0x4D, 0x3C, 0x2B, 0x1A };
81
82 static const mime_files_t magic_files[] = {
83         { jpeg_jfif_magic, sizeof(jpeg_jfif_magic) },
84         { xml_magic, sizeof(xml_magic) },
85         { png_magic, sizeof(png_magic) },
86         { gif87a_magic, sizeof(gif87a_magic) },
87         { gif89a_magic, sizeof(gif89a_magic) },
88         { elf_magic, sizeof(elf_magic) },
89         { btsnoop_magic, sizeof(btsnoop_magic) },
90         { pcap_magic, sizeof(pcap_magic) },
91         { pcap_swapped_magic, sizeof(pcap_swapped_magic) },
92         { pcapng_premagic, sizeof(pcapng_premagic) }
93 };
94
95 #define N_MAGIC_TYPES   (sizeof(magic_files) / sizeof(magic_files[0]))
96
97 /*
98  * Impose a not-too-large limit on the maximum file size, to avoid eating
99  * up 99% of the (address space, swap partition, disk space for swap/page
100  * files); if we were to return smaller chunks and let the dissector do
101  * reassembly, it would *still* have to allocate a buffer the size of
102  * the file, so it's not as if we'd neve try to allocate a buffer the
103  * size of the file.
104  */
105 #define MAX_FILE_SIZE   G_MAXINT
106
107 static gboolean
108 mime_read_file(wtap *wth, FILE_T fh, struct wtap_pkthdr *phdr,
109     Buffer *buf, int *err, gchar **err_info)
110 {
111         gint64 file_size;
112         int packet_size;
113
114         if ((file_size = wtap_file_size(wth, err)) == -1)
115                 return FALSE;
116
117         if (file_size > MAX_FILE_SIZE) {
118                 /*
119                  * Don't blow up trying to allocate space for an
120                  * immensely-large file.
121                  */
122                 *err = WTAP_ERR_BAD_FILE;
123                 *err_info = g_strdup_printf("mime_file: File has %" G_GINT64_MODIFIER "d-byte packet, bigger than maximum of %u",
124                                 file_size, MAX_FILE_SIZE);
125                 return FALSE;
126         }
127         packet_size = (int)file_size;
128
129         phdr->rec_type = REC_TYPE_PACKET;
130         phdr->presence_flags = 0; /* yes, we have no bananas^Wtime stamp */
131
132         phdr->caplen = packet_size;
133         phdr->len = packet_size;
134
135         phdr->ts.secs = 0;
136         phdr->ts.nsecs = 0;
137
138         return wtap_read_packet_bytes(fh, buf, packet_size, err, err_info);
139 }
140
141 static gboolean
142 mime_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
143 {
144         gint64 offset;
145
146         *err = 0;
147
148         offset = file_tell(wth->fh);
149
150         /* there is only ever one packet */
151         if (offset != 0)
152                 return FALSE;
153
154         *data_offset = offset;
155
156         return mime_read_file(wth, wth->fh, &wth->phdr, wth->frame_buffer, err, err_info);
157 }
158
159 static gboolean
160 mime_seek_read(wtap *wth, gint64 seek_off, struct wtap_pkthdr *phdr, Buffer *buf, int *err, gchar **err_info)
161 {
162         /* there is only one packet */
163         if (seek_off > 0) {
164                 *err = 0;
165                 return FALSE;
166         }
167
168         if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
169                 return FALSE;
170
171         return mime_read_file(wth, wth->random_fh, phdr, buf, err, err_info);
172 }
173
174 wtap_open_return_val
175 mime_file_open(wtap *wth, int *err, gchar **err_info)
176 {
177         char magic_buf[128]; /* increase buffer size when needed */
178         int bytes_read;
179         gboolean found_file;
180         /* guint file_ok; */
181         guint i;
182
183         guint read_bytes = 12;
184
185         for (i = 0; i < N_MAGIC_TYPES; i++)
186                 read_bytes = MAX(read_bytes, magic_files[i].magic_len);
187
188         read_bytes = (guint)MIN(read_bytes, sizeof(magic_buf));
189         bytes_read = file_read(magic_buf, read_bytes, wth->fh);
190
191         if (bytes_read < 0) {
192                 *err = file_error(wth->fh, err_info);
193                 return WTAP_OPEN_ERROR;
194         }
195         if (bytes_read == 0)
196                 return WTAP_OPEN_NOT_MINE;
197
198         found_file = FALSE;
199         for (i = 0; i < N_MAGIC_TYPES; i++) {
200                 if ((guint) bytes_read >= magic_files[i].magic_len && !memcmp(magic_buf, magic_files[i].magic, MIN(magic_files[i].magic_len, (guint) bytes_read))) {
201                         if (!found_file) {
202                                 if (magic_files[i].magic == pcapng_premagic) {
203                                         if (memcmp(magic_buf + 8, pcapng_xmagic, sizeof(pcapng_xmagic)) &&
204                                                         memcmp(magic_buf + 8, pcapng_swapped_xmagic, sizeof(pcapng_swapped_xmagic)))
205                                                 continue;
206                                 }
207                                 found_file = TRUE;
208                         } else
209                                 return WTAP_OPEN_NOT_MINE;      /* many files matched, bad file */
210                 }
211         }
212
213         if (!found_file)
214                 return WTAP_OPEN_NOT_MINE;
215
216         if (file_seek(wth->fh, 0, SEEK_SET, err) == -1)
217                 return WTAP_OPEN_ERROR;
218
219         wth->file_type_subtype = WTAP_FILE_TYPE_SUBTYPE_MIME;
220         wth->file_encap = WTAP_ENCAP_MIME;
221         wth->file_tsprec = WTAP_TSPREC_SEC;
222         wth->subtype_read = mime_read;
223         wth->subtype_seek_read = mime_seek_read;
224         wth->snapshot_length = 0;
225
226         return WTAP_OPEN_MINE;
227 }
228
229 /*
230  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
231  *
232  * Local variables:
233  * c-basic-offset: 8
234  * tab-width: 8
235  * indent-tabs-mode: t
236  * End:
237  *
238  * vi: set shiftwidth=8 tabstop=8 noexpandtab:
239  * :indentSize=8:tabSize=8:noTabs=false:
240  */