xref: /aosp_15_r20/external/iptables/include/libiptc/libiptc.h (revision a71a954618bbadd4a345637e5edcf36eec826889)
1*a71a9546SAutomerger Merge Worker #ifndef _LIBIPTC_H
2*a71a9546SAutomerger Merge Worker #define _LIBIPTC_H
3*a71a9546SAutomerger Merge Worker /* Library which manipulates filtering rules. */
4*a71a9546SAutomerger Merge Worker 
5*a71a9546SAutomerger Merge Worker #include <linux/types.h>
6*a71a9546SAutomerger Merge Worker #include <libiptc/ipt_kernel_headers.h>
7*a71a9546SAutomerger Merge Worker #ifdef __cplusplus
8*a71a9546SAutomerger Merge Worker #	include <climits>
9*a71a9546SAutomerger Merge Worker #else
10*a71a9546SAutomerger Merge Worker #	include <limits.h> /* INT_MAX in ip_tables.h */
11*a71a9546SAutomerger Merge Worker #endif
12*a71a9546SAutomerger Merge Worker #include <linux/netfilter_ipv4/ip_tables.h>
13*a71a9546SAutomerger Merge Worker #include <libiptc/xtcshared.h>
14*a71a9546SAutomerger Merge Worker 
15*a71a9546SAutomerger Merge Worker #ifdef __cplusplus
16*a71a9546SAutomerger Merge Worker extern "C" {
17*a71a9546SAutomerger Merge Worker #endif
18*a71a9546SAutomerger Merge Worker 
19*a71a9546SAutomerger Merge Worker #define iptc_handle xtc_handle
20*a71a9546SAutomerger Merge Worker #define ipt_chainlabel xt_chainlabel
21*a71a9546SAutomerger Merge Worker 
22*a71a9546SAutomerger Merge Worker #define IPTC_LABEL_ACCEPT  "ACCEPT"
23*a71a9546SAutomerger Merge Worker #define IPTC_LABEL_DROP    "DROP"
24*a71a9546SAutomerger Merge Worker #define IPTC_LABEL_QUEUE   "QUEUE"
25*a71a9546SAutomerger Merge Worker #define IPTC_LABEL_RETURN  "RETURN"
26*a71a9546SAutomerger Merge Worker 
27*a71a9546SAutomerger Merge Worker /* Does this chain exist? */
28*a71a9546SAutomerger Merge Worker int iptc_is_chain(const char *chain, struct xtc_handle *const handle);
29*a71a9546SAutomerger Merge Worker 
30*a71a9546SAutomerger Merge Worker /* Take a snapshot of the rules.  Returns NULL on error. */
31*a71a9546SAutomerger Merge Worker struct xtc_handle *iptc_init(const char *tablename);
32*a71a9546SAutomerger Merge Worker 
33*a71a9546SAutomerger Merge Worker /* Cleanup after iptc_init(). */
34*a71a9546SAutomerger Merge Worker void iptc_free(struct xtc_handle *h);
35*a71a9546SAutomerger Merge Worker 
36*a71a9546SAutomerger Merge Worker /* Iterator functions to run through the chains.  Returns NULL at end. */
37*a71a9546SAutomerger Merge Worker const char *iptc_first_chain(struct xtc_handle *handle);
38*a71a9546SAutomerger Merge Worker const char *iptc_next_chain(struct xtc_handle *handle);
39*a71a9546SAutomerger Merge Worker 
40*a71a9546SAutomerger Merge Worker /* Get first rule in the given chain: NULL for empty chain. */
41*a71a9546SAutomerger Merge Worker const struct ipt_entry *iptc_first_rule(const char *chain,
42*a71a9546SAutomerger Merge Worker 					struct xtc_handle *handle);
43*a71a9546SAutomerger Merge Worker 
44*a71a9546SAutomerger Merge Worker /* Returns NULL when rules run out. */
45*a71a9546SAutomerger Merge Worker const struct ipt_entry *iptc_next_rule(const struct ipt_entry *prev,
46*a71a9546SAutomerger Merge Worker 				       struct xtc_handle *handle);
47*a71a9546SAutomerger Merge Worker 
48*a71a9546SAutomerger Merge Worker /* Returns a pointer to the target name of this entry. */
49*a71a9546SAutomerger Merge Worker const char *iptc_get_target(const struct ipt_entry *e,
50*a71a9546SAutomerger Merge Worker 			    struct xtc_handle *handle);
51*a71a9546SAutomerger Merge Worker 
52*a71a9546SAutomerger Merge Worker /* Is this a built-in chain? */
53*a71a9546SAutomerger Merge Worker int iptc_builtin(const char *chain, struct xtc_handle *const handle);
54*a71a9546SAutomerger Merge Worker 
55*a71a9546SAutomerger Merge Worker /* Get the policy of a given built-in chain */
56*a71a9546SAutomerger Merge Worker const char *iptc_get_policy(const char *chain,
57*a71a9546SAutomerger Merge Worker 			    struct xt_counters *counter,
58*a71a9546SAutomerger Merge Worker 			    struct xtc_handle *handle);
59*a71a9546SAutomerger Merge Worker 
60*a71a9546SAutomerger Merge Worker /* These functions return TRUE for OK or 0 and set errno.  If errno ==
61*a71a9546SAutomerger Merge Worker    0, it means there was a version error (ie. upgrade libiptc). */
62*a71a9546SAutomerger Merge Worker /* Rule numbers start at 1 for the first rule. */
63*a71a9546SAutomerger Merge Worker 
64*a71a9546SAutomerger Merge Worker /* Insert the entry `e' in chain `chain' into position `rulenum'. */
65*a71a9546SAutomerger Merge Worker int iptc_insert_entry(const xt_chainlabel chain,
66*a71a9546SAutomerger Merge Worker 		      const struct ipt_entry *e,
67*a71a9546SAutomerger Merge Worker 		      unsigned int rulenum,
68*a71a9546SAutomerger Merge Worker 		      struct xtc_handle *handle);
69*a71a9546SAutomerger Merge Worker 
70*a71a9546SAutomerger Merge Worker /* Atomically replace rule `rulenum' in `chain' with `e'. */
71*a71a9546SAutomerger Merge Worker int iptc_replace_entry(const xt_chainlabel chain,
72*a71a9546SAutomerger Merge Worker 		       const struct ipt_entry *e,
73*a71a9546SAutomerger Merge Worker 		       unsigned int rulenum,
74*a71a9546SAutomerger Merge Worker 		       struct xtc_handle *handle);
75*a71a9546SAutomerger Merge Worker 
76*a71a9546SAutomerger Merge Worker /* Append entry `e' to chain `chain'.  Equivalent to insert with
77*a71a9546SAutomerger Merge Worker    rulenum = length of chain. */
78*a71a9546SAutomerger Merge Worker int iptc_append_entry(const xt_chainlabel chain,
79*a71a9546SAutomerger Merge Worker 		      const struct ipt_entry *e,
80*a71a9546SAutomerger Merge Worker 		      struct xtc_handle *handle);
81*a71a9546SAutomerger Merge Worker 
82*a71a9546SAutomerger Merge Worker /* Check whether a mathching rule exists */
83*a71a9546SAutomerger Merge Worker int iptc_check_entry(const xt_chainlabel chain,
84*a71a9546SAutomerger Merge Worker 		      const struct ipt_entry *origfw,
85*a71a9546SAutomerger Merge Worker 		      unsigned char *matchmask,
86*a71a9546SAutomerger Merge Worker 		      struct xtc_handle *handle);
87*a71a9546SAutomerger Merge Worker 
88*a71a9546SAutomerger Merge Worker /* Delete the first rule in `chain' which matches `e', subject to
89*a71a9546SAutomerger Merge Worker    matchmask (array of length == origfw) */
90*a71a9546SAutomerger Merge Worker int iptc_delete_entry(const xt_chainlabel chain,
91*a71a9546SAutomerger Merge Worker 		      const struct ipt_entry *origfw,
92*a71a9546SAutomerger Merge Worker 		      unsigned char *matchmask,
93*a71a9546SAutomerger Merge Worker 		      struct xtc_handle *handle);
94*a71a9546SAutomerger Merge Worker 
95*a71a9546SAutomerger Merge Worker /* Delete the rule in position `rulenum' in `chain'. */
96*a71a9546SAutomerger Merge Worker int iptc_delete_num_entry(const xt_chainlabel chain,
97*a71a9546SAutomerger Merge Worker 			  unsigned int rulenum,
98*a71a9546SAutomerger Merge Worker 			  struct xtc_handle *handle);
99*a71a9546SAutomerger Merge Worker 
100*a71a9546SAutomerger Merge Worker /* Check the packet `e' on chain `chain'.  Returns the verdict, or
101*a71a9546SAutomerger Merge Worker    NULL and sets errno. */
102*a71a9546SAutomerger Merge Worker const char *iptc_check_packet(const xt_chainlabel chain,
103*a71a9546SAutomerger Merge Worker 			      struct ipt_entry *entry,
104*a71a9546SAutomerger Merge Worker 			      struct xtc_handle *handle);
105*a71a9546SAutomerger Merge Worker 
106*a71a9546SAutomerger Merge Worker /* Flushes the entries in the given chain (ie. empties chain). */
107*a71a9546SAutomerger Merge Worker int iptc_flush_entries(const xt_chainlabel chain,
108*a71a9546SAutomerger Merge Worker 		       struct xtc_handle *handle);
109*a71a9546SAutomerger Merge Worker 
110*a71a9546SAutomerger Merge Worker /* Zeroes the counters in a chain. */
111*a71a9546SAutomerger Merge Worker int iptc_zero_entries(const xt_chainlabel chain,
112*a71a9546SAutomerger Merge Worker 		      struct xtc_handle *handle);
113*a71a9546SAutomerger Merge Worker 
114*a71a9546SAutomerger Merge Worker /* Creates a new chain. */
115*a71a9546SAutomerger Merge Worker int iptc_create_chain(const xt_chainlabel chain,
116*a71a9546SAutomerger Merge Worker 		      struct xtc_handle *handle);
117*a71a9546SAutomerger Merge Worker 
118*a71a9546SAutomerger Merge Worker /* Deletes a chain. */
119*a71a9546SAutomerger Merge Worker int iptc_delete_chain(const xt_chainlabel chain,
120*a71a9546SAutomerger Merge Worker 		      struct xtc_handle *handle);
121*a71a9546SAutomerger Merge Worker 
122*a71a9546SAutomerger Merge Worker /* Renames a chain. */
123*a71a9546SAutomerger Merge Worker int iptc_rename_chain(const xt_chainlabel oldname,
124*a71a9546SAutomerger Merge Worker 		      const xt_chainlabel newname,
125*a71a9546SAutomerger Merge Worker 		      struct xtc_handle *handle);
126*a71a9546SAutomerger Merge Worker 
127*a71a9546SAutomerger Merge Worker /* Sets the policy on a built-in chain. */
128*a71a9546SAutomerger Merge Worker int iptc_set_policy(const xt_chainlabel chain,
129*a71a9546SAutomerger Merge Worker 		    const xt_chainlabel policy,
130*a71a9546SAutomerger Merge Worker 		    struct xt_counters *counters,
131*a71a9546SAutomerger Merge Worker 		    struct xtc_handle *handle);
132*a71a9546SAutomerger Merge Worker 
133*a71a9546SAutomerger Merge Worker /* Get the number of references to this chain */
134*a71a9546SAutomerger Merge Worker int iptc_get_references(unsigned int *ref,
135*a71a9546SAutomerger Merge Worker 			const xt_chainlabel chain,
136*a71a9546SAutomerger Merge Worker 			struct xtc_handle *handle);
137*a71a9546SAutomerger Merge Worker 
138*a71a9546SAutomerger Merge Worker /* read packet and byte counters for a specific rule */
139*a71a9546SAutomerger Merge Worker struct xt_counters *iptc_read_counter(const xt_chainlabel chain,
140*a71a9546SAutomerger Merge Worker 				       unsigned int rulenum,
141*a71a9546SAutomerger Merge Worker 				       struct xtc_handle *handle);
142*a71a9546SAutomerger Merge Worker 
143*a71a9546SAutomerger Merge Worker /* zero packet and byte counters for a specific rule */
144*a71a9546SAutomerger Merge Worker int iptc_zero_counter(const xt_chainlabel chain,
145*a71a9546SAutomerger Merge Worker 		      unsigned int rulenum,
146*a71a9546SAutomerger Merge Worker 		      struct xtc_handle *handle);
147*a71a9546SAutomerger Merge Worker 
148*a71a9546SAutomerger Merge Worker /* set packet and byte counters for a specific rule */
149*a71a9546SAutomerger Merge Worker int iptc_set_counter(const xt_chainlabel chain,
150*a71a9546SAutomerger Merge Worker 		     unsigned int rulenum,
151*a71a9546SAutomerger Merge Worker 		     struct xt_counters *counters,
152*a71a9546SAutomerger Merge Worker 		     struct xtc_handle *handle);
153*a71a9546SAutomerger Merge Worker 
154*a71a9546SAutomerger Merge Worker /* Makes the actual changes. */
155*a71a9546SAutomerger Merge Worker int iptc_commit(struct xtc_handle *handle);
156*a71a9546SAutomerger Merge Worker 
157*a71a9546SAutomerger Merge Worker /* Get raw socket. */
158*a71a9546SAutomerger Merge Worker int iptc_get_raw_socket(void);
159*a71a9546SAutomerger Merge Worker 
160*a71a9546SAutomerger Merge Worker /* Translates errno numbers into more human-readable form than strerror. */
161*a71a9546SAutomerger Merge Worker const char *iptc_strerror(int err);
162*a71a9546SAutomerger Merge Worker 
163*a71a9546SAutomerger Merge Worker extern void dump_entries(struct xtc_handle *const);
164*a71a9546SAutomerger Merge Worker 
165*a71a9546SAutomerger Merge Worker extern const struct xtc_ops iptc_ops;
166*a71a9546SAutomerger Merge Worker 
167*a71a9546SAutomerger Merge Worker #ifdef __cplusplus
168*a71a9546SAutomerger Merge Worker }
169*a71a9546SAutomerger Merge Worker #endif
170*a71a9546SAutomerger Merge Worker 
171*a71a9546SAutomerger Merge Worker 
172*a71a9546SAutomerger Merge Worker #endif /* _LIBIPTC_H */
173