-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathappsentinels-sniffer-2.0.5.tgz
More file actions
707 lines (602 loc) · 40 KB
/
Copy pathappsentinels-sniffer-2.0.5.tgz
File metadata and controls
707 lines (602 loc) · 40 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
appsentinels-sniffer/ 0000775 0001774 0001777 00000000000 15223156020 014206 5 ustar sagar sagar appsentinels-sniffer/README.md 0000644 0001774 0001777 00000022253 15102601066 015470 0 ustar sagar sagar # AppSentinels Sniffer Helm Chart
This Helm chart deploys the AppSentinels Sniffer as a DaemonSet on a Kubernetes cluster.
## Prerequisites
- Kubernetes
- Helm
## Installing the Chart
To install the chart with the release name `appsentinels-sniffer`:
```bash
helm install appsentinels-sniffer ./sniffer-sensor/helm-chart
```
The command deploys the AppSentinels Sniffer DaemonSet on the Kubernetes cluster with default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
## Uninstalling the Chart
To uninstall/delete the `appsentinels-sniffer` deployment:
```bash
helm uninstall appsentinels-sniffer
```
## Parameters
The following table lists the configurable parameters of the AppSentinels Sniffer chart and their default values.
| Parameter | Description | Default |
|--------------------------------|-------------------------------------------------|---------------------------------------|
| `nameOverride` | Override the name of the chart | `""` |
| `fullnameOverride` | Override the full name of the chart | `""` |
| `namespace` | Namespace to deploy the DaemonSet | `appsentinels` |
| `image.repository` | Image repository | `docker.io/appsentinels/ng-controller`|
| `image.tag` | Image tag | `test` |
| `image.pullPolicy` | Image pull policy | `Always` |
| `resources.limits.cpu` | CPU resource limits | `2` |
| `resources.limits.memory` | Memory resource limits | `2Gi` |
| `resources.requests.cpu` | CPU resource requests | `1` |
| `resources.requests.memory` | Memory resource requests | `1Gi` |
| `controller.serverName` | Remote controller server name | `devsaas3.appsentinels.ai` |
| `controller.serverPort` | Remote controller server port | `9006` |
| `environment` | Environment setting | `dev` |
| `sensorInstance` | Sniffer sensor instance name | `dev-cluster-1-sensor` |
| `tapInterface` | Network interface to tap | `all or any or default or interface-name` |
| `tapFilter` | Tap filter expression | `tcp-and-port-8091` |
| `relayProtocol` | Protocol for relay communication | `http` |
| `tapProfile` | Tap profile setting | `low` |
| `nodeSelector` | Node labels for pod assignment | `{}` |
| `tolerations` | Tolerations for pod assignment | See values.yaml |
## TAP Interface
The `tapInterface` parameter can be set to `all` or `any` or `default` or an interface name.
- `all` - Tap all interfaces
- `any` - Tap local and ingress/egress interfaces
- `default` - Tap the default route interface
- `interface-name` - Tap a specific interface by name
## Example: Customizing the Installation
A YAML file that specifies the values for the parameters can be provided while installing the chart:
```bash
helm install appsentinels-sniffer ./sniffer-sensor/helm-chart -f values.yaml
```
Example `values.yaml`:
```yaml
environment: production
controller:
serverName: prod.appsentinels.ai
serverPort: 9006
sensorInstance: prod-cluster-sensor
tapFilter: tcp-and-not-port-443
resources:
limits:
cpu: 2
memory: 4Gi
requests:
cpu: 1
memory: 2Gi
```
## Upgrading the Chart
To upgrade the `appsentinels-sniffer` deployment:
```bash
helm upgrade appsentinels-sniffer ./sniffer-sensor/helm-chart
```
Or with custom values:
```bash
helm upgrade appsentinels-sniffer ./sniffer-sensor/helm-chart -f values.yaml
```
## Configuration Notes
### Node Selection
By default, the DaemonSet will run on all nodes in the cluster. To restrict it to specific nodes, you can use the `nodeSelector` parameter:
```yaml
nodeSelector:
node-role.kubernetes.io/worker: "true"
```
### Privileged Mode
The sniffer sensor runs in privileged mode to access network interfaces. Ensure your cluster security policies allow privileged containers.
### Network Access
The DaemonSet uses `hostNetwork: true` to access the host's network stack directly. This is required for network traffic sniffing.
### Filtering for URI Extension, Hostname and Extension Filtering
=============================================
These environment variables should be set in the container environment for your sniffer sensor
-------------------------------------------------------------------------------
#### skipHostnameRegex
-----------------------------
Purpose:
Skip (exclude) HTTP transactions where the hostname matches this regular expression.
How it works:
- If the regex matches the hostname, the transaction is SKIPPED (not logged)
- If not set or empty, no hostnames are excluded by this filter.
- Please note that this filter shouldnt be used with port numbers
Example values:
skipHostnameRegex="^www\.example\.com$"
# Skips any transaction where the hostname is exactly 'www.example.com'
skipHostnameRegex="(test|dev)\.mydomain\.org$"
# Skips hostnames ending with 'test.mydomain.org' or 'dev.mydomain.org'
-------------------------------------------------------------------------------
#### includeHostnameRegex
-----------------------------------
Purpose:
ONLY process (include) HTTP transactions where the hostname matches this regular expression.
How it works:
- If set, ONLY hostnames matching this regex are processed.
- If the hostname does NOT match, the transaction is skipped.
- If not set or empty, all hostnames are included (unless excluded by skipHostnameRegex).
- Please note that this filter shouldnt be used with port numbers
Example values:
includeHostnameRegex="^api\."
# Only process hostnames starting with 'api.'
includeHostnameRegex="(prod|main)\.mydomain\.org$"
# Only process hostnames ending with 'prod.mydomain.org' or 'main.mydomain.org'
-------------------------------------------------------------------------------
#### uriExtentionFilter
-----------------------
Purpose:
Skip (exclude) HTTP transactions where the URI path ends with one of the specified file extensions.
How it works:
- If set, the value should be a '|' (pipe) separated list of file extensions (e.g., 'svg|png|jpg').
- If the URI path ends with one of these extensions, the transaction is skipped.
- If not set or empty, a default list of common static file extensions is used.
Default Extensions Skipped:
"svg|txt|png|jpg|jpeg|io|tff|woff|woff2|ico|css|pdf|html|mp4|php|ajax|js|gif|tiff|ttf|docx|wasm|aspx"
Example values:
uriExtentionFilter="svg|png|jpg|ico"
# Skips URIs ending with .svg, .png, .jpg, or .ico
uriExtentionFilter="js|css|woff2"
# Skips URIs ending with .js, .css, or .woff2
--------------------------------
#### Order of Evaluation
-------------------
1. If includeHostnameRegex is set, the hostname MUST match this regex to be processed.
2. If skipHostnameRegex is set, the hostname MUST NOT match this regex to be processed.
3. If uriExtentionFilter is set, the URI path MUST NOT end with one of the specified extensions.
4. If both hostname regexes are set, the hostname must match the include regex AND must not match the skip regex.
-------------------------------------------------------------------------------
#### Regex Syntax and Escaping
-------------------------
- Write regexes as you would in C or Python (e.g., ^foo\.bar$, .*\.test\.local$).
- Use a single backslash (\.) for regex metacharacters.
- When writing YAML (Kubernetes, Compose), you may need to double the backslash (\\.) for proper escaping.
-------------------------------------------------------------------------------
#### Examples for Kubernetes
-------------
```yaml
values.yaml:
skipHostnameRegex: "^www\\.example\\.com$"
includeHostnameRegex: "^api\\."
uriExtentionFilter: "svg|png|jpg"
```
-------------------------------------------------------------------------------
Notes:
------
- All regexes are case-insensitive.
- If neither hostname regex is set, all hostnames are processed.
- If both hostname regexes are set, both conditions must be satisfied for a transaction to be processed.
- If uriExtentionFilter is not set, a default list of static file extensions is used.