sys/netinet6/ip6_fw.h

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