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