1 /* 2 * Copyright (C) 1995-2001, 2003 by Darren Reed. 3 * 4 * See the IPFILTER.LICENCE file for details on licencing. 5 * 6 * @(#)ip_nat.h 1.5 2/4/96 7 * $Id: ip_nat.h,v 2.90.2.11 2005/06/18 02:41:32 darrenr Exp $ 8 * 9 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 10 * Use is subject to license terms. 11 */ 12 #pragma ident "%Z%%M% %I% %E% SMI" 13 14 #ifndef __IP_NAT_H__ 15 #define __IP_NAT_H__ 16 17 #ifndef SOLARIS 18 #define SOLARIS (defined(sun) && (defined(__svr4__) || defined(__SVR4))) 19 #endif 20 21 #if defined(__STDC__) || defined(__GNUC__) || defined(_AIX51) 22 #define SIOCADNAT _IOW('r', 60, struct ipfobj) 23 #define SIOCRMNAT _IOW('r', 61, struct ipfobj) 24 #define SIOCGNATS _IOWR('r', 62, struct ipfobj) 25 #define SIOCGNATL _IOWR('r', 63, struct ipfobj) 26 #else 27 #define SIOCADNAT _IOW(r, 60, struct ipfobj) 28 #define SIOCRMNAT _IOW(r, 61, struct ipfobj) 29 #define SIOCGNATS _IOWR(r, 62, struct ipfobj) 30 #define SIOCGNATL _IOWR(r, 63, struct ipfobj) 31 #endif 32 33 #undef LARGE_NAT /* define this if you're setting up a system to NAT 34 * LARGE numbers of networks/hosts - i.e. in the 35 * hundreds or thousands. In such a case, you should 36 * also change the RDR_SIZE and NAT_SIZE below to more 37 * appropriate sizes. The figures below were used for 38 * a setup with 1000-2000 networks to NAT. 39 */ 40 #ifndef NAT_SIZE 41 # ifdef LARGE_NAT 42 # define NAT_SIZE 2047 43 # else 44 # define NAT_SIZE 127 45 # endif 46 #endif 47 #ifndef RDR_SIZE 48 # ifdef LARGE_NAT 49 # define RDR_SIZE 2047 50 # else 51 # define RDR_SIZE 127 52 # endif 53 #endif 54 #ifndef HOSTMAP_SIZE 55 # ifdef LARGE_NAT 56 # define HOSTMAP_SIZE 8191 57 # else 58 # define HOSTMAP_SIZE 2047 59 # endif 60 #endif 61 #ifndef NAT_TABLE_MAX 62 /* 63 * This is newly introduced and for the sake of "least surprise", the numbers 64 * present aren't what we'd normally use for creating a proper hash table. 65 */ 66 # ifdef LARGE_NAT 67 # define NAT_TABLE_MAX 180000 68 # else 69 # define NAT_TABLE_MAX 30000 70 # endif 71 #endif 72 #ifndef NAT_TABLE_SZ 73 # ifdef LARGE_NAT 74 # define NAT_TABLE_SZ 16383 75 # else 76 # define NAT_TABLE_SZ 2047 77 # endif 78 #endif 79 #ifndef APR_LABELLEN 80 #define APR_LABELLEN 16 81 #endif 82 83 #define DEF_NAT_AGE 1200 /* 10 minutes (600 seconds) */ 84 85 /* 86 * Default hi and lo watermarks used with forced flush of nat table. 87 */ 88 89 #define NAT_FLUSH_HI 95 90 #define NAT_FLUSH_LO 75 91 92 /* How full is the nat table? */ 93 94 #define NAT_TAB_WATER_LEVEL(x) ((x)->ifs_nat_stats.ns_inuse * 100 \ 95 / (x)->ifs_ipf_nattable_max) 96 97 struct ipstate; 98 struct ap_session; 99 100 typedef struct nat { 101 ipfmutex_t nat_lock; 102 struct nat *nat_next; 103 struct nat **nat_pnext; 104 struct nat *nat_hnext[2]; 105 struct nat **nat_phnext[2]; 106 struct hostmap *nat_hm; 107 void *nat_data; 108 struct nat **nat_me; 109 struct ipstate *nat_state; 110 struct ap_session *nat_aps; /* proxy session */ 111 frentry_t *nat_fr; /* filter rule ptr if appropriate */ 112 struct ipnat *nat_ptr; /* pointer back to the rule */ 113 void *nat_ifps[2]; 114 void *nat_sync; 115 ipftqent_t nat_tqe; 116 u_32_t nat_flags; 117 u_32_t nat_sumd[2]; /* ip checksum delta for data segment */ 118 u_32_t nat_ipsumd; /* ip checksum delta for ip header */ 119 u_32_t nat_mssclamp; /* if != zero clamp MSS to this */ 120 i6addr_t nat_inip6; 121 i6addr_t nat_outip6; 122 i6addr_t nat_oip6; /* other ip */ 123 U_QUAD_T nat_pkts[2]; 124 U_QUAD_T nat_bytes[2]; 125 union { 126 udpinfo_t nat_unu; 127 tcpinfo_t nat_unt; 128 icmpinfo_t nat_uni; 129 greinfo_t nat_ugre; 130 } nat_un; 131 u_short nat_oport; /* other port */ 132 u_short nat_use; 133 u_char nat_p; /* protocol for NAT */ 134 int nat_dir; 135 int nat_ref; /* reference count */ 136 int nat_hv[2]; 137 char nat_ifnames[2][LIFNAMSIZ]; 138 int nat_rev; /* 0 = forward, 1 = reverse */ 139 int nat_v; 140 int nat_redir; /* copy of in_redir */ 141 } nat_t; 142 143 #define nat_inip nat_inip6.in4 144 #define nat_outip nat_outip6.in4 145 #define nat_oip nat_oip6.in4 146 #define nat_age nat_tqe.tqe_die 147 #define nat_inport nat_un.nat_unt.ts_sport 148 #define nat_outport nat_un.nat_unt.ts_dport 149 #define nat_type nat_un.nat_uni.ici_type 150 #define nat_seq nat_un.nat_uni.ici_seq 151 #define nat_id nat_un.nat_uni.ici_id 152 #define nat_tcpstate nat_tqe.tqe_state 153 #define nat_touched nat_tqe.tqe_touched 154 155 /* 156 * Values for nat_dir 157 */ 158 #define NAT_INBOUND 0 159 #define NAT_OUTBOUND 1 160 161 /* 162 * Definitions for nat_flags 163 */ 164 #define NAT_TCP 0x0001 /* IPN_TCP */ 165 #define NAT_UDP 0x0002 /* IPN_UDP */ 166 #define NAT_ICMPERR 0x0004 /* IPN_ICMPERR */ 167 #define NAT_ICMPQUERY 0x0008 /* IPN_ICMPQUERY */ 168 #define NAT_SEARCH 0x0010 169 #define NAT_SLAVE 0x0020 /* Slave connection for a proxy */ 170 #define NAT_NOTRULEPORT 0x0040 171 172 #define NAT_TCPUDP (NAT_TCP|NAT_UDP) 173 #define NAT_TCPUDPICMP (NAT_TCP|NAT_UDP|NAT_ICMPERR) 174 #define NAT_TCPUDPICMPQ (NAT_TCP|NAT_UDP|NAT_ICMPQUERY) 175 #define NAT_FROMRULE (NAT_TCP|NAT_UDP) 176 177 /* 0x0100 reserved for FI_W_SPORT */ 178 /* 0x0200 reserved for FI_W_DPORT */ 179 /* 0x0400 reserved for FI_W_SADDR */ 180 /* 0x0800 reserved for FI_W_DADDR */ 181 /* 0x1000 reserved for FI_W_NEWFR */ 182 /* 0x2000 reserved for SI_CLONE */ 183 /* 0x4000 reserved for SI_CLONED */ 184 /* 0x8000 reserved for SI_IGNOREPKT */ 185 186 #define NAT_DEBUG 0x800000 187 188 typedef struct ipnat { 189 struct ipnat *in_next; /* NAT rule list next */ 190 struct ipnat *in_rnext; /* rdr rule hash next */ 191 struct ipnat **in_prnext; /* prior rdr next ptr */ 192 struct ipnat *in_mnext; /* map rule hash next */ 193 struct ipnat **in_pmnext; /* prior map next ptr */ 194 struct ipftq *in_tqehead[2]; 195 void *in_ifps[2]; 196 void *in_apr; 197 char *in_comment; 198 i6addr_t in_next6; 199 u_long in_space; 200 u_long in_hits; 201 u_int in_use; 202 u_int in_hv; 203 int in_flineno; /* conf. file line number */ 204 u_short in_pnext; 205 u_char in_v; 206 u_char in_xxx; 207 /* From here to the end is covered by IPN_CMPSIZ */ 208 u_32_t in_flags; 209 u_32_t in_mssclamp; /* if != 0 clamp MSS to this */ 210 u_int in_age[2]; 211 int in_redir; /* see below for values */ 212 int in_p; /* protocol. */ 213 i6addr_t in_in[2]; 214 i6addr_t in_out[2]; 215 i6addr_t in_src[2]; 216 frtuc_t in_tuc; 217 u_short in_port[2]; 218 u_short in_ppip; /* ports per IP. */ 219 u_short in_ippip; /* IP #'s per IP# */ 220 char in_ifnames[2][LIFNAMSIZ]; 221 char in_plabel[APR_LABELLEN]; /* proxy label. */ 222 ipftag_t in_tag; 223 } ipnat_t; 224 225 #define in_pmin in_port[0] /* Also holds static redir port */ 226 #define in_pmax in_port[1] 227 #define in_nextip in_next6.in4 228 #define in_nip in_next6.in4.s_addr 229 #define in_inip in_in[0].in4.s_addr 230 #define in_inmsk in_in[1].in4.s_addr 231 #define in_outip in_out[0].in4.s_addr 232 #define in_outmsk in_out[1].in4.s_addr 233 #define in_srcip in_src[0].in4.s_addr 234 #define in_srcmsk in_src[1].in4.s_addr 235 #define in_scmp in_tuc.ftu_scmp 236 #define in_dcmp in_tuc.ftu_dcmp 237 #define in_stop in_tuc.ftu_stop 238 #define in_dtop in_tuc.ftu_dtop 239 #define in_sport in_tuc.ftu_sport 240 #define in_dport in_tuc.ftu_dport 241 242 /* 243 * Bit definitions for in_flags 244 */ 245 #define IPN_ANY 0x00000 246 #define IPN_TCP 0x00001 247 #define IPN_UDP 0x00002 248 #define IPN_TCPUDP (IPN_TCP|IPN_UDP) 249 #define IPN_ICMPERR 0x00004 250 #define IPN_TCPUDPICMP (IPN_TCP|IPN_UDP|IPN_ICMPERR) 251 #define IPN_ICMPQUERY 0x00008 252 #define IPN_TCPUDPICMPQ (IPN_TCP|IPN_UDP|IPN_ICMPQUERY) 253 #define IPN_RF (IPN_TCPUDP|IPN_DELETE|IPN_ICMPERR) 254 #define IPN_AUTOPORTMAP 0x00010 255 #define IPN_IPRANGE 0x00020 256 #define IPN_FILTER 0x00040 257 #define IPN_SPLIT 0x00080 258 #define IPN_ROUNDR 0x00100 259 #define IPN_NOTSRC 0x04000 260 #define IPN_NOTDST 0x08000 261 #define IPN_DYNSRCIP 0x10000 /* dynamic src IP# */ 262 #define IPN_DYNDSTIP 0x20000 /* dynamic dst IP# */ 263 #define IPN_DELETE 0x40000 264 #define IPN_STICKY 0x80000 265 #define IPN_FRAG 0x100000 266 #define IPN_FIXEDDPORT 0x200000 267 #define IPN_FINDFORWARD 0x400000 268 #define IPN_IN 0x800000 269 #define IPN_SEQUENTIAL 0x1000000 270 #define IPN_USERFLAGS (IPN_TCPUDP|IPN_AUTOPORTMAP|IPN_IPRANGE|IPN_SPLIT|\ 271 IPN_ROUNDR|IPN_FILTER|IPN_NOTSRC|IPN_NOTDST|\ 272 IPN_FRAG|IPN_STICKY|IPN_FIXEDDPORT|IPN_ICMPQUERY|\ 273 IPN_SEQUENTIAL) 274 275 /* 276 * Values for in_redir 277 */ 278 #define NAT_MAP 0x01 279 #define NAT_REDIRECT 0x02 280 #define NAT_BIMAP (NAT_MAP|NAT_REDIRECT) 281 #define NAT_MAPBLK 0x04 282 283 #define MAPBLK_MINPORT 1024 /* don't use reserved ports for src port */ 284 #define USABLE_PORTS (65536 - MAPBLK_MINPORT) 285 286 #define IPN_CMPSIZ (sizeof (ipnat_t) - offsetof(ipnat_t, in_flags)) 287 288 typedef struct natlookup { 289 i6addr_t nl_inipaddr; 290 i6addr_t nl_outipaddr; 291 i6addr_t nl_realipaddr; 292 int nl_v; 293 int nl_flags; 294 u_short nl_inport; 295 u_short nl_outport; 296 u_short nl_realport; 297 } natlookup_t; 298 299 #define nl_inip nl_inipaddr.in4 300 #define nl_outip nl_outipaddr.in4 301 #define nl_realip nl_realipaddr.in4 302 #define nl_inip6 nl_inipaddr.in6 303 #define nl_outip6 nl_outipaddr.in6 304 #define nl_realip6 nl_realipaddr.in6 305 306 307 typedef struct nat_save { 308 void *ipn_next; 309 struct nat ipn_nat; 310 struct ipnat ipn_ipnat; 311 struct frentry ipn_fr; 312 int ipn_dsize; 313 char ipn_data[4]; 314 } nat_save_t; 315 316 #define ipn_rule ipn_nat.nat_fr 317 318 typedef struct natget { 319 void *ng_ptr; 320 int ng_sz; 321 } natget_t; 322 323 324 #undef tr_flags 325 typedef struct nattrpnt { 326 struct in_addr tr_dstip; /* real destination IP# */ 327 struct in_addr tr_srcip; /* real source IP# */ 328 struct in_addr tr_locip; /* local source IP# */ 329 u_int tr_flags; 330 int tr_expire; 331 u_short tr_dstport; /* real destination port# */ 332 u_short tr_srcport; /* real source port# */ 333 u_short tr_locport; /* local source port# */ 334 struct nattrpnt *tr_hnext; 335 struct nattrpnt **tr_phnext; 336 struct nattrpnt *tr_next; 337 struct nattrpnt **tr_pnext; /* previous next */ 338 } nattrpnt_t; 339 340 #define TN_CMPSIZ offsetof(nattrpnt_t, tr_hnext) 341 342 343 /* 344 * This structure gets used to help NAT sessions keep the same NAT rule (and 345 * thus translation for IP address) when: 346 * (a) round-robin redirects are in use 347 * (b) different IP add 348 */ 349 typedef struct hostmap { 350 struct hostmap *hm_next; 351 struct hostmap **hm_pnext; 352 struct hostmap *hm_hnext; 353 struct hostmap **hm_phnext; 354 struct ipnat *hm_ipnat; 355 i6addr_t hm_src; 356 i6addr_t hm_dst; 357 i6addr_t hm_map; 358 u_32_t hm_port; 359 int hm_ref; 360 int hm_v; 361 } hostmap_t; 362 363 #define hm_srcip hm_src.in4 364 #define hm_dstip hm_dst.in4 365 #define hm_mapip hm_map.in4 366 #define hm_srcip6 hm_src.in6 367 #define hm_dstip6 hm_dst.in6 368 #define hm_mapip6 hm_map.in6 369 370 371 /* 372 * Structure used to pass information in to nat_newmap and nat_newrdr. 373 */ 374 typedef struct natinfo { 375 ipnat_t *nai_np; 376 u_32_t nai_nflags; 377 u_32_t nai_flags; 378 struct in_addr nai_ip; 379 u_short nai_port; 380 u_short nai_nport; 381 u_short nai_sport; 382 u_short nai_dport; 383 } natinfo_t; 384 385 386 typedef struct natstat { 387 u_long ns_mapped[2]; 388 u_long ns_rules; 389 u_long ns_added; 390 u_long ns_expire; 391 u_long ns_inuse; 392 u_long ns_logged; 393 u_long ns_logfail; 394 u_long ns_memfail; 395 u_long ns_badnat; 396 u_long ns_addtrpnt; 397 nat_t **ns_table[2]; 398 hostmap_t **ns_maptable; 399 ipnat_t *ns_list; 400 void *ns_apslist; 401 u_int ns_wilds; 402 u_int ns_nattab_sz; 403 u_int ns_nattab_max; 404 u_int ns_rultab_sz; 405 u_int ns_rdrtab_sz; 406 u_int ns_trpntab_sz; 407 u_int ns_hostmap_sz; 408 nat_t *ns_instances; 409 nattrpnt_t *ns_trpntlist; 410 hostmap_t *ns_maplist; 411 u_long *ns_bucketlen[2]; 412 } natstat_t; 413 414 typedef struct natlog { 415 i6addr_t nlg_origip; 416 i6addr_t nlg_outip; 417 i6addr_t nlg_inip; 418 u_short nlg_origport; 419 u_short nlg_outport; 420 u_short nlg_inport; 421 u_short nlg_type; 422 int nlg_rule; 423 U_QUAD_T nlg_pkts[2]; 424 U_QUAD_T nlg_bytes[2]; 425 u_char nlg_p; 426 int nlg_v; 427 } natlog_t; 428 429 430 #define NL_NEWMAP NAT_MAP 431 #define NL_NEWRDR NAT_REDIRECT 432 #define NL_NEWBIMAP NAT_BIMAP 433 #define NL_NEWBLOCK NAT_MAPBLK 434 #define NL_CLONE 0xfffd 435 #define NL_FLUSH 0xfffe 436 #define NL_EXPIRE 0xffff 437 438 #define NAT_HASH_FN(k, l, m) (((k) + ((k) >> 12) + l) % (m)) 439 #define NAT_HASH_FN6(k, l, m) ((((u_32_t *)(k))[3] \ 440 + (((u_32_t *)(k))[3] >> 12) \ 441 + (((u_32_t *)(k))[2]) \ 442 + (((u_32_t *)(k))[2] >> 12) \ 443 + (((u_32_t *)(k))[1]) \ 444 + (((u_32_t *)(k))[1] >> 12) \ 445 + (((u_32_t *)(k))[0]) \ 446 + (((u_32_t *)(k))[0] >> 12) \ 447 + l) % (m)) 448 449 #define LONG_SUM(in) (((in) & 0xffff) + ((in) >> 16)) 450 #define LONG_SUM6(in) (LONG_SUM(ntohl(((u_32_t *)(in))[0])) + \ 451 LONG_SUM(ntohl(((u_32_t *)(in))[1])) + \ 452 LONG_SUM(ntohl(((u_32_t *)(in))[2])) + \ 453 LONG_SUM(ntohl(((u_32_t *)(in))[3]))) 454 455 #define CALC_SUMD(s1, s2, sd) { \ 456 (s1) = ((s1) & 0xffff) + ((s1) >> 16); \ 457 (s2) = ((s2) & 0xffff) + ((s2) >> 16); \ 458 /* Do it twice */ \ 459 (s1) = ((s1) & 0xffff) + ((s1) >> 16); \ 460 (s2) = ((s2) & 0xffff) + ((s2) >> 16); \ 461 /* Because ~1 == -2, We really need ~1 == -1 */ \ 462 if ((s1) > (s2)) (s2)--; \ 463 (sd) = (s2) - (s1); \ 464 (sd) = ((sd) & 0xffff) + ((sd) >> 16); } 465 466 #define NAT_SYSSPACE 0x80000000 467 #define NAT_LOCKHELD 0x40000000 468 469 extern void fr_natsync __P((void *, ipf_stack_t *)); 470 extern void fr_nataddrsync __P((int, void *, void *, ipf_stack_t *)); 471 extern void fr_natifpsync __P((int, int, void *, char *, ipf_stack_t *)); 472 473 #if defined(__OpenBSD__) 474 extern void nat_ifdetach __P((void *, ipf_stack_t *)); 475 #endif 476 extern int fr_nat_ioctl __P((caddr_t, ioctlcmd_t, int, int, void *, ipf_stack_t *)); 477 extern int fr_natinit __P((ipf_stack_t *)); 478 extern nat_t *nat_new __P((fr_info_t *, ipnat_t *, nat_t **, u_int, int)); 479 extern nat_t *nat_outlookup __P((fr_info_t *, u_int, u_int, struct in_addr, 480 struct in_addr)); 481 extern void fix_datacksum __P((u_short *, u_32_t)); 482 extern nat_t *nat_inlookup __P((fr_info_t *, u_int, u_int, struct in_addr, 483 struct in_addr)); 484 extern nat_t *nat_tnlookup __P((fr_info_t *, int)); 485 extern nat_t *nat_maplookup __P((void *, u_int, struct in_addr, 486 struct in_addr)); 487 extern nat_t *nat_lookupredir __P((natlookup_t *, ipf_stack_t *)); 488 extern nat_t *nat_icmperrorlookup __P((fr_info_t *, int)); 489 extern nat_t *nat_icmperror __P((fr_info_t *, u_int *, int)); 490 extern int nat_insert __P((nat_t *, int, ipf_stack_t *)); 491 492 extern int fr_checknatout __P((fr_info_t *, u_32_t *)); 493 extern int fr_natout __P((fr_info_t *, nat_t *, int, u_32_t)); 494 extern int fr_checknatin __P((fr_info_t *, u_32_t *)); 495 extern int fr_natin __P((fr_info_t *, nat_t *, int, u_32_t)); 496 extern void fr_natunload __P((ipf_stack_t *)); 497 extern void fr_natexpire __P((ipf_stack_t *)); 498 extern void nat_log __P((struct nat *, u_int, ipf_stack_t *)); 499 extern void fix_incksum __P((u_short *, u_32_t)); 500 extern void fix_outcksum __P((u_short *, u_32_t)); 501 extern void fr_ipnatderef __P((ipnat_t **, ipf_stack_t *)); 502 extern void fr_natderef __P((nat_t **, ipf_stack_t *)); 503 extern u_short *nat_proto __P((fr_info_t *, nat_t *, u_int)); 504 extern void nat_update __P((fr_info_t *, nat_t *, ipnat_t *)); 505 extern void fr_setnatqueue __P((nat_t *, int, ipf_stack_t *)); 506 extern void fr_hostmapdel __P((hostmap_t **)); 507 508 extern nat_t *fr_natclone __P((fr_info_t *, nat_t *)); 509 extern void nat_delrdr __P((struct ipnat *)); 510 extern void nat_delnat __P((struct ipnat *)); 511 extern int nat_wildok __P((nat_t *, int, int, int, int)); 512 extern void nat_calc_chksum_diffs __P((nat_t *)); 513 514 #ifdef USE_INET6 515 extern void nat6_addnat __P((ipnat_t *, ipf_stack_t *)); 516 extern void nat6_addrdr __P((ipnat_t *, ipf_stack_t *)); 517 extern nat_t *nat6_new __P((fr_info_t *, ipnat_t *, nat_t **, u_int, int)); 518 extern nat_t *nat6_outlookup __P((fr_info_t *, u_int, u_int, 519 struct in6_addr *, struct in6_addr *)); 520 extern nat_t *nat6_inlookup __P((fr_info_t *, u_int, u_int, 521 struct in6_addr *, struct in6_addr *)); 522 extern nat_t *nat6_lookupredir __P((natlookup_t *, ipf_stack_t *)); 523 extern nat_t *nat6_icmperrorlookup __P((fr_info_t *, int)); 524 extern nat_t *nat6_icmperror __P((fr_info_t *, u_int *, int)); 525 extern int nat6_insert __P((nat_t *, int, ipf_stack_t *)); 526 extern int fr_checknat6out __P((fr_info_t *, u_32_t *)); 527 extern int fr_nat6out __P((fr_info_t *, nat_t *, int, u_32_t)); 528 extern int fr_checknat6in __P((fr_info_t *, u_32_t *)); 529 extern int fr_nat6in __P((fr_info_t *, nat_t *, int, u_32_t)); 530 #endif 531 532 #endif /* __IP_NAT_H__ */ 533