netdissect.h revision 214478
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.27 2008-08-16 11:36:20 hannes 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) 44int snprintf (char *str, size_t sz, const char *format, ...) 45 __attribute__ ((format (printf, 3, 4))); 46#endif 47 48#if !defined(HAVE_VSNPRINTF) 49int 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 54extern size_t strlcat (char *, const char *, size_t); 55#endif 56#ifndef HAVE_STRLCPY 57extern size_t strlcpy (char *, const char *, size_t); 58#endif 59 60#ifndef HAVE_STRDUP 61extern char *strdup (const char *str); 62#endif 63 64#ifndef HAVE_STRSEP 65extern char *strsep(char **, const char *); 66#endif 67 68struct tok { 69 int v; /* value */ 70 const char *s; /* string */ 71}; 72 73#define TOKBUFSIZE 128 74extern const char *tok2strbuf(const struct tok *, const char *, int, 75 char *buf, size_t bufsize); 76 77/* tok2str is deprecated */ 78extern const char *tok2str(const struct tok *, const char *, int); 79extern char *bittok2str(const struct tok *, const char *, int); 80extern char *bittok2str_nosep(const struct tok *, const char *, int); 81 82 83typedef struct netdissect_options netdissect_options; 84 85struct netdissect_options { 86 int ndo_aflag; /* translate network and broadcast addresses */ 87 int ndo_bflag; /* print 4 byte ASes in ASDOT notation */ 88 int ndo_eflag; /* print ethernet header */ 89 int ndo_fflag; /* don't translate "foreign" IP address */ 90 int ndo_Kflag; /* don't check TCP checksums */ 91 int ndo_nflag; /* leave addresses as numbers */ 92 int ndo_Nflag; /* remove domains from printed host names */ 93 int ndo_qflag; /* quick (shorter) output */ 94 int ndo_Rflag; /* print sequence # field in AH/ESP*/ 95 int ndo_sflag; /* use the libsmi to translate OIDs */ 96 int ndo_Sflag; /* print raw TCP sequence numbers */ 97 int ndo_tflag; /* print packet arrival time */ 98 int ndo_Uflag; /* "unbuffered" output of dump files */ 99 int ndo_uflag; /* Print undecoded NFS handles */ 100 int ndo_vflag; /* verbose */ 101 int ndo_xflag; /* print packet in hex */ 102 int ndo_Xflag; /* print packet in hex/ascii */ 103 int ndo_Aflag; /* print packet only in ascii observing TAB, 104 * LF, CR and SPACE as graphical chars 105 */ 106 int ndo_Bflag; /* buffer size */ 107 int ndo_Iflag; /* rfmon (monitor) mode */ 108 int ndo_Oflag; /* run filter code optimizer */ 109 int ndo_dlt; /* if != -1, ask libpcap for the DLT it names*/ 110 int ndo_pflag; /* don't go promiscuous */ 111 112 int ndo_Cflag; /* rotate dump files after this many bytes */ 113 int ndo_Cflag_count; /* Keep track of which file number we're writing */ 114 int ndo_Gflag; /* rotate dump files after this many seconds */ 115 int ndo_Gflag_count; /* number of files created with Gflag rotation */ 116 time_t ndo_Gflag_time; /* The last time_t the dump file was rotated. */ 117 int ndo_Wflag; /* recycle output files after this number of files */ 118 int ndo_WflagChars; 119 int ndo_suppress_default_print; /* don't use default_print() for unknown packet types */ 120 const char *ndo_dltname; 121 122 char *ndo_espsecret; 123 struct sa_list *ndo_sa_list_head; /* used by print-esp.c */ 124 struct sa_list *ndo_sa_default; 125 126 char *ndo_sigsecret; /* Signature verification secret key */ 127 128 struct esp_algorithm *ndo_espsecret_xform; /* cache of decoded */ 129 char *ndo_espsecret_key; 130 131 int ndo_packettype; /* as specified by -T */ 132 133 char *ndo_program_name; /*used to generate self-identifying messages */ 134 135 int32_t ndo_thiszone; /* seconds offset from gmt to local time */ 136 137 int ndo_snaplen; 138 139 /*global pointers to beginning and end of current packet (during printing) */ 140 const u_char *ndo_packetp; 141 const u_char *ndo_snapend; 142 143 /* bookkeeping for ^T output */ 144 int ndo_infodelay; 145 146 /* pointer to void function to output stuff */ 147 void (*ndo_default_print)(netdissect_options *, 148 register const u_char *bp, register u_int length); 149 void (*ndo_info)(netdissect_options *, int verbose); 150 151 int (*ndo_printf)(netdissect_options *, 152 const char *fmt, ...) 153#ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS 154 __attribute__ ((format (printf, 2, 3))) 155#endif 156 ; 157 void (*ndo_error)(netdissect_options *, 158 const char *fmt, ...) 159#ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS 160 __attribute__ ((format (printf, 2, 3))) 161#endif 162 ; 163 void (*ndo_warning)(netdissect_options *, 164 const char *fmt, ...) 165#ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS 166 __attribute__ ((format (printf, 2, 3))) 167#endif 168 ; 169}; 170 171#define PT_VAT 1 /* Visual Audio Tool */ 172#define PT_WB 2 /* distributed White Board */ 173#define PT_RPC 3 /* Remote Procedure Call */ 174#define PT_RTP 4 /* Real-Time Applications protocol */ 175#define PT_RTCP 5 /* Real-Time Applications control protocol */ 176#define PT_SNMP 6 /* Simple Network Management Protocol */ 177#define PT_CNFP 7 /* Cisco NetFlow protocol */ 178 179#ifndef min 180#define min(a,b) ((a)>(b)?(b):(a)) 181#endif 182#ifndef max 183#define max(a,b) ((b)>(a)?(b):(a)) 184#endif 185 186/* 187 * Maximum snapshot length. This should be enough to capture the full 188 * packet on most network interfaces. 189 * 190 * XXX - could it be larger? If so, should it? Some applications might 191 * use the snapshot length in a savefile header to control the size of 192 * the buffer they allocate, so a size of, say, 2^31-1 might not work 193 * well. 194 */ 195#define MAXIMUM_SNAPLEN 65535 196 197/* 198 * The default snapshot length is the maximum. 199 */ 200#define DEFAULT_SNAPLEN MAXIMUM_SNAPLEN 201 202#define ESRC(ep) ((ep)->ether_shost) 203#define EDST(ep) ((ep)->ether_dhost) 204 205#ifndef NTOHL 206#define NTOHL(x) (x) = ntohl(x) 207#define NTOHS(x) (x) = ntohs(x) 208#define HTONL(x) (x) = htonl(x) 209#define HTONS(x) (x) = htons(x) 210#endif 211 212/* 213 * True if "l" bytes of "var" were captured. 214 * 215 * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure 216 * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows. 217 * 218 * The check is for <= rather than < because "l" might be 0. 219 */ 220#define ND_TTEST2(var, l) (ndo->ndo_snapend - (l) <= ndo->ndo_snapend && \ 221 (const u_char *)&(var) <= ndo->ndo_snapend - (l)) 222 223/* True if "var" was captured */ 224#define ND_TTEST(var) ND_TTEST2(var, sizeof(var)) 225 226/* Bail if "l" bytes of "var" were not captured */ 227#define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc 228 229/* Bail if "var" was not captured */ 230#define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var)) 231 232#define ND_PRINT(STUFF) (*ndo->ndo_printf)STUFF 233#define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length) 234 235#if 0 236extern void ts_print(netdissect_options *ipdo, 237 const struct timeval *); 238extern void relts_print(int); 239#endif 240 241extern int fn_print(const u_char *, const u_char *); 242extern int fn_printn(const u_char *, u_int, const u_char *); 243extern const char *tok2str(const struct tok *, const char *, int); 244 245extern void wrapup(int); 246 247#if 0 248extern char *read_infile(netdissect_options *, char *); 249extern char *copy_argv(netdissect_options *, char **); 250#endif 251 252extern void safeputchar(int); 253extern void safeputs(const char *, int); 254 255#if 0 256extern const char *isonsap_string(netdissect_options *, const u_char *); 257extern const char *protoid_string(netdissect_options *, const u_char *); 258extern const char *dnname_string(netdissect_options *, u_short); 259extern const char *dnnum_string(netdissect_options *, u_short); 260#endif 261 262/* The printer routines. */ 263 264#include <pcap.h> 265 266 267extern void eap_print(netdissect_options *,const u_char *, u_int); 268extern int esp_print(netdissect_options *, 269 register const u_char *bp, int len, register const u_char *bp2, 270 int *nhdr, int *padlen); 271extern void arp_print(netdissect_options *,const u_char *, u_int, u_int); 272extern void icmp6_print(netdissect_options *ndo, const u_char *, 273 u_int, const u_char *, int); 274extern void isakmp_print(netdissect_options *,const u_char *, 275 u_int, const u_char *); 276extern void isakmp_rfc3948_print(netdissect_options *,const u_char *, 277 u_int, const u_char *); 278extern void ip_print(netdissect_options *,const u_char *, u_int); 279extern void ip_print_inner(netdissect_options *ndo, 280 const u_char *bp, u_int length, u_int nh, 281 const u_char *bp2); 282extern void rrcp_print(netdissect_options *,const u_char *, u_int); 283 284/* stuff that has not yet been rototiled */ 285#if 0 286extern void ascii_print(netdissect_options *,u_int); 287extern void hex_and_ascii_print_with_offset(netdissect_options *,const char *, 288 u_int, u_int); 289extern void hex_and_ascii_print(netdissect_options *,const char *, u_int); 290extern void hex_print_with_offset(netdissect_options *,const char *, 291 u_int, u_int); 292extern void hex_print(netdissect_options *,const char *, u_int); 293extern void telnet_print(netdissect_options *,const u_char *, u_int); 294extern int ethertype_print(netdissect_options *,u_short, const u_char *, 295 u_int, u_int); 296extern int llc_print(netdissect_options *, 297 const u_char *, u_int, u_int, const u_char *, 298 const u_char *, u_short *); 299extern void aarp_print(netdissect_options *,const u_char *, u_int); 300extern void atalk_print(netdissect_options *,const u_char *, u_int); 301extern void atm_if_print(u_char *,const struct pcap_pkthdr *, const u_char *); 302extern void bootp_print(netdissect_options *,const u_char *, 303 u_int, u_short, u_short); 304extern void bgp_print(netdissect_options *,const u_char *, int); 305extern void bxxp_print(netdissect_options *,const u_char *, u_int); 306extern void chdlc_if_print(u_char *user, const struct pcap_pkthdr *h, 307 register const u_char *p); 308extern void chdlc_print(netdissect_options *ndo, 309 register const u_char *p, u_int length, u_int caplen); 310extern void cisco_autorp_print(netdissect_options *, 311 const u_char *, u_int); 312extern void cnfp_print(netdissect_options *,const u_char *cp, 313 u_int len, const u_char *bp); 314extern void decnet_print(netdissect_options *,const u_char *, 315 u_int, u_int); 316extern void default_print(netdissect_options *,const u_char *, u_int); 317extern void dvmrp_print(netdissect_options *,const u_char *, u_int); 318extern void egp_print(netdissect_options *,const u_char *, u_int, 319 const u_char *); 320 321extern void arcnet_if_print(u_char*,const struct pcap_pkthdr *,const u_char *); 322extern void ether_if_print(u_char *,const struct pcap_pkthdr *,const u_char *); 323extern void token_if_print(u_char *,const struct pcap_pkthdr *,const u_char *); 324extern void fddi_if_print(u_char *,const struct pcap_pkthdr *, const u_char *); 325 326extern void gre_print(netdissect_options *,const u_char *, u_int); 327extern void icmp_print(netdissect_options *,const u_char *, u_int, 328 const u_char *); 329extern void hsrp_print(netdissect_options *ndo, 330 register const u_char *bp, register u_int len); 331extern void ieee802_11_if_print(u_char *,const struct pcap_pkthdr *, const u_char *); 332extern void igmp_print(netdissect_options *, 333 register const u_char *, u_int); 334extern void igrp_print(netdissect_options *,const u_char *, u_int, 335 const u_char *); 336extern void ipN_print(netdissect_options *,const u_char *, u_int); 337extern void ipx_print(netdissect_options *,const u_char *, u_int); 338extern void isoclns_print(netdissect_options *,const u_char *, 339 u_int, u_int, const u_char *, const u_char *); 340extern void krb_print(netdissect_options *,const u_char *, u_int); 341extern void llap_print(netdissect_options *,const u_char *, u_int); 342extern const char *linkaddr_string(netdissect_options *ndo, 343 const u_char *ep, const unsigned int len); 344extern void ltalk_if_print(netdissect_options *ndo, 345 u_char *user, const struct pcap_pkthdr *h, 346 const u_char *p); 347extern void mpls_print(netdissect_options *ndo, 348 const u_char *bp, u_int length); 349extern void msdp_print(netdissect_options *ndo, 350 const unsigned char *sp, u_int length); 351extern void nfsreply_print(netdissect_options *,const u_char *, 352 u_int, const u_char *); 353extern void nfsreq_print(netdissect_options *,const u_char *, 354 u_int, const u_char *); 355extern void ns_print(netdissect_options *,const u_char *, u_int); 356extern void ntp_print(netdissect_options *,const u_char *, u_int); 357extern void null_if_print(u_char *,const struct pcap_pkthdr *, const u_char *); 358extern void ospf_print(netdissect_options *,const u_char *, 359 u_int, const u_char *); 360extern void pimv1_print(netdissect_options *,const u_char *, u_int); 361extern void mobile_print(netdissect_options *,const u_char *, u_int); 362extern void pim_print(netdissect_options *,const u_char *, u_int, u_int); 363extern void pppoe_if_print(u_char *,const struct pcap_pkthdr *, const u_char *); 364extern void pppoe_print(netdissect_options *,const u_char *, u_int); 365extern void ppp_print(netdissect_options *, 366 register const u_char *, u_int); 367 368extern void ppp_if_print(u_char *,const struct pcap_pkthdr *, const u_char *); 369extern void ppp_hdlc_if_print(u_char *, 370 const struct pcap_pkthdr *, const u_char *); 371extern void ppp_bsdos_if_print(u_char *, 372 const struct pcap_pkthdr *, const u_char *); 373 374extern int vjc_print(netdissect_options *,register const char *, 375 register u_int, u_short); 376 377extern void raw_if_print(u_char *, 378 const struct pcap_pkthdr *, const u_char *); 379 380extern void rip_print(netdissect_options *,const u_char *, u_int); 381 382extern void sctp_print(netdissect_options *ndo, 383 const u_char *bp, const u_char *bp2, 384 u_int sctpPacketLength); 385 386extern void sl_if_print(u_char *,const struct pcap_pkthdr *, const u_char *); 387 388extern void lane_if_print(u_char *,const struct pcap_pkthdr *,const u_char *); 389extern void cip_if_print(u_char *,const struct pcap_pkthdr *,const u_char *); 390extern void sl_bsdos_if_print(u_char *, 391 const struct pcap_pkthdr *, const u_char *); 392extern void sll_if_print(u_char *, 393 const struct pcap_pkthdr *, const u_char *); 394 395extern void snmp_print(netdissect_options *,const u_char *, u_int); 396extern void sunrpcrequest_print(netdissect_options *,const u_char *, 397 u_int, const u_char *); 398extern void tcp_print(netdissect_options *,const u_char *, u_int, 399 const u_char *, int); 400extern void tftp_print(netdissect_options *,const u_char *, u_int); 401extern void timed_print(netdissect_options *,const u_char *, u_int); 402extern void udp_print(netdissect_options *,const u_char *, u_int, 403 const u_char *, int); 404extern void wb_print(netdissect_options *,const void *, u_int); 405extern int ah_print(netdissect_options *,register const u_char *, 406 register const u_char *); 407extern void esp_print_decodesecret(netdissect_options *ndo); 408extern int ipcomp_print(netdissect_options *,register const u_char *, 409 register const u_char *, int *); 410extern void rx_print(netdissect_options *,register const u_char *, 411 int, int, int, u_char *); 412extern void netbeui_print(netdissect_options *,u_short, 413 const u_char *, int); 414extern void ipx_netbios_print(netdissect_options *,const u_char *, u_int); 415extern void nbt_tcp_print(netdissect_options *,const u_char *, int); 416extern void nbt_udp137_print(netdissect_options *, 417 const u_char *data, int); 418extern void nbt_udp138_print(netdissect_options *, 419 const u_char *data, int); 420extern char *smb_errstr(netdissect_options *,int, int); 421extern const char *nt_errstr(netdissect_options *, u_int32_t); 422extern void print_data(netdissect_options *,const unsigned char *, int); 423extern void l2tp_print(netdissect_options *,const u_char *, u_int); 424extern void lcp_print(netdissect_options *,const u_char *, u_int); 425extern void vrrp_print(netdissect_options *,const u_char *bp, 426 u_int len, int ttl); 427extern void cdp_print(netdissect_options *,const u_char *, 428 u_int, u_int, const u_char *, const u_char *); 429extern void stp_print(netdissect_options *,const u_char *p, u_int length); 430extern void radius_print(netdissect_options *,const u_char *, u_int); 431extern void lwres_print(netdissect_options *,const u_char *, u_int); 432extern void pptp_print(netdissect_options *,const u_char *, u_int); 433#endif 434 435extern u_int ipnet_if_print(netdissect_options *,const struct pcap_pkthdr *, const u_char *); 436 437#if 0 438#ifdef INET6 439extern void ip6_print(netdissect_options *,const u_char *, u_int); 440extern void ip6_opt_print(netdissect_options *,const u_char *, int); 441extern int nextproto6_cksum(const struct ip6_hdr *, const u_short *, u_int, u_int); 442extern int hbhopt_print(netdissect_options *,const u_char *); 443extern int dstopt_print(netdissect_options *,const u_char *); 444extern int frag6_print(netdissect_options *,const u_char *, 445 const u_char *); 446extern void icmp6_print(netdissect_options *,const u_char *, 447 const u_char *); 448extern void ripng_print(netdissect_options *,const u_char *, int); 449extern int rt6_print(netdissect_options *,const u_char *, const u_char *); 450extern void ospf6_print(netdissect_options *,const u_char *, u_int); 451extern void dhcp6_print(netdissect_options *,const u_char *, 452 u_int, u_int16_t, u_int16_t); 453 454extern void zephyr_print(netdissect_options * ndo, 455 const u_char *cp, int length); 456 457#endif /*INET6*/ 458extern u_short in_cksum(const u_short *, 459 register u_int, int); 460 461#endif 462 463extern void esp_print_decodesecret(netdissect_options *ndo); 464extern int esp_print_decrypt_buffer_by_ikev2(netdissect_options *ndo, 465 int initiator, 466 u_char spii[8], u_char spir[8], 467 u_char *buf, u_char *end); 468 469 470#endif /* netdissect_h */ 471