pathpol

type ACL ¶

type ACL struct {
	Entries []*ACLEntry
}

func NewACL(entries ...*ACLEntry) (*ACL, error)

func (a *ACL) Eval(inputSet PathSet) PathSet

func (a *ACL) MarshalJSON() ([]byte, error)

func (a *ACL) UnmarshalJSON(b []byte) error

type ACLAction ¶

type ACLAction bool

ACLAction has two options: Deny and Allow

const (
	Deny  ACLAction = false
	Allow ACLAction = true
)

type ACLEntry ¶

type ACLEntry struct {
	Action ACLAction
	Rule   *HopPredicate
}

func (ae *ACLEntry) LoadFromString(str string) error

func (ae *ACLEntry) MarshalJSON() ([]byte, error)

func (ae *ACLEntry) String() string

func (ae *ACLEntry) UnmarshalJSON(b []byte) error

type ExtPolicy ¶

type ExtPolicy struct {
	Extends []string `json:"extends,omitempty"`
	*Policy
}

ExtPolicy is an extending policy, it may have a list of policies it extends

type FilterOptions ¶

type FilterOptions struct {
	// IgnoreSequence can be used to ignore the sequence part of policies.
	IgnoreSequence bool
}

FilterOptions contains options for filtering.

type HopPredicate ¶

type HopPredicate struct {
	ISD   addr.ISD
	AS    addr.AS
	IfIDs []common.IFIDType
}

A HopPredicate specifies a hop in the ACL or Sequence of the path policy, see docs/PathPolicy.md.

func HopPredicateFromString(str string) (*HopPredicate, error)

func NewHopPredicate() *HopPredicate

func (hp *HopPredicate) MarshalJSON() ([]byte, error)

func (hp HopPredicate) String() string

func (hp *HopPredicate) UnmarshalJSON(b []byte) error

type Option ¶

type Option struct {
	Weight int        `json:"weight"`
	Policy *ExtPolicy `json:"policy"`
}

Option contains a weight and a policy and is used as a list item in Policy.Options

type Path ¶

type Path interface {
	// Interfaces returns all the interfaces of this path.
	Interfaces() []PathInterface
	// Returns a string that uniquely identifies this path.
	Key() string
}

Path describes a path or a partial path, e.g. a segment.

type PathInterface ¶

type PathInterface interface {
	// IfId is the id of the interface.
	IfId() common.IFIDType
	// IA is the ISD AS identifier of the interface.
	IA() addr.IA
}

PathInterface is an interface on the path.

type PathSet ¶

type PathSet map[string]Path

PathSet is a set of paths. PathSet is used for policy filtering.

type Policy ¶

type Policy struct {
	Name     string    `json:"-"`
	ACL      *ACL      `json:"acl,omitempty"`
	Sequence *Sequence `json:"sequence,omitempty"`
	Options  []Option  `json:"options,omitempty"`
}

Policy is a compiled path policy object, all extended policies have been merged.

func NewPolicy(name string, acl *ACL, sequence *Sequence, options []Option) *Policy

func PolicyFromExtPolicy(extPolicy *ExtPolicy, extended []*ExtPolicy) (*Policy, error)

func (p *Policy) Filter(paths PathSet) PathSet

func (p *Policy) FilterOpt(paths PathSet, opts FilterOptions) PathSet

type PolicyMap ¶

type PolicyMap map[string]*ExtPolicy

PolicyMap is a container for Policies, keyed by their unique name. PolicyMap can be used to marshal Policies to JSON. Unmarshaling back to PolicyMap is guaranteed to yield an object that is identical to the initial one.

type Sequence ¶

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

func NewSequence(s string) (*Sequence, error)

func (s *Sequence) Eval(inputSet PathSet) PathSet

func (s *Sequence) MarshalJSON() ([]byte, error)

func (s *Sequence) UnmarshalJSON(b []byte) error