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