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