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 2006 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 #define NAT_HW_CKSUM 0x80000000 83 84 #define DEF_NAT_AGE 1200 /* 10 minutes (600 seconds) */ 85 86 struct ipstate; 87 struct ap_session; 88 89 typedef struct nat { 90 ipfmutex_t nat_lock; 91 struct nat *nat_next; 92 struct nat **nat_pnext; 93 struct nat *nat_hnext[2]; 94 struct nat **nat_phnext[2]; 95 struct hostmap *nat_hm; 96 void *nat_data; 97 struct nat **nat_me; 98 struct ipstate *nat_state; 99 struct ap_session *nat_aps; /* proxy session */ 100 frentry_t *nat_fr; /* filter rule ptr if appropriate */ 101 struct ipnat *nat_ptr; /* pointer back to the rule */ 102 void *nat_ifps[2]; 103 void *nat_sync; 104 ipftqent_t nat_tqe; 105 u_32_t nat_flags; 106 u_32_t nat_sumd[2]; /* ip checksum delta for data segment*/ 107 u_32_t nat_ipsumd; /* ip checksum delta for ip header */ 108 u_32_t nat_mssclamp; /* if != zero clamp MSS to this */ 109 i6addr_t nat_inip6; 110 i6addr_t nat_outip6; 111 i6addr_t nat_oip6; /* other ip */ 112 U_QUAD_T nat_pkts[2]; 113 U_QUAD_T nat_bytes[2]; 114 union { 115 udpinfo_t nat_unu; 116 tcpinfo_t nat_unt; 117 icmpinfo_t nat_uni; 118 greinfo_t nat_ugre; 119 } nat_un; 120 u_short nat_oport; /* other port */ 121 u_short nat_use; 122 u_char nat_p; /* protocol for NAT */ 123 int nat_dir; 124 int nat_ref; /* reference count */ 125 int nat_hv[2]; 126 char nat_ifnames[2][LIFNAMSIZ]; 127 int nat_rev; /* 0 = forward, 1 = reverse */ 128 } nat_t; 129 130 #define nat_inip nat_inip6.in4 131 #define nat_outip nat_outip6.in4 132 #define nat_oip nat_oip6.in4 133 #define nat_age nat_tqe.tqe_die 134 #define nat_inport nat_un.nat_unt.ts_sport 135 #define nat_outport nat_un.nat_unt.ts_dport 136 #define nat_type nat_un.nat_uni.ici_type 137 #define nat_seq nat_un.nat_uni.ici_seq 138 #define nat_id nat_un.nat_uni.ici_id 139 #define nat_tcpstate nat_tqe.tqe_state 140 141 /* 142 * Values for nat_dir 143 */ 144 #define NAT_INBOUND 0 145 #define NAT_OUTBOUND 1 146 147 /* 148 * Definitions for nat_flags 149 */ 150 #define NAT_TCP 0x0001 /* IPN_TCP */ 151 #define NAT_UDP 0x0002 /* IPN_UDP */ 152 #define NAT_ICMPERR 0x0004 /* IPN_ICMPERR */ 153 #define NAT_ICMPQUERY 0x0008 /* IPN_ICMPQUERY */ 154 #define NAT_SEARCH 0x0010 155 #define NAT_SLAVE 0x0020 /* Slave connection for a proxy */ 156 #define NAT_NOTRULEPORT 0x0040 157 158 #define NAT_TCPUDP (NAT_TCP|NAT_UDP) 159 #define NAT_TCPUDPICMP (NAT_TCP|NAT_UDP|NAT_ICMPERR) 160 #define NAT_TCPUDPICMPQ (NAT_TCP|NAT_UDP|NAT_ICMPQUERY) 161 #define NAT_FROMRULE (NAT_TCP|NAT_UDP) 162 163 /* 0x0100 reserved for FI_W_SPORT */ 164 /* 0x0200 reserved for FI_W_DPORT */ 165 /* 0x0400 reserved for FI_W_SADDR */ 166 /* 0x0800 reserved for FI_W_DADDR */ 167 /* 0x1000 reserved for FI_W_NEWFR */ 168 /* 0x2000 reserved for SI_CLONE */ 169 /* 0x4000 reserved for SI_CLONED */ 170 /* 0x8000 reserved for SI_IGNOREPKT */ 171 172 #define NAT_DEBUG 0x800000 173 174 typedef struct ipnat { 175 struct ipnat *in_next; /* NAT rule list next */ 176 struct ipnat *in_rnext; /* rdr rule hash next */ 177 struct ipnat **in_prnext; /* prior rdr next ptr */ 178 struct ipnat *in_mnext; /* map rule hash next */ 179 struct ipnat **in_pmnext; /* prior map next ptr */ 180 struct ipftq *in_tqehead[2]; 181 void *in_ifps[2]; 182 void *in_apr; 183 char *in_comment; 184 i6addr_t in_next6; 185 u_long in_space; 186 u_long in_hits; 187 u_int in_use; 188 u_int in_hv; 189 int in_flineno; /* conf. file line number */ 190 u_short in_pnext; 191 u_char in_v; 192 u_char in_xxx; 193 /* From here to the end is covered by IPN_CMPSIZ */ 194 u_32_t in_flags; 195 u_32_t in_mssclamp; /* if != 0 clamp MSS to this */ 196 u_int in_age[2]; 197 int in_redir; /* see below for values */ 198 int in_p; /* protocol. */ 199 i6addr_t in_in[2]; 200 i6addr_t in_out[2]; 201 i6addr_t in_src[2]; 202 frtuc_t in_tuc; 203 u_short in_port[2]; 204 u_short in_ppip; /* ports per IP. */ 205 u_short in_ippip; /* IP #'s per IP# */ 206 char in_ifnames[2][LIFNAMSIZ]; 207 char in_plabel[APR_LABELLEN]; /* proxy label. */ 208 ipftag_t in_tag; 209 } ipnat_t; 210 211 #define in_pmin in_port[0] /* Also holds static redir port */ 212 #define in_pmax in_port[1] 213 #define in_nextip in_next6.in4 214 #define in_nip in_next6.in4.s_addr 215 #define in_inip in_in[0].in4.s_addr 216 #define in_inmsk in_in[1].in4.s_addr 217 #define in_outip in_out[0].in4.s_addr 218 #define in_outmsk in_out[1].in4.s_addr 219 #define in_srcip in_src[0].in4.s_addr 220 #define in_srcmsk in_src[1].in4.s_addr 221 #define in_scmp in_tuc.ftu_scmp 222 #define in_dcmp in_tuc.ftu_dcmp 223 #define in_stop in_tuc.ftu_stop 224 #define in_dtop in_tuc.ftu_dtop 225 #define in_sport in_tuc.ftu_sport 226 #define in_dport in_tuc.ftu_dport 227 228 /* 229 * Bit definitions for in_flags 230 */ 231 #define IPN_ANY 0x00000 232 #define IPN_TCP 0x00001 233 #define IPN_UDP 0x00002 234 #define IPN_TCPUDP (IPN_TCP|IPN_UDP) 235 #define IPN_ICMPERR 0x00004 236 #define IPN_TCPUDPICMP (IPN_TCP|IPN_UDP|IPN_ICMPERR) 237 #define IPN_ICMPQUERY 0x00008 238 #define IPN_TCPUDPICMPQ (IPN_TCP|IPN_UDP|IPN_ICMPQUERY) 239 #define IPN_RF (IPN_TCPUDP|IPN_DELETE|IPN_ICMPERR) 240 #define IPN_AUTOPORTMAP 0x00010 241 #define IPN_IPRANGE 0x00020 242 #define IPN_FILTER 0x00040 243 #define IPN_SPLIT 0x00080 244 #define IPN_ROUNDR 0x00100 245 #define IPN_NOTSRC 0x04000 246 #define IPN_NOTDST 0x08000 247 #define IPN_DYNSRCIP 0x10000 /* dynamic src IP# */ 248 #define IPN_DYNDSTIP 0x20000 /* dynamic dst IP# */ 249 #define IPN_DELETE 0x40000 250 #define IPN_STICKY 0x80000 251 #define IPN_FRAG 0x100000 252 #define IPN_FIXEDDPORT 0x200000 253 #define IPN_FINDFORWARD 0x400000 254 #define IPN_IN 0x800000 255 #define IPN_USERFLAGS (IPN_TCPUDP|IPN_AUTOPORTMAP|IPN_IPRANGE|IPN_SPLIT|\ 256 IPN_ROUNDR|IPN_FILTER|IPN_NOTSRC|IPN_NOTDST|\ 257 IPN_FRAG|IPN_STICKY|IPN_FIXEDDPORT|IPN_ICMPQUERY) 258 259 /* 260 * Values for in_redir 261 */ 262 #define NAT_MAP 0x01 263 #define NAT_REDIRECT 0x02 264 #define NAT_BIMAP (NAT_MAP|NAT_REDIRECT) 265 #define NAT_MAPBLK 0x04 266 267 #define MAPBLK_MINPORT 1024 /* don't use reserved ports for src port */ 268 #define USABLE_PORTS (65536 - MAPBLK_MINPORT) 269 270 #define IPN_CMPSIZ (sizeof(ipnat_t) - offsetof(ipnat_t, in_flags)) 271 272 typedef struct natlookup { 273 struct in_addr nl_inip; 274 struct in_addr nl_outip; 275 struct in_addr nl_realip; 276 int nl_flags; 277 u_short nl_inport; 278 u_short nl_outport; 279 u_short nl_realport; 280 } natlookup_t; 281 282 283 typedef struct nat_save { 284 void *ipn_next; 285 struct nat ipn_nat; 286 struct ipnat ipn_ipnat; 287 struct frentry ipn_fr; 288 int ipn_dsize; 289 char ipn_data[4]; 290 } nat_save_t; 291 292 #define ipn_rule ipn_nat.nat_fr 293 294 typedef struct natget { 295 void *ng_ptr; 296 int ng_sz; 297 } natget_t; 298 299 300 #undef tr_flags 301 typedef struct nattrpnt { 302 struct in_addr tr_dstip; /* real destination IP# */ 303 struct in_addr tr_srcip; /* real source IP# */ 304 struct in_addr tr_locip; /* local source IP# */ 305 u_int tr_flags; 306 int tr_expire; 307 u_short tr_dstport; /* real destination port# */ 308 u_short tr_srcport; /* real source port# */ 309 u_short tr_locport; /* local source port# */ 310 struct nattrpnt *tr_hnext; 311 struct nattrpnt **tr_phnext; 312 struct nattrpnt *tr_next; 313 struct nattrpnt **tr_pnext; /* previous next */ 314 } nattrpnt_t; 315 316 #define TN_CMPSIZ offsetof(nattrpnt_t, tr_hnext) 317 318 319 /* 320 * This structure gets used to help NAT sessions keep the same NAT rule (and 321 * thus translation for IP address) when: 322 * (a) round-robin redirects are in use 323 * (b) different IP add 324 */ 325 typedef struct hostmap { 326 struct hostmap *hm_next; 327 struct hostmap **hm_pnext; 328 struct ipnat *hm_ipnat; 329 struct in_addr hm_srcip; 330 struct in_addr hm_dstip; 331 struct in_addr hm_mapip; 332 u_32_t hm_port; 333 int hm_ref; 334 } hostmap_t; 335 336 337 /* 338 * Structure used to pass information in to nat_newmap and nat_newrdr. 339 */ 340 typedef struct natinfo { 341 ipnat_t *nai_np; 342 u_32_t nai_sum1; 343 u_32_t nai_sum2; 344 u_32_t nai_nflags; 345 u_32_t nai_flags; 346 struct in_addr nai_ip; 347 u_short nai_port; 348 u_short nai_nport; 349 u_short nai_sport; 350 u_short nai_dport; 351 } natinfo_t; 352 353 354 typedef struct natstat { 355 u_long ns_mapped[2]; 356 u_long ns_rules; 357 u_long ns_added; 358 u_long ns_expire; 359 u_long ns_inuse; 360 u_long ns_logged; 361 u_long ns_logfail; 362 u_long ns_memfail; 363 u_long ns_badnat; 364 u_long ns_addtrpnt; 365 nat_t **ns_table[2]; 366 hostmap_t **ns_maptable; 367 ipnat_t *ns_list; 368 void *ns_apslist; 369 u_int ns_wilds; 370 u_int ns_nattab_sz; 371 u_int ns_nattab_max; 372 u_int ns_rultab_sz; 373 u_int ns_rdrtab_sz; 374 u_int ns_trpntab_sz; 375 u_int ns_hostmap_sz; 376 nat_t *ns_instances; 377 nattrpnt_t *ns_trpntlist; 378 u_long *ns_bucketlen[2]; 379 } natstat_t; 380 381 typedef struct natlog { 382 struct in_addr nl_origip; 383 struct in_addr nl_outip; 384 struct in_addr nl_inip; 385 u_short nl_origport; 386 u_short nl_outport; 387 u_short nl_inport; 388 u_short nl_type; 389 int nl_rule; 390 U_QUAD_T nl_pkts[2]; 391 U_QUAD_T nl_bytes[2]; 392 u_char nl_p; 393 } natlog_t; 394 395 396 #define NL_NEWMAP NAT_MAP 397 #define NL_NEWRDR NAT_REDIRECT 398 #define NL_NEWBIMAP NAT_BIMAP 399 #define NL_NEWBLOCK NAT_MAPBLK 400 #define NL_CLONE 0xfffd 401 #define NL_FLUSH 0xfffe 402 #define NL_EXPIRE 0xffff 403 404 #define NAT_HASH_FN(k,l,m) (((k) + ((k) >> 12) + l) % (m)) 405 406 #define LONG_SUM(in) (((in) & 0xffff) + ((in) >> 16)) 407 408 #define CALC_SUMD(s1, s2, sd) { \ 409 (s1) = ((s1) & 0xffff) + ((s1) >> 16); \ 410 (s2) = ((s2) & 0xffff) + ((s2) >> 16); \ 411 /* Do it twice */ \ 412 (s1) = ((s1) & 0xffff) + ((s1) >> 16); \ 413 (s2) = ((s2) & 0xffff) + ((s2) >> 16); \ 414 /* Because ~1 == -2, We really need ~1 == -1 */ \ 415 if ((s1) > (s2)) (s2)--; \ 416 (sd) = (s2) - (s1); \ 417 (sd) = ((sd) & 0xffff) + ((sd) >> 16); } 418 419 #define NAT_SYSSPACE 0x80000000 420 #define NAT_LOCKHELD 0x40000000 421 422 423 extern u_int ipf_nattable_sz; 424 extern u_int ipf_nattable_max; 425 extern u_int ipf_natrules_sz; 426 extern u_int ipf_rdrrules_sz; 427 extern u_int ipf_hostmap_sz; 428 extern u_int fr_nat_maxbucket; 429 extern u_int fr_nat_maxbucket_reset; 430 extern int fr_nat_lock; 431 extern void fr_natsync __P((void *)); 432 extern u_long fr_defnatage; 433 extern u_long fr_defnaticmpage; 434 extern u_long fr_defnatipage; 435 /* nat_table[0] -> hashed list sorted by inside (ip, port) */ 436 /* nat_table[1] -> hashed list sorted by outside (ip, port) */ 437 extern nat_t **nat_table[2]; 438 extern nat_t *nat_instances; 439 extern ipnat_t *nat_list; 440 extern ipnat_t **nat_rules; 441 extern ipnat_t **rdr_rules; 442 extern ipftq_t *nat_utqe; 443 extern natstat_t nat_stats; 444 445 #if defined(__OpenBSD__) 446 extern void nat_ifdetach __P((void *)); 447 #endif 448 extern int fr_nat_ioctl __P((caddr_t, ioctlcmd_t, int)); 449 extern int fr_natinit __P((void)); 450 extern nat_t *nat_new __P((fr_info_t *, ipnat_t *, nat_t **, u_int, int)); 451 extern nat_t *nat_outlookup __P((fr_info_t *, u_int, u_int, struct in_addr, 452 struct in_addr)); 453 extern void fix_datacksum __P((u_short *, u_32_t)); 454 extern nat_t *nat_inlookup __P((fr_info_t *, u_int, u_int, struct in_addr, 455 struct in_addr)); 456 extern nat_t *nat_tnlookup __P((fr_info_t *, int)); 457 extern nat_t *nat_maplookup __P((void *, u_int, struct in_addr, 458 struct in_addr)); 459 extern nat_t *nat_lookupredir __P((natlookup_t *)); 460 extern nat_t *nat_icmperrorlookup __P((fr_info_t *, int)); 461 extern nat_t *nat_icmperror __P((fr_info_t *, u_int *, int)); 462 extern int nat_insert __P((nat_t *, int)); 463 464 extern int fr_checknatout __P((fr_info_t *, u_32_t *)); 465 extern int fr_natout __P((fr_info_t *, nat_t *, int, u_32_t)); 466 extern int fr_checknatin __P((fr_info_t *, u_32_t *)); 467 extern int fr_natin __P((fr_info_t *, nat_t *, int, u_32_t)); 468 extern void fr_natunload __P((void)); 469 extern void fr_natexpire __P((void)); 470 extern void nat_log __P((struct nat *, u_int)); 471 extern void fix_incksum __P((fr_info_t *, u_short *, u_32_t)); 472 extern void fix_outcksum __P((fr_info_t *, u_short *, u_32_t)); 473 extern void fr_natderef __P((nat_t **)); 474 extern u_short *nat_proto __P((fr_info_t *, nat_t *, u_int)); 475 extern void nat_update __P((fr_info_t *, nat_t *, ipnat_t *)); 476 extern void fr_setnatqueue __P((nat_t *, int)); 477 478 #endif /* __IP_NAT_H__ */ 479