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