snoop.h revision 10491:8893b747ecdf
1/* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22/* 23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27#ifndef _SNOOP_H 28#define _SNOOP_H 29 30#include <rpc/types.h> 31#include <sys/pfmod.h> 32#include <sys/time.h> 33#include <sys/types.h> 34#include <sys/socket.h> 35#include <sys/bufmod.h> 36#include <net/if.h> 37#include <netinet/in.h> 38#include <netinet/if_ether.h> 39#include <netinet/in_systm.h> 40#include <netinet/ip.h> 41#include <netinet/ip6.h> 42#include <netinet/ip_icmp.h> 43#include <netinet/icmp6.h> 44#include <net/pppoe.h> 45#include <libdlpi.h> 46 47#ifdef __cplusplus 48extern "C" { 49#endif 50 51/* 52 * Flags to control packet info display 53 */ 54#define F_NOW 0x00000001 /* display in realtime */ 55#define F_SUM 0x00000002 /* display summary line */ 56#define F_ALLSUM 0x00000004 /* display all summary lines */ 57#define F_DTAIL 0x00000008 /* display detail lines */ 58#define F_TIME 0x00000010 /* display time */ 59#define F_ATIME 0x00000020 /* display absolute time */ 60#define F_RTIME 0x00000040 /* display relative time */ 61#define F_DROPS 0x00000080 /* display drops */ 62#define F_LEN 0x00000100 /* display pkt length */ 63#define F_NUM 0x00000200 /* display pkt number */ 64#define F_WHO 0x00000400 /* display src/dst */ 65 66#define MAXLINE (1088) /* max len of detail line */ 67 68#define MAX_HDRTRAILER (64) /* max hdr/trailer packet slack */ 69 70/* 71 * The RPC XID cache structure. 72 * When analyzing RPC protocols we 73 * have to cache the xid of the RPC 74 * request together with the program 75 * number, proc, version etc since this 76 * information is missing in the reply 77 * packet. Using the xid in the reply 78 * we can lookup this previously stashed 79 * information in the cache. 80 * 81 * For RPCSEC_GSS flavor, some special processing is 82 * needed for the argument interpretation based on its 83 * control procedure and service type. This information 84 * is stored in the cache table during interpretation of 85 * the rpc header and will be referenced later when the rpc 86 * argument is interpreted. 87 */ 88#define XID_CACHE_SIZE 256 89struct cache_struct { 90 int xid_num; /* RPC transaction id */ 91 int xid_frame; /* Packet number */ 92 int xid_prog; /* RPC program number */ 93 int xid_vers; /* RPC version number */ 94 int xid_proc; /* RPC procedure number */ 95 unsigned int xid_gss_proc; /* control procedure */ 96 int xid_gss_service; /* none, integ, priv */ 97} xid_cache[XID_CACHE_SIZE]; 98 99 100/* 101 * The following macros advance the pointer passed to them. They 102 * assume they are given a char *. 103 */ 104#define GETINT8(v, ptr) { \ 105 (v) = (*(ptr)++); \ 106} 107 108#define GETINT16(v, ptr) { \ 109 (v) = *(ptr)++ << 8; \ 110 (v) |= *(ptr)++; \ 111} 112 113#define GETINT32(v, ptr) { \ 114 (v) = *(ptr)++ << 8; \ 115 (v) |= *(ptr)++; (v) <<= 8; \ 116 (v) |= *(ptr)++; (v) <<= 8; \ 117 (v) |= *(ptr)++; \ 118} 119 120/* 121 * Used to print nested protocol layers. For example, an ip datagram included 122 * in an icmp error, or a PPP packet included in an LCP protocol reject.. 123 */ 124extern char *prot_nest_prefix; 125 126extern char *get_sum_line(void); 127extern char *get_detail_line(int, int); 128extern void set_vlan_id(int); 129extern struct timeval prev_time; 130extern void process_pkt(struct sb_hdr *, char *, int, int); 131extern char *getflag(int, int, char *, char *); 132extern void show_header(char *, char *, int); 133extern void xdr_init(char *, int); 134extern char *get_line(int, int); 135extern int get_line_remain(void); 136extern char getxdr_char(void); 137extern char showxdr_char(char *); 138extern uchar_t getxdr_u_char(void); 139extern uchar_t showxdr_u_char(char *); 140extern short getxdr_short(void); 141extern short showxdr_short(char *); 142extern ushort_t getxdr_u_short(void); 143extern ushort_t showxdr_u_short(char *); 144extern long getxdr_long(void); 145extern long showxdr_long(char *); 146extern ulong_t getxdr_u_long(void); 147extern ulong_t showxdr_u_long(char *); 148extern longlong_t getxdr_longlong(void); 149extern longlong_t showxdr_longlong(char *); 150extern u_longlong_t getxdr_u_longlong(void); 151extern u_longlong_t showxdr_u_longlong(char *); 152extern char *getxdr_opaque(char *, int); 153extern char *getxdr_string(char *, int); 154extern char *showxdr_string(int, char *); 155extern char *getxdr_bytes(uint_t *); 156extern void xdr_skip(int); 157extern int getxdr_pos(void); 158extern void setxdr_pos(int); 159extern char *getxdr_context(char *, int); 160extern char *showxdr_context(char *); 161extern enum_t getxdr_enum(void); 162extern void show_space(void); 163extern void show_trailer(void); 164extern char *getxdr_date(void); 165extern char *showxdr_date(char *); 166extern char *getxdr_date_ns(void); 167char *format_time(int64_t sec, uint32_t nsec); 168extern char *showxdr_date_ns(char *); 169extern char *getxdr_hex(int); 170extern char *showxdr_hex(int, char *); 171extern bool_t getxdr_bool(void); 172extern bool_t showxdr_bool(char *); 173extern char *concat_args(char **, int); 174extern int pf_compile(char *, int); 175extern void compile(char *, int); 176extern void load_names(char *); 177extern void cap_write(struct sb_hdr *, char *, int, int); 178extern void cap_open_read(const char *); 179extern void cap_open_write(const char *); 180extern void cap_read(int, int, int, void (*)(), int); 181extern void cap_close(void); 182extern boolean_t open_datalink(dlpi_handle_t *, const char *); 183extern void init_datalink(dlpi_handle_t, ulong_t, ulong_t, struct timeval *, 184 struct Pf_ext_packetfilt *); 185extern void net_read(dlpi_handle_t, size_t, int, void (*)(), int); 186extern void click(int); 187extern void show_pktinfo(int, int, char *, char *, struct timeval *, 188 struct timeval *, int, int); 189extern void show_line(char *); 190extern char *getxdr_time(void); 191extern char *showxdr_time(char *); 192extern char *addrtoname(int, const void *); 193extern char *show_string(const char *, int, int); 194extern void pr_err(const char *, ...); 195extern void pr_errdlpi(dlpi_handle_t, const char *, int); 196extern void check_retransmit(char *, ulong_t); 197extern char *nameof_prog(int); 198extern char *getproto(int); 199extern uint8_t print_ipv6_extensions(int, uint8_t **, uint8_t *, int *, int *); 200extern void protoprint(int, int, ulong_t, int, int, int, char *, int); 201extern char *getportname(int, in_port_t); 202 203extern void interpret_arp(int, struct arphdr *, int); 204extern void interpret_bparam(int, int, int, int, int, char *, int); 205extern void interpret_dns(int, int, const uchar_t *, int, int); 206extern void interpret_mount(int, int, int, int, int, char *, int); 207extern void interpret_nfs(int, int, int, int, int, char *, int); 208extern void interpret_nfs3(int, int, int, int, int, char *, int); 209extern void interpret_nfs4(int, int, int, int, int, char *, int); 210extern void interpret_nfs4_cb(int, int, int, int, int, char *, int); 211extern void interpret_nfs_acl(int, int, int, int, int, char *, int); 212extern void interpret_nis(int, int, int, int, int, char *, int); 213extern void interpret_nisbind(int, int, int, int, int, char *, int); 214extern void interpret_nisp_cb(int, int, int, int, int, char *, int); 215extern void interpret_nisplus(int, int, int, int, int, char *, int); 216extern void interpret_nlm(int, int, int, int, int, char *, int); 217extern void interpret_pmap(int, int, int, int, int, char *, int); 218extern int interpret_reserved(int, int, in_port_t, in_port_t, char *, int); 219extern void interpret_rquota(int, int, int, int, int, char *, int); 220extern void interpret_rstat(int, int, int, int, int, char *, int); 221extern void interpret_solarnet_fw(int, int, int, int, int, char *, int); 222extern void interpret_ldap(int, char *, int, int, int); 223extern void interpret_icmp(int, struct icmp *, int, int); 224extern void interpret_icmpv6(int, icmp6_t *, int, int); 225extern int interpret_ip(int, const struct ip *, int); 226extern int interpret_ipv6(int, const ip6_t *, int); 227extern int interpret_ppp(int, uchar_t *, int); 228extern int interpret_pppoe(int, poep_t *, int); 229struct tcphdr; 230extern int interpret_tcp(int, struct tcphdr *, int, int); 231struct udphdr; 232extern int interpret_udp(int, struct udphdr *, int, int); 233extern int interpret_esp(int, uint8_t *, int, int); 234extern int interpret_ah(int, uint8_t *, int, int); 235struct sctp_hdr; 236extern void interpret_sctp(int, struct sctp_hdr *, int, int); 237extern void interpret_mip_cntrlmsg(int, uchar_t *, int); 238struct dhcp; 239extern int interpret_dhcp(int, struct dhcp *, int); 240extern int interpret_dhcpv6(int, const uint8_t *, int); 241struct tftphdr; 242extern int interpret_tftp(int, struct tftphdr *, int); 243extern int interpret_http(int, char *, int); 244struct ntpdata; 245extern int interpret_ntp(int, struct ntpdata *, int); 246extern void interpret_netbios_ns(int, uchar_t *, int); 247extern void interpret_netbios_datagram(int, uchar_t *, int); 248extern void interpret_netbios_ses(int, uchar_t *, int); 249extern void interpret_slp(int, char *, int); 250struct rip; 251extern int interpret_rip(int, struct rip *, int); 252struct rip6; 253extern int interpret_rip6(int, struct rip6 *, int); 254extern int interpret_socks_call(int, char *, int); 255extern int interpret_socks_reply(int, char *, int); 256extern int interpret_trill(int, struct ether_header **, char *, int *); 257extern int interpret_isis(int, char *, int, boolean_t); 258extern int interpret_bpdu(int, char *, int); 259extern void init_ldap(void); 260extern boolean_t arp_for_ether(char *, struct ether_addr *); 261extern char *ether_ouiname(uint32_t); 262extern char *tohex(char *p, int len); 263extern char *printether(struct ether_addr *); 264extern char *print_ethertype(int); 265extern const char *arp_htype(int); 266 267/* 268 * Describes characteristics of the Media Access Layer. 269 * The mac_type is one of the supported DLPI media 270 * types (see <sys/dlpi.h>). 271 * The mtu_size is the size of the largest frame. 272 * network_type_offset is where the network type 273 * is located in the link layer header. 274 * The header length is returned by a function to 275 * allow for variable header size - for ethernet it's 276 * just a constant 14 octets. 277 * The interpreter is the function that "knows" how 278 * to interpret the frame. 279 * try_kernel_filter tells snoop to first try a kernel 280 * filter (because the header size is fixed, or if it could 281 * be of variable size where the variable size is easy for a kernel 282 * filter to handle, for example, Ethernet and VLAN tags) 283 * and only use a user space filter if the filter expression 284 * cannot be expressed in kernel space. 285 */ 286typedef struct interface { 287 uint_t mac_type; 288 uint_t mtu_size; 289 uint_t network_type_offset; 290 size_t network_type_len; 291 uint_t network_type_ip; 292 uint_t network_type_ipv6; 293 uint_t (*header_len)(char *); 294 uint_t (*interpreter)(int, char *, int, int); 295 boolean_t try_kernel_filter; 296} interface_t; 297 298extern interface_t INTERFACES[], *interface; 299extern char *dlc_header; 300extern char *src_name, *dst_name; 301extern char *prot_prefix; 302extern char *prot_nest_prefix; 303extern char *prot_title; 304 305/* Keep track of how many nested IP headers we have. */ 306extern unsigned int encap_levels, total_encap_levels; 307 308extern int quitting; 309extern boolean_t Iflg, Pflg, rflg; 310 311/* 312 * Global error recovery routine: used to reset snoop variables after 313 * catastrophic failure. 314 */ 315void snoop_recover(void); 316 317/* 318 * Global alarm handler structure for managing multiple alarms within 319 * snoop. 320 */ 321typedef struct snoop_handler { 322 struct snoop_handler *s_next; /* next alarm handler */ 323 time_t s_time; /* time to fire */ 324 void (*s_handler)(); /* alarm handler */ 325} snoop_handler_t; 326 327#define SNOOP_MAXRECOVER 20 /* maxium number of recoveries */ 328#define SNOOP_ALARM_GRAN 3 /* alarm() timeout multiplier */ 329 330/* 331 * Global alarm handler management routine. 332 */ 333extern int snoop_alarm(int s_sec, void (*s_handler)()); 334 335/* 336 * The next two definitions do not take into account the length 337 * of the underlying link header. In order to use them, you must 338 * add link_header_len to them. The reason it is not done here is 339 * that later these macros are used to initialize a table. 340 */ 341#define IPV4_TYPE_HEADER_OFFSET 9 342#define IPV6_TYPE_HEADER_OFFSET 6 343 344#ifdef __cplusplus 345} 346#endif 347 348#endif /* _SNOOP_H */ 349