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 * file.h - definitions for file(1) program
30 * @(#)$File: file.h,v 1.193 2018/05/24 18:09:17 christos Exp $
40 #ifndef __STDC_LIMIT_MACROS
41 #define __STDC_LIMIT_MACROS
46 #define SIZE_T_FORMAT "I64"
48 #define SIZE_T_FORMAT ""
50 #define INT64_T_FORMAT "I64"
51 #define INTMAX_T_FORMAT "I64"
53 #define SIZE_T_FORMAT "z"
54 #define INT64_T_FORMAT "ll"
55 #define INTMAX_T_FORMAT "j"
60 #include <stdio.h> /* Include that here, to make sure __P gets defined */
62 #include <fcntl.h> /* For open and flags */
63 #ifdef HAVE_INTTYPES_H
68 #include <sys/types.h>
70 #include <sys/param.h>
72 /* Do this here and now, because struct stat gets re-defined on solaris */
76 #define ENABLE_CONDITIONALS
79 #define MAGIC "/etc/magic"
82 #if defined(__EMX__) || defined (WIN32)
88 #define private static
90 #if HAVE_VISIBILITY && !defined(WIN32)
91 #define public __attribute__ ((__visibility__("default")))
93 #define protected __attribute__ ((__visibility__("hidden")))
103 #define __arraycount(a) (sizeof(a) / sizeof(a[0]))
106 #ifndef __GNUC_PREREQ__
108 #define __GNUC_PREREQ__(x, y) \
109 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \
112 #define __GNUC_PREREQ__(x, y) 0
117 #ifndef __attribute__
118 #define __attribute__(a)
123 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
127 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
130 #ifndef FILE_BYTES_MAX
131 # define FILE_BYTES_MAX (1024 * 1024) /* how much of the file to look at */
133 #define MAXMAGIS 8192 /* max entries in any one magic file
135 #define MAXDESC 64 /* max len of text description/MIME type */
136 #define MAXMIME 80 /* max len of text MIME type */
137 #define MAXstring 96 /* max len of "string" types */
139 #define MAGICNO 0xF11E041C
141 #define FILE_MAGICSIZE 344
145 #define FILE_COMPILE 2
163 uint8_t hs[2]; /* 2 bytes of a fixed-endian "short" */
164 uint8_t hl[4]; /* 4 bytes of a fixed-endian "long" */
165 uint8_t hq[8]; /* 8 bytes of a fixed-endian "quad" */
166 char s[MAXstring]; /* the search string or regex pattern */
167 unsigned char us[MAXstring];
174 uint16_t cont_level; /* level of ">" */
176 #define INDIR 0x01 /* if '(...)' appears */
177 #define OFFADD 0x02 /* if '>&' or '>...(&' appears */
178 #define INDIROFFADD 0x04 /* if '>&(' appears */
179 #define UNSIGNED 0x08 /* comparison is unsigned */
180 #define NOSPACE 0x10 /* suppress space character before output */
181 #define BINTEST 0x20 /* test is for a binary type (set only
182 for top-level tests) */
183 #define TEXTTEST 0x40 /* for passing to file_softmagic */
188 uint8_t reln; /* relation (0=eq, '>'=gt, etc) */
189 uint8_t vallen; /* length of string value, if any */
190 uint8_t type; /* comparison type (FILE_*) */
191 uint8_t in_type; /* type of indirection */
192 #define FILE_INVALID 0
195 #define FILE_DEFAULT 3
197 #define FILE_STRING 5
199 #define FILE_BESHORT 7
200 #define FILE_BELONG 8
201 #define FILE_BEDATE 9
202 #define FILE_LESHORT 10
203 #define FILE_LELONG 11
204 #define FILE_LEDATE 12
205 #define FILE_PSTRING 13
206 #define FILE_LDATE 14
207 #define FILE_BELDATE 15
208 #define FILE_LELDATE 16
209 #define FILE_REGEX 17
210 #define FILE_BESTRING16 18
211 #define FILE_LESTRING16 19
212 #define FILE_SEARCH 20
213 #define FILE_MEDATE 21
214 #define FILE_MELDATE 22
215 #define FILE_MELONG 23
217 #define FILE_LEQUAD 25
218 #define FILE_BEQUAD 26
219 #define FILE_QDATE 27
220 #define FILE_LEQDATE 28
221 #define FILE_BEQDATE 29
222 #define FILE_QLDATE 30
223 #define FILE_LEQLDATE 31
224 #define FILE_BEQLDATE 32
225 #define FILE_FLOAT 33
226 #define FILE_BEFLOAT 34
227 #define FILE_LEFLOAT 35
228 #define FILE_DOUBLE 36
229 #define FILE_BEDOUBLE 37
230 #define FILE_LEDOUBLE 38
231 #define FILE_BEID3 39
232 #define FILE_LEID3 40
233 #define FILE_INDIRECT 41
234 #define FILE_QWDATE 42
235 #define FILE_LEQWDATE 43
236 #define FILE_BEQWDATE 44
239 #define FILE_CLEAR 47
241 #define FILE_NAMES_SIZE 49 /* size of array to contain all names */
243 #define IS_STRING(t) \
244 ((t) == FILE_STRING || \
245 (t) == FILE_PSTRING || \
246 (t) == FILE_BESTRING16 || \
247 (t) == FILE_LESTRING16 || \
248 (t) == FILE_REGEX || \
249 (t) == FILE_SEARCH || \
250 (t) == FILE_INDIRECT || \
251 (t) == FILE_NAME || \
254 #define FILE_FMT_NONE 0
255 #define FILE_FMT_NUM 1 /* "cduxXi" */
256 #define FILE_FMT_STR 2 /* "s" */
257 #define FILE_FMT_QUAD 3 /* "ll" */
258 #define FILE_FMT_FLOAT 4 /* "eEfFgG" */
259 #define FILE_FMT_DOUBLE 5 /* "eEfFgG" */
262 uint8_t in_op; /* operator for indirection */
263 uint8_t mask_op; /* operator for mask */
264 #ifdef ENABLE_CONDITIONALS
265 uint8_t cond; /* conditional type */
270 #define FILE_FACTOR_OP_PLUS '+'
271 #define FILE_FACTOR_OP_MINUS '-'
272 #define FILE_FACTOR_OP_TIMES '*'
273 #define FILE_FACTOR_OP_DIV '/'
274 #define FILE_FACTOR_OP_NONE '\0'
276 #define FILE_OPS "&|^+-*/%"
281 #define FILE_OPMINUS 4
282 #define FILE_OPMULTIPLY 5
283 #define FILE_OPDIVIDE 6
284 #define FILE_OPMODULO 7
285 #define FILE_OPS_MASK 0x07 /* mask for above ops */
286 #define FILE_UNUSED_1 0x08
287 #define FILE_UNUSED_2 0x10
288 #define FILE_OPSIGNED 0x20
289 #define FILE_OPINVERSE 0x40
290 #define FILE_OPINDIRECT 0x80
292 #ifdef ENABLE_CONDITIONALS
297 #endif /* ENABLE_CONDITIONALS */
300 int32_t offset; /* offset to magic number */
302 int32_t in_offset; /* offset from indirection */
304 uint32_t lineno; /* line number in magic file */
307 uint64_t _mask; /* for use with numeric and date types */
309 uint32_t _count; /* repeat/line count */
310 uint32_t _flags; /* modifier flags */
311 } _s; /* for use with string types */
313 #define num_mask _u._mask
314 #define str_range _u._s._count
315 #define str_flags _u._s._flags
317 union VALUETYPE value; /* either number or string */
319 char desc[MAXDESC]; /* description */
321 char mimetype[MAXMIME]; /* MIME type */
323 char apple[8]; /* APPLE CREATOR/TYPE */
325 char ext[64]; /* Popular extensions */
328 #define BIT(A) (1 << (A))
329 #define STRING_COMPACT_WHITESPACE BIT(0)
330 #define STRING_COMPACT_OPTIONAL_WHITESPACE BIT(1)
331 #define STRING_IGNORE_LOWERCASE BIT(2)
332 #define STRING_IGNORE_UPPERCASE BIT(3)
333 #define REGEX_OFFSET_START BIT(4)
334 #define STRING_TEXTTEST BIT(5)
335 #define STRING_BINTEST BIT(6)
336 #define PSTRING_1_BE BIT(7)
337 #define PSTRING_1_LE BIT(7)
338 #define PSTRING_2_BE BIT(8)
339 #define PSTRING_2_LE BIT(9)
340 #define PSTRING_4_BE BIT(10)
341 #define PSTRING_4_LE BIT(11)
342 #define REGEX_LINE_COUNT BIT(11)
343 #define PSTRING_LEN \
344 (PSTRING_1_BE|PSTRING_2_LE|PSTRING_2_BE|PSTRING_4_LE|PSTRING_4_BE)
345 #define PSTRING_LENGTH_INCLUDES_ITSELF BIT(12)
346 #define STRING_TRIM BIT(13)
347 #define CHAR_COMPACT_WHITESPACE 'W'
348 #define CHAR_COMPACT_OPTIONAL_WHITESPACE 'w'
349 #define CHAR_IGNORE_LOWERCASE 'c'
350 #define CHAR_IGNORE_UPPERCASE 'C'
351 #define CHAR_REGEX_OFFSET_START 's'
352 #define CHAR_TEXTTEST 't'
353 #define CHAR_TRIM 'T'
354 #define CHAR_BINTEST 'b'
355 #define CHAR_PSTRING_1_BE 'B'
356 #define CHAR_PSTRING_1_LE 'B'
357 #define CHAR_PSTRING_2_BE 'H'
358 #define CHAR_PSTRING_2_LE 'h'
359 #define CHAR_PSTRING_4_BE 'L'
360 #define CHAR_PSTRING_4_LE 'l'
361 #define CHAR_PSTRING_LENGTH_INCLUDES_ITSELF 'J'
362 #define STRING_IGNORE_CASE (STRING_IGNORE_LOWERCASE|STRING_IGNORE_UPPERCASE)
363 #define STRING_DEFAULT_RANGE 100
365 #define INDIRECT_RELATIVE BIT(0)
366 #define CHAR_INDIRECT_RELATIVE 'r'
368 /* list of magic entries */
370 struct magic *magic; /* array of magic entries */
371 uint32_t nmagic; /* number of entries in array */
372 void *map; /* internal resources used by entry */
373 struct mlist *next, *prev;
377 #define CAST(T, b) static_cast<T>(b)
378 #define RCAST(T, b) reinterpret_cast<T>(b)
379 #define CCAST(T, b) const_cast<T>(b)
381 #define CAST(T, b) ((T)(b))
382 #define RCAST(T, b) ((T)(b))
383 #define CCAST(T, b) ((T)(uintptr_t)(b))
389 #ifdef ENABLE_CONDITIONALS
391 int last_cond; /* used for error checking by parse() */
398 struct mlist *mlist[MAGIC_SETS]; /* list of regular entries */
401 struct level_info *li;
404 char *buf; /* Accumulation buffer */
405 char *pbuf; /* Printable buffer */
407 uint32_t offset; /* a copy of m->offset while we */
408 /* are working on the magic entry */
409 uint32_t eoffset; /* offset from end of file */
411 int flags; /* Control magic tests. */
412 int event_flags; /* Note things that happened. */
413 #define EVENT_HAD_ERR 0x01
415 size_t line; /* current magic line number */
416 mode_t mode; /* copy of current stat mode */
418 /* data for searches */
420 const char *s; /* start of search in original source */
421 size_t s_len; /* length of search region */
422 size_t offset; /* starting offset in source: XXX - should this be off_t? */
423 size_t rm_len; /* match length */
426 /* FIXME: Make the string dynamically allocated so that e.g.
427 strings matched in files can be longer than MAXstring */
428 union VALUETYPE ms_value; /* either number or string */
431 uint16_t elf_shnum_max;
432 uint16_t elf_phnum_max;
433 uint16_t elf_notes_max;
435 size_t bytes_max; /* number of bytes to read from file */
436 #define FILE_INDIR_MAX 50
437 #define FILE_NAME_MAX 30
438 #define FILE_ELF_SHNUM_MAX 32768
439 #define FILE_ELF_PHNUM_MAX 2048
440 #define FILE_ELF_NOTES_MAX 256
441 #define FILE_REGEX_MAX 8192
444 /* Type for Unicode characters */
445 typedef unsigned long unichar;
448 #define FILE_T_LOCAL 1
449 #define FILE_T_WINDOWS 2
450 protected const char *file_fmttime(uint64_t, int, char *);
451 protected struct magic_set *file_ms_alloc(int);
452 protected void file_ms_free(struct magic_set *);
453 protected int file_buffer(struct magic_set *, int, const char *, const void *,
455 protected int file_fsmagic(struct magic_set *, const char *, struct stat *);
456 protected int file_pipe2file(struct magic_set *, int, const void *, size_t);
457 protected int file_vprintf(struct magic_set *, const char *, va_list)
458 __attribute__((__format__(__printf__, 2, 0)));
459 protected size_t file_printedlen(const struct magic_set *);
460 protected int file_replace(struct magic_set *, const char *, const char *);
461 protected int file_printf(struct magic_set *, const char *, ...)
462 __attribute__((__format__(__printf__, 2, 3)));
463 protected int file_reset(struct magic_set *, int);
464 protected int file_tryelf(struct magic_set *, const struct buffer *);
465 protected int file_trycdf(struct magic_set *, const struct buffer *);
467 protected int file_zmagic(struct magic_set *, const struct buffer *,
470 protected int file_ascmagic(struct magic_set *, const struct buffer *,
472 protected int file_ascmagic_with_encoding(struct magic_set *,
473 const struct buffer *, unichar *, size_t, const char *, const char *, int);
474 protected int file_encoding(struct magic_set *, const struct buffer *,
475 unichar **, size_t *, const char **, const char **, const char **);
476 protected int file_is_tar(struct magic_set *, const struct buffer *);
477 protected int file_softmagic(struct magic_set *, const struct buffer *,
478 uint16_t *, uint16_t *, int, int);
479 protected int file_apprentice(struct magic_set *, const char *, int);
480 protected int buffer_apprentice(struct magic_set *, struct magic **,
482 protected int file_magicfind(struct magic_set *, const char *, struct mlist *);
483 protected uint64_t file_signextend(struct magic_set *, struct magic *,
485 protected void file_badread(struct magic_set *);
486 protected void file_badseek(struct magic_set *);
487 protected void file_oomem(struct magic_set *, size_t);
488 protected void file_error(struct magic_set *, int, const char *, ...)
489 __attribute__((__format__(__printf__, 3, 4)));
490 protected void file_magerror(struct magic_set *, const char *, ...)
491 __attribute__((__format__(__printf__, 2, 3)));
492 protected void file_magwarn(struct magic_set *, const char *, ...)
493 __attribute__((__format__(__printf__, 2, 3)));
494 protected void file_mdump(struct magic *);
495 protected void file_showstr(FILE *, const char *, size_t);
496 protected size_t file_mbswidth(const char *);
497 protected const char *file_getbuffer(struct magic_set *);
498 protected ssize_t sread(int, void *, size_t, int);
499 protected int file_check_mem(struct magic_set *, unsigned int);
500 protected int file_looks_utf8(const unsigned char *, size_t, unichar *,
502 protected size_t file_pstring_length_size(const struct magic *);
503 protected size_t file_pstring_get_length(const struct magic *, const char *);
504 protected char * file_printable(char *, size_t, const char *);
506 protected int file_os2_apptype(struct magic_set *, const char *, const void *,
510 protected void buffer_init(struct buffer *, int, const void *, size_t);
511 protected void buffer_fini(struct buffer *);
512 protected int buffer_fill(const struct buffer *);
514 #if defined(HAVE_LOCALE_H)
517 #if defined(HAVE_XLOCALE_H)
523 #if defined(HAVE_NEWLOCALE) && defined(HAVE_USELOCALE) && defined(HAVE_FREELOCALE)
525 locale_t old_lc_ctype;
534 protected int file_regcomp(file_regex_t *, const char *, int);
535 protected int file_regexec(file_regex_t *, const char *, size_t, regmatch_t *,
537 protected void file_regfree(file_regex_t *);
538 protected void file_regerror(file_regex_t *, int, struct magic_set *);
545 protected file_pushbuf_t *file_push_buffer(struct magic_set *);
546 protected char *file_pop_buffer(struct magic_set *, file_pushbuf_t *);
549 extern const char *file_names[];
550 extern const size_t file_nnames;
553 #ifndef HAVE_STRERROR
555 extern char *sys_errlist[];
556 #define strerror(e) \
557 (((e) >= 0 && (e) < sys_nerr) ? sys_errlist[(e)] : "Unknown error")
561 #define strtoul(a, b, c) strtol(a, b, c)
565 ssize_t pread(int, void *, size_t, off_t);
567 #ifndef HAVE_VASPRINTF
568 int vasprintf(char **, const char *, va_list);
570 #ifndef HAVE_ASPRINTF
571 int asprintf(char **, const char *, ...);
574 int dprintf(int, const char *, ...);
578 size_t strlcpy(char *, const char *, size_t);
581 size_t strlcat(char *, const char *, size_t);
583 #ifndef HAVE_STRCASESTR
584 char *strcasestr(const char *, const char *);
587 ssize_t getline(char **, size_t *, FILE *);
588 ssize_t getdelim(char **, size_t *, int, FILE *);
591 char *ctime_r(const time_t *, char *);
593 #ifndef HAVE_ASCTIME_R
594 char *asctime_r(const struct tm *, char *);
596 #ifndef HAVE_GMTIME_R
597 struct tm *gmtime_r(const time_t *, struct tm *);
599 #ifndef HAVE_LOCALTIME_R
600 struct tm *localtime_r(const time_t *, struct tm *);
602 #ifndef HAVE_FMTCHECK
603 const char *fmtcheck(const char *, const char *)
604 __attribute__((__format_arg__(2)));
607 #ifdef HAVE_LIBSECCOMP
609 // this mode should not interfere with normal operations
610 // only some dangerous syscalls are blacklisted
611 int enable_sandbox_basic(void);
614 // this mode allows only the necessary syscalls used during normal operation
615 // extensive testing required !!!
616 int enable_sandbox_full(void);
619 protected const char *file_getprogname(void);
620 protected void file_setprogname(const char *);
621 protected void file_err(int, const char *, ...)
622 __attribute__((__format__(__printf__, 2, 3), __noreturn__));
623 protected void file_errx(int, const char *, ...)
624 __attribute__((__format__(__printf__, 2, 3), __noreturn__));
625 protected void file_warn(const char *, ...)
626 __attribute__((__format__(__printf__, 1, 2)));
627 protected void file_warnx(const char *, ...)
628 __attribute__((__format__(__printf__, 1, 2)));
630 #if defined(HAVE_MMAP) && defined(HAVE_SYS_MMAN_H) && !defined(QUICK)
639 #if defined(__GNUC__) && (__GNUC__ >= 3)
640 #define FILE_RCSID(id) \
641 static const char rcsid[] __attribute__((__used__)) = id;
643 #define FILE_RCSID(id) \
644 static const char *rcsid(const char *p) { \
645 return rcsid(p = id); \
649 #define FILE_RCSID(id)
655 #endif /* __file_h__ */