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.22 2006-05-05 23:13:00 guy 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
  81
  82 typedef struct netdissect_options netdissect_options;
  83
  84 struct netdissect_options {
  85   int ndo_aflag;                /* translate network and broadcast addresses */
  86   int ndo_eflag;                /* print ethernet header */
  87   int ndo_fflag;                /* don't translate "foreign" IP address */
  88   int ndo_Kflag;                /* don't check TCP checksums */
  89   int ndo_nflag;                /* leave addresses as numbers */
  90   int ndo_Nflag;                /* remove domains from printed host names */
  91   int ndo_qflag;                /* quick (shorter) output */
  92   int ndo_Rflag;                /* print sequence # field in AH/ESP*/
  93   int ndo_sflag;                /* use the libsmi to translate OIDs */
  94   int ndo_Sflag;                /* print raw TCP sequence numbers */
  95   int ndo_tflag;                /* print packet arrival time */
  96   int ndo_Uflag;                /* "unbuffered" output of dump files */
  97   int ndo_uflag;                /* Print undecoded NFS handles */
  98   int ndo_vflag;                /* verbose */
  99   int ndo_xflag;                /* print packet in hex */
 100   int ndo_Xflag;                /* print packet in hex/ascii */
 101   int ndo_Aflag;                /* print packet only in ascii observing TAB,
 102                                  * LF, CR and SPACE as graphical chars
 103                                  */
 104   int ndo_Oflag;                /* run filter code optimizer */
 105   int ndo_dlt;                  /* if != -1, ask libpcap for the DLT it names*/
 106   int ndo_pflag;                /* don't go promiscuous */
 107
 108   int ndo_Cflag;                /* rotate dump files after this many bytes */
 109   int ndo_Cflag_count;      /* Keep track of which file number we're writing */
 110   int ndo_Gflag;            /* rotate dump files after this many seconds */
 111   int ndo_Gflag_count;      /* number of files created with Gflag rotation */
 112   time_t ndo_Gflag_time;    /* The last time_t the dump file was rotated. */
 113   int ndo_Wflag;          /* recycle output files after this number of files */
 114   int ndo_WflagChars;
 115   int ndo_suppress_default_print; /* don't use default_print() for unknown packet types */
 116   const char *ndo_dltname;
 117
 118   char *ndo_espsecret;
 119   struct sa_list *ndo_sa_list_head;  /* used by print-esp.c */
 120   struct sa_list *ndo_sa_default;
 121
 122   char *ndo_tcpmd5secret;       /* TCP-MD5 secret key */
 123
 124   struct esp_algorithm *ndo_espsecret_xform;   /* cache of decoded  */
 125   char                 *ndo_espsecret_key;
 126
 127   int   ndo_packettype; /* as specified by -T */
 128
 129   char *ndo_program_name;       /*used to generate self-identifying messages */
 130
 131   int32_t ndo_thiszone; /* seconds offset from gmt to local time */
 132
 133   int   ndo_snaplen;
 134
 135   /*global pointers to beginning and end of current packet (during printing) */
 136   const u_char *ndo_packetp;
 137   const u_char *ndo_snapend;
 138
 139   /* bookkeeping for ^T output */
 140   int ndo_infodelay;
 141
 142   /* pointer to void function to output stuff */
 143   void (*ndo_default_print)(netdissect_options *,
 144                       register const u_char *bp, register u_int length);
 145   void (*ndo_info)(netdissect_options *, int verbose);
 146
 147   int  (*ndo_printf)(netdissect_options *,
 148                      const char *fmt, ...);
 149   void (*ndo_error)(netdissect_options *,
 150                     const char *fmt, ...);
 151   void (*ndo_warning)(netdissect_options *,
 152                       const char *fmt, ...);
 153 };
 154
 155 #define PT_VAT          1       /* Visual Audio Tool */
 156 #define PT_WB           2       /* distributed White Board */
 157 #define PT_RPC          3       /* Remote Procedure Call */
 158 #define PT_RTP          4       /* Real-Time Applications protocol */
 159 #define PT_RTCP         5       /* Real-Time Applications control protocol */
 160 #define PT_SNMP         6       /* Simple Network Management Protocol */
 161 #define PT_CNFP         7       /* Cisco NetFlow protocol */
 162
 163 #ifndef min
 164 #define min(a,b) ((a)>(b)?(b):(a))
 165 #endif
 166 #ifndef max
 167 #define max(a,b) ((b)>(a)?(b):(a))
 168 #endif
 169
 170 #ifndef INET6
 171 /*
 172  * The default snapshot length.  This value allows most printers to print
 173  * useful information while keeping the amount of unwanted data down.
 174  * In particular, it allows for an ethernet header, tcp/ip header, and
 175  * 14 bytes of data (assuming no ip options).
 176  */
 177 #define DEFAULT_SNAPLEN 68
 178 #else
 179 #define DEFAULT_SNAPLEN 96
 180 #endif
 181
 182 #ifndef BIG_ENDIAN
 183 #define BIG_ENDIAN 4321
 184 #define LITTLE_ENDIAN 1234
 185 #endif
 186
 187 #define ESRC(ep) ((ep)->ether_shost)
 188 #define EDST(ep) ((ep)->ether_dhost)
 189
 190 #ifndef NTOHL
 191 #define NTOHL(x)        (x) = ntohl(x)
 192 #define NTOHS(x)        (x) = ntohs(x)
 193 #define HTONL(x)        (x) = htonl(x)
 194 #define HTONS(x)        (x) = htons(x)
 195 #endif
 196
 197 /*
 198  * True if "l" bytes of "var" were captured.
 199  *
 200  * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure
 201  * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows.
 202  *
 203  * The check is for <= rather than < because "l" might be 0.
 204  */
 205 #define ND_TTEST2(var, l) (ndo->ndo_snapend - (l) <= ndo->ndo_snapend && \
 206                         (const u_char *)&(var) <= ndo->ndo_snapend - (l))
 207
 208 /* True if "var" was captured */
 209 #define ND_TTEST(var) ND_TTEST2(var, sizeof(var))
 210
 211 /* Bail if "l" bytes of "var" were not captured */
 212 #define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc
 213
 214 /* Bail if "var" was not captured */
 215 #define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var))
 216
 217 #define ND_PRINT(STUFF) (*ndo->ndo_printf)STUFF
 218 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
 219
 220 #if 0
 221 extern void ts_print(netdissect_options *ipdo,
 222                      const struct timeval *);
 223 extern void relts_print(int);
 224 #endif
 225
 226 extern int fn_print(const u_char *, const u_char *);
 227 extern int fn_printn(const u_char *, u_int, const u_char *);
 228 extern const char *tok2str(const struct tok *, const char *, int);
 229
 230 extern void wrapup(int);
 231
 232 #if 0
 233 extern char *read_infile(netdissect_options *, char *);
 234 extern char *copy_argv(netdissect_options *, char **);
 235 #endif
 236
 237 extern void safeputchar(int);
 238 extern void safeputs(const char *, int);
 239
 240 #if 0
 241 extern const char *isonsap_string(netdissect_options *, const u_char *);
 242 extern const char *protoid_string(netdissect_options *, const u_char *);
 243 extern const char *dnname_string(netdissect_options *, u_short);
 244 extern const char *dnnum_string(netdissect_options *, u_short);
 245 #endif
 246
 247 /* The printer routines. */
 248
 249 #include <pcap.h>
 250
 251
 252 extern void eap_print(netdissect_options *,const u_char *, u_int);
 253 extern int esp_print(netdissect_options *,
 254                      register const u_char *bp, int len, register const u_char *bp2,
 255                      int *nhdr, int *padlen);
 256 extern void arp_print(netdissect_options *,const u_char *, u_int, u_int);
 257 extern void isakmp_print(netdissect_options *,const u_char *,
 258                          u_int, const u_char *);
 259 extern void isakmp_rfc3948_print(netdissect_options *,const u_char *,
 260                                  u_int, const u_char *);
 261 extern void ip_print(netdissect_options *,const u_char *, u_int);
 262 extern void ip_print_inner(netdissect_options *ndo,
 263                            const u_char *bp, u_int length, u_int nh,
 264                            const u_char *bp2);
 265
 266 /* stuff that has not yet been rototiled */
 267 #if 0
 268 extern void ascii_print(netdissect_options *,u_int);
 269 extern void hex_and_ascii_print_with_offset(netdissect_options *,const char *,
 270                                     u_int, u_int);
 271 extern void hex_and_ascii_print(netdissect_options *,const char *, u_int);
 272 extern void hex_print_with_offset(netdissect_options *,const char *,
 273                                   u_int, u_int);
 274 extern void hex_print(netdissect_options *,const char *, u_int);
 275 extern void telnet_print(netdissect_options *,const u_char *, u_int);
 276 extern int ether_encap_print(netdissect_options *,u_short, const u_char *,
 277                              u_int, u_int, u_short *);
 278 extern int llc_print(netdissect_options *,
 279                      const u_char *, u_int, u_int, const u_char *,
 280                      const u_char *, u_short *);
 281 extern void aarp_print(netdissect_options *,const u_char *, u_int);
 282 extern void atalk_print(netdissect_options *,const u_char *, u_int);
 283 extern void atm_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 284 extern void bootp_print(netdissect_options *,const u_char *,
 285                         u_int, u_short, u_short);
 286 extern void bgp_print(netdissect_options *,const u_char *, int);
 287 extern void bxxp_print(netdissect_options *,const u_char *, u_int);
 288 extern void chdlc_if_print(u_char *user, const struct pcap_pkthdr *h,
 289                            register const u_char *p);
 290 extern void chdlc_print(netdissect_options *ndo,
 291                         register const u_char *p, u_int length, u_int caplen);
 292 extern void cisco_autorp_print(netdissect_options *,
 293                                const u_char *, u_int);
 294 extern void cnfp_print(netdissect_options *,const u_char *cp,
 295                        u_int len, const u_char *bp);
 296 extern void decnet_print(netdissect_options *,const u_char *,
 297                          u_int, u_int);
 298 extern void default_print(netdissect_options *,const u_char *, u_int);
 299 extern void dvmrp_print(netdissect_options *,const u_char *, u_int);
 300 extern void egp_print(netdissect_options *,const u_char *, u_int,
 301                       const u_char *);
 302
 303 extern void arcnet_if_print(u_char*,const struct pcap_pkthdr *,const u_char *);
 304 extern void ether_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
 305 extern void token_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
 306 extern void fddi_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 307
 308 extern void gre_print(netdissect_options *,const u_char *, u_int);
 309 extern void icmp_print(netdissect_options *,const u_char *, u_int,
 310                        const u_char *);
 311 extern void hsrp_print(netdissect_options *ndo,
 312                        register const u_char *bp, register u_int len);
 313 extern void ieee802_11_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 314 extern void igmp_print(netdissect_options *,
 315                        register const u_char *, u_int);
 316 extern void igrp_print(netdissect_options *,const u_char *, u_int,
 317                        const u_char *);
 318 extern void ipN_print(netdissect_options *,const u_char *, u_int);
 319 extern void ipx_print(netdissect_options *,const u_char *, u_int);
 320 extern void isoclns_print(netdissect_options *,const u_char *,
 321                           u_int, u_int, const u_char *, const u_char *);
 322 extern void krb_print(netdissect_options *,const u_char *, u_int);
 323 extern void llap_print(netdissect_options *,const u_char *, u_int);
 324 extern const char *linkaddr_string(netdissect_options *ndo,
 325                                    const u_char *ep, const unsigned int len);
 326 extern void ltalk_if_print(netdissect_options *ndo,
 327                            u_char *user, const struct pcap_pkthdr *h,
 328                            const u_char *p);
 329 extern void mpls_print(netdissect_options *ndo,
 330                        const u_char *bp, u_int length);
 331 extern void msdp_print(netdissect_options *ndo,
 332                        const unsigned char *sp, u_int length);
 333 extern void nfsreply_print(netdissect_options *,const u_char *,
 334                            u_int, const u_char *);
 335 extern void nfsreq_print(netdissect_options *,const u_char *,
 336                          u_int, const u_char *);
 337 extern void ns_print(netdissect_options *,const u_char *, u_int);
 338 extern void ntp_print(netdissect_options *,const u_char *, u_int);
 339 extern void null_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 340 extern void ospf_print(netdissect_options *,const u_char *,
 341                        u_int, const u_char *);
 342 extern void pimv1_print(netdissect_options *,const u_char *, u_int);
 343 extern void mobile_print(netdissect_options *,const u_char *, u_int);
 344 extern void pim_print(netdissect_options *,const u_char *, u_int);
 345 extern void pppoe_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 346 extern void pppoe_print(netdissect_options *,const u_char *, u_int);
 347 extern void ppp_print(netdissect_options *,
 348                       register const u_char *, u_int);
 349
 350 extern void ppp_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 351 extern void ppp_hdlc_if_print(u_char *,
 352                               const struct pcap_pkthdr *, const u_char *);
 353 extern void ppp_bsdos_if_print(u_char *,
 354                                const struct pcap_pkthdr *, const u_char *);
 355
 356 extern int vjc_print(netdissect_options *,register const char *,
 357                      register u_int, u_short);
 358
 359 extern void raw_if_print(u_char *,
 360                          const struct pcap_pkthdr *, const u_char *);
 361
 362 extern void rip_print(netdissect_options *,const u_char *, u_int);
 363
 364 extern void sctp_print(netdissect_options *ndo,
 365                        const u_char *bp, const u_char *bp2,
 366                        u_int sctpPacketLength);
 367
 368 extern void sl_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
 369
 370 extern void lane_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
 371 extern void cip_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
 372 extern void sl_bsdos_if_print(u_char *,
 373                               const struct pcap_pkthdr *, const u_char *);
 374 extern void sll_if_print(u_char *,
 375                          const struct pcap_pkthdr *, const u_char *);
 376
 377 extern void snmp_print(netdissect_options *,const u_char *, u_int);
 378 extern void sunrpcrequest_print(netdissect_options *,const u_char *,
 379                                 u_int, const u_char *);
 380 extern void tcp_print(netdissect_options *,const u_char *, u_int,
 381                       const u_char *, int);
 382 extern void tftp_print(netdissect_options *,const u_char *, u_int);
 383 extern void timed_print(netdissect_options *,const u_char *, u_int);
 384 extern void udp_print(netdissect_options *,const u_char *, u_int,
 385                       const u_char *, int);
 386 extern void wb_print(netdissect_options *,const void *, u_int);
 387 extern int ah_print(netdissect_options *,register const u_char *,
 388                     register const u_char *);
 389 extern void esp_print_decodesecret(netdissect_options *ndo);
 390 extern int ipcomp_print(netdissect_options *,register const u_char *,
 391                         register const u_char *, int *);
 392 extern void rx_print(netdissect_options *,register const u_char *,
 393                      int, int, int, u_char *);
 394 extern void netbeui_print(netdissect_options *,u_short,
 395                           const u_char *, int);
 396 extern void ipx_netbios_print(netdissect_options *,const u_char *, u_int);
 397 extern void nbt_tcp_print(netdissect_options *,const u_char *, int);
 398 extern void nbt_udp137_print(netdissect_options *,
 399                              const u_char *data, int);
 400 extern void nbt_udp138_print(netdissect_options *,
 401                              const u_char *data, int);
 402 extern char *smb_errstr(netdissect_options *,int, int);
 403 extern const char *nt_errstr(netdissect_options *, u_int32_t);
 404 extern void print_data(netdissect_options *,const unsigned char *, int);
 405 extern void l2tp_print(netdissect_options *,const u_char *, u_int);
 406 extern void lcp_print(netdissect_options *,const u_char *, u_int);
 407 extern void vrrp_print(netdissect_options *,const u_char *bp,
 408                        u_int len, int ttl);
 409 extern void cdp_print(netdissect_options *,const u_char *,
 410                       u_int, u_int, const u_char *, const u_char *);
 411 extern void stp_print(netdissect_options *,const u_char *p, u_int length);
 412 extern void radius_print(netdissect_options *,const u_char *, u_int);
 413 extern void lwres_print(netdissect_options *,const u_char *, u_int);
 414 extern void pptp_print(netdissect_options *,const u_char *, u_int);
 415
 416 #ifdef INET6
 417 extern void ip6_print(netdissect_options *,const u_char *, u_int);
 418 extern void ip6_opt_print(netdissect_options *,const u_char *, int);
 419 extern int hbhopt_print(netdissect_options *,const u_char *);
 420 extern int dstopt_print(netdissect_options *,const u_char *);
 421 extern int frag6_print(netdissect_options *,const u_char *,
 422                        const u_char *);
 423 extern void icmp6_print(netdissect_options *,const u_char *,
 424                         const u_char *);
 425 extern void ripng_print(netdissect_options *,const u_char *, int);
 426 extern int rt6_print(netdissect_options *,const u_char *, const u_char *);
 427 extern void ospf6_print(netdissect_options *,const u_char *, u_int);
 428 extern void dhcp6_print(netdissect_options *,const u_char *,
 429                         u_int, u_int16_t, u_int16_t);
 430
 431 extern void zephyr_print(netdissect_options * ndo,
 432                          const u_char *cp, int length);
 433
 434 #endif /*INET6*/
 435 extern u_short in_cksum(const u_short *,
 436                         register u_int, int);
 437
 438 #endif
 439
 440 #endif  /* netdissect_h */