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 48 extern "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 89 struct 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 */ 124 extern char *prot_nest_prefix; 125 126 extern char *get_sum_line(void); 127 extern char *get_detail_line(int, int); 128 extern int want_packet(uchar_t *, int, int); 129 extern void set_vlan_id(int); 130 extern struct timeval prev_time; 131 extern void process_pkt(struct sb_hdr *, char *, int, int); 132 extern char *getflag(int, int, char *, char *); 133 extern void show_header(char *, char *, int); 134 extern void show_count(void); 135 extern void xdr_init(char *, int); 136 extern char *get_line(int, int); 137 extern int get_line_remain(void); 138 extern char getxdr_char(void); 139 extern char showxdr_char(char *); 140 extern uchar_t getxdr_u_char(void); 141 extern uchar_t showxdr_u_char(char *); 142 extern short getxdr_short(void); 143 extern short showxdr_short(char *); 144 extern ushort_t getxdr_u_short(void); 145 extern ushort_t showxdr_u_short(char *); 146 extern long getxdr_long(void); 147 extern long showxdr_long(char *); 148 extern ulong_t getxdr_u_long(void); 149 extern ulong_t showxdr_u_long(char *); 150 extern longlong_t getxdr_longlong(void); 151 extern longlong_t showxdr_longlong(char *); 152 extern u_longlong_t getxdr_u_longlong(void); 153 extern u_longlong_t showxdr_u_longlong(char *); 154 extern char *getxdr_opaque(char *, int); 155 extern char *getxdr_string(char *, int); 156 extern char *showxdr_string(int, char *); 157 extern char *getxdr_bytes(uint_t *); 158 extern void xdr_skip(int); 159 extern int getxdr_pos(void); 160 extern void setxdr_pos(int); 161 extern char *getxdr_context(char *, int); 162 extern char *showxdr_context(char *); 163 extern enum_t getxdr_enum(void); 164 extern void show_space(void); 165 extern void show_trailer(void); 166 extern char *getxdr_date(void); 167 extern char *showxdr_date(char *); 168 extern char *getxdr_date_ns(void); 169 char *format_time(int64_t sec, uint32_t nsec); 170 extern char *showxdr_date_ns(char *); 171 extern char *getxdr_hex(int); 172 extern char *showxdr_hex(int, char *); 173 extern bool_t getxdr_bool(void); 174 extern bool_t showxdr_bool(char *); 175 extern char *concat_args(char **, int); 176 extern int pf_compile(char *, int); 177 extern void compile(char *, int); 178 extern void load_names(char *); 179 extern void cap_write(struct sb_hdr *, char *, int, int); 180 extern void cap_open_read(const char *); 181 extern void cap_open_write(const char *); 182 extern void cap_read(int, int, int, void (*)(), int); 183 extern void cap_close(void); 184 extern boolean_t open_datalink(dlpi_handle_t *, const char *); 185 extern void init_datalink(dlpi_handle_t, ulong_t, ulong_t, struct timeval *, 186 struct Pf_ext_packetfilt *); 187 extern void net_read(dlpi_handle_t, size_t, int, void (*)(), int); 188 extern void click(int); 189 extern void show_pktinfo(int, int, char *, char *, struct timeval *, 190 struct timeval *, int, int); 191 extern void show_line(char *); 192 extern char *getxdr_time(void); 193 extern char *showxdr_time(char *); 194 extern char *addrtoname(int, const void *); 195 extern char *show_string(const char *, int, int); 196 extern void pr_err(const char *, ...); 197 extern void pr_errdlpi(dlpi_handle_t, const char *, int); 198 extern void check_retransmit(char *, ulong_t); 199 extern char *nameof_prog(int); 200 extern char *getproto(int); 201 extern uint8_t print_ipv6_extensions(int, uint8_t **, uint8_t *, int *, int *); 202 extern void protoprint(int, int, ulong_t, int, int, int, char *, int); 203 extern char *getportname(int, in_port_t); 204 205 extern void interpret_arp(int, struct arphdr *, int); 206 extern void interpret_bparam(int, int, int, int, int, char *, int); 207 extern void interpret_dns(int, int, const uchar_t *, int, int); 208 extern void interpret_mount(int, int, int, int, int, char *, int); 209 extern void interpret_nfs(int, int, int, int, int, char *, int); 210 extern void interpret_nfs3(int, int, int, int, int, char *, int); 211 extern void interpret_nfs4(int, int, int, int, int, char *, int); 212 extern void interpret_nfs4_cb(int, int, int, int, int, char *, int); 213 extern void interpret_nfs_acl(int, int, int, int, int, char *, int); 214 extern void interpret_nis(int, int, int, int, int, char *, int); 215 extern void interpret_nisbind(int, int, int, int, int, char *, int); 216 extern void interpret_nisp_cb(int, int, int, int, int, char *, int); 217 extern void interpret_nisplus(int, int, int, int, int, char *, int); 218 extern void interpret_nlm(int, int, int, int, int, char *, int); 219 extern void interpret_pmap(int, int, int, int, int, char *, int); 220 extern int interpret_reserved(int, int, in_port_t, in_port_t, char *, int); 221 extern void interpret_rquota(int, int, int, int, int, char *, int); 222 extern void interpret_rstat(int, int, int, int, int, char *, int); 223 extern void interpret_solarnet_fw(int, int, int, int, int, char *, int); 224 extern void interpret_ldap(int, char *, int, int, int); 225 extern void interpret_icmp(int, struct icmp *, int, int); 226 extern void interpret_icmpv6(int, icmp6_t *, int, int); 227 extern int interpret_ip(int, const struct ip *, int); 228 extern int interpret_ipv6(int, const ip6_t *, int); 229 extern int interpret_ppp(int, uchar_t *, int); 230 extern int interpret_pppoe(int, poep_t *, int); 231 struct tcphdr; 232 extern int interpret_tcp(int, struct tcphdr *, int, int); 233 struct udphdr; 234 extern int interpret_udp(int, struct udphdr *, int, int); 235 extern int interpret_esp(int, uint8_t *, int, int); 236 extern int interpret_ah(int, uint8_t *, int, int); 237 struct sctp_hdr; 238 extern void interpret_sctp(int, struct sctp_hdr *, int, int); 239 extern void interpret_mip_cntrlmsg(int, uchar_t *, int); 240 struct dhcp; 241 extern int interpret_dhcp(int, struct dhcp *, int); 242 extern int interpret_dhcpv6(int, const uint8_t *, int); 243 struct tftphdr; 244 extern int interpret_tftp(int, struct tftphdr *, int); 245 extern int interpret_http(int, char *, int); 246 struct ntpdata; 247 extern int interpret_ntp(int, struct ntpdata *, int); 248 extern void interpret_netbios_ns(int, uchar_t *, int); 249 extern void interpret_netbios_datagram(int, uchar_t *, int); 250 extern void interpret_netbios_ses(int, uchar_t *, int); 251 extern void interpret_slp(int, char *, int); 252 struct rip; 253 extern int interpret_rip(int, struct rip *, int); 254 struct rip6; 255 extern int interpret_rip6(int, struct rip6 *, int); 256 extern int interpret_socks_call(int, char *, int); 257 extern int interpret_socks_reply(int, char *, int); 258 extern int interpret_trill(int, struct ether_header **, char *, int *); 259 extern int interpret_isis(int, char *, int, boolean_t); 260 extern int interpret_bpdu(int, char *, int); 261 extern void init_ldap(void); 262 extern boolean_t arp_for_ether(char *, struct ether_addr *); 263 extern char *ether_ouiname(uint32_t); 264 extern char *tohex(char *p, int len); 265 extern char *printether(struct ether_addr *); 266 extern char *print_ethertype(int); 267 extern const char *arp_htype(int); 268 extern int valid_rpc(char *, int); 269 270 /* 271 * Describes characteristics of the Media Access Layer. 272 * The mac_type is one of the supported DLPI media 273 * types (see <sys/dlpi.h>). 274 * The mtu_size is the size of the largest frame. 275 * network_type_offset is where the network type 276 * is located in the link layer header. 277 * The header length is returned by a function to 278 * allow for variable header size - for ethernet it's 279 * just a constant 14 octets. 280 * The interpreter is the function that "knows" how 281 * to interpret the frame. 282 * try_kernel_filter tells snoop to first try a kernel 283 * filter (because the header size is fixed, or if it could 284 * be of variable size where the variable size is easy for a kernel 285 * filter to handle, for example, Ethernet and VLAN tags) 286 * and only use a user space filter if the filter expression 287 * cannot be expressed in kernel space. 288 */ 289 typedef uint_t (interpreter_fn_t)(int, char *, int, int); 290 typedef uint_t (headerlen_fn_t)(char *, size_t); 291 typedef struct interface { 292 uint_t mac_type; 293 uint_t mtu_size; 294 uint_t network_type_offset; 295 size_t network_type_len; 296 uint_t network_type_ip; 297 uint_t network_type_ipv6; 298 headerlen_fn_t *header_len; 299 interpreter_fn_t *interpreter; 300 boolean_t try_kernel_filter; 301 } interface_t; 302 303 extern interface_t INTERFACES[], *interface; 304 extern char *dlc_header; 305 extern char *src_name, *dst_name; 306 extern char *prot_prefix; 307 extern char *prot_nest_prefix; 308 extern char *prot_title; 309 310 /* Keep track of how many nested IP headers we have. */ 311 extern unsigned int encap_levels, total_encap_levels; 312 313 extern int quitting; 314 extern boolean_t Iflg, Pflg, rflg; 315 316 /* 317 * Global error recovery routine: used to reset snoop variables after 318 * catastrophic failure. 319 */ 320 void snoop_recover(void); 321 322 /* 323 * Global alarm handler structure for managing multiple alarms within 324 * snoop. 325 */ 326 typedef struct snoop_handler { 327 struct snoop_handler *s_next; /* next alarm handler */ 328 time_t s_time; /* time to fire */ 329 void (*s_handler)(); /* alarm handler */ 330 } snoop_handler_t; 331 332 #define SNOOP_MAXRECOVER 20 /* maxium number of recoveries */ 333 #define SNOOP_ALARM_GRAN 3 /* alarm() timeout multiplier */ 334 335 /* 336 * Global alarm handler management routine. 337 */ 338 extern int snoop_alarm(int s_sec, void (*s_handler)()); 339 340 /* 341 * The next two definitions do not take into account the length 342 * of the underlying link header. In order to use them, you must 343 * add link_header_len to them. The reason it is not done here is 344 * that later these macros are used to initialize a table. 345 */ 346 #define IPV4_TYPE_HEADER_OFFSET 9 347 #define IPV6_TYPE_HEADER_OFFSET 6 348 349 #ifdef __cplusplus 350 } 351 #endif 352 353 #endif /* _SNOOP_H */ 354