xref: /dragonfly/contrib/file/src/file.h (revision 739f0ef867128a933e021db3d831e906fcafd825)
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.237 2022/09/10 13:21:42 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   18
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_OCTAL                    59
282 #define                                 FILE_NAMES_SIZE               60 /* size of array to contain all names */
283 
284 #define IS_STRING(t) \
285           ((t) == FILE_STRING || \
286            (t) == FILE_PSTRING || \
287            (t) == FILE_BESTRING16 || \
288            (t) == FILE_LESTRING16 || \
289            (t) == FILE_REGEX || \
290            (t) == FILE_SEARCH || \
291            (t) == FILE_INDIRECT || \
292            (t) == FILE_NAME || \
293            (t) == FILE_USE || \
294            (t) == FILE_OCTAL)
295 
296 #define FILE_FMT_NONE 0
297 #define FILE_FMT_NUM  1 /* "cduxXi" */
298 #define FILE_FMT_STR  2 /* "s" */
299 #define FILE_FMT_QUAD 3 /* "ll" */
300 #define FILE_FMT_FLOAT 4 /* "eEfFgG" */
301 #define FILE_FMT_DOUBLE 5 /* "eEfFgG" */
302 
303           /* Word 3 */
304           uint8_t in_op;                /* operator for indirection */
305           uint8_t mask_op;    /* operator for mask */
306 #ifdef ENABLE_CONDITIONALS
307           uint8_t cond;                 /* conditional type */
308 #else
309           uint8_t dummy;
310 #endif
311           uint8_t factor_op;
312 #define             FILE_FACTOR_OP_PLUS '+'
313 #define             FILE_FACTOR_OP_MINUS          '-'
314 #define             FILE_FACTOR_OP_TIMES          '*'
315 #define             FILE_FACTOR_OP_DIV  '/'
316 #define             FILE_FACTOR_OP_NONE '\0'
317 
318 #define                                 FILE_OPS  "&|^+-*/%"
319 #define                                 FILE_OPAND          0
320 #define                                 FILE_OPOR 1
321 #define                                 FILE_OPXOR          2
322 #define                                 FILE_OPADD          3
323 #define                                 FILE_OPMINUS        4
324 #define                                 FILE_OPMULTIPLY     5
325 #define                                 FILE_OPDIVIDE       6
326 #define                                 FILE_OPMODULO       7
327 #define                                 FILE_OPS_MASK       0x07 /* mask for above ops */
328 #define                                 FILE_UNUSED_1       0x08
329 #define                                 FILE_UNUSED_2       0x10
330 #define                                 FILE_OPSIGNED       0x20
331 #define                                 FILE_OPINVERSE      0x40
332 #define                                 FILE_OPINDIRECT     0x80
333 
334 #ifdef ENABLE_CONDITIONALS
335 #define                                 COND_NONE 0
336 #define                                 COND_IF             1
337 #define                                 COND_ELIF 2
338 #define                                 COND_ELSE 3
339 #endif /* ENABLE_CONDITIONALS */
340 
341           /* Word 4 */
342           int32_t offset;               /* offset to magic number */
343           /* Word 5 */
344           int32_t in_offset;  /* offset from indirection */
345           /* Word 6 */
346           uint32_t lineno;    /* line number in magic file */
347           /* Word 7,8 */
348           union {
349                     uint64_t _mask;     /* for use with numeric and date types */
350                     struct {
351                               uint32_t _count;    /* repeat/line count */
352                               uint32_t _flags;    /* modifier flags */
353                     } _s;               /* for use with string types */
354           } _u;
355 #define num_mask _u._mask
356 #define str_range _u._s._count
357 #define str_flags _u._s._flags
358           /* Words 9-24 */
359           union VALUETYPE value;        /* either number or string */
360           /* Words 25-40 */
361           char desc[MAXDESC]; /* description */
362           /* Words 41-60 */
363           char mimetype[MAXMIME]; /* MIME type */
364           /* Words 61-62 */
365           char apple[8];                /* APPLE CREATOR/TYPE */
366           /* Words 63-78 */
367           char ext[64];                 /* Popular extensions */
368 };
369 
370 #define BIT(A)   (1 << (A))
371 #define STRING_COMPACT_WHITESPACE                 BIT(0)
372 #define STRING_COMPACT_OPTIONAL_WHITESPACE        BIT(1)
373 #define STRING_IGNORE_LOWERCASE                             BIT(2)
374 #define STRING_IGNORE_UPPERCASE                             BIT(3)
375 #define REGEX_OFFSET_START                        BIT(4)
376 #define STRING_TEXTTEST                                     BIT(5)
377 #define STRING_BINTEST                                      BIT(6)
378 #define PSTRING_1_BE                                        BIT(7)
379 #define PSTRING_1_LE                                        BIT(7)
380 #define PSTRING_2_BE                                        BIT(8)
381 #define PSTRING_2_LE                                        BIT(9)
382 #define PSTRING_4_BE                                        BIT(10)
383 #define PSTRING_4_LE                                        BIT(11)
384 #define REGEX_LINE_COUNT                          BIT(11)
385 #define PSTRING_LEN \
386     (PSTRING_1_BE|PSTRING_2_LE|PSTRING_2_BE|PSTRING_4_LE|PSTRING_4_BE)
387 #define PSTRING_LENGTH_INCLUDES_ITSELF            BIT(12)
388 #define   STRING_TRIM                                       BIT(13)
389 #define   STRING_FULL_WORD                        BIT(14)
390 #define CHAR_COMPACT_WHITESPACE                             'W'
391 #define CHAR_COMPACT_OPTIONAL_WHITESPACE          'w'
392 #define CHAR_IGNORE_LOWERCASE                     'c'
393 #define CHAR_IGNORE_UPPERCASE                     'C'
394 #define CHAR_REGEX_OFFSET_START                             's'
395 #define CHAR_TEXTTEST                                       't'
396 #define   CHAR_TRIM                               'T'
397 #define   CHAR_FULL_WORD                                    'f'
398 #define CHAR_BINTEST                                        'b'
399 #define CHAR_PSTRING_1_BE                         'B'
400 #define CHAR_PSTRING_1_LE                         'B'
401 #define CHAR_PSTRING_2_BE                         'H'
402 #define CHAR_PSTRING_2_LE                         'h'
403 #define CHAR_PSTRING_4_BE                         'L'
404 #define CHAR_PSTRING_4_LE                         'l'
405 #define CHAR_PSTRING_LENGTH_INCLUDES_ITSELF     'J'
406 #define STRING_IGNORE_CASE              (STRING_IGNORE_LOWERCASE|STRING_IGNORE_UPPERCASE)
407 #define STRING_DEFAULT_RANGE            100
408 
409 #define   INDIRECT_RELATIVE                       BIT(0)
410 #define   CHAR_INDIRECT_RELATIVE                            'r'
411 
412 /* list of magic entries */
413 struct mlist {
414           struct magic *magic;                    /* array of magic entries */
415           file_regex_t **magic_rxcomp;  /* array of compiled regexps */
416           size_t nmagic;                          /* number of entries in array */
417           void *map;                              /* internal resources used by entry */
418           struct mlist *next, *prev;
419 };
420 
421 #ifdef __cplusplus
422 #define CAST(T, b)  static_cast<T>(b)
423 #define RCAST(T, b) reinterpret_cast<T>(b)
424 #define CCAST(T, b) const_cast<T>(b)
425 #else
426 #define CAST(T, b)  ((T)(b))
427 #define RCAST(T, b) ((T)(uintptr_t)(b))
428 #define CCAST(T, b) ((T)(uintptr_t)(b))
429 #endif
430 
431 struct level_info {
432           int32_t off;
433           int got_match;
434 #ifdef ENABLE_CONDITIONALS
435           int last_match;
436           int last_cond;      /* used for error checking by parse() */
437 #endif
438 };
439 
440 struct cont {
441           size_t len;
442           struct level_info *li;
443 };
444 
445 #define MAGIC_SETS  2
446 
447 struct magic_set {
448           struct mlist *mlist[MAGIC_SETS];        /* list of regular entries */
449           struct cont c;
450           struct out {
451                     char *buf;                    /* Accumulation buffer */
452                     size_t blen;                  /* Length of buffer */
453                     char *pbuf;                   /* Printable buffer */
454           } o;
455           uint32_t offset;                        /* a copy of m->offset while we */
456                                                   /* are working on the magic entry */
457           uint32_t eoffset;             /* offset from end of file */
458           int error;
459           int flags;                              /* Control magic tests. */
460           int event_flags;              /* Note things that happened. */
461 #define             EVENT_HAD_ERR                 0x01
462           const char *file;
463           size_t line;                            /* current magic line number */
464           mode_t mode;                            /* copy of current stat mode */
465 
466           /* data for searches */
467           struct {
468                     const char *s;                /* start of search in original source */
469                     size_t s_len;                 /* length of search region */
470                     size_t offset;                /* starting offset in source: XXX - should this be off_t? */
471                     size_t rm_len;                /* match length */
472           } search;
473 
474           /* FIXME: Make the string dynamically allocated so that e.g.
475              strings matched in files can be longer than MAXstring */
476           union VALUETYPE ms_value;     /* either number or string */
477           uint16_t indir_max;
478           uint16_t name_max;
479           uint16_t elf_shnum_max;
480           uint16_t elf_phnum_max;
481           uint16_t elf_notes_max;
482           uint16_t regex_max;
483           size_t bytes_max;             /* number of bytes to read from file */
484           size_t encoding_max;                    /* bytes to look for encoding */
485 #ifndef FILE_BYTES_MAX
486 # define FILE_BYTES_MAX (1024 * 1024)   /* how much of the file to look at */
487 #endif
488 #define   FILE_ELF_NOTES_MAX            256
489 #define   FILE_ELF_PHNUM_MAX            2048
490 #define   FILE_ELF_SHNUM_MAX            32768
491 #define   FILE_INDIR_MAX                          50
492 #define   FILE_NAME_MAX                           50
493 #define   FILE_REGEX_MAX                          8192
494 #define   FILE_ENCODING_MAX             (64 * 1024)
495 #if defined(HAVE_NEWLOCALE) && defined(HAVE_USELOCALE) && defined(HAVE_FREELOCALE)
496 #define USE_C_LOCALE
497           locale_t c_lc_ctype;
498 #define file_locale_used
499 #else
500 #define file_locale_used __attribute__((__unused__))
501 #endif
502 };
503 
504 /* Type for Unicode characters */
505 typedef unsigned long file_unichar_t;
506 
507 struct stat;
508 #define FILE_T_LOCAL          1
509 #define FILE_T_WINDOWS        2
510 protected const char *file_fmtdatetime(char *, size_t, uint64_t, int);
511 protected const char *file_fmtdate(char *, size_t, uint16_t);
512 protected const char *file_fmttime(char *, size_t, uint16_t);
513 protected const char *file_fmtvarint(char *, size_t, const unsigned char *,
514     int);
515 protected const char *file_fmtnum(char *, size_t, const char *, int);
516 protected struct magic_set *file_ms_alloc(int);
517 protected void file_ms_free(struct magic_set *);
518 protected int file_default(struct magic_set *, size_t);
519 protected int file_buffer(struct magic_set *, int, struct stat *, const char *,
520     const void *, size_t);
521 protected int file_fsmagic(struct magic_set *, const char *, struct stat *);
522 protected int file_pipe2file(struct magic_set *, int, const void *, size_t);
523 protected int file_vprintf(struct magic_set *, const char *, va_list)
524     __attribute__((__format__(__printf__, 2, 0)));
525 protected int file_separator(struct magic_set *);
526 protected char *file_copystr(char *, size_t, size_t, const char *);
527 protected int file_checkfmt(char *, size_t, const char *);
528 protected size_t file_printedlen(const struct magic_set *);
529 protected int file_print_guid(char *, size_t, const uint64_t *);
530 protected int file_parse_guid(const char *, uint64_t *);
531 protected int file_replace(struct magic_set *, const char *, const char *);
532 protected int file_printf(struct magic_set *, const char *, ...)
533     __attribute__((__format__(__printf__, 2, 3)));
534 protected int file_reset(struct magic_set *, int);
535 protected int file_tryelf(struct magic_set *, const struct buffer *);
536 protected int file_trycdf(struct magic_set *, const struct buffer *);
537 #if HAVE_FORK
538 protected int file_zmagic(struct magic_set *, const struct buffer *,
539     const char *);
540 #endif
541 protected int file_ascmagic(struct magic_set *, const struct buffer *,
542     int);
543 protected int file_ascmagic_with_encoding(struct magic_set *,
544     const struct buffer *, file_unichar_t *, size_t, const char *, const char *, int);
545 protected int file_encoding(struct magic_set *, const struct buffer *,
546     file_unichar_t **, size_t *, const char **, const char **, const char **);
547 protected int file_is_json(struct magic_set *, const struct buffer *);
548 protected int file_is_csv(struct magic_set *, const struct buffer *, int);
549 protected int file_is_tar(struct magic_set *, const struct buffer *);
550 protected int file_softmagic(struct magic_set *, const struct buffer *,
551     uint16_t *, uint16_t *, int, int);
552 protected int file_apprentice(struct magic_set *, const char *, int);
553 protected int buffer_apprentice(struct magic_set *, struct magic **,
554     size_t *, size_t);
555 protected int file_magicfind(struct magic_set *, const char *, struct mlist *);
556 protected uint64_t file_signextend(struct magic_set *, struct magic *,
557     uint64_t);
558 protected uintmax_t file_varint2uintmax_t(const unsigned char *, int, size_t *);
559 
560 protected void file_badread(struct magic_set *);
561 protected void file_badseek(struct magic_set *);
562 protected void file_oomem(struct magic_set *, size_t);
563 protected void file_error(struct magic_set *, int, const char *, ...)
564     __attribute__((__format__(__printf__, 3, 4)));
565 protected void file_magerror(struct magic_set *, const char *, ...)
566     __attribute__((__format__(__printf__, 2, 3)));
567 protected void file_magwarn(struct magic_set *, const char *, ...)
568     __attribute__((__format__(__printf__, 2, 3)));
569 protected void file_mdump(struct magic *);
570 protected void file_showstr(FILE *, const char *, size_t);
571 protected size_t file_mbswidth(struct magic_set *, const char *);
572 protected const char *file_getbuffer(struct magic_set *);
573 protected ssize_t sread(int, void *, size_t, int);
574 protected int file_check_mem(struct magic_set *, unsigned int);
575 protected int file_looks_utf8(const unsigned char *, size_t, file_unichar_t *,
576     size_t *);
577 protected size_t file_pstring_length_size(struct magic_set *,
578     const struct magic *);
579 protected size_t file_pstring_get_length(struct magic_set *,
580     const struct magic *, const char *);
581 protected char * file_printable(struct magic_set *, char *, size_t,
582     const char *, size_t);
583 #ifdef __EMX__
584 protected int file_os2_apptype(struct magic_set *, const char *, const void *,
585     size_t);
586 #endif /* __EMX__ */
587 protected int file_pipe_closexec(int *);
588 protected int file_clear_closexec(int);
589 protected char *file_strtrim(char *);
590 
591 protected void buffer_init(struct buffer *, int, const struct stat *,
592     const void *, size_t);
593 protected void buffer_fini(struct buffer *);
594 protected int buffer_fill(const struct buffer *);
595 
596 
597 
598 protected int file_regcomp(struct magic_set *, file_regex_t *, const char *,
599     int);
600 protected int file_regexec(struct magic_set *, file_regex_t *, const char *,
601     size_t, regmatch_t *, int);
602 protected void file_regfree(file_regex_t *);
603 
604 typedef struct {
605           char *buf;
606           size_t blen;
607           uint32_t offset;
608 } file_pushbuf_t;
609 
610 protected file_pushbuf_t *file_push_buffer(struct magic_set *);
611 protected char  *file_pop_buffer(struct magic_set *, file_pushbuf_t *);
612 
613 #ifndef COMPILE_ONLY
614 extern const char *file_names[];
615 extern const size_t file_nnames;
616 #endif
617 
618 #ifndef HAVE_PREAD
619 ssize_t pread(int, void *, size_t, off_t);
620 #endif
621 #ifndef HAVE_VASPRINTF
622 int vasprintf(char **, const char *, va_list);
623 #endif
624 #ifndef HAVE_ASPRINTF
625 int asprintf(char **, const char *, ...);
626 #endif
627 #ifndef HAVE_DPRINTF
628 int dprintf(int, const char *, ...);
629 #endif
630 
631 #ifndef HAVE_STRLCPY
632 size_t strlcpy(char *, const char *, size_t);
633 #endif
634 #ifndef HAVE_STRLCAT
635 size_t strlcat(char *, const char *, size_t);
636 #endif
637 #ifndef HAVE_STRCASESTR
638 char *strcasestr(const char *, const char *);
639 #endif
640 #ifndef HAVE_GETLINE
641 ssize_t getline(char **, size_t *, FILE *);
642 ssize_t getdelim(char **, size_t *, int, FILE *);
643 #endif
644 #ifndef HAVE_CTIME_R
645 char   *ctime_r(const time_t *, char *);
646 #endif
647 #ifndef HAVE_ASCTIME_R
648 char   *asctime_r(const struct tm *, char *);
649 #endif
650 #ifndef HAVE_GMTIME_R
651 struct tm *gmtime_r(const time_t *, struct tm *);
652 #endif
653 #ifndef HAVE_LOCALTIME_R
654 struct tm *localtime_r(const time_t *, struct tm *);
655 #endif
656 #ifndef HAVE_FMTCHECK
657 const char *fmtcheck(const char *, const char *)
658      __attribute__((__format_arg__(2)));
659 #endif
660 
661 #ifdef HAVE_LIBSECCOMP
662 // basic filter
663 // this mode should not interfere with normal operations
664 // only some dangerous syscalls are blacklisted
665 int enable_sandbox_basic(void);
666 
667 // enhanced filter
668 // this mode allows only the necessary syscalls used during normal operation
669 // extensive testing required !!!
670 int enable_sandbox_full(void);
671 #endif
672 
673 protected const char *file_getprogname(void);
674 protected void file_setprogname(const char *);
675 protected void file_err(int, const char *, ...)
676     __attribute__((__format__(__printf__, 2, 3), __noreturn__));
677 protected void file_errx(int, const char *, ...)
678     __attribute__((__format__(__printf__, 2, 3), __noreturn__));
679 protected void file_warn(const char *, ...)
680     __attribute__((__format__(__printf__, 1, 2)));
681 protected void file_warnx(const char *, ...)
682     __attribute__((__format__(__printf__, 1, 2)));
683 
684 #if defined(HAVE_MMAP) && defined(HAVE_SYS_MMAN_H) && !defined(QUICK)
685 #define QUICK
686 #endif
687 
688 #ifndef O_BINARY
689 #define O_BINARY    0
690 #endif
691 #ifndef O_NONBLOCK
692 #define O_NONBLOCK  0
693 #endif
694 
695 #ifndef __cplusplus
696 #if defined(__GNUC__) && (__GNUC__ >= 3)
697 #define FILE_RCSID(id) \
698 static const char rcsid[] __attribute__((__used__)) = id;
699 #else
700 #define FILE_RCSID(id) \
701 static const char *rcsid(const char *p) { \
702           return rcsid(p = id); \
703 }
704 #endif
705 #else
706 #define FILE_RCSID(id)
707 #endif
708 #ifndef __RCSID
709 #define __RCSID(a)
710 #endif
711 
712 #endif /* __file_h__ */
713