policy

Documentation

Index

• Constants
• Variables
• func ResolveEndpoints(ctx context.Context, hostports []string, hosts *Hosts) ([]netip.AddrPort, error)
• type DebugPorts
• type Dialer
  • func NewDialer(p *Policy) *Dialer
  • func (d *Dialer) Control(network, address string, _ syscall.RawConn) error
  • func (d *Dialer) Dial(network, address string) (net.Conn, error)
  • func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)
• type Error
  • func (e *Error) Errno() string
  • func (e *Error) Error() string
  • func (e *Error) Is(target error) bool
• type Hosts
  • func LoadHosts(path string) (*Hosts, error)
  • func ParseHosts(r io.Reader) (*Hosts, error)
  • func (h *Hosts) Lookup(network, name string) ([]netip.Addr, bool)
• type Policy
  • func Local(protectedPorts ...uint16) *Policy
  • func New() *Policy
  • func Remote(protectedPorts ...uint16) *Policy
  • func (p *Policy) AddProtectedEndpoints(id string, addrs []netip.AddrPort)
  • func (p *Policy) Allow() []string
  • func (p *Policy) AllowsAny(addr netip.Addr) bool
  • func (p *Policy) Check(addr netip.Addr, port uint16) error
  • func (p *Policy) CheckDatagram(addr netip.Addr, port uint16) error
  • func (p *Policy) Deny() []string
  • func (p *Policy) Exposed() []uint16
  • func (p *Policy) Filter(addrs []netip.Addr) []netip.Addr
  • func (p *Policy) Guard(d DebugPorts) *Policy
  • func (p *Policy) GuardPort(port uint16) bool
  • func (p *Policy) Live(scan func() []uint16, found func(uint16))
  • func (p *Policy) ProtectBrowser(ctx context.Context, id string, hostports []string, hosts *Hosts) error
  • func (p *Policy) ProtectEndpoints(id string, addrs []netip.AddrPort)
  • func (p *Policy) ProtectedEndpoints(id string) []netip.AddrPort
  • func (p *Policy) RefreshBrowser(ctx context.Context, id string, hostports []string, hosts *Hosts) error
  • func (p *Policy) Summary() string
  • func (p *Policy) With(allow, deny []Rule) *Policy
• type Ports
  • func (s *Ports) Set(v string) error
  • func (s *Ports) String() string
• type Resolver
  • func NewResolver(p *Policy) *Resolver
  • func (r *Resolver) LookupNetIP(ctx context.Context, network, host string) ([]netip.Addr, error)
• type Rule
  • func ParseRule(s string) (Rule, error)
  • func (r Rule) String() string
• type Rules
  • func ParseRules(values []string) (Rules, error)
  • func (r *Rules) Set(value string) error
  • func (r Rules) String() string

Constants

const ConnectTimeout = 30 * time.Second

const Errno = "EACCES"

Variables

var ErrDenied = errors.New("denied by policy")

Functions

func ResolveEndpoints

func ResolveEndpoints(ctx context.Context, hostports []string, hosts *Hosts) ([]netip.AddrPort, error)

Types

type DebugPorts

type DebugPorts struct {
	Found   []uint16
	Given   []uint16
	Exposed []uint16
}

type Dialer

type Dialer struct {
	Policy *Policy
	Base   net.Dialer
	Hosts  *Hosts
}

func NewDialer

func NewDialer(p *Policy) *Dialer

func (*Dialer) Control

func (d *Dialer) Control(network, address string, _ syscall.RawConn) error

func (*Dialer) Dial

func (d *Dialer) Dial(network, address string) (net.Conn, error)

func (*Dialer) DialContext

func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)

type Error

type Error struct {
	Addr    netip.AddrPort
	Checked netip.Addr
	Rule    string
	Reason  string
}

func (*Error) Errno

func (e *Error) Errno() string

func (*Error) Error

func (e *Error) Error() string

func (*Error) Is

func (e *Error) Is(target error) bool

type Hosts

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

func LoadHosts

func LoadHosts(path string) (*Hosts, error)

func ParseHosts

func ParseHosts(r io.Reader) (*Hosts, error)

func (*Hosts) Lookup

func (h *Hosts) Lookup(network, name string) ([]netip.Addr, bool)

type Policy

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

func Local

func Local(protectedPorts ...uint16) *Policy

func New

func New() *Policy

func Remote

func Remote(protectedPorts ...uint16) *Policy

func (*Policy) AddProtectedEndpoints

func (p *Policy) AddProtectedEndpoints(id string, addrs []netip.AddrPort)

func (*Policy) Allow

func (p *Policy) Allow() []string

func (*Policy) AllowsAny

func (p *Policy) AllowsAny(addr netip.Addr) bool

func (*Policy) Check

func (p *Policy) Check(addr netip.Addr, port uint16) error

func (*Policy) CheckDatagram

func (p *Policy) CheckDatagram(addr netip.Addr, port uint16) error

func (*Policy) Deny

func (p *Policy) Deny() []string

func (*Policy) Exposed

func (p *Policy) Exposed() []uint16

func (*Policy) Filter

func (p *Policy) Filter(addrs []netip.Addr) []netip.Addr

func (*Policy) Guard

func (p *Policy) Guard(d DebugPorts) *Policy

func (*Policy) GuardPort

func (p *Policy) GuardPort(port uint16) bool

func (*Policy) Live

func (p *Policy) Live(scan func() []uint16, found func(uint16))

func (*Policy) ProtectBrowser

func (p *Policy) ProtectBrowser(ctx context.Context, id string, hostports []string, hosts *Hosts) error

func (*Policy) ProtectEndpoints

func (p *Policy) ProtectEndpoints(id string, addrs []netip.AddrPort)

func (*Policy) ProtectedEndpoints

func (p *Policy) ProtectedEndpoints(id string) []netip.AddrPort

func (*Policy) RefreshBrowser

func (p *Policy) RefreshBrowser(ctx context.Context, id string, hostports []string, hosts *Hosts) error

func (*Policy) Summary

func (p *Policy) Summary() string

func (*Policy) With

func (p *Policy) With(allow, deny []Rule) *Policy

type Ports

type Ports []uint16

func (*Ports) Set

func (s *Ports) Set(v string) error

func (*Ports) String

func (s *Ports) String() string

type Resolver

type Resolver struct {
	Policy *Policy
	Base   *net.Resolver
	Hosts  *Hosts
}

func NewResolver

func NewResolver(p *Policy) *Resolver

func (*Resolver) LookupNetIP

func (r *Resolver) LookupNetIP(ctx context.Context, network, host string) ([]netip.Addr, error)

type Rule

type Rule struct {
	Prefix netip.Prefix
	Port   uint16
}

func ParseRule

func ParseRule(s string) (Rule, error)

func (Rule) String

func (r Rule) String() string

type Rules

type Rules []Rule

func ParseRules

func ParseRules(values []string) (Rules, error)

func (*Rules) Set

func (r *Rules) Set(value string) error

func (Rules) String

func (r Rules) String() string