iptables

Documentation

Overview

Package iptables implements objects that manipulate netfilter rules by calling the iptables binary.

Index

• type Iptables
  • func New(executor runtime.Executor) Iptables
  • func (i Iptables) Add(r Rule) error
  • func (i Iptables) Remove(r Rule) error
• type Rule
• type RuleSet
  • func NewRuleSet(iptables Iptables) *RuleSet
  • func (i *RuleSet) Add(r Rule) error
  • func (i *RuleSet) Remove() error

Types

type Iptables

type Iptables struct {
	// contains filtered or unexported fields
}

Iptables adds and removes iptables rules by executing the `iptables` binary.

func New

func New(executor runtime.Executor) Iptables

New returns a new Iptables ready to use.

func (Iptables) Add

func (i Iptables) Add(r Rule) error

Add appends a rule into the corresponding table and chain.

func (Iptables) Remove

func (i Iptables) Remove(r Rule) error

Remove removes an existing rule. If the rule does not exist, an error is returned.

type Rule

type Rule struct {
	// Table is the netfilter table to which this rule belongs. It is usually "filter".
	Table string
	// Chain is the netfilter chain to which this rule belongs. Usual values are "INPUT", "OUTPUT".
	Chain string
	// Args is the rest of the netfilter rule.
	// Arguments must be space-separated. Using shell-style quotes or backslashes to group more than one space-separated
	// word as one argument is not allowed.
	Args string
}

Rule is a netfilter/iptables rule.

type RuleSet

type RuleSet struct {
	// contains filtered or unexported fields
}

RuleSet is a stateful object that allows adding rules and keeping track of them to remove them later.

func NewRuleSet

func NewRuleSet(iptables Iptables) *RuleSet

NewRuleSet builds a RuleSet that uses the provided Iptables instance to add and remove rules.

func (*RuleSet) Add

func (i *RuleSet) Add(r Rule) error

Add adds a rule. Added rule will be remembered and removed later together with other rules when Remove is called.

func (*RuleSet) Remove

func (i *RuleSet) Remove() error

Remove removes all added rules. If an error occurs, Remove continues to try and remove remaining rules.