-
Notifications
You must be signed in to change notification settings - Fork 0
/
kextfind_query.h
445 lines (380 loc) · 13.7 KB
/
kextfind_query.h
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
/*
* Copyright (c) 2006 Apple Computer, Inc. All rights reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#ifndef _KEXTFIND_QUERY_H_
#define _KEXTFIND_QUERY_H_
#include "QEQuery.h"
#include "kextfind_tables.h"
/*******************************************************************************
* PREDICATES
*
* These are the basic atoms of a query expression.
*******************************************************************************/
/*****
* Info Dictionary predicates.
*/
#define kPredNameProperty "-property"
#define kPredNamePropertyExists "-property-exists"
#define kPredNameMatchProperty "-match-property"
#define kPredNameMatchPropertyExists "-match-property-exists"
/*****
* "Flag" predicates.
*
* Any predicate that is just "is the kext so?" is considered a boolean flag
* and handled internally with the same eval callback, triggered by the
* special kPredNameFlag predicate; the predicate keyword itself is stored
* in the query element under the key "flag".
*/
#define kPredNameFlag "__flag__"
#define kPredNameLoaded "-loaded"
#define kPredNameValid "-valid"
#define kPredNameAuthentic "-authentic"
#define kPredNameDependenciesMet "-dependencies-met"
#define kPredNameLoadable "-loadable"
#define kPredNameWarnings "-warnings"
#define kPredNameIsLibrary "-library"
#define kPredNameHasPlugins "-has-plugins"
#define kPredNameIsPlugin "-plugin"
#define kPredNameHasDebugProperties "-debug"
#define kPredNameIsKernelResource "-kernel-resource"
#define kPredNameDuplicate "-duplicate-id"
// Flag Shorthands; I may dump these as they are all just logical
// negations of shorter predicates.
#define kPredNameInvalid "-invalid"
#define kPredNameInauthentic "-inauthentic"
#define kPredNameDependenciesMissing "-dependencies-missing"
#define kPredNameNonloadable "-nonloadable"
/*****
* Version-checking predicates.
*/
#define kPredNameVersion "-version"
#define kPredNameCompatibleWithVersion "-compatible-with-version"
/*****
* BOM-integrity predicates.
*
* Kext integrity is no longer used on SnowLeopard. We read the
* flags but no kext will ever match them now.
*/
#define kPredNameIntegrity "-integrity"
/*****
* Executable-checking predicates.
*/
#define kPredNameArch "-arch"
#define kPredNameArchExact "-arch-exact"
#define kPredNameExecutable "-executable"
#define kPredNameNoExecutable "-no-executable"
#define kPredNameDefinesSymbol "-defines-symbol"
#define kPredNameReferencesSymbol "-references-symbol"
/*****
* Property shorthands.
*
* The bundle ID shorthands are direct property queries, and work with
* the -case-insensitive command line option, but the OSBundleRequired
* shorthands enforce strict case-matching for correct handling.
*/
#define kPredNameBundleID "-bundle-id"
#define kPredNameBundleName "-bundle-name"
#define kPredNameRoot "-root"
#define kPredNameConsole "-console"
#define kPredNameLocalRoot "-local-root"
#define kPredNameNetworkRoot "-network-root"
#define kPredNameSafeBoot "-safe-boot"
/*****
* Output commands.
*
* These all print some info and evaluate to true.
*
* All commands are handled internally with the same eval callback, triggered
* by the special kPredNameCommand predicate; the command itself is stored
* in the query element under the key "command".
*/
#define kPredNameCommand "__command__"
// Any command that begins with this, except for -print0 and -print-diagnostics,
// can take the -0 option to terminate output with a nul rather than a newline.
#define kPredPrefixPrint "-print"
#define kPredNameEcho "-echo"
#define kPredNameExec "-exec"
#define kPredNamePrint "-print"
#define kPredNamePrint0 "-print0"
#define kPredNamePrintDiagnostics "-print-diagnostics"
#define kPredNamePrintProperty "-print-property"
#define kPredNamePrintMatchProperty "-print-match-property"
#define kPredNamePrintArches "-print-arches"
#define kPredNamePrintDependencies "-print-dependencies"
#define kPredNamePrintDependents "-print-dependents"
#define kPredNamePrintIntegrity "-print-integrity"
#define kPredNamePrintPlugins "-print-plugins"
#define kPredNamePrintInfoDictionary "-print-info-dictionary"
#define kPredNamePrintExecutable "-print-executable"
#define kExecInfoDictionaryReplace "{info-dictionary}"
#define kExecExecutableReplace "{executable}"
#define kExecBundlePathReplace "{}"
#define kExecTerminator ";"
/*****
* Shorter options for the more common predicates.
*/
#define kPredCharProperty "-p"
#define kPredCharPropertyExists "-pe"
#define kPredCharMatchProperty "-m"
#define kPredCharMatchPropertyExists "-me"
#define kPredCharValid "-v"
#define kPredCharAuthentic "-a"
#define kPredCharDependenciesMet "-d"
#define kPredCharLoadable "-l"
#define kPredCharDuplicate "-dup"
#define kPredCharInvalid "-nv"
#define kPredCharInauthentic "-na"
#define kPredCharDependenciesMissing "-nd"
#define kPredCharNonloadable "-nl"
#define kPredCharWarnings "-w"
#define kPredCharVersion "-V"
#define kPredCharIsLibrary "-lib"
#define kPredCharArchExact "-ax"
#define kPredCharExecutable "-x"
#define kPredCharNoExecutable "-nx"
#define kPredCharDefinesSymbol "-dsym"
#define kPredCharReferencesSymbol "-rsym"
#define kPredCharBundleID "-b"
#define kPredCharBundleName "-B"
#define kPredCharRoot "-R"
#define kPredCharConsole "-C"
#define kPredCharLocalRoot "-L"
#define kPredCharNetworkRoot "-N"
#define kPredCharSafeBoot "-S"
//#define kPredCharPrint0 "-p0"
#define kPredCharPrintDiagnostics "-pdiag"
#define kPredCharPrintProperty "-pp"
#define kPredCharPrintMatchProperty "-pm"
#define kPredCharPrintArches "-pa"
//#define kPredCharPrintDependencies "-print-dependencies"
//#define kPredCharPrintDependents "-print-dependents"
//#define kPredCharPrintPlugins "-print-plugins"
#define kPredCharPrintInfoDictionary "-pid"
#define kPredCharPrintExecutable "-px"
/*******************************************************************************
* Stuff for query & reporting parse/eval.
*******************************************************************************/
/*****
* Options to predicates. These do *not* include the hyphen
* cause they get used with getopt_long_only().
*/
// Do not use -1, that's getopt() end-of-args return value
#define kPredOptNameNoNewline "no-newline"
#define kPredOptNoNewline 'n'
#define kPredOptNameCaseInsensitive kOptNameCaseInsensitive
#define kPredOptCaseInsensitive kOptCaseInsensitive
#define kPredOptNameSubstring "substring"
#define kPredOptSubstring 's'
/*****
* These keys get stuffed into a query element dictionary to alter how it's
* evaluated. (Maybe they should get put into the arguments.)
*/
#define kSearchStyleExact "exact"
#define kSearchStyleCaseInsensitive "case-insensitive"
#define kSearchStyleSubstring "substring"
#define kSearchStyleKeyExists "exists"
/*****
* XXX: These OSBundleRequired definitions should be done by the kext library.
*/
#define kOSBundleRequired "OSBundleRequired"
#define kOSBundleRequiredRoot "Root"
#define kOSBundleRequiredConsole "Console"
#define kOSBundleRequiredLocalRoot "Local-Root"
#define kOSBundleRequiredNetworkRoot "Network-Root"
#define kOSBundleRequiredSafeBoot "Safe Boot"
/*****
* Command-line keywords for the five possible integrity states.
*
* Kext integrity is no longer used on SnowLeopard. We read the
* flags but no kext will ever match them now.
*/
#define kIntegrityCorrect "correct"
#define kIntegrityUnknown "unknown"
#define kIntegrityNotApple "not-apple"
#define kIntegrityNoReceipt "no-receipt"
#define kIntegrityModified "modified"
#define kIntegrityNotApplicable "n/a"
#define kKeywordFlag "flag"
#define kKeywordCommand "command"
#define kWordTrue "true"
#define kWordYes "yes"
#define kWord1 "1"
#define kWordFalse "false"
#define kWordNo "no"
#define kWord0 "0"
/*******************************************************************************
* Query Engine Callbacks
*
* The Query Engine invokes these as it finds keywords from the above list
* in the command line or the query being evaluated.
*******************************************************************************/
Boolean parseArgument(
CFMutableDictionaryRef element,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean parseBundleName(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalBundleName(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean parseProperty(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean parseShorthand(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalProperty(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean parseMatchProperty(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalMatchProperty(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean parseIntegrity(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalIntegrity(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean parseFlag(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalFlag(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean parseVersion(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalVersion(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean parseCompatibleWithVersion(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalCompatibleWithVersion(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean parseArch(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalArch(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean evalArchExact(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean parseCommand(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean parseDefinesOrReferencesSymbol(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalDefinesOrReferencesSymbol(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean evalCommand(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
Boolean parseExec(
CFMutableDictionaryRef element,
int argc,
char * const argv[],
uint32_t * num_used,
void * user_data,
QEQueryError * error);
Boolean evalExec(
CFDictionaryRef queryElement,
void * object,
void * user_data,
QEQueryError * error);
#endif /* _KEXTFIND_QUERY_H_ */