summaryrefslogtreecommitdiff
path: root/file/file.h
blob: c06da7d3a53ed7b9bb8b826cec9bcbe936c529d7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/*
 * file.h - definitions for file(1) program
 * @(#)Id: file.h,v 1.43 2002/07/03 18:57:52 christos Exp 
 *
 * Copyright (c) Ian F. Darwin, 1987.
 * Written by Ian F. Darwin.
 *
 * This software is not subject to any license of the American Telephone
 * and Telegraph Company or of the Regents of the University of California.
 *
 * Permission is granted to anyone to use this software for any purpose on
 * any computer system, and to alter it and redistribute it freely, subject
 * to the following restrictions:
 *
 * 1. The author is not responsible for the consequences of use of this
 *    software, no matter how awful, even if they arise from flaws in it.
 *
 * 2. The origin of this software must not be misrepresented, either by
 *    explicit claim or by omission.  Since few users ever read sources,
 *    credits must appear in the documentation.
 *
 * 3. Altered versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.  Since few users
 *    ever read sources, credits must appear in the documentation.
 *
 * 4. This notice may not be removed or altered.
 */

#ifndef __file_h__
#define __file_h__

#ifndef HOWMANY
# define HOWMANY 65536		/* how much of the file to look at */
#endif
#define MAXMAGIS 4096		/* max entries in /etc/magic */
#define MAXDESC	50		/* max leng of text description */
#define MAXstring 32		/* max leng of "string" types */

#define MAGICNO		0xF11E041C
#define VERSIONNO	1

#define CHECK	1
#define COMPILE	2

struct magic {
	uint16_t cont_level;	/* level of ">" */
	uint8_t nospflag;	/* supress space character */
	uint8_t flag;
#define INDIR	1		/* if '>(...)' appears,  */
#define	UNSIGNED 2		/* comparison is unsigned */
#define OFFADD	4		/* if '>&' appears,  */
	uint8_t reln;		/* relation (0=eq, '>'=gt, etc) */
	uint8_t vallen;		/* length of string value, if any */
	uint8_t type;		/* int, short, long or string. */
	uint8_t in_type;	/* type of indirrection */
#define 			BYTE	1
#define				SHORT	2
#define				LONG	4
#define				STRING	5
#define				DATE	6
#define				BESHORT	7
#define				BELONG	8
#define				BEDATE	9
#define				LESHORT	10
#define				LELONG	11
#define				LEDATE	12
#define				PSTRING	13
#define				LDATE	14
#define				BELDATE	15
#define				LELDATE	16
#define				REGEX	17
	uint8_t in_op;		/* operator for indirection */
	uint8_t mask_op;	/* operator for mask */
#define				OPAND	1
#define				OPOR	2
#define				OPXOR	3
#define				OPADD	4
#define				OPMINUS	5
#define				OPMULTIPLY	6
#define				OPDIVIDE	7
#define				OPMODULO	8
#define				OPINVERSE	0x80
	int32_t offset;		/* offset to magic number */
	int32_t in_offset;	/* offset from indirection */
	union VALUETYPE {
		uint8_t b;
		uint16_t h;
		uint32_t l;
		char s[MAXstring];
		const char * buf;
		uint8_t hs[2];	/* 2 bytes of a fixed-endian "short" */
		uint8_t hl[4];	/* 4 bytes of a fixed-endian "long" */
	} value;		/* either number or string */
	uint32_t mask;	/* mask before comparison with value */
	char desc[MAXDESC];	/* description */
} __attribute__((__packed__));

#define BIT(A)   (1 << (A))
#define STRING_IGNORE_LOWERCASE		BIT(0)
#define STRING_COMPACT_BLANK		BIT(1)
#define STRING_COMPACT_OPTIONAL_BLANK	BIT(2)
#define CHAR_IGNORE_LOWERCASE		'c'
#define CHAR_COMPACT_BLANK		'B'
#define CHAR_COMPACT_OPTIONAL_BLANK	'b'


/* list of magic entries */
struct mlist {
	struct magic *magic;		/* array of magic entries */
	uint32_t nmagic;		/* number of entries in array */
/*@relnull@*/
	struct mlist *next;
/*@relnull@*/
	struct mlist *prev;
};

enum fmagicFlags_e {
/*@-enummemuse@*/
    FMAGIC_FLAGS_NONE		= 0,
/*@=enummemuse@*/
    FMAGIC_FLAGS_DEBUG		= (1 << 0),
    FMAGIC_FLAGS_BRIEF		= (1 << 1),	/*!< brief output format */
    FMAGIC_FLAGS_MIME		= (1 << 2),	/*!< output as mime-types */
    FMAGIC_FLAGS_CONTINUE	= (1 << 3),	/*!< continue after 1st match */
    FMAGIC_FLAGS_FOLLOW		= (1 << 4),	/*!< follow symlinks? */
    FMAGIC_FLAGS_SPECIAL	= (1 << 5),	/*!< analyze block devices? */
    FMAGIC_FLAGS_UNCOMPRESS	= (1 << 6)	/*!< uncompress files? */
};

struct fmagic_s {
    int flags;			/*!< bit(s) to control fmagic behavior. */
/*@dependent@*/ /*@observer@*/ /*@relnull@*/
    const char *magicfile;	/*!< name of the magic file		*/
    int lineno;			/*!< current line number in magic file	*/
/*@relnull@*/
    struct mlist * mlist;	/*!< list of arrays of magic entries	*/
/*@relnull@*/
    struct mlist * ml;		/*!< current magic array item		*/
/*@observer@*/
    const char * fn;		/*!< current file name			*/
    int fd;			/*!< current file descriptor            */
    struct stat sb;		/*!< current file stat(2) buffer	*/
/*@relnull@*/
    unsigned char * buf;	/*!< current file buffer		*/
    int nb;			/*!< current no. bytes in file buffer	*/
    union VALUETYPE val;	/*!< current magic expression value	*/
    int cls;			/*!< Elf class				*/
    int swap;			/*!< Elf swap bytes?			*/
/*@dependent@*/
    char * obp;			/*!< current output buffer pointer	*/
    size_t nob;			/*!< bytes remaining in output buffer	*/
    char obuf[512];		/*!< output buffer			*/
};

typedef /*@abstract@*/ struct fmagic_s * fmagic;

/*unchecked@*/
extern fmagic global_fmagic;

/*@unchecked@*//*@observer@*/
extern const char * default_magicfile;

#ifdef __cplusplus
extern "C" {
#endif

/*@mayexit@*/
extern int fmagicSetup(fmagic fm, const char *fn, int action)
	/*@globals fileSystem, internalState @*/
	/*@modifies fm, fileSystem, internalState @*/;
extern int fmagicProcess(fmagic fm, const char *fn, int wid)
	/*@globals fileSystem, internalState @*/
	/*@modifies fm, fileSystem, internalState @*/;

extern int fmagicA(fmagic fm)
	/*@modifies fm @*/;
extern int fmagicD(fmagic fm)
	/*@globals fileSystem, internalState @*/
	/*@modifies fm, fileSystem, internalState @*/;
extern void fmagicE(fmagic fm)
	/*@globals fileSystem, internalState @*/
	/*@modifies fm, fileSystem, internalState @*/;
extern int fmagicF(fmagic fm, int zfl)
	/*@globals fileSystem, internalState @*/
	/*@modifies fm, fileSystem, internalState @*/;
extern int fmagicS(fmagic fm)
	/*@globals fileSystem @*/
	/*@modifies fm, fileSystem @*/;
extern int fmagicZ(fmagic fm)
	/*@globals fileSystem, internalState @*/
	/*@modifies fm, fileSystem, internalState @*/;

extern void fmagicPrintf(const fmagic fm, const char *f, ...)
	/*@modifies fm @*/;

/*@observer@*/
extern char *fmttime(long v, int local)
	/*@*/;

extern void magwarn(const char *f, ...)
	/*@globals fileSystem @*/
	/*@modifies fileSystem @*/;
extern void mdump(struct magic *m)
	/*@globals fileSystem @*/
	/*@modifies fileSystem @*/;
extern void showstr(FILE *fp, const char *s, int len)
	/*@globals fileSystem @*/
	/*@modifies fp, fileSystem @*/;

extern uint32_t signextend(struct magic *m, uint32_t v)
	/*@globals fileSystem @*/
	/*@modifies fileSystem @*/;
extern int pipe2file(int fd, void *startbuf, size_t nbytes)
	/*@globals errno, fileSystem, internalState @*/
	/*@modifies errno, fileSystem, internalState @*/;

#ifdef __cplusplus
}
#endif

#endif /* __file_h__ */