Blame include/libiptc/libiptc.h

Packit d3f73b
/* SPDX-License-Identifier: GPL-2.0 */
Packit d3f73b
#ifndef _LIBIPTC_H
Packit d3f73b
#define _LIBIPTC_H
Packit d3f73b
/* Library which manipulates filtering rules. */
Packit d3f73b
Packit d3f73b
#include <linux/types.h>
Packit d3f73b
#include <libiptc/ipt_kernel_headers.h>
Packit d3f73b
#ifdef __cplusplus
Packit d3f73b
#	include <climits>
Packit d3f73b
#else
Packit d3f73b
#	include <limits.h> /* INT_MAX in ip_tables.h */
Packit d3f73b
#endif
Packit d3f73b
#include <linux/netfilter_ipv4/ip_tables.h>
Packit d3f73b
#include <libiptc/xtcshared.h>
Packit d3f73b
Packit d3f73b
#ifdef __cplusplus
Packit d3f73b
extern "C" {
Packit d3f73b
#endif
Packit d3f73b
Packit d3f73b
#define iptc_handle xtc_handle
Packit d3f73b
#define ipt_chainlabel xt_chainlabel
Packit d3f73b
Packit d3f73b
#define IPTC_LABEL_ACCEPT  "ACCEPT"
Packit d3f73b
#define IPTC_LABEL_DROP    "DROP"
Packit d3f73b
#define IPTC_LABEL_QUEUE   "QUEUE"
Packit d3f73b
#define IPTC_LABEL_RETURN  "RETURN"
Packit d3f73b
Packit d3f73b
/* Does this chain exist? */
Packit d3f73b
int iptc_is_chain(const char *chain, struct xtc_handle *const handle);
Packit d3f73b
Packit d3f73b
/* Take a snapshot of the rules.  Returns NULL on error. */
Packit d3f73b
struct xtc_handle *iptc_init(const char *tablename);
Packit d3f73b
Packit d3f73b
/* Cleanup after iptc_init(). */
Packit d3f73b
void iptc_free(struct xtc_handle *h);
Packit d3f73b
Packit d3f73b
/* Iterator functions to run through the chains.  Returns NULL at end. */
Packit d3f73b
const char *iptc_first_chain(struct xtc_handle *handle);
Packit d3f73b
const char *iptc_next_chain(struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Get first rule in the given chain: NULL for empty chain. */
Packit d3f73b
const struct ipt_entry *iptc_first_rule(const char *chain,
Packit d3f73b
					struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Returns NULL when rules run out. */
Packit d3f73b
const struct ipt_entry *iptc_next_rule(const struct ipt_entry *prev,
Packit d3f73b
				       struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Returns a pointer to the target name of this entry. */
Packit d3f73b
const char *iptc_get_target(const struct ipt_entry *e,
Packit d3f73b
			    struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Is this a built-in chain? */
Packit d3f73b
int iptc_builtin(const char *chain, struct xtc_handle *const handle);
Packit d3f73b
Packit d3f73b
/* Get the policy of a given built-in chain */
Packit d3f73b
const char *iptc_get_policy(const char *chain,
Packit d3f73b
			    struct xt_counters *counter,
Packit d3f73b
			    struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* These functions return TRUE for OK or 0 and set errno.  If errno ==
Packit d3f73b
   0, it means there was a version error (ie. upgrade libiptc). */
Packit d3f73b
/* Rule numbers start at 1 for the first rule. */
Packit d3f73b
Packit d3f73b
/* Insert the entry `e' in chain `chain' into position `rulenum'. */
Packit d3f73b
int iptc_insert_entry(const xt_chainlabel chain,
Packit d3f73b
		      const struct ipt_entry *e,
Packit d3f73b
		      unsigned int rulenum,
Packit d3f73b
		      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Atomically replace rule `rulenum' in `chain' with `e'. */
Packit d3f73b
int iptc_replace_entry(const xt_chainlabel chain,
Packit d3f73b
		       const struct ipt_entry *e,
Packit d3f73b
		       unsigned int rulenum,
Packit d3f73b
		       struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Append entry `e' to chain `chain'.  Equivalent to insert with
Packit d3f73b
   rulenum = length of chain. */
Packit d3f73b
int iptc_append_entry(const xt_chainlabel chain,
Packit d3f73b
		      const struct ipt_entry *e,
Packit d3f73b
		      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Check whether a mathching rule exists */
Packit d3f73b
int iptc_check_entry(const xt_chainlabel chain,
Packit d3f73b
		      const struct ipt_entry *origfw,
Packit d3f73b
		      unsigned char *matchmask,
Packit d3f73b
		      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Delete the first rule in `chain' which matches `e', subject to
Packit d3f73b
   matchmask (array of length == origfw) */
Packit d3f73b
int iptc_delete_entry(const xt_chainlabel chain,
Packit d3f73b
		      const struct ipt_entry *origfw,
Packit d3f73b
		      unsigned char *matchmask,
Packit d3f73b
		      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Delete the rule in position `rulenum' in `chain'. */
Packit d3f73b
int iptc_delete_num_entry(const xt_chainlabel chain,
Packit d3f73b
			  unsigned int rulenum,
Packit d3f73b
			  struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Check the packet `e' on chain `chain'.  Returns the verdict, or
Packit d3f73b
   NULL and sets errno. */
Packit d3f73b
const char *iptc_check_packet(const xt_chainlabel chain,
Packit d3f73b
			      struct ipt_entry *entry,
Packit d3f73b
			      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Flushes the entries in the given chain (ie. empties chain). */
Packit d3f73b
int iptc_flush_entries(const xt_chainlabel chain,
Packit d3f73b
		       struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Zeroes the counters in a chain. */
Packit d3f73b
int iptc_zero_entries(const xt_chainlabel chain,
Packit d3f73b
		      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Creates a new chain. */
Packit d3f73b
int iptc_create_chain(const xt_chainlabel chain,
Packit d3f73b
		      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Deletes a chain. */
Packit d3f73b
int iptc_delete_chain(const xt_chainlabel chain,
Packit d3f73b
		      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Renames a chain. */
Packit d3f73b
int iptc_rename_chain(const xt_chainlabel oldname,
Packit d3f73b
		      const xt_chainlabel newname,
Packit d3f73b
		      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Sets the policy on a built-in chain. */
Packit d3f73b
int iptc_set_policy(const xt_chainlabel chain,
Packit d3f73b
		    const xt_chainlabel policy,
Packit d3f73b
		    struct xt_counters *counters,
Packit d3f73b
		    struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Get the number of references to this chain */
Packit d3f73b
int iptc_get_references(unsigned int *ref,
Packit d3f73b
			const xt_chainlabel chain,
Packit d3f73b
			struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* read packet and byte counters for a specific rule */
Packit d3f73b
struct xt_counters *iptc_read_counter(const xt_chainlabel chain,
Packit d3f73b
				       unsigned int rulenum,
Packit d3f73b
				       struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* zero packet and byte counters for a specific rule */
Packit d3f73b
int iptc_zero_counter(const xt_chainlabel chain,
Packit d3f73b
		      unsigned int rulenum,
Packit d3f73b
		      struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* set packet and byte counters for a specific rule */
Packit d3f73b
int iptc_set_counter(const xt_chainlabel chain,
Packit d3f73b
		     unsigned int rulenum,
Packit d3f73b
		     struct xt_counters *counters,
Packit d3f73b
		     struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Makes the actual changes. */
Packit d3f73b
int iptc_commit(struct xtc_handle *handle);
Packit d3f73b
Packit d3f73b
/* Get raw socket. */
Packit d3f73b
int iptc_get_raw_socket(void);
Packit d3f73b
Packit d3f73b
/* Translates errno numbers into more human-readable form than strerror. */
Packit d3f73b
const char *iptc_strerror(int err);
Packit d3f73b
Packit d3f73b
extern void dump_entries(struct xtc_handle *const);
Packit d3f73b
Packit d3f73b
extern const struct xtc_ops iptc_ops;
Packit d3f73b
Packit d3f73b
#ifdef __cplusplus
Packit d3f73b
}
Packit d3f73b
#endif
Packit d3f73b
Packit d3f73b
Packit d3f73b
#endif /* _LIBIPTC_H */