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