bsd/netinet/ip_fw2_compat.h

   1 /* IPFW backward compatibility */
   2
   3 #ifndef _IP_FW_COMPAT_H_
   4 #define _IP_FW_COMPAT_H_
   5
   6
   7 /* prototypes */
   8 void    ipfw_convert_from_latest(struct ip_fw *curr_rule, void *old_rule, u_int32_t api_version);
   9 int             ipfw_convert_to_latest(struct sockopt *sopt, struct ip_fw *rule, int api_version);
  10 int     ipfw_get_command_and_version(struct sockopt *sopt, int *command, u_int32_t *api_version);
  11
  12
  13 /*
  14  * ******************************
  15  * ****** IPFW version one ******
  16  * ******************************
  17  */
  18
  19 /*
  20  * This union structure identifies an interface, either explicitly
  21  * by name or implicitly by IP address. The flags IP_FW_F_IIFNAME
  22  * and IP_FW_F_OIFNAME say how to interpret this structure. An
  23  * interface unit number of -1 matches any unit number, while an
  24  * IP address of 0.0.0.0 indicates matches any interface.
  25  *
  26  * The receive and transmit interfaces are only compared against the
  27  * the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE)
  28  * is set. Note some packets lack a receive or transmit interface
  29  * (in which case the missing "interface" never matches).
  30  */
  31
  32 union ip_fw_if_compat {
  33     struct in_addr fu_via_ip;   /* Specified by IP address */
  34     struct {                    /* Specified by interface name */
  35 #define FW_IFNLEN_COMPAT     10 /* need room ! was IFNAMSIZ */
  36             char  name[FW_IFNLEN_COMPAT];
  37             short unit;         /* -1 means match any unit */
  38     } fu_via_if_compat;
  39 };
  40
  41 /*
  42  * Format of an IP firewall descriptor
  43  *
  44  * fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order.
  45  * fw_flg and fw_n*p are stored in host byte order (of course).
  46  * Port numbers are stored in HOST byte order.
  47  */
  48
  49 struct ip_fw_compat {
  50         u_int32_t version;              /* Version of this structure.  Should always be */
  51                                                         /* set to IP_FW_CURRENT_API_VERSION by clients. */
  52         void *context;                  /* Context that is usable by user processes to */
  53                                                         /* identify this rule. */
  54     u_int64_t fw_pcnt,fw_bcnt;          /* Packet and byte counters */
  55     struct in_addr fw_src, fw_dst;      /* Source and destination IP addr */
  56     struct in_addr fw_smsk, fw_dmsk;    /* Mask for src and dest IP addr */
  57     u_short fw_number;                  /* Rule number */
  58     u_int fw_flg;                       /* Flags word */
  59 #define IP_FW_MAX_PORTS_COMPAT  10              /* A reasonable maximum */
  60         union {
  61                 u_short fw_pts[IP_FW_MAX_PORTS_COMPAT]; /* Array of port numbers to match */
  62 #define IP_FW_ICMPTYPES_MAX_COMPAT      128
  63 #define IP_FW_ICMPTYPES_DIM_COMPAT      (IP_FW_ICMPTYPES_MAX_COMPAT / (sizeof(unsigned) * 8))
  64                 unsigned fw_icmptypes[IP_FW_ICMPTYPES_DIM_COMPAT]; /* ICMP types bitmap */
  65         } fw_uar_compat;
  66     u_int fw_ipflg;                     /* IP flags word */
  67     u_char fw_ipopt,fw_ipnopt;          /* IP options set/unset */
  68     u_char fw_tcpopt,fw_tcpnopt;        /* TCP options set/unset */
  69     u_char fw_tcpf,fw_tcpnf;            /* TCP flags set/unset */
  70     long timestamp;                     /* timestamp (tv_sec) of last match */
  71     union ip_fw_if_compat fw_in_if, fw_out_if;  /* Incoming and outgoing interfaces */
  72     union {
  73                 u_short fu_divert_port;         /* Divert/tee port (options IPDIVERT) */
  74                 u_short fu_pipe_nr;             /* queue number (option DUMMYNET) */
  75                 u_short fu_skipto_rule;         /* SKIPTO command rule number */
  76                 u_short fu_reject_code;         /* REJECT response code */
  77                 struct sockaddr_in fu_fwd_ip;
  78     } fw_un_compat;
  79     u_char fw_prot;                     /* IP protocol */
  80         /*
  81          * N'of src ports and # of dst ports in ports array (dst ports
  82          * follow src ports; max of 10 ports in all; count of 0 means
  83          * match all ports)
  84          */
  85     u_char fw_nports;
  86     void *pipe_ptr;                    /* flow_set ptr for dummynet pipe */
  87     void *next_rule_ptr ;              /* next rule in case of match */
  88     uid_t fw_uid;                       /* uid to match */
  89     int fw_logamount;                   /* amount to log */
  90     u_int64_t fw_loghighest;            /* highest number packet to log */
  91 };
  92
  93 /*
  94  * extended ipfw structure... some fields in the original struct
  95  * can be used to pass parameters up/down, namely pointers
  96  *     void *pipe_ptr
  97  *     void *next_rule_ptr
  98  * some others can be used to pass parameters down, namely counters etc.
  99  *     u_int64_t fw_pcnt,fw_bcnt;
 100  *     long timestamp;
 101  */
 102
 103 struct ip_fw_ext_compat {             /* extended structure */
 104     struct ip_fw rule;      /* must be at offset 0 */
 105     long    dont_match_prob;        /* 0x7fffffff means 1.0, always fail */
 106     u_int   dyn_type;  /* type for dynamic rule */
 107 };
 108
 109 struct ip_fw_chain_compat {
 110         LIST_ENTRY(ip_fw_chain_compat) next;
 111         struct ip_fw_compat *rule;
 112 };
 113
 114 /*
 115  * dynamic ipfw rule
 116  */
 117 struct ipfw_dyn_rule_compat {
 118     struct ipfw_dyn_rule *next ;
 119
 120     struct ipfw_flow_id id ;
 121     struct ipfw_flow_id mask ;
 122     struct ip_fw_chain_compat *chain ;          /* pointer to parent rule       */
 123     u_int32_t type ;                    /* rule type                    */
 124     u_int32_t expire ;                  /* expire time                  */
 125     u_int64_t pcnt, bcnt;               /* match counters               */
 126     u_int32_t bucket ;                  /* which bucket in hash table   */
 127     u_int32_t state ;                   /* state of this rule (typ. a   */
 128                                         /* combination of TCP flags)    */
 129 } ;
 130
 131 #define IP_FW_GETNSRCP_COMPAT(rule)             ((rule)->fw_nports & 0x0f)
 132 #define IP_FW_SETNSRCP_COMPAT(rule, n)          do {                            \
 133                                           (rule)->fw_nports &= ~0x0f;   \
 134                                           (rule)->fw_nports |= (n);     \
 135                                         } while (0)
 136 #define IP_FW_GETNDSTP_COMPAT(rule)             ((rule)->fw_nports >> 4)
 137 #define IP_FW_SETNDSTP_COMPAT(rule, n)          do {                            \
 138                                           (rule)->fw_nports &= ~0xf0;   \
 139                                           (rule)->fw_nports |= (n) << 4;\
 140                                         } while (0)
 141
 142 #define fw_divert_port_compat   fw_un_compat.fu_divert_port
 143 #define fw_skipto_rule_compat   fw_un_compat.fu_skipto_rule
 144 #define fw_reject_code_compat   fw_un_compat.fu_reject_code
 145 #define fw_pipe_nr_compat       fw_un_compat.fu_pipe_nr
 146 #define fw_fwd_ip_compat        fw_un_compat.fu_fwd_ip
 147
 148 /*
 149  * Values for "flags" field .
 150  */
 151 #define IP_FW_F_COMMAND_COMPAT 0x000000ff       /* Mask for type of chain entry:        */
 152 #define IP_FW_F_DENY_COMPAT     0x00000000      /* This is a deny rule                  */
 153 #define IP_FW_F_REJECT_COMPAT   0x00000001      /* Deny and send a response packet      */
 154 #define IP_FW_F_ACCEPT_COMPAT   0x00000002      /* This is an accept rule               */
 155 #define IP_FW_F_COUNT_COMPAT    0x00000003      /* This is a count rule                 */
 156 #define IP_FW_F_DIVERT_COMPAT   0x00000004      /* This is a divert rule                */
 157 #define IP_FW_F_TEE_COMPAT      0x00000005      /* This is a tee rule                   */
 158 #define IP_FW_F_SKIPTO_COMPAT   0x00000006      /* This is a skipto rule                */
 159 #define IP_FW_F_FWD_COMPAT      0x00000007      /* This is a "change forwarding address" rule */
 160 #define IP_FW_F_PIPE_COMPAT     0x00000008      /* This is a dummynet rule */
 161 #define IP_FW_F_QUEUE_COMPAT    0x00000009      /* This is a dummynet queue */
 162
 163 #define IP_FW_F_IN_COMPAT       0x00000100      /* Check inbound packets                */
 164 #define IP_FW_F_OUT_COMPAT      0x00000200      /* Check outbound packets               */
 165 #define IP_FW_F_IIFACE_COMPAT   0x00000400      /* Apply inbound interface test         */
 166 #define IP_FW_F_OIFACE_COMPAT   0x00000800      /* Apply outbound interface test        */
 167
 168 #define IP_FW_F_PRN_COMPAT      0x00001000      /* Print if this rule matches           */
 169
 170 #define IP_FW_F_SRNG_COMPAT     0x00002000      /* The first two src ports are a min    *
 171                                          * and max range (stored in host byte   *
 172                                          * order).                              */
 173
 174 #define IP_FW_F_DRNG_COMPAT     0x00004000      /* The first two dst ports are a min    *
 175                                          * and max range (stored in host byte   *
 176                                          * order).                              */
 177
 178 #define IP_FW_F_FRAG_COMPAT     0x00008000      /* Fragment                             */
 179
 180 #define IP_FW_F_IIFNAME_COMPAT  0x00010000      /* In interface by name/unit (not IP)   */
 181 #define IP_FW_F_OIFNAME_COMPAT  0x00020000      /* Out interface by name/unit (not IP)  */
 182
 183 #define IP_FW_F_INVSRC_COMPAT   0x00040000      /* Invert sense of src check            */
 184 #define IP_FW_F_INVDST_COMPAT   0x00080000      /* Invert sense of dst check            */
 185
 186 #define IP_FW_F_ICMPBIT_COMPAT 0x00100000       /* ICMP type bitmap is valid            */
 187
 188 #define IP_FW_F_UID_COMPAT      0x00200000      /* filter by uid                        */
 189
 190 #define IP_FW_F_RND_MATCH_COMPAT 0x00800000     /* probabilistic rule match             */
 191 #define IP_FW_F_SMSK_COMPAT     0x01000000      /* src-port + mask                      */
 192 #define IP_FW_F_DMSK_COMPAT     0x02000000      /* dst-port + mask                      */
 193 #define IP_FW_BRIDGED_COMPAT    0x04000000      /* only match bridged packets           */
 194 #define IP_FW_F_KEEP_S_COMPAT   0x08000000      /* keep state                           */
 195 #define IP_FW_F_CHECK_S_COMPAT  0x10000000      /* check state                          */
 196
 197 #define IP_FW_F_SME_COMPAT      0x20000000      /* source = me                          */
 198 #define IP_FW_F_DME_COMPAT      0x40000000      /* destination = me                     */
 199
 200 #define IP_FW_F_MASK_COMPAT     0x7FFFFFFF      /* All possible flag bits mask          */
 201
 202 /*
 203  * Flags for the 'fw_ipflg' field, for comparing values of ip and its protocols.
 204  */
 205 #define IP_FW_IF_TCPEST_COMPAT  0x00000020      /* established TCP connection */
 206 #define IP_FW_IF_TCPMSK_COMPAT  0x00000020      /* mask of all TCP values */
 207
 208 /*
 209  * Definitions for TCP flags.
 210  */
 211 #define IP_FW_TCPF_FIN_COMPAT           TH_FIN
 212 #define IP_FW_TCPF_SYN_COMPAT           TH_SYN
 213 #define IP_FW_TCPF_RST_COMPAT           TH_RST
 214 #define IP_FW_TCPF_PSH_COMPAT           TH_PUSH
 215 #define IP_FW_TCPF_ACK_COMPAT           TH_ACK
 216 #define IP_FW_TCPF_URG_COMPAT           TH_URG
 217
 218 /*
 219  * For backwards compatibility with rules specifying "via iface" but
 220  * not restricted to only "in" or "out" packets, we define this combination
 221  * of bits to represent this configuration.
 222  */
 223
 224 #define IF_FW_F_VIAHACK_COMPAT  (IP_FW_F_IN_COMPAT|IP_FW_F_OUT_COMPAT|IP_FW_F_IIFACE_COMPAT|IP_FW_F_OIFACE_COMPAT)
 225
 226 /*
 227  * Definitions for REJECT response codes.
 228  * Values less than 256 correspond to ICMP unreachable codes.
 229  */
 230 #define IP_FW_REJECT_RST_COMPAT 0x0100          /* TCP packets: send RST */
 231
 232
 233 /*
 234  * ******************************
 235  * ****** IPFW version zero *****
 236  * ******************************
 237  */
 238
 239 /*
 240  * This union structure identifies an interface, either explicitly
 241  * by name or implicitly by IP address. The flags IP_FW_F_IIFNAME
 242  * and IP_FW_F_OIFNAME say how to interpret this structure. An
 243  * interface unit number of -1 matches any unit number, while an
 244  * IP address of 0.0.0.0 indicates matches any interface.
 245  *
 246  * The receive and transmit interfaces are only compared against the
 247  * the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE)
 248  * is set. Note some packets lack a receive or transmit interface
 249  * (in which case the missing "interface" never matches).
 250  */
 251
 252 union ip_old_fw_if {
 253     struct in_addr fu_via_ip;   /* Specified by IP address */
 254     struct {                    /* Specified by interface name */
 255 #define OLD_FW_IFNLEN     10 /* need room ! was IFNAMSIZ */
 256             char  name[OLD_FW_IFNLEN];
 257             short unit;         /* -1 means match any unit */
 258     } fu_via_if;
 259 };
 260
 261 /*
 262  * Format of an IP firewall descriptor
 263  *
 264  * fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order.
 265  * fw_flg and fw_n*p are stored in host byte order (of course).
 266  * Port numbers are stored in HOST byte order.
 267  * Warning: setsockopt() will fail if sizeof(struct ip_fw) > MLEN (108)
 268  */
 269
 270 struct ip_old_fw {
 271     u_int64_t fw_pcnt,fw_bcnt;          /* Packet and byte counters */
 272     struct in_addr fw_src, fw_dst;      /* Source and destination IP addr */
 273     struct in_addr fw_smsk, fw_dmsk;    /* Mask for src and dest IP addr */
 274     u_short fw_number;                  /* Rule number */
 275     u_int fw_flg;                       /* Flags word */
 276 #define IP_OLD_FW_MAX_PORTS     10              /* A reasonable maximum */
 277         union {
 278         u_short fw_pts[IP_OLD_FW_MAX_PORTS];    /* Array of port numbers to match */
 279 #define IP_OLD_FW_ICMPTYPES_MAX 128
 280 #define IP_OLD_FW_ICMPTYPES_DIM (IP_OLD_FW_ICMPTYPES_MAX / (sizeof(unsigned) * 8))
 281         unsigned fw_icmptypes[IP_OLD_FW_ICMPTYPES_DIM]; /* ICMP types bitmap */
 282         } fw_uar;
 283     u_char fw_ipopt,fw_ipnopt;          /* IP options set/unset */
 284     u_char fw_tcpf,fw_tcpnf;            /* TCP flags set/unset */
 285     long timestamp;                     /* timestamp (tv_sec) of last match */
 286     union ip_old_fw_if fw_in_if, fw_out_if;     /* Incoming and outgoing interfaces */
 287     union {
 288         u_short fu_divert_port;         /* Divert/tee port (options IPDIVERT) */
 289         u_short fu_pipe_nr;             /* pipe number (option DUMMYNET) */
 290         u_short fu_skipto_rule;         /* SKIPTO command rule number */
 291         u_short fu_reject_code;         /* REJECT response code */
 292         struct sockaddr_in fu_fwd_ip;
 293     } fw_un;
 294     u_char fw_prot;                     /* IP protocol */
 295     u_char fw_nports;                   /* N'of src ports and # of dst ports */
 296                                         /* in ports array (dst ports follow */
 297                                         /* src ports; max of 10 ports in all; */
 298                                         /* count of 0 means match all ports) */
 299     void *pipe_ptr;                    /* Pipe ptr in case of dummynet pipe */
 300     void *next_rule_ptr ;              /* next rule in case of match */
 301 };
 302
 303 #define IP_OLD_FW_GETNSRCP(rule)                ((rule)->fw_nports & 0x0f)
 304 #define IP_OLD_FW_SETNSRCP(rule, n)             do {                            \
 305                                           (rule)->fw_nports &= ~0x0f;   \
 306                                           (rule)->fw_nports |= (n);     \
 307                                         } while (0)
 308 #define IP_OLD_FW_GETNDSTP(rule)                ((rule)->fw_nports >> 4)
 309 #define IP_OLD_FW_SETNDSTP(rule, n)             do {                            \
 310                                           (rule)->fw_nports &= ~0xf0;   \
 311                                           (rule)->fw_nports |= (n) << 4;\
 312                                         } while (0)
 313
 314 #define old_fw_divert_port      fw_un.fu_divert_port
 315 #define old_fw_skipto_rule      fw_un.fu_skipto_rule
 316 #define old_fw_reject_code      fw_un.fu_reject_code
 317 #define old_fw_pipe_nr  fw_un.fu_pipe_nr
 318 #define old_fw_fwd_ip   fw_un.fu_fwd_ip
 319
 320 /*
 321  * Values for "flags" field .
 322  */
 323 #define IP_OLD_FW_F_COMMAND 0x000000ff  /* Mask for type of chain entry:        */
 324 #define IP_OLD_FW_F_DENY        0x00000000      /* This is a deny rule                  */
 325 #define IP_OLD_FW_F_REJECT      0x00000001      /* Deny and send a response packet      */
 326 #define IP_OLD_FW_F_ACCEPT      0x00000002      /* This is an accept rule               */
 327 #define IP_OLD_FW_F_COUNT       0x00000003      /* This is a count rule                 */
 328 #define IP_OLD_FW_F_DIVERT      0x00000004      /* This is a divert rule                */
 329 #define IP_OLD_FW_F_TEE 0x00000005      /* This is a tee rule                   */
 330 #define IP_OLD_FW_F_SKIPTO      0x00000006      /* This is a skipto rule                */
 331 #define IP_OLD_FW_F_FWD 0x00000007      /* This is a "change forwarding address" rule */
 332 #define IP_OLD_FW_F_PIPE        0x00000008      /* This is a dummynet rule */
 333
 334 #define IP_OLD_FW_F_IN  0x00000100      /* Check inbound packets                */
 335 #define IP_OLD_FW_F_OUT 0x00000200      /* Check outbound packets               */
 336 #define IP_OLD_FW_F_IIFACE      0x00000400      /* Apply inbound interface test         */
 337 #define IP_OLD_FW_F_OIFACE      0x00000800      /* Apply outbound interface test        */
 338
 339 #define IP_OLD_FW_F_PRN 0x00001000      /* Print if this rule matches           */
 340
 341 #define IP_OLD_FW_F_SRNG        0x00002000      /* The first two src ports are a min    *
 342                                          * and max range (stored in host byte   *
 343                                          * order).                              */
 344
 345 #define IP_OLD_FW_F_DRNG        0x00004000      /* The first two dst ports are a min    *
 346                                          * and max range (stored in host byte   *
 347                                          * order).                              */
 348
 349 #define IP_OLD_FW_F_FRAG        0x00008000      /* Fragment                             */
 350
 351 #define IP_OLD_FW_F_IIFNAME     0x00010000      /* In interface by name/unit (not IP)   */
 352 #define IP_OLD_FW_F_OIFNAME     0x00020000      /* Out interface by name/unit (not IP)  */
 353
 354 #define IP_OLD_FW_F_INVSRC      0x00040000      /* Invert sense of src check            */
 355 #define IP_OLD_FW_F_INVDST      0x00080000      /* Invert sense of dst check            */
 356
 357 #define IP_OLD_FW_F_ICMPBIT 0x00100000  /* ICMP type bitmap is valid            */
 358
 359 #define IP_OLD_FW_F_MASK        0x001FFFFF      /* All possible flag bits mask          */
 360
 361 /*
 362  * For backwards compatibility with rules specifying "via iface" but
 363  * not restricted to only "in" or "out" packets, we define this combination
 364  * of bits to represent this configuration.
 365  */
 366
 367 #define IF_OLD_FW_F_VIAHACK     (IP_OLD_FW_F_IN|IP_OLD_FW_F_OUT|IP_OLD_FW_F_IIFACE|IP_OLD_FW_F_OIFACE)
 368
 369 /*
 370  * Definitions for TCP flags - abridged
 371  */
 372 #define IP_OLD_FW_TCPF_ESTAB    0x40
 373
 374 #endif
 375