-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInvoking.html
More file actions
773 lines (593 loc) · 32.8 KB
/
Invoking.html
File metadata and controls
773 lines (593 loc) · 32.8 KB
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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Invoking Fandango — Fuzzing with Fandango</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.8ecb98da25f57f5357bf6f572d296f466b2cfe2517ffebfabe82451661e28f02.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
<script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/documentation_options.js?v=9eb32ce0"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
<script>let toggleHintShow = 'Click to show';</script>
<script>let toggleHintHide = 'Click to hide';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="_static/togglebutton.js?v=4a39c7ea"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
<script async="async" src="_static/sphinx-thebe.js?v=c100c467"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
<script>DOCUMENTATION_OPTIONS.pagename = 'Invoking';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Fuzzing with Fandango" href="Fuzzing.html" />
<link rel="prev" title="A First Fandango Spec" href="FirstSpec.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<input type="checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
<input type="checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search this book..."
aria-label="Search this book..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<aside class="bd-header-announcement" aria-label="Announcement">
<div class="bd-header-announcement__content"><a href="https://pypi.org/project/fandango-fuzzer/1.1.1/" style="color:white;">Fandango 1.1.1</a> is now available! Check out the <a href="https://fandango-fuzzer.github.io/ReleaseNotes.html#" style="color:white;">release notes</a> for details.</div>
</aside>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/fandango.png" class="logo__image only-light" alt="Fuzzing with Fandango - Home"/>
<script>document.write(`<img src="_static/fandango.png" class="logo__image only-dark" alt="Fuzzing with Fandango - Home"/>`);</script>
</a></div>
<div class="sidebar-primary-item">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script></div>
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1">
<a class="reference internal" href="index.html">
Fuzzing with Fandango
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">About Fandango</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="About.html">About Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="ReleaseNotes.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="FAQ.html">Fandango FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="Contributing.html">Contributing to Fandango</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">First Steps</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Tutorial.html">Tutorial Conventions</a></li>
<li class="toctree-l1"><a class="reference internal" href="Setup.html">Installing Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="FirstSpec.html">A First Fandango Spec</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Invoking Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="Fuzzing.html">Fuzzing with Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="Strategies.html">Some Fuzzing Strategies</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Advanced Input Generation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Constraints.html">Shaping Inputs with Constraints</a></li>
<li class="toctree-l1"><a class="reference internal" href="Shell.html">The Fandango Shell</a></li>
<li class="toctree-l1"><a class="reference internal" href="Generators.html">Data Generators and Fakers</a></li>
<li class="toctree-l1"><a class="reference internal" href="Regexes.html">Regular Expressions</a></li>
<li class="toctree-l1"><a class="reference internal" href="Recursive.html">Complex Input Structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="Paths.html">Accessing Input Elements</a></li>
<li class="toctree-l1"><a class="reference internal" href="Converters.html">Converting ANTLR and Other Input Specs</a></li>
<li class="toctree-l1"><a class="reference internal" href="Diversity.html">Covering Specs and Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="ISO8601.html">Case Study: ISO 8601 Date + Time</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Generating Binary Inputs</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Binary.html">Generating Binary Inputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bits.html">Bits and Bit Fields</a></li>
<li class="toctree-l1"><a class="reference internal" href="Conversion.html">Data Converters</a></li>
<li class="toctree-l1"><a class="reference internal" href="Gif.html">Case Study: The GIF Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="Hatching.html">Hatching Specs</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Checking Responses</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Parsing.html">Parsing Strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="Outputs.html">Checking Outputs</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Testing Protocols</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Protocols.html">Testing Protocols</a></li>
<li class="toctree-l1"><a class="reference internal" href="Parties.html">Customizing Party Communication</a></li>
<li class="toctree-l1"><a class="reference internal" href="FTP.html">Case Study: FTP</a></li>
<li class="toctree-l1"><a class="reference internal" href="DNS.html">Case Study: DNS</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Fandango Reference</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Reference.html">Fandango Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installing.html">Installing Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="Commands.html">Fandango Command Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Language.html">Fandango Language Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib.html">Fandango Standard Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="DerivationTree.html">Derivation Tree Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="PythonAPI.html">Python API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="FandangoParty.html">FandangoParty Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Including.html">Fandango File Locations</a></li>
<li class="toctree-l1"><a class="reference internal" href="LanguageServer.html">Fandango Language Server</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</button></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<div class="dropdown dropdown-source-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Source repositories">
<i class="fab fa-github"></i>
</button>
<ul class="dropdown-menu">
<li><a href="https://github.com/fandango-fuzzer/fandango" target="_blank"
class="btn btn-sm btn-source-repository-button dropdown-item"
title="Source repository"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fab fa-github"></i>
</span>
<span class="btn__text-container">Repository</span>
</a>
</li>
<li><a href="https://github.com/fandango-fuzzer/fandango/issues/new?title=Issue%20on%20page%20%2FInvoking.html&body=Your%20issue%20content%20here." target="_blank"
class="btn btn-sm btn-source-issues-button dropdown-item"
title="Open an issue"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-lightbulb"></i>
</span>
<span class="btn__text-container">Open issue</span>
</a>
</li>
</ul>
</div>
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="_sources/Invoking.md" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.md</span>
</a>
</li>
<li>
<a href="_static/fandango.pdf" target="_blank"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Download PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</a>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script>
<script>
document.write(`
<button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
`);
</script>
<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-list"></span>
</button>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>Invoking Fandango</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#running-fandango-on-our-example-spec">Running Fandango on our Example Spec</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#more-commands-and-options">More Commands and Options</a></li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section class="tex2jax_ignore mathjax_ignore" id="invoking-fandango">
<span id="sec-invoking"></span><h1>Invoking Fandango<a class="headerlink" href="#invoking-fandango" title="Link to this heading">#</a></h1>
<section id="running-fandango-on-our-example-spec">
<h2>Running Fandango on our Example Spec<a class="headerlink" href="#running-fandango-on-our-example-spec" title="Link to this heading">#</a></h2>
<p>To run Fandango on <a class="reference internal" href="FirstSpec.html#sec-first-spec"><span class="std std-ref">our “digits” example</span></a>,
create or download a file <a class="reference download internal" download="" href="_downloads/743ff06243a90b38d58d4cd590981601/digits.fan"><span class="xref download myst">digits.fan</span></a> with the “digits” grammar in the current folder.</p>
<aside class="margin sidebar">
<p class="sidebar-title"></p>
<p>Fandango specs have a <code class="docutils literal notranslate"><span class="pre">.fan</span></code> extension.</p>
</aside>
<p>Then, you can run Fandango on it to create inputs.
The command we need is called <code class="docutils literal notranslate"><span class="pre">fandango</span> <span class="pre">fuzz</span></code>, and it takes two important parameters:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">-f</span></code> followed by the <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file – for us, that is <code class="docutils literal notranslate"><span class="pre">digits.fan</span></code>;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-n</span></code> followed by the number of inputs we want to have – say, 10.</p></li>
</ul>
<p>This is how we invoke Fandango:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>fandango<span class="w"> </span>fuzz<span class="w"> </span>-f<span class="w"> </span>digits.fan<span class="w"> </span>-n<span class="w"> </span><span class="m">10</span>
</pre></div>
</div>
<p>And this is what we get:</p>
<div class="cell tag_remove-input docutils container">
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>28969599665997786
49459262591294
261494623318
410
62540210526
48216613297303
0433383012533
76327424
304350763342006366
89299274562266349
</pre></div>
</div>
</div>
</div>
<p>Success! We have created 10 random sequences of digits.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Be aware that <code class="docutils literal notranslate"><span class="pre">.fan</span></code> files can contain Python code that is <em>executed when being loaded</em>. This code can execute arbitrary commands.</p>
</div>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>Only load <code class="docutils literal notranslate"><span class="pre">.fan</span></code> files you trust.</p>
</div>
</section>
<section id="more-commands-and-options">
<h2>More Commands and Options<a class="headerlink" href="#more-commands-and-options" title="Link to this heading">#</a></h2>
<p>Besides <code class="docutils literal notranslate"><span class="pre">fandango</span> <span class="pre">fuzz</span></code>, Fandango supports more commands, and besides <code class="docutils literal notranslate"><span class="pre">-f</span></code> and <code class="docutils literal notranslate"><span class="pre">-n</span></code>, Fandango supports way more options.
To find out which commands Fandango supports, try</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>fandango<span class="w"> </span>--help
</pre></div>
</div>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Fandango commands not detailed in this documentation are <em>experimental</em> – do not rely on them.</p>
</div>
<p>To find out which option a particular command supports, invoke the command with <code class="docutils literal notranslate"><span class="pre">--help</span></code>.
For instance, these are all the options supported by <code class="docutils literal notranslate"><span class="pre">fandango</span> <span class="pre">fuzz</span></code>:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>fandango<span class="w"> </span>fuzz<span class="w"> </span>--help
</pre></div>
</div>
<div class="cell tag_remove-input tag_scroll-output docutils container">
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>usage: fandango fuzz [-h] [-f FAN_FILE] [-c CONSTRAINT] [-S START_SYMBOL]
[--max MAXCONSTRAINT] [--min MINCONSTRAINTS] [-I DIR]
[--file-mode {text,binary,auto}] [--no-cache]
[--no-stdlib] [-s SEPARATOR] [-d DIRECTORY]
[-x FILENAME_EXTENSION]
[--format {string,bits,tree,grammar,value,repr,none}]
[--validate] [-N MAX_GENERATIONS] [--infinite]
[--population-size POPULATION_SIZE]
[--elitism-rate ELITISM_RATE]
[--crossover-rate CROSSOVER_RATE]
[--mutation-rate MUTATION_RATE]
[--random-seed RANDOM_SEED]
[--destruction-rate DESTRUCTION_RATE]
[--max-repetition-rate MAX_REPETITION_RATE]
[--max-repetitions MAX_REPETITIONS]
[--max-node-rate MAX_NODE_RATE] [--max-nodes MAX_NODES]
[-n DESIRED_SOLUTIONS] [--best-effort]
[-i INITIAL_POPULATION] [--progress-bar {on,off,auto}]
[--warnings-are-errors] [--party PARTY] [-o OUTPUT]
[--input-method {stdin,filename,libfuzzer}]
[command] ...
options:
-h, --help show this help message and exit
-o, --output OUTPUT Write output to OUTPUT (default: stdout).
Fandango file settings:
-f, --fandango-file FAN_FILE
Fandango file (.fan, .py) to be processed. Can be
given multiple times. Use '-' for stdin.
-c, --constraint CONSTRAINT
Define an additional constraint CONSTRAINT. Can be
given multiple times.
-S, --start-symbol START_SYMBOL
The grammar start symbol (default: '<start>').
--max, --maximize MAXCONSTRAINT
Define an additional constraint MAXCONSTRAINT to be
maximized. Can be given multiple times.
--min, --minimize MINCONSTRAINTS
Define an additional constraint MINCONSTRAINT to be
minimized. Can be given multiple times.
-I, --include-dir DIR
Specify a directory DIR to search for included
Fandango files.
--file-mode {text,binary,auto}
Mode in which to open and write files (default is
'auto': 'binary' if grammar has bits or bytes, 'text'
otherwise).
--no-cache Do not cache parsed Fandango files.
--no-stdlib Do not include the standard Fandango library.
Output settings:
-s, --separator SEPARATOR
Output SEPARATOR between individual inputs. (default:
newline).
-d, --directory DIRECTORY
Create individual output files in DIRECTORY.
-x, --filename-extension FILENAME_EXTENSION
Extension of generated file names (default: '.txt').
--format {string,bits,tree,grammar,value,repr,none}
Produce output(s) as string (default), as a bit
string, as a derivation tree, as a grammar, as a
Python value, in internal representation, or none.
--validate Run internal consistency checks for debugging.
Generation settings:
-N, --max-generations MAX_GENERATIONS
Maximum number of generations to run the algorithm
(ignored if --infinite is set).
--infinite Run the algorithm indefinitely.
--population-size POPULATION_SIZE
Size of the population.
--elitism-rate ELITISM_RATE
Rate of individuals preserved in the next generation.
--crossover-rate CROSSOVER_RATE
Rate of individuals that will undergo crossover.
--mutation-rate MUTATION_RATE
Rate of individuals that will undergo mutation.
--random-seed RANDOM_SEED
Random seed to use for the algorithm. You probably
also want to specify 'PYTHONHASHSEED=<some-value>' to
achieve full reproducibility.
--destruction-rate DESTRUCTION_RATE
Rate of individuals that will be randomly destroyed in
every generation.
--max-repetition-rate MAX_REPETITION_RATE
Rate at which the number of maximal repetitions should
be increased.
--max-repetitions MAX_REPETITIONS
Maximal value the number of repetitions can be
increased to.
--max-node-rate MAX_NODE_RATE
Rate at which the maximal number of nodes in a tree is
increased.
--max-nodes MAX_NODES
Maximal value, the number of nodes in a tree can be
increased to.
-n, --desired-solutions, --num-outputs DESIRED_SOLUTIONS
Number of outputs to produce.
--best-effort Produce a 'best effort' population (may not satisfy
all constraints).
-i, --initial-population INITIAL_POPULATION
Directory or ZIP archive with initial population.
--progress-bar {on,off,auto}
Whether to show the progress bar. 'auto' (default)
shows the progress bar only if stderr is a terminal.
General settings:
--warnings-are-errors
Treat warnings as errors.
Party settings:
--party PARTY Only consider the PARTY part of the interaction in the
.fan file.
command invocation settings:
--input-method {stdin,filename,libfuzzer}
When invoking COMMAND, choose whether Fandango input
will be passed as standard input (`stdin`), as last
argument on the command line (`filename`) (default),
or to a libFuzzer style harness compiled to a shared
.so/.dylib object (`libfuzzer`).
command Command to be invoked with a Fandango input.
args The arguments of the command.
</pre></div>
</div>
</div>
</div>
<p>Some of these options are very useful, such as <code class="docutils literal notranslate"><span class="pre">-o</span></code> and <code class="docutils literal notranslate"><span class="pre">-d</span></code>, which redirect the inputs generated towards individual files.
You can also specify a <em>command</em> to be executed with the inputs Fandango generated.</p>
<p>We will go through these commands and options in due time.
For now, let us get back to our specifications and actually <a class="reference internal" href="Fuzzing.html#sec-fuzzing"><span class="std std-ref"><em>fuzz with Fandango</em></span></a>.</p>
</section>
</section>
<script type="text/x-thebe-config">
{
requestKernel: true,
binderOptions: {
repo: "binder-examples/jupyter-stacks-datascience",
ref: "master",
},
codeMirrorConfig: {
theme: "abcdef",
mode: "python"
},
kernelOptions: {
name: "python3",
path: "./."
},
predefinedOutput: true
}
</script>
<script>kernelName = 'python3'</script>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="FirstSpec.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">A First Fandango Spec</p>
</div>
</a>
<a class="right-next"
href="Fuzzing.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Fuzzing with Fandango</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#running-fandango-on-our-example-spec">Running Fandango on our Example Spec</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#more-commands-and-options">More Commands and Options</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By José Antonio Zamudio Amaya, Valentin Huber, Alexander Liggesmeyer, Marius Smytzek, and Andreas Zeller
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2024-2026 CISPA Helmholtz Center for Information Security (www.cispa.de). All Rights Reserved..
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script>
<footer class="bd-footer">
</footer>
</body>
</html>