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