ui/firewall_rules.h

   1 /** @file
   2  *
   3  * Produce ACL rules for various products from a packet.
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 2006 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #ifndef __UI_FIREWALL_RULES_H__
  13 #define __UI_FIREWALL_RULES_H__
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif /* __cplusplus */
  18
  19 /* Rule types */
  20 typedef enum {
  21     RT_NONE,
  22     RT_MAC_SRC,
  23     RT_MAC_DST,
  24     RT_IPv4_SRC,
  25     RT_IPv4_DST,
  26     RT_PORT_SRC,
  27     RT_PORT_DST,
  28     RT_IPv4_PORT_SRC,
  29     RT_IPv4_PORT_DST,
  30     NUM_RULE_TYPES
  31 } rule_type_e;
  32
  33 /** Fetch the number of firewall products.
  34  * @return The number of firewall products. Should be used as the index for
  35  * the rest of the functions below.
  36  */
  37 size_t firewall_product_count(void);
  38
  39 /** Product name
  40  * Given an index, return the product name.
  41  * @param product_idx Product index.
  42  * @return Product name or "Unknown".
  43  */
  44 const char *firewall_product_name(size_t product_idx);
  45
  46 /** Product rule hint
  47  * Given an index, return the product's rule hint.
  48  * @param product_idx Product index.
  49  * @return Product rule hint, e.g. "Change le0 to a valid interface." or "".
  50  */
  51 const char *firewall_product_rule_hint(size_t product_idx);
  52
  53 /** Comment prefix
  54  * @param product_idx Product index.
  55  * @return The comment prefix, e.g. "#" or an empty string.
  56  */
  57 const char *firewall_product_comment_prefix(size_t product_idx);
  58
  59 /* Syntax function prototypes */
  60 typedef void (*syntax_func)(GString *rtxt, char *addr, uint32_t port, port_type ptype, bool inbound, bool deny);
  61
  62 /** MAC filter function
  63  * @param product_idx Product index.
  64  * @return A pointer to the MAC filter function or NULL.
  65  */
  66 syntax_func firewall_product_mac_func(size_t product_idx);
  67
  68 /** IPv4 filter function
  69  * @param product_idx Product index.
  70  * @return A pointer to the IPv4 filter function or NULL.
  71  */
  72 syntax_func firewall_product_ipv4_func(size_t product_idx);
  73
  74 /** Port filter function
  75  * @param product_idx Product index.
  76  * @return A pointer to the port filter function or NULL.
  77  */
  78 syntax_func firewall_product_port_func(size_t product_idx);
  79
  80 /** IPv4+port filter function
  81  * @param product_idx Product index.
  82  * @return A pointer to the IPv4+port filter function or NULL.
  83  */
  84 syntax_func firewall_product_ipv4_port_func(size_t product_idx);
  85
  86 /** Product inbound support
  87  * Given an index, return the product's ability to support inbound rules.
  88  * @param product_idx Product index.
  89  * @return true or false.
  90  */
  91 bool firewall_product_does_inbound(size_t product_idx);
  92
  93 #ifdef __cplusplus
  94 }
  95 #endif /* __cplusplus */
  96
  97 #endif /* __UI_FIREWALL_RULES_H__ */