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