-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathParties.html.orig
More file actions
768 lines (588 loc) · 47.3 KB
/
Parties.html.orig
File metadata and controls
768 lines (588 loc) · 47.3 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
<!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>Customizing Party Communication — 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 = 'Parties';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Case Study: FTP" href="FTP.html" />
<link rel="prev" title="Testing Protocols" href="Protocols.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="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"><a class="reference internal" href="Invoking.html">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="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Protocols.html">Testing Protocols</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">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%2FParties.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/Parties.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>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to 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>
</button>
</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>Customizing Party Communication</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="#party-classes">Party Classes</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#extending-party-functionality">Extending Party Functionality</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#starting-a-party">Starting a Party</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#stopping-a-party">Stopping a Party</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#sending-messages">Sending Messages</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#receiving-messages">Receiving Messages</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#own-network-parties">Own Network Parties</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#accessing-network-parties-at-runtime">Accessing Network Parties at Runtime</a></li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section class="tex2jax_ignore mathjax_ignore" id="customizing-party-communication">
<span id="sec-parties"></span><h1>Customizing Party Communication<a class="headerlink" href="#customizing-party-communication" title="Link to this heading">#</a></h1>
<p>In the <a class="reference internal" href="Protocols.html#sec-protocols"><span class="std std-ref">previous chapter</span></a>, we have seen how to define and test protocol interactions with Fandango.
In this chapter, we describe additional ways to control communication behavior.</p>
<div class="versionadded">
<p><span class="versionmodified added">Added in version 1.1: </span>These features are available in Fandango 1.1 and later.</p>
</div>
<section id="party-classes">
<h2>Party Classes<a class="headerlink" href="#party-classes" title="Link to this heading">#</a></h2>
<p>All the communication between Fandango and its parties takes place via dedicated <em>classes</em>.
In fact, prefixes like <code class="docutils literal notranslate"><span class="pre">Client</span></code> and <code class="docutils literal notranslate"><span class="pre">Server</span></code> in <a class="reference internal" href="Protocols.html#sec-protocols"><span class="std std-ref">protocol testing</span></a> or <code class="docutils literal notranslate"><span class="pre">In</span></code> and <code class="docutils literal notranslate"><span class="pre">Out</span></code> when <a class="reference internal" href="Outputs.html#sec-outputs"><span class="std std-ref">checking outputs</span></a> all stand for predefined <em>classes</em> that implement a set of methods to handle the communication:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Client</span></code> and <code class="docutils literal notranslate"><span class="pre">Server</span></code> are <code class="docutils literal notranslate"><span class="pre">NetworkParty</span></code> classes, detailed in the <a class="reference internal" href="FandangoParty.html"><span class="std std-doc"><code class="docutils literal notranslate"><span class="pre">FandangoParty</span></code> reference</span></a>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">In</span></code> and <code class="docutils literal notranslate"><span class="pre">Out</span></code> are <code class="docutils literal notranslate"><span class="pre">FandangoParty</span></code> classes, detailed in the <a class="reference internal" href="FandangoParty.html"><span class="std std-doc"><code class="docutils literal notranslate"><span class="pre">FandangoParty</span></code> reference</span></a>.</p></li>
</ul>
<p>The fact that these are classes allows you to <em>implement your own communication classes</em> and define code that should be executed when starting, stopping, or communicating with a party.
This is typically done by <em>subclassing</em> one of the existing classes.</p>
</section>
<section id="extending-party-functionality">
<h2>Extending Party Functionality<a class="headerlink" href="#extending-party-functionality" title="Link to this heading">#</a></h2>
<section id="starting-a-party">
<h3>Starting a Party<a class="headerlink" href="#starting-a-party" title="Link to this heading">#</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">NetworkParty</span></code> class has a <code class="docutils literal notranslate"><span class="pre">start()</span></code> method that is invoked whenever the respective party is started.
You can extend this method to execute additional code, for instance to create configuration files.
To this end, simply subclass the respective party class and override its <code class="docutils literal notranslate"><span class="pre">start()</span></code> method:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">create_configuration_file</span><span class="p">()</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
<span class="o">...</span> <span class="c1"># Your code goes here</span>
<span class="k">class</span><span class="w"> </span><span class="nc">MyClient</span><span class="p">(</span><span class="n">Client</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
<span class="n">create_configuration_file</span><span class="p">()</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">start</span><span class="p">()</span> <span class="c1"># Invoke the start() method of the superclass</span>
</pre></div>
</div>
<p>This definition goes right into the <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>In the grammar, be sure to use your own class name - in this case, <code class="docutils literal notranslate"><span class="pre">MyClient</span></code>. Only then will your definition be used.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">start</span><span class="o">></span> <span class="p">:</span><span class="o">:=</span> <span class="o"><</span><span class="n">MyClient</span><span class="p">:</span><span class="n">send</span><span class="o">></span> <span class="o"><</span><span class="n">Server</span><span class="p">:</span><span class="n">respond</span><span class="o">></span>
<span class="o"><</span><span class="n">send</span><span class="o">></span> <span class="p">:</span><span class="o">:=</span> <span class="o">...</span>
</pre></div>
</div>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>You can also <em>override</em> existing class names. With this hack, you do not have to change the grammar:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Client</span><span class="p">(</span><span class="n">Client</span><span class="p">):</span> <span class="c1"># extends the original `Client` class</span>
<span class="k">def</span><span class="w"> </span><span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
<span class="n">create_configuration_file</span><span class="p">()</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">start</span><span class="p">()</span> <span class="c1"># Invoke the start() method of the superclass</span>
</pre></div>
</div>
</div>
<p>See the <a class="reference internal" href="FandangoParty.html#sec-startstop-api"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">FandangoParty</span></code> reference</span></a> for details on <code class="docutils literal notranslate"><span class="pre">start()</span></code>.</p>
</section>
<section id="stopping-a-party">
<h3>Stopping a Party<a class="headerlink" href="#stopping-a-party" title="Link to this heading">#</a></h3>
<p>In the same way as extending starting a party, one can also hook into <em>stopping</em> a party – for cleanup actions, for instance.
The <code class="docutils literal notranslate"><span class="pre">stop()</span></code> method is useful for this:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">cleanup_server</span><span class="p">()</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
<span class="o">...</span> <span class="c1"># Your code goes here</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Server</span><span class="p">(</span><span class="n">Server</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">cleanup_server</span><span class="p">()</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span> <span class="c1"># Invoke the stop() method of the superclass</span>
</pre></div>
</div>
<p>Again, this definition goes right into the <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file.
See the <a class="reference internal" href="FandangoParty.html#sec-startstop-api"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">FandangoParty</span></code> reference</span></a> for details on <code class="docutils literal notranslate"><span class="pre">stop()</span></code>.</p>
</section>
<section id="sending-messages">
<h3>Sending Messages<a class="headerlink" href="#sending-messages" title="Link to this heading">#</a></h3>
<p>Whenever Fandango wants to send messages to a party, it invokes its <code class="docutils literal notranslate"><span class="pre">send()</span></code> message.
As with <code class="docutils literal notranslate"><span class="pre">start()</span></code> and <code class="docutils literal notranslate"><span class="pre">stop()</span></code>, above, you can extend the <code class="docutils literal notranslate"><span class="pre">send()</span></code> method for your own needs.
This includes</p>
<ul class="simple">
<li><p>altering messages (e.g. encrypt or compress them)</p></li>
<li><p>logging information</p></li>
<li><p>reacting to specific messages</p></li>
</ul>
<p>Here is an example in which we compress the <code class="docutils literal notranslate"><span class="pre">DerivationTree</span></code> passed via a <code class="docutils literal notranslate"><span class="pre">compress()</span></code> function.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">compress</span><span class="p">(</span><span class="n">msg</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bytes</span><span class="p">:</span>
<span class="n">compressed_message</span> <span class="o">=</span> <span class="o">...</span> <span class="c1"># Your code goes here</span>
<span class="k">return</span> <span class="n">compressed_message</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Server</span><span class="p">(</span><span class="n">Server</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">send</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">DerivationTree</span> <span class="o">|</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span> <span class="n">recipient</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
<span class="n">compressed_message</span> <span class="o">=</span> <span class="n">compress</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">to_bytes</span><span class="p">())</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="n">compressed_message</span><span class="p">,</span> <span class="n">recipient</span><span class="p">)</span>
</pre></div>
</div>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>When called from Fandango, <code class="docutils literal notranslate"><span class="pre">message</span></code> always is of type <a class="reference internal" href="DerivationTree.html"><span class="std std-doc"><code class="docutils literal notranslate"><span class="pre">DerivationTree</span></code></span></a>;
this allows you to access its constituents (as in <code class="docutils literal notranslate"><span class="pre">to_bytes()</span></code>, above).
However, the <code class="docutils literal notranslate"><span class="pre">FandangoParty</span></code> classes all support sending <code class="docutils literal notranslate"><span class="pre">DerivationTree</span></code>, <code class="docutils literal notranslate"><span class="pre">str</span></code>, and <code class="docutils literal notranslate"><span class="pre">bytes</span></code> types, so you do not have to re-create a <code class="docutils literal notranslate"><span class="pre">DerivationTree</span></code> object when calling <code class="docutils literal notranslate"><span class="pre">send()</span></code>.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For encodings, compression, and other alterations, you can also use a <a class="reference internal" href="Conversion.html#sec-conversion"><span class="std std-ref">data converter</span></a> instead.</p>
</div>
<p>See the <a class="reference internal" href="FandangoParty.html#sec-send-api"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">FandangoParty</span></code> reference</span></a> for details on <code class="docutils literal notranslate"><span class="pre">send()</span></code>.</p>
</section>
<section id="receiving-messages">
<h3>Receiving Messages<a class="headerlink" href="#receiving-messages" title="Link to this heading">#</a></h3>
<p>Whenever Fandango receives messages from a party, it invokes its <code class="docutils literal notranslate"><span class="pre">receive()</span></code> message.
Again, you can extend this for your own needs.</p>
<p>Here is an example in which we decompress the message received via a <code class="docutils literal notranslate"><span class="pre">decompress()</span></code> function.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">decompress</span><span class="p">(</span><span class="n">msg</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bytes</span><span class="p">:</span>
<span class="n">decompressed_message</span> <span class="o">=</span> <span class="o">...</span> <span class="c1"># Your code goes here</span>
<span class="k">return</span> <span class="n">decompressed_message</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Server</span><span class="p">(</span><span class="n">Server</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">receive</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">sender</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
<span class="n">decompressed_message</span> <span class="o">=</span> <span class="n">decompress</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">receive</span><span class="p">(</span><span class="n">decompressed_message</span><span class="p">,</span> <span class="n">sender</span><span class="p">)</span>
</pre></div>
</div>
<p>Again, this definition goes right into the <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file.
See the <a class="reference internal" href="FandangoParty.html#sec-receive-api"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">FandangoParty</span></code> reference</span></a> for details on <code class="docutils literal notranslate"><span class="pre">receive()</span></code>.</p>
</section>
</section>
<section id="own-network-parties">
<h2>Own Network Parties<a class="headerlink" href="#own-network-parties" title="Link to this heading">#</a></h2>
<p>If your setting uses more than just <code class="docutils literal notranslate"><span class="pre">client</span></code> or <code class="docutils literal notranslate"><span class="pre">server</span></code> parties, or if the existing <code class="docutils literal notranslate"><span class="pre">--client</span></code> and <code class="docutils literal notranslate"><span class="pre">--server</span></code> options to Fandango are not sufficient, you can define your own network parties by subclassing one of the <a class="reference internal" href="FandangoParty.html#sec-networkparty-class"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">NetworkParty</span></code> classes</span></a>.</p>
<aside class="margin sidebar">
<p class="sidebar-title"></p>
<p><code class="docutils literal notranslate"><span class="pre">Server_1</span></code> and <code class="docutils literal notranslate"><span class="pre">Server_2</span></code> could also be two channels to the same server; likewise with the client.</p>
</aside>
<p>As an example, consider a protocol where two clients <code class="docutils literal notranslate"><span class="pre">Client_1</span></code> and <code class="docutils literal notranslate"><span class="pre">Client_2</span></code> connect to the servers <code class="docutils literal notranslate"><span class="pre">Server_1</span></code> and <code class="docutils literal notranslate"><span class="pre">Server_2</span></code>, respectively.
Using the <a class="reference internal" href="FandangoParty.html#sec-networkparty-class"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">NetworkParty</span></code> constructor</span></a>, the respective <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file would contain these definitions:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Client_1</span><span class="p">(</span><span class="n">NetworkParty</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="s2">"localhost:8000"</span><span class="p">,</span>
<span class="n">connection_mode</span><span class="o">=</span><span class="n">ConnectionMode</span><span class="o">.</span><span class="n">CONNECT</span><span class="p">)</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Server_1</span><span class="p">(</span><span class="n">NetworkParty</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="s2">"localhost:8000"</span><span class="p">,</span>
<span class="n">connection_mode</span><span class="o">=</span><span class="n">ConnectionMode</span><span class="o">.</span><span class="n">EXTERNAL</span><span class="p">)</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Client_2</span><span class="p">(</span><span class="n">NetworkParty</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="s2">"localhost:8000"</span><span class="p">,</span>
<span class="n">connection_mode</span><span class="o">=</span><span class="n">ConnectionMode</span><span class="o">.</span><span class="n">CONNECT</span><span class="p">)</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Server_2</span><span class="p">(</span><span class="n">NetworkParty</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="s2">"localhost:8001"</span><span class="p">,</span>
<span class="n">connection_mode</span><span class="o">=</span><span class="n">ConnectionMode</span><span class="o">.</span><span class="n">EXTERNAL</span><span class="p">)</span>
</pre></div>
</div>
<p>The grammar can then use <code class="docutils literal notranslate"><span class="pre">Client_1</span></code>, <code class="docutils literal notranslate"><span class="pre">Client_2</span></code>, <code class="docutils literal notranslate"><span class="pre">Server_1</span></code>, and <code class="docutils literal notranslate"><span class="pre">Server_2</span></code> as prefixes, and specify a protocol that involves all four parties.
As specified, Fandango would operate as client (1 and 2) and fuzz the two servers.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Use one <code class="docutils literal notranslate"><span class="pre">.fan</span></code> file to specify the protocol, and a second one (which <a class="reference internal" href="Hatching.html#sec-hatching"><span class="std std-ref">includes</span></a> the first) to specify details on where and how the clients and servers are located.
This allows alternate settings to also make use (= include) the protocol spec - say, a setting in which Fandango acts as server(s) to fuzz the clients.</p>
</div>
</section>
<section id="accessing-network-parties-at-runtime">
<span id="sec-party-instance"></span><h2>Accessing Network Parties at Runtime<a class="headerlink" href="#accessing-network-parties-at-runtime" title="Link to this heading">#</a></h2>
<p>If the party configuration changes at runtime (see the <a class="reference internal" href="FTP.html#sec-ftp"><span class="std std-ref">FTP</span></a> case study for an example), you may need to access the individual party objects.
Use <a class="reference internal" href="FandangoParty.html#sec-instance-api"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">PARTY.instance()</span></code></span></a> for this, where <code class="docutils literal notranslate"><span class="pre">PARTY</span></code> is the class of the respective party.</p>
<p>For instance, to stop the <code class="docutils literal notranslate"><span class="pre">Server</span></code> object, use</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="n">Server</span><span class="o">.</span><span class="n">instance</span><span class="p">()</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
</pre></div>
</div>
<p>If you have given your party an individual name, pass its name as a string argument.
In this case, the class is ignored; <code class="docutils literal notranslate"><span class="pre">FandangoParty</span></code> will do fine. The code</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="n">FandangoParty</span><span class="o">.</span><span class="n">instance</span><span class="p">(</span><span class="s2">"Server"</span><span class="p">)</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
</pre></div>
</div>
<p>is equivalent to the above.</p>
<p>In the next chapters, we look at how <a class="reference internal" href="FTP.html#sec-ftp"><span class="std std-ref">FTP</span></a> and <a class="reference internal" href="DNS.html#sec-dns"><span class="std std-ref">DNS</span></a> protocol specs make use of these features.</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="Protocols.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">Testing Protocols</p>
</div>
</a>
<a class="right-next"
href="FTP.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Case Study: FTP</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="#party-classes">Party Classes</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#extending-party-functionality">Extending Party Functionality</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#starting-a-party">Starting a Party</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#stopping-a-party">Stopping a Party</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#sending-messages">Sending Messages</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#receiving-messages">Receiving Messages</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#own-network-parties">Own Network Parties</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#accessing-network-parties-at-runtime">Accessing Network Parties at Runtime</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>