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