forked from cisagov/Malcolm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocker-compose-standalone.yml
968 lines (945 loc) · 35.2 KB
/
docker-compose-standalone.yml
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
# Copyright (c) 2022 Battelle Energy Alliance, LLC. All rights reserved.
version: '3.7'
################################################################################
# Commonly tweaked configuration options
#-------------------------------------------------------------------------------
x-process-variables: &process-variables
# docker containers will run processes as unprivileged user with UID:GID
PUID : 1000
PGID : 1000
x-auth-variables: &auth-variables
# authentication method: encrypted HTTP basic authentication ('true') vs LDAP ('false')
NGINX_BASIC_AUTH : 'true'
# NGINX LDAP (NGINX_BASIC_AUTH=false) can support LDAP, LDAPS, or LDAP+StartTLS.
# For StartTLS, set NGINX_LDAP_TLS_STUNNEL=true to issue the StartTLS command
# and use stunnel to tunnel the connection.
NGINX_LDAP_TLS_STUNNEL : 'false'
# stunnel will require and verify certificates for StartTLS when one or more
# trusted CA certificate files are placed in the ./nginx/ca-trust directory.
# For additional security, hostname or IP address checking of the associated
# CA certificate(s) can be enabled by providing these values.
NGINX_LDAP_TLS_STUNNEL_CHECK_HOST : ''
NGINX_LDAP_TLS_STUNNEL_CHECK_IP : ''
NGINX_LDAP_TLS_STUNNEL_VERIFY_LEVEL : 2
x-nginx-variables: &nginx-variables
# Whether or not nginx should use HTTPS. This is almost CERTAINLY what you want.
# The only case you may want to set this to false is if you're using another
# reverse proxy in front of Malcolm. Even if set to 'false', NGINX will still
# listen on port 443 (it just won't be encrypted). If you change this, you'll
# probably want to change "0.0.0.0:443:443" to something like
# "127.0.0.1:80:443" in the ports section for the nginx-proxy service.
NGINX_SSL : 'true'
# Whether or not to write nginx's access.log and error.log to OpenSearch
NGINX_LOG_ACCESS_AND_ERRORS : 'false'
x-ssl-variables: &ssl-variables
# When possible, docker containers will automatically add trusted CA certificate files
# found in the ./nginx/ca-trust directory (which is bind mounted to /ca-trust).
PUSER_CA_TRUST : '/var/local/ca-trust'
x-opensearch-variables: &opensearch-variables
# Used in various services to define the connection to the OpenSearch document store.
# Whether or not Malcolm will start and use its own local OpenSearch instance as its
# primary data store. Set to 'false' if you're connecting to another OpenSearch
# cluster, in which case the other environment variables in this section must also
# be set with the connection parameters.
OPENSEARCH_LOCAL : 'true'
# URL for connecting to OpenSearch instance. When using Malcolm's internal instance
# of OpenSearch (i.e., OPENSEARCH_LOCAL is 'true') this should be
# 'http://opensearch:9200', otherwise specify the primary remote instance URL
# in the format 'protocol://host:port'.
OPENSEARCH_URL : 'http://opensearch:9200'
# Used when OPENSEARCH_LOCAL is 'false', the cURL-formatted config file contains login
# credentials for the primary OpenSearch instance. It can be generated for you by the
# ./scripts/auth_setup script. The notable parameters expected from this file would be
# user (with a "user:password" value) and "insecure" (if the certificate verification
# setting below is 'false'). See cURL config file format at
# https://everything.curl.dev/cmdline/configfile. This file is bind mounted locally
# from .opensearch.primary.curlrc as /var/local/opensearch.primary.curlrc
OPENSEARCH_CREDS_CONFIG_FILE : '/var/local/opensearch.primary.curlrc'
# Whether or not connections to the primary remote OpenSearch instance require full
# TLS certificate validation for the connection (this may fail if using self-signed
# certificates).
OPENSEARCH_SSL_CERTIFICATE_VERIFICATION : 'false'
# Whether or not Malcolm's Logstash instance will forward logs to a secondary remote
# OpenSearch instance in addition to the (local or remote) primary instance.
OPENSEARCH_SECONDARY : 'false'
# URL for connecting to the secondary remote OpenSearch instance, specified
# in the format 'protocol://host:port'.
OPENSEARCH_SECONDARY_URL : ''
# Used when OPENSEARCH_SECONDARY is 'true', the cURL-formatted config file contains login
# credentials for the secondary OpenSearch instance. The comments describing
# OPENSEARCH_CREDS_CONFIG_FILE above also apply here. This file is bind mounted locally
# from .opensearch.secondary.curlrc as /var/local/opensearch.secondary.curlrc
OPENSEARCH_SECONDARY_CREDS_CONFIG_FILE : '/var/local/opensearch.secondary.curlrc'
# Whether or not connections to the secondary remote OpenSearch instance require full
# TLS certificate validation for the connection (this may fail if using self-signed
# certificates).
OPENSEARCH_SECONDARY_SSL_CERTIFICATE_VERIFICATION : 'false'
x-arkime-variables: &arkime-variables
# Whether or not Arkime is allowed to delete uploaded/captured PCAP (see
# https://arkime.com/faq#pcap-deletion)
MANAGE_PCAP_FILES : 'false'
# The number of Arkime capture processes allowed to run concurrently
ARKIME_ANALYZE_PCAP_THREADS : 1
# MaxMind GeoIP database update API key (see
# https://support.maxmind.com/hc/en-us/articles/4407116112539-Using-License-Keys)
MAXMIND_GEOIP_DB_LICENSE_KEY : '0'
x-zeek-live-variables: &zeek-live-variables
# Whether or not Zeek should monitor live traffic on a local
# interface (PCAP_IFACE variable below specifies capture interfaces)
ZEEK_LIVE_CAPTURE : 'false'
x-zeek-offline-variables: &zeek-offline-variables
# Whether or not Zeek should analyze uploaded PCAP files
ZEEK_AUTO_ANALYZE_PCAP_FILES : 'true'
# The number of Zeek processes for analyzing uploaded PCAP files allowed
# to run concurrently
ZEEK_AUTO_ANALYZE_PCAP_THREADS : 1
# Whether or not Zeek should analyze captured PCAP files captured
# by netsniff-ng/tcpdump (see PCAP_ENABLE_NETSNIFF and PCAP_ENABLE_TCPDUMP
# below). If ZEEK_LIVE_CAPTURE is true, this should be false: otherwise
# Zeek will see duplicate traffic.
ZEEK_ROTATED_PCAP : 'true'
x-zeek-variables: &zeek-variables
# Specifies the value for Zeek's Intel::item_expiration timeout (-1min to disable)
ZEEK_INTEL_ITEM_EXPIRATION : '-1min'
# When querying a TAXII or MISP feed, only process threat indicators that have
# been created or modified since the time represented by this value;
# it may be either a fixed date/time (01/01/2021) or relative interval (30 days ago)
ZEEK_INTEL_FEED_SINCE : ''
# Specifies a cron expression indicating the refresh interval for generating the
# Zeek Intelligence Framework files ('' disables automatic refresh)
ZEEK_INTEL_REFRESH_CRON_EXPRESSION : ''
# Determines the file extraction behavior for file transfers detected by Zeek
ZEEK_EXTRACTOR_MODE : 'none'
# Whether or not files extant in ./zeek-logs/extract_files/ will be ignored on startup
EXTRACTED_FILE_IGNORE_EXISTING : 'false'
# Determines the behavior for preservation of Zeek-extracted files
EXTRACTED_FILE_PRESERVATION : 'quarantined'
# The minimum size (in bytes) for files to be extracted by Zeek
EXTRACTED_FILE_MIN_BYTES : 64
# The maximum size (in bytes) for files to be extracted by Zeek
EXTRACTED_FILE_MAX_BYTES : 134217728
# A VirusTotal Public API v.20 used to submit hashes of Zeek-extracted files
VTOT_API2_KEY : '0'
# Rate limiting for VirusTotal, ClamAV, YARA and capa with Zeek-extracted files
VTOT_REQUESTS_PER_MINUTE : 4
CLAMD_MAX_REQUESTS : 8
YARA_MAX_REQUESTS : 8
CAPA_MAX_REQUESTS : 4
# Whether or not YARA will scan Zeek-extracted files
EXTRACTED_FILE_ENABLE_YARA : 'false'
# Whether or not the default YARA ruleset will be ignored and only custom rules used
EXTRACTED_FILE_YARA_CUSTOM_ONLY : 'false'
# Whether or not capa will scan Zeek-extracted executables
EXTRACTED_FILE_ENABLE_CAPA : 'false'
# Whether or not capa will be extra verbose
EXTRACTED_FILE_CAPA_VERBOSE : 'false'
# Whether or not ClamAV will scan Zeek-extracted executables
EXTRACTED_FILE_ENABLE_CLAMAV : 'false'
# Whether or not to regularly update rule definitions for file scanning engines
EXTRACTED_FILE_UPDATE_RULES : 'false'
# Whether or not to enable debug output for Zeek-extracted file scanning
EXTRACTED_FILE_PIPELINE_DEBUG : 'false'
# Whether or not to enable very verbose debug output for Zeek-extracted file scanning
EXTRACTED_FILE_PIPELINE_DEBUG_EXTRA : 'false'
# Whether or not to serve the directory containing Zeek-extracted over HTTP at ./extracted-files/
EXTRACTED_FILE_HTTP_SERVER_ENABLE : 'false'
# Whether or not Zeek-extracted files served over HTTP will be AES-256-CBC-encrypted
EXTRACTED_FILE_HTTP_SERVER_ENCRYPT : 'true'
# Specifies the AES-256-CBC decryption password for encrypted Zeek-extracted files served over HTTP
EXTRACTED_FILE_HTTP_SERVER_KEY : 'quarantined'
# Environment variables for tweaking Zeek at runtime (see local.zeek)
# Set to any non-blank value to disable the corresponding feature
ZEEK_DISABLE_HASH_ALL_FILES : ''
ZEEK_DISABLE_LOG_PASSWORDS : ''
ZEEK_DISABLE_SSL_VALIDATE_CERTS : ''
ZEEK_DISABLE_TRACK_ALL_ASSETS : ''
ZEEK_DISABLE_BEST_GUESS_ICS : 'true'
ZEEK_DISABLE_SPICY_DHCP : 'true'
ZEEK_DISABLE_SPICY_DNS : 'true'
ZEEK_DISABLE_SPICY_HTTP : 'true'
ZEEK_DISABLE_SPICY_IPSEC : ''
ZEEK_DISABLE_SPICY_LDAP : ''
ZEEK_DISABLE_SPICY_OPENVPN : ''
ZEEK_DISABLE_SPICY_STUN : ''
ZEEK_DISABLE_SPICY_TAILSCALE : ''
ZEEK_DISABLE_SPICY_TFTP : ''
ZEEK_DISABLE_SPICY_WIREGUARD : ''
x-suricata-live-variables: &suricata-live-variables
# Whether or not Suricata should monitor live traffic on a local
# interface (PCAP_IFACE variable below specifies capture interfaces)
SURICATA_LIVE_CAPTURE : 'false'
# Specifies the Suricata runmode for live capture (see
# https://suricata.readthedocs.io/en/latest/performance/runmodes.html)
SURICATA_RUNMODE : 'workers'
x-suricata-offline-variables: &suricata-offline-variables
# Whether or not Suricata should analyze uploaded PCAP files
SURICATA_AUTO_ANALYZE_PCAP_FILES: 'true'
# The number of Suricata processes for analyzing uploaded PCAP files allowed
# to run concurrently
SURICATA_AUTO_ANALYZE_PCAP_THREADS : 1
# Whether or not Suricata should analyze captured PCAP files captured
# by netsniff-ng/tcpdump (see PCAP_ENABLE_NETSNIFF and PCAP_ENABLE_TCPDUMP
# below). If SURICATA_LIVE_CAPTURE is true, this should be false: otherwise
# Suricata will see duplicate traffic.
SURICATA_ROTATED_PCAP : 'true'
x-suricata-variables: &suricata-variables
# Whether or not the default Suricata ruleset will be ignored and only custom rules used
SURICATA_CUSTOM_RULES_ONLY : 'false'
SURICATA_UPDATE_RULES: 'false'
SURICATA_UPDATE_DEBUG: 'false'
SURICATA_UPDATE_ETOPEN: 'true'
# suricata_config_populate.py can use MANY more environment variables to tweak
# suricata.yaml (see https://github.com/OISF/suricata/blob/master/suricata.yaml.in and
# https://suricata.readthedocs.io/en/latest/configuration/suricata-yaml.html).
# DEFAULT_VARS in that script defines those variables (albeit without the
# required `SURICATA_` prefixing each)
x-dashboards-helper-variables: &dashboards-helper-variables
# The maximum cumulative size of OpenSearch indices containing network traffic metadata
# (arkime_sessions3-*) before which the oldest indices will be deleted ('' to disable
# storage-based index pruning).
OPENSEARCH_INDEX_SIZE_PRUNE_LIMIT : '0'
# Whether to determine the "oldest" indices for storage-based index pruning by creation
# date/time ('true') or index name ('false')
OPENSEARCH_INDEX_SIZE_PRUNE_NAME_SORT : 'false'
# Parameters for the OpenSearch repository used for index snapshots
ISM_SNAPSHOT_COMPRESSED : 'false'
ISM_SNAPSHOT_REPO : 'logs'
x-logstash-variables: &logstash-variables
# Parameters for tuning Logstash pipelines (see
# https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html)
pipeline.workers : 3
pipeline.batch.size : 75
pipeline.batch.delay : 50
# Whether or not Logstash will map MAC addresses to vendors for MAC addresses
LOGSTASH_OUI_LOOKUP : 'true'
# Whether or not Logstash will perform severity scoring on network traffic metadata
LOGSTASH_SEVERITY_SCORING : 'true'
# Whether or not Logstash will perform a reverse DNS lookup for external IP addresses
LOGSTASH_REVERSE_DNS : 'false'
x-filebeat-variables: &filebeat-variables
# filebeat parameters used for monitoring log files containing network traffic metadata
# (see https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-log.html)
FILEBEAT_SCAN_FREQUENCY : '10s'
FILEBEAT_CLEAN_INACTIVE : '180m'
FILEBEAT_IGNORE_OLDER : '120m'
FILEBEAT_CLOSE_INACTIVE : '120s'
FILEBEAT_CLOSE_INACTIVE_LIVE : '90m'
FILEBEAT_CLOSE_RENAMED : 'true'
FILEBEAT_CLOSE_REMOVED : 'true'
FILEBEAT_CLOSE_EOF : 'true'
FILEBEAT_CLEAN_REMOVED : 'true'
# Whether or not to expose a filebeat TCP input listener (see
# https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-tcp.html)
FILEBEAT_TCP_LISTEN : 'false'
# Log format expected for events sent to the filebeat TCP input listener ('json' or 'raw')
FILEBEAT_TCP_LOG_FORMAT : 'raw'
# Source field name to parse (when FILEBEAT_TCP_LOG_FORMAT is 'json') for events sent to the
# filebeat TCP input listener
FILEBEAT_TCP_PARSE_SOURCE_FIELD : 'message'
# Target field name to store decoded JSON fields (when FILEBEAT_TCP_LOG_FORMAT is 'json') for
# events sent to the filebeat TCP input listener
FILEBEAT_TCP_PARSE_TARGET_FIELD : ''
# Name of field to drop (if it exists) in events sent to the filebeat TCP input listener
FILEBEAT_TCP_PARSE_DROP_FIELD : ''
# Tag to append to events sent to the filebeat TCP input listener
FILEBEAT_TCP_TAG : '_malcolm_beats'
x-common-upload-variables: &common-upload-variables
# Whether or not to automatically apply tags based (on the PCAP filename) to network traffic metadata
# parsed from uploaded PCAP files
AUTO_TAG : 'true'
# The node name (e.g., the hostname of this machine running Malcolm) to associate with
# network traffic metadata
PCAP_NODE_NAME : 'malcolm'
# Whether or not to enable debug output for processing uploaded/captured PCAP files
PCAP_PIPELINE_DEBUG : 'false'
# Whether or not to enable very verbose debug output for processing uploaded/captured PCAP files
PCAP_PIPELINE_DEBUG_EXTRA : 'false'
# Whether or not PCAP files extant in ./pcap/ will be ignored on startup
PCAP_PIPELINE_IGNORE_PREEXISTING : 'false'
# 'pcap-monitor' to match the name of the container providing the uploaded/captured PCAP file
# monitoring service
PCAP_MONITOR_HOST : 'pcap-monitor'
# The age (in minutes) at which already-processed log files containing network traffic metadata should
# be pruned from the filesystem
LOG_CLEANUP_MINUTES : 360
# The age (in minutes) at which the compressed archives containing already-processed log files should
# be pruned from the filesystem
ZIP_CLEANUP_MINUTES : 720
x-common-lookup-variables: &common-lookup-variables
# Whether or not domain names (from DNS queries and SSL server names) will be assigned entropy scores
# as calculated by freq
FREQ_LOOKUP : 'true'
# When severity scoring is enabled, this variable indicates the entropy threshold for
# assigning severity to events with entropy scores calculated by freq;
# a lower value will only assign severity scores to fewer domain names with higher entropy
FREQ_SEVERITY_THRESHOLD : '2.0'
# When severity scoring is enabled, this variable indicates the size threshold (in megabytes)
# for assigning severity to large connections or file transfers
TOTAL_MEGABYTES_SEVERITY_THRESHOLD : 1000
# When severity scoring is enabled, this variable indicates the duration threshold (in seconds)
# for assigning severity to long connections
CONNECTION_SECONDS_SEVERITY_THRESHOLD : 3600
# When severity scoring is enabled, this variable defines a comma-separated list of
# sensitive countries (using ISO 3166-1 alpha-2 codes)
SENSITIVE_COUNTRY_CODES : 'AM,AZ,BY,CN,CU,DZ,GE,HK,IL,IN,IQ,IR,KG,KP,KZ,LY,MD,MO,PK,RU,SD,SS,SY,TJ,TM,TW,UA,UZ'
x-common-beats-variables: &common-beats-variables
# Whether or not Logstash will use require encrypted communications for any external
# Beats-based forwarders from which it will accept logs
BEATS_SSL : 'true'
x-pcap-capture-variables: &pcap-capture-variables
# Whether or not netsniff-ng should create PCAP files from live traffic on a local
# interface for analysis by Arkime capture (should be 'false' if PCAP_ENABLE_TCPDUMP
# is 'true')
PCAP_ENABLE_NETSNIFF : 'false'
# Whether or not tcpdump should create PCAP files from live traffic on a local
# interface for analysis by Arkime capture (should be 'false' if PCAP_ENABLE_NETSNIFF
# is 'true')
PCAP_ENABLE_TCPDUMP : 'false'
# Specifies local network interface(s) for local packet capture if PCAP_ENABLE_NETSNIFF,
# PCAP_ENABLE_TCPDUMP, ZEEK_LIVE_CAPTURE or SURICATA_LIVE_CAPTURE are 'true'
PCAP_IFACE : 'lo'
# Whether or not ethtool will disable NIC hardware offloading features and adjust
# ring buffer sizes for capture interface(s) (should be 'true' if the interface(s) are
# being used for capture only, 'false' if they are being used for management/communication)
PCAP_IFACE_TWEAK : 'false'
# Specifies how large a locally-captured PCAP file can become (in megabytes) before
# it is closed for processing and a new PCAP file created
PCAP_ROTATE_MEGABYTES : 1024
# Specifies a time interval (in minutes) after which a locally-captured PCAP file
# will be closed for processing and a new PCAP file created
PCAP_ROTATE_MINUTES : 10
# Specifies a tcpdump-style filter expression for local packet capture ('' to capture all traffic)
PCAP_FILTER : ''
################################################################################
services:
opensearch:
image: malcolmnetsec/opensearch:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: opensearch
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *opensearch-variables
logger.level : 'WARN'
bootstrap.memory_lock : 'true'
MAX_LOCKED_MEMORY : 'unlimited'
OPENSEARCH_JAVA_OPTS : '-server -Xms4g -Xmx4g -Xss256k -XX:-HeapDumpOnOutOfMemoryError -Djava.security.egd=file:/dev/./urandom -Dlog4j.formatMsgNoLookups=true'
VIRTUAL_HOST : 'os.malcolm.local'
discovery.type : 'single-node'
cluster.routing.allocation.disk.threshold_enabled : 'false'
cluster.routing.allocation.node_initial_primaries_recoveries : 8
indices.query.bool.max_clause_count : 4096
path.repo : '/opt/opensearch/backup'
expose:
- 9200
ulimits:
memlock:
soft: -1
hard: -1
cap_add:
- IPC_LOCK
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./.opensearch.primary.curlrc:/var/local/opensearch.primary.curlrc:ro
- ./.opensearch.secondary.curlrc:/var/local/opensearch.secondary.curlrc:ro
- ./opensearch/opensearch.keystore:/usr/share/opensearch/config/opensearch.keystore:rw
- ./opensearch:/usr/share/opensearch/data:delegated
- ./opensearch-backup:/opt/opensearch/backup:delegated
healthcheck:
test: ["CMD", "curl", "--silent", "--fail", "http://localhost:9200"]
interval: 30s
timeout: 15s
retries: 3
start_period: 180s
dashboards-helper:
image: malcolmnetsec/dashboards-helper:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: dashboards-helper
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *opensearch-variables
<< : *dashboards-helper-variables
DASHBOARDS_URL : 'http://dashboards:5601/dashboards'
VIRTUAL_HOST : 'dashboards-helper.malcolm.local'
ARKIME_INDEX_PATTERN : 'arkime_sessions3-*'
ARKIME_INDEX_PATTERN_ID : 'arkime_sessions3-*'
ARKIME_INDEX_TIME_FIELD : 'firstPacket'
CREATE_OS_ARKIME_SESSION_INDEX : 'true'
depends_on:
- opensearch
expose:
- 28991
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./.opensearch.primary.curlrc:/var/local/opensearch.primary.curlrc:ro
- ./.opensearch.secondary.curlrc:/var/local/opensearch.secondary.curlrc:ro
healthcheck:
test: ["CMD", "supervisorctl", "status", "cron", "maps"]
interval: 60s
timeout: 15s
retries: 3
start_period: 30s
dashboards:
image: malcolmnetsec/dashboards:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: dashboards
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *opensearch-variables
VIRTUAL_HOST : 'dashboards.malcolm.local'
depends_on:
- opensearch
- dashboards-helper
expose:
- 5601
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./.opensearch.primary.curlrc:/var/local/opensearch.primary.curlrc:ro
healthcheck:
test: ["CMD", "curl", "--silent", "--fail", "http://localhost:5601/dashboards/api/status"]
interval: 30s
timeout: 15s
retries: 3
start_period: 210s
logstash:
image: malcolmnetsec/logstash-oss:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: logstash
networks:
- default
ulimits:
memlock:
soft: -1
hard: -1
cap_add:
- IPC_LOCK
environment:
<< : *process-variables
<< : *ssl-variables
<< : *opensearch-variables
<< : *logstash-variables
<< : *common-beats-variables
<< : *common-lookup-variables
LS_JAVA_OPTS : '-server -Xms2g -Xmx2g -Xss1536k -XX:-HeapDumpOnOutOfMemoryError -Djava.security.egd=file:/dev/./urandom -Dlog4j.formatMsgNoLookups=true'
depends_on:
- opensearch
expose:
- 5044
- 9001
- 9600
ports:
- "127.0.0.1:5044:5044"
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./.opensearch.primary.curlrc:/var/local/opensearch.primary.curlrc:ro
- ./.opensearch.secondary.curlrc:/var/local/opensearch.secondary.curlrc:ro
- ./logstash/maps/malcolm_severity.yaml:/etc/malcolm_severity.yaml:ro
- ./logstash/certs/ca.crt:/certs/ca.crt:ro
- ./logstash/certs/server.crt:/certs/server.crt:ro
- ./logstash/certs/server.key:/certs/server.key:ro
- ./cidr-map.txt:/usr/share/logstash/config/cidr-map.txt:ro
- ./host-map.txt:/usr/share/logstash/config/host-map.txt:ro
- ./net-map.json:/usr/share/logstash/config/net-map.json:ro
healthcheck:
test: ["CMD", "curl", "--silent", "--fail", "http://localhost:9600"]
interval: 30s
timeout: 15s
retries: 3
start_period: 600s
filebeat:
image: malcolmnetsec/filebeat-oss:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: filebeat
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *nginx-variables
<< : *opensearch-variables
<< : *filebeat-variables
<< : *common-upload-variables
<< : *common-beats-variables
FILEBEAT_ZEEK_LOG_PATH : '/zeek/current'
FILEBEAT_ZEEK_LOG_LIVE_PATH : '/zeek/live'
FILEBEAT_SURICATA_LOG_PATH : '/suricata'
FILEBEAT_NGINX_LOG_PATH : '/nginx'
depends_on:
- logstash
expose:
- 5045
ports:
- "127.0.0.1:5045:5045"
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./.opensearch.primary.curlrc:/var/local/opensearch.primary.curlrc:ro
- nginx-log-path:/nginx:ro
- ./zeek-logs:/zeek
- ./suricata-logs:/suricata
- ./filebeat/certs/ca.crt:/certs/ca.crt:ro
- ./filebeat/certs/client.crt:/certs/client.crt:ro
- ./filebeat/certs/client.key:/certs/client.key:ro
healthcheck:
test: ["CMD", "supervisorctl", "status", "filebeat"]
interval: 30s
timeout: 15s
retries: 3
start_period: 60s
arkime:
image: malcolmnetsec/arkime:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: arkime
networks:
- default
env_file:
- ./auth.env
environment:
<< : *process-variables
<< : *ssl-variables
<< : *opensearch-variables
<< : *common-upload-variables
<< : *arkime-variables
VIRTUAL_HOST : 'arkime.malcolm.local'
OPENSEARCH_MAX_SHARDS_PER_NODE : 2500
VIEWER : 'on'
WISE : 'on'
ulimits:
memlock:
soft: -1
hard: -1
depends_on:
- opensearch
expose:
- 8000
- 8005
- 8081
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./.opensearch.primary.curlrc:/var/local/opensearch.primary.curlrc:ro
- ./pcap:/data/pcap
- ./arkime-logs:/opt/arkime/logs
- ./arkime-raw:/opt/arkime/raw
healthcheck:
test: ["CMD", "curl", "--silent", "--fail", "http://localhost:8005/_ns_/nstest.html"]
interval: 90s
timeout: 30s
retries: 3
start_period: 210s
zeek:
image: malcolmnetsec/zeek:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: zeek
networks:
- default
ulimits:
memlock:
soft: -1
hard: -1
cap_add:
- IPC_LOCK
- NET_ADMIN
- NET_RAW
- SYS_ADMIN
environment:
<< : *process-variables
<< : *ssl-variables
<< : *common-upload-variables
<< : *zeek-variables
<< : *zeek-offline-variables
ZEEK_PCAP_PROCESSOR : 'true'
ZEEK_CRON : 'false'
depends_on:
- opensearch
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./pcap:/pcap
- ./zeek-logs/upload:/zeek/upload
- ./zeek-logs/extract_files:/zeek/extract_files
- ./zeek/intel:/opt/zeek/share/zeek/site/intel
healthcheck:
test: ["CMD", "supervisorctl", "status", "pcap-zeek"]
interval: 30s
timeout: 15s
retries: 3
start_period: 60s
zeek-live:
image: malcolmnetsec/zeek:6.3.0
restart: "no"
stdin_open: false
tty: true
network_mode: host
ulimits:
memlock:
soft: -1
hard: -1
cap_add:
- IPC_LOCK
- NET_ADMIN
- NET_RAW
- SYS_ADMIN
environment:
<< : *process-variables
<< : *ssl-variables
<< : *common-upload-variables
<< : *zeek-variables
<< : *zeek-live-variables
<< : *pcap-capture-variables
ZEEK_PCAP_PROCESSOR : 'false'
ZEEK_CRON : 'true'
ZEEK_LOG_PATH : '/zeek/live'
ZEEK_INTEL_PATH : '/opt/zeek/share/zeek/site/intel'
EXTRACT_FILES_PATH : '/zeek/extract_files'
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./zeek-logs/live:/zeek/live
- ./zeek-logs/extract_files:/zeek/extract_files
- ./zeek/intel:/opt/zeek/share/zeek/site/intel
suricata:
image: malcolmnetsec/suricata:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: suricata
networks:
- default
ulimits:
memlock:
soft: -1
hard: -1
cap_add:
- IPC_LOCK
- NET_ADMIN
- NET_RAW
- SYS_ADMIN
environment:
<< : *process-variables
<< : *ssl-variables
<< : *common-upload-variables
<< : *suricata-variables
<< : *suricata-offline-variables
SURICATA_PCAP_PROCESSOR : 'true'
depends_on:
- logstash
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./suricata-logs:/var/log/suricata
- ./pcap:/data/pcap
- ./suricata/rules:/opt/suricata/rules:ro
healthcheck:
test: ["CMD", "supervisorctl", "status", "pcap-suricata"]
interval: 30s
timeout: 15s
retries: 3
start_period: 120s
suricata-live:
image: malcolmnetsec/suricata:6.3.0
restart: "no"
stdin_open: false
tty: true
network_mode: host
ulimits:
memlock:
soft: -1
hard: -1
cap_add:
- IPC_LOCK
- NET_ADMIN
- NET_RAW
- SYS_ADMIN
environment:
<< : *process-variables
<< : *ssl-variables
<< : *common-upload-variables
<< : *suricata-variables
<< : *suricata-live-variables
<< : *pcap-capture-variables
SURICATA_PCAP_PROCESSOR : 'false'
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./suricata-logs:/var/log/suricata
- ./suricata/rules:/opt/suricata/rules:ro
file-monitor:
image: malcolmnetsec/file-monitor:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: file-monitor
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *zeek-variables
VIRTUAL_HOST : 'file-monitor.malcolm.local'
expose:
- 3310
- 8440
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./zeek-logs/extract_files:/zeek/extract_files
- ./zeek-logs/current:/zeek/logs
- ./yara/rules:/yara-rules/custom:ro
healthcheck:
test: ["CMD", "supervisorctl", "status", "watcher", "logger"]
interval: 30s
timeout: 15s
retries: 3
start_period: 60s
pcap-capture:
image: malcolmnetsec/pcap-capture:6.3.0
restart: "no"
stdin_open: false
tty: true
network_mode: host
ulimits:
memlock:
soft: -1
hard: -1
cap_add:
- IPC_LOCK
- NET_ADMIN
- NET_RAW
- SYS_ADMIN
environment:
<< : *process-variables
<< : *ssl-variables
<< : *pcap-capture-variables
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./pcap/upload:/pcap
pcap-monitor:
image: malcolmnetsec/pcap-monitor:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: pcapmon
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *opensearch-variables
<< : *common-upload-variables
depends_on:
- opensearch
expose:
- 30441
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./.opensearch.primary.curlrc:/var/local/opensearch.primary.curlrc:ro
- ./zeek-logs:/zeek
- ./pcap:/pcap
healthcheck:
test: ["CMD", "supervisorctl", "status", "watch-upload", "pcap-publisher"]
interval: 30s
timeout: 15s
retries: 3
start_period: 90s
upload:
image: malcolmnetsec/file-upload:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: upload
networks:
- default
env_file:
- ./auth.env
environment:
<< : *process-variables
<< : *ssl-variables
SITE_NAME : 'Capture File and Log Archive Upload'
VIRTUAL_HOST : 'upload.malcolm.local'
depends_on:
- arkime
expose:
- 80
ports:
- "127.0.0.1:8022:22"
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./pcap/upload:/var/www/upload/server/php/chroot/files
healthcheck:
test: ["CMD", "wget", "-qO-", "http://localhost"]
interval: 30s
timeout: 15s
retries: 3
start_period: 60s
htadmin:
image: malcolmnetsec/htadmin:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: htadmin
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *auth-variables
VIRTUAL_HOST : 'htadmin.malcolm.local'
expose:
- 80
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./htadmin/config.ini:/var/www/htadmin/config/config.ini:rw
- ./htadmin/metadata:/var/www/htadmin/config/metadata:rw
- ./nginx/htpasswd:/var/www/htadmin/config/htpasswd:rw
healthcheck:
test: ["CMD", "curl", "--silent", "--fail", "http://localhost"]
interval: 60s
timeout: 15s
retries: 3
start_period: 60s
freq:
image: malcolmnetsec/freq:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: freq
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *common-lookup-variables
VIRTUAL_HOST : 'freq.malcolm.local'
expose:
- 10004
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
healthcheck:
test: ["CMD", "curl", "--silent", "--fail", "http://localhost:10004"]
interval: 30s
timeout: 15s
retries: 3
start_period: 60s
name-map-ui:
image: malcolmnetsec/name-map-ui:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: name-map-ui
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
VIRTUAL_HOST : 'name-map-ui.malcolm.local'
expose:
- 8080
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./cidr-map.txt:/var/www/html/maps/cidr-map.txt:ro
- ./host-map.txt:/var/www/html/maps/host-map.txt:ro
- ./net-map.json:/var/www/html/maps/net-map.json:rw
healthcheck:
test: ["CMD", "curl", "--silent", "--fail", "http://localhost:8080/fpm-ping"]
interval: 30s
timeout: 15s
retries: 3
start_period: 60s
api:
image: malcolmnetsec/api:6.3.0
command: gunicorn --bind 0:5000 manage:app
restart: "no"
stdin_open: false
tty: true
hostname: api
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *opensearch-variables
VIRTUAL_HOST : 'api.malcolm.local'
expose:
- 5000
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- ./.opensearch.primary.curlrc:/var/local/opensearch.primary.curlrc:ro
healthcheck:
test: ["CMD", "curl", "--silent", "--fail", "http://localhost:5000/ping"]
interval: 30s
timeout: 15s
retries: 3
start_period: 60s
nginx-proxy:
image: malcolmnetsec/nginx-proxy:6.3.0
restart: "no"
stdin_open: false
tty: true
hostname: nginx-proxy
networks:
- default
environment:
<< : *process-variables
<< : *ssl-variables
<< : *auth-variables
<< : *nginx-variables
depends_on:
- api
- arkime
- dashboards
- upload
- htadmin
- name-map-ui
- file-monitor
ports:
- "0.0.0.0:443:443"
- "0.0.0.0:488:488"
- "127.0.0.1:5601:5601"
- "127.0.0.1:9200:9200"
volumes:
- ./nginx/ca-trust:/var/local/ca-trust:ro
- nginx-log-path:/var/log/nginx:rw
- ./nginx/nginx_ldap.conf:/etc/nginx/nginx_ldap.conf:ro
- ./nginx/htpasswd:/etc/nginx/.htpasswd:ro
- ./nginx/certs:/etc/nginx/certs:ro
- ./nginx/certs/dhparam.pem:/etc/nginx/dhparam/dhparam.pem:ro
healthcheck:
test: ["CMD", "curl", "--insecure", "--silent", "https://localhost:443"]
interval: 30s
timeout: 15s
retries: 3
start_period: 120s
labels:
traefik.enable: "false"
# traefik.http.routers.osmalcolm.rule: 'Host(`opensearch.malcolm.example.org`)'
# traefik.http.routers.osmalcolm.entrypoints: 'websecure'
# traefik.http.routers.osmalcolm.tls.certresolver: 'myresolver'
# traefik.http.routers.osmalcolm.service: 'osmalcolm'
# traefik.http.services.osmalcolm.loadbalancer.server.port: '9200'
# traefik.http.routers.malcolm.rule: 'Host(`malcolm.example.org`)'
# traefik.http.routers.malcolm.entrypoints: 'websecure'
# traefik.http.routers.malcolm.tls.certresolver: 'myresolver'
# traefik.http.routers.malcolm.service: 'malcolm'
# traefik.http.services.malcolm.loadbalancer.server.port: '443'
# shared named volume so filebeat can access nginx access logs
volumes:
nginx-log-path:
networks:
default:
external: false