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