bsd/netinet6/ip6_fw.h

   1 /*
   2  * Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright (c) 1993 Daniel Boulet
  30  * Copyright (c) 1994 Ugen J.S.Antsilevich
  31  *
  32  * Redistribution and use in source forms, with and without modification,
  33  * are permitted provided that this entire comment appears intact.
  34  *
  35  * Redistribution in binary form may occur without any restrictions.
  36  * Obviously, it would be nice if you gave credit where credit is due
  37  * but requiring it would be too onerous.
  38  *
  39  * This software is provided ``AS IS'' without any warranties of any kind.
  40  *
  41  */
  42
  43 #ifndef _IP6_FW_H
  44 #define _IP6_FW_H
  45 #include <sys/appleapiopts.h>
  46
  47 #include <net/if.h>
  48
  49 #define IPV6_FW_CURRENT_API_VERSION 20  /* Version of this API */
  50
  51
  52 /*
  53  * This union structure identifies an interface, either explicitly
  54  * by name or implicitly by IP address. The flags IP_FW_F_IIFNAME
  55  * and IP_FW_F_OIFNAME say how to interpret this structure. An
  56  * interface unit number of -1 matches any unit number, while an
  57  * IP address of 0.0.0.0 indicates matches any interface.
  58  *
  59  * The receive and transmit interfaces are only compared against the
  60  * the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE)
  61  * is set. Note some packets lack a receive or transmit interface
  62  * (in which case the missing "interface" never matches).
  63  */
  64
  65 union ip6_fw_if {
  66     struct in6_addr fu_via_ip6; /* Specified by IPv6 address */
  67     struct {                    /* Specified by interface name */
  68 #define IP6FW_IFNLEN     IFNAMSIZ
  69             char  name[IP6FW_IFNLEN];
  70             short unit;         /* -1 means match any unit */
  71     } fu_via_if;
  72 };
  73
  74 /*
  75  * Format of an IP firewall descriptor
  76  *
  77  * fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order.
  78  * fw_flg and fw_n*p are stored in host byte order (of course).
  79  * Port numbers are stored in HOST byte order.
  80  * Warning: setsockopt() will fail if sizeof(struct ip_fw) > MLEN (108)
  81  */
  82
  83 struct ip6_fw {
  84         u_int32_t version;              /* Version of this structure.  Should always be */
  85                                                         /* set to IP6_FW_CURRENT_API_VERSION by clients. */
  86         void *context;                  /* Context that is usable by user processes to */
  87                                                         /* identify this rule. */
  88     u_long fw_pcnt,fw_bcnt;             /* Packet and byte counters */
  89     struct in6_addr fw_src, fw_dst;     /* Source and destination IPv6 addr */
  90     struct in6_addr fw_smsk, fw_dmsk;   /* Mask for src and dest IPv6 addr */
  91     u_short fw_number;                  /* Rule number */
  92     u_short fw_flg;                     /* Flags word */
  93 #define IPV6_FW_MAX_PORTS       10      /* A reasonable maximum */
  94     u_int fw_ipflg;                     /* IP flags word */
  95     u_short fw_pts[IPV6_FW_MAX_PORTS];  /* Array of port numbers to match */
  96     u_char fw_ip6opt,fw_ip6nopt;        /* IPv6 options set/unset */
  97     u_char fw_tcpf,fw_tcpnf;            /* TCP flags set/unset */
  98 #define IPV6_FW_ICMPTYPES_DIM (256 / (sizeof(unsigned) * 8))
  99     unsigned fw_icmp6types[IPV6_FW_ICMPTYPES_DIM]; /* ICMP types bitmap */
 100     long timestamp;                     /* timestamp (tv_sec) of last match */
 101     union ip6_fw_if fw_in_if, fw_out_if;/* Incoming and outgoing interfaces */
 102     union {
 103         u_short fu_divert_port;         /* Divert/tee port (options IP6DIVERT) */
 104         u_short fu_skipto_rule;         /* SKIPTO command rule number */
 105         u_short fu_reject_code;         /* REJECT response code */
 106     } fw_un;
 107     u_char fw_prot;                     /* IPv6 protocol */
 108     u_char fw_nports;                   /* N'of src ports and # of dst ports */
 109                                         /* in ports array (dst ports follow */
 110                                         /* src ports; max of 10 ports in all; */
 111                                         /* count of 0 means match all ports) */
 112 };
 113
 114 #define IPV6_FW_GETNSRCP(rule)          ((rule)->fw_nports & 0x0f)
 115 #define IPV6_FW_SETNSRCP(rule, n)               do {                            \
 116                                           (rule)->fw_nports &= ~0x0f;   \
 117                                           (rule)->fw_nports |= (n);     \
 118                                         } while (0)
 119 #define IPV6_FW_GETNDSTP(rule)          ((rule)->fw_nports >> 4)
 120 #define IPV6_FW_SETNDSTP(rule, n)               do {                            \
 121                                           (rule)->fw_nports &= ~0xf0;   \
 122                                           (rule)->fw_nports |= (n) << 4;\
 123                                         } while (0)
 124
 125 #define fw_divert_port  fw_un.fu_divert_port
 126 #define fw_skipto_rule  fw_un.fu_skipto_rule
 127 #define fw_reject_code  fw_un.fu_reject_code
 128
 129 struct ip6_fw_chain {
 130         LIST_ENTRY(ip6_fw_chain) chain;
 131         struct ip6_fw    *rule;
 132 };
 133
 134 /*
 135  * Values for "flags" field .
 136  */
 137 #define IPV6_FW_F_IN    0x0001  /* Check inbound packets                */
 138 #define IPV6_FW_F_OUT   0x0002  /* Check outbound packets               */
 139 #define IPV6_FW_F_IIFACE        0x0004  /* Apply inbound interface test         */
 140 #define IPV6_FW_F_OIFACE        0x0008  /* Apply outbound interface test        */
 141
 142 #define IPV6_FW_F_COMMAND 0x0070        /* Mask for type of chain entry:        */
 143 #define IPV6_FW_F_DENY  0x0000  /* This is a deny rule                  */
 144 #define IPV6_FW_F_REJECT        0x0010  /* Deny and send a response packet      */
 145 #define IPV6_FW_F_ACCEPT        0x0020  /* This is an accept rule               */
 146 #define IPV6_FW_F_COUNT 0x0030  /* This is a count rule                 */
 147 #define IPV6_FW_F_DIVERT        0x0040  /* This is a divert rule                */
 148 #define IPV6_FW_F_TEE   0x0050  /* This is a tee rule                   */
 149 #define IPV6_FW_F_SKIPTO        0x0060  /* This is a skipto rule                */
 150
 151 #define IPV6_FW_F_PRN   0x0080  /* Print if this rule matches           */
 152
 153 #define IPV6_FW_F_SRNG  0x0100  /* The first two src ports are a min    *
 154                                  * and max range (stored in host byte   *
 155                                  * order).                              */
 156
 157 #define IPV6_FW_F_DRNG  0x0200  /* The first two dst ports are a min    *
 158                                  * and max range (stored in host byte   *
 159                                  * order).                              */
 160
 161 #define IPV6_FW_F_IIFNAME       0x0400  /* In interface by name/unit (not IP)   */
 162 #define IPV6_FW_F_OIFNAME       0x0800  /* Out interface by name/unit (not IP)  */
 163
 164 #define IPV6_FW_F_INVSRC        0x1000  /* Invert sense of src check            */
 165 #define IPV6_FW_F_INVDST        0x2000  /* Invert sense of dst check            */
 166
 167 #define IPV6_FW_F_FRAG  0x4000  /* Fragment                             */
 168
 169 #define IPV6_FW_F_ICMPBIT 0x8000        /* ICMP type bitmap is valid            */
 170
 171 #define IPV6_FW_F_MASK  0xFFFF  /* All possible flag bits mask          */
 172
 173 /*
 174  * Flags for the 'fw_ipflg' field, for comparing values of ip and its protocols. */
 175 #define IPV6_FW_IF_TCPEST 0x00000020    /* established TCP connection   */
 176 #define IPV6_FW_IF_TCPMSK 0x00000020    /* mask of all TCP values */
 177
 178 /*
 179  * For backwards compatibility with rules specifying "via iface" but
 180  * not restricted to only "in" or "out" packets, we define this combination
 181  * of bits to represent this configuration.
 182  */
 183
 184 #define IF6_FW_F_VIAHACK        (IPV6_FW_F_IN|IPV6_FW_F_OUT|IPV6_FW_F_IIFACE|IPV6_FW_F_OIFACE)
 185
 186 /*
 187  * Definitions for REJECT response codes.
 188  * Values less than 256 correspond to ICMP unreachable codes.
 189  */
 190 #define IPV6_FW_REJECT_RST      0x0100          /* TCP packets: send RST */
 191
 192 /*
 193  * Definitions for IPv6 option names.
 194  */
 195 #define IPV6_FW_IP6OPT_HOPOPT   0x01
 196 #define IPV6_FW_IP6OPT_ROUTE    0x02
 197 #define IPV6_FW_IP6OPT_FRAG     0x04
 198 #define IPV6_FW_IP6OPT_ESP      0x08
 199 #define IPV6_FW_IP6OPT_AH       0x10
 200 #define IPV6_FW_IP6OPT_NONXT    0x20
 201 #define IPV6_FW_IP6OPT_OPTS     0x40
 202
 203 /*
 204  * Definitions for TCP flags.
 205  */
 206 #define IPV6_FW_TCPF_FIN        TH_FIN
 207 #define IPV6_FW_TCPF_SYN        TH_SYN
 208 #define IPV6_FW_TCPF_RST        TH_RST
 209 #define IPV6_FW_TCPF_PSH        TH_PUSH
 210 #define IPV6_FW_TCPF_ACK        TH_ACK
 211 #define IPV6_FW_TCPF_URG        TH_URG
 212
 213 /*
 214  * Main firewall chains definitions and global var's definitions.
 215  */
 216 #ifdef KERNEL_PRIVATE
 217
 218 #define M_IP6FW M_IPFW
 219
 220
 221 /*
 222  * Function definitions.
 223  */
 224 void ip6_fw_init(void);
 225
 226 /* Firewall hooks */
 227 struct ip6_hdr;
 228 struct sockopt;
 229 typedef int ip6_fw_chk_t(struct ip6_hdr**, struct ifnet*,
 230                                 u_short *, struct mbuf**);
 231 typedef int ip6_fw_ctl_t(struct sockopt *);
 232 extern  ip6_fw_chk_t *ip6_fw_chk_ptr;
 233 extern  ip6_fw_ctl_t *ip6_fw_ctl_ptr;
 234 extern  int ip6_fw_enable;
 235
 236 #endif /* KERNEL_PRIVATE */
 237
 238 #endif /* _IP6_FW_H */