blob: 74f91e7781fc304fdbb73e7edca2441c6d177e03 [file] [log] [blame]
Robert Swieckia88f96f2015-10-09 16:47:39 +02001/*
2
3 honggfuzz - cmdline parsing
4
5 -----------------------------------------
6
7 Copyright 2014 Google Inc. All Rights Reserved.
8
9 Licensed under the Apache License, Version 2.0 (the "License");
10 you may not use this file except in compliance with the License.
11 You may obtain a copy of the License at
12
13 http://www.apache.org/licenses/LICENSE-2.0
14
15 Unless required by applicable law or agreed to in writing, software
16 distributed under the License is distributed on an "AS IS" BASIS,
17 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 See the License for the specific language governing permissions and
19 limitations under the License.
20
21*/
22
23#include "cmdline.h"
24
25#include <ctype.h>
26#include <errno.h>
27#include <getopt.h>
Robert Swieckia88f96f2015-10-09 16:47:39 +020028#include <inttypes.h>
29#include <limits.h>
Robert Swiecki846ccd72017-01-12 17:52:23 +010030#if defined(_HF_ARCH_LINUX)
31#include <sched.h>
Robert Swiecki4e595fb2017-10-11 17:26:51 +020032#endif /* defined(_HF_ARCH_LINUX) */
Robert Swiecki846ccd72017-01-12 17:52:23 +010033#include <signal.h>
Robert Swieckia88f96f2015-10-09 16:47:39 +020034#include <stdio.h>
Robert Swieckid0fa62c2017-09-28 18:11:05 +020035#include <stdlib.h>
Robert Swieckia88f96f2015-10-09 16:47:39 +020036#include <string.h>
Robert Swieckif8292582018-01-10 16:19:18 +010037#include <sys/mman.h>
Robert Swiecki3bfc33c2016-03-14 18:12:41 +010038#include <sys/queue.h>
Robert Swieckia35d9d82017-12-15 22:00:41 +010039#include <sys/stat.h>
40#include <sys/types.h>
Robert Swieckia88f96f2015-10-09 16:47:39 +020041#include <unistd.h>
42
Robert Swiecki246af3e2018-01-05 14:56:32 +010043#include "libhfcommon/common.h"
44#include "libhfcommon/files.h"
45#include "libhfcommon/log.h"
46#include "libhfcommon/util.h"
Robert Swieckia88f96f2015-10-09 16:47:39 +020047
48struct custom_option {
49 struct option opt;
Robert Swiecki4e595fb2017-10-11 17:26:51 +020050 const char* descr;
Robert Swieckia88f96f2015-10-09 16:47:39 +020051};
52
Robert Swiecki97d0cee2017-12-18 00:17:50 +010053static bool checkFor_FILE_PLACEHOLDER(const char* const* args) {
Robert Swieckia88f96f2015-10-09 16:47:39 +020054 for (int x = 0; args[x]; x++) {
Robert Swieckid50ed422017-11-13 23:32:26 +010055 if (strstr(args[x], _HF_FILE_PLACEHOLDER)) return true;
Robert Swieckia88f96f2015-10-09 16:47:39 +020056 }
57 return false;
58}
59
Robert Swieckif8292582018-01-10 16:19:18 +010060static bool cmdlineCheckIfPersistent(const char* fname) {
61 int fd;
62 off_t fileSz;
63 int ret = false;
64
65 uint8_t* map = files_mapFile(fname, &fileSz, &fd, /* isWriteable= */ false);
66 if (map == MAP_FAILED) {
67 LOG_W("Couldn't map file '%s' to check whether it's a persistent binary", fname);
68 return false;
69 }
70 if (memmem(map, fileSz, _HF_PERSISTENT_SIG, strlen(_HF_PERSISTENT_SIG))) {
71 ret = true;
72 }
73 if (munmap(map, fileSz) == -1) {
Robert Swieckic3d5d5b2018-01-11 02:29:11 +010074 PLOG_W("munmap(%p, %zu)", map, (size_t)fileSz);
Robert Swieckif8292582018-01-10 16:19:18 +010075 }
76 close(fd);
77 return ret;
78}
79
Robert Swiecki0b566112017-10-17 17:39:07 +020080static const char* cmdlineYesNo(bool yes) { return (yes ? "true" : "false"); }
Robert Swieckia88f96f2015-10-09 16:47:39 +020081
Robert Swieckid50ed422017-11-13 23:32:26 +010082static void cmdlineHelp(const char* pname, struct custom_option* opts) {
Robert Swieckia88f96f2015-10-09 16:47:39 +020083 LOG_HELP_BOLD("Usage: %s [options] -- path_to_command [args]", pname);
84 LOG_HELP_BOLD("Options:");
85 for (int i = 0; opts[i].opt.name; i++) {
Robert Swieckif3a5f6a2016-03-16 14:47:30 +010086 if (isprint(opts[i].opt.val) && opts[i].opt.val < 0x80) {
Robert Swiecki0b566112017-10-17 17:39:07 +020087 LOG_HELP_BOLD(" --%s%s%c %s", opts[i].opt.name, "|-", opts[i].opt.val,
Robert Swiecki4e595fb2017-10-11 17:26:51 +020088 opts[i].opt.has_arg == required_argument ? "VALUE" : "");
Robert Swieckia88f96f2015-10-09 16:47:39 +020089 } else {
90 LOG_HELP_BOLD(" --%s %s", opts[i].opt.name,
Robert Swiecki4e595fb2017-10-11 17:26:51 +020091 opts[i].opt.has_arg == required_argument ? "VALUE" : "");
Robert Swieckia88f96f2015-10-09 16:47:39 +020092 }
93 LOG_HELP("\t%s", opts[i].descr);
94 }
Jagger32127372015-10-09 23:07:38 +020095 LOG_HELP_BOLD("\nExamples:");
Robert Swieckid50ed422017-11-13 23:32:26 +010096 LOG_HELP(
97 " Run the binary over a mutated file chosen from the directory. Disable fuzzing "
98 "feedback (dry/static mode)");
Robert Swiecki216a4362017-12-13 13:02:52 +010099 LOG_HELP_BOLD(" " PROG_NAME " -f input_dir -x -- /usr/bin/djpeg " _HF_FILE_PLACEHOLDER);
Jagger32127372015-10-09 23:07:38 +0200100 LOG_HELP(" As above, provide input over STDIN:");
Robert Swiecki930e12f2017-10-24 14:52:03 +0200101 LOG_HELP_BOLD(" " PROG_NAME " -f input_dir -x -s -- /usr/bin/djpeg");
Jaggere848cc72016-09-19 02:28:52 +0200102 LOG_HELP(" Use compile-time instrumentation (libhfuzz/instrument.c):");
Robert Swiecki216a4362017-12-13 13:02:52 +0100103 LOG_HELP_BOLD(" " PROG_NAME " -f input_dir -- /usr/bin/djpeg " _HF_FILE_PLACEHOLDER);
Robert Swiecki930e12f2017-10-24 14:52:03 +0200104 LOG_HELP(" Use SANCOV instrumentation:");
Robert Swiecki216a4362017-12-13 13:02:52 +0100105 LOG_HELP_BOLD(" " PROG_NAME " -f input_dir -C -- /usr/bin/djpeg " _HF_FILE_PLACEHOLDER);
Robert Swiecki930e12f2017-10-24 14:52:03 +0200106 LOG_HELP(" Use persistent mode (libhfuzz/persistent.c) w/o instrumentation:");
Robert Swiecki216a4362017-12-13 13:02:52 +0100107 LOG_HELP_BOLD(" " PROG_NAME " -f input_dir -P -x -- /usr/bin/djpeg_persistent_mode");
Robert Swiecki930e12f2017-10-24 14:52:03 +0200108 LOG_HELP(" Use persistent mode (libhfuzz/persistent.c) and compile-time instrumentation:");
Robert Swiecki216a4362017-12-13 13:02:52 +0100109 LOG_HELP_BOLD(" " PROG_NAME " -f input_dir -P -- /usr/bin/djpeg_persistent_mode");
Robert Swieckia88f96f2015-10-09 16:47:39 +0200110#if defined(_HF_ARCH_LINUX)
Robert Swiecki930e12f2017-10-24 14:52:03 +0200111 LOG_HELP(
112 " Run the binary with dynamically generate inputs, maximize total no. of instructions:");
Robert Swiecki216a4362017-12-13 13:02:52 +0100113 LOG_HELP_BOLD(" " PROG_NAME " --linux_perf_instr -- /usr/bin/djpeg " _HF_FILE_PLACEHOLDER);
Robert Swiecki930e12f2017-10-24 14:52:03 +0200114 LOG_HELP(" As above, maximize total no. of branches:");
Robert Swiecki216a4362017-12-13 13:02:52 +0100115 LOG_HELP_BOLD(" " PROG_NAME " --linux_perf_branch -- /usr/bin/djpeg " _HF_FILE_PLACEHOLDER);
Robert Swiecki930e12f2017-10-24 14:52:03 +0200116 LOG_HELP(" As above, maximize unique branches (edges) via Intel BTS:");
Robert Swiecki216a4362017-12-13 13:02:52 +0100117 LOG_HELP_BOLD(" " PROG_NAME " --linux_perf_bts_edge -- /usr/bin/djpeg " _HF_FILE_PLACEHOLDER);
Robert Swiecki930e12f2017-10-24 14:52:03 +0200118 LOG_HELP(
119 " As above, maximize unique code blocks via Intel Processor Trace (requires libipt.so):");
Robert Swiecki216a4362017-12-13 13:02:52 +0100120 LOG_HELP_BOLD(" " PROG_NAME " --linux_perf_ipt_block -- /usr/bin/djpeg " _HF_FILE_PLACEHOLDER);
Robert Swiecki4e595fb2017-10-11 17:26:51 +0200121#endif /* defined(_HF_ARCH_LINUX) */
Robert Swieckia88f96f2015-10-09 16:47:39 +0200122}
123
Robert Swieckid50ed422017-11-13 23:32:26 +0100124static void cmdlineUsage(const char* pname, struct custom_option* opts) {
Robert Swieckia88f96f2015-10-09 16:47:39 +0200125 cmdlineHelp(pname, opts);
126 exit(0);
127}
128
Robert Swieckid50ed422017-11-13 23:32:26 +0100129rlim_t cmdlineParseRLimit(int res, const char* optarg, unsigned long mul) {
Robert Swieckia88f96f2015-10-09 16:47:39 +0200130 struct rlimit cur;
131 if (getrlimit(res, &cur) == -1) {
132 PLOG_F("getrlimit(%d)", res);
133 }
134 if (strcasecmp(optarg, "max") == 0) {
135 return cur.rlim_max;
136 }
137 if (strcasecmp(optarg, "def") == 0) {
138 return cur.rlim_cur;
139 }
Anestis Bechtsoudis413cb132016-02-07 12:59:00 +0200140 if (util_isANumber(optarg) == false) {
Robert Swieckia88f96f2015-10-09 16:47:39 +0200141 LOG_F("RLIMIT %d needs a numeric or 'max'/'def' value ('%s' provided)", res, optarg);
142 }
143 rlim_t val = strtoul(optarg, NULL, 0) * mul;
Jagger2bd61b72015-10-10 05:23:32 +0200144 if ((unsigned long)val == ULONG_MAX && errno != 0) {
Robert Swieckia88f96f2015-10-09 16:47:39 +0200145 PLOG_F("strtoul('%s', 0)", optarg);
146 }
147 return val;
148}
149
Robert Swieckia35d9d82017-12-15 22:00:41 +0100150static bool cmdlineVerify(honggfuzz_t* hfuzz) {
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100151 if (!hfuzz->exe.fuzzStdin && !hfuzz->persistent &&
152 !checkFor_FILE_PLACEHOLDER(hfuzz->exe.cmdline)) {
Robert Swieckia35d9d82017-12-15 22:00:41 +0100153 LOG_E("You must specify '" _HF_FILE_PLACEHOLDER
154 "' when the -s (stdin fuzzing) or --persistent options are not set");
155 return false;
156 }
157
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100158 if (hfuzz->exe.fuzzStdin && hfuzz->persistent) {
Robert Swieckia35d9d82017-12-15 22:00:41 +0100159 LOG_E(
160 "Stdin fuzzing (-s) and persistent fuzzing (-P) cannot be specified at the same time");
161 return false;
162 }
163
164 if (hfuzz->threads.threadsMax >= _HF_THREAD_MAX) {
165 LOG_E("Too many fuzzing threads specified %zu (>= _HF_THREAD_MAX (%u))",
166 hfuzz->threads.threadsMax, _HF_THREAD_MAX);
167 return false;
168 }
169
170 if (strchr(hfuzz->io.fileExtn, '/')) {
171 LOG_E("The file extension contains the '/' character: '%s'", hfuzz->io.fileExtn);
172 return false;
173 }
174
175 if (hfuzz->io.workDir == NULL) {
176 hfuzz->io.workDir = ".";
177 }
178 if (mkdir(hfuzz->io.workDir, 0700) == -1 && errno != EEXIST) {
179 PLOG_E("Couldn't create the workspace directory '%s'", hfuzz->io.workDir);
180 return false;
181 }
182 if (hfuzz->io.crashDir == NULL) {
183 hfuzz->io.crashDir = hfuzz->io.workDir;
184 }
185 if (mkdir(hfuzz->io.crashDir, 0700) && errno != EEXIST) {
186 PLOG_E("Couldn't create the crash directory '%s'", hfuzz->io.crashDir);
187 return false;
188 }
189
190 if (hfuzz->linux.pid > 0 || hfuzz->linux.pidFile) {
191 LOG_I("PID=%d specified, lowering maximum number of concurrent threads to 1",
192 hfuzz->linux.pid);
193 hfuzz->threads.threadsMax = 1;
194 }
195
196 if (hfuzz->mutationsPerRun == 0U && hfuzz->useVerifier) {
197 LOG_I("Verifier enabled with mutationsPerRun == 0, activating the dry run mode");
198 }
199
200 /*
201 * 'enableSanitizers' can be auto enabled when 'useSanCov', although it's probably
202 * better to let user know about the features that each flag control.
203 */
204 if (hfuzz->useSanCov == true && hfuzz->enableSanitizers == false) {
205 LOG_E("Sanitizer coverage cannot be used without enabling sanitizers '-S/--sanitizers'");
206 return false;
207 }
208
Robert Swiecki0a01ea72018-01-11 01:50:18 +0100209 if (hfuzz->maxFileSz > _HF_INPUT_MAX_SIZE) {
210 LOG_E("Maximum file size '%zu' bigger than the maximum size '%zu'", hfuzz->maxFileSz,
211 (size_t)_HF_INPUT_MAX_SIZE);
212 return false;
213 }
214
Robert Swieckia35d9d82017-12-15 22:00:41 +0100215 return true;
216}
217
Robert Swieckid50ed422017-11-13 23:32:26 +0100218bool cmdlineParse(int argc, char* argv[], honggfuzz_t* hfuzz) {
219 honggfuzz_t tmp = {
Robert Swiecki82c707c2017-11-14 16:36:23 +0100220 .io =
221 {
222 .inputDir = NULL,
Robert Swieckia35d9d82017-12-15 22:00:41 +0100223 .inputDirPtr = NULL,
Robert Swiecki82c707c2017-11-14 16:36:23 +0100224 .fileCnt = 0,
225 .fileCntDone = false,
226 .fileExtn = "fuzz",
Robert Swieckiced3eba2017-12-15 15:33:03 +0100227 .workDir = NULL,
228 .crashDir = NULL,
229 .covDirAll = NULL,
230 .covDirNew = NULL,
Robert Swiecki26fd6d52017-11-15 00:46:21 +0100231 .saveUnique = true,
Robert Swiecki82c707c2017-11-14 16:36:23 +0100232 },
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100233 .exe =
234 {
Robert Swiecki2aeff252018-01-10 14:58:44 +0100235 .argc = 0,
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100236 .cmdline = NULL,
237 .nullifyStdio = true,
238 .fuzzStdin = false,
239 .externalCommand = NULL,
240 .postExternalCommand = NULL,
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100241 .asLimit = 0U,
242 .rssLimit = 0U,
243 .dataLimit = 0U,
244 .clearEnv = false,
245 .envs[0] = NULL,
246 },
Robert Swiecki371e1292017-12-18 01:10:33 +0100247 .timing =
248 {
249 .timeStart = time(NULL),
250 .runEndTime = 0,
251 .tmOut = 10,
Robert Swieckieba27172017-12-18 01:12:02 +0100252 .tmoutVTALRM = false,
Robert Swiecki371e1292017-12-18 01:10:33 +0100253 },
Robert Swieckif4cbd8b2018-01-10 23:28:01 +0100254 .cmdline_txt[0] = '\0',
Robert Swiecki6c9f6822016-03-14 16:12:27 +0100255 .useScreen = true,
256 .useVerifier = false,
Robert Swiecki10e93562017-11-04 00:57:47 +0100257 .mutationsPerRun = 6U,
Robert Swieckia88f96f2015-10-09 16:47:39 +0200258 .blacklistFile = NULL,
259 .blacklistCnt = 0,
260 .blacklist = NULL,
Jaggerf4a60562016-09-25 15:40:23 +0200261 .maxFileSz = 0UL,
Robert Swieckia88f96f2015-10-09 16:47:39 +0200262 .mutationsMax = 0,
Robert Swieckia88f96f2015-10-09 16:47:39 +0200263 .reportFile = NULL,
Robert Swiecki0f937af2016-03-30 18:19:16 +0200264 .persistent = false,
Robert Swiecki44f6b192017-02-15 20:24:55 +0100265 .skipFeedbackOnTimeout = false,
Anestis Bechtsoudise5f09f82016-12-27 16:06:05 +0200266 .enableSanitizers = false,
267#if defined(__ANDROID__)
268 .monitorSIGABRT = false,
269#else
270 .monitorSIGABRT = true,
271#endif
Robert Swieckic95cf2a2017-06-23 15:31:08 +0200272 .exitUponCrash = false,
Robert Swieckia88f96f2015-10-09 16:47:39 +0200273
Robert Swieckid50ed422017-11-13 23:32:26 +0100274 .threads =
275 {
276 .threadsFinished = 0,
277 .threadsMax =
278 (sysconf(_SC_NPROCESSORS_ONLN) <= 1) ? 1 : sysconf(_SC_NPROCESSORS_ONLN) / 2,
279 .threadsActiveCnt = 0,
Robert Swiecki82c707c2017-11-14 16:36:23 +0100280 .mainThread = pthread_self(),
281 .mainPid = getpid(),
Robert Swieckid50ed422017-11-13 23:32:26 +0100282 },
Robert Swiecki66b65122017-11-11 02:55:55 +0100283
Robert Swiecki531438a2016-09-13 19:05:11 +0200284 .dictionaryFile = NULL,
285 .dictionaryCnt = 0,
Robert Swiecki9f5f9432017-03-09 01:48:04 +0100286 .dictqCurrent = NULL,
Robert Swiecki531438a2016-09-13 19:05:11 +0200287
Robert Swiecki6c9f6822016-03-14 16:12:27 +0100288 .state = _HF_STATE_UNSET,
Jaggerb7fa3ee2016-08-21 19:46:26 +0200289 .feedback = NULL,
Robert Swieckibc7532e2016-08-20 00:34:17 +0200290 .bbFd = -1,
Robert Swiecki9f5f9432017-03-09 01:48:04 +0100291
Robert Swiecki3bfc33c2016-03-14 18:12:41 +0100292 .dynfileqCnt = 0U,
Robert Swieckibf8f8cc2017-11-09 00:42:50 +0100293 .dynfileq_mutex = PTHREAD_RWLOCK_INITIALIZER,
Robert Swiecki6c9f6822016-03-14 16:12:27 +0100294
Robert Swiecki37498fd2017-03-12 21:12:54 +0100295 .feedback_mutex = PTHREAD_MUTEX_INITIALIZER,
296
Robert Swiecki01a980e2017-11-14 03:36:50 +0100297 .cnts =
298 {
299 .mutationsCnt = 0,
300 .crashesCnt = 0,
301 .uniqueCrashesCnt = 0,
302 .verifiedCrashesCnt = 0,
303 .blCrashesCnt = 0,
304 .timeoutedCnt = 0,
305 },
Robert Swieckia88f96f2015-10-09 16:47:39 +0200306
Robert Swiecki930e12f2017-10-24 14:52:03 +0200307 .dynFileMethod = _HF_DYNFILE_SOFT,
Robert Swieckid50ed422017-11-13 23:32:26 +0100308 .sanCovCnts =
309 {
310 .hitBBCnt = 0ULL,
311 .totalBBCnt = 0ULL,
312 .dsoCnt = 0ULL,
313 .iDsoCnt = 0ULL,
314 .newBBCnt = 0ULL,
315 .crashesCnt = 0ULL,
316 },
Robert Swieckia88f96f2015-10-09 16:47:39 +0200317
Robert Swiecki66b65122017-11-11 02:55:55 +0100318 .sanCov_mutex = PTHREAD_MUTEX_INITIALIZER,
Robert Swiecki97d88932018-01-10 19:29:34 +0100319 .extSanOpts = NULL,
Robert Swiecki66b65122017-11-11 02:55:55 +0100320 .useSanCov = false,
321 .covMetadata = NULL,
Robert Swiecki6c9f6822016-03-14 16:12:27 +0100322
Haris Andrianakisc9a71332016-05-09 21:56:30 -0700323 .report_mutex = PTHREAD_MUTEX_INITIALIZER,
324
Robert Swiecki6c9f6822016-03-14 16:12:27 +0100325 /* Linux code */
Robert Swieckid50ed422017-11-13 23:32:26 +0100326 .linux =
327 {
Robert Swiecki4e595fb2017-10-11 17:26:51 +0200328 .exeFd = -1,
Robert Swieckid50ed422017-11-13 23:32:26 +0100329 .hwCnts =
330 {
331 .cpuInstrCnt = 0ULL,
332 .cpuBranchCnt = 0ULL,
333 .bbCnt = 0ULL,
334 .newBBCnt = 0ULL,
335 .softCntPc = 0ULL,
336 .softCntCmp = 0ULL,
337 },
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200338 .dynamicCutOffAddr = ~(0ULL),
339 .disableRandomization = true,
340 .ignoreAddr = NULL,
341 .numMajorFrames = 7,
342 .pid = 0,
343 .pidFile = NULL,
Robert Swiecki06008f72017-12-27 18:40:34 +0100344 .pidCmd = {},
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200345 .symsBlFile = NULL,
346 .symsBlCnt = 0,
347 .symsBl = NULL,
348 .symsWlFile = NULL,
349 .symsWlCnt = 0,
350 .symsWl = NULL,
351 .cloneFlags = 0,
352 .kernelOnly = false,
353 .useClone = true,
Jaggerab26e702016-03-22 04:28:00 +0100354 },
Robert Swieckia88f96f2015-10-09 16:47:39 +0200355 };
Robert Swieckid50ed422017-11-13 23:32:26 +0100356 *hfuzz = tmp;
Robert Swieckia88f96f2015-10-09 16:47:39 +0200357
Robert Swieckib0e261a2017-11-09 01:30:54 +0100358 TAILQ_INIT(&hfuzz->dynfileq);
Robert Swieckiafb16102017-03-13 22:14:31 +0100359 TAILQ_INIT(&hfuzz->dictq);
Robert Swiecki3bfc33c2016-03-14 18:12:41 +0100360
Robert Swiecki0b566112017-10-17 17:39:07 +0200361 // clang-format off
Robert Swieckia88f96f2015-10-09 16:47:39 +0200362 struct custom_option custom_opts[] = {
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200363 { { "help", no_argument, NULL, 'h' }, "Help plz.." },
364 { { "input", required_argument, NULL, 'f' }, "Path to a directory containing initial file corpus" },
365 { { "persistent", no_argument, NULL, 'P' }, "Enable persistent fuzzing (use hfuzz_cc/hfuzz-clang to compile code)" },
Robert Swiecki930e12f2017-10-24 14:52:03 +0200366 { { "instrument", no_argument, NULL, 'z' }, "*DEFAULT-MODE-BY-DEFAULT* Enable compile-time instrumentation (use hfuzz_cc/hfuzz-clang to compile code)" },
367 { { "noinst", no_argument, NULL, 'x' }, "Static mode (dry-mode), disable any instrumentation (hw/sw)" },
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200368 { { "sancov", no_argument, NULL, 'C' }, "Enable sanitizer coverage feedback" },
369 { { "keep_output", no_argument, NULL, 'Q' }, "Don't close children's stdin, stdout, stderr; can be noisy" },
370 { { "timeout", required_argument, NULL, 't' }, "Timeout in seconds (default: '10')" },
371 { { "threads", required_argument, NULL, 'n' }, "Number of concurrent fuzzing threads (default: number of CPUs / 2)" },
372 { { "stdin_input", no_argument, NULL, 's' }, "Provide fuzzing input on STDIN, instead of ___FILE___" },
Robert Swiecki5c673d62017-11-06 00:54:00 +0100373 { { "mutations_per_run", required_argument, NULL, 'r' }, "Maximal number of mutations per one run (default: '6')" },
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200374 { { "logfile", required_argument, NULL, 'l' }, "Log file" },
375 { { "verbose", no_argument, NULL, 'v' }, "Disable ANSI console; use simple log output" },
376 { { "verifier", no_argument, NULL, 'V' }, "Enable crashes verifier" },
Robert Swiecki97cd6242017-12-27 21:02:47 +0100377 { { "debug", no_argument, NULL, 'd' }, "Show debug messages (level >= 4)" },
378 { { "quiet", no_argument, NULL, 'q' }, "Show only warnings and more serious messages (level <= 1)" },
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200379 { { "extension", required_argument, NULL, 'e' }, "Input file extension (e.g. 'swf'), (default: 'fuzz')" },
380 { { "workspace", required_argument, NULL, 'W' }, "Workspace directory to save crashes & runtime files (default: '.')" },
Robert Swieckia35d9d82017-12-15 22:00:41 +0100381 { { "crashdir", required_argument, NULL, 0x600 }, "Directory where crashes are saved to (default: workspace directory)" },
382 { { "covdir_all", required_argument, NULL, 0x601 }, "Coverage is written to a separate directory (default: input directory)" },
383 { { "covdir_new", required_argument, NULL, 0x602 }, "New coverage (beyond the dry-run fuzzing phase) is written to this separate directory" },
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200384 { { "dict", required_argument, NULL, 'w' }, "Dictionary file. Format:http://llvm.org/docs/LibFuzzer.html#dictionaries" },
385 { { "stackhash_bl", required_argument, NULL, 'B' }, "Stackhashes blacklist file (one entry per line)" },
386 { { "mutate_cmd", required_argument, NULL, 'c' }, "External command producing fuzz files (instead of internal mutators)" },
387 { { "pprocess_cmd", required_argument, NULL, 0x104 }, "External command postprocessing files produced by internal mutators" },
388 { { "run_time", required_argument, NULL, 0x109 }, "Number of seconds this fuzzing session will last (default: '0' [no limit])" },
389 { { "iterations", required_argument, NULL, 'N' }, "Number of fuzzing iterations (default: '0' [no limit])" },
Robert Swiecki8954afd2017-11-14 18:14:22 +0100390 { { "rlimit_as", required_argument, NULL, 0x100 }, "Per process RLIMIT_AS in MiB (default: '0' [no limit])" },
391 { { "rlimit_rss", required_argument, NULL, 0x101 }, "Per process RLIMIT_RSS in MiB (default: '0' [no limit])" },
392 { { "rlimit_data", required_argument, NULL, 0x102 }, "Per process RLIMIT_DATA in MiB (default: '0' [no limit])" },
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200393 { { "report", required_argument, NULL, 'R' }, "Write report to this file (default: '" _HF_REPORT_FILE "')" },
394 { { "max_file_size", required_argument, NULL, 'F' }, "Maximal size of files processed by the fuzzer in bytes (default: '1048576')" },
Robert Swiecki8954afd2017-11-14 18:14:22 +0100395 { { "clear_env", no_argument, NULL, 0x108 }, "Clear all environment variables before executing the binary" },
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200396 { { "env", required_argument, NULL, 'E' }, "Pass this environment variable, can be used multiple times" },
397 { { "save_all", no_argument, NULL, 'u' }, "Save all test-cases (not only the unique ones) by appending the current time-stamp to the filenames" },
398 { { "tmout_sigvtalrm", no_argument, NULL, 'T' }, "Use SIGVTALRM to kill timeouting processes (default: use SIGKILL)" },
399 { { "sanitizers", no_argument, NULL, 'S' }, "Enable sanitizers settings (default: false)" },
Robert Swiecki97d88932018-01-10 19:29:34 +0100400 { { "san_opts", required_argument, NULL, 0x10A }, "Options appended to the regular *SAN_OPTIONS (default: empty)" },
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200401 { { "monitor_sigabrt", required_argument, NULL, 0x105 }, "Monitor SIGABRT (default: 'false for Android - 'true for other platforms)" },
402 { { "no_fb_timeout", required_argument, NULL, 0x106 }, "Skip feedback if the process has timeouted (default: 'false')" },
403 { { "exit_upon_crash", no_argument, NULL, 0x107 }, "Exit upon seeing the first crash (default: 'false')" },
Robert Swieckia88f96f2015-10-09 16:47:39 +0200404
405#if defined(_HF_ARCH_LINUX)
Robert Swieckid0fa62c2017-09-28 18:11:05 +0200406 { { "linux_symbols_bl", required_argument, NULL, 0x504 }, "Symbols blacklist filter file (one entry per line)" },
407 { { "linux_symbols_wl", required_argument, NULL, 0x505 }, "Symbols whitelist filter file (one entry per line)" },
408 { { "linux_pid", required_argument, NULL, 'p' }, "Attach to a pid (and its thread group)" },
409 { { "linux_file_pid", required_argument, NULL, 0x502 }, "Attach to pid (and its thread group) read from file" },
410 { { "linux_addr_low_limit", required_argument, NULL, 0x500 }, "Address limit (from si.si_addr) below which crashes are not reported, (default: '0')" },
411 { { "linux_keep_aslr", no_argument, NULL, 0x501 }, "Don't disable ASLR randomization, might be useful with MSAN" },
412 { { "linux_perf_ignore_above", required_argument, NULL, 0x503 }, "Ignore perf events which report IPs above this address" },
413 { { "linux_perf_instr", no_argument, NULL, 0x510 }, "Use PERF_COUNT_HW_INSTRUCTIONS perf" },
414 { { "linux_perf_branch", no_argument, NULL, 0x511 }, "Use PERF_COUNT_HW_BRANCH_INSTRUCTIONS perf" },
415 { { "linux_perf_bts_edge", no_argument, NULL, 0x513 }, "Use Intel BTS to count unique edges" },
416 { { "linux_perf_ipt_block", no_argument, NULL, 0x514 }, "Use Intel Processor Trace to count unique blocks (requires libipt.so)" },
417 { { "linux_perf_kernel_only", no_argument, NULL, 0x515 }, "Gather kernel-only coverage with Intel PT and with Intel BTS" },
418 { { "linux_ns_net", no_argument, NULL, 0x0530 }, "Use Linux NET namespace isolation" },
419 { { "linux_ns_pid", no_argument, NULL, 0x0531 }, "Use Linux PID namespace isolation" },
420 { { "linux_ns_ipc", no_argument, NULL, 0x0532 }, "Use Linux IPC namespace isolation" },
421#endif // defined(_HF_ARCH_LINUX)
422 { { 0, 0, 0, 0 }, NULL },
Robert Swieckia88f96f2015-10-09 16:47:39 +0200423 };
Robert Swiecki0b566112017-10-17 17:39:07 +0200424 // clang-format on
Robert Swieckia88f96f2015-10-09 16:47:39 +0200425
426 struct option opts[ARRAYSIZE(custom_opts)];
427 for (unsigned i = 0; i < ARRAYSIZE(custom_opts); i++) {
428 opts[i] = custom_opts[i].opt;
429 }
430
431 enum llevel_t ll = INFO;
Robert Swiecki4e595fb2017-10-11 17:26:51 +0200432 const char* logfile = NULL;
Robert Swieckia88f96f2015-10-09 16:47:39 +0200433 int opt_index = 0;
434 for (;;) {
Robert Swiecki0b566112017-10-17 17:39:07 +0200435 int c = getopt_long(
Robert Swiecki97cd6242017-12-27 21:02:47 +0100436 argc, argv, "-?hQvVsuPxf:dqe:W:r:c:F:t:R:n:N:l:p:g:E:w:B:CzTS", opts, &opt_index);
Robert Swieckid50ed422017-11-13 23:32:26 +0100437 if (c < 0) break;
Robert Swieckia88f96f2015-10-09 16:47:39 +0200438
439 switch (c) {
Robert Swieckid50ed422017-11-13 23:32:26 +0100440 case 'h':
441 case '?':
442 cmdlineUsage(argv[0], custom_opts);
443 break;
444 case 'f':
Robert Swiecki82c707c2017-11-14 16:36:23 +0100445 hfuzz->io.inputDir = optarg;
Robert Swieckiced3eba2017-12-15 15:33:03 +0100446 if (hfuzz->io.covDirAll == NULL) {
447 hfuzz->io.covDirAll = optarg;
448 }
Robert Swieckid50ed422017-11-13 23:32:26 +0100449 break;
450 case 'x':
451 hfuzz->dynFileMethod = _HF_DYNFILE_NONE;
452 break;
453 case 'Q':
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100454 hfuzz->exe.nullifyStdio = false;
Robert Swieckid50ed422017-11-13 23:32:26 +0100455 break;
456 case 'v':
457 hfuzz->useScreen = false;
458 break;
459 case 'V':
460 hfuzz->useVerifier = true;
461 break;
462 case 's':
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100463 hfuzz->exe.fuzzStdin = true;
Robert Swieckid50ed422017-11-13 23:32:26 +0100464 break;
465 case 'u':
Robert Swiecki26fd6d52017-11-15 00:46:21 +0100466 hfuzz->io.saveUnique = false;
Robert Swieckid50ed422017-11-13 23:32:26 +0100467 break;
468 case 'l':
469 logfile = optarg;
470 break;
471 case 'd':
Robert Swiecki97cd6242017-12-27 21:02:47 +0100472 ll = DEBUG;
473 break;
474 case 'q':
475 ll = WARNING;
Robert Swieckid50ed422017-11-13 23:32:26 +0100476 break;
477 case 'e':
Robert Swiecki82c707c2017-11-14 16:36:23 +0100478 hfuzz->io.fileExtn = optarg;
Robert Swieckid50ed422017-11-13 23:32:26 +0100479 break;
480 case 'W':
Robert Swiecki82c707c2017-11-14 16:36:23 +0100481 hfuzz->io.workDir = optarg;
Robert Swieckid50ed422017-11-13 23:32:26 +0100482 break;
Robert Swieckia35d9d82017-12-15 22:00:41 +0100483 case 0x600:
Robert Swieckiced3eba2017-12-15 15:33:03 +0100484 hfuzz->io.crashDir = optarg;
485 break;
Robert Swieckia35d9d82017-12-15 22:00:41 +0100486 case 0x601:
487 hfuzz->io.covDirAll = optarg;
488 break;
489 case 0x602:
490 hfuzz->io.covDirNew = optarg;
491 break;
Robert Swieckid50ed422017-11-13 23:32:26 +0100492 case 'r':
493 hfuzz->mutationsPerRun = strtoul(optarg, NULL, 10);
494 break;
495 case 'c':
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100496 hfuzz->exe.externalCommand = optarg;
Robert Swieckid50ed422017-11-13 23:32:26 +0100497 break;
498 case 'C':
499 hfuzz->useSanCov = true;
500 break;
501 case 'S':
502 hfuzz->enableSanitizers = true;
503 break;
Robert Swiecki97d88932018-01-10 19:29:34 +0100504 case 0x10A:
505 hfuzz->extSanOpts = optarg;
506 break;
Robert Swieckid50ed422017-11-13 23:32:26 +0100507 case 'z':
508 hfuzz->dynFileMethod |= _HF_DYNFILE_SOFT;
509 break;
510 case 'F':
511 hfuzz->maxFileSz = strtoul(optarg, NULL, 0);
512 break;
513 case 't':
Robert Swiecki371e1292017-12-18 01:10:33 +0100514 hfuzz->timing.tmOut = atol(optarg);
Robert Swieckid50ed422017-11-13 23:32:26 +0100515 break;
516 case 'R':
517 hfuzz->reportFile = optarg;
518 break;
519 case 'n':
520 hfuzz->threads.threadsMax = atol(optarg);
521 break;
522 case 0x109: {
523 time_t p = atol(optarg);
524 if (p > 0) {
Robert Swiecki371e1292017-12-18 01:10:33 +0100525 hfuzz->timing.runEndTime = time(NULL) + p;
Robert Swieckia88f96f2015-10-09 16:47:39 +0200526 }
Robert Swieckid50ed422017-11-13 23:32:26 +0100527 } break;
528 case 'N':
529 hfuzz->mutationsMax = atol(optarg);
530 break;
531 case 0x100:
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100532 hfuzz->exe.asLimit = strtoull(optarg, NULL, 0);
Robert Swieckid50ed422017-11-13 23:32:26 +0100533 break;
534 case 0x101:
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100535 hfuzz->exe.rssLimit = strtoull(optarg, NULL, 0);
Robert Swiecki8954afd2017-11-14 18:14:22 +0100536 break;
537 case 0x102:
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100538 hfuzz->exe.dataLimit = strtoull(optarg, NULL, 0);
Robert Swieckid50ed422017-11-13 23:32:26 +0100539 break;
Robert Swieckid50ed422017-11-13 23:32:26 +0100540 case 0x104:
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100541 hfuzz->exe.postExternalCommand = optarg;
Robert Swieckid50ed422017-11-13 23:32:26 +0100542 break;
543 case 0x105:
544 if ((strcasecmp(optarg, "0") == 0) || (strcasecmp(optarg, "false") == 0)) {
545 hfuzz->monitorSIGABRT = false;
546 } else {
547 hfuzz->monitorSIGABRT = true;
548 }
549 break;
550 case 0x106:
551 hfuzz->skipFeedbackOnTimeout = true;
552 break;
553 case 0x107:
554 hfuzz->exitUponCrash = true;
555 break;
Robert Swiecki8954afd2017-11-14 18:14:22 +0100556 case 0x108:
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100557 hfuzz->exe.clearEnv = true;
Robert Swiecki8954afd2017-11-14 18:14:22 +0100558 break;
Robert Swieckid50ed422017-11-13 23:32:26 +0100559 case 'P':
560 hfuzz->persistent = true;
561 break;
562 case 'T':
Robert Swieckieba27172017-12-18 01:12:02 +0100563 hfuzz->timing.tmoutVTALRM = true;
Robert Swieckid50ed422017-11-13 23:32:26 +0100564 break;
565 case 'p':
566 if (util_isANumber(optarg) == false) {
567 LOG_E("-p '%s' is not a number", optarg);
568 return false;
569 }
570 hfuzz->linux.pid = atoi(optarg);
571 if (hfuzz->linux.pid < 1) {
572 LOG_E("-p '%d' is invalid", hfuzz->linux.pid);
573 return false;
574 }
575 break;
576 case 0x502:
577 hfuzz->linux.pidFile = optarg;
578 break;
579 case 'E':
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100580 for (size_t i = 0; i < ARRAYSIZE(hfuzz->exe.envs); i++) {
581 if (hfuzz->exe.envs[i] == NULL) {
582 hfuzz->exe.envs[i] = optarg;
Robert Swieckid50ed422017-11-13 23:32:26 +0100583 break;
584 }
585 }
586 break;
587 case 'w':
588 hfuzz->dictionaryFile = optarg;
589 break;
590 case 'B':
591 hfuzz->blacklistFile = optarg;
592 break;
Robert Swiecki846ccd72017-01-12 17:52:23 +0100593#if defined(_HF_ARCH_LINUX)
Robert Swieckid50ed422017-11-13 23:32:26 +0100594 case 0x500:
595 hfuzz->linux.ignoreAddr = (void*)strtoul(optarg, NULL, 0);
596 break;
597 case 0x501:
598 hfuzz->linux.disableRandomization = false;
599 break;
600 case 0x503:
601 hfuzz->linux.dynamicCutOffAddr = strtoull(optarg, NULL, 0);
602 break;
603 case 0x504:
604 hfuzz->linux.symsBlFile = optarg;
605 break;
606 case 0x505:
607 hfuzz->linux.symsWlFile = optarg;
608 break;
609 case 0x510:
610 hfuzz->dynFileMethod |= _HF_DYNFILE_INSTR_COUNT;
611 break;
612 case 0x511:
613 hfuzz->dynFileMethod |= _HF_DYNFILE_BRANCH_COUNT;
614 break;
615 case 0x513:
616 hfuzz->dynFileMethod |= _HF_DYNFILE_BTS_EDGE;
617 break;
618 case 0x514:
619 hfuzz->dynFileMethod |= _HF_DYNFILE_IPT_BLOCK;
620 break;
621 case 0x515:
622 hfuzz->linux.kernelOnly = true;
623 break;
624 case 0x530:
625 hfuzz->linux.cloneFlags |= (CLONE_NEWUSER | CLONE_NEWNET);
626 break;
627 case 0x531:
628 hfuzz->linux.cloneFlags |= (CLONE_NEWUSER | CLONE_NEWPID);
629 break;
630 case 0x532:
631 hfuzz->linux.cloneFlags |= (CLONE_NEWUSER | CLONE_NEWIPC);
632 break;
Robert Swiecki4e595fb2017-10-11 17:26:51 +0200633#endif /* defined(_HF_ARCH_LINUX) */
Robert Swieckid50ed422017-11-13 23:32:26 +0100634 default:
635 cmdlineUsage(argv[0], custom_opts);
636 return false;
637 break;
Robert Swieckia88f96f2015-10-09 16:47:39 +0200638 }
639 }
Jagger72f258b2015-10-09 23:09:01 +0200640
Robert Swieckia35d9d82017-12-15 22:00:41 +0100641 if (!logInitLogFile(logfile, ll)) {
Robert Swieckia88f96f2015-10-09 16:47:39 +0200642 return false;
643 }
Robert Swiecki2aeff252018-01-10 14:58:44 +0100644 hfuzz->exe.argc = argc - optind;
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100645 hfuzz->exe.cmdline = (const char* const*)&argv[optind];
Robert Swiecki2aeff252018-01-10 14:58:44 +0100646 if (hfuzz->exe.argc <= 0) {
Robert Swieckia88f96f2015-10-09 16:47:39 +0200647 LOG_E("No fuzz command provided");
648 cmdlineUsage(argv[0], custom_opts);
649 return false;
650 }
Robert Swiecki32ae3892018-01-10 16:20:28 +0100651 if (!hfuzz->persistent && cmdlineCheckIfPersistent(hfuzz->exe.cmdline[0])) {
Robert Swieckif8292582018-01-10 16:19:18 +0100652 LOG_I("Persistent signature detected, assume it's a persistent fuzzing-mode binary");
653 hfuzz->persistent = true;
654 }
Robert Swieckia35d9d82017-12-15 22:00:41 +0100655 if (!cmdlineVerify(hfuzz)) {
Anestis Bechtsoudisc1a0d9f2016-12-29 11:34:10 +0200656 return false;
657 }
658
Robert Swieckid50ed422017-11-13 23:32:26 +0100659 LOG_I(
660 "PID: %d, inputDir '%s', nullifyStdio: %s, fuzzStdin: %s, saveUnique: %s, "
661 "mutationsPerRun: %u, "
662 "externalCommand: '%s', runEndTime: %d tmOut: %ld, mutationsMax: %zu, "
663 "threads.threadsMax: %zu, "
664 "fileExtn: '%s', "
Robert Swiecki8954afd2017-11-14 18:14:22 +0100665 "ASLimit: 0x%" PRIx64 "(MiB), RSSLimit: 0x%" PRIx64 ", DATALimit: 0x%" PRIx64
666 ", fuzzExe: '%s', fuzzedPid: %d, monitorSIGABRT: '%s'",
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100667 (int)getpid(), hfuzz->io.inputDir, cmdlineYesNo(hfuzz->exe.nullifyStdio),
668 cmdlineYesNo(hfuzz->exe.fuzzStdin), cmdlineYesNo(hfuzz->io.saveUnique),
669 hfuzz->mutationsPerRun,
670 hfuzz->exe.externalCommand == NULL ? "NULL" : hfuzz->exe.externalCommand,
Robert Swiecki371e1292017-12-18 01:10:33 +0100671 (int)hfuzz->timing.runEndTime, hfuzz->timing.tmOut, hfuzz->mutationsMax,
672 hfuzz->threads.threadsMax, hfuzz->io.fileExtn, hfuzz->exe.asLimit, hfuzz->exe.rssLimit,
673 hfuzz->exe.dataLimit, hfuzz->exe.cmdline[0], hfuzz->linux.pid,
674 cmdlineYesNo(hfuzz->monitorSIGABRT));
Robert Swieckia88f96f2015-10-09 16:47:39 +0200675
Robert Swiecki97d0cee2017-12-18 00:17:50 +0100676 snprintf(hfuzz->cmdline_txt, sizeof(hfuzz->cmdline_txt), "%s", hfuzz->exe.cmdline[0]);
677 for (size_t i = 1; hfuzz->exe.cmdline[i]; i++) {
678 util_ssnprintf(
679 hfuzz->cmdline_txt, sizeof(hfuzz->cmdline_txt), " %s", hfuzz->exe.cmdline[i]);
Robert Swieckif2d9c3a2016-11-03 02:13:54 +0100680 if (strlen(hfuzz->cmdline_txt) == (sizeof(hfuzz->cmdline_txt) - 1)) {
Robert Swiecki6e885112017-11-22 00:32:24 +0100681 hfuzz->cmdline_txt[sizeof(hfuzz->cmdline_txt) - 5] = ' ';
682 hfuzz->cmdline_txt[sizeof(hfuzz->cmdline_txt) - 4] = '.';
Robert Swieckif2d9c3a2016-11-03 02:13:54 +0100683 hfuzz->cmdline_txt[sizeof(hfuzz->cmdline_txt) - 3] = '.';
684 hfuzz->cmdline_txt[sizeof(hfuzz->cmdline_txt) - 2] = '.';
Robert Swiecki6e885112017-11-22 00:32:24 +0100685 hfuzz->cmdline_txt[sizeof(hfuzz->cmdline_txt) - 1] = '\0';
Robert Swieckif2d9c3a2016-11-03 02:13:54 +0100686 }
Robert Swiecki72d2bef2016-01-19 14:39:26 +0100687 }
688
Robert Swieckia88f96f2015-10-09 16:47:39 +0200689 return true;
690}