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