sys/contrib/ipfilter/netinet/ip_nat.h

   1 /*
   2  * Copyright (C) 1995-2001 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.17.2.27 2002/08/28 12:45:51 darrenr Exp $
   8  * $FreeBSD: src/sys/contrib/ipfilter/netinet/ip_nat.h,v 1.15.2.5 2003/03/01 03:55:54 darrenr Exp $
   9  */
  10
  11 #ifndef __IP_NAT_H__
  12 #define __IP_NAT_H__
  13
  14 #ifndef SOLARIS
  15 #define SOLARIS (defined(sun) && (defined(__svr4__) || defined(__SVR4)))
  16 #endif
  17
  18 #if defined(__STDC__) || defined(__GNUC__)
  19 #define SIOCADNAT       _IOW('r', 60, struct ipnat *)
  20 #define SIOCRMNAT       _IOW('r', 61, struct ipnat *)
  21 #define SIOCGNATS       _IOWR('r', 62, struct natstat *)
  22 #define SIOCGNATL       _IOWR('r', 63, struct natlookup *)
  23 #else
  24 #define SIOCADNAT       _IOW(r, 60, struct ipnat *)
  25 #define SIOCRMNAT       _IOW(r, 61, struct ipnat *)
  26 #define SIOCGNATS       _IOWR(r, 62, struct natstat *)
  27 #define SIOCGNATL       _IOWR(r, 63, struct natlookup *)
  28 #endif
  29
  30 #undef  LARGE_NAT       /* define this if you're setting up a system to NAT
  31                          * LARGE numbers of networks/hosts - i.e. in the
  32                          * hundreds or thousands.  In such a case, you should
  33                          * also change the RDR_SIZE and NAT_SIZE below to more
  34                          * appropriate sizes.  The figures below were used for
  35                          * a setup with 1000-2000 networks to NAT.
  36                          */
  37 #ifndef NAT_SIZE
  38 # define        NAT_SIZE        127
  39 #endif
  40 #ifndef RDR_SIZE
  41 # define        RDR_SIZE        127
  42 #endif
  43 #ifndef HOSTMAP_SIZE
  44 # define        HOSTMAP_SIZE    127
  45 #endif
  46 #ifndef NAT_TABLE_SZ
  47 # define        NAT_TABLE_SZ    127
  48 #endif
  49 #ifdef  LARGE_NAT
  50 #undef  NAT_SIZE
  51 #undef  RDR_SIZE
  52 #undef  NAT_TABLE_SZ
  53 #undef  HOSTMAP_SIZE    127
  54 #define NAT_SIZE        2047
  55 #define RDR_SIZE        2047
  56 #define NAT_TABLE_SZ    16383
  57 #define HOSTMAP_SIZE    8191
  58 #endif
  59 #ifndef APR_LABELLEN
  60 #define APR_LABELLEN    16
  61 #endif
  62 #define NAT_HW_CKSUM    0x80000000
  63
  64 #define DEF_NAT_AGE     1200     /* 10 minutes (600 seconds) */
  65
  66 struct ap_session;
  67
  68 typedef struct  nat     {
  69         u_long  nat_age;
  70         int     nat_flags;
  71         u_32_t  nat_sumd[2];
  72         u_32_t  nat_ipsumd;
  73         void    *nat_data;
  74         struct  ap_session      *nat_aps;               /* proxy session */
  75         struct  frentry *nat_fr;        /* filter rule ptr if appropriate */
  76         struct  in_addr nat_inip;
  77         struct  in_addr nat_outip;
  78         struct  in_addr nat_oip;        /* other ip */
  79         U_QUAD_T        nat_pkts;
  80         U_QUAD_T        nat_bytes;
  81         u_int   nat_drop[2];
  82         u_short nat_oport;              /* other port */
  83         u_short nat_inport;
  84         u_short nat_outport;
  85         u_short nat_use;
  86         u_char  nat_tcpstate[2];
  87         u_char  nat_p;                  /* protocol for NAT */
  88         u_32_t  nat_mssclamp;   /* if != zero clamp MSS to this */
  89         struct  ipnat   *nat_ptr;       /* pointer back to the rule */
  90         struct  hostmap *nat_hm;
  91         struct  nat     *nat_next;
  92         struct  nat     *nat_hnext[2];
  93         struct  nat     **nat_phnext[2];
  94         struct  nat     **nat_me;
  95         void    *nat_ifp;
  96         int     nat_dir;
  97         char    nat_ifname[IFNAMSIZ];
  98 #if SOLARIS || defined(__sgi)
  99         kmutex_t        nat_lock;
 100 #endif
 101 } nat_t;
 102
 103 typedef struct  ipnat   {
 104         struct  ipnat   *in_next;
 105         struct  ipnat   *in_rnext;
 106         struct  ipnat   **in_prnext;
 107         struct  ipnat   *in_mnext;
 108         struct  ipnat   **in_pmnext;
 109         void    *in_ifp;
 110         void    *in_apr;
 111         u_long  in_space;
 112         u_int   in_use;
 113         u_int   in_hits;
 114         struct  in_addr in_nextip;
 115         u_short in_pnext;
 116         u_short in_ippip;       /* IP #'s per IP# */
 117         u_32_t  in_flags;       /* From here to in_dport must be reflected */
 118         u_32_t  in_mssclamp;    /* if != zero clamp MSS to this */
 119         u_short in_spare;
 120         u_short in_ppip;        /* ports per IP */
 121         u_short in_port[2];     /* correctly in IPN_CMPSIZ */
 122         struct  in_addr in_in[2];
 123         struct  in_addr in_out[2];
 124         struct  in_addr in_src[2];
 125         struct  frtuc   in_tuc;
 126         u_int   in_age[2];      /* Aging for NAT entries. Not for TCP */
 127         int     in_redir; /* 0 if it's a mapping, 1 if it's a hard redir */
 128         char    in_ifname[IFNAMSIZ];
 129         char    in_plabel[APR_LABELLEN];        /* proxy label */
 130         char    in_p;   /* protocol */
 131 } ipnat_t;
 132
 133 #define in_pmin         in_port[0]      /* Also holds static redir port */
 134 #define in_pmax         in_port[1]
 135 #define in_nip          in_nextip.s_addr
 136 #define in_inip         in_in[0].s_addr
 137 #define in_inmsk        in_in[1].s_addr
 138 #define in_outip        in_out[0].s_addr
 139 #define in_outmsk       in_out[1].s_addr
 140 #define in_srcip        in_src[0].s_addr
 141 #define in_srcmsk       in_src[1].s_addr
 142 #define in_scmp         in_tuc.ftu_scmp
 143 #define in_dcmp         in_tuc.ftu_dcmp
 144 #define in_stop         in_tuc.ftu_stop
 145 #define in_dtop         in_tuc.ftu_dtop
 146 #define in_sport        in_tuc.ftu_sport
 147 #define in_dport        in_tuc.ftu_dport
 148
 149 #define NAT_OUTBOUND    0
 150 #define NAT_INBOUND     1
 151
 152 #define NAT_MAP         0x01
 153 #define NAT_REDIRECT    0x02
 154 #define NAT_BIMAP       (NAT_MAP|NAT_REDIRECT)
 155 #define NAT_MAPBLK      0x04
 156 /* 0x100 reserved for FI_W_SPORT */
 157 /* 0x200 reserved for FI_W_DPORT */
 158 /* 0x400 reserved for FI_W_SADDR */
 159 /* 0x800 reserved for FI_W_DADDR */
 160 /* 0x1000 reserved for FI_W_NEWFR */
 161
 162 #define MAPBLK_MINPORT  1024    /* don't use reserved ports for src port */
 163 #define USABLE_PORTS    (65536 - MAPBLK_MINPORT)
 164
 165 #define IPN_CMPSIZ      (sizeof(ipnat_t) - offsetof(ipnat_t, in_flags))
 166
 167 typedef struct  natlookup {
 168         struct  in_addr nl_inip;
 169         struct  in_addr nl_outip;
 170         struct  in_addr nl_realip;
 171         int     nl_flags;
 172         u_short nl_inport;
 173         u_short nl_outport;
 174         u_short nl_realport;
 175 } natlookup_t;
 176
 177
 178 typedef struct  nat_save    {
 179         void    *ipn_next;
 180         struct  nat     ipn_nat;
 181         struct  ipnat   ipn_ipnat;
 182         struct  frentry ipn_fr;
 183         int     ipn_dsize;
 184         char    ipn_data[4];
 185 } nat_save_t;
 186
 187 #define ipn_rule        ipn_nat.nat_fr
 188
 189 typedef struct  natget  {
 190         void    *ng_ptr;
 191         int     ng_sz;
 192 } natget_t;
 193
 194
 195 typedef struct  hostmap {
 196         struct  hostmap *hm_next;
 197         struct  hostmap **hm_pnext;
 198         struct  ipnat   *hm_ipnat;
 199         struct  in_addr hm_realip;
 200         struct  in_addr hm_mapip;
 201         int     hm_ref;
 202 } hostmap_t;
 203
 204
 205 typedef struct  natstat {
 206         u_long  ns_mapped[2];
 207         u_long  ns_rules;
 208         u_long  ns_added;
 209         u_long  ns_expire;
 210         u_long  ns_inuse;
 211         u_long  ns_logged;
 212         u_long  ns_logfail;
 213         u_long  ns_memfail;
 214         u_long  ns_badnat;
 215         nat_t   **ns_table[2];
 216         hostmap_t **ns_maptable;
 217         ipnat_t *ns_list;
 218         void    *ns_apslist;
 219         u_int   ns_nattab_sz;
 220         u_int   ns_rultab_sz;
 221         u_int   ns_rdrtab_sz;
 222         u_int   ns_hostmap_sz;
 223         nat_t   *ns_instances;
 224         u_int   ns_wilds;
 225 } natstat_t;
 226
 227 #define IPN_ANY         0x000
 228 #define IPN_TCP         0x001
 229 #define IPN_UDP         0x002
 230 #define IPN_TCPUDP      (IPN_TCP|IPN_UDP)
 231 #define IPN_DELETE      0x004
 232 #define IPN_ICMPERR     0x008
 233 #define IPN_RF          (IPN_TCPUDP|IPN_DELETE|IPN_ICMPERR)
 234 #define IPN_AUTOPORTMAP 0x010
 235 #define IPN_IPRANGE     0x020
 236 #define IPN_USERFLAGS   (IPN_TCPUDP|IPN_AUTOPORTMAP|IPN_IPRANGE|IPN_SPLIT|\
 237                          IPN_ROUNDR|IPN_FILTER|IPN_NOTSRC|IPN_NOTDST|IPN_FRAG)
 238 #define IPN_FILTER      0x040
 239 #define IPN_SPLIT       0x080
 240 #define IPN_ROUNDR      0x100
 241 #define IPN_NOTSRC      0x080000
 242 #define IPN_NOTDST      0x100000
 243 #define IPN_FRAG        0x200000
 244
 245
 246 typedef struct  natlog {
 247         struct  in_addr nl_origip;
 248         struct  in_addr nl_outip;
 249         struct  in_addr nl_inip;
 250         u_short nl_origport;
 251         u_short nl_outport;
 252         u_short nl_inport;
 253         u_short nl_type;
 254         int     nl_rule;
 255         U_QUAD_T        nl_pkts;
 256         U_QUAD_T        nl_bytes;
 257         u_char  nl_p;
 258 } natlog_t;
 259
 260
 261 #define NL_NEWMAP       NAT_MAP
 262 #define NL_NEWRDR       NAT_REDIRECT
 263 #define NL_NEWBIMAP     NAT_BIMAP
 264 #define NL_NEWBLOCK     NAT_MAPBLK
 265 #define NL_FLUSH        0xfffe
 266 #define NL_EXPIRE       0xffff
 267
 268 #define NAT_HASH_FN(k,l,m)      (((k) + ((k) >> 12) + l) % (m))
 269
 270 #define LONG_SUM(in)    (((in) & 0xffff) + ((in) >> 16))
 271
 272 #define CALC_SUMD(s1, s2, sd) { \
 273                             (s1) = ((s1) & 0xffff) + ((s1) >> 16); \
 274                             (s2) = ((s2) & 0xffff) + ((s2) >> 16); \
 275                             /* Do it twice */ \
 276                             (s1) = ((s1) & 0xffff) + ((s1) >> 16); \
 277                             (s2) = ((s2) & 0xffff) + ((s2) >> 16); \
 278                             /* Because ~1 == -2, We really need ~1 == -1 */ \
 279                             if ((s1) > (s2)) (s2)--; \
 280                             (sd) = (s2) - (s1); \
 281                             (sd) = ((sd) & 0xffff) + ((sd) >> 16); }
 282
 283 #define NAT_SYSSPACE            0x80000000
 284 #define NAT_LOCKHELD            0x40000000
 285
 286 extern  u_int   ipf_nattable_sz;
 287 extern  u_int   ipf_natrules_sz;
 288 extern  u_int   ipf_rdrrules_sz;
 289 extern  int     fr_nat_lock;
 290 extern  void    ip_natsync __P((void *));
 291 extern  u_long  fr_defnatage;
 292 extern  u_long  fr_defnaticmpage;
 293 extern  nat_t   **nat_table[2];
 294 extern  nat_t   *nat_instances;
 295 extern  ipnat_t **nat_rules;
 296 extern  ipnat_t **rdr_rules;
 297 extern  ipnat_t *nat_list;
 298 extern  natstat_t       nat_stats;
 299 #if defined(__OpenBSD__)
 300 extern  void    nat_ifdetach __P((void *));
 301 #endif
 302 #if defined(__NetBSD__) || defined(__OpenBSD__) || (__FreeBSD_version >= 300003)
 303 extern  int     nat_ioctl __P((caddr_t, u_long, int));
 304 #else
 305 extern  int     nat_ioctl __P((caddr_t, int, int));
 306 #endif
 307 extern  int     nat_init __P((void));
 308 extern  nat_t   *nat_new __P((fr_info_t *, ip_t *, ipnat_t *, nat_t **,
 309                               u_int, int));
 310 extern  nat_t   *nat_outlookup __P((fr_info_t *, u_int, u_int, struct in_addr,
 311                                  struct in_addr, int));
 312 extern  nat_t   *nat_inlookup __P((fr_info_t *, u_int, u_int, struct in_addr,
 313                                 struct in_addr, int));
 314 extern  nat_t   *nat_lookupredir __P((natlookup_t *));
 315 extern  nat_t   *nat_icmplookup __P((ip_t *, fr_info_t *, int));
 316 extern  nat_t   *nat_icmp __P((ip_t *, fr_info_t *, u_int *, int));
 317 extern  int     nat_clearlist __P((void));
 318 extern  void    nat_insert __P((nat_t *));
 319
 320 extern  int     ip_natout __P((ip_t *, fr_info_t *));
 321 extern  int     ip_natin __P((ip_t *, fr_info_t *));
 322 extern  void    ip_natunload __P((void)), ip_natexpire __P((void));
 323 extern  void    nat_log __P((struct nat *, u_int));
 324 extern  void    fix_incksum __P((fr_info_t *, u_short *, u_32_t));
 325 extern  void    fix_outcksum __P((fr_info_t *, u_short *, u_32_t));
 326 extern  void    fix_datacksum __P((u_short *, u_32_t));
 327
 328 #endif /* __IP_NAT_H__ */