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.283 2019/02/20 02:35:27 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(struct mlist *);
124 private void byteswap(struct magic *, uint32_t);
125 private void bs1(struct magic *);
126 private uint16_t swap2(uint16_t);
127 private uint32_t swap4(uint32_t);
128 private uint64_t swap8(uint64_t);
129 private char *mkdbname(struct magic_set *, const char *, int);
130 private struct magic_map *apprentice_buf(struct magic_set *, struct magic *,
132 private struct magic_map *apprentice_map(struct magic_set *, const char *);
133 private int check_buffer(struct magic_set *, struct magic_map *, const char *);
134 private void apprentice_unmap(struct magic_map *);
135 private int apprentice_compile(struct magic_set *, struct magic_map *,
137 private int check_format_type(const char *, int, const char **);
138 private int check_format(struct magic_set *, struct magic *);
139 private int get_op(char);
140 private int parse_mime(struct magic_set *, struct magic_entry *, const char *);
141 private int parse_strength(struct magic_set *, struct magic_entry *, const char *);
142 private int parse_apple(struct magic_set *, struct magic_entry *, const char *);
143 private int parse_ext(struct magic_set *, struct magic_entry *, const char *);
146 private size_t magicsize = sizeof(struct magic);
148 private const char usg_hdr[] = "cont\toffset\ttype\topcode\tmask\tvalue\tdesc";
153 int (*fun)(struct magic_set *, struct magic_entry *, const char *);
155 #define DECLARE_FIELD(name) { # name, sizeof(# name) - 1, parse_ ## name }
157 DECLARE_FIELD(apple),
159 DECLARE_FIELD(strength),
166 int main(int, char *[]);
169 main(int argc, char *argv[])
172 struct magic_set *ms;
175 if ((progname = strrchr(argv[0], '/')) != NULL)
181 (void)fprintf(stderr, "Usage: %s file\n", progname);
185 if ((ms = magic_open(MAGIC_CHECK)) == NULL) {
186 (void)fprintf(stderr, "%s: %s\n", progname, strerror(errno));
189 ret = magic_compile(ms, argv[1]) == -1 ? 1 : 0;
191 (void)fprintf(stderr, "%s: %s\n", progname, magic_error(ms));
195 #endif /* COMPILE_ONLY */
205 * XXX - the actual Single UNIX Specification says that "long" means "long",
206 * as in the C data type, but we treat it as meaning "4-byte integer".
207 * Given that the OS X version of file 5.04 did the same, I guess that passes
208 * the actual test; having "long" be dependent on how big a "long" is on
209 * the machine running "file" is silly.
211 static const struct type_tbl_s type_tbl[] = {
212 # define XX(s) s, (sizeof(s) - 1)
213 # define XX_NULL "", 0
214 { XX("invalid"), FILE_INVALID, FILE_FMT_NONE },
215 { XX("byte"), FILE_BYTE, FILE_FMT_NUM },
216 { XX("short"), FILE_SHORT, FILE_FMT_NUM },
217 { XX("default"), FILE_DEFAULT, FILE_FMT_NONE },
218 { XX("long"), FILE_LONG, FILE_FMT_NUM },
219 { XX("string"), FILE_STRING, FILE_FMT_STR },
220 { XX("date"), FILE_DATE, FILE_FMT_STR },
221 { XX("beshort"), FILE_BESHORT, FILE_FMT_NUM },
222 { XX("belong"), FILE_BELONG, FILE_FMT_NUM },
223 { XX("bedate"), FILE_BEDATE, FILE_FMT_STR },
224 { XX("leshort"), FILE_LESHORT, FILE_FMT_NUM },
225 { XX("lelong"), FILE_LELONG, FILE_FMT_NUM },
226 { XX("ledate"), FILE_LEDATE, FILE_FMT_STR },
227 { XX("pstring"), FILE_PSTRING, FILE_FMT_STR },
228 { XX("ldate"), FILE_LDATE, FILE_FMT_STR },
229 { XX("beldate"), FILE_BELDATE, FILE_FMT_STR },
230 { XX("leldate"), FILE_LELDATE, FILE_FMT_STR },
231 { XX("regex"), FILE_REGEX, FILE_FMT_STR },
232 { XX("bestring16"), FILE_BESTRING16, FILE_FMT_STR },
233 { XX("lestring16"), FILE_LESTRING16, FILE_FMT_STR },
234 { XX("search"), FILE_SEARCH, FILE_FMT_STR },
235 { XX("medate"), FILE_MEDATE, FILE_FMT_STR },
236 { XX("meldate"), FILE_MELDATE, FILE_FMT_STR },
237 { XX("melong"), FILE_MELONG, FILE_FMT_NUM },
238 { XX("quad"), FILE_QUAD, FILE_FMT_QUAD },
239 { XX("lequad"), FILE_LEQUAD, FILE_FMT_QUAD },
240 { XX("bequad"), FILE_BEQUAD, FILE_FMT_QUAD },
241 { XX("qdate"), FILE_QDATE, FILE_FMT_STR },
242 { XX("leqdate"), FILE_LEQDATE, FILE_FMT_STR },
243 { XX("beqdate"), FILE_BEQDATE, FILE_FMT_STR },
244 { XX("qldate"), FILE_QLDATE, FILE_FMT_STR },
245 { XX("leqldate"), FILE_LEQLDATE, FILE_FMT_STR },
246 { XX("beqldate"), FILE_BEQLDATE, FILE_FMT_STR },
247 { XX("float"), FILE_FLOAT, FILE_FMT_FLOAT },
248 { XX("befloat"), FILE_BEFLOAT, FILE_FMT_FLOAT },
249 { XX("lefloat"), FILE_LEFLOAT, FILE_FMT_FLOAT },
250 { XX("double"), FILE_DOUBLE, FILE_FMT_DOUBLE },
251 { XX("bedouble"), FILE_BEDOUBLE, FILE_FMT_DOUBLE },
252 { XX("ledouble"), FILE_LEDOUBLE, FILE_FMT_DOUBLE },
253 { XX("leid3"), FILE_LEID3, FILE_FMT_NUM },
254 { XX("beid3"), FILE_BEID3, FILE_FMT_NUM },
255 { XX("indirect"), FILE_INDIRECT, FILE_FMT_NUM },
256 { XX("qwdate"), FILE_QWDATE, FILE_FMT_STR },
257 { XX("leqwdate"), FILE_LEQWDATE, FILE_FMT_STR },
258 { XX("beqwdate"), FILE_BEQWDATE, FILE_FMT_STR },
259 { XX("name"), FILE_NAME, FILE_FMT_NONE },
260 { XX("use"), FILE_USE, FILE_FMT_NONE },
261 { XX("clear"), FILE_CLEAR, FILE_FMT_NONE },
262 { XX("der"), FILE_DER, FILE_FMT_STR },
263 { XX_NULL, FILE_INVALID, FILE_FMT_NONE },
267 * These are not types, and cannot be preceded by "u" to make them
270 static const struct type_tbl_s special_tbl[] = {
271 { XX("der"), FILE_DER, FILE_FMT_STR },
272 { XX("name"), FILE_NAME, FILE_FMT_STR },
273 { XX("use"), FILE_USE, FILE_FMT_STR },
274 { XX_NULL, FILE_INVALID, FILE_FMT_NONE },
280 get_type(const struct type_tbl_s *tbl, const char *l, const char **t)
282 const struct type_tbl_s *p;
284 for (p = tbl; p->len; p++) {
285 if (strncmp(l, p->name, p->len) == 0) {
296 if (/*CONSTCOND*/sizeof(off_t) == sizeof(int))
297 return CAST(off_t, INT_MAX);
298 if (/*CONSTCOND*/sizeof(off_t) == sizeof(long))
299 return CAST(off_t, LONG_MAX);
304 get_standard_integer_type(const char *l, const char **t)
308 if (isalpha(CAST(unsigned char, l[1]))) {
321 * "dI", "dL", "uI", and "uL".
323 * XXX - the actual Single UNIX Specification says
324 * that "L" means "long", as in the C data type,
325 * but we treat it as meaning "4-byte integer".
326 * Given that the OS X version of file 5.04 did
327 * the same, I guess that passes the actual SUS
328 * validation suite; having "dL" be dependent on
329 * how big a "long" is on the machine running
339 /* "d{anything else}", "u{anything else}" */
343 } else if (isdigit(CAST(unsigned char, l[1]))) {
345 * "d{num}" and "u{num}"; we only support {num} values
346 * of 1, 2, 4, and 8 - the Single UNIX Specification
347 * doesn't say anything about whether arbitrary
348 * values should be supported, but both the Solaris 10
349 * and OS X Mountain Lion versions of file passed the
350 * Single UNIX Specification validation suite, and
351 * neither of them support values bigger than 8 or
352 * non-power-of-2 values.
354 if (isdigit(CAST(unsigned char, l[2]))) {
355 /* Multi-digit, so > 9 */
372 /* XXX - what about 3, 5, 6, or 7? */
378 * "d" or "u" by itself.
389 init_file_tables(void)
392 const struct type_tbl_s *p;
398 for (p = type_tbl; p->len; p++) {
399 assert(p->type < FILE_NAMES_SIZE);
400 file_names[p->type] = p->name;
401 file_formats[p->type] = p->format;
403 assert(p - type_tbl == FILE_NAMES_SIZE);
407 add_mlist(struct mlist *mlp, struct magic_map *map, size_t idx)
412 if ((ml = CAST(struct mlist *, malloc(sizeof(*ml)))) == NULL)
415 ml->map = idx == 0 ? map : NULL;
416 ml->magic = map->magic[idx];
417 ml->nmagic = map->nmagic[idx];
419 mlp->prev->next = ml;
420 ml->prev = mlp->prev;
427 * Handle one file or directory.
430 apprentice_1(struct magic_set *ms, const char *fn, int action)
432 struct magic_map *map;
438 if (magicsize != FILE_MAGICSIZE) {
439 file_error(ms, 0, "magic element size %lu != %lu",
440 CAST(unsigned long, sizeof(*map->magic[0])),
441 CAST(unsigned long, FILE_MAGICSIZE));
445 if (action == FILE_COMPILE) {
446 map = apprentice_load(ms, fn, action);
449 return apprentice_compile(ms, map, fn);
453 map = apprentice_map(ms, fn);
454 if (map == RCAST(struct magic_map *, -1))
457 if (ms->flags & MAGIC_CHECK)
458 file_magwarn(ms, "using regular magic file `%s'", fn);
459 map = apprentice_load(ms, fn, action);
464 for (i = 0; i < MAGIC_SETS; i++) {
465 if (add_mlist(ms->mlist[i], map, i) == -1) {
466 file_oomem(ms, sizeof(*ml));
471 if (action == FILE_LIST) {
472 for (i = 0; i < MAGIC_SETS; i++) {
473 printf("Set %" SIZE_T_FORMAT "u:\nBinary patterns:\n",
475 apprentice_list(ms->mlist[i], BINTEST);
476 printf("Text patterns:\n");
477 apprentice_list(ms->mlist[i], TEXTTEST);
483 #endif /* COMPILE_ONLY */
487 file_ms_free(struct magic_set *ms)
492 for (i = 0; i < MAGIC_SETS; i++)
493 mlist_free(ms->mlist[i]);
500 protected struct magic_set *
501 file_ms_alloc(int flags)
503 struct magic_set *ms;
506 if ((ms = CAST(struct magic_set *, calloc(CAST(size_t, 1u),
507 sizeof(struct magic_set)))) == NULL)
510 if (magic_setflags(ms, flags) == -1) {
515 ms->o.buf = ms->o.pbuf = NULL;
516 len = (ms->c.len = 10) * sizeof(*ms->c.li);
518 if ((ms->c.li = CAST(struct level_info *, malloc(len))) == NULL)
523 for (i = 0; i < MAGIC_SETS; i++)
525 ms->file = "unknown";
527 ms->indir_max = FILE_INDIR_MAX;
528 ms->name_max = FILE_NAME_MAX;
529 ms->elf_shnum_max = FILE_ELF_SHNUM_MAX;
530 ms->elf_phnum_max = FILE_ELF_PHNUM_MAX;
531 ms->elf_notes_max = FILE_ELF_NOTES_MAX;
532 ms->regex_max = FILE_REGEX_MAX;
533 ms->bytes_max = FILE_BYTES_MAX;
541 apprentice_unmap(struct magic_map *map)
550 case MAP_TYPE_MALLOC:
551 for (i = 0; i < MAGIC_SETS; i++) {
552 void *b = map->magic[i];
554 if (CAST(char *, b) >= CAST(char *, p) &&
555 CAST(char *, b) <= CAST(char *, p) + map->len)
563 if (map->p && map->p != MAP_FAILED)
564 (void)munmap(map->p, map->len);
573 private struct mlist *
577 if ((mlist = CAST(struct mlist *, calloc(1, sizeof(*mlist)))) == NULL) {
580 mlist->next = mlist->prev = mlist;
585 mlist_free_one(struct mlist *ml)
588 apprentice_unmap(CAST(struct magic_map *, ml->map));
593 mlist_free(struct mlist *mlist)
595 struct mlist *ml, *next;
600 for (ml = mlist->next; ml != mlist; ml = next) {
604 mlist_free_one(mlist);
608 /* void **bufs: an array of compiled magic files */
610 buffer_apprentice(struct magic_set *ms, struct magic **bufs,
611 size_t *sizes, size_t nbufs)
615 struct magic_map *map;
620 (void)file_reset(ms, 0);
624 for (i = 0; i < MAGIC_SETS; i++) {
625 mlist_free(ms->mlist[i]);
626 if ((ms->mlist[i] = mlist_alloc()) == NULL) {
627 file_oomem(ms, sizeof(*ms->mlist[i]));
632 for (i = 0; i < nbufs; i++) {
633 map = apprentice_buf(ms, bufs[i], sizes[i]);
637 for (j = 0; j < MAGIC_SETS; j++) {
638 if (add_mlist(ms->mlist[j], map, j) == -1) {
639 file_oomem(ms, sizeof(*ml));
647 for (i = 0; i < MAGIC_SETS; i++) {
648 mlist_free(ms->mlist[i]);
655 /* const char *fn: list of magic files and directories */
657 file_apprentice(struct magic_set *ms, const char *fn, int action)
660 int fileerr, errs = -1;
663 (void)file_reset(ms, 0);
665 if ((fn = magic_getpath(fn, action)) == NULL)
670 if ((mfn = strdup(fn)) == NULL) {
671 file_oomem(ms, strlen(fn));
675 for (i = 0; i < MAGIC_SETS; i++) {
676 mlist_free(ms->mlist[i]);
677 if ((ms->mlist[i] = mlist_alloc()) == NULL) {
678 file_oomem(ms, sizeof(*ms->mlist[i]));
680 mlist_free(ms->mlist[i]);
690 p = strchr(fn, PATHSEP);
695 fileerr = apprentice_1(ms, fn, action);
696 errs = MAX(errs, fileerr);
703 for (i = 0; i < MAGIC_SETS; i++) {
704 mlist_free(ms->mlist[i]);
707 file_error(ms, 0, "could not find any valid magic files!");
713 * Always leave the database loaded
715 if (action == FILE_LOAD)
718 for (i = 0; i < MAGIC_SETS; i++) {
719 mlist_free(ms->mlist[i]);
731 file_error(ms, 0, "Invalid action %d", action);
737 * Compute the real length of a magic expression, for the purposes
738 * of determining how "strong" a magic expression is (approximating
739 * how specific its matches are):
740 * - magic characters count 0 unless escaped.
741 * - [] expressions count 1
742 * - {} expressions count 0
743 * - regular characters or escaped magic characters count 1
744 * - 0 length expressions count as one
747 nonmagic(const char *str)
752 for (p = str; *p; p++)
754 case '\\': /* Escaped anything counts 1 */
759 case '?': /* Magic characters count 0 */
766 case '[': /* Bracketed expressions count 1 the ']' */
767 while (*p && *p != ']')
771 case '{': /* Braced expressions count 0 */
772 while (*p && *p != '}')
777 default: /* Anything else counts 1 */
782 return rv == 0 ? 1 : rv; /* Return at least 1 */
834 return CAST(size_t, ~0);
839 * Get weight of this magic entry, for sorting purposes.
842 apprentice_magic_strength(const struct magic *m)
846 ssize_t val = 2 * MULT; /* baseline strength */
849 case FILE_DEFAULT: /* make sure this sorts last */
850 if (m->factor_op != FILE_FACTOR_OP_NONE)
888 ts = typesize(m->type);
889 if (ts == CAST(size_t, ~0))
896 val += m->vallen * MULT;
899 case FILE_BESTRING16:
900 case FILE_LESTRING16:
901 val += m->vallen * MULT / 2;
907 val += m->vallen * MAX(MULT / m->vallen, 1);
911 v = nonmagic(m->value.s);
912 val += v * MAX(MULT / v, 1);
925 (void)fprintf(stderr, "Bad type %d\n", m->type);
930 case 'x': /* matches anything penalize */
931 case '!': /* matches almost anything penalize */
935 case '=': /* Exact match, prefer */
940 case '<': /* comparison match reduce strength */
945 case '&': /* masking bits, we could count them too */
950 (void)fprintf(stderr, "Bad relation %c\n", m->reln);
954 switch (m->factor_op) {
955 case FILE_FACTOR_OP_NONE:
957 case FILE_FACTOR_OP_PLUS:
960 case FILE_FACTOR_OP_MINUS:
963 case FILE_FACTOR_OP_TIMES:
966 case FILE_FACTOR_OP_DIV:
973 if (val <= 0) /* ensure we only return 0 for FILE_DEFAULT */
977 * Magic entries with no description get a bonus because they depend
978 * on subsequent magic entries to print something.
980 if (m->desc[0] == '\0')
986 * Sort callback for sorting entries by "strength" (basically length)
989 apprentice_sort(const void *a, const void *b)
991 const struct magic_entry *ma = CAST(const struct magic_entry *, a);
992 const struct magic_entry *mb = CAST(const struct magic_entry *, b);
993 size_t sa = apprentice_magic_strength(ma->mp);
994 size_t sb = apprentice_magic_strength(mb->mp);
1004 * Shows sorted patterns list in the order which is used for the matching
1007 apprentice_list(struct mlist *mlist, int mode)
1009 uint32_t magindex = 0;
1011 for (ml = mlist->next; ml != mlist; ml = ml->next) {
1012 for (magindex = 0; magindex < ml->nmagic; magindex++) {
1013 struct magic *m = &ml->magic[magindex];
1014 if ((m->flag & mode) != mode) {
1015 /* Skip sub-tests */
1016 while (magindex + 1 < ml->nmagic &&
1017 ml->magic[magindex + 1].cont_level != 0)
1019 continue; /* Skip to next top-level test*/
1023 * Try to iterate over the tree until we find item with
1024 * description/mimetype.
1026 while (magindex + 1 < ml->nmagic &&
1027 ml->magic[magindex + 1].cont_level != 0 &&
1028 *ml->magic[magindex].desc == '\0' &&
1029 *ml->magic[magindex].mimetype == '\0')
1032 printf("Strength = %3" SIZE_T_FORMAT "u@%u: %s [%s]\n",
1033 apprentice_magic_strength(m),
1034 ml->magic[magindex].lineno,
1035 ml->magic[magindex].desc,
1036 ml->magic[magindex].mimetype);
1042 set_test_type(struct magic *mstart, struct magic *m)
1080 mstart->flag |= BINTEST;
1084 case FILE_BESTRING16:
1085 case FILE_LESTRING16:
1086 /* Allow text overrides */
1087 if (mstart->str_flags & STRING_TEXTTEST)
1088 mstart->flag |= TEXTTEST;
1090 mstart->flag |= BINTEST;
1094 /* Check for override */
1095 if (mstart->str_flags & STRING_BINTEST)
1096 mstart->flag |= BINTEST;
1097 if (mstart->str_flags & STRING_TEXTTEST)
1098 mstart->flag |= TEXTTEST;
1100 if (mstart->flag & (TEXTTEST|BINTEST))
1103 /* binary test if pattern is not text */
1104 if (file_looks_utf8(m->value.us, CAST(size_t, m->vallen), NULL,
1106 mstart->flag |= BINTEST;
1108 mstart->flag |= TEXTTEST;
1111 /* can't deduce anything; we shouldn't see this at the
1116 /* invalid search type, but no need to complain here */
1122 addentry(struct magic_set *ms, struct magic_entry *me,
1123 struct magic_entry_set *mset)
1125 size_t i = me->mp->type == FILE_NAME ? 1 : 0;
1126 if (mset[i].count == mset[i].max) {
1127 struct magic_entry *mp;
1129 mset[i].max += ALLOC_INCR;
1130 if ((mp = CAST(struct magic_entry *,
1131 realloc(mset[i].me, sizeof(*mp) * mset[i].max))) ==
1133 file_oomem(ms, sizeof(*mp) * mset[i].max);
1136 (void)memset(&mp[mset[i].count], 0, sizeof(*mp) *
1140 mset[i].me[mset[i].count++] = *me;
1141 memset(me, 0, sizeof(*me));
1146 * Load and parse one file.
1149 load_1(struct magic_set *ms, int action, const char *fn, int *errs,
1150 struct magic_entry_set *mset)
1152 size_t lineno = 0, llen = 0;
1155 struct magic_entry me;
1157 FILE *f = fopen(ms->file = fn, "r");
1159 if (errno != ENOENT)
1160 file_error(ms, errno, "cannot read magic file `%s'",
1166 memset(&me, 0, sizeof(me));
1167 /* read and parse this file */
1168 for (ms->line = 1; (len = getline(&line, &llen, f)) != -1;
1170 if (len == 0) /* null line, garbage, etc */
1172 if (line[len - 1] == '\n') {
1174 line[len - 1] = '\0'; /* delete newline */
1177 case '\0': /* empty, do not parse */
1178 case '#': /* comment, do not parse */
1181 if (line[1] == ':') {
1184 for (i = 0; bang[i].name != NULL; i++) {
1185 if (CAST(size_t, len - 2) > bang[i].len &&
1186 memcmp(bang[i].name, line + 2,
1190 if (bang[i].name == NULL) {
1192 "Unknown !: entry `%s'", line);
1196 if (me.mp == NULL) {
1198 "No current entry for :!%s type",
1203 if ((*bang[i].fun)(ms, &me,
1204 line + bang[i].len + 2) != 0) {
1213 switch (parse(ms, &me, line, lineno, action)) {
1217 (void)addentry(ms, &me, mset);
1226 (void)addentry(ms, &me, mset);
1232 * parse a file or directory of files
1233 * const char *fn: name of magic file or directory
1236 cmpstrp(const void *p1, const void *p2)
1238 return strcmp(*RCAST(char *const *, p1), *RCAST(char *const *, p2));
1243 set_text_binary(struct magic_set *ms, struct magic_entry *me, uint32_t nme,
1246 static const char text[] = "text";
1247 static const char binary[] = "binary";
1248 static const size_t len = sizeof(text);
1250 uint32_t i = starttest;
1253 set_test_type(me[starttest].mp, me[i].mp);
1254 if ((ms->flags & MAGIC_DEBUG) == 0)
1256 (void)fprintf(stderr, "%s%s%s: %s\n",
1258 me[i].mp->mimetype[0] == '\0' ? "" : "; ",
1259 me[i].mp->desc[0] ? me[i].mp->desc : "(no description)",
1260 me[i].mp->flag & BINTEST ? binary : text);
1261 if (me[i].mp->flag & BINTEST) {
1262 char *p = strstr(me[i].mp->desc, text);
1263 if (p && (p == me[i].mp->desc ||
1264 isspace(CAST(unsigned char, p[-1]))) &&
1265 (p + len - me[i].mp->desc == MAXstring
1266 || (p[len] == '\0' ||
1267 isspace(CAST(unsigned char, p[len])))))
1268 (void)fprintf(stderr, "*** Possible "
1269 "binary test for text type\n");
1271 } while (++i < nme && me[i].mp->cont_level != 0);
1276 set_last_default(struct magic_set *ms, struct magic_entry *me, uint32_t nme)
1279 for (i = 0; i < nme; i++) {
1280 if (me[i].mp->cont_level == 0 &&
1281 me[i].mp->type == FILE_DEFAULT) {
1283 if (me[i].mp->cont_level == 0)
1287 ms->line = me[i].mp->lineno;
1289 "level 0 \"default\" did not sort last");
1297 coalesce_entries(struct magic_set *ms, struct magic_entry *me, uint32_t nme,
1298 struct magic **ma, uint32_t *nma)
1300 uint32_t i, mentrycount = 0;
1303 for (i = 0; i < nme; i++)
1304 mentrycount += me[i].cont_count;
1306 slen = sizeof(**ma) * mentrycount;
1307 if ((*ma = CAST(struct magic *, malloc(slen))) == NULL) {
1308 file_oomem(ms, slen);
1313 for (i = 0; i < nme; i++) {
1314 (void)memcpy(*ma + mentrycount, me[i].mp,
1315 me[i].cont_count * sizeof(**ma));
1316 mentrycount += me[i].cont_count;
1323 magic_entry_free(struct magic_entry *me, uint32_t nme)
1328 for (i = 0; i < nme; i++)
1333 private struct magic_map *
1334 apprentice_load(struct magic_set *ms, const char *fn, int action)
1338 size_t files = 0, maxfiles = 0;
1339 char **filearr = NULL, *mfn;
1341 struct magic_map *map;
1342 struct magic_entry_set mset[MAGIC_SETS];
1346 memset(mset, 0, sizeof(mset));
1347 ms->flags |= MAGIC_CHECK; /* Enable checks for parsed files */
1350 if ((map = CAST(struct magic_map *, calloc(1, sizeof(*map)))) == NULL)
1352 file_oomem(ms, sizeof(*map));
1355 map->type = MAP_TYPE_MALLOC;
1357 /* print silly verbose header for USG compat. */
1358 if (action == FILE_CHECK)
1359 (void)fprintf(stderr, "%s\n", usg_hdr);
1361 /* load directory or file */
1362 if (stat(fn, &st) == 0 && S_ISDIR(st.st_mode)) {
1368 while ((d = readdir(dir)) != NULL) {
1369 if (d->d_name[0] == '.')
1371 if (asprintf(&mfn, "%s/%s", fn, d->d_name) < 0) {
1373 strlen(fn) + strlen(d->d_name) + 2);
1378 if (stat(mfn, &st) == -1 || !S_ISREG(st.st_mode)) {
1382 if (files >= maxfiles) {
1384 maxfiles = (maxfiles + 1) * 2;
1385 mlen = maxfiles * sizeof(*filearr);
1386 if ((filearr = CAST(char **,
1387 realloc(filearr, mlen))) == NULL) {
1388 file_oomem(ms, mlen);
1395 filearr[files++] = mfn;
1399 qsort(filearr, files, sizeof(*filearr), cmpstrp);
1400 for (i = 0; i < files; i++) {
1401 load_1(ms, action, filearr[i], &errs, mset);
1407 load_1(ms, action, fn, &errs, mset);
1411 for (j = 0; j < MAGIC_SETS; j++) {
1412 /* Set types of tests */
1413 for (i = 0; i < mset[j].count; ) {
1414 if (mset[j].me[i].mp->cont_level != 0) {
1418 i = set_text_binary(ms, mset[j].me, mset[j].count, i);
1421 qsort(mset[j].me, mset[j].count, sizeof(*mset[j].me),
1425 * Make sure that any level 0 "default" line is last
1428 set_last_default(ms, mset[j].me, mset[j].count);
1430 /* coalesce per file arrays into a single one */
1431 if (coalesce_entries(ms, mset[j].me, mset[j].count,
1432 &map->magic[j], &map->nmagic[j]) == -1) {
1439 for (j = 0; j < MAGIC_SETS; j++)
1440 magic_entry_free(mset[j].me, mset[j].count);
1443 apprentice_unmap(map);
1450 * extend the sign bit if the comparison is to be signed
1453 file_signextend(struct magic_set *ms, struct magic *m, uint64_t v)
1455 if (!(m->flag & UNSIGNED)) {
1458 * Do not remove the casts below. They are
1459 * vital. When later compared with the data,
1460 * the sign extension must have happened.
1463 v = CAST(signed char, v);
1485 v = CAST(int32_t, v);
1502 v = CAST(int64_t, v);
1506 case FILE_BESTRING16:
1507 case FILE_LESTRING16:
1518 if (ms->flags & MAGIC_CHECK)
1519 file_magwarn(ms, "cannot happen: m->type=%d\n",
1528 string_modifier_check(struct magic_set *ms, struct magic *m)
1530 if ((ms->flags & MAGIC_CHECK) == 0)
1533 if ((m->type != FILE_REGEX || (m->str_flags & REGEX_LINE_COUNT) == 0) &&
1534 (m->type != FILE_PSTRING && (m->str_flags & PSTRING_LEN) != 0)) {
1536 "'/BHhLl' modifiers are only allowed for pascal strings\n");
1540 case FILE_BESTRING16:
1541 case FILE_LESTRING16:
1542 if (m->str_flags != 0) {
1544 "no modifiers allowed for 16-bit strings\n");
1550 if ((m->str_flags & REGEX_OFFSET_START) != 0) {
1552 "'/%c' only allowed on regex and search\n",
1553 CHAR_REGEX_OFFSET_START);
1558 if (m->str_range == 0) {
1560 "missing range; defaulting to %d\n",
1561 STRING_DEFAULT_RANGE);
1562 m->str_range = STRING_DEFAULT_RANGE;
1567 if ((m->str_flags & STRING_COMPACT_WHITESPACE) != 0) {
1568 file_magwarn(ms, "'/%c' not allowed on regex\n",
1569 CHAR_COMPACT_WHITESPACE);
1572 if ((m->str_flags & STRING_COMPACT_OPTIONAL_WHITESPACE) != 0) {
1573 file_magwarn(ms, "'/%c' not allowed on regex\n",
1574 CHAR_COMPACT_OPTIONAL_WHITESPACE);
1579 file_magwarn(ms, "coding error: m->type=%d\n",
1599 return FILE_OPMINUS;
1601 return FILE_OPMULTIPLY;
1603 return FILE_OPDIVIDE;
1605 return FILE_OPMODULO;
1611 #ifdef ENABLE_CONDITIONALS
1613 get_cond(const char *l, const char **t)
1615 static const struct cond_tbl_s {
1620 { "if", 2, COND_IF },
1621 { "elif", 4, COND_ELIF },
1622 { "else", 4, COND_ELSE },
1623 { "", 0, COND_NONE },
1625 const struct cond_tbl_s *p;
1627 for (p = cond_tbl; p->len; p++) {
1628 if (strncmp(l, p->name, p->len) == 0 &&
1629 isspace(CAST(unsigned char, l[p->len]))) {
1639 check_cond(struct magic_set *ms, int cond, uint32_t cont_level)
1642 last_cond = ms->c.li[cont_level].last_cond;
1646 if (last_cond != COND_NONE && last_cond != COND_ELIF) {
1647 if (ms->flags & MAGIC_CHECK)
1648 file_magwarn(ms, "syntax error: `if'");
1651 last_cond = COND_IF;
1655 if (last_cond != COND_IF && last_cond != COND_ELIF) {
1656 if (ms->flags & MAGIC_CHECK)
1657 file_magwarn(ms, "syntax error: `elif'");
1660 last_cond = COND_ELIF;
1664 if (last_cond != COND_IF && last_cond != COND_ELIF) {
1665 if (ms->flags & MAGIC_CHECK)
1666 file_magwarn(ms, "syntax error: `else'");
1669 last_cond = COND_NONE;
1673 last_cond = COND_NONE;
1677 ms->c.li[cont_level].last_cond = last_cond;
1680 #endif /* ENABLE_CONDITIONALS */
1683 parse_indirect_modifier(struct magic_set *ms, struct magic *m, const char **lp)
1685 const char *l = *lp;
1687 while (!isspace(CAST(unsigned char, *++l)))
1689 case CHAR_INDIRECT_RELATIVE:
1690 m->str_flags |= INDIRECT_RELATIVE;
1693 if (ms->flags & MAGIC_CHECK)
1694 file_magwarn(ms, "indirect modifier `%c' "
1704 parse_op_modifier(struct magic_set *ms, struct magic *m, const char **lp,
1707 const char *l = *lp;
1713 val = CAST(uint64_t, strtoull(l, &t, 0));
1715 m->num_mask = file_signextend(ms, m, val);
1721 parse_string_modifier(struct magic_set *ms, struct magic *m, const char **lp)
1723 const char *l = *lp;
1727 while (!isspace(CAST(unsigned char, *++l))) {
1729 case '0': case '1': case '2':
1730 case '3': case '4': case '5':
1731 case '6': case '7': case '8':
1733 if (have_range && (ms->flags & MAGIC_CHECK))
1734 file_magwarn(ms, "multiple ranges");
1736 m->str_range = CAST(uint32_t, strtoul(l, &t, 0));
1737 if (m->str_range == 0)
1738 file_magwarn(ms, "zero range");
1741 case CHAR_COMPACT_WHITESPACE:
1742 m->str_flags |= STRING_COMPACT_WHITESPACE;
1744 case CHAR_COMPACT_OPTIONAL_WHITESPACE:
1745 m->str_flags |= STRING_COMPACT_OPTIONAL_WHITESPACE;
1747 case CHAR_IGNORE_LOWERCASE:
1748 m->str_flags |= STRING_IGNORE_LOWERCASE;
1750 case CHAR_IGNORE_UPPERCASE:
1751 m->str_flags |= STRING_IGNORE_UPPERCASE;
1753 case CHAR_REGEX_OFFSET_START:
1754 m->str_flags |= REGEX_OFFSET_START;
1757 m->str_flags |= STRING_BINTEST;
1760 m->str_flags |= STRING_TEXTTEST;
1763 m->str_flags |= STRING_TRIM;
1765 case CHAR_PSTRING_1_LE:
1766 #define SET_LENGTH(a) m->str_flags = (m->str_flags & ~PSTRING_LEN) | (a)
1767 if (m->type != FILE_PSTRING)
1769 SET_LENGTH(PSTRING_1_LE);
1771 case CHAR_PSTRING_2_BE:
1772 if (m->type != FILE_PSTRING)
1774 SET_LENGTH(PSTRING_2_BE);
1776 case CHAR_PSTRING_2_LE:
1777 if (m->type != FILE_PSTRING)
1779 SET_LENGTH(PSTRING_2_LE);
1781 case CHAR_PSTRING_4_BE:
1782 if (m->type != FILE_PSTRING)
1784 SET_LENGTH(PSTRING_4_BE);
1786 case CHAR_PSTRING_4_LE:
1794 SET_LENGTH(PSTRING_4_LE);
1796 case CHAR_PSTRING_LENGTH_INCLUDES_ITSELF:
1797 if (m->type != FILE_PSTRING)
1799 m->str_flags |= PSTRING_LENGTH_INCLUDES_ITSELF;
1803 if (ms->flags & MAGIC_CHECK)
1804 file_magwarn(ms, "string modifier `%c' "
1808 /* allow multiple '/' for readability */
1809 if (l[1] == '/' && !isspace(CAST(unsigned char, l[2])))
1812 if (string_modifier_check(ms, m) == -1)
1822 * parse one line from magic file, put into magic[index++] if valid
1825 parse(struct magic_set *ms, struct magic_entry *me, const char *line,
1826 size_t lineno, int action)
1828 #ifdef ENABLE_CONDITIONALS
1829 static uint32_t last_cont_level = 0;
1833 const char *l = line;
1836 uint32_t cont_level;
1845 ++l; /* step over */
1848 #ifdef ENABLE_CONDITIONALS
1849 if (cont_level == 0 || cont_level > last_cont_level)
1850 if (file_check_mem(ms, cont_level) == -1)
1852 last_cont_level = cont_level;
1854 if (cont_level != 0) {
1855 if (me->mp == NULL) {
1856 file_magerror(ms, "No current entry for continuation");
1859 if (me->cont_count == 0) {
1860 file_magerror(ms, "Continuations present with 0 count");
1863 m = &me->mp[me->cont_count - 1];
1864 diff = CAST(int32_t, cont_level) - CAST(int32_t, m->cont_level);
1866 file_magwarn(ms, "New continuation level %u is more "
1867 "than one larger than current level %u", cont_level,
1869 if (me->cont_count == me->max_count) {
1871 size_t cnt = me->max_count + ALLOC_CHUNK;
1872 if ((nm = CAST(struct magic *, realloc(me->mp,
1873 sizeof(*nm) * cnt))) == NULL) {
1874 file_oomem(ms, sizeof(*nm) * cnt);
1878 me->max_count = CAST(uint32_t, cnt);
1880 m = &me->mp[me->cont_count++];
1881 (void)memset(m, 0, sizeof(*m));
1882 m->cont_level = cont_level;
1884 static const size_t len = sizeof(*m) * ALLOC_CHUNK;
1887 if ((m = CAST(struct magic *, malloc(len))) == NULL) {
1888 file_oomem(ms, len);
1892 me->max_count = ALLOC_CHUNK;
1893 (void)memset(m, 0, sizeof(*m));
1894 m->factor_op = FILE_FACTOR_OP_NONE;
1898 m->lineno = CAST(uint32_t, lineno);
1900 if (*l == '&') { /* m->cont_level == 0 checked below. */
1901 ++l; /* step over */
1905 ++l; /* step over */
1907 if (m->flag & OFFADD)
1908 m->flag = (m->flag & ~OFFADD) | INDIROFFADD;
1910 if (*l == '&') { /* m->cont_level == 0 checked below */
1911 ++l; /* step over */
1915 /* Indirect offsets are not valid at level 0. */
1916 if (m->cont_level == 0 && (m->flag & (OFFADD | INDIROFFADD))) {
1917 if (ms->flags & MAGIC_CHECK)
1918 file_magwarn(ms, "relative offset at level 0");
1922 /* get offset, then skip over it */
1923 m->offset = CAST(int32_t, strtol(l, &t, 0));
1925 if (ms->flags & MAGIC_CHECK)
1926 file_magwarn(ms, "offset `%s' invalid", l);
1930 if (m->offset < 0 && cont_level != 0 &&
1931 (m->flag & (OFFADD | INDIROFFADD)) == 0) {
1932 if (ms->flags & MAGIC_CHECK) {
1934 "negative direct offset `%s' at level %u",
1942 if (m->flag & INDIR) {
1943 m->in_type = FILE_LONG;
1947 * read [.,lbs][+-]nnnnn)
1949 if (*l == '.' || *l == ',') {
1951 m->in_op |= FILE_OPSIGNED;
1955 m->in_type = FILE_LELONG;
1958 m->in_type = FILE_BELONG;
1961 m->in_type = FILE_MELONG;
1965 m->in_type = FILE_LESHORT;
1969 m->in_type = FILE_BESHORT;
1975 m->in_type = FILE_BYTE;
1980 m->in_type = FILE_LEDOUBLE;
1985 m->in_type = FILE_BEDOUBLE;
1988 m->in_type = FILE_LEID3;
1991 m->in_type = FILE_BEID3;
1994 m->in_type = FILE_LEQUAD;
1997 m->in_type = FILE_BEQUAD;
2000 if (ms->flags & MAGIC_CHECK)
2002 "indirect offset type `%c' invalid",
2010 m->in_op |= FILE_OPINVERSE;
2013 if ((op = get_op(*l)) != -1) {
2018 m->in_op |= FILE_OPINDIRECT;
2021 if (isdigit(CAST(unsigned char, *l)) || *l == '-') {
2022 m->in_offset = CAST(int32_t, strtol(l, &t, 0));
2024 if (ms->flags & MAGIC_CHECK)
2026 "in_offset `%s' invalid", l);
2032 ((m->in_op & FILE_OPINDIRECT) && *l++ != ')')) {
2033 if (ms->flags & MAGIC_CHECK)
2035 "missing ')' in indirect offset");
2041 #ifdef ENABLE_CONDITIONALS
2042 m->cond = get_cond(l, &l);
2043 if (check_cond(ms, m->cond, cont_level) == -1)
2054 * Try it as a keyword type prefixed by "u"; match what
2055 * follows the "u". If that fails, try it as an SUS
2058 m->type = get_type(type_tbl, l + 1, &l);
2059 if (m->type == FILE_INVALID) {
2061 * Not a keyword type; parse it as an SUS type,
2062 * 'u' possibly followed by a number or C/S/L.
2064 m->type = get_standard_integer_type(l, &l);
2066 /* It's unsigned. */
2067 if (m->type != FILE_INVALID)
2068 m->flag |= UNSIGNED;
2071 * Try it as a keyword type. If that fails, try it as
2072 * an SUS integer type if it begins with "d" or as an
2073 * SUS string type if it begins with "s". In any case,
2074 * it's not unsigned.
2076 m->type = get_type(type_tbl, l, &l);
2077 if (m->type == FILE_INVALID) {
2079 * Not a keyword type; parse it as an SUS type,
2080 * either 'd' possibly followed by a number or
2081 * C/S/L, or just 's'.
2084 m->type = get_standard_integer_type(l, &l);
2086 && !isalpha(CAST(unsigned char, l[1]))) {
2087 m->type = FILE_STRING;
2093 if (m->type == FILE_INVALID) {
2094 /* Not found - try it as a special keyword. */
2095 m->type = get_type(special_tbl, l, &l);
2098 if (m->type == FILE_INVALID) {
2099 if (ms->flags & MAGIC_CHECK)
2100 file_magwarn(ms, "type `%s' invalid", l);
2104 /* New-style anding: "0 byte&0x80 =0x80 dynamically linked" */
2105 /* New and improved: ~ & | ^ + - * / % -- exciting, isn't it? */
2109 if (!IS_STRING(m->type))
2110 m->mask_op |= FILE_OPINVERSE;
2111 else if (ms->flags & MAGIC_CHECK)
2112 file_magwarn(ms, "'~' invalid for string types");
2116 m->str_flags = m->type == FILE_PSTRING ? PSTRING_1_LE : 0;
2117 if ((op = get_op(*l)) != -1) {
2118 if (IS_STRING(m->type)) {
2121 if (op != FILE_OPDIVIDE) {
2122 if (ms->flags & MAGIC_CHECK)
2124 "invalid string/indirect op: "
2129 if (m->type == FILE_INDIRECT)
2130 r = parse_indirect_modifier(ms, m, &l);
2132 r = parse_string_modifier(ms, m, &l);
2136 parse_op_modifier(ms, m, &l, op);
2140 * We used to set mask to all 1's here, instead let's just not do
2141 * anything if mask = 0 (unless you have a better idea)
2151 if (ms->flags & MAGIC_CHECK) {
2152 file_magwarn(ms, "%c= not supported",
2159 /* Old-style anding: "0 byte &0x80 dynamically linked" */
2166 /* HP compat: ignore &= etc. */
2175 m->reln = '='; /* the default relation */
2176 if (*l == 'x' && ((isascii(CAST(unsigned char, l[1])) &&
2177 isspace(CAST(unsigned char, l[1]))) || !l[1])) {
2184 * Grab the value part, except for an 'x' reln.
2186 if (m->reln != 'x' && getvalue(ms, m, &l, action))
2190 * TODO finish this macro and start using it!
2191 * #define offsetcheck {if (offset > ms->bytes_max -1)
2192 * magwarn("offset too big"); }
2196 * Now get last part - the description
2202 } else if ((l[0] == '\\') && (l[1] == 'b')) {
2207 for (i = 0; (m->desc[i++] = *l++) != '\0' && i < sizeof(m->desc); )
2209 if (i == sizeof(m->desc)) {
2210 m->desc[sizeof(m->desc) - 1] = '\0';
2211 if (ms->flags & MAGIC_CHECK)
2212 file_magwarn(ms, "description `%s' truncated", m->desc);
2216 * We only do this check while compiling, or if any of the magic
2217 * files were not compiled.
2219 if (ms->flags & MAGIC_CHECK) {
2220 if (check_format(ms, m) == -1)
2223 #ifndef COMPILE_ONLY
2224 if (action == FILE_CHECK) {
2228 m->mimetype[0] = '\0'; /* initialise MIME type to none */
2233 * parse a STRENGTH annotation line from magic file, put into magic[index - 1]
2237 parse_strength(struct magic_set *ms, struct magic_entry *me, const char *line)
2239 const char *l = line;
2241 unsigned long factor;
2242 struct magic *m = &me->mp[0];
2244 if (m->factor_op != FILE_FACTOR_OP_NONE) {
2246 "Current entry already has a strength type: %c %d",
2247 m->factor_op, m->factor);
2250 if (m->type == FILE_NAME) {
2251 file_magwarn(ms, "%s: Strength setting is not supported in "
2252 "\"name\" magic entries", m->value.s);
2257 case FILE_FACTOR_OP_NONE:
2258 case FILE_FACTOR_OP_PLUS:
2259 case FILE_FACTOR_OP_MINUS:
2260 case FILE_FACTOR_OP_TIMES:
2261 case FILE_FACTOR_OP_DIV:
2262 m->factor_op = *l++;
2265 file_magwarn(ms, "Unknown factor op `%c'", *l);
2269 factor = strtoul(l, &el, 0);
2271 file_magwarn(ms, "Too large factor `%lu'", factor);
2274 if (*el && !isspace(CAST(unsigned char, *el))) {
2275 file_magwarn(ms, "Bad factor `%s'", l);
2278 m->factor = CAST(uint8_t, factor);
2279 if (m->factor == 0 && m->factor_op == FILE_FACTOR_OP_DIV) {
2280 file_magwarn(ms, "Cannot have factor op `%c' and factor %u",
2281 m->factor_op, m->factor);
2286 m->factor_op = FILE_FACTOR_OP_NONE;
2292 goodchar(unsigned char x, const char *extra)
2294 return (isascii(x) && isalnum(x)) || strchr(extra, x);
2298 parse_extra(struct magic_set *ms, struct magic_entry *me, const char *line,
2299 off_t off, size_t len, const char *name, const char *extra, int nt)
2302 const char *l = line;
2303 struct magic *m = &me->mp[me->cont_count == 0 ? 0 : me->cont_count - 1];
2304 char *buf = CAST(char *, CAST(void *, m)) + off;
2306 if (buf[0] != '\0') {
2307 len = nt ? strlen(buf) : len;
2308 file_magwarn(ms, "Current entry already has a %s type "
2309 "`%.*s', new type `%s'", name, CAST(int, len), buf, l);
2313 if (*m->desc == '\0') {
2314 file_magwarn(ms, "Current entry does not yet have a "
2315 "description for adding a %s type", name);
2320 for (i = 0; *l && i < len && goodchar(*l, extra); buf[i++] = *l++)
2323 if (i == len && *l) {
2325 buf[len - 1] = '\0';
2326 if (ms->flags & MAGIC_CHECK)
2327 file_magwarn(ms, "%s type `%s' truncated %"
2328 SIZE_T_FORMAT "u", name, line, i);
2330 if (!isspace(CAST(unsigned char, *l)) && !goodchar(*l, extra))
2331 file_magwarn(ms, "%s type `%s' has bad char '%c'",
2340 file_magerror(ms, "Bad magic entry '%s'", line);
2345 * Parse an Apple CREATOR/TYPE annotation from magic file and put it into
2349 parse_apple(struct magic_set *ms, struct magic_entry *me, const char *line)
2351 struct magic *m = &me->mp[0];
2353 return parse_extra(ms, me, line,
2354 CAST(off_t, offsetof(struct magic, apple)),
2355 sizeof(m->apple), "APPLE", "!+-./?", 0);
2359 * Parse a comma-separated list of extensions
2362 parse_ext(struct magic_set *ms, struct magic_entry *me, const char *line)
2364 struct magic *m = &me->mp[0];
2366 return parse_extra(ms, me, line,
2367 CAST(off_t, offsetof(struct magic, ext)),
2368 sizeof(m->ext), "EXTENSION", ",!+-/@?_$", 0);
2372 * parse a MIME annotation line from magic file, put into magic[index - 1]
2376 parse_mime(struct magic_set *ms, struct magic_entry *me, const char *line)
2378 struct magic *m = &me->mp[0];
2380 return parse_extra(ms, me, line,
2381 CAST(off_t, offsetof(struct magic, mimetype)),
2382 sizeof(m->mimetype), "MIME", "+-/.$?:{}", 1);
2386 check_format_type(const char *ptr, int type, const char **estr)
2391 /* Missing format string; bad */
2392 *estr = "missing format spec";
2396 switch (file_formats[type]) {
2431 #define CHECKLEN() do { \
2432 for (len = cnt = 0; isdigit(CAST(unsigned char, *ptr)); ptr++, cnt++) \
2433 len = len * 10 + (*ptr - '0'); \
2434 if (cnt > 5 || len > 1024) \
2436 } while (/*CONSTCOND*/0)
2450 #ifdef STRICT_FORMAT /* "long" formats are int formats for us */
2451 /* so don't accept the 'l' modifier */
2468 * Don't accept h and hh modifiers. They make writing
2469 * magic entries more complicated, for very little benefit
2512 #ifdef STRICT_FORMAT
2523 case FILE_FMT_FLOAT:
2524 case FILE_FMT_DOUBLE:
2550 while (isdigit(CAST(unsigned char, *ptr)))
2554 while (isdigit(CAST(unsigned char , *ptr)))
2566 /* internal error */
2570 *estr = "not valid";
2577 * Check that the optional printf format in description matches
2578 * the type of the magic.
2581 check_format(struct magic_set *ms, struct magic *m)
2586 for (ptr = m->desc; *ptr; ptr++)
2590 /* No format string; ok */
2594 assert(file_nformats == file_nnames);
2596 if (m->type >= file_nformats) {
2597 file_magwarn(ms, "Internal error inconsistency between "
2598 "m->type and format strings");
2601 if (file_formats[m->type] == FILE_FMT_NONE) {
2602 file_magwarn(ms, "No format string for `%s' with description "
2603 "`%s'", m->desc, file_names[m->type]);
2608 if (check_format_type(ptr, m->type, &estr) == -1) {
2610 * TODO: this error message is unhelpful if the format
2611 * string is not one character long
2613 file_magwarn(ms, "Printf format is %s for type "
2614 "`%s' in description `%s'", estr,
2615 file_names[m->type], m->desc);
2619 for (; *ptr; ptr++) {
2622 "Too many format strings (should have at most one) "
2623 "for `%s' with description `%s'",
2624 file_names[m->type], m->desc);
2632 * Read a numeric value from a pointer, into the value union of a magic
2633 * pointer, according to the magic type. Update the string pointer to point
2634 * just after the number read. Return 0 for success, non-zero for failure.
2637 getvalue(struct magic_set *ms, struct magic *m, const char **p, int action)
2643 case FILE_BESTRING16:
2644 case FILE_LESTRING16:
2652 *p = getstr(ms, m, *p, action == FILE_COMPILE);
2654 if (ms->flags & MAGIC_CHECK)
2655 file_magwarn(ms, "cannot get string from `%s'",
2659 if (m->type == FILE_REGEX) {
2661 int rc = file_regcomp(&rx, m->value.s, REG_EXTENDED);
2663 if (ms->flags & MAGIC_CHECK)
2664 file_regerror(&rx, rc, ms);
2682 m->value.f = strtof(*p, &ep);
2684 m->value.f = (float)strtod(*p, &ep);
2693 m->value.d = strtod(*p, &ep);
2699 ull = CAST(uint64_t, strtoull(*p, &ep, 0));
2700 m->value.q = file_signextend(ms, m, ull);
2702 file_magwarn(ms, "Unparseable number `%s'", *p);
2704 size_t ts = typesize(m->type);
2708 if (ts == CAST(size_t, ~0)) {
2710 "Expected numeric type got `%s'",
2711 type_tbl[m->type].name);
2713 for (q = *p; isspace(CAST(unsigned char, *q)); q++)
2716 ull = -CAST(int64_t, ull);
2719 x = CAST(uint64_t, ull & ~0xffULL);
2722 x = CAST(uint64_t, ull & ~0xffffULL);
2725 x = CAST(uint64_t, ull & ~0xffffffffULL);
2734 file_magwarn(ms, "Overflow for numeric"
2735 " type `%s' value %#" PRIx64,
2736 type_tbl[m->type].name, ull);
2748 * Convert a string containing C character escapes. Stop at an unescaped
2750 * Copy the converted version to "m->value.s", and the length in m->vallen.
2751 * Return updated scan pointer as function result. Warn if set.
2753 private const char *
2754 getstr(struct magic_set *ms, struct magic *m, const char *s, int warn)
2756 const char *origs = s;
2757 char *p = m->value.s;
2758 size_t plen = sizeof(m->value.s);
2760 char *pmax = p + plen - 1;
2764 while ((c = *s++) != '\0') {
2765 if (isspace(CAST(unsigned char, c)))
2768 file_error(ms, 0, "string too long: `%s'", origs);
2776 file_magwarn(ms, "incomplete escape");
2783 "escaped tab found, use \\t instead");
2784 warn = 0; /* already did */
2789 if (isprint(CAST(unsigned char, c))) {
2790 /* Allow escaping of
2792 if (strchr("<>&^=!", c) == NULL
2793 && (m->type != FILE_REGEX ||
2794 strchr("[]().*?^$|{}", c)
2796 file_magwarn(ms, "no "
2802 "unknown escape sequence: "
2807 /* space, perhaps force people to use \040? */
2811 * Other things people escape, but shouldn't need to,
2812 * so we disallow them
2825 /* and baskslash itself */
2827 *p++ = CAST(char, c);
2858 /* \ and up to 3 octal digits */
2868 c = *s++; /* try for 2 */
2869 if (c >= '0' && c <= '7') {
2870 val = (val << 3) | (c - '0');
2871 c = *s++; /* try for 3 */
2872 if (c >= '0' && c <= '7')
2873 val = (val << 3) | (c-'0');
2879 *p++ = CAST(char, val);
2882 /* \x and up to 2 hex digits */
2884 val = 'x'; /* Default if no digits */
2885 c = hextoint(*s++); /* Get next char */
2890 val = (val << 4) + c;
2895 *p++ = CAST(char, val);
2899 *p++ = CAST(char, c);
2904 m->vallen = CAST(unsigned char, (p - origp));
2905 if (m->type == FILE_PSTRING)
2906 m->vallen += CAST(unsigned char, file_pstring_length_size(m));
2911 /* Single hex char to int; -1 if not a hex char. */
2915 if (!isascii(CAST(unsigned char, c)))
2917 if (isdigit(CAST(unsigned char, c)))
2919 if ((c >= 'a') && (c <= 'f'))
2920 return c + 10 - 'a';
2921 if (( c>= 'A') && (c <= 'F'))
2922 return c + 10 - 'A';
2928 * Print a string containing C character escapes.
2931 file_showstr(FILE *fp, const char *s, size_t len)
2946 if (c >= 040 && c <= 0176) /* TODO isprint && !iscntrl */
2947 (void) fputc(c, fp);
2949 (void) fputc('\\', fp);
2952 (void) fputc('a', fp);
2956 (void) fputc('b', fp);
2960 (void) fputc('f', fp);
2964 (void) fputc('n', fp);
2968 (void) fputc('r', fp);
2972 (void) fputc('t', fp);
2976 (void) fputc('v', fp);
2980 (void) fprintf(fp, "%.3o", c & 0377);
2988 * eatsize(): Eat the size spec from a number [eg. 10UL]
2991 eatsize(const char **p)
2995 if (LOWCASE(*l) == 'u')
2998 switch (LOWCASE(*l)) {
2999 case 'l': /* long */
3000 case 's': /* short */
3001 case 'h': /* short */
3002 case 'b': /* char/byte */
3003 case 'c': /* char/byte */
3014 * handle a buffer containing a compiled file.
3016 private struct magic_map *
3017 apprentice_buf(struct magic_set *ms, struct magic *buf, size_t len)
3019 struct magic_map *map;
3021 if ((map = CAST(struct magic_map *, calloc(1, sizeof(*map)))) == NULL) {
3022 file_oomem(ms, sizeof(*map));
3027 map->type = MAP_TYPE_USER;
3028 if (check_buffer(ms, map, "buffer") != 0) {
3029 apprentice_unmap(map);
3036 * handle a compiled file.
3039 private struct magic_map *
3040 apprentice_map(struct magic_set *ms, const char *fn)
3044 char *dbname = NULL;
3045 struct magic_map *map;
3046 struct magic_map *rv = NULL;
3049 if ((map = CAST(struct magic_map *, calloc(1, sizeof(*map)))) == NULL) {
3050 file_oomem(ms, sizeof(*map));
3053 map->type = MAP_TYPE_USER; /* unspecified */
3055 dbname = mkdbname(ms, fn, 0);
3059 if ((fd = open(dbname, O_RDONLY|O_BINARY)) == -1)
3062 if (fstat(fd, &st) == -1) {
3063 file_error(ms, errno, "cannot stat `%s'", dbname);
3066 if (st.st_size < 8 || st.st_size > maxoff_t()) {
3067 file_error(ms, 0, "file `%s' is too %s", dbname,
3068 st.st_size < 8 ? "small" : "large");
3072 map->len = CAST(size_t, st.st_size);
3074 map->type = MAP_TYPE_MMAP;
3075 if ((map->p = mmap(0, CAST(size_t, st.st_size), PROT_READ|PROT_WRITE,
3076 MAP_PRIVATE|MAP_FILE, fd, CAST(off_t, 0))) == MAP_FAILED) {
3077 file_error(ms, errno, "cannot map `%s'", dbname);
3081 map->type = MAP_TYPE_MALLOC;
3082 if ((map->p = CAST(void *, malloc(map->len))) == NULL) {
3083 file_oomem(ms, map->len);
3086 if (read(fd, map->p, map->len) != (ssize_t)map->len) {
3095 if (check_buffer(ms, map, dbname) != 0) {
3096 rv = RCAST(struct magic_map *, -1);
3100 if (mprotect(map->p, CAST(size_t, st.st_size), PROT_READ) == -1) {
3101 file_error(ms, errno, "cannot mprotect `%s'", dbname);
3112 apprentice_unmap(map);
3118 check_buffer(struct magic_set *ms, struct magic_map *map, const char *dbname)
3121 uint32_t entries, nentries;
3123 int i, needsbyteswap;
3125 ptr = CAST(uint32_t *, map->p);
3126 if (*ptr != MAGICNO) {
3127 if (swap4(*ptr) != MAGICNO) {
3128 file_error(ms, 0, "bad magic in `%s'", dbname);
3135 version = swap4(ptr[1]);
3138 if (version != VERSIONNO) {
3139 file_error(ms, 0, "File %s supports only version %d magic "
3140 "files. `%s' is version %d", VERSION,
3141 VERSIONNO, dbname, version);
3144 entries = CAST(uint32_t, map->len / sizeof(struct magic));
3145 if ((entries * sizeof(struct magic)) != map->len) {
3146 file_error(ms, 0, "Size of `%s' %" SIZE_T_FORMAT "u is not "
3147 "a multiple of %" SIZE_T_FORMAT "u",
3148 dbname, map->len, sizeof(struct magic));
3151 map->magic[0] = CAST(struct magic *, map->p) + 1;
3153 for (i = 0; i < MAGIC_SETS; i++) {
3155 map->nmagic[i] = swap4(ptr[i + 2]);
3157 map->nmagic[i] = ptr[i + 2];
3158 if (i != MAGIC_SETS - 1)
3159 map->magic[i + 1] = map->magic[i] + map->nmagic[i];
3160 nentries += map->nmagic[i];
3162 if (entries != nentries + 1) {
3163 file_error(ms, 0, "Inconsistent entries in `%s' %u != %u",
3164 dbname, entries, nentries + 1);
3168 for (i = 0; i < MAGIC_SETS; i++)
3169 byteswap(map->magic[i], map->nmagic[i]);
3174 * handle an mmaped file.
3177 apprentice_compile(struct magic_set *ms, struct magic_map *map, const char *fn)
3179 static const size_t nm = sizeof(*map->nmagic) * MAGIC_SETS;
3180 static const size_t m = sizeof(**map->magic);
3188 uint32_t h[2 + MAGIC_SETS];
3191 dbname = mkdbname(ms, fn, 1);
3196 if ((fd = open(dbname, O_WRONLY|O_CREAT|O_TRUNC|O_BINARY, 0644)) == -1)
3198 file_error(ms, errno, "cannot open `%s'", dbname);
3201 memset(&hdr, 0, sizeof(hdr));
3203 hdr.h[1] = VERSIONNO;
3204 memcpy(hdr.h + 2, map->nmagic, nm);
3206 if (write(fd, &hdr, sizeof(hdr)) != CAST(ssize_t, sizeof(hdr))) {
3207 file_error(ms, errno, "error writing `%s'", dbname);
3211 for (i = 0; i < MAGIC_SETS; i++) {
3212 len = m * map->nmagic[i];
3213 if (write(fd, map->magic[i], len) != CAST(ssize_t, len)) {
3214 file_error(ms, errno, "error writing `%s'", dbname);
3224 apprentice_unmap(map);
3229 private const char ext[] = ".mgc";
3234 mkdbname(struct magic_set *ms, const char *fn, int strip)
3240 if ((p = strrchr(fn, '/')) != NULL)
3244 for (q = fn; *q; q++)
3247 for (p = ext + sizeof(ext) - 1; p >= ext && q >= fn; p--, q--)
3251 /* Did not find .mgc, restore q */
3257 /* Compatibility with old code that looked in .mime */
3258 if (ms->flags & MAGIC_MIME) {
3259 if (asprintf(&buf, "%.*s.mime%s", CAST(int, q - fn), fn, ext)
3262 if (access(buf, R_OK) != -1) {
3263 ms->flags &= MAGIC_MIME_TYPE;
3268 if (asprintf(&buf, "%.*s%s", CAST(int, q - fn), fn, ext) < 0)
3271 /* Compatibility with old code that looked in .mime */
3272 if (strstr(fn, ".mime") != NULL)
3273 ms->flags &= MAGIC_MIME_TYPE;
3278 * Byteswap an mmap'ed file if needed
3281 byteswap(struct magic *magic, uint32_t nmagic)
3284 for (i = 0; i < nmagic; i++)
3295 uint8_t *s = RCAST(uint8_t *, RCAST(void *, &sv));
3296 uint8_t *d = RCAST(uint8_t *, RCAST(void *, &rv));
3309 uint8_t *s = RCAST(uint8_t *, RCAST(void *, &sv));
3310 uint8_t *d = RCAST(uint8_t *, RCAST(void *, &rv));
3325 uint8_t *s = RCAST(uint8_t *, RCAST(void *, &sv));
3326 uint8_t *d = RCAST(uint8_t *, RCAST(void *, &rv));
3350 * byteswap a single magic entry
3353 bs1(struct magic *m)
3355 m->cont_level = swap2(m->cont_level);
3356 m->offset = swap4(CAST(uint32_t, m->offset));
3357 m->in_offset = swap4(CAST(uint32_t, m->in_offset));
3358 m->lineno = swap4(CAST(uint32_t, m->lineno));
3359 if (IS_STRING(m->type)) {
3360 m->str_range = swap4(m->str_range);
3361 m->str_flags = swap4(m->str_flags);
3364 m->value.q = swap8(m->value.q);
3365 m->num_mask = swap8(m->num_mask);
3370 file_pstring_length_size(const struct magic *m)
3372 switch (m->str_flags & PSTRING_LEN) {
3382 abort(); /* Impossible */
3387 file_pstring_get_length(const struct magic *m, const char *ss)
3390 const unsigned char *s = RCAST(const unsigned char *, ss);
3391 unsigned int s3, s2, s1, s0;
3393 switch (m->str_flags & PSTRING_LEN) {
3400 len = (s1 << 8) | s0;
3405 len = (s0 << 8) | s1;
3412 len = (s3 << 24) | (s2 << 16) | (s1 << 8) | s0;
3419 len = (s0 << 24) | (s1 << 16) | (s2 << 8) | s3;
3422 abort(); /* Impossible */
3425 if (m->str_flags & PSTRING_LENGTH_INCLUDES_ITSELF)
3426 len -= file_pstring_length_size(m);
3432 file_magicfind(struct magic_set *ms, const char *name, struct mlist *v)
3435 struct mlist *mlist, *ml;
3437 mlist = ms->mlist[1];
3439 for (ml = mlist->next; ml != mlist; ml = ml->next) {
3440 struct magic *ma = ml->magic;
3441 uint32_t nma = ml->nmagic;
3442 for (i = 0; i < nma; i++) {
3443 if (ma[i].type != FILE_NAME)
3445 if (strcmp(ma[i].value.s, name) == 0) {
3447 for (j = i + 1; j < nma; j++)
3448 if (ma[j].cont_level == 0)