The Tcpdump Group git mirrors - tcpdump/blob - netdissect.h

   1 /*
   2  * Copyright (c) 1988-1997
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Copyright (c) 1998-2004  Michael Richardson <mcr@tcpdump.org>
   6  *      The TCPDUMP project
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that: (1) source code distributions
  10  * retain the above copyright notice and this paragraph in its entirety, (2)
  11  * distributions including binary code include the above copyright notice and
  12  * this paragraph in its entirety in the documentation or other materials
  13  * provided with the distribution, and (3) all advertising materials mentioning
  14  * features or use of this software display the following acknowledgement:
  15  * ``This product includes software developed by the University of California,
  16  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  17  * the University nor the names of its contributors may be used to endorse
  18  * or promote products derived from this software without specific prior
  19  * written permission.
  20  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  21  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  22  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  23  *
  24  * @(#) $Header: /tcpdump/master/tcpdump/netdissect.h,v 1.27 2008-08-16 11:36:20 hannes Exp $ (LBL)
  25  */
  26
  27 #ifndef netdissect_h
  28 #define netdissect_h
  29
  30 #ifdef HAVE_OS_PROTO_H
  31 #include "os-proto.h"
  32 #endif
  33 #include <sys/types.h>
  34
  35 #ifndef HAVE___ATTRIBUTE__
  36 #define __attribute__(x)
  37 #endif
  38
  39 /* snprintf et al */
  40
  41 #include <stdarg.h>
  42
  43 #if !defined(HAVE_SNPRINTF)
  44 int snprintf (char *str, size_t sz, const char *format, ...)
  45      __attribute__ ((format (printf, 3, 4)));
  46 #endif
  47
  48 #if !defined(HAVE_VSNPRINTF)
  49 int vsnprintf (char *str, size_t sz, const char *format, va_list ap)
  50      __attribute__((format (printf, 3, 0)));
  51 #endif
  52
  53 #ifndef HAVE_STRLCAT
  54 extern size_t strlcat (char *, const char *, size_t);
  55 #endif
  56 #ifndef HAVE_STRLCPY
  57 extern size_t strlcpy (char *, const char *, size_t);
  58 #endif
  59
  60 #ifndef HAVE_STRDUP
  61 extern char *strdup (const char *str);
  62 #endif
  63
  64 #ifndef HAVE_STRSEP
  65 extern char *strsep(char **, const char *);
  66 #endif
  67
  68 struct tok {
  69         int v;                  /* value */
  70         const char *s;          /* string */
  71 };
  72
  73 #define TOKBUFSIZE 128
  74 extern const char *tok2strbuf(const struct tok *, const char *, int,
  75                               char *buf, size_t bufsize);
  76
  77 /* tok2str is deprecated */
  78 extern const char *tok2str(const struct tok *, const char *, int);
  79 extern char *bittok2str(const struct tok *, const char *, int);
  80 extern char *bittok2str_nosep(const struct tok *, const char *, int);
  81
  82
  83 typedef struct netdissect_options netdissect_options;
  84
  85 struct netdissect_options {
  86   int ndo_aflag;                /* translate network and broadcast addresses */
  87   int ndo_bflag;                /* print 4 byte ASes in ASDOT notation */
  88   int ndo_eflag;                /* print ethernet header */
  89   int ndo_fflag;                /* don't translate "foreign" IP address */
  90   int ndo_Kflag;                /* don't check TCP checksums */
  91   int ndo_nflag;                /* leave addresses as numbers */
  92   int ndo_Nflag;                /* remove domains from printed host names */
  93   int ndo_qflag;                /* quick (shorter) output */
  94   int ndo_Rflag;                /* print sequence # field in AH/ESP*/
  95   int ndo_sflag;                /* use the libsmi to translate OIDs */
  96   int ndo_Sflag;                /* print raw TCP sequence numbers */
  97   int ndo_tflag;                /* print packet arrival time */
  98   int ndo_Uflag;                /* "unbuffered" output of dump files */
  99   int ndo_uflag;                /* Print undecoded NFS handles */
 100   int ndo_vflag;                /* verbose */
 101   int ndo_xflag;                /* print packet in hex */
 102   int ndo_Xflag;                /* print packet in hex/ascii */
 103   int ndo_Aflag;                /* print packet only in ascii observing TAB,
 104                                  * LF, CR and SPACE as graphical chars
 105                                  */
 106   int ndo_Bflag;                /* buffer size */
 107   int ndo_Iflag;                /* rfmon (monitor) mode */
 108   int ndo_Oflag;                /* run filter code optimizer */
 109   int ndo_dlt;                  /* if != -1, ask libpcap for the DLT it names*/
 110   int ndo_pflag;                /* don't go promiscuous */
 111
 112   int ndo_Cflag;                /* rotate dump files after this many bytes */
 113   int ndo_Cflag_count;      /* Keep track of which file number we're writing */
 114   int ndo_Gflag;            /* rotate dump files after this many seconds */
 115   int ndo_Gflag_count;      /* number of files created with Gflag rotation */
 116   time_t ndo_Gflag_time;    /* The last time_t the dump file was rotated. */
 117   int ndo_Wflag;          /* recycle output files after this number of files */
 118   int ndo_WflagChars;
 119   int ndo_suppress_default_print; /* don't use default_print() for unknown packet types */
 120   const char *ndo_dltname;
 121
 122   char *ndo_espsecret;
 123   struct sa_list *ndo_sa_list_head;  /* used by print-esp.c */
 124   struct sa_list *ndo_sa_default;
 125
 126   char *ndo_sigsecret;          /* Signature verification secret key */
 127
 128   struct esp_algorithm *ndo_espsecret_xform;   /* cache of decoded  */
 129   char                 *ndo_espsecret_key;
 130
 131   int   ndo_packettype; /* as specified by -T */
 132
 133   char *ndo_program_name;       /*used to generate self-identifying messages */
 134
 135   int32_t ndo_thiszone; /* seconds offset from gmt to local time */
 136
 137   int   ndo_snaplen;
 138
 139   /*global pointers to beginning and end of current packet (during printing) */
 140   const u_char *ndo_packetp;
 141   const u_char *ndo_snapend;
 142
 143   /* bookkeeping for ^T output */
 144   int ndo_infodelay;
 145
 146   /* pointer to void function to output stuff */
 147   void (*ndo_default_print)(netdissect_options *,
 148                       register const u_char *bp, register u_int length);
 149   void (*ndo_info)(netdissect_options *, int verbose);
 150
 151   int  (*ndo_printf)(netdissect_options *,
 152                      const char *fmt, ...)
 153 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
 154                      __attribute__ ((format (printf, 2, 3)))
 155 #endif
 156                      ;
 157   void (*ndo_error)(netdissect_options *,
 158                     const char *fmt, ...)
 159 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
 160                      __attribute__ ((format (printf, 2, 3)))
 161 #endif
 162                      ;
 163   void (*ndo_warning)(netdissect_options *,
 164                       const char *fmt, ...)
 165 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
 166                      __attribute__ ((format (printf, 2, 3)))
 167 #endif
 168                      ;
 169 };
 170
 171 #define PT_VAT          1       /* Visual Audio Tool */
 172 #define PT_WB           2       /* distributed White Board */
 173 #define PT_RPC          3       /* Remote Procedure Call */
 174 #define PT_RTP          4       /* Real-Time Applications protocol */
 175 #define PT_RTCP         5       /* Real-Time Applications control protocol */
 176 #define PT_SNMP         6       /* Simple Network Management Protocol */
 177 #define PT_CNFP         7       /* Cisco NetFlow protocol */
 178
 179 #ifndef min
 180 #define min(a,b) ((a)>(b)?(b):(a))
 181 #endif
 182 #ifndef max
 183 #define max(a,b) ((b)>(a)?(b):(a))
 184 #endif
 185
 186 /*
 187  * Maximum snapshot length.  This should be enough to capture the full
 188  * packet on most network interfaces.
 189  *
 190  * XXX - could it be larger?  If so, should it?  Some applications might
 191  * use the snapshot length in a savefile header to control the size of
 192  * the buffer they allocate, so a size of, say, 2^31-1 might not work
 193  * well.
 194  */
 195 #define MAXIMUM_SNAPLEN 65535
 196
 197 /*
 198  * The default snapshot length is the maximum.
 199  */
 200 #define DEFAULT_SNAPLEN MAXIMUM_SNAPLEN
 201
 202 #ifndef BIG_ENDIAN
 203 #define BIG_ENDIAN 4321
 204 #define LITTLE_ENDIAN 1234
 205 #endif
 206
 207 #define ESRC(ep) ((ep)->ether_shost)
 208 #define EDST(ep) ((ep)->ether_dhost)
 209
 210 #ifndef NTOHL
 211 #define NTOHL(x)        (x) = ntohl(x)
 212 #define NTOHS(x)        (x) = ntohs(x)
 213 #define HTONL(x)        (x) = htonl(x)
 214 #define HTONS(x)        (x) = htons(x)
 215 #endif
 216
 217 /*
 218  * True if "l" bytes of "var" were captured.
 219  *
 220  * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure
 221  * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows.
 222  *
 223  * The check is for <= rather than < because "l" might be 0.
 224  */
 225 #define ND_TTEST2(var, l) (ndo->ndo_snapend - (l) <= ndo->ndo_snapend && \
 226                         (const u_char *)&(var) <= ndo->ndo_snapend - (l))
 227
 228 /* True if "var" was captured */
 229 #define ND_TTEST(var) ND_TTEST2(var, sizeof(var))
 230
 231 /* Bail if "l" bytes of "var" were not captured */
 232 #define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc
 233
 234 /* Bail if "var" was not captured */
 235 #define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var))
 236
 237 #define ND_PRINT(STUFF) (*ndo->ndo_printf)STUFF
 238 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
 239
 240 #if 0
 241 extern void ts_print(netdissect_options *ipdo,
 242                      const struct timeval *);
 243 extern void relts_print(int);
 244 #endif
 245
 246 extern int fn_print(const u_char *, const u_char *);
 247 extern int fn_printn(const u_char *, u_int, const u_char *);
 248 extern const char *tok2str(const struct tok *, const char *, int);
 249
 250 extern void wrapup(int);
 251
 252 #if 0
 253 extern char *read_infile(netdissect_options *, char *);
 254 extern char *copy_argv(netdissect_options *, char **);
 255 #endif
 256
 257 extern void safeputchar(int);
 258 extern void safeputs(const char *, int);
 259
 260 #if 0
 261 extern const char *isonsap_string(netdissect_options *, const u_char *);
 262 extern const char *protoid_string(netdissect_options *, const u_char *);
 263 extern const char *dnname_string(netdissect_options *, u_short);
 264 extern const char *dnnum_string(netdissect_options *, u_short);
 265 #endif
 266
 267 /* The printer routines. */
 268
 269 #include <pcap.h>
 270
 271
 272 extern void eap_print(netdissect_options *,const u_char *, u_int);
 273 extern int esp_print(netdissect_options *,
 274                      register const u_char *bp, int len, register const u_char *bp2,
 275                      int *nhdr, int *padlen);
 276 extern void arp_print(netdissect_options *,const u_char *, u_int, u_int);
 277 extern void isakmp_print(netdissect_options *,const u_char *,
 278                          u_int, const u_char *);
 279 extern void isakmp_rfc3948_print(netdissect_options *,const u_char *,
 280                                  u_int, const u_char *);
 281 extern void ip_print(netdissect_options *,const u_char *, u_int);
 282 extern void ip_print_inner(netdissect_options *ndo,
 283                            const u_char *bp, u_int length, u_int nh,
 284                            const u_char *bp2);
 285 extern void rrcp_print(netdissect_options *,const u_char *, u_int);
 286
 287 /* stuff that has not yet been rototiled */
 288 #if 0
 289 extern void ascii_print(netdissect_options *,u_int);
 290 extern void hex_and_ascii_print_with_offset(netdissect_options *,const char *,
 291                                     u_int, u_int);
 292 extern void hex_and_ascii_print(netdissect_options *,const char *, u_int);
 293 extern void hex_print_with_offset(netdissect_options *,const char *,
 294                                   u_int, u_int);
 295 extern void hex_print(netdissect_options *,const char *, u_int);
 296 extern void telnet_print(netdissect_options *,const u_char *, u_int);
 297 extern int ether_encap_print(netdissect_options *,u_short, const u_char *,
 298                              u_int, u_int, u_short *);
 299 extern int llc_print(netdissect_options *,
 300                      const u_char *, u_int, u_int, const u_char *,
 301                      const u_char *, u_short *);
 302 extern void aarp_print(netdissect_options *,const u_char *, u_int);
 303 extern void atalk_print(netdissect_options *,const u_char *, u_int);
 304 extern void atm_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 305 extern void bootp_print(netdissect_options *,const u_char *,
 306                         u_int, u_short, u_short);
 307 extern void bgp_print(netdissect_options *,const u_char *, int);
 308 extern void bxxp_print(netdissect_options *,const u_char *, u_int);
 309 extern void chdlc_if_print(u_char *user, const struct pcap_pkthdr *h,
 310                            register const u_char *p);
 311 extern void chdlc_print(netdissect_options *ndo,
 312                         register const u_char *p, u_int length, u_int caplen);
 313 extern void cisco_autorp_print(netdissect_options *,
 314                                const u_char *, u_int);
 315 extern void cnfp_print(netdissect_options *,const u_char *cp,
 316                        u_int len, const u_char *bp);
 317 extern void decnet_print(netdissect_options *,const u_char *,
 318                          u_int, u_int);
 319 extern void default_print(netdissect_options *,const u_char *, u_int);
 320 extern void dvmrp_print(netdissect_options *,const u_char *, u_int);
 321 extern void egp_print(netdissect_options *,const u_char *, u_int,
 322                       const u_char *);
 323
 324 extern void arcnet_if_print(u_char*,const struct pcap_pkthdr *,const u_char *);
 325 extern void ether_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
 326 extern void token_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
 327 extern void fddi_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 328
 329 extern void gre_print(netdissect_options *,const u_char *, u_int);
 330 extern void icmp_print(netdissect_options *,const u_char *, u_int,
 331                        const u_char *);
 332 extern void icmp6_print(netdissect_options *ndo, const u_char *,
 333                         u_int, const u_char *, int);
 334 extern void hsrp_print(netdissect_options *ndo,
 335                        register const u_char *bp, register u_int len);
 336 extern void ieee802_11_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 337 extern void igmp_print(netdissect_options *,
 338                        register const u_char *, u_int);
 339 extern void igrp_print(netdissect_options *,const u_char *, u_int,
 340                        const u_char *);
 341 extern void ipN_print(netdissect_options *,const u_char *, u_int);
 342 extern void ipx_print(netdissect_options *,const u_char *, u_int);
 343 extern void isoclns_print(netdissect_options *,const u_char *,
 344                           u_int, u_int, const u_char *, const u_char *);
 345 extern void krb_print(netdissect_options *,const u_char *, u_int);
 346 extern void llap_print(netdissect_options *,const u_char *, u_int);
 347 extern const char *linkaddr_string(netdissect_options *ndo,
 348                                    const u_char *ep, const unsigned int len);
 349 extern void ltalk_if_print(netdissect_options *ndo,
 350                            u_char *user, const struct pcap_pkthdr *h,
 351                            const u_char *p);
 352 extern void mpls_print(netdissect_options *ndo,
 353                        const u_char *bp, u_int length);
 354 extern void msdp_print(netdissect_options *ndo,
 355                        const unsigned char *sp, u_int length);
 356 extern void nfsreply_print(netdissect_options *,const u_char *,
 357                            u_int, const u_char *);
 358 extern void nfsreq_print(netdissect_options *,const u_char *,
 359                          u_int, const u_char *);
 360 extern void ns_print(netdissect_options *,const u_char *, u_int);
 361 extern void ntp_print(netdissect_options *,const u_char *, u_int);
 362 extern void null_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 363 extern void ospf_print(netdissect_options *,const u_char *,
 364                        u_int, const u_char *);
 365 extern void pimv1_print(netdissect_options *,const u_char *, u_int);
 366 extern void mobile_print(netdissect_options *,const u_char *, u_int);
 367 extern void pim_print(netdissect_options *,const u_char *, u_int, u_int);
 368 extern void pppoe_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 369 extern void pppoe_print(netdissect_options *,const u_char *, u_int);
 370 extern void ppp_print(netdissect_options *,
 371                       register const u_char *, u_int);
 372
 373 extern void ppp_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 374 extern void ppp_hdlc_if_print(u_char *,
 375                               const struct pcap_pkthdr *, const u_char *);
 376 extern void ppp_bsdos_if_print(u_char *,
 377                                const struct pcap_pkthdr *, const u_char *);
 378
 379 extern int vjc_print(netdissect_options *,register const char *,
 380                      register u_int, u_short);
 381
 382 extern void raw_if_print(u_char *,
 383                          const struct pcap_pkthdr *, const u_char *);
 384
 385 extern void rip_print(netdissect_options *,const u_char *, u_int);
 386
 387 extern void sctp_print(netdissect_options *ndo,
 388                        const u_char *bp, const u_char *bp2,
 389                        u_int sctpPacketLength);
 390
 391 extern void sl_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 392
 393 extern void lane_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
 394 extern void cip_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
 395 extern void sl_bsdos_if_print(u_char *,
 396                               const struct pcap_pkthdr *, const u_char *);
 397 extern void sll_if_print(u_char *,
 398                          const struct pcap_pkthdr *, const u_char *);
 399
 400 extern void snmp_print(netdissect_options *,const u_char *, u_int);
 401 extern void sunrpcrequest_print(netdissect_options *,const u_char *,
 402                                 u_int, const u_char *);
 403 extern void tcp_print(netdissect_options *,const u_char *, u_int,
 404                       const u_char *, int);
 405 extern void tftp_print(netdissect_options *,const u_char *, u_int);
 406 extern void timed_print(netdissect_options *,const u_char *, u_int);
 407 extern void udp_print(netdissect_options *,const u_char *, u_int,
 408                       const u_char *, int);
 409 extern void wb_print(netdissect_options *,const void *, u_int);
 410 extern int ah_print(netdissect_options *,register const u_char *,
 411                     register const u_char *);
 412 extern void esp_print_decodesecret(netdissect_options *ndo);
 413 extern int ipcomp_print(netdissect_options *,register const u_char *,
 414                         register const u_char *, int *);
 415 extern void rx_print(netdissect_options *,register const u_char *,
 416                      int, int, int, u_char *);
 417 extern void netbeui_print(netdissect_options *,u_short,
 418                           const u_char *, int);
 419 extern void ipx_netbios_print(netdissect_options *,const u_char *, u_int);
 420 extern void nbt_tcp_print(netdissect_options *,const u_char *, int);
 421 extern void nbt_udp137_print(netdissect_options *,
 422                              const u_char *data, int);
 423 extern void nbt_udp138_print(netdissect_options *,
 424                              const u_char *data, int);
 425 extern char *smb_errstr(netdissect_options *,int, int);
 426 extern const char *nt_errstr(netdissect_options *, u_int32_t);
 427 extern void print_data(netdissect_options *,const unsigned char *, int);
 428 extern void l2tp_print(netdissect_options *,const u_char *, u_int);
 429 extern void lcp_print(netdissect_options *,const u_char *, u_int);
 430 extern void vrrp_print(netdissect_options *,const u_char *bp,
 431                        u_int len, int ttl);
 432 extern void cdp_print(netdissect_options *,const u_char *,
 433                       u_int, u_int, const u_char *, const u_char *);
 434 extern void stp_print(netdissect_options *,const u_char *p, u_int length);
 435 extern void radius_print(netdissect_options *,const u_char *, u_int);
 436 extern void lwres_print(netdissect_options *,const u_char *, u_int);
 437 extern void pptp_print(netdissect_options *,const u_char *, u_int);
 438
 439 extern void ipnet_print(netdissect_options *,const u_char *, u_int, u_int);
 440 extern u_int ipnet_if_print(netdissect_options *,const struct pcap_pkthdr *, const u_char *);
 441 extern int ipnet_encap_print(netdissect_options *,u_short, const u_char *, u_int, u_int);
 442
 443 #ifdef INET6
 444 extern void ip6_print(netdissect_options *,const u_char *, u_int);
 445 extern void ip6_opt_print(netdissect_options *,const u_char *, int);
 446 extern int nextproto6_cksum(const struct ip6_hdr *, const u_short *, u_int, u_int);
 447 extern int hbhopt_print(netdissect_options *,const u_char *);
 448 extern int dstopt_print(netdissect_options *,const u_char *);
 449 extern int frag6_print(netdissect_options *,const u_char *,
 450                        const u_char *);
 451 extern void icmp6_print(netdissect_options *,const u_char *,
 452                         const u_char *);
 453 extern void ripng_print(netdissect_options *,const u_char *, int);
 454 extern int rt6_print(netdissect_options *,const u_char *, const u_char *);
 455 extern void ospf6_print(netdissect_options *,const u_char *, u_int);
 456 extern void dhcp6_print(netdissect_options *,const u_char *,
 457                         u_int, u_int16_t, u_int16_t);
 458
 459 extern void zephyr_print(netdissect_options * ndo,
 460                          const u_char *cp, int length);
 461
 462 #endif /*INET6*/
 463 extern u_short in_cksum(const u_short *,
 464                         register u_int, int);
 465
 466 #endif
 467
 468 extern void esp_print_decodesecret(netdissect_options *ndo);
 469 extern int esp_print_decrypt_buffer_by_ikev2(netdissect_options *ndo,
 470                                              int initiator,
 471                                              u_char spii[8], u_char spir[8],
 472                                              u_char *buf, u_char *end);
 473
 474
 475 #endif  /* netdissect_h */