1/* IPFW backward compatibility */ 2 3#ifndef _IP_FW_COMPAT_H_ 4#define _IP_FW_COMPAT_H_ 5 6#if !__LP64__ 7 8/* prototypes */ 9void ipfw_convert_from_latest(struct ip_fw *curr_rule, void *old_rule, u_int32_t api_version); 10int ipfw_convert_to_latest(struct sockopt *sopt, struct ip_fw *rule, int api_version); 11int ipfw_get_command_and_version(struct sockopt *sopt, int *command, u_int32_t *api_version); 12 13 14/* 15 * ****************************** 16 * ****** IPFW version one ****** 17 * ****************************** 18 */ 19 20/* 21 * This union structure identifies an interface, either explicitly 22 * by name or implicitly by IP address. The flags IP_FW_F_IIFNAME 23 * and IP_FW_F_OIFNAME say how to interpret this structure. An 24 * interface unit number of -1 matches any unit number, while an 25 * IP address of 0.0.0.0 indicates matches any interface. 26 * 27 * The receive and transmit interfaces are only compared against the 28 * the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE) 29 * is set. Note some packets lack a receive or transmit interface 30 * (in which case the missing "interface" never matches). 31 */ 32 33union ip_fw_if_compat { 34 struct in_addr fu_via_ip; /* Specified by IP address */ 35 struct { /* Specified by interface name */ 36#define FW_IFNLEN_COMPAT 10 /* need room ! was IFNAMSIZ */ 37 char name[FW_IFNLEN_COMPAT]; 38 short unit; /* -1 means match any unit */ 39 } fu_via_if_compat; 40}; 41 42/* 43 * Format of an IP firewall descriptor 44 * 45 * fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order. 46 * fw_flg and fw_n*p are stored in host byte order (of course). 47 * Port numbers are stored in HOST byte order. 48 */ 49 50struct ip_fw_compat { 51 u_int32_t version; /* Version of this structure. Should always be */ 52 /* set to IP_FW_CURRENT_API_VERSION by clients. */ 53 void *context; /* Context that is usable by user processes to */ 54 /* identify this rule. */ 55 u_int64_t fw_pcnt,fw_bcnt; /* Packet and byte counters */ 56 struct in_addr fw_src, fw_dst; /* Source and destination IP addr */ 57 struct in_addr fw_smsk, fw_dmsk; /* Mask for src and dest IP addr */ 58 u_short fw_number; /* Rule number */ 59 u_int fw_flg; /* Flags word */ 60#define IP_FW_MAX_PORTS_COMPAT 10 /* A reasonable maximum */ 61 union { 62 u_short fw_pts[IP_FW_MAX_PORTS_COMPAT]; /* Array of port numbers to match */ 63#define IP_FW_ICMPTYPES_MAX_COMPAT 128 64#define IP_FW_ICMPTYPES_DIM_COMPAT (IP_FW_ICMPTYPES_MAX_COMPAT / (sizeof(unsigned) * 8)) 65 unsigned fw_icmptypes[IP_FW_ICMPTYPES_DIM_COMPAT]; /* ICMP types bitmap */ 66 } fw_uar_compat; 67 u_int fw_ipflg; /* IP flags word */ 68 u_char fw_ipopt,fw_ipnopt; /* IP options set/unset */ 69 u_char fw_tcpopt,fw_tcpnopt; /* TCP options set/unset */ 70 u_char fw_tcpf,fw_tcpnf; /* TCP flags set/unset */ 71 long timestamp; /* timestamp (tv_sec) of last match */ 72 union ip_fw_if_compat fw_in_if, fw_out_if; /* Incoming and outgoing interfaces */ 73 union { 74 u_short fu_divert_port; /* Divert/tee port (options IPDIVERT) */ 75 u_short fu_pipe_nr; /* queue number (option DUMMYNET) */ 76 u_short fu_skipto_rule; /* SKIPTO command rule number */ 77 u_short fu_reject_code; /* REJECT response code */ 78 struct sockaddr_in fu_fwd_ip; 79 } fw_un_compat; 80 u_char fw_prot; /* IP protocol */ 81 /* 82 * N'of src ports and # of dst ports in ports array (dst ports 83 * follow src ports; max of 10 ports in all; count of 0 means 84 * match all ports) 85 */ 86 u_char fw_nports; 87 void *pipe_ptr; /* flow_set ptr for dummynet pipe */ 88 void *next_rule_ptr ; /* next rule in case of match */ 89 uid_t fw_uid; /* uid to match */ 90 int fw_logamount; /* amount to log */ 91 u_int64_t fw_loghighest; /* highest number packet to log */ 92}; 93 94/* 95 * extended ipfw structure... some fields in the original struct 96 * can be used to pass parameters up/down, namely pointers 97 * void *pipe_ptr 98 * void *next_rule_ptr 99 * some others can be used to pass parameters down, namely counters etc. 100 * u_int64_t fw_pcnt,fw_bcnt; 101 * long timestamp; 102 */ 103 104struct ip_fw_ext_compat { /* extended structure */ 105 struct ip_fw rule; /* must be at offset 0 */ 106 long dont_match_prob; /* 0x7fffffff means 1.0, always fail */ 107 u_int dyn_type; /* type for dynamic rule */ 108}; 109 110struct ip_fw_chain_compat { 111 LIST_ENTRY(ip_fw_chain_compat) next; 112 struct ip_fw_compat *rule; 113}; 114 115/* 116 * dynamic ipfw rule 117 */ 118struct ipfw_dyn_rule_compat { 119 struct ipfw_dyn_rule *next ; 120 121 struct ipfw_flow_id id ; 122 struct ipfw_flow_id mask ; 123 struct ip_fw_chain_compat *chain ; /* pointer to parent rule */ 124 u_int32_t type ; /* rule type */ 125 u_int32_t expire ; /* expire time */ 126 u_int64_t pcnt, bcnt; /* match counters */ 127 u_int32_t bucket ; /* which bucket in hash table */ 128 u_int32_t state ; /* state of this rule (typ. a */ 129 /* combination of TCP flags) */ 130} ; 131 132#define IP_FW_GETNSRCP_COMPAT(rule) ((rule)->fw_nports & 0x0f) 133#define IP_FW_SETNSRCP_COMPAT(rule, n) do { \ 134 (rule)->fw_nports &= ~0x0f; \ 135 (rule)->fw_nports |= (n); \ 136 } while (0) 137#define IP_FW_GETNDSTP_COMPAT(rule) ((rule)->fw_nports >> 4) 138#define IP_FW_SETNDSTP_COMPAT(rule, n) do { \ 139 (rule)->fw_nports &= ~0xf0; \ 140 (rule)->fw_nports |= (n) << 4;\ 141 } while (0) 142 143#define fw_divert_port_compat fw_un_compat.fu_divert_port 144#define fw_skipto_rule_compat fw_un_compat.fu_skipto_rule 145#define fw_reject_code_compat fw_un_compat.fu_reject_code 146#define fw_pipe_nr_compat fw_un_compat.fu_pipe_nr 147#define fw_fwd_ip_compat fw_un_compat.fu_fwd_ip 148 149/* 150 * Values for "flags" field . 151 */ 152#define IP_FW_F_COMMAND_COMPAT 0x000000ff /* Mask for type of chain entry: */ 153#define IP_FW_F_DENY_COMPAT 0x00000000 /* This is a deny rule */ 154#define IP_FW_F_REJECT_COMPAT 0x00000001 /* Deny and send a response packet */ 155#define IP_FW_F_ACCEPT_COMPAT 0x00000002 /* This is an accept rule */ 156#define IP_FW_F_COUNT_COMPAT 0x00000003 /* This is a count rule */ 157#define IP_FW_F_DIVERT_COMPAT 0x00000004 /* This is a divert rule */ 158#define IP_FW_F_TEE_COMPAT 0x00000005 /* This is a tee rule */ 159#define IP_FW_F_SKIPTO_COMPAT 0x00000006 /* This is a skipto rule */ 160#define IP_FW_F_FWD_COMPAT 0x00000007 /* This is a "change forwarding address" rule */ 161#define IP_FW_F_PIPE_COMPAT 0x00000008 /* This is a dummynet rule */ 162#define IP_FW_F_QUEUE_COMPAT 0x00000009 /* This is a dummynet queue */ 163 164#define IP_FW_F_IN_COMPAT 0x00000100 /* Check inbound packets */ 165#define IP_FW_F_OUT_COMPAT 0x00000200 /* Check outbound packets */ 166#define IP_FW_F_IIFACE_COMPAT 0x00000400 /* Apply inbound interface test */ 167#define IP_FW_F_OIFACE_COMPAT 0x00000800 /* Apply outbound interface test */ 168 169#define IP_FW_F_PRN_COMPAT 0x00001000 /* Print if this rule matches */ 170 171#define IP_FW_F_SRNG_COMPAT 0x00002000 /* The first two src ports are a min * 172 * and max range (stored in host byte * 173 * order). */ 174 175#define IP_FW_F_DRNG_COMPAT 0x00004000 /* The first two dst ports are a min * 176 * and max range (stored in host byte * 177 * order). */ 178 179#define IP_FW_F_FRAG_COMPAT 0x00008000 /* Fragment */ 180 181#define IP_FW_F_IIFNAME_COMPAT 0x00010000 /* In interface by name/unit (not IP) */ 182#define IP_FW_F_OIFNAME_COMPAT 0x00020000 /* Out interface by name/unit (not IP) */ 183 184#define IP_FW_F_INVSRC_COMPAT 0x00040000 /* Invert sense of src check */ 185#define IP_FW_F_INVDST_COMPAT 0x00080000 /* Invert sense of dst check */ 186 187#define IP_FW_F_ICMPBIT_COMPAT 0x00100000 /* ICMP type bitmap is valid */ 188 189#define IP_FW_F_UID_COMPAT 0x00200000 /* filter by uid */ 190 191#define IP_FW_F_RND_MATCH_COMPAT 0x00800000 /* probabilistic rule match */ 192#define IP_FW_F_SMSK_COMPAT 0x01000000 /* src-port + mask */ 193#define IP_FW_F_DMSK_COMPAT 0x02000000 /* dst-port + mask */ 194#define IP_FW_BRIDGED_COMPAT 0x04000000 /* only match bridged packets */ 195#define IP_FW_F_KEEP_S_COMPAT 0x08000000 /* keep state */ 196#define IP_FW_F_CHECK_S_COMPAT 0x10000000 /* check state */ 197 198#define IP_FW_F_SME_COMPAT 0x20000000 /* source = me */ 199#define IP_FW_F_DME_COMPAT 0x40000000 /* destination = me */ 200 201#define IP_FW_F_MASK_COMPAT 0x7FFFFFFF /* All possible flag bits mask */ 202 203/* 204 * Flags for the 'fw_ipflg' field, for comparing values of ip and its protocols. 205 */ 206#define IP_FW_IF_TCPEST_COMPAT 0x00000020 /* established TCP connection */ 207#define IP_FW_IF_TCPMSK_COMPAT 0x00000020 /* mask of all TCP values */ 208 209/* 210 * Definitions for TCP flags. 211 */ 212#define IP_FW_TCPF_FIN_COMPAT TH_FIN 213#define IP_FW_TCPF_SYN_COMPAT TH_SYN 214#define IP_FW_TCPF_RST_COMPAT TH_RST 215#define IP_FW_TCPF_PSH_COMPAT TH_PUSH 216#define IP_FW_TCPF_ACK_COMPAT TH_ACK 217#define IP_FW_TCPF_URG_COMPAT TH_URG 218 219/* 220 * For backwards compatibility with rules specifying "via iface" but 221 * not restricted to only "in" or "out" packets, we define this combination 222 * of bits to represent this configuration. 223 */ 224 225#define IF_FW_F_VIAHACK_COMPAT (IP_FW_F_IN_COMPAT|IP_FW_F_OUT_COMPAT|IP_FW_F_IIFACE_COMPAT|IP_FW_F_OIFACE_COMPAT) 226 227/* 228 * Definitions for REJECT response codes. 229 * Values less than 256 correspond to ICMP unreachable codes. 230 */ 231#define IP_FW_REJECT_RST_COMPAT 0x0100 /* TCP packets: send RST */ 232 233 234/* 235 * ****************************** 236 * ****** IPFW version zero ***** 237 * ****************************** 238 */ 239 240/* 241 * This union structure identifies an interface, either explicitly 242 * by name or implicitly by IP address. The flags IP_FW_F_IIFNAME 243 * and IP_FW_F_OIFNAME say how to interpret this structure. An 244 * interface unit number of -1 matches any unit number, while an 245 * IP address of 0.0.0.0 indicates matches any interface. 246 * 247 * The receive and transmit interfaces are only compared against the 248 * the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE) 249 * is set. Note some packets lack a receive or transmit interface 250 * (in which case the missing "interface" never matches). 251 */ 252 253union ip_old_fw_if { 254 struct in_addr fu_via_ip; /* Specified by IP address */ 255 struct { /* Specified by interface name */ 256#define OLD_FW_IFNLEN 10 /* need room ! was IFNAMSIZ */ 257 char name[OLD_FW_IFNLEN]; 258 short unit; /* -1 means match any unit */ 259 } fu_via_if; 260}; 261 262/* 263 * Format of an IP firewall descriptor 264 * 265 * fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order. 266 * fw_flg and fw_n*p are stored in host byte order (of course). 267 * Port numbers are stored in HOST byte order. 268 * Warning: setsockopt() will fail if sizeof(struct ip_fw) > MLEN (108) 269 */ 270 271struct ip_old_fw { 272 u_int64_t fw_pcnt,fw_bcnt; /* Packet and byte counters */ 273 struct in_addr fw_src, fw_dst; /* Source and destination IP addr */ 274 struct in_addr fw_smsk, fw_dmsk; /* Mask for src and dest IP addr */ 275 u_short fw_number; /* Rule number */ 276 u_int fw_flg; /* Flags word */ 277#define IP_OLD_FW_MAX_PORTS 10 /* A reasonable maximum */ 278 union { 279 u_short fw_pts[IP_OLD_FW_MAX_PORTS]; /* Array of port numbers to match */ 280#define IP_OLD_FW_ICMPTYPES_MAX 128 281#define IP_OLD_FW_ICMPTYPES_DIM (IP_OLD_FW_ICMPTYPES_MAX / (sizeof(unsigned) * 8)) 282 unsigned fw_icmptypes[IP_OLD_FW_ICMPTYPES_DIM]; /* ICMP types bitmap */ 283 } fw_uar; 284 u_char fw_ipopt,fw_ipnopt; /* IP options set/unset */ 285 u_char fw_tcpf,fw_tcpnf; /* TCP flags set/unset */ 286 long timestamp; /* timestamp (tv_sec) of last match */ 287 union ip_old_fw_if fw_in_if, fw_out_if; /* Incoming and outgoing interfaces */ 288 union { 289 u_short fu_divert_port; /* Divert/tee port (options IPDIVERT) */ 290 u_short fu_pipe_nr; /* pipe number (option DUMMYNET) */ 291 u_short fu_skipto_rule; /* SKIPTO command rule number */ 292 u_short fu_reject_code; /* REJECT response code */ 293 struct sockaddr_in fu_fwd_ip; 294 } fw_un; 295 u_char fw_prot; /* IP protocol */ 296 u_char fw_nports; /* N'of src ports and # of dst ports */ 297 /* in ports array (dst ports follow */ 298 /* src ports; max of 10 ports in all; */ 299 /* count of 0 means match all ports) */ 300 void *pipe_ptr; /* Pipe ptr in case of dummynet pipe */ 301 void *next_rule_ptr ; /* next rule in case of match */ 302}; 303 304#define IP_OLD_FW_GETNSRCP(rule) ((rule)->fw_nports & 0x0f) 305#define IP_OLD_FW_SETNSRCP(rule, n) do { \ 306 (rule)->fw_nports &= ~0x0f; \ 307 (rule)->fw_nports |= (n); \ 308 } while (0) 309#define IP_OLD_FW_GETNDSTP(rule) ((rule)->fw_nports >> 4) 310#define IP_OLD_FW_SETNDSTP(rule, n) do { \ 311 (rule)->fw_nports &= ~0xf0; \ 312 (rule)->fw_nports |= (n) << 4;\ 313 } while (0) 314 315#define old_fw_divert_port fw_un.fu_divert_port 316#define old_fw_skipto_rule fw_un.fu_skipto_rule 317#define old_fw_reject_code fw_un.fu_reject_code 318#define old_fw_pipe_nr fw_un.fu_pipe_nr 319#define old_fw_fwd_ip fw_un.fu_fwd_ip 320 321/* 322 * Values for "flags" field . 323 */ 324#define IP_OLD_FW_F_COMMAND 0x000000ff /* Mask for type of chain entry: */ 325#define IP_OLD_FW_F_DENY 0x00000000 /* This is a deny rule */ 326#define IP_OLD_FW_F_REJECT 0x00000001 /* Deny and send a response packet */ 327#define IP_OLD_FW_F_ACCEPT 0x00000002 /* This is an accept rule */ 328#define IP_OLD_FW_F_COUNT 0x00000003 /* This is a count rule */ 329#define IP_OLD_FW_F_DIVERT 0x00000004 /* This is a divert rule */ 330#define IP_OLD_FW_F_TEE 0x00000005 /* This is a tee rule */ 331#define IP_OLD_FW_F_SKIPTO 0x00000006 /* This is a skipto rule */ 332#define IP_OLD_FW_F_FWD 0x00000007 /* This is a "change forwarding address" rule */ 333#define IP_OLD_FW_F_PIPE 0x00000008 /* This is a dummynet rule */ 334 335#define IP_OLD_FW_F_IN 0x00000100 /* Check inbound packets */ 336#define IP_OLD_FW_F_OUT 0x00000200 /* Check outbound packets */ 337#define IP_OLD_FW_F_IIFACE 0x00000400 /* Apply inbound interface test */ 338#define IP_OLD_FW_F_OIFACE 0x00000800 /* Apply outbound interface test */ 339 340#define IP_OLD_FW_F_PRN 0x00001000 /* Print if this rule matches */ 341 342#define IP_OLD_FW_F_SRNG 0x00002000 /* The first two src ports are a min * 343 * and max range (stored in host byte * 344 * order). */ 345 346#define IP_OLD_FW_F_DRNG 0x00004000 /* The first two dst ports are a min * 347 * and max range (stored in host byte * 348 * order). */ 349 350#define IP_OLD_FW_F_FRAG 0x00008000 /* Fragment */ 351 352#define IP_OLD_FW_F_IIFNAME 0x00010000 /* In interface by name/unit (not IP) */ 353#define IP_OLD_FW_F_OIFNAME 0x00020000 /* Out interface by name/unit (not IP) */ 354 355#define IP_OLD_FW_F_INVSRC 0x00040000 /* Invert sense of src check */ 356#define IP_OLD_FW_F_INVDST 0x00080000 /* Invert sense of dst check */ 357 358#define IP_OLD_FW_F_ICMPBIT 0x00100000 /* ICMP type bitmap is valid */ 359 360#define IP_OLD_FW_F_MASK 0x001FFFFF /* All possible flag bits mask */ 361 362/* 363 * For backwards compatibility with rules specifying "via iface" but 364 * not restricted to only "in" or "out" packets, we define this combination 365 * of bits to represent this configuration. 366 */ 367 368#define IF_OLD_FW_F_VIAHACK (IP_OLD_FW_F_IN|IP_OLD_FW_F_OUT|IP_OLD_FW_F_IIFACE|IP_OLD_FW_F_OIFACE) 369 370/* 371 * Definitions for TCP flags - abridged 372 */ 373#define IP_OLD_FW_TCPF_ESTAB 0x40 374 375#endif /* !__LP64__ */ 376#endif /* _IP_FW_COMPAT_H_ */ 377