options.c 17.7 KB
Newer Older
pdw's avatar
pdw committed
1 2 3 4 5 6
/*
 * options.c:
 *
 *
 */

7 8
#include "config.h"

chris's avatar
chris committed
9 10
#include <sys/types.h>

pdw's avatar
pdw committed
11 12
#include <stdio.h>
#include <string.h>
chris's avatar
chris committed
13 14 15 16
#include <stdlib.h>
#include <unistd.h>

#include <sys/ioctl.h>
17
#include <sys/socket.h>
chris's avatar
chris committed
18 19
#include <netinet/in.h>
#include <arpa/inet.h>
20
#include <net/if.h>
chris's avatar
chris committed
21 22

#include "iftop.h"
pdw's avatar
pdw committed
23
#include "options.h"
pdw's avatar
pdw committed
24
#include "cfgfile.h"
chris's avatar
chris committed
25
#include "integers.h"
pdw's avatar
pdw committed
26

chris's avatar
chris committed
27 28 29 30
#if !defined(HAVE_INET_ATON) && defined(HAVE_INET_PTON)
#   define inet_aton(a, b)  inet_pton(AF_INET, (a), (b))
#endif

pdw's avatar
pdw committed
31 32
options_t options;

33
char optstr[] = "+i:f:nNF:G:lhpbBu:Pm:c:s:tL:o:";
pdw's avatar
pdw committed
34 35 36

/* Global options. */

chris's avatar
chris committed
37 38 39 40 41 42
/* Selecting an interface on which to listen: */

/* This is a list of interface name prefixes which are `bad' in the sense
 * that they don't refer to interfaces of external type on which we are
 * likely to want to listen. We also compare candidate interfaces to lo. */
static char *bad_interface_names[] = {
43
            "lo:",
pdw's avatar
pdw committed
44 45 46
            "lo",
            "stf",     /* pseudo-device 6to4 tunnel interface */
            "gif",     /* psuedo-device generic tunnel interface */
chris's avatar
chris committed
47 48
            "dummy",
            "vmnet",
49 50
            "wmaster", /* wmaster0 is an internal-use interface for mac80211, a Linux WiFi API. */
            NULL       /* last entry must be NULL */
chris's avatar
chris committed
51 52
        };

pdw's avatar
pdw committed
53 54
config_enumeration_type sort_enumeration[] = {
	{ "2s", OPTION_SORT_DIV1 },
pdw's avatar
pdw committed
55 56
	{ "10s", OPTION_SORT_DIV2 },
	{ "40s", OPTION_SORT_DIV3 },
pdw's avatar
pdw committed
57
	{ "source", OPTION_SORT_SRC },
58
	{ "destination", OPTION_SORT_DEST },
pdw's avatar
pdw committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
	{ NULL, -1 }
};

config_enumeration_type linedisplay_enumeration[] = {
	{ "two-line", OPTION_LINEDISPLAY_TWO_LINE },
	{ "one-line-both", OPTION_LINEDISPLAY_ONE_LINE_BOTH },
	{ "one-line-sent", OPTION_LINEDISPLAY_ONE_LINE_SENT },
	{ "one-line-received", OPTION_LINEDISPLAY_ONE_LINE_RECV },
	{ NULL, -1 }
};

config_enumeration_type showports_enumeration[] = {
	{ "off", OPTION_PORTS_OFF },
	{ "source-only", OPTION_PORTS_SRC },
	{ "destination-only", OPTION_PORTS_DEST },
	{ "on", OPTION_PORTS_ON },
	{ NULL, -1 }
};

78 79 80 81 82 83 84
config_enumeration_type bandwidth_unit_enumeration[] = {
	{ "bits", OPTION_BW_BITS },
	{ "bytes", OPTION_BW_BYTES },
	{ "packets", OPTION_BW_PKTS },
	{ NULL, -1 }
};

chris's avatar
chris committed
85 86 87 88 89 90 91 92 93 94
static int is_bad_interface_name(char *i) {
    char **p;
    for (p = bad_interface_names; *p; ++p)
        if (strncmp(i, *p, strlen(*p)) == 0)
            return 1;
    return 0;
}

/* This finds the first interface which is up and is not the loopback
 * interface or one of the interface types listed in bad_interface_names. */
chris's avatar
chris committed
95
static char *get_first_interface(void) {
96
    struct if_nameindex * nameindex;
97
    struct ifreq ifr;
chris's avatar
chris committed
98
    char *i = NULL;
99
    int j = 0;
100
    int s;
chris's avatar
chris committed
101
    /* Use if_nameindex(3) instead? */
102 103 104

    nameindex = if_nameindex();
    if(nameindex == NULL) {
pdw's avatar
pdw committed
105
        return NULL;
106 107
    }

108 109
    s = socket(AF_INET, SOCK_DGRAM, 0); /* any sort of IP socket will do */

110 111
    while(nameindex[j].if_index != 0) {
        if (strcmp(nameindex[j].if_name, "lo") != 0 && !is_bad_interface_name(nameindex[j].if_name)) {
112
            strncpy(ifr.ifr_name, nameindex[j].if_name, sizeof(ifr.ifr_name));
113
            if ((s == -1) || (ioctl(s, SIOCGIFFLAGS, &ifr) == -1) || (ifr.ifr_flags & IFF_RUNNING)) {
114 115 116
                i = xstrdup(nameindex[j].if_name);
                break;
            }
chris's avatar
chris committed
117
        }
118
        j++;
chris's avatar
chris committed
119
    }
120
    if_freenameindex(nameindex);
chris's avatar
chris committed
121 122 123
    return i;
}

pdw's avatar
pdw committed
124 125
void options_set_defaults() {
    char *s;
chris's avatar
chris committed
126 127 128 129 130 131
    /* Should go through the list of interfaces, and find the first one which
     * is up and is not lo or dummy*. */
    options.interface = get_first_interface();
    if (!options.interface)
        options.interface = "eth0";

pdw's avatar
pdw committed
132 133 134 135
    options.filtercode = NULL;
    options.netfilter = 0;
    inet_aton("10.0.1.0", &options.netfilternet);
    inet_aton("255.255.255.0", &options.netfiltermask);
136 137 138 139
    options.netfilter6 = 0;
    inet_pton(AF_INET6, "fe80::", &options.netfilter6net);	/* Link-local */
    inet_pton(AF_INET6, "ffff::", &options.netfilter6mask);
    options.link_local = 0;
pdw's avatar
pdw committed
140
    options.dnsresolution = 1;
141
    options.portresolution = 1;
142 143 144 145
#ifdef NEED_PROMISCUOUS_FOR_OUTGOING
    options.promiscuous = 1;
    options.promiscuous_but_choosy = 1;
#else
pdw's avatar
pdw committed
146
    options.promiscuous = 0;
147 148
    options.promiscuous_but_choosy = 0;
#endif
pdw's avatar
pdw committed
149
    options.showbars = 1;
150
    options.showports = OPTION_PORTS_OFF;
151 152
    options.aggregate_src = 0;
    options.aggregate_dest = 0;
pdw's avatar
pdw committed
153
    options.paused = 0;
pdw's avatar
pdw committed
154
    options.showhelp = 0;
155
    options.bandwidth_unit = OPTION_BW_BITS;
pdw's avatar
pdw committed
156
    options.sort = OPTION_SORT_DIV2;
157
    options.screenfilter = NULL;
158
    options.freezeorder = 0;
pdw's avatar
pdw committed
159 160
    options.linedisplay = OPTION_LINEDISPLAY_TWO_LINE;
    options.screen_offset = 0;
pdw's avatar
pdw committed
161
    options.show_totals = 0;
162
    options.max_bandwidth = 0; /* auto */
pdw's avatar
pdw committed
163 164
    options.log_scale = 0;
    options.bar_interval = 1;
165 166 167
    options.timed_output = 0;
    options.no_curses = 0;
    options.num_lines = 10;
pdw's avatar
pdw committed
168

169
    /* Figure out the name for the config file */
pdw's avatar
pdw committed
170 171 172 173 174 175 176 177 178
    s = getenv("HOME");
    if(s != NULL) {
        int i = strlen(s) + 9 + 1;
        options.config_file = xmalloc(i);
        snprintf(options.config_file,i,"%s/.iftoprc",s);
    }
    else {
        options.config_file = xstrdup("iftoprc");
    }
179
    options.config_file_specified = 0;
pdw's avatar
pdw committed
180
    
pdw's avatar
pdw committed
181 182 183 184
}

/* usage:
 * Print usage information. */
chris's avatar
chris committed
185
static void usage(FILE *fp) {
pdw's avatar
pdw committed
186 187 188
    fprintf(fp,
"iftop: display bandwidth usage on an interface by host\n"
"\n"
189
"Synopsis: iftop -h | [-npblNBP] [-i interface] [-f filter code]\n"
190
"                               [-F net/mask] [-G net6/mask6]\n"
pdw's avatar
pdw committed
191 192
"\n"
"   -h                  display this message\n"
193
"   -n                  don't do hostname lookups\n"
chris's avatar
chris committed
194
"   -N                  don't convert port numbers to services\n"
pdw's avatar
pdw committed
195 196
"   -p                  run in promiscuous mode (show traffic between other\n"
"                       hosts on the same network segment)\n"
chris's avatar
chris committed
197
"   -b                  don't display a bar graph of traffic\n"
198 199
"   -B                  display bandwidth in bytes\n"
"   -a                  display bandwidth in packets\n"
chris's avatar
chris committed
200
"   -i interface        listen on named interface\n"
pdw's avatar
pdw committed
201 202
"   -f filter code      use filter code to select packets to count\n"
"                       (default: none, but only IP packets are counted)\n"
203 204 205
"   -F net/mask         show traffic flows in/out of IPv4 network\n"
"   -G net6/mask6       show traffic flows in/out of IPv6 network\n"
"   -l                  display and count link-local IPv6 traffic (default: off)\n"
206
"   -P                  show ports as well as hosts\n"
207
"   -m limit            sets the upper limit for the bandwidth scale\n"
208
"   -c config file      specifies an alternative configuration file\n"
209 210 211 212 213 214 215 216 217 218 219 220
"   -t                  use text interface without ncurses\n"
"\n"
"   Sorting orders:\n"
"   -o 2s                Sort by first column (2s traffic average)\n"
"   -o 10s               Sort by second column (10s traffic average) [default]\n"
"   -o 40s               Sort by third column (40s traffic average)\n"
"   -o source            Sort by source address\n"
"   -o destination       Sort by destination address\n"
"\n"
"   The following options are only available in combination with -t\n"
"   -s num              print one single text output afer num seconds, then quit\n"
"   -L num              number of lines to print\n"
pdw's avatar
pdw committed
221
"\n"
222
"iftop, version " PACKAGE_VERSION "\n"
pdw's avatar
pdw committed
223
"copyright (c) 2002 Paul Warren <pdw@ex-parrot.com> and contributors\n"
pdw's avatar
pdw committed
224 225 226
            );
}

pdw's avatar
pdw committed
227
void options_read_args(int argc, char **argv) {
pdw's avatar
pdw committed
228 229 230 231 232 233 234 235 236
    int opt;

    opterr = 0;
    while ((opt = getopt(argc, argv, optstr)) != -1) {
        switch (opt) {
            case 'h':
                usage(stdout);
                exit(0);

237
            case 'n':
pdw's avatar
pdw committed
238
                config_set_string("dns-resolution","false");
239 240 241
                break;

            case 'N':
pdw's avatar
pdw committed
242
                config_set_string("port-resolution","false");
pdw's avatar
pdw committed
243 244 245
                break;

            case 'i':
246
                config_set_string("interface", optarg);
pdw's avatar
pdw committed
247 248 249
                break;

            case 'f':
250
                config_set_string("filter-code", optarg);
pdw's avatar
pdw committed
251 252
                break;

253 254 255 256
            case 'l':
                config_set_string("link-local", "true");
                break;

pdw's avatar
pdw committed
257
            case 'p':
258
                config_set_string("promiscuous", "true");
pdw's avatar
pdw committed
259 260
                break;

261
            case 'P':
262
                config_set_string("port-display", "on");
263 264
                break;

265 266
            case 'F':
                config_set_string("net-filter", optarg);
pdw's avatar
pdw committed
267
                break;
268
            
269 270 271 272
            case 'G':
                config_set_string("net-filter6", optarg);
                break;

273
            case 'm':
274
                config_set_string("max-bandwidth", optarg);
275 276
                break;

chris's avatar
chris committed
277
            case 'b':
pdw's avatar
pdw committed
278
                config_set_string("show-bars", "false");
chris's avatar
chris committed
279 280
                break;

281
            case 'B':
282
                config_set_string("bandwidth-unit", "bytes");
283 284
                break;

285 286 287 288
	    case 'u':
		config_set_string("bandwidth-unit", optarg);
		break;

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
            case 's':
                config_set_string("timed-output", optarg);
                break;

            case 't':
                config_set_string("no-curses", "true");
                break;

            case 'L':
                config_set_string("num-lines", optarg);
                break;

            case 'o':
                config_set_string("sort", optarg);
                break;

305 306 307 308
            case 'c':
                xfree(options.config_file);
                options.config_file = xstrdup(optarg);
                options.config_file_specified = 1;
309
                break;
310

pdw's avatar
pdw committed
311 312 313 314 315 316 317 318 319 320 321 322
            case '?':
                fprintf(stderr, "iftop: unknown option -%c\n", optopt);
                usage(stderr);
                exit(1);

            case ':':
                fprintf(stderr, "iftop: option -%c requires an argument\n", optopt);
                usage(stderr);
                exit(1);
        }
    }

pdw's avatar
pdw committed
323

pdw's avatar
pdw committed
324 325 326 327 328 329
    if (optind != argc) {
        fprintf(stderr, "iftop: found arguments following options\n");
        fprintf(stderr, "*** some options have changed names since v0.9 ***\n");
        usage(stderr);
        exit(1);
    }
pdw's avatar
pdw committed
330
}
pdw's avatar
pdw committed
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

/* options_config_get_string:
 * Gets a value from the config, sets *value to a copy of the value, if
 * found.  Leaves the option unchanged otherwise. */
int options_config_get_string(const char *name, char** value) {
    char *s;
    s = config_get_string(name);
    if(s != NULL) {
        *value = xstrdup(s);
        return 1;
    }
    return 0;
}

int options_config_get_bool(const char *name, int* value) {
    if(config_get_string(name)) {
        *value = config_get_bool(name);
        return 1;
    }
    return 0;
}

int options_config_get_int(const char *name, int* value) {
    if(config_get_string(name)) {
        config_get_int(name, value);
        return 1;
    }
    return 0;
}

int options_config_get_enum(char *name, config_enumeration_type* enumeration, int *result) {
    int i;
    if(config_get_string(name)) {
        if(config_get_enum(name, enumeration, &i)) {
            *result = i; 
            return 1;
        }
    }
    return 0;
}

int options_config_get_promiscuous() {
    if(config_get_string("promiscuous")) {
        options.promiscuous = config_get_bool("promiscuous");
        if(options.promiscuous) {
            /* User has explicitly requested promiscuous mode, so don't be
             * choosy */
            options.promiscuous_but_choosy = 0;
        }
        return 1;
    }
    return 0;
}

385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
int options_config_get_bw_unit() {
    int i;

    if (options_config_get_enum("bandwidth-unit", bandwidth_unit_enumeration,
				(int*)&options.bandwidth_unit))
	return 1;
    /* compatibility with use-bytes / -B */
    if (options_config_get_bool("use-bytes", &i)) {
	if (i)
	    options.bandwidth_unit = OPTION_BW_BYTES;
	else
	    options.bandwidth_unit = OPTION_BW_BITS;
	return 1;
    }
    return 0;
}

pdw's avatar
pdw committed
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
int options_config_get_bw_rate(char *directive, long long* result) {
    char* units;
    long long mult = 1;
    long long value;
    char *s;
    s = config_get_string(directive);
    if(s) {
        units = s + strspn(s, "0123456789");
        if(strlen(units) > 1) {
            fprintf(stderr, "Invalid units in value: %s\n", s);
            return 0;
        }
        if(strlen(units) == 1) {
            if(*units == 'k' || *units == 'K') {
                mult = 1024;
            }
            else if(*units == 'm' || *units == 'M') {
                mult = 1024 * 1024;
            }
            else if(*units == 'g' || *units == 'G') {
                mult = 1024 * 1024 * 1024;
            }
            else if(*units == 'b' || *units == 'B') {
                /* bits => mult = 1 */
            }
            else {
                fprintf(stderr, "Invalid units in value: %s\n", s);
                return 0;
            }
        }
        *units = '\0';
        if(sscanf(s, "%lld", &value) != 1) {
            fprintf(stderr, "Error reading rate: %s\n", s);
        }
        options.max_bandwidth = value * mult;
        return 1;
    }
    return 0;
}

/*
 * Read the net filter option.  
 */
int options_config_get_net_filter() {
    char* s;
    s = config_get_string("net-filter");
    if(s) {
        char* mask;

451 452
        options.netfilter = 0;

pdw's avatar
pdw committed
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
        mask = strchr(s, '/');
        if (mask == NULL) {
            fprintf(stderr, "Could not parse net/mask: %s\n", s);
            return 0;
        }
        *mask = '\0';
        mask++;
        if (inet_aton(s, &options.netfilternet) == 0) {
            fprintf(stderr, "Invalid network address: %s\n", s);
            return 0;
        }
        /* Accept a netmask like /24 or /255.255.255.0. */
        if (mask[strspn(mask, "0123456789")] == '\0') {
            /* Whole string is numeric */
            int n;
            n = atoi(mask);
            if (n > 32) {
470
                fprintf(stderr, "Invalid netmask length: %s\n", mask);
pdw's avatar
pdw committed
471 472 473 474 475 476 477 478 479 480 481 482 483 484
            }
            else {
                if(n == 32) {
                  /* This needs to be special cased, although I don't fully 
                   * understand why -pdw 
                   */
                  options.netfiltermask.s_addr = htonl(0xffffffffl);
                }
                else {
                  u_int32_t mm = 0xffffffffl;
                  mm >>= n;
                  options.netfiltermask.s_addr = htonl(~mm);
                }
            }
485
            options.netfilter = 1;
pdw's avatar
pdw committed
486
        } 
487 488 489 490 491 492 493
        else {
            if (inet_aton(mask, &options.netfiltermask) != 0)
                options.netfilter = 1;
            else {
                fprintf(stderr, "Invalid netmask: %s\n", s);
                return 0;
            }
pdw's avatar
pdw committed
494 495 496 497 498 499 500
        }
        options.netfilternet.s_addr = options.netfilternet.s_addr & options.netfiltermask.s_addr;
        return 1;
    }
    return 0;
}

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
/*
 * Read the net filter IPv6 option.  
 */
int options_config_get_net_filter6() {
    char* s;
    int j;

    s = config_get_string("net-filter6");
    if(s) {
        char* mask;

        options.netfilter6 = 0;

        mask = strchr(s, '/');
        if (mask == NULL) {
            fprintf(stderr, "Could not parse IPv6 net/prefix: %s\n", s);
            return 0;
        }
        *mask = '\0';
        mask++;
        if (inet_pton(AF_INET6, s, &options.netfilter6net) == 0) {
            fprintf(stderr, "Invalid IPv6 network address: %s\n", s);
            return 0;
        }
        /* Accept prefix lengths and address expressions. */
        if (mask[strspn(mask, "0123456789")] == '\0') {
            /* Whole string is numeric */
            unsigned int n;

            n = atoi(mask);
            if (n > 128 || n < 1) {
                fprintf(stderr, "Invalid IPv6 prefix length: %s\n", mask);
            }
            else {
                int bl, rem;
536 537
                const uint8_t mm = 0xff;
                uint8_t part = mm;
538

539 540 541
                bl = n / 8;
                rem = n % 8;
                part <<= 8 - rem;
542
                for (j=0; j < bl; ++j)
543 544
                    options.netfilter6mask.s6_addr[j] = mm;

545
                if (rem > 0)
546
                    options.netfilter6mask.s6_addr[bl] = part;
547
                options.netfilter6 = 1;
548
              }
549 550 551 552 553 554 555 556 557 558
        }
        else {
            if (inet_pton(AF_INET6, mask, &options.netfilter6mask) != 0)
                options.netfilter6 = 1;
            else {
                fprintf(stderr, "Invalid IPv6 netmask: %s\n", s);
                return 0;
            }
        }
        /* Prepare any comparison by masking the provided filtered net. */
559 560
        for (j=0; j < 16; ++j)
            options.netfilter6net.s6_addr[j] &= options.netfilter6mask.s6_addr[j];
561 562 563 564 565

        return 1;
    }
    return 0;
}
pdw's avatar
pdw committed
566 567 568 569 570 571 572 573 574 575

void options_make() {
    options_config_get_string("interface", &options.interface);
    options_config_get_bool("dns-resolution", &options.dnsresolution);
    options_config_get_bool("port-resolution", &options.portresolution);
    options_config_get_string("filter-code", &options.filtercode);
    options_config_get_bool("show-bars", &options.showbars);
    options_config_get_promiscuous();
    options_config_get_bool("hide-source", &options.aggregate_src);
    options_config_get_bool("hide-destination", &options.aggregate_dest);
576
    options_config_get_bw_unit();
pdw's avatar
pdw committed
577 578 579 580 581 582
    options_config_get_enum("sort", sort_enumeration, (int*)&options.sort);
    options_config_get_enum("line-display", linedisplay_enumeration, (int*)&options.linedisplay);
    options_config_get_bool("show-totals", &options.show_totals);
    options_config_get_bool("log-scale", &options.log_scale);
    options_config_get_bw_rate("max-bandwidth", &options.max_bandwidth);
    options_config_get_enum("port-display", showports_enumeration, (int*)&options.showports);
pdw's avatar
pdw committed
583
    options_config_get_string("screen-filter", &options.screenfilter);
584
    options_config_get_bool("link-local", &options.link_local);
585 586 587
    options_config_get_int("timed-output", &options.timed_output);
    options_config_get_bool("no-curses", &options.no_curses);
    options_config_get_int("num-lines", &options.num_lines);
pdw's avatar
pdw committed
588
    options_config_get_net_filter();
589
    options_config_get_net_filter6();
pdw's avatar
pdw committed
590
};