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