-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathusage.html
2311 lines (1988 loc) · 94.6 KB
/
usage.html
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
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-01-22 Fri 14:52 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Pastelyzer</title>
<meta name="generator" content="Org mode" />
<meta name="author" content="Jānis Džeriņš" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<style>body { max-width: 38em; margin: auto; }</style>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2020 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">Pastelyzer
<br />
<span class="subtitle">User manual</span>
</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#intro">1. Introduction</a></li>
<li><a href="#running-pastelyzer">2. Running <code>pastelyzer</code></a>
<ul>
<li><a href="#common-cli-options">2.1. Common command-line options</a></li>
<li><a href="#interactive-mode">2.2. Interactive mode</a></li>
<li><a href="#standalone-mode">2.3. Standalone mode</a>
<ul>
<li><a href="#prerequisites">2.3.1. Prerequisites</a></li>
<li><a href="#standalone-options">2.3.2. Options</a></li>
<li><a href="#environment-variables">2.3.3. Environment variables</a></li>
<li><a href="#static-web-server-files">2.3.4. Static web server files</a></li>
<li><a href="#submitting-documents">2.3.5. Submitting documents</a></li>
</ul>
</li>
<li><a href="#sec-reprocessing-documents">2.4. Reprocessing documents</a></li>
</ul>
</li>
<li><a href="#configuration">3. Configuration</a>
<ul>
<li><a href="#syntax-overview">3.1. Syntax overview</a></li>
<li><a href="#sec-user-sets">3.2. User sets</a>
<ul>
<li><a href="#orgfffc128">3.2.1. <code>super-domains</code></a></li>
<li><a href="#orgfab6f2f">3.2.2. <code>ipv4-networks</code></a></li>
<li><a href="#cc-bins-set">3.2.3. <code>cc-bins</code></a></li>
</ul>
</li>
<li><a href="#sinks">3.3. Sinks</a>
<ul>
<li><a href="#specifying-values">3.3.1. Specifying values</a></li>
<li><a href="#templates">3.3.2. Templates</a></li>
<li><a href="#sink-field-extractors">3.3.3. Document field extractors</a></li>
<li><a href="#item-field-extractors">3.3.4. Artefact field extractors</a></li>
<li><a href="#sec-process-extractors">3.3.5. Extractors valid in process filters</a></li>
<li><a href="#WEB-SINK">3.3.6. <code>WEB-SINK</code></a></li>
<li><a href="#SMTP-SINK">3.3.7. <code>SMTP-SINK</code></a></li>
<li><a href="#MISP-SINK">3.3.8. <code>MISP-SINK</code></a></li>
<li><a href="#CMD-SINK">3.3.9. <code>CMD-SINK</code></a></li>
</ul>
</li>
<li><a href="#filters">3.4. Filters</a>
<ul>
<li><a href="#sec-process-filters">3.4.1. Process filters</a></li>
</ul>
</li>
<li><a href="#sec-artefact-export">3.5. Artefact export</a></li>
<li><a href="#example-configuration">3.6. Example configuration</a></li>
</ul>
</li>
<li><a href="#artefact-classes">4. Artefact classes</a>
<ul>
<li><a href="#binary-artefacts">4.1. Binary artefacts</a>
<ul>
<li><a href="#COMPRESSED-BLOB">4.1.1. <code>COMPRESSED-BLOB</code></a></li>
<li><a href="#ENCODED-STRING">4.1.2. <code>ENCODED-STRING</code></a></li>
</ul>
</li>
<li><a href="#string-artefacts">4.2. String artefacts</a>
<ul>
<li><a href="#BANK-CARD-NUMBER">4.2.1. <code>BANK-CARD-NUMBER</code></a></li>
<li><a href="#CREDENTIAL">4.2.2. <code>CREDENTIAL</code></a></li>
<li><a href="#DOMAIN">4.2.3. <code>DOMAIN</code></a></li>
<li><a href="#ONION">4.2.4. <code>ONION</code></a></li>
<li><a href="#EMAIL">4.2.5. <code>EMAIL</code></a></li>
<li><a href="#EMBEDDED-BINARY">4.2.6. <code>EMBEDDED-BINARY</code></a></li>
<li><a href="#IP-ADDRESS">4.2.7. <code>IP-ADDRESS</code></a></li>
<li><a href="#IP-SERVICE">4.2.8. <code>IP-SERVICE</code></a></li>
<li><a href="#RESOLVED-IP-ADDRESS">4.2.9. <code>RESOLVED-IP-ADDRESS</code></a></li>
<li><a href="#M3U-ENTRY">4.2.10. <code>M3U-ENTRY</code></a></li>
<li><a href="#URI">4.2.11. <code>URI</code></a></li>
<li><a href="#WINDOWS-INTERNAL">4.2.12. <code>WINDOWS-INTERNAL</code></a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org623fb47">5. API</a>
<ul>
<li><a href="#org0bc90cb">5.1. Generic value search</a></li>
<li><a href="#orgc470492">5.2. Typed search</a></li>
<li><a href="#orgdd10d7e">5.3. Document information</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orgfebdefa" class="outline-2">
<h2 id="intro"><span class="section-number-2">1</span> Introduction</h2>
<div class="outline-text-2" id="text-intro">
<p>
<code>pastelyzer</code> is a tool that analyses text documents and looks for security and
privacy related “items” (called <i>artefacts</i> in this document). A
distinguishing feature of the tool is that embedded binary content (e.g.,
base64-encoded) is detected and decoded. The decoded content is then
recursively processed (see section <a href="#binary-artefacts">4.1</a>).
</p>
<p>
<b>IMPORTANT</b>: This software is a work-in-progress, and is expected to change.
Make sure you consult the documentation that corresponds to the version of
<code>pastelyzer</code> you’re using.
</p>
</div>
</div>
<div id="outline-container-orgb7f1a65" class="outline-2">
<h2 id="running-pastelyzer"><span class="section-number-2">2</span> Running <code>pastelyzer</code></h2>
<div class="outline-text-2" id="text-running-pastelyzer">
<p>
The simplest way to use <code>pastelyzer</code> is on the command-line and to pass it one
or more file names. <code>pastelyzer</code> can also be run as a background service.
These modes and applicable command-line options are described in the sections
below.
</p>
</div>
<div id="outline-container-orgb4e4b97" class="outline-3">
<h3 id="common-cli-options"><span class="section-number-3">2.1</span> Common command-line options</h3>
<div class="outline-text-3" id="text-common-cli-options">
<dl class="org-dl">
<dt><code>-h, --help</code></dt><dd>Show short usage information.</dd>
<dt><code>-v, --version</code></dt><dd>Show version.</dd>
</dl>
<p>
The following options affect artefact extraction and apply in all modes:
</p>
<dl class="org-dl">
<dt><code>--[no-]resolve-damains</code></dt><dd>If <code>--resolve-domains</code> option is present, domain names are resolved to IP
addresses. If <code>--no-resolve-domains</code> is present, domains are not resolved
(default).</dd>
</dl>
</div>
</div>
<div id="outline-container-orgd2a41da" class="outline-3">
<h3 id="interactive-mode"><span class="section-number-3">2.2</span> Interactive mode</h3>
<div class="outline-text-3" id="text-interactive-mode">
<p>
Unless specified otherwise <code>pastelyzer</code> operates in an interactive mode and
processes documents specified on the command line, showing all detected
artefacts in a tree structure (see figure <a href="#org7cbdc8d">below</a>).
</p>
<div id="org7cbdc8d" class="figure">
<p><img src="img/cli-33E400e1.png" alt="cli-33E400e1.png" width="100%" />
</p>
<p><span class="figure-number">Figure 1: </span>Sample CLI usage</p>
</div>
<p>
Each line in the tree structure contains the following information:
</p>
<ul class="org-ul">
<li>Start and end character position of the artefact in the parent object.</li>
<li>Number of additional instances of this artefact (if there are any, and if
the <code>--show-duplicates</code> option is not given) in the form of <code>(+N)</code>, where
<code>N</code> is the number of additional occurrences.</li>
<li>Artefact class.</li>
<li>Short description of the artefact (depends on the class).</li>
</ul>
<p>
The following options apply to the interactive mode:
</p>
<dl class="org-dl">
<dt><code>-C, --color</code></dt><dd>Enable colors in output (default if run interactively in a terminal).</dd>
<dt><code>+C, --no-color</code></dt><dd>Disable colors in output.</dd>
<dt><code>--extract-embedded</code></dt><dd>Embedded binary artefacts are extracted and saved in the current directory.</dd>
<dt><code>--show-duplicates</code></dt><dd>Do not detect duplicate artefacts. In this case all artefacts and their
locations will be shown.</dd>
</dl>
</div>
</div>
<div id="outline-container-orgccc986c" class="outline-3">
<h3 id="standalone-mode"><span class="section-number-3">2.3</span> Standalone mode</h3>
<div class="outline-text-3" id="text-standalone-mode">
<p>
Standalone mode is selected by passing <code>server</code> as a command-line option. In
this mode <code>pastelyzer</code> receives documents from a feed<sup><a id="fnr.1" class="footref" href="#fn.1">1</a></sup>, stores them in
database and analyzes them. It is possible to control what to do with the
discovered artefacts using <a href="#configuration">configuration</a>. A sample
<code>systemd</code> service file is provided in
<a href="../support/pastelyzer.service">support/pastelyzer.service</a> file.
</p>
</div>
<div id="outline-container-org852a143" class="outline-4">
<h4 id="prerequisites"><span class="section-number-4">2.3.1</span> Prerequisites</h4>
<div class="outline-text-4" id="text-prerequisites">
<p>
<code>pastelyzer</code> stores all received documents in a PostgreSQL (version <b>9.5</b> or
later) database. Database connection parameters are set using environment
variables (see section <a href="#environment-variables">2.3.3</a>). At the moment schema
updates are managed by the application itself. This means that all tables
will be created automatically whenever <code>pastelyzer</code> is run in standalone mode.
</p>
</div>
</div>
<div id="outline-container-orgb7b0109" class="outline-4">
<h4 id="standalone-options"><span class="section-number-4">2.3.2</span> Options</h4>
<div class="outline-text-4" id="text-standalone-options">
<dl class="org-dl">
<dt><code>-c, --config</code></dt><dd>Path to configuration file (see section <a href="#configuration">3</a>).</dd>
<dt><code>-w, --workers</code></dt><dd>Number of threads to use for document processing (default: <code>4</code>).</dd>
<dt><code>--server-port</code></dt><dd>Port number where to expose the built-in web server. If the port is not
given then the web server is not started and it will not be possible to
interact with the application using HTTP protocol.</dd>
<dt><code>--server-ext-host</code>, <code>--server-ext-port</code></dt><dd>Web server host and port to use when generating links to documents (see
<code>local-url</code> <a href="#sink-field-extractors">extractor</a>). If not specified, links
of the form <code>http://localhost/...</code> will be generated.</dd>
<dt><code>--[no-]process-broken</code></dt><dd>Process pastes with broken UTF-8 content<sup><a id="fnr.2" class="footref" href="#fn.2">2</a></sup> (in addition to trying to fix
them; defaults to yes). Specific sites can be blacklisted using an
environment variable (see <a href="#environment-variables"><code>IGNORED_PASTESITES</code></a>).</dd>
</dl>
</div>
</div>
<div id="outline-container-org5c44a61" class="outline-4">
<h4 id="environment-variables"><span class="section-number-4">2.3.3</span> Environment variables</h4>
<div class="outline-text-4" id="text-environment-variables">
<dl class="org-dl">
<dt><code>DB_NAME</code></dt><dd>Database name. Default: <code>pastelyzer</code>.</dd>
<dt><code>DB_USER</code></dt><dd>Database user. Default: <code>pastelyzer</code>.</dd>
<dt><code>DB_PASS</code></dt><dd>Database password. Default: empty.</dd>
<dt><code>DB_HOST</code></dt><dd>Database host. Default: <code>localhost</code>.</dd>
<dt><code>DB_PORT</code></dt><dd>Database port. Default: <code>5432</code>.</dd>
<dt><code>CIRCL_ZMQ_ADDRESS</code></dt><dd>Paste feed endpoint<sup><a id="fnr.3" class="footref" href="#fn.3">3</a></sup>. Default: <code>tcp://crf.circl.lu:5556</code>. Can be set
to an empty value to not connect to the feed.</dd>
<dt><code>IGNORED_PASTESITES</code></dt><dd>Comma-separated list of paste sites to not re-fetch broken<sup><a id="fnr.4" class="footref" href="#fn.4">4</a></sup> pastes
from. It is a good idea to have at least <code>pastebin.com</code> in this list<sup><a id="fnr.5" class="footref" href="#fn.5">5</a></sup>.</dd>
<dt><code>HTTP_USER_AGENT</code></dt><dd>User agent to use when fetching web pages. This will be used verbatim as
the HTTP <code>User-Agent</code> header value.</dd>
</dl>
</div>
</div>
<div id="outline-container-org7338719" class="outline-4">
<h4 id="static-web-server-files"><span class="section-number-4">2.3.4</span> Static web server files</h4>
<div class="outline-text-4" id="text-static-web-server-files">
<p>
The <code>public</code> directory in the source distribution is expected to be located in
the “working directory” (or “current directory”) of the <code>pastelyzer</code> process.
It is safe to make this directory read-only, or keep it on a read-only
file system because <code>pastelyzer</code> does not write to any files.
</p>
</div>
</div>
<div id="outline-container-orgd7374eb" class="outline-4">
<h4 id="submitting-documents"><span class="section-number-4">2.3.5</span> Submitting documents</h4>
<div class="outline-text-4" id="text-submitting-documents">
<p>
If the web server is started (see <a href="#standalone-options"><code>--server-port</code></a>
option) it is also possible to submit documents using HTTP POST requests. The
following POST parameters are expected:
</p>
<dl class="org-dl">
<dt><code>data</code></dt><dd>Required. The document content.</dd>
<dt><code>source</code></dt><dd>Optional. String used to identify document source. <code>store</code> is used if not
provided. This is used as the value for <code>provider</code> column in the <code>pastes</code>
table.</dd>
<dt><code>id</code></dt><dd>Optional. Identifier of the document. If not provided the file name from
the post data is used. This is used as the value for <code>provider_id</code> column
in the <code>pastes</code> table.</dd>
</dl>
<p>
Example:
</p>
<pre class="example">
curl 'http://localhost:8080/store' -F data=@/path/to/a/file
</pre>
</div>
</div>
</div>
<div id="outline-container-org459bcdb" class="outline-3">
<h3 id="sec-reprocessing-documents"><span class="section-number-3">2.4</span> Reprocessing documents</h3>
<div class="outline-text-3" id="text-sec-reprocessing-documents">
<p>
There are a number of circumstances when the documents that are already in the
database might need to be reprocessed. These circumstances include, but are
not limited to:
</p>
<ul class="org-ul">
<li>Newer <code>pastelyzer</code> versions might process documents differently and extract
different set of artefacts (hopefully more or higher quality).</li>
<li>User configuration affects the number and kinds of artefacts that are
extracted.</li>
<li>Documents have been inserted into the database manually.</li>
</ul>
<p>
The <code>reprocess</code> mode is very similar to the <code>server</code> mode described above,
except instead of connecting to a feed the documents already present in the
database (and not processed by the current version of <code>pastelyzer</code>) are
processed. The process exits as soon as there are no documents to process.
</p>
<p>
<b>Important</b>: if <code>pastelyzer</code> configuration contains rules to send emails or
interact with other systems/programs then the reprocessing might trigger these
rules again. It is therefore advisable to create a separate configuration
file for reprocessing and either omit these rules or change them so that the
information does not go to production systems.
</p>
</div>
</div>
</div>
<div id="outline-container-org90d2f2a" class="outline-2">
<h2 id="configuration"><span class="section-number-2">3</span> Configuration</h2>
<div class="outline-text-2" id="text-configuration">
<p>
Currently configuration file is used only when running in
<a href="#standalone-mode">standalone</a> (or
<a href="#sec-reprocessing-documents">reprocess</a>) mode. By default received
documents are stored in the database, processed, and extracted artefacts are
stored in the database. <a href="#sinks">Sinks</a> are additional destinations where
artefacts can be collected, and <a href="#filters">filters</a> are used to control what
artefacts end up in which sinks.
</p>
<p>
Current sink and filter implementation is good enough to support basic use
cases. The implementation is expected to change in the future to accommodate
additional use cases.
</p>
</div>
<div id="outline-container-orgac5336c" class="outline-3">
<h3 id="syntax-overview"><span class="section-number-3">3.1</span> Syntax overview</h3>
<div class="outline-text-3" id="text-syntax-overview">
<p>
Configuration is written using
<a href="https://en.wikipedia.org/wiki/S-expression">S-expressions</a>. The most
unusual thing about this notation might be the prefix notation, but it can
also be thought of as XML simplified (i.e., no need for closing tags). Please
refer to <a href="https://en.wikipedia.org/wiki/S-expression">Wikipedia page</a> for a
more verbose introduction.
</p>
<p>
Syntax used in <code>pastelyzer</code> configuration file have an extension: square
brackets can be used to specify byte-vectors. The elements between opening
and closing square brackets are expected to be space-separated hexadecimal
8-bit numbers (case-insensitive). Example: <code>[7f 45 4c 46]</code>.
</p>
<p>
The following configuration directives are recognized (described in following
sections): <code>define-set</code>, <code>define-sink</code> and <code>define-artefact-filter</code><sup><a id="fnr.6" class="footref" href="#fn.6">6</a></sup>.
These directives, as well as other <i>symbolic</i> identifiers are <b>case
insensitive</b>.
</p>
</div>
</div>
<div id="outline-container-org1faca1d" class="outline-3">
<h3 id="sec-user-sets"><span class="section-number-3">3.2</span> User sets</h3>
<div class="outline-text-3" id="text-sec-user-sets">
<p>
<code>define-set</code> defines a set of values that can then be used in filters. As an
example consider a list of valid TLDs (top-level domains) that can be applied
to filter domain-looking strings. The syntax of the directive is like this:
</p>
<div class="org-src-container">
<pre class="src src-sexpr">(<span style="color: #1874cd;">define-set</span> <name> (<type>) <attribute>*)
</pre>
</div>
<p>
<code><name></code> is used in other parts of the configuration to refer to this set.
<code><type></code> is one of the built-in set types (described below). Attributes
common to all of the sets are:
</p>
<dl class="org-dl">
<dt><code>:entries ("entry1" ("entry2" "Note for entry2") ...)</code></dt><dd>Entries of the set provided in the configuration file itself. Mutually
exclusive with the <code>:file</code> attribute. Each entry in the list can be:
<ul class="org-ul">
<li>like <code>entry1</code> — a plain string, or</li>
<li>like <code>entry2</code> — a list where first element is the entry and the second
element is a note to be attached to the matching artefact (see
<a href="#sec-artefact-export">3.5</a>).</li>
</ul></dd>
<dt><code>:file "path/to-file"</code></dt><dd>Path to a file where to read the set entries from. Each line of the file is
read as a set entry.</dd>
<dt><code>:comment-start <string></code></dt><dd>(Only when reading entries from file) line starting with the provided string
(defaults to <code>"#"</code>) are treated as comment lines and are not included as
entries in the set. For now only a single comment start string can be
provided.</dd>
<dt><code>:attach-comments <bool></code></dt><dd>When <a href="#specifying-values">true</a> (default is false) comments are attached
to all artefacts matching the following entries as notes (see
<a href="#sec-artefact-export">3.5</a>). An empty comment or an empty line can be used to
clear the comment for the following entries. Only single-line comments are
used as notes and each consecutive comment line will override the comment
set before.</dd>
<dt><code>:trim-space <bool></code></dt><dd>(Only when reading entries from file) when <a href="#specifying-values">true</a>
(default) leading and trailing white-space characters are removed from each
line read (including comment lines).</dd>
</dl>
<p>
Descriptions of defined set types follow.
</p>
</div>
<div id="outline-container-orgfffc128" class="outline-4">
<h4 id="orgfffc128"><span class="section-number-4">3.2.1</span> <code>super-domains</code></h4>
<div class="outline-text-4" id="text-3-2-1">
<p>
Each entry is a “super-domain” and can be used for sub-domain membership test.
As an example listing <a href="#orgb25baf4">1</a> shows configuration to mark
<code>domain</code> artefacts matching your organization as important (see
<a href="#filters">filters</a> below):
</p>
<div class="org-src-container">
<label class="org-src-name"><span class="listing-number">Listing 1: </span>Sample super-domain set</label><pre class="src src-sexpr" id="orgb25baf4">(<span style="color: #1874cd;">define-set</span> our-org (super-domains)
<span style="color: #cd6600;">:entries</span> (<span style="color: #a52a2a;">"our.org"</span> <span style="color: #a52a2a;">"our-org.com"</span>))
(<span style="color: #1874cd;">define-filter</span> our-domain
(and (type? domain)
(member? our-org))
(set-important))
</pre>
</div>
<p>
<b>Note</b>: super-domain membership tests are case-insensitive!
</p>
</div>
</div>
<div id="outline-container-orgfab6f2f" class="outline-4">
<h4 id="orgfab6f2f"><span class="section-number-4">3.2.2</span> <code>ipv4-networks</code></h4>
<div class="outline-text-4" id="text-3-2-2">
<p>
Each entry specifies an IPv4 network (in
<a href="https://tools.ietf.org/html/rfc4632#section-3.1">CIDR notation</a>). For
example if you are not interested in local IP addresses you could use the
configuration shown in listing <a href="#orgc498eb5">2</a>:
</p>
<div class="org-src-container">
<label class="org-src-name"><span class="listing-number">Listing 2: </span>Sample IPv4 networks set</label><pre class="src src-sexpr" id="orgc498eb5">(<span style="color: #1874cd;">define-set</span> private-networks (ipv4-networks)
<span style="color: #cd6600;">:entries</span> (<span style="color: #a52a2a;">"10.0.0.0/8"</span> <span style="color: #a52a2a;">"172.16.0.0/12"</span> <span style="color: #a52a2a;">"192.168.0.0/16"</span>))
(<span style="color: #1874cd;">define-filter</span> private-ip
(and (type? ip-address)
(member? private-networks))
(discard <span style="color: #a52a2a;">"Private network"</span>))
</pre>
</div>
</div>
</div>
<div id="outline-container-orgf4b3648" class="outline-4">
<h4 id="cc-bins-set"><span class="section-number-4">3.2.3</span> <code>cc-bins</code></h4>
<div class="outline-text-4" id="text-cc-bins-set">
<p>
Each entry specifies a bank card
<a href="https://en.wikipedia.org/wiki/Payment_card_number">BIN</a>. The format is:
digit characters followed by number placeholder characters. The number of
digit and placeholder characters should match the number of bank card digits
corresponding to the bin (e.g., 16 for Visa and Mastercard). Spaces are
ignored (in both prefix and placeholder parts).
</p>
<p>
Listing <a href="#org3654a71">3</a> defines 5 bins for 2 banks. The first bank uses
16-digit numbers that start with <code>123456</code>, <code>424242</code> and <code>111122</code>. The second
bank uses 15-digit numbers that start with <code>23</code> and <code>32</code>. A set with the
entries from this file can then be defined as shown in listing
<a href="#orge349376">4</a> (<code>:attach-comments</code> option defaults to <code>true</code> when
reading bank card BINs).
</p>
<div class="org-src-container">
<label class="org-src-name"><span class="listing-number">Listing 3: </span>Sample bank card BIN file</label><pre class="src src-text" id="org3654a71"># This is just an example. The note before each block will be
# attached to all following entries.
# National bank
1234 56xx xxxx xxxx
424242 xx xxxx xxxx
111122xxxxxxxxxx
# Other bank
23xx xxxxxx xxxxx
32xxxxxxxxxxxxx
</pre>
</div>
<div class="org-src-container">
<label class="org-src-name"><span class="listing-number">Listing 4: </span>Using sample bank card BIN file</label><pre class="src src-sexpr" id="orge349376">(<span style="color: #1874cd;">define-set</span> special-bins (cc-bins)
<span style="color: #cd6600;">:file</span> <span style="color: #a52a2a;">"path/to/above/file.ext"</span>)
</pre>
</div>
<p>
The same bins can also be defined in-line, as shown in listing
<a href="#orgd0bda35">5</a> (notice that the note has to be specified for each
entry individually):
</p>
<div class="org-src-container">
<label class="org-src-name"><span class="listing-number">Listing 5: </span>Sample in-line bank card BINs</label><pre class="src src-sexpr" id="orgd0bda35">(<span style="color: #1874cd;">define-set</span> special-bins (cc-bins)
<span style="color: #cd6600;">:entries</span> ((<span style="color: #a52a2a;">"1234 56xx xxxx xxxx"</span> <span style="color: #a52a2a;">"National bank"</span>)
(<span style="color: #a52a2a;">"424242 xx xxxx xxxx"</span> <span style="color: #a52a2a;">"National bank"</span>)
(<span style="color: #a52a2a;">"111122xxxxxxxxxx"</span> <span style="color: #a52a2a;">"National bank"</span>)
(<span style="color: #a52a2a;">"23xx xxxxxx xxxxx"</span> <span style="color: #a52a2a;">"Other bank"</span>)
(<span style="color: #a52a2a;">"32xxxxxxxxxxxxx"</span> <span style="color: #a52a2a;">"Other bank"</span>)))
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-orgaf91e69" class="outline-3">
<h3 id="sinks"><span class="section-number-3">3.3</span> Sinks</h3>
<div class="outline-text-3" id="text-sinks">
<p>
<code>define-sink</code> directive is used to define a sink. The syntax is as follows:
</p>
<div class="org-src-container">
<pre class="src src-sexpr">(<span style="color: #1874cd;">define-sink</span> <name> (<parent>) <attribute>*)
</pre>
</div>
<p>
<code><name></code> is the name of sink being defined and will be used to refer to it in
<a href="#filters">filters</a> or as a parent in another sink.
</p>
<p>
<code><parent></code> should be either one of the built-in sink implementations
(described in the following sections), or another sink that has been defined
previously. Even though a sink can only have one parent it has to be
specified as a single-element list (i.e., it has to be surrounded by
parenthesis).
</p>
<p>
There can be zero or more <code><attribute></code> specifications of the following form:
</p>
<div class="org-src-container">
<pre class="src src-sexpr">(<name> <parameter>*)
</pre>
</div>
<p>
Attribute <code><name></code> will usually be a keyword (i.e., a symbol starting with a
colon). Each sink implementation has a different set of supported attributes
described in corresponding section below.
</p>
</div>
<div id="outline-container-org3447c51" class="outline-4">
<h4 id="specifying-values"><span class="section-number-4">3.3.1</span> Specifying values</h4>
<div class="outline-text-4" id="text-specifying-values">
<p>
Attribute values have types. This means that if a <code>string</code> value is required,
the value must be enclosed in double quotes (i.e., <code>"this is a string"</code>).
</p>
<p>
Values can also be forms:
</p>
<dl class="org-dl">
<dt><code>"string"</code></dt><dd>A string value stands for itself.</dd>
<dt><code>yes</code>, <code>true</code></dt><dd>A boolean true value.</dd>
<dt><code>no</code>, <code>false</code></dt><dd>A boolean false value.</dd>
<dt><code>(env <string>)</code></dt><dd>Returns the value of process environment variable named by given string.</dd>
<dt><code>(file-contents <string>)</code></dt><dd>Returns the contents of a file named by the given string.</dd>
<dt><code>(or <form>+)</code></dt><dd>Returns the first form from the given list that has a value. For example,
the form <code>(or (env "SOME_VAR" "undefined"))</code> will return
the value of <code>SOME_VAR</code> environment variable, or the string <code>"undefined"</code> if
there is no such environment variable.</dd>
</dl>
</div>
</div>
<div id="outline-container-org036db5d" class="outline-4">
<h4 id="templates"><span class="section-number-4">3.3.2</span> Templates</h4>
<div class="outline-text-4" id="text-templates">
<p>
If an attribute is specified to be a template, the value of an attribute will
be generated using forms provided in the attribute.
</p>
<dl class="org-dl">
<dt><code>:nl</code></dt><dd>New line: outputs a newline character, unconditionally.</dd>
<dt><code>:fl</code></dt><dd>Fresh line: outputs a newline only if the last character was not a newline.</dd>
<dt><code>(extract <field>)</code></dt><dd>Extracts <code>field</code> from the context variable. See
<a href="#sink-field-extractors">document</a> and
<a href="#item-field-extractors">artefact</a> field extractors below.</dd>
<dt><code>(fmt <format-string> <form>+)</code></dt><dd>Formats given parameters using Common-lisp
<a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_format.htm">format</a>
function. For advanced users only.</dd>
<dt><code>(unique-count <artefact-class>)</code></dt><dd>Not really a filter function or an extractor, but can be used in sink
attribute <a href="#templates">templates</a> to calculate the number of unique
artefacts of the given <code>artefact-class</code> in a document currently being
processed. Note: this is a hack, and most probably will change once we come
up with a more general way to access this information.</dd>
</dl>
</div>
</div>
<div id="outline-container-org4f5b836" class="outline-4">
<h4 id="sink-field-extractors"><span class="section-number-4">3.3.3</span> Document field extractors</h4>
<div class="outline-text-4" id="text-sink-field-extractors">
<dl class="org-dl">
<dt><code>origin</code></dt><dd>Source site of the document being processed. E.g., <code>pastebin.com</code>.</dd>
<dt><code>remote-url</code></dt><dd>The URL of the document being processed (if available).</dd>
<dt><code>remote-raw-url</code></dt><dd>The URL to the raw contents of the document being processed (if available).</dd>
<dt><code>local-url</code></dt><dd>The URL to the local copy of the document being processed. See
<code>--server-ext-host</code> and <code>--server-ext-port</code> command line
<a href="#standalone-options">options</a>.</dd>
<dt><code>artefact-descriptions</code></dt><dd>Generates a summary of all artefacts collected in a sink, grouped by
artefact class, one per line.</dd>
<dt><code>artefact-summary-by-class</code></dt><dd>Generates a comma-separated string with artefact class and the number of
artefacts with this class collected in the sink.</dd>
</dl>
</div>
</div>
<div id="outline-container-org278a5f0" class="outline-4">
<h4 id="item-field-extractors"><span class="section-number-4">3.3.4</span> Artefact field extractors</h4>
<div class="outline-text-4" id="text-item-field-extractors">
<dl class="org-dl">
<dt><code>note</code></dt><dd>Note associated with an artefact.</dd>
<dt><code>important</code></dt><dd>Important flag set on an artefact.</dd>
<dt><code>source-string</code></dt><dd>String representation of the current artefact as it is in source document.</dd>
<dt><code>source-context</code></dt><dd>The whole text (string) where current artefact has been found, usually the
whole document currently being processed (might be embedded).</dd>
<dt><code>context-before</code></dt><dd>Text preceding current artefact in source document.</dd>
<dt><code>context-after</code></dt><dd>Text following current artefact in source document.</dd>
<dt><code>bytes</code></dt><dd>(Applies to <code>EMBEDDED-BINARY</code> artefacts only) bytes of an artefact after
decoding.</dd>
<dt><code>digits</code></dt><dd>(Applies to <code>BANK-CARD-NUMBER</code> only) digits of a bank card number with no
separators.</dd>
</dl>
</div>
</div>
<div id="outline-container-org5944a9c" class="outline-4">
<h4 id="sec-process-extractors"><span class="section-number-4">3.3.5</span> Extractors valid in process filters</h4>
<div class="outline-text-4" id="text-sec-process-extractors">
<p>
The following extractors are only valid in <a href="#sec-process-filters">process
filters</a>:
</p>
<dl class="org-dl">
<dt><code>stdout</code></dt><dd>Standard output of the finished process.</dd>
<dt><code>stderr</code></dt><dd>Standard error output of the finished process.</dd>
<dt><code>status</code></dt><dd>Exit status of the finished process.</dd>
</dl>
</div>
</div>
<div id="outline-container-org0205236" class="outline-4">
<h4 id="WEB-SINK"><span class="section-number-4">3.3.6</span> <code>WEB-SINK</code></h4>
<div class="outline-text-4" id="text-WEB-SINK">
<p>
This is the simplest sink. It does not have any parameters.
</p>
<p>
Example:
</p>
<div class="org-src-container">
<pre class="src src-sexpr">(<span style="color: #1874cd;">define-sink</span> dashboard (web-sink))
</pre>
</div>
</div>
</div>
<div id="outline-container-org867058d" class="outline-4">
<h4 id="SMTP-SINK"><span class="section-number-4">3.3.7</span> <code>SMTP-SINK</code></h4>
<div class="outline-text-4" id="text-SMTP-SINK">
<p>
This sink is used to send emails. Attributes:
</p>
<dl class="org-dl">
<dt><code>(:server <string>)</code></dt><dd>Sets the outgoing SMTP server to the given string.</dd>
<dt><code>(:from <string>)</code></dt><dd>Sets the sender (“From” field) of the outgoing emails.</dd>
<dt><code>(:subject <form>+)</code></dt><dd><a href="#templates">Template</a> attribute to generate subject line of the outgoing