ipaddr

Documentation

Overview

Package ipaddr implements IP allowlist check.

Index

• type Allowlist
  • func NewAllowlist(wl []*protocol.AuthIPWhitelist, as []*protocol.AuthIPWhitelistAssignment) (Allowlist, error)
  • func (l Allowlist) GetAllowlistForIdentity(ident identity.Identity) string
  • func (l Allowlist) IsAllowedIP(ip net.IP, allowlist string) bool

Types

type Allowlist

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

Allowlist holds all named IP allowlist and the allowlist assignment map.

func NewAllowlist

func NewAllowlist(wl []*protocol.AuthIPWhitelist, as []*protocol.AuthIPWhitelistAssignment) (Allowlist, error)

NewAllowlist creates new populated IP allowlist set.

func (Allowlist) GetAllowlistForIdentity

func (l Allowlist) GetAllowlistForIdentity(ident identity.Identity) string

GetAllowlistForIdentity returns name of the IP allowlist to use to check IP of requests from given `ident`.

Returns an empty string if the identity is not IP-restricted.

func (Allowlist) IsAllowedIP

func (l Allowlist) IsAllowedIP(ip net.IP, allowlist string) bool

IsAllowedIP returns true if IP address belongs to given named IP allowlist.