Home | History | Annotate | Line # | Download | only in src
      1 /*	$NetBSD: file.h,v 1.28 2023/08/18 19:00:11 christos Exp $	*/
      2 
      3 /*
      4  * Copyright (c) Ian F. Darwin 1986-1995.
      5  * Software written by Ian F. Darwin and others;
      6  * maintained 1995-present by Christos Zoulas and others.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  * 1. Redistributions of source code must retain the above copyright
     12  *    notice immediately at the beginning of the file, without modification,
     13  *    this list of conditions, and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
     22  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     28  * SUCH DAMAGE.
     29  */
     30 /*
     31  * file.h - definitions for file(1) program
     32  * @(#)$File: file.h,v 1.247 2023/07/27 19:40:22 christos Exp $
     33  */
     34 
     35 #ifndef __file_h__
     36 #define __file_h__
     37 
     38 #ifdef HAVE_CONFIG_H
     39 #include <config.h>
     40 #endif
     41 
     42 #ifdef HAVE_STDINT_H
     43 #include <stdint.h>
     44 #endif
     45 
     46 #ifdef HAVE_INTTYPES_H
     47 #include <inttypes.h>
     48 #endif
     49 
     50 #ifndef __STDC_LIMIT_MACROS
     51 #define __STDC_LIMIT_MACROS
     52 #endif
     53 #ifndef __STDC_FORMAT_MACROS
     54 #define __STDC_FORMAT_MACROS
     55 #endif
     56 
     57 #ifdef _WIN32
     58 # ifdef PRIu32
     59 #  ifdef _WIN64
     60 #   define SIZE_T_FORMAT PRIu64
     61 #  else
     62 #   define SIZE_T_FORMAT PRIu32
     63 #  endif
     64 #  define INT64_T_FORMAT PRIi64
     65 #  define INTMAX_T_FORMAT PRIiMAX
     66 # else
     67 #  ifdef _WIN64
     68 #   define SIZE_T_FORMAT "I64"
     69 #  else
     70 #   define SIZE_T_FORMAT ""
     71 #  endif
     72 #  define INT64_T_FORMAT "I64"
     73 #  define INTMAX_T_FORMAT "I64"
     74 # endif
     75 #else
     76 # define SIZE_T_FORMAT "z"
     77 # define INT64_T_FORMAT "ll"
     78 # define INTMAX_T_FORMAT "j"
     79 #endif
     80 
     81 #include <stdio.h>	/* Include that here, to make sure __P gets defined */
     82 #include <errno.h>
     83 #include <fcntl.h>	/* For open and flags */
     84 #include <regex.h>
     85 #include <time.h>
     86 #include <sys/types.h>
     87 #ifndef WIN32
     88 #include <sys/param.h>
     89 #endif
     90 /* Do this here and now, because struct stat gets re-defined on solaris */
     91 #include <sys/stat.h>
     92 #include <stdarg.h>
     93 #include <locale.h>
     94 #if defined(HAVE_XLOCALE_H)
     95 #include <xlocale.h>
     96 #endif
     97 
     98 #define ENABLE_CONDITIONALS
     99 
    100 #ifndef MAGIC
    101 #define MAGIC "/etc/magic"
    102 #endif
    103 
    104 #if defined(__EMX__) || defined (WIN32)
    105 #define PATHSEP	';'
    106 #else
    107 #define PATHSEP	':'
    108 #endif
    109 
    110 #define file_private static
    111 
    112 #if HAVE_VISIBILITY && !defined(WIN32)
    113 #define file_public  __attribute__ ((__visibility__("default")))
    114 #ifndef file_protected
    115 #define file_protected __attribute__ ((__visibility__("hidden")))
    116 #endif
    117 #else
    118 #define file_public
    119 #ifndef file_protected
    120 #define file_protected
    121 #endif
    122 #endif
    123 
    124 #ifndef __arraycount
    125 #define __arraycount(a) (sizeof(a) / sizeof(a[0]))
    126 #endif
    127 
    128 #ifndef __GNUC_PREREQ__
    129 #ifdef __GNUC__
    130 #define	__GNUC_PREREQ__(x, y)						\
    131 	((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) ||			\
    132 	 (__GNUC__ > (x)))
    133 #else
    134 #define	__GNUC_PREREQ__(x, y)	0
    135 #endif
    136 #endif
    137 
    138 #ifndef __GNUC__
    139 #ifndef __attribute__
    140 #define __attribute__(a)
    141 #endif
    142 #endif
    143 
    144 #ifndef MIN
    145 #define	MIN(a,b)	(((a) < (b)) ? (a) : (b))
    146 #endif
    147 
    148 #ifndef MAX
    149 #define	MAX(a,b)	(((a) > (b)) ? (a) : (b))
    150 #endif
    151 
    152 #ifndef O_CLOEXEC
    153 # define O_CLOEXEC 0
    154 #endif
    155 
    156 #ifndef FD_CLOEXEC
    157 # define FD_CLOEXEC 1
    158 #endif
    159 
    160 
    161 /*
    162  * Dec 31, 23:59:59 9999
    163  * we need to make sure that we don't exceed 9999 because some libc
    164  * implementations like muslc crash otherwise
    165  */
    166 #define	MAX_CTIME	CAST(time_t, 0x3afff487cfULL)
    167 
    168 #define FILE_BADSIZE CAST(size_t, ~0ul)
    169 #define MAXDESC	64		/* max len of text description/MIME type */
    170 #define MAXMIME	80		/* max len of text MIME type */
    171 #define MAXstring 128		/* max len of "string" types */
    172 
    173 #define MAGICNO		0xF11E041C
    174 #define VERSIONNO	18
    175 #define FILE_MAGICSIZE	376
    176 
    177 #define FILE_GUID_SIZE	sizeof("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
    178 
    179 #define	FILE_LOAD	0
    180 #define FILE_CHECK	1
    181 #define FILE_COMPILE	2
    182 #define FILE_LIST	3
    183 
    184 typedef regex_t file_regex_t;
    185 
    186 struct buffer {
    187 	int fd;
    188 	struct stat st;
    189 	const void *fbuf;
    190 	size_t flen;
    191 	off_t eoff;
    192 	void *ebuf;
    193 	size_t elen;
    194 };
    195 
    196 union VALUETYPE {
    197 	uint8_t b;
    198 	uint16_t h;
    199 	uint32_t l;
    200 	uint64_t q;
    201 	uint8_t hs[2];	/* 2 bytes of a fixed-endian "short" */
    202 	uint8_t hl[4];	/* 4 bytes of a fixed-endian "long" */
    203 	uint8_t hq[8];	/* 8 bytes of a fixed-endian "quad" */
    204 	char s[MAXstring];	/* the search string or regex pattern */
    205 	unsigned char us[MAXstring];
    206 	uint64_t guid[2];
    207 	float f;
    208 	double d;
    209 };
    210 
    211 struct magic {
    212 	/* Word 1 */
    213 	uint16_t cont_level;	/* level of ">" */
    214 	uint8_t flag;
    215 #define INDIR		0x01	/* if '(...)' appears */
    216 #define OFFADD		0x02	/* if '>&' or '>...(&' appears */
    217 #define INDIROFFADD	0x04	/* if '>&(' appears */
    218 #define UNSIGNED	0x08	/* comparison is unsigned */
    219 #define NOSPACE		0x10	/* suppress space character before output */
    220 #define BINTEST		0x20	/* test is for a binary type (set only
    221 				   for top-level tests) */
    222 #define TEXTTEST	0x40	/* for passing to file_softmagic */
    223 #define OFFNEGATIVE	0x80	/* relative to the end of file */
    224 
    225 	uint8_t factor;
    226 
    227 	/* Word 2 */
    228 	uint8_t reln;		/* relation (0=eq, '>'=gt, etc) */
    229 	uint8_t vallen;		/* length of string value, if any */
    230 	uint8_t type;		/* comparison type (FILE_*) */
    231 	uint8_t in_type;	/* type of indirection */
    232 #define 			FILE_INVALID		0
    233 #define 			FILE_BYTE		1
    234 #define				FILE_SHORT		2
    235 #define				FILE_DEFAULT		3
    236 #define				FILE_LONG		4
    237 #define				FILE_STRING		5
    238 #define				FILE_DATE		6
    239 #define				FILE_BESHORT		7
    240 #define				FILE_BELONG		8
    241 #define				FILE_BEDATE		9
    242 #define				FILE_LESHORT		10
    243 #define				FILE_LELONG		11
    244 #define				FILE_LEDATE		12
    245 #define				FILE_PSTRING		13
    246 #define				FILE_LDATE		14
    247 #define				FILE_BELDATE		15
    248 #define				FILE_LELDATE		16
    249 #define				FILE_REGEX		17
    250 #define				FILE_BESTRING16		18
    251 #define				FILE_LESTRING16		19
    252 #define				FILE_SEARCH		20
    253 #define				FILE_MEDATE		21
    254 #define				FILE_MELDATE		22
    255 #define				FILE_MELONG		23
    256 #define				FILE_QUAD		24
    257 #define				FILE_LEQUAD		25
    258 #define				FILE_BEQUAD		26
    259 #define				FILE_QDATE		27
    260 #define				FILE_LEQDATE		28
    261 #define				FILE_BEQDATE		29
    262 #define				FILE_QLDATE		30
    263 #define				FILE_LEQLDATE		31
    264 #define				FILE_BEQLDATE		32
    265 #define				FILE_FLOAT		33
    266 #define				FILE_BEFLOAT		34
    267 #define				FILE_LEFLOAT		35
    268 #define				FILE_DOUBLE		36
    269 #define				FILE_BEDOUBLE		37
    270 #define				FILE_LEDOUBLE		38
    271 #define				FILE_BEID3		39
    272 #define				FILE_LEID3		40
    273 #define				FILE_INDIRECT		41
    274 #define				FILE_QWDATE		42
    275 #define				FILE_LEQWDATE		43
    276 #define				FILE_BEQWDATE		44
    277 #define				FILE_NAME		45
    278 #define				FILE_USE		46
    279 #define				FILE_CLEAR		47
    280 #define				FILE_DER		48
    281 #define				FILE_GUID		49
    282 #define				FILE_OFFSET		50
    283 #define				FILE_BEVARINT		51
    284 #define				FILE_LEVARINT		52
    285 #define				FILE_MSDOSDATE		53
    286 #define				FILE_LEMSDOSDATE	54
    287 #define				FILE_BEMSDOSDATE	55
    288 #define				FILE_MSDOSTIME		56
    289 #define				FILE_LEMSDOSTIME	57
    290 #define				FILE_BEMSDOSTIME	58
    291 #define				FILE_OCTAL		59
    292 #define				FILE_NAMES_SIZE		60 /* size of array to contain all names */
    293 
    294 #define IS_STRING(t) \
    295 	((t) == FILE_STRING || \
    296 	 (t) == FILE_PSTRING || \
    297 	 (t) == FILE_BESTRING16 || \
    298 	 (t) == FILE_LESTRING16 || \
    299 	 (t) == FILE_REGEX || \
    300 	 (t) == FILE_SEARCH || \
    301 	 (t) == FILE_INDIRECT || \
    302 	 (t) == FILE_NAME || \
    303 	 (t) == FILE_USE || \
    304 	 (t) == FILE_OCTAL)
    305 
    306 #define FILE_FMT_NONE 0
    307 #define FILE_FMT_NUM  1 /* "cduxXi" */
    308 #define FILE_FMT_STR  2 /* "s" */
    309 #define FILE_FMT_QUAD 3 /* "ll" */
    310 #define FILE_FMT_FLOAT 4 /* "eEfFgG" */
    311 #define FILE_FMT_DOUBLE 5 /* "eEfFgG" */
    312 
    313 	/* Word 3 */
    314 	uint8_t in_op;		/* operator for indirection */
    315 	uint8_t mask_op;	/* operator for mask */
    316 #ifdef ENABLE_CONDITIONALS
    317 	uint8_t cond;		/* conditional type */
    318 #else
    319 	uint8_t dummy;
    320 #endif
    321 	uint8_t factor_op;
    322 #define		FILE_FACTOR_OP_PLUS	'+'
    323 #define		FILE_FACTOR_OP_MINUS	'-'
    324 #define		FILE_FACTOR_OP_TIMES	'*'
    325 #define		FILE_FACTOR_OP_DIV	'/'
    326 #define		FILE_FACTOR_OP_NONE	'\0'
    327 
    328 #define				FILE_OPS	"&|^+-*/%"
    329 #define				FILE_OPAND	0
    330 #define				FILE_OPOR	1
    331 #define				FILE_OPXOR	2
    332 #define				FILE_OPADD	3
    333 #define				FILE_OPMINUS	4
    334 #define				FILE_OPMULTIPLY	5
    335 #define				FILE_OPDIVIDE	6
    336 #define				FILE_OPMODULO	7
    337 #define				FILE_OPS_MASK	0x07 /* mask for above ops */
    338 #define				FILE_UNUSED_1	0x08
    339 #define				FILE_UNUSED_2	0x10
    340 #define				FILE_OPSIGNED	0x20
    341 #define				FILE_OPINVERSE	0x40
    342 #define				FILE_OPINDIRECT	0x80
    343 
    344 #ifdef ENABLE_CONDITIONALS
    345 #define				COND_NONE	0
    346 #define				COND_IF		1
    347 #define				COND_ELIF	2
    348 #define				COND_ELSE	3
    349 #endif /* ENABLE_CONDITIONALS */
    350 
    351 	/* Word 4 */
    352 	int32_t offset;		/* offset to magic number */
    353 	/* Word 5 */
    354 	int32_t in_offset;	/* offset from indirection */
    355 	/* Word 6 */
    356 	uint32_t lineno;	/* line number in magic file */
    357 	/* Word 7,8 */
    358 	union {
    359 		uint64_t _mask;	/* for use with numeric and date types */
    360 		struct {
    361 			uint32_t _count;	/* repeat/line count */
    362 			uint32_t _flags;	/* modifier flags */
    363 		} _s;		/* for use with string types */
    364 	} _u;
    365 #define num_mask _u._mask
    366 #define str_range _u._s._count
    367 #define str_flags _u._s._flags
    368 	/* Words 9-24 */
    369 	union VALUETYPE value;	/* either number or string */
    370 	/* Words 25-40 */
    371 	char desc[MAXDESC];	/* description */
    372 	/* Words 41-60 */
    373 	char mimetype[MAXMIME]; /* MIME type */
    374 	/* Words 61-62 */
    375 	char apple[8];		/* APPLE CREATOR/TYPE */
    376 	/* Words 63-78 */
    377 	char ext[64];		/* Popular extensions */
    378 };
    379 
    380 #define BIT(A)   (1 << (A))
    381 #define STRING_COMPACT_WHITESPACE		BIT(0)
    382 #define STRING_COMPACT_OPTIONAL_WHITESPACE	BIT(1)
    383 #define STRING_IGNORE_LOWERCASE			BIT(2)
    384 #define STRING_IGNORE_UPPERCASE			BIT(3)
    385 #define REGEX_OFFSET_START			BIT(4)
    386 #define STRING_TEXTTEST				BIT(5)
    387 #define STRING_BINTEST				BIT(6)
    388 #define PSTRING_1_BE				BIT(7)
    389 #define PSTRING_1_LE				BIT(7)
    390 #define PSTRING_2_BE				BIT(8)
    391 #define PSTRING_2_LE				BIT(9)
    392 #define PSTRING_4_BE				BIT(10)
    393 #define PSTRING_4_LE				BIT(11)
    394 #define REGEX_LINE_COUNT			BIT(11)
    395 #define PSTRING_LEN	\
    396     (PSTRING_1_BE|PSTRING_2_LE|PSTRING_2_BE|PSTRING_4_LE|PSTRING_4_BE)
    397 #define PSTRING_LENGTH_INCLUDES_ITSELF		BIT(12)
    398 #define	STRING_TRIM				BIT(13)
    399 #define	STRING_FULL_WORD			BIT(14)
    400 #define CHAR_COMPACT_WHITESPACE			'W'
    401 #define CHAR_COMPACT_OPTIONAL_WHITESPACE	'w'
    402 #define CHAR_IGNORE_LOWERCASE			'c'
    403 #define CHAR_IGNORE_UPPERCASE			'C'
    404 #define CHAR_REGEX_OFFSET_START			's'
    405 #define CHAR_TEXTTEST				't'
    406 #define	CHAR_TRIM				'T'
    407 #define	CHAR_FULL_WORD				'f'
    408 #define CHAR_BINTEST				'b'
    409 #define CHAR_PSTRING_1_BE			'B'
    410 #define CHAR_PSTRING_1_LE			'B'
    411 #define CHAR_PSTRING_2_BE			'H'
    412 #define CHAR_PSTRING_2_LE			'h'
    413 #define CHAR_PSTRING_4_BE			'L'
    414 #define CHAR_PSTRING_4_LE			'l'
    415 #define CHAR_PSTRING_LENGTH_INCLUDES_ITSELF     'J'
    416 #define STRING_IGNORE_CASE		(STRING_IGNORE_LOWERCASE|STRING_IGNORE_UPPERCASE)
    417 #define STRING_DEFAULT_RANGE		100
    418 
    419 #define	INDIRECT_RELATIVE			BIT(0)
    420 #define	CHAR_INDIRECT_RELATIVE			'r'
    421 
    422 /* list of magic entries */
    423 struct mlist {
    424 	struct magic *magic;		/* array of magic entries */
    425 	file_regex_t **magic_rxcomp;	/* array of compiled regexps */
    426 	size_t nmagic;			/* number of entries in array */
    427 	void *map;			/* internal resources used by entry */
    428 	struct mlist *next, *prev;
    429 };
    430 
    431 #ifdef __cplusplus
    432 #define CAST(T, b)	static_cast<T>(b)
    433 #define RCAST(T, b)	reinterpret_cast<T>(b)
    434 #define CCAST(T, b)	const_cast<T>(b)
    435 #else
    436 #define CAST(T, b)	((T)(b))
    437 #define RCAST(T, b)	((T)(uintptr_t)(b))
    438 #define CCAST(T, b)	((T)(uintptr_t)(b))
    439 #endif
    440 
    441 struct level_info {
    442 	int32_t off;
    443 	int got_match;
    444 #ifdef ENABLE_CONDITIONALS
    445 	int last_match;
    446 	int last_cond;	/* used for error checking by parse() */
    447 #endif
    448 };
    449 
    450 struct cont {
    451 	size_t len;
    452 	struct level_info *li;
    453 };
    454 
    455 #define MAGIC_SETS	2
    456 
    457 struct magic_set {
    458 	struct mlist *mlist[MAGIC_SETS];	/* list of regular entries */
    459 	struct cont c;
    460 	struct out {
    461 		char *buf;		/* Accumulation buffer */
    462 		size_t blen;		/* Length of buffer */
    463 		char *pbuf;		/* Printable buffer */
    464 	} o;
    465 	uint32_t offset;			/* a copy of m->offset while we */
    466 					/* are working on the magic entry */
    467 	uint32_t eoffset;		/* offset from end of file */
    468 	int error;
    469 	int flags;			/* Control magic tests. */
    470 	int event_flags;		/* Note things that happened. */
    471 #define 		EVENT_HAD_ERR		0x01
    472 	const char *file;
    473 	size_t line;			/* current magic line number */
    474 	mode_t mode;			/* copy of current stat mode */
    475 
    476 	/* data for searches */
    477 	struct {
    478 		const char *s;		/* start of search in original source */
    479 		size_t s_len;		/* length of search region */
    480 		size_t offset;		/* starting offset in source: XXX - should this be off_t? */
    481 		size_t rm_len;		/* match length */
    482 	} search;
    483 
    484 	/* FIXME: Make the string dynamically allocated so that e.g.
    485 	   strings matched in files can be longer than MAXstring */
    486 	union VALUETYPE ms_value;	/* either number or string */
    487 	uint16_t indir_max;
    488 	uint16_t name_max;
    489 	uint16_t elf_shnum_max;
    490 	uint16_t elf_phnum_max;
    491 	uint16_t elf_notes_max;
    492 	uint16_t regex_max;
    493 	size_t bytes_max;		/* number of bytes to read from file */
    494 	size_t encoding_max;		/* bytes to look for encoding */
    495 	size_t	elf_shsize_max;
    496 #ifndef FILE_BYTES_MAX
    497 # define FILE_BYTES_MAX (7 * 1024 * 1024)/* how much of the file to look at */
    498 #endif /* above 0x6ab0f4 map offset for HelveticaNeue.dfont */
    499 #define	FILE_ELF_NOTES_MAX		256
    500 #define	FILE_ELF_PHNUM_MAX		2048
    501 #define	FILE_ELF_SHNUM_MAX		32768
    502 #define	FILE_ELF_SHSIZE_MAX		(128 * 1024 * 1024)
    503 #define	FILE_INDIR_MAX			50
    504 #define	FILE_NAME_MAX			50
    505 #define	FILE_REGEX_MAX			8192
    506 #define	FILE_ENCODING_MAX		(64 * 1024)
    507 #if defined(HAVE_NEWLOCALE) && defined(HAVE_USELOCALE) && defined(HAVE_FREELOCALE)
    508 #define USE_C_LOCALE
    509 	locale_t c_lc_ctype;
    510 #define file_locale_used
    511 #else
    512 #define file_locale_used __attribute__((__unused__))
    513 #endif
    514 };
    515 
    516 /* Type for Unicode characters */
    517 typedef unsigned long file_unichar_t;
    518 
    519 struct stat;
    520 #define FILE_T_LOCAL	1
    521 #define FILE_T_WINDOWS	2
    522 file_protected const char *file_fmtdatetime(char *, size_t, uint64_t, int);
    523 file_protected const char *file_fmtdate(char *, size_t, uint16_t);
    524 file_protected const char *file_fmttime(char *, size_t, uint16_t);
    525 file_protected const char *file_fmtvarint(char *, size_t, const unsigned char *,
    526     int);
    527 file_protected const char *file_fmtnum(char *, size_t, const char *, int);
    528 file_protected struct magic_set *file_ms_alloc(int);
    529 file_protected void file_ms_free(struct magic_set *);
    530 file_protected int file_default(struct magic_set *, size_t);
    531 file_protected int file_buffer(struct magic_set *, int, struct stat *,
    532     const char *, const void *, size_t);
    533 file_protected int file_fsmagic(struct magic_set *, const char *,
    534     struct stat *);
    535 file_protected int file_pipe2file(struct magic_set *, int, const void *,
    536     size_t);
    537 file_protected int file_vprintf(struct magic_set *, const char *, va_list)
    538     __attribute__((__format__(__printf__, 2, 0)));
    539 file_protected int file_separator(struct magic_set *);
    540 file_protected char *file_copystr(char *, size_t, size_t, const char *);
    541 file_protected int file_checkfmt(char *, size_t, const char *);
    542 file_protected size_t file_printedlen(const struct magic_set *);
    543 file_protected int file_print_guid(char *, size_t, const uint64_t *);
    544 file_protected int file_parse_guid(const char *, uint64_t *);
    545 file_protected int file_replace(struct magic_set *, const char *, const char *);
    546 file_protected int file_printf(struct magic_set *, const char *, ...)
    547     __attribute__((__format__(__printf__, 2, 3)));
    548 file_protected int file_reset(struct magic_set *, int);
    549 file_protected int file_tryelf(struct magic_set *, const struct buffer *);
    550 file_protected int file_trycdf(struct magic_set *, const struct buffer *);
    551 #if HAVE_FORK
    552 file_protected int file_zmagic(struct magic_set *, const struct buffer *,
    553     const char *);
    554 #endif
    555 file_protected int file_ascmagic(struct magic_set *, const struct buffer *,
    556     int);
    557 file_protected int file_ascmagic_with_encoding(struct magic_set *,
    558     const struct buffer *, file_unichar_t *, size_t, const char *, const char *, int);
    559 file_protected int file_encoding(struct magic_set *, const struct buffer *,
    560     file_unichar_t **, size_t *, const char **, const char **, const char **);
    561 file_protected int file_is_json(struct magic_set *, const struct buffer *);
    562 file_protected int file_is_csv(struct magic_set *, const struct buffer *, int,
    563     const char *);
    564 file_protected int file_is_simh(struct magic_set *, const struct buffer *);
    565 file_protected int file_is_tar(struct magic_set *, const struct buffer *);
    566 file_protected int file_softmagic(struct magic_set *, const struct buffer *,
    567     uint16_t *, uint16_t *, int, int);
    568 file_protected int file_apprentice(struct magic_set *, const char *, int);
    569 file_protected size_t file_magic_strength(const struct magic *, size_t);
    570 file_protected int buffer_apprentice(struct magic_set *, struct magic **,
    571     size_t *, size_t);
    572 file_protected int file_magicfind(struct magic_set *, const char *,
    573     struct mlist *);
    574 file_protected uint64_t file_signextend(struct magic_set *, struct magic *,
    575     uint64_t);
    576 file_protected uintmax_t file_varint2uintmax_t(const unsigned char *, int,
    577     size_t *);
    578 
    579 file_protected void file_badread(struct magic_set *);
    580 file_protected void file_badseek(struct magic_set *);
    581 file_protected void file_oomem(struct magic_set *, size_t);
    582 file_protected void file_error(struct magic_set *, int, const char *, ...)
    583     __attribute__((__format__(__printf__, 3, 4)));
    584 file_protected void file_magerror(struct magic_set *, const char *, ...)
    585     __attribute__((__format__(__printf__, 2, 3)));
    586 file_protected void file_magwarn(struct magic_set *, const char *, ...)
    587     __attribute__((__format__(__printf__, 2, 3)));
    588 file_protected void file_mdump(struct magic *);
    589 file_protected void file_showstr(FILE *, const char *, size_t);
    590 file_protected size_t file_mbswidth(struct magic_set *, const char *);
    591 file_protected const char *file_getbuffer(struct magic_set *);
    592 file_protected ssize_t sread(int, void *, size_t, int);
    593 file_protected int file_check_mem(struct magic_set *, unsigned int);
    594 file_protected int file_looks_utf8(const unsigned char *, size_t,
    595     file_unichar_t *, size_t *);
    596 file_protected size_t file_pstring_length_size(struct magic_set *,
    597     const struct magic *);
    598 file_protected size_t file_pstring_get_length(struct magic_set *,
    599     const struct magic *, const char *);
    600 file_protected char * file_printable(struct magic_set *, char *, size_t,
    601     const char *, size_t);
    602 #ifdef __EMX__
    603 file_protected int file_os2_apptype(struct magic_set *, const char *,
    604     const void *, size_t);
    605 #endif /* __EMX__ */
    606 file_protected int file_pipe_closexec(int *);
    607 file_protected int file_clear_closexec(int);
    608 file_protected char *file_strtrim(char *);
    609 
    610 file_protected void buffer_init(struct buffer *, int, const struct stat *,
    611     const void *, size_t);
    612 file_protected void buffer_fini(struct buffer *);
    613 file_protected int buffer_fill(const struct buffer *);
    614 
    615 
    616 
    617 file_protected int file_regcomp(struct magic_set *, file_regex_t *,
    618     const char *, int);
    619 file_protected int file_regexec(struct magic_set *, file_regex_t *,
    620     const char *, size_t, regmatch_t *, int);
    621 file_protected void file_regfree(file_regex_t *);
    622 
    623 typedef struct {
    624 	char *buf;
    625 	size_t blen;
    626 	uint32_t offset;
    627 } file_pushbuf_t;
    628 
    629 file_protected file_pushbuf_t *file_push_buffer(struct magic_set *);
    630 file_protected char  *file_pop_buffer(struct magic_set *, file_pushbuf_t *);
    631 
    632 #ifndef COMPILE_ONLY
    633 extern const char *file_names[];
    634 extern const size_t file_nnames;
    635 #endif
    636 
    637 #ifndef HAVE_PREAD
    638 ssize_t pread(int, void *, size_t, off_t);
    639 #endif
    640 #ifndef HAVE_VASPRINTF
    641 int vasprintf(char **, const char *, va_list);
    642 #endif
    643 #ifndef HAVE_ASPRINTF
    644 int asprintf(char **, const char *, ...);
    645 #endif
    646 #ifndef HAVE_DPRINTF
    647 int dprintf(int, const char *, ...);
    648 #endif
    649 
    650 #ifndef HAVE_STRLCPY
    651 size_t strlcpy(char *, const char *, size_t);
    652 #endif
    653 #ifndef HAVE_STRLCAT
    654 size_t strlcat(char *, const char *, size_t);
    655 #endif
    656 #ifndef HAVE_STRCASESTR
    657 char *strcasestr(const char *, const char *);
    658 #endif
    659 #ifndef HAVE_GETLINE
    660 ssize_t getline(char **, size_t *, FILE *);
    661 ssize_t getdelim(char **, size_t *, int, FILE *);
    662 #endif
    663 #ifndef HAVE_CTIME_R
    664 char   *ctime_r(const time_t *, char *);
    665 #endif
    666 #ifndef HAVE_ASCTIME_R
    667 char   *asctime_r(const struct tm *, char *);
    668 #endif
    669 #ifndef HAVE_GMTIME_R
    670 struct tm *gmtime_r(const time_t *, struct tm *);
    671 #endif
    672 #ifndef HAVE_LOCALTIME_R
    673 struct tm *localtime_r(const time_t *, struct tm *);
    674 #endif
    675 #ifndef HAVE_FMTCHECK
    676 const char *fmtcheck(const char *, const char *)
    677      __attribute__((__format_arg__(2)));
    678 #endif
    679 
    680 #ifdef HAVE_LIBSECCOMP
    681 // basic filter
    682 // this mode should not interfere with normal operations
    683 // only some dangerous syscalls are blacklisted
    684 int enable_sandbox_basic(void);
    685 
    686 // enhanced filter
    687 // this mode allows only the necessary syscalls used during normal operation
    688 // extensive testing required !!!
    689 int enable_sandbox_full(void);
    690 #endif
    691 
    692 file_protected const char *file_getprogname(void);
    693 file_protected void file_setprogname(const char *);
    694 file_protected void file_err(int, const char *, ...)
    695     __attribute__((__format__(__printf__, 2, 3), __noreturn__));
    696 file_protected void file_errx(int, const char *, ...)
    697     __attribute__((__format__(__printf__, 2, 3), __noreturn__));
    698 file_protected void file_warn(const char *, ...)
    699     __attribute__((__format__(__printf__, 1, 2)));
    700 file_protected void file_warnx(const char *, ...)
    701     __attribute__((__format__(__printf__, 1, 2)));
    702 
    703 #if defined(HAVE_MMAP) && defined(HAVE_SYS_MMAN_H) && !defined(QUICK)
    704 #define QUICK
    705 #endif
    706 
    707 #ifndef O_BINARY
    708 #define O_BINARY	0
    709 #endif
    710 #ifndef O_NONBLOCK
    711 #define O_NONBLOCK	0
    712 #endif
    713 
    714 #ifndef __cplusplus
    715 #if defined(__GNUC__) && (__GNUC__ >= 3)
    716 #define FILE_RCSID(id) \
    717 static const char rcsid[] __attribute__((__used__)) = id;
    718 #else
    719 #define FILE_RCSID(id) \
    720 static const char *rcsid(const char *p) { \
    721 	return rcsid(p = id); \
    722 }
    723 #endif
    724 #else
    725 #define FILE_RCSID(id)
    726 #endif
    727 #ifndef __RCSID
    728 #define __RCSID(a)
    729 #endif
    730 
    731 #endif /* __file_h__ */
    732