/
capture_opts.c
1591 lines (1464 loc) · 64.6 KB
/
capture_opts.c
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
/* capture_opts.c
* Routines for capture options setting
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include <config.h>
#include <wireshark.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#ifdef HAVE_LIBPCAP
#include <errno.h>
#include <ws_exit_codes.h>
#include "capture_opts.h"
#include "ringbuffer.h"
#include <wsutil/clopts_common.h>
#include <wsutil/cmdarg_err.h>
#include <wsutil/file_util.h>
#include <wsutil/ws_pipe.h>
#include <wsutil/ws_assert.h>
#ifdef _WIN32
#include <wsutil/win32-utils.h>
#endif
#include "capture/capture_ifinfo.h"
#include "capture/capture-pcap-util.h"
static gboolean capture_opts_output_to_pipe(const char *save_file, gboolean *is_pipe);
void
capture_opts_init(capture_options *capture_opts, GList *(*get_iface_list)(int *, gchar **))
{
capture_opts->get_iface_list = get_iface_list;
capture_opts->ifaces = g_array_new(FALSE, FALSE, sizeof(interface_options));
capture_opts->all_ifaces = g_array_new(FALSE, FALSE, sizeof(interface_t));
capture_opts->num_selected = 0;
capture_opts->default_options.name = NULL;
capture_opts->default_options.descr = NULL;
capture_opts->default_options.ifname = NULL;
capture_opts->default_options.hardware = NULL;
capture_opts->default_options.display_name = NULL;
capture_opts->default_options.cfilter = NULL;
capture_opts->default_options.has_snaplen = FALSE;
capture_opts->default_options.snaplen = WTAP_MAX_PACKET_SIZE_STANDARD;
capture_opts->default_options.linktype = -1; /* use interface default */
capture_opts->default_options.promisc_mode = TRUE;
capture_opts->default_options.if_type = IF_WIRED;
capture_opts->default_options.extcap = NULL;
capture_opts->default_options.extcap_fifo = NULL;
capture_opts->default_options.extcap_args = NULL;
capture_opts->default_options.extcap_pid = WS_INVALID_PID;
capture_opts->default_options.extcap_pipedata = NULL;
capture_opts->default_options.extcap_stderr = NULL;
capture_opts->default_options.extcap_stdout_watch = 0;
capture_opts->default_options.extcap_stderr_watch = 0;
#ifdef _WIN32
capture_opts->default_options.extcap_pipe_h = INVALID_HANDLE_VALUE;
capture_opts->default_options.extcap_control_in_h = INVALID_HANDLE_VALUE;
capture_opts->default_options.extcap_control_out_h = INVALID_HANDLE_VALUE;
#endif
capture_opts->default_options.extcap_control_in = NULL;
capture_opts->default_options.extcap_control_out = NULL;
#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
capture_opts->default_options.buffer_size = DEFAULT_CAPTURE_BUFFER_SIZE;
#endif
capture_opts->default_options.monitor_mode = FALSE;
#ifdef HAVE_PCAP_REMOTE
capture_opts->default_options.src_type = CAPTURE_IFLOCAL;
capture_opts->default_options.remote_host = NULL;
capture_opts->default_options.remote_port = NULL;
capture_opts->default_options.auth_type = CAPTURE_AUTH_NULL;
capture_opts->default_options.auth_username = NULL;
capture_opts->default_options.auth_password = NULL;
capture_opts->default_options.datatx_udp = FALSE;
capture_opts->default_options.nocap_rpcap = TRUE;
capture_opts->default_options.nocap_local = FALSE;
#endif
#ifdef HAVE_PCAP_SETSAMPLING
capture_opts->default_options.sampling_method = CAPTURE_SAMP_NONE;
capture_opts->default_options.sampling_param = 0;
#endif
capture_opts->default_options.timestamp_type = NULL;
capture_opts->saving_to_file = FALSE;
capture_opts->save_file = NULL;
capture_opts->group_read_access = FALSE;
capture_opts->use_pcapng = TRUE; /* Save as pcapng by default */
capture_opts->update_interval = DEFAULT_UPDATE_INTERVAL; /* 100 ms */
capture_opts->real_time_mode = TRUE;
capture_opts->show_info = TRUE;
capture_opts->restart = FALSE;
capture_opts->orig_save_file = NULL;
capture_opts->multi_files_on = FALSE;
capture_opts->has_file_duration = FALSE;
capture_opts->file_duration = 60.0; /* 1 min */
capture_opts->has_file_interval = FALSE;
capture_opts->has_nametimenum = FALSE;
capture_opts->file_interval = 60; /* 1 min */
capture_opts->has_file_packets = FALSE;
capture_opts->file_packets = 0;
capture_opts->has_ring_num_files = FALSE;
capture_opts->ring_num_files = RINGBUFFER_MIN_NUM_FILES;
capture_opts->has_autostop_files = FALSE;
capture_opts->autostop_files = 1;
capture_opts->has_autostop_packets = FALSE;
capture_opts->autostop_packets = 0;
capture_opts->has_autostop_written_packets = FALSE;
capture_opts->autostop_written_packets = 0;
capture_opts->has_autostop_filesize = FALSE;
capture_opts->autostop_filesize = 1000; /* 1 MB */
capture_opts->has_autostop_duration = FALSE;
capture_opts->autostop_duration = 60.0; /* 1 min */
capture_opts->output_to_pipe = FALSE;
capture_opts->capture_child = FALSE;
capture_opts->stop_after_extcaps = FALSE;
capture_opts->wait_for_extcap_cbs = FALSE;
capture_opts->print_file_names = FALSE;
capture_opts->print_name_to = NULL;
capture_opts->temp_dir = NULL;
capture_opts->compress_type = NULL;
capture_opts->closed_msg = NULL;
capture_opts->extcap_terminate_id = 0;
capture_opts->capture_filters_list = NULL;
}
void
capture_opts_cleanup(capture_options *capture_opts)
{
if (!capture_opts)
return;
if (capture_opts->ifaces) {
while (capture_opts->ifaces->len > 0) {
capture_opts_del_iface(capture_opts, 0);
}
g_array_free(capture_opts->ifaces, TRUE);
capture_opts->ifaces = NULL;
}
if (capture_opts->all_ifaces) {
while (capture_opts->all_ifaces->len > 0) {
interface_t *device = &g_array_index(capture_opts->all_ifaces, interface_t, 0);
capture_opts_free_interface_t(device);
capture_opts->all_ifaces = g_array_remove_index(capture_opts->all_ifaces, 0);
}
g_array_free(capture_opts->all_ifaces, TRUE);
capture_opts->all_ifaces = NULL;
}
g_free(capture_opts->save_file);
g_free(capture_opts->temp_dir);
if (capture_opts->closed_msg) {
g_free(capture_opts->closed_msg);
capture_opts->closed_msg = NULL;
}
if (capture_opts->extcap_terminate_id > 0) {
g_source_remove(capture_opts->extcap_terminate_id);
capture_opts->extcap_terminate_id = 0;
}
if (capture_opts->capture_filters_list) {
ws_filter_list_free(capture_opts->capture_filters_list);
capture_opts->capture_filters_list = NULL;
}
}
/* log content of capture_opts */
void
capture_opts_log(const char *log_domain, enum ws_log_level log_level, capture_options *capture_opts) {
guint i;
ws_log(log_domain, log_level, "CAPTURE OPTIONS :");
for (i = 0; i < capture_opts->ifaces->len; i++) {
interface_options *interface_opts;
interface_opts = &g_array_index(capture_opts->ifaces, interface_options, i);
ws_log(log_domain, log_level, "Interface name[%02d] : %s", i, interface_opts->name ? interface_opts->name : "(unspecified)");
ws_log(log_domain, log_level, "Interface description[%02d] : %s", i, interface_opts->descr ? interface_opts->descr : "(unspecified)");
ws_log(log_domain, log_level, "Interface vendor description[%02d] : %s", i, interface_opts->hardware ? interface_opts->hardware : "(unspecified)");
ws_log(log_domain, log_level, "Display name[%02d]: %s", i, interface_opts->display_name ? interface_opts->display_name : "(unspecified)");
ws_log(log_domain, log_level, "Capture filter[%02d] : %s", i, interface_opts->cfilter ? interface_opts->cfilter : "(unspecified)");
ws_log(log_domain, log_level, "Snap length[%02d] (%u) : %d", i, interface_opts->has_snaplen, interface_opts->snaplen);
ws_log(log_domain, log_level, "Link Type[%02d] : %d", i, interface_opts->linktype);
ws_log(log_domain, log_level, "Promiscuous Mode[%02d]: %s", i, interface_opts->promisc_mode?"TRUE":"FALSE");
ws_log(log_domain, log_level, "Extcap[%02d] : %s", i, interface_opts->extcap ? interface_opts->extcap : "(unspecified)");
ws_log(log_domain, log_level, "Extcap FIFO[%02d] : %s", i, interface_opts->extcap_fifo ? interface_opts->extcap_fifo : "(unspecified)");
ws_log(log_domain, log_level, "Extcap PID[%02d] : %"PRIdMAX, i, (intmax_t)interface_opts->extcap_pid);
#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
ws_log(log_domain, log_level, "Buffer size[%02d] : %d (MB)", i, interface_opts->buffer_size);
#endif
ws_log(log_domain, log_level, "Monitor Mode[%02d] : %s", i, interface_opts->monitor_mode?"TRUE":"FALSE");
#ifdef HAVE_PCAP_REMOTE
ws_log(log_domain, log_level, "Capture source[%02d] : %s", i,
interface_opts->src_type == CAPTURE_IFLOCAL ? "Local interface" :
interface_opts->src_type == CAPTURE_IFREMOTE ? "Remote interface" :
"Unknown");
if (interface_opts->src_type == CAPTURE_IFREMOTE) {
ws_log(log_domain, log_level, "Remote host[%02d] : %s", i, interface_opts->remote_host ? interface_opts->remote_host : "(unspecified)");
ws_log(log_domain, log_level, "Remote port[%02d] : %s", i, interface_opts->remote_port ? interface_opts->remote_port : "(unspecified)");
}
ws_log(log_domain, log_level, "Authentication[%02d] : %s", i,
interface_opts->auth_type == CAPTURE_AUTH_NULL ? "Null" :
interface_opts->auth_type == CAPTURE_AUTH_PWD ? "By username/password" :
"Unknown");
if (interface_opts->auth_type == CAPTURE_AUTH_PWD) {
ws_log(log_domain, log_level, "Auth username[%02d] : %s", i, interface_opts->auth_username ? interface_opts->auth_username : "(unspecified)");
ws_log(log_domain, log_level, "Auth password[%02d] : <hidden>", i);
}
ws_log(log_domain, log_level, "UDP data tfer[%02d] : %u", i, interface_opts->datatx_udp);
ws_log(log_domain, log_level, "No cap. RPCAP[%02d] : %u", i, interface_opts->nocap_rpcap);
ws_log(log_domain, log_level, "No cap. local[%02d] : %u", i, interface_opts->nocap_local);
#endif
#ifdef HAVE_PCAP_SETSAMPLING
ws_log(log_domain, log_level, "Sampling meth.[%02d] : %d", i, interface_opts->sampling_method);
ws_log(log_domain, log_level, "Sampling param.[%02d] : %d", i, interface_opts->sampling_param);
#endif
ws_log(log_domain, log_level, "Timestamp type [%02d] : %s", i, interface_opts->timestamp_type);
}
ws_log(log_domain, log_level, "Interface name[df] : %s", capture_opts->default_options.name ? capture_opts->default_options.name : "(unspecified)");
ws_log(log_domain, log_level, "Interface Descr[df] : %s", capture_opts->default_options.descr ? capture_opts->default_options.descr : "(unspecified)");
ws_log(log_domain, log_level, "Interface Hardware Descr[df] : %s", capture_opts->default_options.hardware ? capture_opts->default_options.hardware : "(unspecified)");
ws_log(log_domain, log_level, "Interface display name[df] : %s", capture_opts->default_options.display_name ? capture_opts->default_options.display_name : "(unspecified)");
ws_log(log_domain, log_level, "Capture filter[df] : %s", capture_opts->default_options.cfilter ? capture_opts->default_options.cfilter : "(unspecified)");
ws_log(log_domain, log_level, "Snap length[df] (%u) : %d", capture_opts->default_options.has_snaplen, capture_opts->default_options.snaplen);
ws_log(log_domain, log_level, "Link Type[df] : %d", capture_opts->default_options.linktype);
ws_log(log_domain, log_level, "Promiscuous Mode[df]: %s", capture_opts->default_options.promisc_mode?"TRUE":"FALSE");
ws_log(log_domain, log_level, "Extcap[df] : %s", capture_opts->default_options.extcap ? capture_opts->default_options.extcap : "(unspecified)");
ws_log(log_domain, log_level, "Extcap FIFO[df] : %s", capture_opts->default_options.extcap_fifo ? capture_opts->default_options.extcap_fifo : "(unspecified)");
#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
ws_log(log_domain, log_level, "Buffer size[df] : %d (MB)", capture_opts->default_options.buffer_size);
#endif
ws_log(log_domain, log_level, "Monitor Mode[df] : %s", capture_opts->default_options.monitor_mode?"TRUE":"FALSE");
#ifdef HAVE_PCAP_REMOTE
ws_log(log_domain, log_level, "Capture source[df] : %s",
capture_opts->default_options.src_type == CAPTURE_IFLOCAL ? "Local interface" :
capture_opts->default_options.src_type == CAPTURE_IFREMOTE ? "Remote interface" :
"Unknown");
if (capture_opts->default_options.src_type == CAPTURE_IFREMOTE) {
ws_log(log_domain, log_level, "Remote host[df] : %s", capture_opts->default_options.remote_host ? capture_opts->default_options.remote_host : "(unspecified)");
ws_log(log_domain, log_level, "Remote port[df] : %s", capture_opts->default_options.remote_port ? capture_opts->default_options.remote_port : "(unspecified)");
}
ws_log(log_domain, log_level, "Authentication[df] : %s",
capture_opts->default_options.auth_type == CAPTURE_AUTH_NULL ? "Null" :
capture_opts->default_options.auth_type == CAPTURE_AUTH_PWD ? "By username/password" :
"Unknown");
if (capture_opts->default_options.auth_type == CAPTURE_AUTH_PWD) {
ws_log(log_domain, log_level, "Auth username[df] : %s", capture_opts->default_options.auth_username ? capture_opts->default_options.auth_username : "(unspecified)");
ws_log(log_domain, log_level, "Auth password[df] : <hidden>");
}
ws_log(log_domain, log_level, "UDP data tfer[df] : %u", capture_opts->default_options.datatx_udp);
ws_log(log_domain, log_level, "No cap. RPCAP[df] : %u", capture_opts->default_options.nocap_rpcap);
ws_log(log_domain, log_level, "No cap. local[df] : %u", capture_opts->default_options.nocap_local);
#endif
#ifdef HAVE_PCAP_SETSAMPLING
ws_log(log_domain, log_level, "Sampling meth. [df] : %d", capture_opts->default_options.sampling_method);
ws_log(log_domain, log_level, "Sampling param.[df] : %d", capture_opts->default_options.sampling_param);
#endif
ws_log(log_domain, log_level, "Timestamp type [df] : %s", capture_opts->default_options.timestamp_type ? capture_opts->default_options.timestamp_type : "(unspecified)");
ws_log(log_domain, log_level, "SavingToFile : %u", capture_opts->saving_to_file);
ws_log(log_domain, log_level, "SaveFile : %s", (capture_opts->save_file) ? capture_opts->save_file : "");
ws_log(log_domain, log_level, "GroupReadAccess : %u", capture_opts->group_read_access);
ws_log(log_domain, log_level, "Fileformat : %s", (capture_opts->use_pcapng) ? "PCAPNG" : "PCAP");
ws_log(log_domain, log_level, "UpdateInterval : %u (ms)", capture_opts->update_interval);
ws_log(log_domain, log_level, "RealTimeMode : %u", capture_opts->real_time_mode);
ws_log(log_domain, log_level, "ShowInfo : %u", capture_opts->show_info);
ws_log(log_domain, log_level, "MultiFilesOn : %u", capture_opts->multi_files_on);
ws_log(log_domain, log_level, "FileDuration (%u) : %.3f", capture_opts->has_file_duration, capture_opts->file_duration);
ws_log(log_domain, log_level, "FileInterval (%u) : %u", capture_opts->has_file_interval, capture_opts->file_interval);
ws_log(log_domain, log_level, "FilePackets (%u) : %u", capture_opts->has_file_packets, capture_opts->file_packets);
ws_log(log_domain, log_level, "FileNameType : %s", (capture_opts->has_nametimenum) ? "prefix_time_num.suffix" : "prefix_num_time.suffix");
ws_log(log_domain, log_level, "RingNumFiles (%u) : %u", capture_opts->has_ring_num_files, capture_opts->ring_num_files);
ws_log(log_domain, log_level, "RingPrintFiles (%u) : %s", capture_opts->print_file_names, (capture_opts->print_file_names ? capture_opts->print_name_to : ""));
ws_log(log_domain, log_level, "AutostopFiles (%u) : %u", capture_opts->has_autostop_files, capture_opts->autostop_files);
ws_log(log_domain, log_level, "AutostopPackets (%u) : %u", capture_opts->has_autostop_packets, capture_opts->autostop_packets);
ws_log(log_domain, log_level, "AutostopWrittenPackets (%u) : %u", capture_opts->has_autostop_written_packets, capture_opts->autostop_written_packets);
ws_log(log_domain, log_level, "AutostopFilesize(%u) : %u (KB)", capture_opts->has_autostop_filesize, capture_opts->autostop_filesize);
ws_log(log_domain, log_level, "AutostopDuration(%u) : %.3f", capture_opts->has_autostop_duration, capture_opts->autostop_duration);
ws_log(log_domain, log_level, "Temporary Directory : %s", capture_opts->temp_dir && capture_opts->temp_dir[0] ? capture_opts->temp_dir : g_get_tmp_dir());
}
/*
* Given a string of the form "<autostop criterion>:<value>", as might appear
* as an argument to a "-a" option, parse it and set the criterion in
* question. Return an indication of whether it succeeded or failed
* in some fashion.
*/
static gboolean
set_autostop_criterion(capture_options *capture_opts, const char *autostoparg)
{
gchar *p, *colonp;
colonp = strchr(autostoparg, ':');
if (colonp == NULL)
return FALSE;
p = colonp;
*p++ = '\0';
/*
* Skip over any white space (there probably won't be any, but
* as we allow it in the preferences file, we might as well
* allow it here).
*/
while (g_ascii_isspace(*p))
p++;
if (*p == '\0') {
/*
* Put the colon back, so if our caller uses, in an
* error message, the string they passed us, the message
* looks correct.
*/
*colonp = ':';
return FALSE;
}
if (strcmp(autostoparg,"duration") == 0) {
capture_opts->has_autostop_duration = TRUE;
capture_opts->autostop_duration = get_positive_double(p,"autostop duration");
} else if (strcmp(autostoparg,"filesize") == 0) {
capture_opts->has_autostop_filesize = TRUE;
capture_opts->autostop_filesize = get_nonzero_guint32(p,"autostop filesize");
} else if (strcmp(autostoparg,"files") == 0) {
capture_opts->multi_files_on = TRUE;
capture_opts->has_autostop_files = TRUE;
capture_opts->autostop_files = get_positive_int(p,"autostop files");
} else if (strcmp(autostoparg,"packets") == 0) {
capture_opts->has_autostop_written_packets = TRUE;
capture_opts->autostop_written_packets = get_positive_int(p,"packet write count");
} else {
return FALSE;
}
*colonp = ':'; /* put the colon back */
return TRUE;
}
static gboolean get_filter_arguments(capture_options* capture_opts, const char* arg)
{
char* colonp;
char* val;
char* filter_exp = NULL;
colonp = strchr(arg, ':');
if (colonp) {
val = colonp;
*val = '\0';
val++;
if (strcmp(arg, "predef") == 0) {
GList* filterItem;
filterItem = capture_opts->capture_filters_list->list;
while (filterItem != NULL) {
filter_def *filterDef;
filterDef = (filter_def*)filterItem->data;
if (g_ascii_strcasecmp(val, filterDef->name) == 0) {
filter_exp = g_strdup(filterDef->strval);
break;
}
filterItem = filterItem->next;
}
}
}
if (filter_exp == NULL) {
/* No filter expression found yet; fallback to previous implementation
and assume the arg contains a filter expression */
if (colonp) {
*colonp = ':'; /* restore colon */
}
filter_exp = g_strdup(arg);
}
if (capture_opts->ifaces->len > 0) {
interface_options *interface_opts;
interface_opts = &g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
g_free(interface_opts->cfilter);
interface_opts->cfilter = filter_exp;
return TRUE;
}
else {
g_free(capture_opts->default_options.cfilter);
capture_opts->default_options.cfilter = filter_exp;
return TRUE;
}
}
/*
* Given a string of the form "<ring buffer file>:<duration>", as might appear
* as an argument to a "-b" option, parse it and set the arguments in
* question. Return an indication of whether it succeeded or failed
* in some fashion.
*/
static gboolean
get_ring_arguments(capture_options *capture_opts, const char *arg)
{
gchar *p = NULL, *colonp;
colonp = strchr(arg, ':');
if (colonp == NULL)
return FALSE;
p = colonp;
*p++ = '\0';
/*
* Skip over any white space (there probably won't be any, but
* as we allow it in the preferences file, we might as well
* allow it here).
*/
while (g_ascii_isspace(*p))
p++;
if (*p == '\0') {
/*
* Put the colon back, so if our caller uses, in an
* error message, the string they passed us, the message
* looks correct.
*/
*colonp = ':';
return FALSE;
}
if (strcmp(arg,"files") == 0) {
capture_opts->has_ring_num_files = TRUE;
capture_opts->ring_num_files = get_nonzero_guint32(p, "number of ring buffer files");
} else if (strcmp(arg,"filesize") == 0) {
capture_opts->has_autostop_filesize = TRUE;
capture_opts->autostop_filesize = get_nonzero_guint32(p, "ring buffer filesize");
} else if (strcmp(arg,"duration") == 0) {
capture_opts->has_file_duration = TRUE;
capture_opts->file_duration = get_positive_double(p, "ring buffer duration");
} else if (strcmp(arg,"interval") == 0) {
capture_opts->has_file_interval = TRUE;
capture_opts->file_interval = get_positive_int(p, "ring buffer interval");
} else if (strcmp(arg,"nametimenum") == 0) {
int val = get_positive_int(p, "file name: time before num");
capture_opts->has_nametimenum = (val > 1);
} else if (strcmp(arg,"packets") == 0) {
capture_opts->has_file_packets = TRUE;
capture_opts->file_packets = get_positive_int(p, "ring buffer packet count");
} else if (strcmp(arg,"printname") == 0) {
capture_opts->print_file_names = TRUE;
capture_opts->print_name_to = g_strdup(p);
}
else {
return FALSE;
}
*colonp = ':'; /* put the colon back */
return TRUE;
}
#ifdef HAVE_PCAP_SETSAMPLING
/*
* Given a string of the form "<sampling type>:<value>", as might appear
* as an argument to a "-m" option, parse it and set the arguments in
* question. Return an indication of whether it succeeded or failed
* in some fashion.
*/
static gboolean
get_sampling_arguments(capture_options *capture_opts, const char *arg)
{
gchar *p = NULL, *colonp;
colonp = strchr(arg, ':');
if (colonp == NULL)
return FALSE;
p = colonp;
*p++ = '\0';
while (g_ascii_isspace(*p))
p++;
if (*p == '\0') {
*colonp = ':';
return FALSE;
}
if (strcmp(arg, "count") == 0) {
if (capture_opts->ifaces->len > 0) {
interface_options *interface_opts;
interface_opts = &g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
interface_opts->sampling_method = CAPTURE_SAMP_BY_COUNT;
interface_opts->sampling_param = get_positive_int(p, "sampling count");
} else {
capture_opts->default_options.sampling_method = CAPTURE_SAMP_BY_COUNT;
capture_opts->default_options.sampling_param = get_positive_int(p, "sampling count");
}
} else if (strcmp(arg, "timer") == 0) {
if (capture_opts->ifaces->len > 0) {
interface_options *interface_opts;
interface_opts = &g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
interface_opts->sampling_method = CAPTURE_SAMP_BY_TIMER;
interface_opts->sampling_param = get_positive_int(p, "sampling timer");
} else {
capture_opts->default_options.sampling_method = CAPTURE_SAMP_BY_TIMER;
capture_opts->default_options.sampling_param = get_positive_int(p, "sampling timer");
}
}
*colonp = ':';
return TRUE;
}
#endif
#ifdef HAVE_PCAP_REMOTE
/*
* Given a string of the form "<username>:<password>", as might appear
* as an argument to a "-A" option, parse it and set the arguments in
* question. Return an indication of whether it succeeded or failed
* in some fashion.
*/
static gboolean
get_auth_arguments(capture_options *capture_opts, const char *arg)
{
gchar *p = NULL, *colonp;
colonp = strchr(arg, ':');
if (colonp == NULL)
return FALSE;
p = colonp;
*p++ = '\0';
while (g_ascii_isspace(*p))
p++;
if (capture_opts->ifaces->len > 0) {
interface_options *interface_opts;
interface_opts = &g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
interface_opts->auth_type = CAPTURE_AUTH_PWD;
interface_opts->auth_username = g_strdup(arg);
interface_opts->auth_password = g_strdup(p);
} else {
capture_opts->default_options.auth_type = CAPTURE_AUTH_PWD;
capture_opts->default_options.auth_username = g_strdup(arg);
capture_opts->default_options.auth_password = g_strdup(p);
}
*colonp = ':';
return TRUE;
}
#endif
#ifdef _WIN32
static char *
capture_opts_generate_display_name(const char *friendly_name,
const char *name _U_)
{
/*
* Display the friendly name rather than the not-so-friendly
* GUID-based interface name.
*/
return g_strdup(friendly_name);
}
#else
static char *
capture_opts_generate_display_name(const char *friendly_name,
const char *name)
{
/*
* On UN*X, however, users are more used to interface names,
* and may find it helpful to see them.
*/
return ws_strdup_printf("%s: %s", friendly_name, name);
}
#endif
static void
fill_in_interface_opts_defaults(interface_options *interface_opts, const capture_options *capture_opts)
{
interface_opts->cfilter = g_strdup(capture_opts->default_options.cfilter);
interface_opts->snaplen = capture_opts->default_options.snaplen;
interface_opts->has_snaplen = capture_opts->default_options.has_snaplen;
interface_opts->linktype = capture_opts->default_options.linktype;
interface_opts->promisc_mode = capture_opts->default_options.promisc_mode;
interface_opts->extcap_fifo = g_strdup(capture_opts->default_options.extcap_fifo);
interface_opts->extcap_args = NULL;
interface_opts->extcap_pid = WS_INVALID_PID;
interface_opts->extcap_pipedata = NULL;
interface_opts->extcap_stderr = NULL;
interface_opts->extcap_stdout_watch = 0;
interface_opts->extcap_stderr_watch = 0;
#ifdef _WIN32
interface_opts->extcap_pipe_h = INVALID_HANDLE_VALUE;
interface_opts->extcap_control_in_h = INVALID_HANDLE_VALUE;
interface_opts->extcap_control_out_h = INVALID_HANDLE_VALUE;
#endif
interface_opts->extcap_control_in = g_strdup(capture_opts->default_options.extcap_control_in);
interface_opts->extcap_control_out = g_strdup(capture_opts->default_options.extcap_control_out);
#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
interface_opts->buffer_size = capture_opts->default_options.buffer_size;
#endif
interface_opts->monitor_mode = capture_opts->default_options.monitor_mode;
#ifdef HAVE_PCAP_REMOTE
interface_opts->src_type = capture_opts->default_options.src_type;
interface_opts->remote_host = g_strdup(capture_opts->default_options.remote_host);
interface_opts->remote_port = g_strdup(capture_opts->default_options.remote_port);
interface_opts->auth_type = capture_opts->default_options.auth_type;
interface_opts->auth_username = g_strdup(capture_opts->default_options.auth_username);
interface_opts->auth_password = g_strdup(capture_opts->default_options.auth_password);
interface_opts->datatx_udp = capture_opts->default_options.datatx_udp;
interface_opts->nocap_rpcap = capture_opts->default_options.nocap_rpcap;
interface_opts->nocap_local = capture_opts->default_options.nocap_local;
#endif
#ifdef HAVE_PCAP_SETSAMPLING
interface_opts->sampling_method = capture_opts->default_options.sampling_method;
interface_opts->sampling_param = capture_opts->default_options.sampling_param;
#endif
interface_opts->timestamp_type = capture_opts->default_options.timestamp_type;
}
static void
fill_in_interface_opts_from_ifinfo(interface_options *interface_opts,
const if_info_t *if_info)
{
interface_opts->name = g_strdup(if_info->name);
interface_opts->hardware = g_strdup(if_info->vendor_description);
/* XXX: ui/capture_ui_utils.c get_interface_descriptive_name()
* does several things different in setting descr (and thus
* display name):
* 1. It checks for a user-supplied description via
* capture_dev_user_descr_find(if_info->name), including a
* long-standing -X option of "stdin_descr" that dates back to 1.0
* 2. If we don't have a friendly name, but do have a vendor
* description (set to hardware above), that is used as the
* description.
*
* Perhaps we don't want to introduce a dependency on the prefs
* and ex-opts here. We could do 2 here, though.
*
* Because we always set interface_opts->display_name here, it is
* never NULL when get_iface_list_string is called, so that never
* calls get_interface_descriptive_name(). (And thus, we never
* actually use the vendor description in the display name/descr
* as a fallback.)
*/
if (if_info->friendly_name != NULL) {
/*
* We have a friendly name; remember it as the
* description...
*/
interface_opts->descr = g_strdup(if_info->friendly_name);
/*
* ...and use it in the console display name.
*/
interface_opts->display_name = capture_opts_generate_display_name(if_info->friendly_name, if_info->name);
} else {
/* fallback to the interface name */
interface_opts->descr = NULL;
interface_opts->display_name = g_strdup(if_info->name);
}
interface_opts->ifname = NULL;
interface_opts->if_type = if_info->type;
interface_opts->extcap = g_strdup(if_info->extcap);
}
static if_info_t*
find_ifinfo_by_name(GList *if_list, const char *name)
{
GList *if_entry;
if_info_t *matched_if_info;
size_t prefix_length;
matched_if_info = NULL;
if (if_list != NULL) {
/*
* Try and do an exact match (case insensitive) on the
* interface name, the interface description, and the
* hardware description.
*/
for (if_entry = g_list_first(if_list); if_entry != NULL;
if_entry = g_list_next(if_entry))
{
if_info_t *if_info = (if_info_t *)if_entry->data;
/*
* Does the specified name match the interface name
* with a case-insensitive match?
*/
if (g_ascii_strcasecmp(if_info->name, name) == 0) {
/*
* Yes.
*/
matched_if_info = if_info;
break;
}
/*
* Does this interface have a friendly name and, if so,
* does the specified name match the friendly name with
* a case-insensitive match?
*/
if (if_info->friendly_name != NULL &&
g_ascii_strcasecmp(if_info->friendly_name, name) == 0) {
/*
* Yes.
*/
matched_if_info = if_info;
break;
}
#ifdef _WIN32
/*
* On Windows, we store interface names in preferences as:
* friendlyname (name)
* Do we have a case-insensitive match for that?
*/
if (if_info->friendly_name != NULL) {
GString* combined_name = g_string_new(if_info->friendly_name);
g_string_append_printf(combined_name, " (%s)", if_info->name);
if (g_ascii_strcasecmp(combined_name->str, name) == 0) {
/*
* Yes.
*/
matched_if_info = if_info;
}
g_string_free(combined_name, TRUE);
if (matched_if_info != NULL) {
break;
}
}
#endif
}
if (matched_if_info == NULL) {
/*
* We didn't find it; attempt a case-insensitive prefix match
* of the friendly name.
*/
prefix_length = strlen(name);
for (if_entry = g_list_first(if_list); if_entry != NULL;
if_entry = g_list_next(if_entry))
{
if_info_t *if_info = (if_info_t *)if_entry->data;
if (if_info->friendly_name != NULL &&
g_ascii_strncasecmp(if_info->friendly_name, name, prefix_length) == 0) {
/*
* We found an interface whose friendly name matches
* with a case-insensitive prefix match.
*/
matched_if_info = if_info;
break;
}
}
}
}
return matched_if_info;
}
static int
capture_opts_add_iface_opt(capture_options *capture_opts, const char *optarg_str_p)
{
long adapter_index;
char *p;
GList *if_list;
if_info_t *if_info;
int err;
gchar *err_str;
interface_options interface_opts;
/*
* If the argument is a number, treat it as an index into the list
* of adapters, as printed by "tshark -D".
*
* This should be OK on UN*X systems, as interfaces shouldn't have
* names that begin with digits. It can be useful on Windows, where
* more than one interface can have the same name.
*
* XXX - "shouldn't have names that begin with digits" is not true
* on Linux; see
*
* https://github.com/the-tcpdump-group/tcpdump/issues/522
*
* tcpdump handles that by trying to open the device by name and,
* if that fails *and* the name is a syntactically valid number
* (optional sign, followed by decimal digits), reports an error
* if it's not a valid interface index, and otherwise uses it as
* an interface index.
*/
adapter_index = strtol(optarg_str_p, &p, 10);
if (p != NULL && *p == '\0') {
if (adapter_index < 0) {
cmdarg_err("The specified adapter index is a negative number");
return 1;
}
if (adapter_index > INT_MAX) {
cmdarg_err("The specified adapter index is too large (greater than %d)",
INT_MAX);
return 1;
}
if (adapter_index == 0) {
cmdarg_err("There is no interface with that adapter index");
return 1;
}
if_list = capture_opts->get_iface_list(&err, &err_str);
if (if_list == NULL) {
if (err == 0)
cmdarg_err("There are no interfaces on which a capture can be done");
else {
cmdarg_err("%s", err_str);
g_free(err_str);
}
return 2;
}
if_info = (if_info_t *)g_list_nth_data(if_list, (int)(adapter_index - 1));
if (if_info == NULL) {
cmdarg_err("There is no interface with that adapter index");
free_interface_list(if_list);
return 1;
}
fill_in_interface_opts_from_ifinfo(&interface_opts, if_info);
free_interface_list(if_list);
} else if (capture_opts->capture_child) {
/*
* In Wireshark capture child mode, so the exact interface name
* is supplied, and we don't need to look it up.
*/
if_info = if_info_get(optarg_str_p);
fill_in_interface_opts_from_ifinfo(&interface_opts, if_info);
if_info_free(if_info);
} else if (g_strcmp0(optarg_str_p, "-") == 0) {
/*
* Standard input. Don't bother to retrieve the interface_list;
* assume that there isn't a device named "-". (Retrieving the
* interface list involves spawning a privileged dumpcap process.)
*/
interface_opts.name = g_strdup(optarg_str_p);
interface_opts.descr = g_strdup("Standard input");
interface_opts.hardware = NULL;
interface_opts.display_name = g_strdup(interface_opts.descr);
interface_opts.ifname = NULL;
interface_opts.if_type = IF_STDIN;
interface_opts.extcap = g_strdup(capture_opts->default_options.extcap);
#ifdef _WIN32
} else if (win32_is_pipe_name(optarg_str_p)) {
/*
* Special named pipe name on Windows.
* https://learn.microsoft.com/en-us/windows/win32/ipc/pipe-names
* Don't bother retrieving the interface list.
*/
interface_opts.name = g_strdup(optarg_str_p);
interface_opts.descr = NULL;
interface_opts.hardware = NULL;
interface_opts.display_name = g_strdup(optarg_str_p);
interface_opts.ifname = NULL;
interface_opts.if_type = IF_PIPE;
interface_opts.extcap = g_strdup(capture_opts->default_options.extcap);
#endif
} else {
/*
* Search for that name in the interface list and, if we found
* it, fill in fields in the interface_opts structure.
*
* XXX - if we can't get the interface list, we don't report
* an error, as, on Windows, that might be due to WinPcap or
* Npcap not being installed, but the specified "interface"
* might be the standard input ("-") or a pipe, and dumpcap
* should support capturing from the standard input or from
* a pipe even if there's no capture support from *pcap.
*
* Perhaps doing something similar to what was suggested
* for numerical interfaces should be done.
*
* XXX: If we ever save pipe settings permanently, it should be
* capture_interface_list that tries to check saved pipes (or
* extcaps), possibly before retrieving the list.
*/
if_list = capture_opts->get_iface_list(&err, &err_str);
if_info = find_ifinfo_by_name(if_list, optarg_str_p);
if (if_info != NULL) {
/*
* We found the interface in the list; fill in the
* interface_opts structure from its if_info.
*/
fill_in_interface_opts_from_ifinfo(&interface_opts, if_info);
} else {
/*
* We didn't find the interface in the list; just use
* the specified name, so that, for example, if an
* interface doesn't show up in the list for some
* reason, the user can try specifying it explicitly
* for testing purposes.
*/
interface_opts.name = g_strdup(optarg_str_p);
interface_opts.descr = NULL;
interface_opts.hardware = NULL;
interface_opts.display_name = g_strdup(optarg_str_p);
interface_opts.ifname = NULL;
interface_opts.if_type = capture_opts->default_options.if_type;
interface_opts.extcap = g_strdup(capture_opts->default_options.extcap);
}
free_interface_list(if_list);
}
fill_in_interface_opts_defaults(&interface_opts, capture_opts);
g_array_append_val(capture_opts->ifaces, interface_opts);
return 0;
}
int
capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg_str_p)
{
int status, snaplen;
ws_statb64 fstat;
switch(opt) {
case 'a': /* autostop criteria */
if (set_autostop_criterion(capture_opts, optarg_str_p) == FALSE) {
cmdarg_err("Invalid or unknown -a flag \"%s\"", optarg_str_p);
return 1;
}
break;
#ifdef HAVE_PCAP_REMOTE
case 'A':
if (get_auth_arguments(capture_opts, optarg_str_p) == FALSE) {
cmdarg_err("Invalid or unknown -A arg \"%s\"", optarg_str_p);
return 1;
}
break;
#endif
case 'b': /* Ringbuffer option */
capture_opts->multi_files_on = TRUE;
if (get_ring_arguments(capture_opts, optarg_str_p) == FALSE) {
cmdarg_err("Invalid or unknown -b arg \"%s\"", optarg_str_p);
return 1;
}
break;
#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
case 'B': /* Buffer size */
if (capture_opts->ifaces->len > 0) {
interface_options *interface_opts;
interface_opts = &g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
interface_opts->buffer_size = get_positive_int(optarg_str_p, "buffer size");
} else {
capture_opts->default_options.buffer_size = get_positive_int(optarg_str_p, "buffer size");
}
break;
#endif
case 'c': /* Capture n packets */
/* XXX Use set_autostop_criterion instead? */
capture_opts->has_autostop_packets = TRUE;
capture_opts->autostop_packets = get_positive_int(optarg_str_p, "packet count");
break;
case 'f': /* capture filter */
if (capture_opts->capture_filters_list == NULL)
capture_opts->capture_filters_list = ws_filter_list_read(CFILTER_LIST);
get_filter_arguments(capture_opts, optarg_str_p);
break;
case 'g': /* enable group read access on the capture file(s) */
capture_opts->group_read_access = TRUE;
break;
case 'H': /* Hide capture info dialog box */
capture_opts->show_info = FALSE;
break;
case LONGOPT_SET_TSTAMP_TYPE: /* Set capture time stamp type */
if (capture_opts->ifaces->len > 0) {
interface_options *interface_opts;
interface_opts = &g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
g_free(interface_opts->timestamp_type);
interface_opts->timestamp_type = g_strdup(optarg_str_p);
} else {
g_free(capture_opts->default_options.timestamp_type);
capture_opts->default_options.timestamp_type = g_strdup(optarg_str_p);
}
break;
case 'i': /* Use interface x */
status = capture_opts_add_iface_opt(capture_opts, optarg_str_p);
if (status != 0) {
return status;
}