2 * Copyright (c) Ian F. Darwin 1986-1995.
3 * Software written by Ian F. Darwin and others;
4 * maintained 1995-present by Christos Zoulas and others.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice immediately at the beginning of the file, without modification,
11 * this list of conditions, and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * apprentice - make one pass through /etc/magic, learning its secrets.
35 FILE_RCSID("@(#)$File: apprentice.c,v 1.297 2020/05/09 18:57:15 christos Exp $")
55 #define EATAB {while (isascii(CAST(unsigned char, *l)) && \
56 isspace(CAST(unsigned char, *l))) ++l;}
57 #define LOWCASE(l) (isupper(CAST(unsigned char, l)) ? \
58 tolower(CAST(unsigned char, l)) : (l))
60 * Work around a bug in headers on Digital Unix.
61 * At least confirmed for: OSF1 V4.0 878
63 #if defined(__osf__) && defined(__DECC)
70 #define MAP_FAILED (void *) -1
77 #define ALLOC_CHUNK CAST(size_t, 10)
78 #define ALLOC_INCR CAST(size_t, 200)
80 #define MAP_TYPE_USER 0
81 #define MAP_TYPE_MALLOC 1
82 #define MAP_TYPE_MMAP 2
90 struct magic_entry_set {
91 struct magic_entry *me;
100 struct magic *magic[MAGIC_SETS];
101 uint32_t nmagic[MAGIC_SETS];
104 int file_formats[FILE_NAMES_SIZE];
105 const size_t file_nformats = FILE_NAMES_SIZE;
106 const char *file_names[FILE_NAMES_SIZE];
107 const size_t file_nnames = FILE_NAMES_SIZE;
109 private int getvalue(struct magic_set *ms, struct magic *, const char **, int);
110 private int hextoint(int);
111 private const char *getstr(struct magic_set *, struct magic *, const char *,
113 private int parse(struct magic_set *, struct magic_entry *, const char *,
115 private void eatsize(const char **);
116 private int apprentice_1(struct magic_set *, const char *, int);
117 private size_t apprentice_magic_strength(const struct magic *);
118 private int apprentice_sort(const void *, const void *);
119 private void apprentice_list(struct mlist *, int );
120 private struct magic_map *apprentice_load(struct magic_set *,
122 private struct mlist *mlist_alloc(void);
123 private void mlist_free_all(struct magic_set *);
124 private void mlist_free(struct mlist *);
125 private void byteswap(struct magic *, uint32_t);
126 private void bs1(struct magic *);
127 private uint16_t swap2(uint16_t);
128 private uint32_t swap4(uint32_t);
129 private uint64_t swap8(uint64_t);
130 private char *mkdbname(struct magic_set *, const char *, int);
131 private struct magic_map *apprentice_buf(struct magic_set *, struct magic *,
133 private struct magic_map *apprentice_map(struct magic_set *, const char *);
134 private int check_buffer(struct magic_set *, struct magic_map *, const char *);
135 private void apprentice_unmap(struct magic_map *);
136 private int apprentice_compile(struct magic_set *, struct magic_map *,
138 private int check_format_type(const char *, int, const char **);
139 private int check_format(struct magic_set *, struct magic *);
140 private int get_op(char);
141 private int parse_mime(struct magic_set *, struct magic_entry *, const char *,
143 private int parse_strength(struct magic_set *, struct magic_entry *,
144 const char *, size_t);
145 private int parse_apple(struct magic_set *, struct magic_entry *, const char *,
147 private int parse_ext(struct magic_set *, struct magic_entry *, const char *,
151 private size_t magicsize = sizeof(struct magic);
153 private const char usg_hdr[] = "cont\toffset\ttype\topcode\tmask\tvalue\tdesc";
158 int (*fun)(struct magic_set *, struct magic_entry *, const char *,
161 #define DECLARE_FIELD(name) { # name, sizeof(# name) - 1, parse_ ## name }
163 DECLARE_FIELD(apple),
165 DECLARE_FIELD(strength),
172 int main(int, char *[]);
175 main(int argc, char *argv[])
178 struct magic_set *ms;
181 if ((progname = strrchr(argv[0], '/')) != NULL)
187 (void)fprintf(stderr, "Usage: %s file\n", progname);
191 if ((ms = magic_open(MAGIC_CHECK)) == NULL) {
192 (void)fprintf(stderr, "%s: %s\n", progname, strerror(errno));
195 ret = magic_compile(ms, argv[1]) == -1 ? 1 : 0;
197 (void)fprintf(stderr, "%s: %s\n", progname, magic_error(ms));
201 #endif /* COMPILE_ONLY */
211 * XXX - the actual Single UNIX Specification says that "long" means "long",
212 * as in the C data type, but we treat it as meaning "4-byte integer".
213 * Given that the OS X version of file 5.04 did the same, I guess that passes
214 * the actual test; having "long" be dependent on how big a "long" is on
215 * the machine running "file" is silly.
217 static const struct type_tbl_s type_tbl[] = {
218 # define XX(s) s, (sizeof(s) - 1)
219 # define XX_NULL "", 0
220 { XX("invalid"), FILE_INVALID, FILE_FMT_NONE },
221 { XX("byte"), FILE_BYTE, FILE_FMT_NUM },
222 { XX("short"), FILE_SHORT, FILE_FMT_NUM },
223 { XX("default"), FILE_DEFAULT, FILE_FMT_NONE },
224 { XX("long"), FILE_LONG, FILE_FMT_NUM },
225 { XX("string"), FILE_STRING, FILE_FMT_STR },
226 { XX("date"), FILE_DATE, FILE_FMT_STR },
227 { XX("beshort"), FILE_BESHORT, FILE_FMT_NUM },
228 { XX("belong"), FILE_BELONG, FILE_FMT_NUM },
229 { XX("bedate"), FILE_BEDATE, FILE_FMT_STR },
230 { XX("leshort"), FILE_LESHORT, FILE_FMT_NUM },
231 { XX("lelong"), FILE_LELONG, FILE_FMT_NUM },
232 { XX("ledate"), FILE_LEDATE, FILE_FMT_STR },
233 { XX("pstring"), FILE_PSTRING, FILE_FMT_STR },
234 { XX("ldate"), FILE_LDATE, FILE_FMT_STR },
235 { XX("beldate"), FILE_BELDATE, FILE_FMT_STR },
236 { XX("leldate"), FILE_LELDATE, FILE_FMT_STR },
237 { XX("regex"), FILE_REGEX, FILE_FMT_STR },
238 { XX("bestring16"), FILE_BESTRING16, FILE_FMT_STR },
239 { XX("lestring16"), FILE_LESTRING16, FILE_FMT_STR },
240 { XX("search"), FILE_SEARCH, FILE_FMT_STR },
241 { XX("medate"), FILE_MEDATE, FILE_FMT_STR },
242 { XX("meldate"), FILE_MELDATE, FILE_FMT_STR },
243 { XX("melong"), FILE_MELONG, FILE_FMT_NUM },
244 { XX("quad"), FILE_QUAD, FILE_FMT_QUAD },
245 { XX("lequad"), FILE_LEQUAD, FILE_FMT_QUAD },
246 { XX("bequad"), FILE_BEQUAD, FILE_FMT_QUAD },
247 { XX("qdate"), FILE_QDATE, FILE_FMT_STR },
248 { XX("leqdate"), FILE_LEQDATE, FILE_FMT_STR },
249 { XX("beqdate"), FILE_BEQDATE, FILE_FMT_STR },
250 { XX("qldate"), FILE_QLDATE, FILE_FMT_STR },
251 { XX("leqldate"), FILE_LEQLDATE, FILE_FMT_STR },
252 { XX("beqldate"), FILE_BEQLDATE, FILE_FMT_STR },
253 { XX("float"), FILE_FLOAT, FILE_FMT_FLOAT },
254 { XX("befloat"), FILE_BEFLOAT, FILE_FMT_FLOAT },
255 { XX("lefloat"), FILE_LEFLOAT, FILE_FMT_FLOAT },
256 { XX("double"), FILE_DOUBLE, FILE_FMT_DOUBLE },
257 { XX("bedouble"), FILE_BEDOUBLE, FILE_FMT_DOUBLE },
258 { XX("ledouble"), FILE_LEDOUBLE, FILE_FMT_DOUBLE },
259 { XX("leid3"), FILE_LEID3, FILE_FMT_NUM },
260 { XX("beid3"), FILE_BEID3, FILE_FMT_NUM },
261 { XX("indirect"), FILE_INDIRECT, FILE_FMT_NUM },
262 { XX("qwdate"), FILE_QWDATE, FILE_FMT_STR },
263 { XX("leqwdate"), FILE_LEQWDATE, FILE_FMT_STR },
264 { XX("beqwdate"), FILE_BEQWDATE, FILE_FMT_STR },
265 { XX("name"), FILE_NAME, FILE_FMT_NONE },
266 { XX("use"), FILE_USE, FILE_FMT_NONE },
267 { XX("clear"), FILE_CLEAR, FILE_FMT_NONE },
268 { XX("der"), FILE_DER, FILE_FMT_STR },
269 { XX("guid"), FILE_GUID, FILE_FMT_STR },
270 { XX("offset"), FILE_OFFSET, FILE_FMT_QUAD },
271 { XX_NULL, FILE_INVALID, FILE_FMT_NONE },
275 * These are not types, and cannot be preceded by "u" to make them
278 static const struct type_tbl_s special_tbl[] = {
279 { XX("der"), FILE_DER, FILE_FMT_STR },
280 { XX("name"), FILE_NAME, FILE_FMT_STR },
281 { XX("use"), FILE_USE, FILE_FMT_STR },
282 { XX_NULL, FILE_INVALID, FILE_FMT_NONE },
288 get_type(const struct type_tbl_s *tbl, const char *l, const char **t)
290 const struct type_tbl_s *p;
292 for (p = tbl; p->len; p++) {
293 if (strncmp(l, p->name, p->len) == 0) {
304 if (/*CONSTCOND*/sizeof(off_t) == sizeof(int))
305 return CAST(off_t, INT_MAX);
306 if (/*CONSTCOND*/sizeof(off_t) == sizeof(long))
307 return CAST(off_t, LONG_MAX);
312 get_standard_integer_type(const char *l, const char **t)
316 if (isalpha(CAST(unsigned char, l[1]))) {
329 * "dI", "dL", "uI", and "uL".
331 * XXX - the actual Single UNIX Specification says
332 * that "L" means "long", as in the C data type,
333 * but we treat it as meaning "4-byte integer".
334 * Given that the OS X version of file 5.04 did
335 * the same, I guess that passes the actual SUS
336 * validation suite; having "dL" be dependent on
337 * how big a "long" is on the machine running
347 /* "d{anything else}", "u{anything else}" */
351 } else if (isdigit(CAST(unsigned char, l[1]))) {
353 * "d{num}" and "u{num}"; we only support {num} values
354 * of 1, 2, 4, and 8 - the Single UNIX Specification
355 * doesn't say anything about whether arbitrary
356 * values should be supported, but both the Solaris 10
357 * and OS X Mountain Lion versions of file passed the
358 * Single UNIX Specification validation suite, and
359 * neither of them support values bigger than 8 or
360 * non-power-of-2 values.
362 if (isdigit(CAST(unsigned char, l[2]))) {
363 /* Multi-digit, so > 9 */
380 /* XXX - what about 3, 5, 6, or 7? */
386 * "d" or "u" by itself.
397 init_file_tables(void)
400 const struct type_tbl_s *p;
406 for (p = type_tbl; p->len; p++) {
407 assert(p->type < FILE_NAMES_SIZE);
408 file_names[p->type] = p->name;
409 file_formats[p->type] = p->format;
411 assert(p - type_tbl == FILE_NAMES_SIZE);
415 add_mlist(struct mlist *mlp, struct magic_map *map, size_t idx)
420 if ((ml = CAST(struct mlist *, malloc(sizeof(*ml)))) == NULL)
423 ml->map = idx == 0 ? map : NULL;
424 ml->magic = map->magic[idx];
425 ml->nmagic = map->nmagic[idx];
427 mlp->prev->next = ml;
428 ml->prev = mlp->prev;
435 * Handle one file or directory.
438 apprentice_1(struct magic_set *ms, const char *fn, int action)
440 struct magic_map *map;
446 if (magicsize != FILE_MAGICSIZE) {
447 file_error(ms, 0, "magic element size %lu != %lu",
448 CAST(unsigned long, sizeof(*map->magic[0])),
449 CAST(unsigned long, FILE_MAGICSIZE));
453 if (action == FILE_COMPILE) {
454 map = apprentice_load(ms, fn, action);
457 return apprentice_compile(ms, map, fn);
461 map = apprentice_map(ms, fn);
463 if (ms->flags & MAGIC_CHECK)
464 file_magwarn(ms, "using regular magic file `%s'", fn);
465 map = apprentice_load(ms, fn, action);
470 for (i = 0; i < MAGIC_SETS; i++) {
471 if (add_mlist(ms->mlist[i], map, i) == -1) {
472 /* failed to add to any list, free explicitly */
474 apprentice_unmap(map);
477 file_oomem(ms, sizeof(*ml));
482 if (action == FILE_LIST) {
483 for (i = 0; i < MAGIC_SETS; i++) {
484 printf("Set %" SIZE_T_FORMAT "u:\nBinary patterns:\n",
486 apprentice_list(ms->mlist[i], BINTEST);
487 printf("Text patterns:\n");
488 apprentice_list(ms->mlist[i], TEXTTEST);
494 #endif /* COMPILE_ONLY */
498 file_ms_free(struct magic_set *ms)
503 for (i = 0; i < MAGIC_SETS; i++)
504 mlist_free(ms->mlist[i]);
511 protected struct magic_set *
512 file_ms_alloc(int flags)
514 struct magic_set *ms;
517 if ((ms = CAST(struct magic_set *, calloc(CAST(size_t, 1u),
518 sizeof(struct magic_set)))) == NULL)
521 if (magic_setflags(ms, flags) == -1) {
526 ms->o.buf = ms->o.pbuf = NULL;
528 len = (ms->c.len = 10) * sizeof(*ms->c.li);
530 if ((ms->c.li = CAST(struct level_info *, malloc(len))) == NULL)
535 for (i = 0; i < MAGIC_SETS; i++)
537 ms->file = "unknown";
539 ms->indir_max = FILE_INDIR_MAX;
540 ms->name_max = FILE_NAME_MAX;
541 ms->elf_shnum_max = FILE_ELF_SHNUM_MAX;
542 ms->elf_phnum_max = FILE_ELF_PHNUM_MAX;
543 ms->elf_notes_max = FILE_ELF_NOTES_MAX;
544 ms->regex_max = FILE_REGEX_MAX;
545 ms->bytes_max = FILE_BYTES_MAX;
553 apprentice_unmap(struct magic_map *map)
562 case MAP_TYPE_MALLOC:
563 for (i = 0; i < MAGIC_SETS; i++) {
564 void *b = map->magic[i];
566 if (CAST(char *, b) >= CAST(char *, p) &&
567 CAST(char *, b) <= CAST(char *, p) + map->len)
575 if (map->p && map->p != MAP_FAILED)
576 (void)munmap(map->p, map->len);
585 private struct mlist *
589 if ((mlist = CAST(struct mlist *, calloc(1, sizeof(*mlist)))) == NULL) {
592 mlist->next = mlist->prev = mlist;
597 mlist_free_all(struct magic_set *ms)
601 for (i = 0; i < MAGIC_SETS; i++) {
602 mlist_free(ms->mlist[i]);
608 mlist_free_one(struct mlist *ml)
611 apprentice_unmap(CAST(struct magic_map *, ml->map));
616 mlist_free(struct mlist *mlist)
618 struct mlist *ml, *next;
623 for (ml = mlist->next; ml != mlist;) {
628 mlist_free_one(mlist);
632 /* void **bufs: an array of compiled magic files */
634 buffer_apprentice(struct magic_set *ms, struct magic **bufs,
635 size_t *sizes, size_t nbufs)
639 struct magic_map *map;
644 (void)file_reset(ms, 0);
648 for (i = 0; i < MAGIC_SETS; i++) {
649 mlist_free(ms->mlist[i]);
650 if ((ms->mlist[i] = mlist_alloc()) == NULL) {
651 file_oomem(ms, sizeof(*ms->mlist[i]));
656 for (i = 0; i < nbufs; i++) {
657 map = apprentice_buf(ms, bufs[i], sizes[i]);
661 for (j = 0; j < MAGIC_SETS; j++) {
662 if (add_mlist(ms->mlist[j], map, j) == -1) {
663 file_oomem(ms, sizeof(*ml));
676 /* const char *fn: list of magic files and directories */
678 file_apprentice(struct magic_set *ms, const char *fn, int action)
681 int fileerr, errs = -1;
684 (void)file_reset(ms, 0);
686 if ((fn = magic_getpath(fn, action)) == NULL)
691 if ((mfn = strdup(fn)) == NULL) {
692 file_oomem(ms, strlen(fn));
696 for (i = 0; i < MAGIC_SETS; i++) {
697 mlist_free(ms->mlist[i]);
698 if ((ms->mlist[i] = mlist_alloc()) == NULL) {
699 file_oomem(ms, sizeof(*ms->mlist[i]));
700 for (j = 0; j < i; j++) {
701 mlist_free(ms->mlist[j]);
711 p = strchr(fn, PATHSEP);
716 fileerr = apprentice_1(ms, fn, action);
717 errs = MAX(errs, fileerr);
724 for (i = 0; i < MAGIC_SETS; i++) {
725 mlist_free(ms->mlist[i]);
728 file_error(ms, 0, "could not find any valid magic files!");
734 * Always leave the database loaded
736 if (action == FILE_LOAD)
739 for (i = 0; i < MAGIC_SETS; i++) {
740 mlist_free(ms->mlist[i]);
752 file_error(ms, 0, "Invalid action %d", action);
758 * Compute the real length of a magic expression, for the purposes
759 * of determining how "strong" a magic expression is (approximating
760 * how specific its matches are):
761 * - magic characters count 0 unless escaped.
762 * - [] expressions count 1
763 * - {} expressions count 0
764 * - regular characters or escaped magic characters count 1
765 * - 0 length expressions count as one
768 nonmagic(const char *str)
773 for (p = str; *p; p++)
775 case '\\': /* Escaped anything counts 1 */
780 case '?': /* Magic characters count 0 */
787 case '[': /* Bracketed expressions count 1 the ']' */
788 while (*p && *p != ']')
792 case '{': /* Braced expressions count 0 */
793 while (*p && *p != '}')
798 default: /* Anything else counts 1 */
803 return rv == 0 ? 1 : rv; /* Return at least 1 */
865 * Get weight of this magic entry, for sorting purposes.
868 apprentice_magic_strength(const struct magic *m)
872 ssize_t val = 2 * MULT; /* baseline strength */
875 case FILE_DEFAULT: /* make sure this sorts last */
876 if (m->factor_op != FILE_FACTOR_OP_NONE)
916 ts = typesize(m->type);
917 if (ts == FILE_BADSIZE)
924 val += m->vallen * MULT;
927 case FILE_BESTRING16:
928 case FILE_LESTRING16:
929 val += m->vallen * MULT / 2;
935 val += m->vallen * MAX(MULT / m->vallen, 1);
939 v = nonmagic(m->value.s);
940 val += v * MAX(MULT / v, 1);
953 (void)fprintf(stderr, "Bad type %d\n", m->type);
958 case 'x': /* matches anything penalize */
959 case '!': /* matches almost anything penalize */
963 case '=': /* Exact match, prefer */
968 case '<': /* comparison match reduce strength */
973 case '&': /* masking bits, we could count them too */
978 (void)fprintf(stderr, "Bad relation %c\n", m->reln);
982 switch (m->factor_op) {
983 case FILE_FACTOR_OP_NONE:
985 case FILE_FACTOR_OP_PLUS:
988 case FILE_FACTOR_OP_MINUS:
991 case FILE_FACTOR_OP_TIMES:
994 case FILE_FACTOR_OP_DIV:
1001 if (val <= 0) /* ensure we only return 0 for FILE_DEFAULT */
1005 * Magic entries with no description get a bonus because they depend
1006 * on subsequent magic entries to print something.
1008 if (m->desc[0] == '\0')
1014 * Sort callback for sorting entries by "strength" (basically length)
1017 apprentice_sort(const void *a, const void *b)
1019 const struct magic_entry *ma = CAST(const struct magic_entry *, a);
1020 const struct magic_entry *mb = CAST(const struct magic_entry *, b);
1021 size_t sa = apprentice_magic_strength(ma->mp);
1022 size_t sb = apprentice_magic_strength(mb->mp);
1032 * Shows sorted patterns list in the order which is used for the matching
1035 apprentice_list(struct mlist *mlist, int mode)
1037 uint32_t magindex = 0;
1039 for (ml = mlist->next; ml != mlist; ml = ml->next) {
1040 for (magindex = 0; magindex < ml->nmagic; magindex++) {
1041 struct magic *m = &ml->magic[magindex];
1042 if ((m->flag & mode) != mode) {
1043 /* Skip sub-tests */
1044 while (magindex + 1 < ml->nmagic &&
1045 ml->magic[magindex + 1].cont_level != 0)
1047 continue; /* Skip to next top-level test*/
1051 * Try to iterate over the tree until we find item with
1052 * description/mimetype.
1054 while (magindex + 1 < ml->nmagic &&
1055 ml->magic[magindex + 1].cont_level != 0 &&
1056 *ml->magic[magindex].desc == '\0' &&
1057 *ml->magic[magindex].mimetype == '\0')
1060 printf("Strength = %3" SIZE_T_FORMAT "u@%u: %s [%s]\n",
1061 apprentice_magic_strength(m),
1062 ml->magic[magindex].lineno,
1063 ml->magic[magindex].desc,
1064 ml->magic[magindex].mimetype);
1070 set_test_type(struct magic *mstart, struct magic *m)
1110 mstart->flag |= BINTEST;
1114 case FILE_BESTRING16:
1115 case FILE_LESTRING16:
1116 /* Allow text overrides */
1117 if (mstart->str_flags & STRING_TEXTTEST)
1118 mstart->flag |= TEXTTEST;
1120 mstart->flag |= BINTEST;
1124 /* Check for override */
1125 if (mstart->str_flags & STRING_BINTEST)
1126 mstart->flag |= BINTEST;
1127 if (mstart->str_flags & STRING_TEXTTEST)
1128 mstart->flag |= TEXTTEST;
1130 if (mstart->flag & (TEXTTEST|BINTEST))
1133 /* binary test if pattern is not text */
1134 if (file_looks_utf8(m->value.us, CAST(size_t, m->vallen), NULL,
1136 mstart->flag |= BINTEST;
1138 mstart->flag |= TEXTTEST;
1141 /* can't deduce anything; we shouldn't see this at the
1146 /* invalid search type, but no need to complain here */
1152 addentry(struct magic_set *ms, struct magic_entry *me,
1153 struct magic_entry_set *mset)
1155 size_t i = me->mp->type == FILE_NAME ? 1 : 0;
1156 if (mset[i].count == mset[i].max) {
1157 struct magic_entry *mp;
1159 mset[i].max += ALLOC_INCR;
1160 if ((mp = CAST(struct magic_entry *,
1161 realloc(mset[i].me, sizeof(*mp) * mset[i].max))) ==
1163 file_oomem(ms, sizeof(*mp) * mset[i].max);
1166 (void)memset(&mp[mset[i].count], 0, sizeof(*mp) *
1170 mset[i].me[mset[i].count++] = *me;
1171 memset(me, 0, sizeof(*me));
1176 * Load and parse one file.
1179 load_1(struct magic_set *ms, int action, const char *fn, int *errs,
1180 struct magic_entry_set *mset)
1182 size_t lineno = 0, llen = 0;
1185 struct magic_entry me;
1187 FILE *f = fopen(ms->file = fn, "r");
1189 if (errno != ENOENT)
1190 file_error(ms, errno, "cannot read magic file `%s'",
1196 memset(&me, 0, sizeof(me));
1197 /* read and parse this file */
1198 for (ms->line = 1; (len = getline(&line, &llen, f)) != -1;
1200 if (len == 0) /* null line, garbage, etc */
1202 if (line[len - 1] == '\n') {
1204 line[len - 1] = '\0'; /* delete newline */
1207 case '\0': /* empty, do not parse */
1208 case '#': /* comment, do not parse */
1211 if (line[1] == ':') {
1214 for (i = 0; bang[i].name != NULL; i++) {
1215 if (CAST(size_t, len - 2) > bang[i].len &&
1216 memcmp(bang[i].name, line + 2,
1220 if (bang[i].name == NULL) {
1222 "Unknown !: entry `%s'", line);
1226 if (me.mp == NULL) {
1228 "No current entry for :!%s type",
1233 if ((*bang[i].fun)(ms, &me,
1234 line + bang[i].len + 2,
1235 len - bang[i].len - 2) != 0) {
1244 switch (parse(ms, &me, line, lineno, action)) {
1248 (void)addentry(ms, &me, mset);
1257 (void)addentry(ms, &me, mset);
1263 * parse a file or directory of files
1264 * const char *fn: name of magic file or directory
1267 cmpstrp(const void *p1, const void *p2)
1269 return strcmp(*RCAST(char *const *, p1), *RCAST(char *const *, p2));
1274 set_text_binary(struct magic_set *ms, struct magic_entry *me, uint32_t nme,
1277 static const char text[] = "text";
1278 static const char binary[] = "binary";
1279 static const size_t len = sizeof(text);
1281 uint32_t i = starttest;
1284 set_test_type(me[starttest].mp, me[i].mp);
1285 if ((ms->flags & MAGIC_DEBUG) == 0)
1287 (void)fprintf(stderr, "%s%s%s: %s\n",
1289 me[i].mp->mimetype[0] == '\0' ? "" : "; ",
1290 me[i].mp->desc[0] ? me[i].mp->desc : "(no description)",
1291 me[i].mp->flag & BINTEST ? binary : text);
1292 if (me[i].mp->flag & BINTEST) {
1293 char *p = strstr(me[i].mp->desc, text);
1294 if (p && (p == me[i].mp->desc ||
1295 isspace(CAST(unsigned char, p[-1]))) &&
1296 (p + len - me[i].mp->desc == MAXstring
1297 || (p[len] == '\0' ||
1298 isspace(CAST(unsigned char, p[len])))))
1299 (void)fprintf(stderr, "*** Possible "
1300 "binary test for text type\n");
1302 } while (++i < nme && me[i].mp->cont_level != 0);
1307 set_last_default(struct magic_set *ms, struct magic_entry *me, uint32_t nme)
1310 for (i = 0; i < nme; i++) {
1311 if (me[i].mp->cont_level == 0 &&
1312 me[i].mp->type == FILE_DEFAULT) {
1314 if (me[i].mp->cont_level == 0)
1318 ms->line = me[i].mp->lineno;
1320 "level 0 \"default\" did not sort last");
1328 coalesce_entries(struct magic_set *ms, struct magic_entry *me, uint32_t nme,
1329 struct magic **ma, uint32_t *nma)
1331 uint32_t i, mentrycount = 0;
1334 for (i = 0; i < nme; i++)
1335 mentrycount += me[i].cont_count;
1337 slen = sizeof(**ma) * mentrycount;
1338 if ((*ma = CAST(struct magic *, malloc(slen))) == NULL) {
1339 file_oomem(ms, slen);
1344 for (i = 0; i < nme; i++) {
1345 (void)memcpy(*ma + mentrycount, me[i].mp,
1346 me[i].cont_count * sizeof(**ma));
1347 mentrycount += me[i].cont_count;
1354 magic_entry_free(struct magic_entry *me, uint32_t nme)
1359 for (i = 0; i < nme; i++)
1364 private struct magic_map *
1365 apprentice_load(struct magic_set *ms, const char *fn, int action)
1369 size_t files = 0, maxfiles = 0;
1370 char **filearr = NULL, *mfn;
1372 struct magic_map *map;
1373 struct magic_entry_set mset[MAGIC_SETS];
1377 memset(mset, 0, sizeof(mset));
1378 ms->flags |= MAGIC_CHECK; /* Enable checks for parsed files */
1381 if ((map = CAST(struct magic_map *, calloc(1, sizeof(*map)))) == NULL)
1383 file_oomem(ms, sizeof(*map));
1386 map->type = MAP_TYPE_MALLOC;
1388 /* print silly verbose header for USG compat. */
1389 if (action == FILE_CHECK)
1390 (void)fprintf(stderr, "%s\n", usg_hdr);
1392 /* load directory or file */
1393 if (stat(fn, &st) == 0 && S_ISDIR(st.st_mode)) {
1399 while ((d = readdir(dir)) != NULL) {
1400 if (d->d_name[0] == '.')
1402 if (asprintf(&mfn, "%s/%s", fn, d->d_name) < 0) {
1404 strlen(fn) + strlen(d->d_name) + 2);
1409 if (stat(mfn, &st) == -1 || !S_ISREG(st.st_mode)) {
1413 if (files >= maxfiles) {
1416 maxfiles = (maxfiles + 1) * 2;
1417 mlen = maxfiles * sizeof(*filearr);
1418 if ((nfilearr = CAST(char **,
1419 realloc(filearr, mlen))) == NULL) {
1420 file_oomem(ms, mlen);
1428 filearr[files++] = mfn;
1432 qsort(filearr, files, sizeof(*filearr), cmpstrp);
1433 for (i = 0; i < files; i++) {
1434 load_1(ms, action, filearr[i], &errs, mset);
1441 load_1(ms, action, fn, &errs, mset);
1445 for (j = 0; j < MAGIC_SETS; j++) {
1446 /* Set types of tests */
1447 for (i = 0; i < mset[j].count; ) {
1448 if (mset[j].me[i].mp->cont_level != 0) {
1452 i = set_text_binary(ms, mset[j].me, mset[j].count, i);
1455 qsort(mset[j].me, mset[j].count, sizeof(*mset[j].me),
1459 * Make sure that any level 0 "default" line is last
1462 set_last_default(ms, mset[j].me, mset[j].count);
1464 /* coalesce per file arrays into a single one */
1465 if (coalesce_entries(ms, mset[j].me, mset[j].count,
1466 &map->magic[j], &map->nmagic[j]) == -1) {
1474 for (j = 0; j < MAGIC_SETS; j++)
1475 magic_entry_free(mset[j].me, mset[j].count);
1478 apprentice_unmap(map);
1485 * extend the sign bit if the comparison is to be signed
1488 file_signextend(struct magic_set *ms, struct magic *m, uint64_t v)
1490 if (!(m->flag & UNSIGNED)) {
1493 * Do not remove the casts below. They are
1494 * vital. When later compared with the data,
1495 * the sign extension must have happened.
1498 v = CAST(signed char, v);
1520 v = CAST(int32_t, v);
1538 v = CAST(int64_t, v);
1542 case FILE_BESTRING16:
1543 case FILE_LESTRING16:
1555 if (ms->flags & MAGIC_CHECK)
1556 file_magwarn(ms, "cannot happen: m->type=%d\n",
1558 return FILE_BADSIZE;
1565 string_modifier_check(struct magic_set *ms, struct magic *m)
1567 if ((ms->flags & MAGIC_CHECK) == 0)
1570 if ((m->type != FILE_REGEX || (m->str_flags & REGEX_LINE_COUNT) == 0) &&
1571 (m->type != FILE_PSTRING && (m->str_flags & PSTRING_LEN) != 0)) {
1573 "'/BHhLl' modifiers are only allowed for pascal strings\n");
1577 case FILE_BESTRING16:
1578 case FILE_LESTRING16:
1579 if (m->str_flags != 0) {
1581 "no modifiers allowed for 16-bit strings\n");
1587 if ((m->str_flags & REGEX_OFFSET_START) != 0) {
1589 "'/%c' only allowed on regex and search\n",
1590 CHAR_REGEX_OFFSET_START);
1595 if (m->str_range == 0) {
1597 "missing range; defaulting to %d\n",
1598 STRING_DEFAULT_RANGE);
1599 m->str_range = STRING_DEFAULT_RANGE;
1604 if ((m->str_flags & STRING_COMPACT_WHITESPACE) != 0) {
1605 file_magwarn(ms, "'/%c' not allowed on regex\n",
1606 CHAR_COMPACT_WHITESPACE);
1609 if ((m->str_flags & STRING_COMPACT_OPTIONAL_WHITESPACE) != 0) {
1610 file_magwarn(ms, "'/%c' not allowed on regex\n",
1611 CHAR_COMPACT_OPTIONAL_WHITESPACE);
1616 file_magwarn(ms, "coding error: m->type=%d\n",
1636 return FILE_OPMINUS;
1638 return FILE_OPMULTIPLY;
1640 return FILE_OPDIVIDE;
1642 return FILE_OPMODULO;
1648 #ifdef ENABLE_CONDITIONALS
1650 get_cond(const char *l, const char **t)
1652 static const struct cond_tbl_s {
1657 { "if", 2, COND_IF },
1658 { "elif", 4, COND_ELIF },
1659 { "else", 4, COND_ELSE },
1660 { "", 0, COND_NONE },
1662 const struct cond_tbl_s *p;
1664 for (p = cond_tbl; p->len; p++) {
1665 if (strncmp(l, p->name, p->len) == 0 &&
1666 isspace(CAST(unsigned char, l[p->len]))) {
1676 check_cond(struct magic_set *ms, int cond, uint32_t cont_level)
1679 last_cond = ms->c.li[cont_level].last_cond;
1683 if (last_cond != COND_NONE && last_cond != COND_ELIF) {
1684 if (ms->flags & MAGIC_CHECK)
1685 file_magwarn(ms, "syntax error: `if'");
1688 last_cond = COND_IF;
1692 if (last_cond != COND_IF && last_cond != COND_ELIF) {
1693 if (ms->flags & MAGIC_CHECK)
1694 file_magwarn(ms, "syntax error: `elif'");
1697 last_cond = COND_ELIF;
1701 if (last_cond != COND_IF && last_cond != COND_ELIF) {
1702 if (ms->flags & MAGIC_CHECK)
1703 file_magwarn(ms, "syntax error: `else'");
1706 last_cond = COND_NONE;
1710 last_cond = COND_NONE;
1714 ms->c.li[cont_level].last_cond = last_cond;
1717 #endif /* ENABLE_CONDITIONALS */
1720 parse_indirect_modifier(struct magic_set *ms, struct magic *m, const char **lp)
1722 const char *l = *lp;
1724 while (!isspace(CAST(unsigned char, *++l)))
1726 case CHAR_INDIRECT_RELATIVE:
1727 m->str_flags |= INDIRECT_RELATIVE;
1730 if (ms->flags & MAGIC_CHECK)
1731 file_magwarn(ms, "indirect modifier `%c' "
1741 parse_op_modifier(struct magic_set *ms, struct magic *m, const char **lp,
1744 const char *l = *lp;
1750 val = CAST(uint64_t, strtoull(l, &t, 0));
1752 m->num_mask = file_signextend(ms, m, val);
1758 parse_string_modifier(struct magic_set *ms, struct magic *m, const char **lp)
1760 const char *l = *lp;
1764 while (!isspace(CAST(unsigned char, *++l))) {
1766 case '0': case '1': case '2':
1767 case '3': case '4': case '5':
1768 case '6': case '7': case '8':
1770 if (have_range && (ms->flags & MAGIC_CHECK))
1771 file_magwarn(ms, "multiple ranges");
1773 m->str_range = CAST(uint32_t, strtoul(l, &t, 0));
1774 if (m->str_range == 0)
1775 file_magwarn(ms, "zero range");
1778 case CHAR_COMPACT_WHITESPACE:
1779 m->str_flags |= STRING_COMPACT_WHITESPACE;
1781 case CHAR_COMPACT_OPTIONAL_WHITESPACE:
1782 m->str_flags |= STRING_COMPACT_OPTIONAL_WHITESPACE;
1784 case CHAR_IGNORE_LOWERCASE:
1785 m->str_flags |= STRING_IGNORE_LOWERCASE;
1787 case CHAR_IGNORE_UPPERCASE:
1788 m->str_flags |= STRING_IGNORE_UPPERCASE;
1790 case CHAR_REGEX_OFFSET_START:
1791 m->str_flags |= REGEX_OFFSET_START;
1794 m->str_flags |= STRING_BINTEST;
1797 m->str_flags |= STRING_TEXTTEST;
1800 m->str_flags |= STRING_TRIM;
1802 case CHAR_PSTRING_1_LE:
1803 #define SET_LENGTH(a) m->str_flags = (m->str_flags & ~PSTRING_LEN) | (a)
1804 if (m->type != FILE_PSTRING)
1806 SET_LENGTH(PSTRING_1_LE);
1808 case CHAR_PSTRING_2_BE:
1809 if (m->type != FILE_PSTRING)
1811 SET_LENGTH(PSTRING_2_BE);
1813 case CHAR_PSTRING_2_LE:
1814 if (m->type != FILE_PSTRING)
1816 SET_LENGTH(PSTRING_2_LE);
1818 case CHAR_PSTRING_4_BE:
1819 if (m->type != FILE_PSTRING)
1821 SET_LENGTH(PSTRING_4_BE);
1823 case CHAR_PSTRING_4_LE:
1831 SET_LENGTH(PSTRING_4_LE);
1833 case CHAR_PSTRING_LENGTH_INCLUDES_ITSELF:
1834 if (m->type != FILE_PSTRING)
1836 m->str_flags |= PSTRING_LENGTH_INCLUDES_ITSELF;
1840 if (ms->flags & MAGIC_CHECK)
1841 file_magwarn(ms, "string modifier `%c' "
1845 /* allow multiple '/' for readability */
1846 if (l[1] == '/' && !isspace(CAST(unsigned char, l[2])))
1849 if (string_modifier_check(ms, m) == -1)
1859 * parse one line from magic file, put into magic[index++] if valid
1862 parse(struct magic_set *ms, struct magic_entry *me, const char *line,
1863 size_t lineno, int action)
1865 #ifdef ENABLE_CONDITIONALS
1866 static uint32_t last_cont_level = 0;
1870 const char *l = line;
1873 uint32_t cont_level;
1882 ++l; /* step over */
1885 #ifdef ENABLE_CONDITIONALS
1886 if (cont_level == 0 || cont_level > last_cont_level)
1887 if (file_check_mem(ms, cont_level) == -1)
1889 last_cont_level = cont_level;
1891 if (cont_level != 0) {
1892 if (me->mp == NULL) {
1893 file_magerror(ms, "No current entry for continuation");
1896 if (me->cont_count == 0) {
1897 file_magerror(ms, "Continuations present with 0 count");
1900 m = &me->mp[me->cont_count - 1];
1901 diff = CAST(int32_t, cont_level) - CAST(int32_t, m->cont_level);
1903 file_magwarn(ms, "New continuation level %u is more "
1904 "than one larger than current level %u", cont_level,
1906 if (me->cont_count == me->max_count) {
1908 size_t cnt = me->max_count + ALLOC_CHUNK;
1909 if ((nm = CAST(struct magic *, realloc(me->mp,
1910 sizeof(*nm) * cnt))) == NULL) {
1911 file_oomem(ms, sizeof(*nm) * cnt);
1915 me->max_count = CAST(uint32_t, cnt);
1917 m = &me->mp[me->cont_count++];
1918 (void)memset(m, 0, sizeof(*m));
1919 m->cont_level = cont_level;
1921 static const size_t len = sizeof(*m) * ALLOC_CHUNK;
1924 if ((m = CAST(struct magic *, malloc(len))) == NULL) {
1925 file_oomem(ms, len);
1929 me->max_count = ALLOC_CHUNK;
1930 (void)memset(m, 0, sizeof(*m));
1931 m->factor_op = FILE_FACTOR_OP_NONE;
1935 m->lineno = CAST(uint32_t, lineno);
1937 if (*l == '&') { /* m->cont_level == 0 checked below. */
1938 ++l; /* step over */
1942 ++l; /* step over */
1944 if (m->flag & OFFADD)
1945 m->flag = (m->flag & ~OFFADD) | INDIROFFADD;
1947 if (*l == '&') { /* m->cont_level == 0 checked below */
1948 ++l; /* step over */
1952 /* Indirect offsets are not valid at level 0. */
1953 if (m->cont_level == 0 && (m->flag & (OFFADD | INDIROFFADD))) {
1954 if (ms->flags & MAGIC_CHECK)
1955 file_magwarn(ms, "relative offset at level 0");
1959 /* get offset, then skip over it */
1961 ++l; /* step over */
1962 m->flag |= OFFNEGATIVE;
1964 m->offset = CAST(int32_t, strtol(l, &t, 0));
1966 if (ms->flags & MAGIC_CHECK)
1967 file_magwarn(ms, "offset `%s' invalid", l);
1973 if (m->flag & INDIR) {
1974 m->in_type = FILE_LONG;
1978 * read [.,lbs][+-]nnnnn)
1980 if (*l == '.' || *l == ',') {
1982 m->in_op |= FILE_OPSIGNED;
1986 m->in_type = FILE_LELONG;
1989 m->in_type = FILE_BELONG;
1992 m->in_type = FILE_MELONG;
1996 m->in_type = FILE_LESHORT;
2000 m->in_type = FILE_BESHORT;
2006 m->in_type = FILE_BYTE;
2011 m->in_type = FILE_LEDOUBLE;
2016 m->in_type = FILE_BEDOUBLE;
2019 m->in_type = FILE_LEID3;
2022 m->in_type = FILE_BEID3;
2025 m->in_type = FILE_LEQUAD;
2028 m->in_type = FILE_BEQUAD;
2031 if (ms->flags & MAGIC_CHECK)
2033 "indirect offset type `%c' invalid",
2041 m->in_op |= FILE_OPINVERSE;
2044 if ((op = get_op(*l)) != -1) {
2049 m->in_op |= FILE_OPINDIRECT;
2052 if (isdigit(CAST(unsigned char, *l)) || *l == '-') {
2053 m->in_offset = CAST(int32_t, strtol(l, &t, 0));
2055 if (ms->flags & MAGIC_CHECK)
2057 "in_offset `%s' invalid", l);
2063 ((m->in_op & FILE_OPINDIRECT) && *l++ != ')')) {
2064 if (ms->flags & MAGIC_CHECK)
2066 "missing ')' in indirect offset");
2072 #ifdef ENABLE_CONDITIONALS
2073 m->cond = get_cond(l, &l);
2074 if (check_cond(ms, m->cond, cont_level) == -1)
2085 * Try it as a keyword type prefixed by "u"; match what
2086 * follows the "u". If that fails, try it as an SUS
2089 m->type = get_type(type_tbl, l + 1, &l);
2090 if (m->type == FILE_INVALID) {
2092 * Not a keyword type; parse it as an SUS type,
2093 * 'u' possibly followed by a number or C/S/L.
2095 m->type = get_standard_integer_type(l, &l);
2097 /* It's unsigned. */
2098 if (m->type != FILE_INVALID)
2099 m->flag |= UNSIGNED;
2102 * Try it as a keyword type. If that fails, try it as
2103 * an SUS integer type if it begins with "d" or as an
2104 * SUS string type if it begins with "s". In any case,
2105 * it's not unsigned.
2107 m->type = get_type(type_tbl, l, &l);
2108 if (m->type == FILE_INVALID) {
2110 * Not a keyword type; parse it as an SUS type,
2111 * either 'd' possibly followed by a number or
2112 * C/S/L, or just 's'.
2115 m->type = get_standard_integer_type(l, &l);
2117 && !isalpha(CAST(unsigned char, l[1]))) {
2118 m->type = FILE_STRING;
2124 if (m->type == FILE_INVALID) {
2125 /* Not found - try it as a special keyword. */
2126 m->type = get_type(special_tbl, l, &l);
2129 if (m->type == FILE_INVALID) {
2130 if (ms->flags & MAGIC_CHECK)
2131 file_magwarn(ms, "type `%s' invalid", l);
2135 /* New-style anding: "0 byte&0x80 =0x80 dynamically linked" */
2136 /* New and improved: ~ & | ^ + - * / % -- exciting, isn't it? */
2140 if (!IS_STRING(m->type))
2141 m->mask_op |= FILE_OPINVERSE;
2142 else if (ms->flags & MAGIC_CHECK)
2143 file_magwarn(ms, "'~' invalid for string types");
2147 m->str_flags = m->type == FILE_PSTRING ? PSTRING_1_LE : 0;
2148 if ((op = get_op(*l)) != -1) {
2149 if (IS_STRING(m->type)) {
2152 if (op != FILE_OPDIVIDE) {
2153 if (ms->flags & MAGIC_CHECK)
2155 "invalid string/indirect op: "
2160 if (m->type == FILE_INDIRECT)
2161 r = parse_indirect_modifier(ms, m, &l);
2163 r = parse_string_modifier(ms, m, &l);
2167 parse_op_modifier(ms, m, &l, op);
2171 * We used to set mask to all 1's here, instead let's just not do
2172 * anything if mask = 0 (unless you have a better idea)
2182 if (ms->flags & MAGIC_CHECK) {
2183 file_magwarn(ms, "%c= not supported",
2190 /* Old-style anding: "0 byte &0x80 dynamically linked" */
2197 /* HP compat: ignore &= etc. */
2206 m->reln = '='; /* the default relation */
2207 if (*l == 'x' && ((isascii(CAST(unsigned char, l[1])) &&
2208 isspace(CAST(unsigned char, l[1]))) || !l[1])) {
2215 * Grab the value part, except for an 'x' reln.
2217 if (m->reln != 'x' && getvalue(ms, m, &l, action))
2221 * TODO finish this macro and start using it!
2222 * #define offsetcheck {if (offset > ms->bytes_max -1)
2223 * magwarn("offset too big"); }
2227 * Now get last part - the description
2233 } else if ((l[0] == '\\') && (l[1] == 'b')) {
2238 for (i = 0; (m->desc[i++] = *l++) != '\0' && i < sizeof(m->desc); )
2240 if (i == sizeof(m->desc)) {
2241 m->desc[sizeof(m->desc) - 1] = '\0';
2242 if (ms->flags & MAGIC_CHECK)
2243 file_magwarn(ms, "description `%s' truncated", m->desc);
2247 * We only do this check while compiling, or if any of the magic
2248 * files were not compiled.
2250 if (ms->flags & MAGIC_CHECK) {
2251 if (check_format(ms, m) == -1)
2254 #ifndef COMPILE_ONLY
2255 if (action == FILE_CHECK) {
2259 m->mimetype[0] = '\0'; /* initialise MIME type to none */
2264 * parse a STRENGTH annotation line from magic file, put into magic[index - 1]
2268 parse_strength(struct magic_set *ms, struct magic_entry *me, const char *line,
2269 size_t len __attribute__((__unused__)))
2271 const char *l = line;
2273 unsigned long factor;
2274 struct magic *m = &me->mp[0];
2276 if (m->factor_op != FILE_FACTOR_OP_NONE) {
2278 "Current entry already has a strength type: %c %d",
2279 m->factor_op, m->factor);
2282 if (m->type == FILE_NAME) {
2283 file_magwarn(ms, "%s: Strength setting is not supported in "
2284 "\"name\" magic entries", m->value.s);
2289 case FILE_FACTOR_OP_NONE:
2290 case FILE_FACTOR_OP_PLUS:
2291 case FILE_FACTOR_OP_MINUS:
2292 case FILE_FACTOR_OP_TIMES:
2293 case FILE_FACTOR_OP_DIV:
2294 m->factor_op = *l++;
2297 file_magwarn(ms, "Unknown factor op `%c'", *l);
2301 factor = strtoul(l, &el, 0);
2303 file_magwarn(ms, "Too large factor `%lu'", factor);
2306 if (*el && !isspace(CAST(unsigned char, *el))) {
2307 file_magwarn(ms, "Bad factor `%s'", l);
2310 m->factor = CAST(uint8_t, factor);
2311 if (m->factor == 0 && m->factor_op == FILE_FACTOR_OP_DIV) {
2312 file_magwarn(ms, "Cannot have factor op `%c' and factor %u",
2313 m->factor_op, m->factor);
2318 m->factor_op = FILE_FACTOR_OP_NONE;
2324 goodchar(unsigned char x, const char *extra)
2326 return (isascii(x) && isalnum(x)) || strchr(extra, x);
2330 parse_extra(struct magic_set *ms, struct magic_entry *me, const char *line,
2331 size_t llen, off_t off, size_t len, const char *name, const char *extra,
2335 const char *l = line;
2336 struct magic *m = &me->mp[me->cont_count == 0 ? 0 : me->cont_count - 1];
2337 char *buf = CAST(char *, CAST(void *, m)) + off;
2339 if (buf[0] != '\0') {
2340 len = nt ? strlen(buf) : len;
2341 file_magwarn(ms, "Current entry already has a %s type "
2342 "`%.*s', new type `%s'", name, CAST(int, len), buf, l);
2346 if (*m->desc == '\0') {
2347 file_magwarn(ms, "Current entry does not yet have a "
2348 "description for adding a %s type", name);
2353 for (i = 0; *l && i < llen && i < len && goodchar(*l, extra);
2357 if (i == len && *l) {
2359 buf[len - 1] = '\0';
2360 if (ms->flags & MAGIC_CHECK)
2361 file_magwarn(ms, "%s type `%s' truncated %"
2362 SIZE_T_FORMAT "u", name, line, i);
2364 if (!isspace(CAST(unsigned char, *l)) && !goodchar(*l, extra))
2365 file_magwarn(ms, "%s type `%s' has bad char '%c'",
2374 file_magerror(ms, "Bad magic entry '%s'", line);
2379 * Parse an Apple CREATOR/TYPE annotation from magic file and put it into
2383 parse_apple(struct magic_set *ms, struct magic_entry *me, const char *line,
2386 struct magic *m = &me->mp[0];
2388 return parse_extra(ms, me, line, len,
2389 CAST(off_t, offsetof(struct magic, apple)),
2390 sizeof(m->apple), "APPLE", "!+-./?", 0);
2394 * Parse a comma-separated list of extensions
2397 parse_ext(struct magic_set *ms, struct magic_entry *me, const char *line,
2400 struct magic *m = &me->mp[0];
2402 return parse_extra(ms, me, line, len,
2403 CAST(off_t, offsetof(struct magic, ext)),
2404 sizeof(m->ext), "EXTENSION", ",!+-/@?_$", 0);
2408 * parse a MIME annotation line from magic file, put into magic[index - 1]
2412 parse_mime(struct magic_set *ms, struct magic_entry *me, const char *line,
2415 struct magic *m = &me->mp[0];
2417 return parse_extra(ms, me, line, len,
2418 CAST(off_t, offsetof(struct magic, mimetype)),
2419 sizeof(m->mimetype), "MIME", "+-/.$?:{}", 1);
2423 check_format_type(const char *ptr, int type, const char **estr)
2428 /* Missing format string; bad */
2429 *estr = "missing format spec";
2433 switch (file_formats[type]) {
2468 #define CHECKLEN() do { \
2469 for (len = cnt = 0; isdigit(CAST(unsigned char, *ptr)); ptr++, cnt++) \
2470 len = len * 10 + (*ptr - '0'); \
2471 if (cnt > 5 || len > 1024) \
2473 } while (/*CONSTCOND*/0)
2487 #ifdef STRICT_FORMAT /* "long" formats are int formats for us */
2488 /* so don't accept the 'l' modifier */
2505 * Don't accept h and hh modifiers. They make writing
2506 * magic entries more complicated, for very little benefit
2549 #ifdef STRICT_FORMAT
2560 case FILE_FMT_FLOAT:
2561 case FILE_FMT_DOUBLE:
2587 while (isdigit(CAST(unsigned char, *ptr)))
2591 while (isdigit(CAST(unsigned char , *ptr)))
2603 /* internal error */
2607 *estr = "not valid";
2614 * Check that the optional printf format in description matches
2615 * the type of the magic.
2618 check_format(struct magic_set *ms, struct magic *m)
2623 for (ptr = m->desc; *ptr; ptr++)
2627 /* No format string; ok */
2631 assert(file_nformats == file_nnames);
2633 if (m->type >= file_nformats) {
2634 file_magwarn(ms, "Internal error inconsistency between "
2635 "m->type and format strings");
2638 if (file_formats[m->type] == FILE_FMT_NONE) {
2639 file_magwarn(ms, "No format string for `%s' with description "
2640 "`%s'", m->desc, file_names[m->type]);
2645 if (check_format_type(ptr, m->type, &estr) == -1) {
2647 * TODO: this error message is unhelpful if the format
2648 * string is not one character long
2650 file_magwarn(ms, "Printf format is %s for type "
2651 "`%s' in description `%s'", estr,
2652 file_names[m->type], m->desc);
2656 for (; *ptr; ptr++) {
2659 "Too many format strings (should have at most one) "
2660 "for `%s' with description `%s'",
2661 file_names[m->type], m->desc);
2669 * Read a numeric value from a pointer, into the value union of a magic
2670 * pointer, according to the magic type. Update the string pointer to point
2671 * just after the number read. Return 0 for success, non-zero for failure.
2674 getvalue(struct magic_set *ms, struct magic *m, const char **p, int action)
2680 case FILE_BESTRING16:
2681 case FILE_LESTRING16:
2689 *p = getstr(ms, m, *p, action == FILE_COMPILE);
2691 if (ms->flags & MAGIC_CHECK)
2692 file_magwarn(ms, "cannot get string from `%s'",
2696 if (m->type == FILE_REGEX) {
2698 int rc = file_regcomp(&rx, m->value.s, REG_EXTENDED);
2700 if (ms->flags & MAGIC_CHECK)
2701 file_regerror(&rx, rc, ms);
2719 m->value.f = strtof(*p, &ep);
2721 m->value.f = (float)strtod(*p, &ep);
2730 m->value.d = strtod(*p, &ep);
2735 if (file_parse_guid(*p, m->value.guid) == -1)
2737 *p += FILE_GUID_SIZE - 1;
2741 ull = CAST(uint64_t, strtoull(*p, &ep, 0));
2742 m->value.q = file_signextend(ms, m, ull);
2744 file_magwarn(ms, "Unparseable number `%s'", *p);
2746 size_t ts = typesize(m->type);
2750 if (ts == FILE_BADSIZE) {
2752 "Expected numeric type got `%s'",
2753 type_tbl[m->type].name);
2755 for (q = *p; isspace(CAST(unsigned char, *q)); q++)
2758 ull = -CAST(int64_t, ull);
2761 x = CAST(uint64_t, ull & ~0xffULL);
2764 x = CAST(uint64_t, ull & ~0xffffULL);
2767 x = CAST(uint64_t, ull & ~0xffffffffULL);
2776 file_magwarn(ms, "Overflow for numeric"
2777 " type `%s' value %#" PRIx64,
2778 type_tbl[m->type].name, ull);
2790 * Convert a string containing C character escapes. Stop at an unescaped
2792 * Copy the converted version to "m->value.s", and the length in m->vallen.
2793 * Return updated scan pointer as function result. Warn if set.
2795 private const char *
2796 getstr(struct magic_set *ms, struct magic *m, const char *s, int warn)
2798 const char *origs = s;
2799 char *p = m->value.s;
2800 size_t plen = sizeof(m->value.s);
2802 char *pmax = p + plen - 1;
2806 while ((c = *s++) != '\0') {
2807 if (isspace(CAST(unsigned char, c)))
2810 file_error(ms, 0, "string too long: `%s'", origs);
2818 file_magwarn(ms, "incomplete escape");
2825 "escaped tab found, use \\t instead");
2826 warn = 0; /* already did */
2831 if (isprint(CAST(unsigned char, c))) {
2832 /* Allow escaping of
2834 if (strchr("<>&^=!", c) == NULL
2835 && (m->type != FILE_REGEX ||
2836 strchr("[]().*?^$|{}", c)
2838 file_magwarn(ms, "no "
2844 "unknown escape sequence: "
2849 /* space, perhaps force people to use \040? */
2853 * Other things people escape, but shouldn't need to,
2854 * so we disallow them
2867 /* and baskslash itself */
2869 *p++ = CAST(char, c);
2900 /* \ and up to 3 octal digits */
2910 c = *s++; /* try for 2 */
2911 if (c >= '0' && c <= '7') {
2912 val = (val << 3) | (c - '0');
2913 c = *s++; /* try for 3 */
2914 if (c >= '0' && c <= '7')
2915 val = (val << 3) | (c-'0');
2921 *p++ = CAST(char, val);
2924 /* \x and up to 2 hex digits */
2926 val = 'x'; /* Default if no digits */
2927 c = hextoint(*s++); /* Get next char */
2932 val = (val << 4) + c;
2937 *p++ = CAST(char, val);
2941 *p++ = CAST(char, c);
2946 m->vallen = CAST(unsigned char, (p - origp));
2947 if (m->type == FILE_PSTRING) {
2948 size_t l = file_pstring_length_size(ms, m);
2949 if (l == FILE_BADSIZE)
2951 m->vallen += CAST(unsigned char, l);
2957 /* Single hex char to int; -1 if not a hex char. */
2961 if (!isascii(CAST(unsigned char, c)))
2963 if (isdigit(CAST(unsigned char, c)))
2965 if ((c >= 'a') && (c <= 'f'))
2966 return c + 10 - 'a';
2967 if (( c>= 'A') && (c <= 'F'))
2968 return c + 10 - 'A';
2974 * Print a string containing C character escapes.
2977 file_showstr(FILE *fp, const char *s, size_t len)
2982 if (len == FILE_BADSIZE) {
2992 if (c >= 040 && c <= 0176) /* TODO isprint && !iscntrl */
2993 (void) fputc(c, fp);
2995 (void) fputc('\\', fp);
2998 (void) fputc('a', fp);
3002 (void) fputc('b', fp);
3006 (void) fputc('f', fp);
3010 (void) fputc('n', fp);
3014 (void) fputc('r', fp);
3018 (void) fputc('t', fp);
3022 (void) fputc('v', fp);
3026 (void) fprintf(fp, "%.3o", c & 0377);
3034 * eatsize(): Eat the size spec from a number [eg. 10UL]
3037 eatsize(const char **p)
3041 if (LOWCASE(*l) == 'u')
3044 switch (LOWCASE(*l)) {
3045 case 'l': /* long */
3046 case 's': /* short */
3047 case 'h': /* short */
3048 case 'b': /* char/byte */
3049 case 'c': /* char/byte */
3060 * handle a buffer containing a compiled file.
3062 private struct magic_map *
3063 apprentice_buf(struct magic_set *ms, struct magic *buf, size_t len)
3065 struct magic_map *map;
3067 if ((map = CAST(struct magic_map *, calloc(1, sizeof(*map)))) == NULL) {
3068 file_oomem(ms, sizeof(*map));
3073 map->type = MAP_TYPE_USER;
3074 if (check_buffer(ms, map, "buffer") != 0) {
3075 apprentice_unmap(map);
3082 * handle a compiled file.
3085 private struct magic_map *
3086 apprentice_map(struct magic_set *ms, const char *fn)
3090 char *dbname = NULL;
3091 struct magic_map *map;
3092 struct magic_map *rv = NULL;
3095 if ((map = CAST(struct magic_map *, calloc(1, sizeof(*map)))) == NULL) {
3096 file_oomem(ms, sizeof(*map));
3099 map->type = MAP_TYPE_USER; /* unspecified */
3101 dbname = mkdbname(ms, fn, 0);
3105 if ((fd = open(dbname, O_RDONLY|O_BINARY)) == -1)
3108 if (fstat(fd, &st) == -1) {
3109 file_error(ms, errno, "cannot stat `%s'", dbname);
3112 if (st.st_size < 8 || st.st_size > maxoff_t()) {
3113 file_error(ms, 0, "file `%s' is too %s", dbname,
3114 st.st_size < 8 ? "small" : "large");
3118 map->len = CAST(size_t, st.st_size);
3120 map->type = MAP_TYPE_MMAP;
3121 if ((map->p = mmap(0, CAST(size_t, st.st_size), PROT_READ|PROT_WRITE,
3122 MAP_PRIVATE|MAP_FILE, fd, CAST(off_t, 0))) == MAP_FAILED) {
3123 file_error(ms, errno, "cannot map `%s'", dbname);
3127 map->type = MAP_TYPE_MALLOC;
3128 if ((map->p = CAST(void *, malloc(map->len))) == NULL) {
3129 file_oomem(ms, map->len);
3132 if (read(fd, map->p, map->len) != (ssize_t)map->len) {
3140 if (check_buffer(ms, map, dbname) != 0) {
3144 if (mprotect(map->p, CAST(size_t, st.st_size), PROT_READ) == -1) {
3145 file_error(ms, errno, "cannot mprotect `%s'", dbname);
3156 apprentice_unmap(map);
3162 check_buffer(struct magic_set *ms, struct magic_map *map, const char *dbname)
3165 uint32_t entries, nentries;
3167 int i, needsbyteswap;
3169 ptr = CAST(uint32_t *, map->p);
3170 if (*ptr != MAGICNO) {
3171 if (swap4(*ptr) != MAGICNO) {
3172 file_error(ms, 0, "bad magic in `%s'", dbname);
3179 version = swap4(ptr[1]);
3182 if (version != VERSIONNO) {
3183 file_error(ms, 0, "File %s supports only version %d magic "
3184 "files. `%s' is version %d", VERSION,
3185 VERSIONNO, dbname, version);
3188 entries = CAST(uint32_t, map->len / sizeof(struct magic));
3189 if ((entries * sizeof(struct magic)) != map->len) {
3190 file_error(ms, 0, "Size of `%s' %" SIZE_T_FORMAT "u is not "
3191 "a multiple of %" SIZE_T_FORMAT "u",
3192 dbname, map->len, sizeof(struct magic));
3195 map->magic[0] = CAST(struct magic *, map->p) + 1;
3197 for (i = 0; i < MAGIC_SETS; i++) {
3199 map->nmagic[i] = swap4(ptr[i + 2]);
3201 map->nmagic[i] = ptr[i + 2];
3202 if (i != MAGIC_SETS - 1)
3203 map->magic[i + 1] = map->magic[i] + map->nmagic[i];
3204 nentries += map->nmagic[i];
3206 if (entries != nentries + 1) {
3207 file_error(ms, 0, "Inconsistent entries in `%s' %u != %u",
3208 dbname, entries, nentries + 1);
3212 for (i = 0; i < MAGIC_SETS; i++)
3213 byteswap(map->magic[i], map->nmagic[i]);
3218 * handle an mmaped file.
3221 apprentice_compile(struct magic_set *ms, struct magic_map *map, const char *fn)
3223 static const size_t nm = sizeof(*map->nmagic) * MAGIC_SETS;
3224 static const size_t m = sizeof(**map->magic);
3232 uint32_t h[2 + MAGIC_SETS];
3235 dbname = mkdbname(ms, fn, 1);
3240 if ((fd = open(dbname, O_WRONLY|O_CREAT|O_TRUNC|O_BINARY, 0644)) == -1)
3242 file_error(ms, errno, "cannot open `%s'", dbname);
3245 memset(&hdr, 0, sizeof(hdr));
3247 hdr.h[1] = VERSIONNO;
3248 memcpy(hdr.h + 2, map->nmagic, nm);
3250 if (write(fd, &hdr, sizeof(hdr)) != CAST(ssize_t, sizeof(hdr))) {
3251 file_error(ms, errno, "error writing `%s'", dbname);
3255 for (i = 0; i < MAGIC_SETS; i++) {
3256 len = m * map->nmagic[i];
3257 if (write(fd, map->magic[i], len) != CAST(ssize_t, len)) {
3258 file_error(ms, errno, "error writing `%s'", dbname);
3268 apprentice_unmap(map);
3273 private const char ext[] = ".mgc";
3278 mkdbname(struct magic_set *ms, const char *fn, int strip)
3284 if ((p = strrchr(fn, '/')) != NULL)
3288 for (q = fn; *q; q++)
3291 for (p = ext + sizeof(ext) - 1; p >= ext && q >= fn; p--, q--)
3295 /* Did not find .mgc, restore q */
3301 /* Compatibility with old code that looked in .mime */
3302 if (ms->flags & MAGIC_MIME) {
3303 if (asprintf(&buf, "%.*s.mime%s", CAST(int, q - fn), fn, ext)
3306 if (access(buf, R_OK) != -1) {
3307 ms->flags &= MAGIC_MIME_TYPE;
3312 if (asprintf(&buf, "%.*s%s", CAST(int, q - fn), fn, ext) < 0)
3315 /* Compatibility with old code that looked in .mime */
3316 if (strstr(fn, ".mime") != NULL)
3317 ms->flags &= MAGIC_MIME_TYPE;
3322 * Byteswap an mmap'ed file if needed
3325 byteswap(struct magic *magic, uint32_t nmagic)
3328 for (i = 0; i < nmagic; i++)
3339 uint8_t *s = RCAST(uint8_t *, RCAST(void *, &sv));
3340 uint8_t *d = RCAST(uint8_t *, RCAST(void *, &rv));
3353 uint8_t *s = RCAST(uint8_t *, RCAST(void *, &sv));
3354 uint8_t *d = RCAST(uint8_t *, RCAST(void *, &rv));
3369 uint8_t *s = RCAST(uint8_t *, RCAST(void *, &sv));
3370 uint8_t *d = RCAST(uint8_t *, RCAST(void *, &rv));
3394 * byteswap a single magic entry
3397 bs1(struct magic *m)
3399 m->cont_level = swap2(m->cont_level);
3400 m->offset = swap4(CAST(uint32_t, m->offset));
3401 m->in_offset = swap4(CAST(uint32_t, m->in_offset));
3402 m->lineno = swap4(CAST(uint32_t, m->lineno));
3403 if (IS_STRING(m->type)) {
3404 m->str_range = swap4(m->str_range);
3405 m->str_flags = swap4(m->str_flags);
3408 m->value.q = swap8(m->value.q);
3409 m->num_mask = swap8(m->num_mask);
3414 file_pstring_length_size(struct magic_set *ms, const struct magic *m)
3416 switch (m->str_flags & PSTRING_LEN) {
3426 file_error(ms, 0, "corrupt magic file "
3427 "(bad pascal string length %d)",
3428 m->str_flags & PSTRING_LEN);
3429 return FILE_BADSIZE;
3433 file_pstring_get_length(struct magic_set *ms, const struct magic *m,
3437 const unsigned char *s = RCAST(const unsigned char *, ss);
3438 unsigned int s3, s2, s1, s0;
3440 switch (m->str_flags & PSTRING_LEN) {
3447 len = (s1 << 8) | s0;
3452 len = (s0 << 8) | s1;
3459 len = (s3 << 24) | (s2 << 16) | (s1 << 8) | s0;
3466 len = (s0 << 24) | (s1 << 16) | (s2 << 8) | s3;
3469 file_error(ms, 0, "corrupt magic file "
3470 "(bad pascal string length %d)",
3471 m->str_flags & PSTRING_LEN);
3472 return FILE_BADSIZE;
3475 if (m->str_flags & PSTRING_LENGTH_INCLUDES_ITSELF) {
3476 size_t l = file_pstring_length_size(ms, m);
3477 if (l == FILE_BADSIZE)
3486 file_magicfind(struct magic_set *ms, const char *name, struct mlist *v)
3489 struct mlist *mlist, *ml;
3491 mlist = ms->mlist[1];
3493 for (ml = mlist->next; ml != mlist; ml = ml->next) {
3494 struct magic *ma = ml->magic;
3495 uint32_t nma = ml->nmagic;
3496 for (i = 0; i < nma; i++) {
3497 if (ma[i].type != FILE_NAME)
3499 if (strcmp(ma[i].value.s, name) == 0) {
3501 for (j = i + 1; j < nma; j++)
3502 if (ma[j].cont_level == 0)