-
Notifications
You must be signed in to change notification settings - Fork 635
/
Flow.h
1417 lines (1307 loc) · 52.9 KB
/
Flow.h
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
/*
*
* (C) 2013-24 - ntop.org
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
#ifndef _FLOW_H_
#define _FLOW_H_
#include "ntop_includes.h"
typedef struct {
u_int32_t pktFrag;
} IPPacketStats;
typedef struct {
u_int64_t last, next;
} TCPSeqNum;
class FlowAlert;
class FlowCheck;
class Flow : public GenericHashEntry {
private:
int32_t iface_index; /* Interface index on which this flow has been first observed */
Host *cli_host, *srv_host;
IpAddress *cli_ip_addr, *srv_ip_addr;
ICMPinfo *icmp_info;
ndpi_confidence_t ndpi_confidence;
u_int32_t privateFlowId /* Used to store specific flow info such as DNS
TransactionId */
;
u_int8_t cli2srv_tos, srv2cli_tos; /* RFC 2474, 3168 */
u_int16_t cli_port, srv_port;
u_int16_t vlanId;
u_int32_t vrfId;
u_int32_t srcAS, dstAS, prevAdjacentAS, nextAdjacentAS;
u_int32_t protocolErrorCode;
u_int8_t protocol, src2dst_tcp_flags, dst2src_tcp_flags, flow_verdict;
u_int16_t flow_score;
u_int8_t view_cli_mac[6], view_srv_mac[6];
struct ndpi_flow_struct *ndpiFlow;
ndpi_risk ndpi_flow_risk_bitmap;
/* The bitmap of all possible flow alerts set by FlowCheck subclasses.
When no alert is set, the flow is in flow_alert_normal.
A flow can have multiple alerts but at most ONE of its alerts is
predominant of a flow, which is written into `predominant_alert`.
*/
Bitmap128 alerts_map;
std::unordered_map<FlowAlertTypeEnum,u_int16_t /* score */> alert_score;
FlowAlertType predominant_alert; /* This is the predominant alert */
u_int16_t predominant_alert_score; /* The score associated to the predominant alert */
FlowSource flow_source;
struct {
u_int8_t is_cli_attacker : 1, is_cli_victim : 1, is_srv_attacker : 1,
is_srv_victim : 1, auto_acknowledge : 1;
} predominant_alert_info;
char *json_protocol_info, *riskInfo, *end_reason;
/* Calculate the entropy on the first MAX_ENTROPY_BYTES bytes */
struct {
struct ndpi_analyze_struct *c2s, *s2c;
} initial_bytes_entropy;
u_int32_t hash_entry_id; /* Uniquely identify this Flow inside the flows_hash
hash table */
u_int16_t detection_completed : 1, extra_dissection_completed : 1,
twh_over : 1, twh_ok : 1, dissect_next_http_packet : 1, passVerdict : 1,
flow_dropped_counts_increased : 1, quota_exceeded : 1, swap_done : 1,
swap_requested : 1, has_malicious_cli_signature : 1,
has_malicious_srv_signature : 1, src2dst_tcp_zero_window : 1,
dst2src_tcp_zero_window : 1, non_zero_payload_observed : 1,
is_periodic_flow : 1;
ndpi_multimedia_flow_type rtp_stream_type;
#ifdef ALERTED_FLOWS_DEBUG
bool iface_alert_inc, iface_alert_dec;
#endif
#ifdef NTOPNG_PRO
bool ingress2egress_direction;
bool lateral_movement;
PeriodicityStatus periodicity_status;
#ifndef HAVE_NEDGE
FlowProfile *trafficProfile;
#else
u_int8_t routing_table_id;
u_int16_t cli2srv_in, cli2srv_out, srv2cli_in, srv2cli_out;
L7PolicySource_t cli_quota_source, srv_quota_source;
#endif
CounterTrend throughputTrend, goodputTrend, thptRatioTrend;
#endif
char *ndpiAddressFamilyProtocol;
ndpi_protocol ndpiDetectedProtocol;
char *ndpiFlowRiskName;
custom_app_t custom_app;
struct {
bool alertTriggered;
u_int8_t score;
char *msg;
} customFlowAlert;
json_object *json_info;
ndpi_serializer *tlv_info;
ndpi_confidence_t confidence;
char *host_server_name, *bt_hash, *stun_mapped_address;
IEC104Stats *iec104;
#ifdef NTOPNG_PRO
ModbusStats *modbus;
#endif
char *suspicious_dga_domain; /* Stores the suspicious DGA domain for flows
with NDPI_SUSPICIOUS_DGA_DOMAIN */
OSType operating_system;
#ifdef HAVE_NEDGE
u_int32_t last_conntrack_update;
u_int32_t marker;
#endif
struct {
char *source;
json_object *json;
} external_alert;
bool trigger_immediate_periodic_update; /* needed to process external alerts */
time_t next_call_periodic_update; /* The time at which the periodic lua script
on this flow shall be called */
/* Flow payload */
u_int16_t flow_payload_len;
char *flow_payload;
union {
struct {
char *last_url, *last_user_agent, *last_server;
ndpi_http_method last_method;
u_int16_t last_return_code;
} http;
struct {
char *last_query;
char *last_query_shadow;
time_t
last_query_update_time; /* The time when the last query was updated */
u_int16_t last_query_type;
u_int16_t last_return_code;
} dns;
struct {
char *name, *name_txt, *ssid;
char *answer;
} mdns;
struct {
char *location;
} ssdp;
struct {
char *name;
} netbios;
struct {
char *name;
} dhcp;
struct {
char *client_signature, *server_signature;
struct {
/* https://engineering.salesforce.com/open-sourcing-hassh-abed3ae5044c
*/
char *client_hash, *server_hash;
} hassh;
} ssh;
struct {
u_int16_t tls_version;
u_int32_t notBefore, notAfter;
char *client_alpn, *client_tls_supported_versions, *issuerDN, *subjectDN;
char *client_requested_server_name, *server_names;
/* Certificate dissection */
struct {
/* https://engineering.salesforce.com/tls-fingerprinting-with-ja3-and-ja3s-247362855967
*/
char *client_hash, *server_hash;
u_int16_t server_cipher;
ndpi_cipher_weakness server_unsafe_cipher;
} ja3;
struct {
char *client_hash;
} ja4;
} tls;
struct {
struct {
u_int8_t icmp_type, icmp_code;
} cli2srv, srv2cli;
u_int16_t max_icmp_payload_size;
struct {
float min_entropy, max_entropy;
} client_to_server;
} icmp;
struct {
char * currency;
} mining;
struct {
char * mail_from;
char * rcpt_to;
} smtp;
} protos;
struct {
u_int32_t device_ip;
u_int32_t in_index, out_index;
u_int16_t observation_point_id;
} flow_device;
/* eBPF Information */
ParsedeBPF *ebpf;
/* Stats */
FlowTrafficStats stats;
/* IP stats */
IPPacketStats ip_stats_s2d, ip_stats_d2s;
/* TCP stats */
TCPSeqNum tcp_seq_s2d, tcp_seq_d2s;
u_int16_t cli2srv_window, srv2cli_window;
struct timeval synTime, synAckTime,
ackTime; /* network Latency (3-way handshake) */
struct timeval clientNwLatency; /* The RTT/2 between the client and nprobe */
struct timeval serverNwLatency; /* The RTT/2 between nprobe and the server */
struct timeval c2sFirstGoodputTime;
float rttSec, applLatencyMsec;
InterarrivalStats *cli2srvPktTime, *srv2cliPktTime;
/* Counter values at last host update */
struct {
PartializableFlowTrafficStats *partial;
PartializableFlowTrafficStats delta;
time_t first_seen, last_seen;
bool in_progress; /* Set to true when the flow is enqueued to be dumped */
} last_db_dump;
/* Lazily initialized and used by a possible view interface */
ViewInterfaceFlowStats *viewFlowStats;
/* Partial used to periodically update stats out of flows */
PartializableFlowTrafficStats *periodic_stats_update_partial;
#ifdef HAVE_NEDGE
struct {
struct {
TrafficShaper *ingress, *egress;
} cli2srv;
struct {
TrafficShaper *ingress, *egress;
} srv2cli;
} flowShaperIds;
#endif
struct timeval last_update_time;
float top_bytes_thpt, top_goodput_bytes_thpt, top_pkts_thpt;
float bytes_thpt_cli2srv, goodput_bytes_thpt_cli2srv;
float bytes_thpt_srv2cli, goodput_bytes_thpt_srv2cli;
float pkts_thpt_cli2srv, pkts_thpt_srv2cli;
ValueTrend bytes_thpt_trend, goodput_bytes_thpt_trend, pkts_thpt_trend;
MinorConnectionStates current_c_state;
u_int counter = 0;
/*
IMPORTANT NOTE
if you add a new 'directional' field such as cliX and serverX
you need to handle it in the Flow::swap() method
*/
void deferredInitialization();
char *intoaV4(unsigned int addr, char *buf, u_short bufLen);
void allocDPIMemory();
bool checkTor(char *hostname);
void setBittorrentHash(char *hash);
void updateThroughputStats(float tdiff_msec, u_int32_t diff_sent_packets,
u_int64_t diff_sent_bytes,
u_int64_t diff_sent_goodput_bytes,
u_int32_t diff_rcvd_packets,
u_int64_t diff_rcvd_bytes,
u_int64_t diff_rcvd_goodput_bytes);
static void updatePacketStats(InterarrivalStats *stats,
const struct timeval *when, bool update_iat);
char *printTCPState(char *const buf, u_int buf_len) const;
void update_pools_stats(NetworkInterface *iface, Host *cli_host,
Host *srv_host, const struct timeval *tv,
u_int64_t diff_sent_packets,
u_int64_t diff_sent_bytes,
u_int64_t diff_rcvd_packets,
u_int64_t diff_rcvd_bytes) const;
/*
Check (and possibly enqueues) the flow for dump
*/
void dumpCheck(time_t t, bool last_dump_before_free);
void updateCliJA3();
void updateCliJA4();
void updateSrvJA3();
void updateHASSH(bool as_client);
void processExtraDissectedInformation();
void processDetectedProtocol(
u_int8_t *payload, u_int16_t payload_len); /* nDPI detected protocol */
void processDetectedProtocolData(); /* nDPI detected protocol data (e.g.,
ndpiFlow->host_server_name) */
void setExtraDissectionCompleted();
void setProtocolDetectionCompleted(u_int8_t *payload, u_int16_t payload_len);
void updateProtocol(ndpi_protocol proto_id);
const char *cipher_weakness2str(ndpi_cipher_weakness w) const;
bool get_partial_traffic_stats(PartializableFlowTrafficStats **dst,
PartializableFlowTrafficStats *delta,
bool *first_partial) const;
void lua_tos(lua_State *vm);
void lua_confidence(lua_State *vm);
void updateEntropy(struct ndpi_analyze_struct *e, u_int8_t *payload,
u_int payload_len);
void lua_entropy(lua_State *vm);
void luaScore(lua_State *vm);
void luaIEC104(lua_State *vm);
void callFlowUpdate(time_t t);
/*
Method to trigger alerts, synchronous or asynchronous, depending on the last
argument.
- Asynchronous: The alerts bitmap is updated and the predominant alert is
possibly updated. Recipients enqueue is not performed.
- Synchronous: The alerts bitmap is updated and the predominant alert is
possibly updated. Immediate alert JSON generation and enqueue to the
recipients are performed as well.
*/
bool setAlertsBitmap(FlowAlertType alert_type, u_int16_t cli_inc,
u_int16_t srv_inc, bool async);
void setNormalToAlertedCounters();
/* Decreases scores on both client and server hosts when the flow is being
* destructed */
void decAllFlowScores();
void updateServerPortsStats(Host *server_host, ndpi_protocol *proto);
void updateClientContactedPorts(Host *client, ndpi_protocol *proto);
void updateTCPHostServices(Host *cli_h, Host *srv_h);
void updateUDPHostServices();
public:
Flow(NetworkInterface *_iface, int32_t iface_idx,
u_int16_t _vlanId,
u_int16_t _observation_point_id, u_int32_t _private_flow_id,
u_int8_t _protocol, Mac *_cli_mac, IpAddress *_cli_ip,
u_int16_t _cli_port, Mac *_srv_mac, IpAddress *_srv_ip,
u_int16_t _srv_port, const ICMPinfo *const icmp_info, time_t _first_seen,
time_t _last_seen, u_int8_t *_view_cli_mac, u_int8_t *_view_srv_mac);
~Flow();
inline Bitmap128 getAlertsBitmap() const { return (alerts_map); }
/* Enqueues an alert to all available flow recipients. */
bool enqueueAlertToRecipients(FlowAlert *alert);
/*
Called by FlowCheck subclasses to trigger a flow alert. This is an
asynchronous call, faster, but can cause the alert JSON to be generated
after the call. The FlowCheck should implement the buildAlert() method which
is called in the predominant check to actually build the FlowAlert object.
*/
bool triggerAlertAsync(FlowAlertType alert_type, u_int16_t cli_score_inc,
u_int16_t srv_score_inc);
/*
Called by FlowCheck subclasses to trigger a flow alert. This is a
syncrhonous call, more expensive, but causes the alert (FlowAlert) to be
immediately enqueued to all recipients.
*/
bool triggerAlertSync(FlowAlert *alert, u_int16_t cli_score_inc,
u_int16_t srv_score_inc);
/*
Enqueues the predominant alert of the flow to all available flow recipients.
*/
void enqueuePredominantAlert();
inline void setFlowVerdict(u_int8_t _flow_verdict) {
flow_verdict = _flow_verdict;
};
inline void setPredominantAlert(FlowAlertType alert_type, u_int16_t score);
inline FlowAlertType getPredominantAlert() const {
return predominant_alert;
};
inline u_int16_t getPredominantAlertScore() const {
return predominant_alert_score;
};
inline AlertLevel getPredominantAlertSeverity() const {
return Utils::mapScoreToSeverity(predominant_alert_score);
};
inline bool isFlowAlerted() const {
return (predominant_alert.id != flow_alert_normal);
};
void setPredominantAlertInfo(FlowAlert *alert);
inline bool isPredominantAlertAutoAck() {
return !!predominant_alert_info.auto_acknowledge;
};
inline u_int8_t isClientAttacker() {
return predominant_alert_info.is_cli_attacker;
};
inline u_int8_t isClientVictim() {
return predominant_alert_info.is_cli_victim;
};
inline u_int8_t isServerAttacker() {
return predominant_alert_info.is_srv_attacker;
};
inline u_int8_t isServerVictim() {
return predominant_alert_info.is_srv_victim;
};
inline char *getProtocolInfo() { return json_protocol_info; };
void setProtocolJSONInfo();
void getProtocolJSONInfo(ndpi_serializer *serializer);
inline char *getJa3CliHash() { return (protos.tls.ja3.client_hash); }
inline char *getJa4CliHash() { return (protos.tls.ja4.client_hash); }
bool isBlacklistedFlow() const;
bool isBlacklistedClient() const;
bool isBlacklistedServer() const;
struct site_categories *getFlowCategory(bool force_categorization);
void freeDPIMemory();
static const ndpi_protocol ndpiUnknownProtocol;
bool isTiny() const;
inline bool isProto(u_int16_t p) const {
return (((ndpiDetectedProtocol.master_protocol == p) ||
(ndpiDetectedProtocol.app_protocol == p))
? true
: false);
}
bool isTLS() const;
inline bool isEncryptedProto() const {
return (ndpi_is_encrypted_proto(iface->get_ndpi_struct(),
ndpiDetectedProtocol));
}
inline bool isSSH() const { return (isProto(NDPI_PROTOCOL_SSH)); }
inline bool isMining() const { return (isProto(NDPI_PROTOCOL_MINING));}
inline bool isDNS() const { return (isProto(NDPI_PROTOCOL_DNS)); }
inline bool isZoomRTP() const {
return (isProto(NDPI_PROTOCOL_ZOOM) && (isProto(NDPI_PROTOCOL_RTP) || isProto(NDPI_PROTOCOL_SRTP)) );
}
inline bool isIEC60870() const { return (isProto(NDPI_PROTOCOL_IEC60870)); }
inline bool isModbus() const { return (isProto(NDPI_PROTOCOL_MODBUS)); }
inline bool isMDNS() const { return (isProto(NDPI_PROTOCOL_MDNS)); }
inline bool isSSDP() const { return (isProto(NDPI_PROTOCOL_SSDP)); }
inline bool isNetBIOS() const { return (isProto(NDPI_PROTOCOL_NETBIOS)); }
inline bool isDHCP() const { return (isProto(NDPI_PROTOCOL_DHCP)); }
inline bool isNTP() const { return (isProto(NDPI_PROTOCOL_NTP)); }
inline bool isSMTPorSMTPS() const {
return (isSMTP() || isSMTPS());
}
inline bool isSMTP() const {
return (isProto(NDPI_PROTOCOL_MAIL_SMTP));
}
inline bool isSMTPS() const {
return (isProto(NDPI_PROTOCOL_MAIL_SMTPS));
}
inline bool isHTTP() const { return (isProto(NDPI_PROTOCOL_HTTP)); }
inline bool isHTTP_PROXY() const { return (isProto(NDPI_PROTOCOL_HTTP_PROXY)); }
inline bool isICMP() const {
return (isProto(NDPI_PROTOCOL_IP_ICMP) || isProto(NDPI_PROTOCOL_IP_ICMPV6));
}
inline bool isBittorrent() const {
return (isProto(NDPI_PROTOCOL_BITTORRENT));
}
#if defined(NTOPNG_PRO)
inline bool isLateralMovement() const { return (lateral_movement); }
inline void setLateralMovement(bool change) { lateral_movement = change; }
PeriodicityStatus getPeriodicity() const { return (periodicity_status); }
inline void setPeriodicity(PeriodicityStatus _periodicity_status) {
periodicity_status = _periodicity_status;
}
#endif
inline bool isCliDeviceAllowedProtocol() const {
return !cli_host ||
cli_host->getDeviceAllowedProtocolStatus(
get_detected_protocol(), true) == device_proto_allowed;
}
inline bool isSrvDeviceAllowedProtocol() const {
return !srv_host ||
get_bytes_srv2cli() ==
0 /* Server must respond to be considered NOT allowed */
|| srv_host->getDeviceAllowedProtocolStatus(
get_detected_protocol(), false) == device_proto_allowed;
}
inline bool isDeviceAllowedProtocol() const {
return isCliDeviceAllowedProtocol() && isSrvDeviceAllowedProtocol();
}
inline u_int16_t getCliDeviceDisallowedProtocol() const {
DeviceProtoStatus cli_ps =
cli_host->getDeviceAllowedProtocolStatus(get_detected_protocol(), true);
return (cli_ps == device_proto_forbidden_app)
? ndpiDetectedProtocol.app_protocol
: ndpiDetectedProtocol.master_protocol;
}
inline u_int16_t getSrvDeviceDisallowedProtocol() const {
DeviceProtoStatus srv_ps = srv_host->getDeviceAllowedProtocolStatus(
get_detected_protocol(), false);
return (srv_ps == device_proto_forbidden_app)
? ndpiDetectedProtocol.app_protocol
: ndpiDetectedProtocol.master_protocol;
}
inline bool isMaskedFlow() const {
return (Utils::maskHost(get_cli_ip_addr()->isLocalHost()) ||
Utils::maskHost(get_srv_ip_addr()->isLocalHost()));
};
inline const char *getServerCipherClass() const {
return (isTLS() ? cipher_weakness2str(protos.tls.ja3.server_unsafe_cipher)
: NULL);
}
char *serialize(bool use_labels = false);
/* Prepares an alert JSON and puts int in the resulting `serializer`. */
void alert2JSON(FlowAlert *alert, ndpi_serializer *serializer);
json_object *flow2JSON();
json_object *flow2es(json_object *flow_object);
void formatECSInterface(json_object *my_object);
void formatECSNetwork(json_object *my_object, const IpAddress *addr);
void formatECSHost(json_object *my_object, bool is_client,
const IpAddress *addr, Host *host);
void formatECSEvent(json_object *my_object);
void formatECSFlow(json_object *my_object);
void formatSyslogFlow(json_object *my_object);
void formatGenericFlow(json_object *my_object);
void formatECSExtraInfo(json_object *my_object);
void formatECSAppProto(json_object *my_object);
void formatECSObserver(json_object *my_object);
inline u_int16_t getLowerProtocol() {
return (ndpi_get_lower_proto(ndpiDetectedProtocol));
}
inline void updateJA3C(char *j) {
if (j && (j[0] != '\0') && (protos.tls.ja3.client_hash == NULL))
protos.tls.ja3.client_hash = strdup(j);
updateCliJA3();
}
inline void updateJA3S(char *j) {
if (j && (j[0] != '\0') && (protos.tls.ja3.server_hash == NULL))
protos.tls.ja3.server_hash = strdup(j);
updateSrvJA3();
}
inline void updateJA4C(char *j) {
if (j && (j[0] != '\0') && (protos.tls.ja4.client_hash == NULL))
protos.tls.ja4.client_hash = strdup(j);
updateCliJA4();
}
inline u_int8_t getTcpFlags() const {
return (src2dst_tcp_flags | dst2src_tcp_flags);
};
inline u_int8_t getTcpFlagsCli2Srv() const { return (src2dst_tcp_flags); };
inline u_int8_t getTcpFlagsSrv2Cli() const { return (dst2src_tcp_flags); };
#ifdef HAVE_NEDGE
bool checkPassVerdict(const struct tm *now);
bool isPassVerdict() const;
inline void setConntrackMarker(u_int32_t marker) { this->marker = marker; }
inline u_int32_t getConntrackMarker() { return (marker); }
void incFlowDroppedCounters();
#endif
void setDropVerdict();
u_int32_t getPid(bool client);
u_int32_t getFatherPid(bool client);
u_int32_t get_uid(bool client) const;
char *get_proc_name(bool client);
char *get_user_name(bool client);
u_int32_t getNextTcpSeq(u_int8_t tcpFlags, u_int32_t tcpSeqNum,
u_int32_t payloadLen);
static double toMs(const struct timeval *t);
void timeval_diff(struct timeval *begin, const struct timeval *end,
struct timeval *result, u_short divide_by_two);
std::string getFlowInfo(bool isLuaRequest);
inline char *getFlowServerInfo() {
return (isTLS() && protos.tls.client_requested_server_name)
? protos.tls.client_requested_server_name
: host_server_name;
}
inline char *getBitTorrentHash() { return (bt_hash); };
inline void setBTHash(char *h) {
if (!h) return;
if (bt_hash) free(bt_hash);
bt_hash = h;
}
inline void setServerName(char *v) {
if (host_server_name) free(host_server_name);
host_server_name = v;
}
void updateICMPFlood(const struct bpf_timeval *when, bool src2dst_direction);
void updateDNSFlood(const struct bpf_timeval *when, bool src2dst_direction);
void updateSNMPFlood(const struct bpf_timeval *when, bool src2dst_direction);
void updateTcpFlags(const struct bpf_timeval *when, u_int8_t flags,
bool src2dst_direction);
void updateTcpWindow(u_int16_t window, bool src2dst_direction);
void updateTcpSeqIssues(const ParsedFlow *pf);
void updateTLS(ParsedFlow *zflow);
void updateDNS(ParsedFlow *zflow);
void updateHTTP(ParsedFlow *zflow);
void updateSuspiciousDGADomain();
static void incTcpBadStats(bool src2dst_direction, Host *cli, Host *srv,
NetworkInterface *iface, u_int32_t ooo_pkts,
u_int32_t retr_pkts, u_int32_t lost_pkts,
u_int32_t keep_alive_pkts);
void updateTcpSeqNum(const struct bpf_timeval *when, u_int32_t seq_num,
u_int32_t ack_seq_num, u_int16_t window, u_int8_t flags,
u_int16_t payload_len, bool src2dst_direction);
void updateSeqNum(time_t when, u_int32_t sN, u_int32_t aN);
void setDetectedProtocol(ndpi_protocol proto_id);
void processPacket(const struct pcap_pkthdr *h, const u_char *ip_packet,
u_int16_t ip_len, u_int64_t packet_time, u_int8_t *payload,
u_int16_t payload_len, u_int16_t src_port);
void processDNSPacket(const u_char *ip_packet, u_int16_t ip_len,
u_int64_t packet_time);
void processIEC60870Packet(bool tx_direction, const u_char *payload,
u_int16_t payload_len,
const struct pcap_pkthdr *h);
#ifdef NTOPNG_PRO
void processModbusPacket(bool is_query, const u_char *payload,
u_int16_t payload_len,
const struct pcap_pkthdr *h);
#endif
void endProtocolDissection();
inline void setCustomApp(custom_app_t ca) {
memcpy(&custom_app, &ca, sizeof(custom_app));
};
inline custom_app_t getCustomApp() const { return custom_app; };
u_int16_t getStatsProtocol() const;
void setJSONInfo(json_object *json);
void setTLVInfo(ndpi_serializer *tlv);
void incStats(bool cli2srv_direction, u_int pkt_len, u_int8_t *payload,
u_int payload_len, u_int8_t l4_proto, u_int8_t is_fragment,
u_int16_t tcp_flags, const struct timeval *when,
u_int16_t fragment_extra_overhead);
void addFlowStats(bool new_flow, bool cli2srv_direction, u_int in_pkts,
u_int in_bytes, u_int in_goodput_bytes, u_int out_pkts,
u_int out_bytes, u_int out_goodput_bytes,
u_int in_fragments, u_int out_fragments, time_t first_seen,
time_t last_seen);
void check_swap();
inline bool isThreeWayHandshakeOK() const { return (twh_ok ? true : false); };
inline bool isDetectionCompleted() const {
return (detection_completed ? true : false);
};
inline bool isOneWay() const {
return (get_packets() &&
(!get_packets_cli2srv() || !get_packets_srv2cli()));
};
inline bool isBidirectional() const {
return (get_packets_cli2srv() && get_packets_srv2cli());
};
inline bool isRemoteToRemote() const {
return (cli_host && srv_host && !cli_host->isLocalHost() &&
!srv_host->isLocalHost());
};
inline bool isLocalToRemote() const {
return get_cli_ip_addr()->isLocalHost() &&
!get_srv_ip_addr()->isLocalHost();
};
inline bool isRemoteToLocal() const {
return !get_cli_ip_addr()->isLocalHost() &&
get_srv_ip_addr()->isLocalHost();
};
inline bool isLocalToLocal() const {
return get_cli_ip_addr()->isLocalHost() && get_srv_ip_addr()->isLocalHost();
};
inline bool isUnicast() const {
return (cli_ip_addr && srv_ip_addr &&
!cli_ip_addr->isBroadMulticastAddress() &&
!srv_ip_addr->isBroadMulticastAddress());
};
inline u_int32_t get_cli_ipv4() const {
return (cli_host->get_ip()->get_ipv4());
};
inline u_int32_t get_srv_ipv4() const {
return (srv_host->get_ip()->get_ipv4());
};
inline ndpi_protocol get_detected_protocol() const {
return (isDetectionCompleted() ? ndpiDetectedProtocol
: ndpiUnknownProtocol);
};
inline struct ndpi_flow_struct *get_ndpi_flow() const { return (ndpiFlow); };
inline const struct ndpi_in6_addr *get_cli_ipv6() const {
return (cli_host->get_ip()->get_ipv6());
};
inline const struct ndpi_in6_addr *get_srv_ipv6() const {
return (srv_host->get_ip()->get_ipv6());
};
inline u_int16_t get_cli_port() const { return (ntohs(cli_port)); };
inline u_int16_t get_srv_port() const { return (ntohs(srv_port)); };
inline u_int16_t get_vlan_id() const { return (vlanId); };
inline u_int8_t get_protocol() const { return (protocol); };
inline u_int64_t get_bytes() const {
return (stats.get_cli2srv_bytes() + stats.get_srv2cli_bytes());
};
inline u_int64_t get_bytes_cli2srv() const {
return (stats.get_cli2srv_bytes());
};
inline u_int64_t get_bytes_srv2cli() const {
return (stats.get_srv2cli_bytes());
};
inline u_int64_t get_goodput_bytes() const {
return (stats.get_cli2srv_goodput_bytes() +
stats.get_srv2cli_goodput_bytes());
};
inline u_int64_t get_goodput_bytes_cli2srv() const {
return (stats.get_cli2srv_goodput_bytes());
};
inline u_int64_t get_goodput_bytes_srv2cli() const {
return (stats.get_srv2cli_goodput_bytes());
};
inline u_int64_t get_packets() const {
return (stats.get_cli2srv_packets() + stats.get_srv2cli_packets());
};
inline u_int32_t get_packets_cli2srv() const {
return (stats.get_cli2srv_packets());
};
inline u_int32_t get_packets_srv2cli() const {
return (stats.get_srv2cli_packets());
};
inline u_int64_t get_partial_bytes() const {
return get_partial_bytes_cli2srv() + get_partial_bytes_srv2cli();
};
inline u_int64_t get_partial_packets() const {
return get_partial_packets_cli2srv() + get_partial_packets_srv2cli();
};
inline u_int64_t get_partial_goodput_bytes() const {
return last_db_dump.delta.get_cli2srv_goodput_bytes() +
last_db_dump.delta.get_srv2cli_goodput_bytes();
};
inline u_int64_t get_partial_bytes_cli2srv() const {
return last_db_dump.delta.get_cli2srv_bytes();
};
inline u_int64_t get_partial_bytes_srv2cli() const {
return last_db_dump.delta.get_srv2cli_bytes();
};
inline u_int64_t get_partial_packets_cli2srv() const {
return last_db_dump.delta.get_cli2srv_packets();
};
inline u_int64_t get_partial_packets_srv2cli() const {
return last_db_dump.delta.get_srv2cli_packets();
};
inline void set_dump_in_progress() { last_db_dump.in_progress = true; };
inline void set_dump_done() { last_db_dump.in_progress = false; };
bool needsExtraDissection();
bool hasDissectedTooManyPackets();
bool get_partial_traffic_stats_view(PartializableFlowTrafficStats *delta,
bool *first_partial);
bool update_partial_traffic_stats_db_dump();
inline float get_pkts_thpt() const {
return (pkts_thpt_cli2srv + pkts_thpt_srv2cli);
};
inline float get_bytes_thpt() const {
return (bytes_thpt_cli2srv + bytes_thpt_srv2cli);
};
inline float get_goodput_bytes_thpt() const {
return (goodput_bytes_thpt_cli2srv + goodput_bytes_thpt_srv2cli);
};
inline float get_goodput_ratio() const {
return ((float)(100 * get_goodput_bytes()) / ((float)get_bytes() + 1));
};
inline time_t get_partial_first_seen() const {
return (last_db_dump.first_seen);
};
inline time_t get_partial_last_seen() const {
return (last_db_dump.last_seen);
};
inline char *get_protocol_name() const {
return (Utils::l4proto2name(protocol));
};
inline Host *get_cli_host() const { return (cli_host); };
inline Host *get_srv_host() const { return (srv_host); };
inline IpAddress *get_cli_ip_addr() const { return (cli_ip_addr); };
inline IpAddress *get_srv_ip_addr() const { return (srv_ip_addr); };
inline IpAddress *get_dns_srv_ip_addr() const {
return ((get_cli_port() == 53) ? get_cli_ip_addr() : get_srv_ip_addr());
};
inline IpAddress *get_dhcp_srv_ip_addr() const {
return ((get_cli_port() == 67) ? get_cli_ip_addr() : get_srv_ip_addr());
};
inline json_object *get_json_info() const { return (json_info); };
inline ndpi_serializer *get_tlv_info() const { return (tlv_info); };
inline void setICMPPayloadSize(u_int16_t size) {
if (isICMP())
protos.icmp.max_icmp_payload_size =
max(protos.icmp.max_icmp_payload_size, size);
};
inline u_int16_t getICMPPayloadSize() const {
return (isICMP() ? protos.icmp.max_icmp_payload_size : 0);
};
inline ICMPinfo *getICMPInfo() const { return (isICMP() ? icmp_info : NULL); }
inline ndpi_protocol_breed_t get_protocol_breed() const {
return (ndpi_get_proto_breed(
iface->get_ndpi_struct(),
isDetectionCompleted() ? ndpi_get_upper_proto(ndpiDetectedProtocol)
: NDPI_PROTOCOL_UNKNOWN));
};
inline const char *get_protocol_breed_name() const {
return (ndpi_get_proto_breed_name(get_protocol_breed()));
};
inline ndpi_protocol_category_t get_protocol_category() const {
return (ndpi_get_proto_category(
iface->get_ndpi_struct(),
isDetectionCompleted() ? ndpiDetectedProtocol : ndpiUnknownProtocol));
};
inline const char *get_protocol_category_name() const {
return (ndpi_category_get_name(iface->get_ndpi_struct(),
get_protocol_category()));
};
char *get_detected_protocol_name(char *buf, u_int buf_len) const {
return (iface->get_ndpi_full_proto_name(
isDetectionCompleted() ? ndpiDetectedProtocol : ndpiUnknownProtocol,
buf, buf_len));
}
static inline ndpi_protocol get_ndpi_unknown_protocol() {
return ndpiUnknownProtocol;
};
/* NOTE: the caller must ensure that the hosts returned by these methods are
* not used concurrently by subinterfaces since hosts are shared between all
* the subinterfaces of the same ViewInterface. */
inline Host *getViewSharedClient() {
return (viewFlowStats ? viewFlowStats->getViewSharedClient()
: get_cli_host());
};
inline Host *getViewSharedServer() {
return (viewFlowStats ? viewFlowStats->getViewSharedServer()
: get_srv_host());
};
u_int32_t get_packetsLost();
u_int32_t get_packetsRetr();
u_int32_t get_packetsOOO();
inline const struct timeval *get_current_update_time() const {
return &last_update_time;
};
u_int64_t get_current_bytes_cli2srv() const;
u_int64_t get_current_bytes_srv2cli() const;
u_int64_t get_current_goodput_bytes_cli2srv() const;
u_int64_t get_current_goodput_bytes_srv2cli() const;
u_int64_t get_current_packets_cli2srv() const;
u_int64_t get_current_packets_srv2cli() const;
inline bool is_swap_requested() const {
return (swap_requested ? true : false);
};
inline bool is_swap_done() const { return (swap_done ? true : false); };
inline void set_swap_done() { swap_done = 1; };
/*
Returns actual client and server, that is the client and server as
determined after the swap heuristic that has taken place.
*/
inline void get_actual_peers(Host **actual_client,
Host **actual_server) const {
if (is_swap_requested())
*actual_client = get_srv_host(), *actual_server = get_cli_host();
else
*actual_client = get_cli_host(), *actual_server = get_srv_host();
};
bool is_hash_entry_state_idle_transition_ready();
void hosts_periodic_stats_update(NetworkInterface *iface, Host *cli_host,
Host *srv_host,
PartializableFlowTrafficStats *partial,
bool first_partial,
const struct timeval *tv);
void periodic_stats_update(const struct timeval *tv);
void set_hash_entry_id(u_int32_t assigned_hash_entry_id);
u_int32_t get_hash_entry_id() const;
static char *printTCPflags(u_int8_t flags, char *const buf, u_int buf_len);
char *print(char *buf, u_int buf_len, bool full_report = true) const;
u_int32_t key();
static u_int32_t key(Host *cli, u_int16_t cli_port, Host *srv,
u_int16_t srv_port, u_int16_t vlan_id,
u_int16_t _observation_point_id, u_int16_t protocol);
void lua(lua_State *vm, AddressTree *ptree, DetailsLevel details_level,
bool asListElement);
void lua_get_min_info(lua_State *vm);
void lua_duration_info(lua_State *vm);
void lua_snmp_info(lua_State *vm);
void lua_device_protocol_allowed_info(lua_State *vm);
void lua_get_flow_connection_state(lua_State *vm);
void lua_get_tcp_stats(lua_State *vm) const;
void lua_get_unicast_info(lua_State *vm) const;
void lua_get_status(lua_State *vm) const;
void lua_get_protocols(lua_State *vm) const;
void lua_get_bytes(lua_State *vm) const;
void lua_get_dir_traffic(lua_State *vm, bool cli2srv) const;
void lua_get_dir_iat(lua_State *vm, bool cli2srv) const;
void lua_get_packets(lua_State *vm) const;
void lua_get_throughput(lua_State *vm) const;
void lua_get_time(lua_State *vm) const;
void lua_get_ip(lua_State *vm, bool client) const;
void lua_get_mac(lua_State *vm, bool client) const;
void lua_get_info(lua_State *vm, bool client) const;
void lua_get_tls_info(lua_State *vm) const;
void lua_get_ssh_info(lua_State *vm) const;
void lua_get_http_info(lua_State *vm) const;
void lua_get_dns_info(lua_State *vm) const;
void lua_get_tcp_info(lua_State *vm) const;
void lua_get_port(lua_State *vm, bool client) const;
void lua_get_geoloc(lua_State *vm, bool client, bool coords,
bool country_city) const;
void lua_get_risk_info(lua_State *vm);
void getInfo(ndpi_serializer *serializer);
void getHTTPInfo(ndpi_serializer *serializer) const;
void getDNSInfo(ndpi_serializer *serializer) const;
void getICMPInfo(ndpi_serializer *serializer) const;
void getTLSInfo(ndpi_serializer *serializer) const;
void getMDNSInfo(ndpi_serializer *serializer) const;
void getNetBiosInfo(ndpi_serializer *serializer) const;
void getSSHInfo(ndpi_serializer *serializer) const;
bool equal(const Mac *src_mac, const Mac *dst_mac, const IpAddress *_cli_ip,
const IpAddress *_srv_ip, u_int16_t _cli_port, u_int16_t _srv_port,
u_int16_t _u_int16_t, u_int16_t _observation_point_id,
u_int32_t _private_flow_id, u_int8_t _protocol,
const ICMPinfo *const icmp_info, bool *src2srv_direction) const;
void sumStats(nDPIStats *ndpi_stats, FlowStats *stats);
bool dump(time_t t, bool last_dump_before_free);
bool match(AddressTree *ptree);
bool matchFlowIP(IpAddress *ip, u_int16_t vlan_id);
bool matchFlowVLAN(u_int16_t vlan_id);
bool matchFlowDeviceIP(u_int32_t flow_device_ip);
bool matchInIfIdx(u_int32_t in_if_idx);
bool matchOutIfIdx(u_int32_t out_if_idx);
void dissectHTTP(bool src2dst_direction, char *payload,
u_int16_t payload_len);
void dissectDNS(bool src2dst_direction, char *payload, u_int16_t payload_len);
void dissectTLS(char *payload, u_int16_t payload_len);
void dissectSSDP(bool src2dst_direction, char *payload,
u_int16_t payload_len);
void dissectMDNS(u_int8_t *payload, u_int16_t payload_len);
void dissectNetBIOS(u_int8_t *payload, u_int16_t payload_len);
void dissectBittorrent(char *payload, u_int16_t payload_len);
void fillZMQFlowCategory(ndpi_protocol *res);
void setDHCPHostName(const char* name);
inline void setICMP(bool src2dst_direction, u_int8_t icmp_type,
u_int8_t icmp_code, u_int8_t *icmpdata) {
if (isICMP()) {
if (src2dst_direction)
protos.icmp.cli2srv.icmp_type = icmp_type,
protos.icmp.cli2srv.icmp_code = icmp_code;
else
protos.icmp.srv2cli.icmp_type = icmp_type,
protos.icmp.srv2cli.icmp_code = icmp_code;
// if(get_cli_host()) get_cli_host()->incICMP(icmp_type, icmp_code,
// src2dst_direction ? true : false, get_srv_host()); if(get_srv_host())
// get_srv_host()->incICMP(icmp_type, icmp_code, src2dst_direction ? false
// : true, get_cli_host());
}
}
inline void getICMP(u_int8_t *_icmp_type, u_int8_t *_icmp_code) {
if (isBidirectional())
*_icmp_type = protos.icmp.srv2cli.icmp_type,
*_icmp_code = protos.icmp.srv2cli.icmp_code;
else
*_icmp_type = protos.icmp.cli2srv.icmp_type,
*_icmp_code = protos.icmp.cli2srv.icmp_code;
}
inline u_int8_t getICMPType() {