src/mz.h

   1 /*
   2  * Mausezahn - A fast versatile traffic generator
   3  * Copyright (C) 2008-2010 Herbert Haas
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU General Public License version 2 as published by the
   7  * Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  12  * details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, see http://www.gnu.org/licenses/gpl-2.0.html
  16  *
  17 */
  18
  19
  20
  21 #ifndef __MAUSEZAHN__
  22 #define __MAUSEZAHN__
  23
  24 #define _GNU_SOURCE
  25
  26 #include <libnet.h>
  27 #include <pcap/pcap.h>
  28 #include <stdio.h>
  29 #include <unistd.h>
  30 #include <string.h>
  31 #include <stdlib.h>
  32 #include <errno.h>
  33 #include <limits.h>
  34 #include <sys/time.h>
  35 #include <time.h>
  36 #include <signal.h>
  37 #include <sys/types.h>
  38 #include <sys/socket.h>
  39 #include <arpa/inet.h>
  40 #include <sys/ioctl.h>
  41 #include <netinet/in.h>
  42 #include <net/if.h>
  43 #include <stdarg.h>
  44 #include <math.h>
  45
  46 //#include <ctype.h>
  47
  48
  49 ////////////////////////////////////////////////////////////////////////////////////////////////////////////
  50 //
  51 //
  52 #define MAUSEZAHN_VERSION "Mausezahn 0.40 - (C) 2007-2010 by Herbert Haas - http://www.perihel.at/sec/mz/"
  53 #define MAUSEZAHN_VERSION_SHORT "0.40"
  54 //
  55 //
  56 ////////////////////////////////////////////////////////////////////////////////////////////////////////////
  57
  58
  59 // "Dies ist ein schrecklicher Ort."
  60
  61 #define MZ_DEFAULT_CONFIG_PATH "/etc/mausezahn/"   // see also mz_default_config_path below
  62 #define MZ_DEFAULT_LOG_PATH "/var/log/mausezahn/"  // see also mz_default_log_path below
  63
  64 #define SLEEP usleep               // The sleep function to use. Consider 'nanosleep' in future.
  65 #define DEFAULT_DELAY 0
  66 #define PCAP_READ_TIMEOUT_MSEC 1   // The read timeout for pcap_open_live()
  67 #define MZ_MAX_DEVICES 10          // Max number of network devices supported
  68 #define MAX_PAYLOAD_SIZE 3*8192
  69 #define MAX_DNS_NAME 256
  70 #define MAX_8021Q_TAGS 16
  71 #define TIME_COUNT_MAX 10000       // the size of the timestamp arrays timeRX and timeTX upon creation
  72 #define TIME_COUNT 100             // the default used-size of the timestamp arrays timeRX and timeTX
  73 #define MAX_DATA_BLOCKS 1000       // how many data blocks of size TIME_COUNT-1 should be written per file
  74 #define MAXBYTES_TO_READ 1500      // how many bytes the pcap routine should read from net
  75 #define RCV_RTP_MAX_BAR_WIDTH 500  // max line-width printed in BAR mode (see rcv_rtp.c)
  76
  77 #define ETH_SRC 1   // These are only some symbols used by some functions. (Don't touch)
  78 #define ETH_DST 2   // These are only some symbols used by some functions.
  79 #define SRC_PORT 1  // These are only some symbols used by some functions.
  80 #define DST_PORT 2  // These are only some symbols used by some functions.
  81
  82 #define TEST fprintf(stderr, "HERE at line %i in file %s\n", __LINE__,__FILE__ ); fflush(stderr);
  83
  84
  85 // -----  PCAP-specific definitions: ---------------------
  86 #define IPADDRSIZE 46
  87
  88
  89 int MZ_SIZE_LONG_INT;
  90
  91 char mz_default_config_path[256];
  92 char mz_default_log_path[256];
  93
  94
  95 struct arp_table_struct {
  96         int               index;     // an entry index (1, 2, ...) for easier user access
  97         u_int8_t          sa[6];     // sent by this MAC SA
  98         u_int8_t          smac[6];   // announced MAC
  99         u_int8_t          smac_prev[6];   // previously announced MAC
 100         u_int8_t          sip[4];    // announced IP
 101         unsigned long int uni_rq;    // count unidirectional ARP requests for this IP
 102         unsigned long int bc_resp;   // count broadcast ARP responses for this IP
 103         unsigned long int uni_resp;  // count normal (unidir) ARP responses for this IP
 104         unsigned long int changed;   // count how often the MAC address has changed!
 105         int               locked;    // 1=this entry cannot be overidden anymore
 106         int               dynamic;   // 1=learned dynamically, 0=configured by user
 107         int               flags;     // anomaly information (length anomaly: bit 0, sa!=smac: bit 1 , ...)
 108         int               gw;        // 1=Default GW
 109         char              when[10];  // human readable timestamp (e. g. "11:42:53")
 110         u_int32_t sec, nsec;         // timestamp of last ARP response
 111         u_int32_t sec_prev, nsec_prev;         // timestamp of previous ARP response
 112         //-----------------//
 113         struct arp_table_struct *next;
 114 };
 115
 116 // Device list
 117 struct device_struct
 118 {
 119         char       dev[16];               // Device name
 120         int        index;                 // Device index (assigned by OS)
 121         int        phy;                   // 1 if physical, 0 if not (e. g. loopback)
 122         int        mtu;
 123         int        cli;                   // if set to 1 then the CLI connection must terminate here
 124         int        mgmt_only;             // if set to 1 then no data traffic is allowed through that interface
 125         // ---- MAC addresses ----
 126         u_int8_t   mac[6];                // Real MAC address
 127         u_int8_t   mac_mops[6];           // MAC address to be used
 128         // ---- IP related -----
 129         char       ip_str[IPADDRSIZE+1];  // Real IP address as string in dotted decimal notation
 130         u_int8_t   ip[4];                 // Real IP address
 131         u_int8_t   net[4];                // Real network
 132         u_int8_t   mask[4];               // Real mask
 133         u_int8_t   ip_mops[4];            // IP address to be used
 134         // ---- Default Gateway per interface:
 135         u_int8_t   mac_gw[6];             // MAC address of default gateway
 136         u_int8_t   ip_gw[4];              // IP address of default gateway
 137         // ---- various device-specific handles ----
 138         pthread_t  arprx_thread;
 139         struct pcap     *p_arp;                  // pcap handle
 140         struct arp_table_struct *arp_table; // dedicated ARP table
 141         int        ps;                    // packet socket
 142 } device_list[MZ_MAX_DEVICES];
 143
 144 int device_list_entries;
 145
 146
 147 #pragma pack(1)
 148 struct struct_ethernet
 149 {
 150       u_int8_t   eth_da[6];
 151       u_int8_t   eth_sa[6];
 152       u_int16_t  eth_type;
 153 };
 154
 155 struct struct_arp
 156 {
 157    u_int16_t arp_hrd;  // hardware address format
 158    u_int16_t arp_pro;  // protocol address format
 159    u_int8_t  arp_hln;  // hardware address length
 160    u_int8_t  arp_pln;  // protocol address length
 161    u_int16_t arp_op;   // ARP operation type
 162    u_int8_t  arp_smac[6];  // sender's hardware address
 163    u_int8_t  arp_sip[4];  // sender's protocol address
 164    u_int8_t  arp_tmac[6];  // target hardware address
 165    u_int8_t  arp_tip[4];  // target protocol address
 166 };
 167
 168
 169
 170 //#pragma pack(1)
 171 struct struct_ip
 172 {
 173    u_int8_t
 174      hlen :4,
 175      ver  :4;
 176    u_int8_t
 177      tos;
 178    u_int16_t
 179      len;
 180
 181    u_int16_t
 182      id,
 183      offset;   // flags and fragment offset field
 184
 185    u_int8_t
 186      ttl,
 187      proto;
 188    u_int16_t
 189      sum;
 190
 191    u_int8_t  src[4];
 192    u_int8_t  dst[4];
 193 };
 194
 195 //#pragma pack(1)
 196 struct struct_udp {
 197         u_int16_t
 198                 sp,
 199                 dp,
 200                 len,
 201                 sum;
 202 };
 203
 204 //#pragma pack(1)
 205 struct struct_rtp {
 206         u_int8_t
 207                 byte1,
 208                 ptype;
 209         u_int16_t
 210                 sqnr;
 211         u_int32_t
 212                 timestamp,  // official timestamp, created by codecs
 213                 ssrc;
 214                 //   csrc,      // only used by mixers
 215         u_int16_t
 216                 ext_id,
 217                 ext_len;
 218         u_int32_t
 219                 time_sec,
 220                 time_nsec,
 221                 time_sec2,
 222                 time_nsec2;
 223 };
 224
 225 // ---------End of PCAP-specific definitions---------------
 226
 227
 228
 229
 230 // ************************************
 231 //
 232 //  Global variables
 233 //
 234 // ************************************
 235
 236 enum operating_modes
 237 {
 238    BYTE_STREAM,
 239      ARP,
 240      BPDU,
 241      IP,
 242      ICMP,
 243      ICMP6,
 244      UDP,
 245      TCP,
 246      DNS,
 247      CDP,
 248      RTP,
 249      RX_RTP,
 250      SYSLOG,
 251      LLDP
 252 } mode;
 253
 254
 255 int ipv6_mode;
 256 int quiet;           // don't even print 'important standard short messages'
 257 int verbose;         // report character
 258 int simulate;        // if 1 then don't really send frames
 259
 260 char path[256];
 261 char filename[256];
 262 FILE *fp, *fp2;             // global multipurpose file pointer
 263
 264 long double total_d;
 265 clock_t mz_start, mz_stop;
 266
 267 enum rtp_display_mode {
 268         BAR, NCURSES, TEXT
 269 } rtp_dm;
 270
 271
 272 int mz_rand;
 273 int bwidth;
 274
 275 struct mz_timestamp {
 276         u_int32_t sec;
 277         u_int32_t nsec;
 278 };
 279
 280 struct mz_timestamp
 281         tv,
 282         timeTX[TIME_COUNT_MAX],
 283         timeRX[TIME_COUNT_MAX];
 284
 285 int32_t
 286   time0,
 287   jitter_rfc,
 288   jitter[TIME_COUNT_MAX];
 289
 290 int
 291   rtp_log,
 292   time0_flag,        // If set then time0 has valid data
 293   sqnr0_flag;
 294
 295 u_int8_t
 296   mz_ssrc[4];     // holds RTP stream identifier for rcv_rtp()
 297
 298 u_int16_t
 299   sqnr_cur,
 300   sqnr_last,
 301   sqnr_next;
 302
 303 u_int32_t
 304   drop,    // packet drop count
 305   dis,     // packet disorder count
 306   gind,      // a global index to run through deltaRX, deltaTX, and jitter
 307   gind_max,  // the amount of entries used in the (ugly oversized) arrays; per default set to TIME_COUNT
 308   gtotal;    // counts number of file write cycles (see "got_rtp_packet()")
 309
 310
 311 char rtp_filter_str[64];
 312
 313 struct tx_struct
 314 {
 315    // Management issues for TX
 316    char device[16];           // every packet could be sent through a different device
 317    int  packet_mode;          // 0 means use LIBNET_LINK_ADV, 1 means LIBNET_RAW4
 318    unsigned int count;        // 0 means infinite, 1 is default
 319    unsigned int delay;        // Delay in microseconds, 0 means no delay (default)
 320    char arg_string[MAX_PAYLOAD_SIZE];  // Argument-string when -t is used
 321
 322    // Ethernet and 802.3 parameters
 323    int eth_params_already_set; // if set to 1 then send_eth should only send the frame
 324    u_int8_t  eth_mac_own[6];  // Contains own interface MAC if needed by some modules
 325    char      eth_dst_txt[32]; // Text version of eth_dst (or keyword such as 'rand')
 326    u_int8_t  eth_dst[6];
 327    int       eth_dst_rand;    // 1 if random
 328    char      eth_src_txt[32]; // Text version of eth_src (or keyword such as 'rand')
 329    u_int8_t  eth_src[6];
 330    int       eth_src_rand;    // 1 if random
 331    u_int16_t eth_type;
 332    u_int16_t eth_len;
 333    u_int8_t  eth_payload[MAX_PAYLOAD_SIZE];
 334    u_int32_t eth_payload_s;
 335    unsigned int padding;
 336
 337    // CDP parameters
 338    u_int8_t
 339      cdp_version,
 340      cdp_ttl,
 341      cdp_payload[MAX_PAYLOAD_SIZE],
 342      cdp_tlv_id[2048];               // The ID is the only required TLV
 343    u_int16_t
 344      cdp_sum;
 345    u_int32_t
 346      cdp_tlv_id_len,
 347      cdp_payload_s;
 348
 349    // 802.1Q VLAN Tag
 350    int       dot1Q;           // 1 if specified
 351    char      dot1Q_txt[32];   // contains 802.1p(CoS) and VLAN-ID ("5:130" or only VLAN "130")
 352    u_int8_t  dot1Q_CoS;
 353    u_int16_t dot1Q_vlan;
 354    u_int8_t  dot1Q_header[256]; // Contains the complete 802.1Q/P headers (but NOT the Ethernet header!)
 355    u_int8_t  dot1Q_header_s;
 356    int       dot1Q_at_least_two_headers; // If '1' then we have at least QinQ (or more VLAN tags)
 357
 358    // ASCII PAYLOAD
 359    int       ascii;           // 1 if specified
 360    u_int8_t  ascii_payload[MAX_PAYLOAD_SIZE];
 361
 362    // HEX PAYLOAD
 363    u_int8_t  hex_payload[MAX_PAYLOAD_SIZE];
 364    u_int32_t hex_payload_s;   // >0 if hex payload is specified
 365
 366    // MPLS Parameters
 367    char      mpls_txt[128];   // contains MPLS parameters (label, exp, S, TTL)
 368    char      mpls_verbose_string[1024]; // contains all labels for print_frame_details()
 369    int       mpls;            // 1 if specified
 370    u_int32_t mpls_label;
 371    u_int8_t  mpls_exp;
 372    u_int8_t  mpls_bos;
 373    u_int8_t  mpls_ttl;
 374
 375    // IP parameters
 376    u_int32_t ip_src;          // has always network byte order(!)
 377    struct libnet_in6_addr ip6_src;
 378    char      ip_src_txt[256];
 379    int       ip_src_rand;     // if set to 1 then SA should be random
 380    u_int32_t ip_src_h;        // mirror of ip_src (NOT network byte order => easy to count)
 381    u_int32_t ip_src_start;    // start of range (NOT network byte order => easy to count)
 382    u_int32_t ip_src_stop;     // stop of range  (NOT network byte order => easy to count)
 383    int       ip_src_isrange;  // if set to 1 then the start/stop values above are valid.
 384    u_int32_t ip_dst;          // has always network byte order(!)
 385    struct libnet_in6_addr ip6_dst;
 386    char      ip_dst_txt[256];
 387    u_int32_t ip_dst_h;        // mirror of ip_dst (NOT network byte order => easy to count)
 388    u_int32_t ip_dst_start;    // start of range (NOT network byte order => easy to count)
 389    u_int32_t ip_dst_stop;     // stop of range  (NOT network byte order => easy to count)
 390    int       ip_dst_isrange;  // if set to 1 then the start/stop values above are valid.
 391    u_int16_t
 392      ip_len,
 393      ip_id,
 394      ip_frag,                 // Flags and Offset !!!
 395      ip_sum;
 396    u_int8_t
 397      ip_tos,
 398      ip_ttl,
 399      ip6_rtype,
 400      ip6_segs,
 401      ip_proto;
 402    u_int8_t
 403      ip_option[1024],
 404      ip_payload[MAX_PAYLOAD_SIZE];
 405    u_int32_t
 406      ip_flow,
 407      ip6_id,
 408      ip_option_s,
 409      ip_payload_s;
 410
 411    // ICMP
 412    char
 413      icmp_verbose_txt[256]; // used for verbose messages in send.c
 414    u_int8_t
 415      icmp_type,
 416      icmp_code;
 417    u_int16_t icmp_ident;    // ATTENTION: libnet.h already #defines 'icmp_id', 'icmp_sum', and 'icmp_num'
 418    u_int16_t  icmp_chksum;  //            therefore I needed a renaming here -- be careful in future...
 419    u_int16_t  icmp_sqnr;    //
 420    u_int32_t
 421      icmp_gateway,
 422      icmp_payload_s;
 423    u_int8_t
 424      icmp_payload[MAX_PAYLOAD_SIZE];
 425
 426    // General L4 parameters:
 427    char *layer4;
 428    u_int16_t
 429      sp, dp,
 430      sp_start, sp_stop,
 431      dp_start, dp_stop;
 432    int
 433      sp_isrange,               // if set to 1 then start/stop values above are valid
 434      dp_isrange;               // if set to 1 then start/stop values above are valid
 435
 436    // UDP parameters
 437    u_int16_t
 438      udp_len,                  // includes header size (8 bytes)
 439      udp_sum;
 440    u_int8_t
 441      udp_payload[MAX_PAYLOAD_SIZE];
 442    u_int32_t
 443      udp_payload_s;
 444
 445    // TCP parameters
 446    u_int32_t
 447      tcp_seq,
 448      tcp_seq_start,
 449      tcp_seq_stop,                  // is always set! Usually seq_start = seq_stop (=no range)
 450      tcp_seq_delta,                 // Also used instead of an 'isrange' variable
 451      tcp_ack;
 452    u_int8_t
 453      tcp_offset,
 454      tcp_control;
 455    u_int16_t
 456      tcp_win,
 457      tcp_sum,
 458      tcp_urg,
 459      tcp_len;                       // only needed by libnet and must include header size
 460    u_int8_t
 461      tcp_payload[MAX_PAYLOAD_SIZE];
 462    u_int32_t
 463      tcp_sum_part,
 464      tcp_payload_s;
 465
 466    // RTP parameters
 467    u_int32_t
 468      rtp_sqnr,
 469      rtp_stmp;
 470
 471 } tx;  // NOTE: tx elements are considered as default values for MOPS
 472
 473
 474
 475
 476
 477 u_int8_t  gbuf[MAX_PAYLOAD_SIZE];  // This is only a generic global buffer to handover data more easily
 478 u_int32_t gbuf_s;                  //
 479
 480
 481 // ************************************
 482 //
 483 //  Prototypes: General Tools
 484 //
 485 // ************************************
 486
 487 void clean_up(int sig);
 488 int reset();
 489 void usage();
 490 int getopts(int argc, char *argv[]);
 491 int getarg(char *str, char *arg_name, char *arg_value);
 492 unsigned long int str2int(char *str);       // converts "65535" to 65535
 493 unsigned long long int str2lint(char *str); // same but allows 64-bit integers
 494 unsigned long int xstr2int(char *str);      // converts "ffff" to 65535
 495 unsigned long long int xstr2lint(char *str);     // same but allows 64-bit integers
 496 int mz_strisbinary(char *str);
 497 int mz_strisnum(char *str);
 498 int mz_strishex(char *str);
 499 int str2bin8 (char *str);
 500 long int str2bin16 (char *str);
 501 int char2bits (char c, char *str);
 502 int mz_strcmp(char* usr, char* str, int min);
 503 int mz_tok(char * str, char * delim, int anz, ...);
 504 int delay_parse (struct timespec *t, char *a, char *b);
 505
 506 // ************************************
 507 //
 508 //  Prototypes: Layer1
 509 //
 510 // ************************************
 511
 512 int            send_eth(void);
 513 libnet_ptag_t  create_eth_frame (libnet_t *l, libnet_ptag_t  t3, libnet_ptag_t  t4);
 514
 515 // ************************************
 516 //
 517 //   Prototypes: Layer 2
 518 //
 519 // ************************************
 520
 521 int send_arp (void);
 522 int send_bpdu (void);
 523 int send_cdp (void);
 524
 525 // ************************************
 526 //
 527 //   Prototypes: Layer 3
 528 //
 529 // ************************************
 530
 531
 532 libnet_t*      get_link_context(void);
 533 libnet_ptag_t  create_ip_packet (libnet_t *l);
 534 libnet_ptag_t  create_ip6_packet (libnet_t *l);
 535 int            send_frame (libnet_t *l, libnet_ptag_t  t3, libnet_ptag_t  t4);
 536
 537
 538
 539 // ************************************
 540 //
 541 //   Prototypes: Layer 4
 542 //
 543 // ************************************
 544 libnet_ptag_t  create_udp_packet (libnet_t *l);
 545 libnet_ptag_t  create_icmp_packet (libnet_t *l);
 546 libnet_ptag_t  create_icmp6_packet (libnet_t *l);
 547 libnet_ptag_t  create_tcp_packet (libnet_t *l);
 548
 549
 550 // ************************************
 551 //
 552 //   Prototypes: Layer 7
 553 //
 554 // ************************************
 555 int  create_dns_packet (void);
 556 int  create_rtp_packet(void);
 557 int create_syslog_packet(void);
 558
 559 // ************************************
 560 //
 561 //   Prototypes: Helper functions for
 562 //               byte manipulation,
 563 //               address conversion,
 564 //               etc
 565 //
 566 // ************************************
 567
 568 // Converts MAC address specified in str into u_int8_t array
 569 // Usage: str2hex_mac ( "00:01:02:aa:ff:ee", src_addr )
 570 int str2hex_mac (char* str, u_int8_t *addr);
 571
 572 // Converts ascii hex values (string) into integer array, similarly as above but for any size.
 573 // Example: "1a 00:00-2f" => {26, 0, 0, 47}
 574 // Note: apply any improvements here and prefer this function in future!
 575 // Return value: Number of converted elements (=length of array)
 576 int str2hex (char* str, u_int8_t *hp, int n);
 577
 578 // Converts ascii numbers (string) into integer array
 579 // Every byte can be specified as integers {0..255}
 580 // For example "192.16.1.1" will be converted to {C0, 10, 01, 01}
 581 int num2hex(char* str, u_int8_t *hp);
 582
 583 // Convert array of integers into string of hex. Useful for verification messages.
 584 // Example: {0,1,10} => "00-01-0A"
 585 // Usage: bs2str ( src_mac, src_mac_txt, 6 )
 586 int bs2str (u_int8_t *bs, char* str, int len);
 587
 588 // Extract contiguous sequence of bytes from an array. First element has index 1 !!!
 589 // Usage: getbytes (bs, da, 1, 6);
 590 int getbytes(u_int8_t *source, u_int8_t *target, int from, int to);
 591
 592 // For any IP address given in 'dotted decimal' returns an unsigned 32-bit integer.
 593 // Example: "192.168.0.1" => 3232235521
 594 // Note: Result is in LITTLE ENDIAN but usually with IP you need BIG ENDIAN, see next.
 595 u_int32_t str2ip32 (char* str);
 596
 597 // For any IP address given in 'dotted decimal' into an unsigned 32-bit integer
 598 // This version does the same as str2ip32() but in BIG ENDIAN.
 599 // Note: With netlib you need this one, not the previous function.
 600 u_int32_t str2ip32_rev (char* str);
 601
 602 // Converts a 2-byte value (e. g. a EtherType field)
 603 // into a nice string using hex notation.
 604 // Useful for verification messages.
 605 // Example: type2str (tx.eth_type, msg) may result in msg="08:00"
 606 // Return value: how many hex digits have been found.
 607 int type2str(u_int16_t type, char *str);
 608
 609
 610 // Parses string 'arg' for an IP range and finds start and stop IP addresses.
 611 // Return value: 0 upon success, 1 upon failure.
 612 //
 613 // NOTE: The results are written in the following variables:
 614 //
 615 //   (u_int32_t) tx.ip_dst_start    ... contains start value
 616 //   (u_int32_t) tx.ip_dst_stop     ... contains stop value
 617 //   int         tx.ip_dst_isrange  ... set to 1 if above values valid
 618 //
 619 // The other function does the same for the source address!
 620 //
 621 // Possible range specifications:
 622 //
 623 //   1) 192.168.0.0-192.168.0.12
 624 //   2) 10.2.11.0-10.55.13.2
 625 //   3) 172.18.96.0/19
 626 //
 627 // That is:
 628 //
 629 //   FIRST detect a range by scanning for the "-" OR "/" chars
 630 //   THEN determine start and stop value and store them as normal unsigned integers
 631 //
 632 int get_ip_range_dst (char *arg);
 633 int get_ip_range_src (char *arg);
 634
 635 // Sets a random SA for a given IP packet.
 636 // Return value: 0 upon success, 1 upon failure
 637 //
 638 int set_rand_SA (libnet_t *l, libnet_ptag_t t3);
 639
 640 // Scans tx.eth_dst_txt or tx.eth_src_txt and sets the corresponding
 641 // MAC addresses (tx.eth_dst or tx.eth_src) accordingly.
 642 // Argument: What string should be checked, ETH_SRC or ETH_DST.
 643 // Return value:
 644 //       0 when a MAC address has been set or
 645 //       1 upon failure.
 646 // Currently eth_src|dst_txt can be:
 647 //   'rand', 'own', 'bc'|'bcast', 'stp', 'pvst',
 648 //   or a real mac address.
 649 //
 650 int check_eth_mac_txt(int src_or_dst);
 651
 652 // Scans argument for a port number or range
 653 // and sets the corresponding values in the
 654 // tx struct.
 655 //
 656 // Arguments: sp_or_dp is either SRC_PORT or DST_PORT
 657 // Return value: 0 on success, 1 upon failure
 658 //
 659 int get_port_range (int sp_or_dp, char *arg);
 660
 661 // Return a 4-byte unsigned int random number
 662 u_int32_t  mz_rand32 (void);
 663
 664 // Scans argument for TCP flags and sets
 665 // tx.tcp_control accordingly.
 666 //
 667 // Valid keywords are: fin, syn, rst, psh, ack, urg, ecn, cwr
 668 // Valid delimiters are: | or + or -
 669 // Return value: 0 on success, 1 upon failure
 670 //
 671 int get_tcp_flags (char*  flags);
 672
 673 // Scans string 'params' for MPLS parameters
 674 // and sets tx.mpls_* accordingly.
 675 //
 676 // CLI Syntax Examples:
 677 //
 678 // -M help       .... shows syntax
 679 //
 680 // -M 800        .... label=800
 681 // -M 800:S      .... label=800 and BOS flag set
 682 // -M 800:S:64   .... label=800, BOS, TTL=64
 683 // -M 800:64:S   .... same
 684 // -M 64:77      .... label=64, TTL=77
 685 // -M 64:800     .... INVALID
 686 // -M 800:64     .... label=800, TTL=64
 687 // -M 800:3:S:64 .... additionall the experimental bits are set (all fields required!)
 688 //
 689 // Note: S = BOS(1), s = NOT-BOS(0)
 690 //
 691 // Valid delimiters: :-.,+
 692 // Return value: 0 on success, 1 upon failure
 693 int get_mpls_params(char *params);
 694
 695 // Parses str for occurence of character or sequence ch.
 696 // Returns number of occurences
 697 int exists(char* str, char* ch);
 698
 699
 700 // Applies another random Ethernet source address to a given Ethernet-PTAG.
 701 // (The calling function should check 'tx.eth_src_rand' whether the SA
 702 // should be randomized.)
 703 int update_Eth_SA(libnet_t *l, libnet_ptag_t t);
 704
 705
 706 // Update timestamp and sequence number in the RTP header.
 707 // The actual RTP message is stored in tx.udp_payload.
 708 int update_RTP(libnet_t *l, libnet_ptag_t t);
 709
 710
 711 // Applies another SOURCE IP address,
 712 //  - either a random one (tx.ip_src_rand==1)
 713 //  - or from a specified range (tx.ip_src_isrange==1)
 714 // to a given IP-PTAG.
 715 //
 716 // Note: tx.ip_src MUST be already initialized with tx.ip_src_start.
 717 //       This is done by 'get_ip_range_src()' in tools.c.
 718 //
 719 // RETURNS '1' if tx.ip_src restarts
 720 int update_IP_SA (libnet_t *l, libnet_ptag_t t);
 721
 722
 723 // Applies another DESTINATION IP address from a specified range (tx.ip_dst_isrange==1)
 724 // to a given IP-PTAG.
 725 //
 726 // Note: tx.ip_dst MUST be already initialized with tx.ip_dst_start.
 727 //       This is done by 'get_ip_range_dst()' in tools.c.
 728 //
 729 // RETURN VALUE: '1' if tx.ip_dst restarts
 730 int update_IP_DA(libnet_t *l, libnet_ptag_t t);
 731
 732
 733 // Applies another DESTINATION PORT from a specified range to a given UDP- or TCP-PTAG.
 734 //
 735 // Note: tx.dp MUST be already initialized with tx.dp_start
 736 //       This is done by 'get_port_range()' in tools.c.
 737 //
 738 // RETURN VALUE: '1' if tx.dp restarts
 739 int update_DPORT(libnet_t *l, libnet_ptag_t t);
 740
 741
 742 // Applies another SOURCE PORT from a specified range to a given UDP- or TCP-PTAG.
 743 //
 744 // Note: tx.sp MUST be already initialized with tx.sp_start
 745 //       This is done by 'get_port_range()' in tools.c.
 746 //
 747 // RETURN VALUE: '1' if tx.sp restarts
 748 int update_SPORT(libnet_t *l, libnet_ptag_t t);
 749
 750
 751 // Applies another TCP SQNR from a specified range to a given TCP-PTAG
 752 //
 753 // RETURN VALUE: '1' if tx.txp_seq restarts
 754 //
 755 int update_TCP_SQNR(libnet_t *l, libnet_ptag_t t);
 756
 757 int update_ISUM(libnet_t *l, libnet_ptag_t t);
 758 int update_USUM(libnet_t *l, libnet_ptag_t t);
 759 int update_TSUM(libnet_t *l, libnet_ptag_t t);
 760
 761 //
 762 //
 763 int print_frame_details(void);
 764
 765
 766 // Calculates the number of frames to be sent.
 767 // Should be used as standard output except the
 768 // 'quiet' option (-q) has been specified.
 769 int complexity(void);
 770
 771
 772 // Purpose: Calculate time deltas of two timestamps stored in struct timeval.
 773 // Subtract the "struct timeval" values X and Y, storing the result in RESULT.
 774 // Return 1 if the difference is negative, otherwise 0.
 775 int timestamp_subtract (struct mz_timestamp *x,
 776                         struct mz_timestamp *y,
 777                         struct mz_timestamp *result);
 778
 779 void timestamp_add (struct mz_timestamp *x,
 780                     struct mz_timestamp *y,
 781                     struct mz_timestamp *result);
 782
 783 // Returns a human readable timestamp in the string result.
 784 // Optionally a prefix can be specified, for example if the
 785 // timestamp is part of a filename.
 786 //
 787 // Example:
 788 //    char myTimeStamp[128];
 789 //
 790 //    timestamp_human(myTimeStamp, NULL);
 791 //
 792 //    => "20080718_155521"
 793 //
 794 //    /* or with prefix */
 795 //
 796 //    timestamp_human(myTimeStamp, "MZ_RTP_jitter_");
 797 //
 798 //    => MZ_RTP_jitter_20080718_155521
 799 //
 800 int timestamp_human(char* result, const char* prefix);
 801
 802 // Returns a human readable timestamp in the string result.
 803 // Optionally a prefix can be specified, for example if the
 804 // timestamp is part of a filename.
 805 //
 806 // Example:
 807 //    char myTimeStamp[8];
 808 //
 809 //    timestamp_hms (myTimeStamp);
 810 //
 811 //    => "15:55:21"
 812 int timestamp_hms(char* result);
 813
 814 // Initialize the rcv_rtp process: Read user parameters and initialize globals
 815 int rcv_rtp_init(void);
 816
 817 // Defines the pcap handler and the callback function
 818 int rcv_rtp(void);
 819
 820 // Print current RFC-Jitter on screen
 821 void print_jitterbar (long int j, unsigned int d);
 822
 823 // Compares two 4-byte variables byte by byte
 824 // returns 0 if identical, 1 if different
 825 int compare4B (u_int8_t *ip1, u_int8_t *ip2);
 826
 827 // PURPOSE: Find usable network devices
 828 //
 829 // NOTE:
 830 //
 831 //  1. Ignores devices without IP address
 832 //  2. Ignores loopback (etc)
 833 //
 834 // RETURN VALUES:
 835 //
 836 //  0 if usable device found (device_list[] and tx.device set)
 837 //  1 if no usable device found
 838 //
 839 int lookupdev(void);
 840
 841
 842 // For a given device name, find out the following parameters:
 843 //
 844 //  - MTU
 845 //  - Network
 846 //  - Mask
 847 //  - Default GW (IP)
 848 //
 849 int get_dev_params (char *name);
 850
 851 // Handler function to do something when RTP messages are received
 852 void got_rtp_packet(u_char *args,
 853                     const struct pcap_pkthdr *header, // statistics about the packet (see 'struct pcap_pkthdr')
 854                     const u_char *packet);            // the bytestring sniffed
 855
 856
 857 // Check if current system supports the nanosecond timer functions.
 858 // Additionally, measure the precision.
 859 // This function should be called upon program start.
 860 //
 861 int check_timer(void);
 862
 863 // This is the replacement for gettimeofday() which would result in 'jumps' if
 864 // the system clock is adjusted (e. g. via a NTP process) and finally the jitter
 865 // measurement would include wrong datapoints.
 866 //
 867 // Furthermore the function below utilizes the newer hi-res nanosecond timers.
 868 void getcurtime (struct mz_timestamp *t);
 869
 870 // Only print out the help text for the 02.1Q option
 871 void print_dot1Q_help(void);
 872
 873 // Determines ip and mac address of specified interface 'ifname'
 874 // Caller must provide an unsigned char ip[4], mac[6]
 875 //
 876 int get_if_addr (char *ifname, unsigned char *ip, unsigned char *mac);
 877
 878 // Takes filename and prepends valid configuration/logging directory
 879 // NOTE: filename is overwritten and must be big enough to hold full path!
 880 int getfullpath_cfg (char *filename);
 881 int getfullpath_log (char *filename);
 882
 883 // A safer replacement for strncpy which ensures \0-termination
 884 char * mz_strncpy(char *dest, const char *src, size_t n);
 885
 886 // Helper function to count the number of arguments
 887 // in the Mausezahn argument string (comma separated args)
 888 // RETURN VALUE: Number of arguments
 889 int number_of_args (char *str);
 890
 891 int arptable_add(struct device_struct *dev,
 892                  u_int8_t *sa,
 893                  u_int8_t *da,
 894                  u_int8_t *smac,
 895                  u_int8_t *sip,
 896                  u_int32_t sec,
 897                  u_int32_t nsec);
 898
 899 // Validate ARP requests
 900 int arpwatch(struct device_struct *dev,
 901              u_int8_t *sa,
 902              u_int8_t *da,
 903              u_int8_t *smac,
 904              u_int8_t *sip,
 905              u_int8_t *tmac,
 906              u_int8_t *tip,
 907              u_int32_t sec,
 908              u_int32_t nsec);
 909
 910
 911 #endif