ipaddr

Documentation

Overview

Package ipaddr implements IP whitelist check.

Index

• type Whitelist
  • func NewWhitelist(wl []*protocol.AuthIPWhitelist, as []*protocol.AuthIPWhitelistAssignment) (Whitelist, error)
  • func (wl Whitelist) GetWhitelistForIdentity(ident identity.Identity) string
  • func (wl Whitelist) IsInWhitelist(ip net.IP, whitelist string) bool

Types

type Whitelist

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

Whitelist holds all named IP whitelists and the whitelist assignment map.

func NewWhitelist

func NewWhitelist(wl []*protocol.AuthIPWhitelist, as []*protocol.AuthIPWhitelistAssignment) (Whitelist, error)

NewWhitelist creates new populated IP whitelist.

func (Whitelist) GetWhitelistForIdentity

func (wl Whitelist) GetWhitelistForIdentity(ident identity.Identity) string

GetWhitelistForIdentity returns name of the IP whitelist to use to check IP of requests from given `ident`.

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

func (Whitelist) IsInWhitelist

func (wl Whitelist) IsInWhitelist(ip net.IP, whitelist string) bool

IsInWhitelist returns true if IP address belongs to given named IP whitelist.