aghnet

package
v0.107.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 21, 2021 License: GPL-3.0 Imports: 36 Imported by: 0

Documentation

Overview

Package aghnet contains some utilities for networking.

Index

Constants

View Source 
const ErrNoHostsPaths errors.Error = "no valid paths to hosts files provided"

ErrNoHostsPaths is returned when there are no valid paths to watch passed to the HostsContainer.

View Source 
const ErrNoStaticIPInfo errors.Error = "no information about static ip"

ErrNoStaticIPInfo is returned by IfaceHasStaticIP when no information about the IP being static is available.

Variables

This section is empty.

Functions

func BroadcastFromIPNet added in v0.107.0 

func BroadcastFromIPNet(n *net.IPNet) (dc net.IP)

BroadcastFromIPNet calculates the broadcast IP address for n.

func CanBindPort 

func CanBindPort(port int) (can bool, err error)

CanBindPort checks if we can bind to the given port.

func CanBindPrivilegedPorts added in v0.107.0 

func CanBindPrivilegedPorts() (can bool, err error)

CanBindPrivilegedPorts checks if current process can bind to privileged ports.

func CheckOtherDHCP added in v0.107.0 

func CheckOtherDHCP(ifaceName string) (ok4, ok6 bool, err4, err6 error)

CheckOtherDHCP tries to discover another DHCP server in the network.

func CheckPort added in v0.107.0 

func CheckPort(network string, ip net.IP, port int) (err error)

CheckPort checks if the port is available for binding.

func CollectAllIfacesAddrs 

func CollectAllIfacesAddrs() (addrs []string, err error)

CollectAllIfacesAddrs returns the slice of all network interfaces IP addresses without port number.

func DefaultHostsPaths added in v0.107.0 

func DefaultHostsPaths() (paths []string)

DefaultHostsPaths returns the slice of paths default for the operating system to files and directories which are containing the hosts database. The result is intended to be used within fs.FS so the initial slash is omitted.

func GatewayIP 

func GatewayIP(ifaceName string) net.IP

GatewayIP returns IP address of interface's gateway.

func GenerateHostname 

func GenerateHostname(ip net.IP) (hostname string)

GenerateHostname generates the hostname from ip. In case of using IPv4 the result should be like: 

192-168-10-1

In case of using IPv6, the result is like: 

ff80-f076-0000-0000-0000-0000-0000-0010

func GetInterfaceByIP 

func GetInterfaceByIP(ip net.IP) string

GetInterfaceByIP returns the name of interface containing provided ip.

func GetSubnet 

func GetSubnet(ifaceName string) *net.IPNet

GetSubnet returns pointer to net.IPNet for the specified interface or nil if the search fails.

func IfaceDNSIPAddrs added in v0.107.0 

func IfaceDNSIPAddrs(
	iface NetIface,
	ipv IPVersion,
	maxAttempts int,
	backoff time.Duration,
) (addrs []net.IP, err error)

IfaceDNSIPAddrs returns IP addresses of the interface suitable to send to clients as DNS addresses. If err is nil, addrs contains either no addresses or at least two.

It makes up to maxAttempts attempts to get the addresses if there are none, each time using the provided backoff. Sometimes an interface needs a few seconds to really ititialize.

See https://github.com/AdguardTeam/AdGuardHome/issues/2304.

func IfaceHasStaticIP 

func IfaceHasStaticIP(ifaceName string) (has bool, err error)

IfaceHasStaticIP checks if interface is configured to have static IP address. If it can't give a definitive answer, it returns false and an error for which errors.Is(err, ErrNoStaticIPInfo) is true.

func IfaceIPAddrs added in v0.107.0 

func IfaceIPAddrs(iface NetIface, ipv IPVersion) (ips []net.IP, err error)

IfaceIPAddrs returns the interface's IP addresses.

func IfaceSetStaticIP 

func IfaceSetStaticIP(ifaceName string) (err error)

IfaceSetStaticIP sets static IP address for network interface.

func IsAddrInUse added in v0.107.0 

func IsAddrInUse(err error) (ok bool)

IsAddrInUse checks if err is about unsuccessful address binding.

func SplitHost 

func SplitHost(hostport string) (host string, err error)

SplitHost is a wrapper for net.SplitHostPort for the cases when the hostport does not necessarily contain a port.

Types

type HostGenFunc 

type HostGenFunc func() (host string)

HostGenFunc is the signature for functions generating fake hostnames. The implementation must be safe for concurrent use.

type HostsContainer added in v0.107.0 

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

HostsContainer stores the relevant hosts database provided by the OS and processes both A/AAAA and PTR DNS requests for those.

func NewHostsContainer added in v0.107.0 

func NewHostsContainer(
	listID int,
	fsys fs.FS,
	w aghos.FSWatcher,
	paths ...string,
) (hc *HostsContainer, err error)

NewHostsContainer creates a container of hosts, that watches the paths with w. listID is used as an identifier of the underlying rules list. paths shouldn't be empty and each of paths should locate either a file or a directory in fsys. fsys and w must be non-nil.

func (*HostsContainer) Close added in v0.107.0 

func (hc *HostsContainer) Close() (err error)

Close implements the io.Closer interface for *HostsContainer. Close must only be called once. The returned err is always nil.

func (*HostsContainer) MatchRequest added in v0.107.0 

func (rm *HostsContainer) MatchRequest(
	req urlfilter.DNSRequest,
) (res *urlfilter.DNSResult, ok bool)

MatchRequest processes the request rewriting hostnames and addresses read from the operating system's hosts files.

res is nil for any request having not an A/AAAA or PTR type. Results containing CNAME information may be queried again with the same question type and the returned CNAME for Host field of request. Results are guaranteed to be direct, i.e. any returned CNAME resolves into actual address like an alias in hosts does, see man hosts (5).

It's safe for concurrent use.

func (*HostsContainer) Translate added in v0.107.0 

func (rm *HostsContainer) Translate(rule string) (hostRule string)

Translate returns the source hosts-syntax rule for the generated dnsrewrite rule or an empty string if the last doesn't exist.

func (*HostsContainer) Upd added in v0.107.0 

func (hc *HostsContainer) Upd() (updates <-chan *netutil.IPMap)

Upd returns the channel into which the updates are sent. The receivable map's values are guaranteed to be of type of *stringutil.Set.

type IPMut added in v0.107.0 

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

IPMut is a type-safe wrapper of atomic.Value to store the IPMutFunc.

func NewIPMut added in v0.107.0 

func NewIPMut(f IPMutFunc) (m *IPMut)

NewIPMut returns the new properly initialized *IPMut. The m is guaranteed to always store non-nil IPMutFunc which is safe to call.

func (*IPMut) Load added in v0.107.0 

func (m *IPMut) Load() (f IPMutFunc)

Load returns the previously stored IPMutFunc.

func (*IPMut) Store added in v0.107.0 

func (m *IPMut) Store(f IPMutFunc)

Store sets the IPMutFunc to return from Func. It's safe for concurrent use. If f is nil, the stored function is the no-op one.

type IPMutFunc added in v0.107.0 

type IPMutFunc func(ip net.IP)

IPMutFunc is the signature of a function which modifies the IP address instance. It should be safe for concurrent use.

type IPVersion added in v0.107.0 

type IPVersion = int

IPVersion is a documentational alias for int. Use it when the integer means IP version. 

const (
	IPVersion4 IPVersion = 4
	IPVersion6 IPVersion = 6
)

IP version constants.

type IpsetManager added in v0.107.0 

type IpsetManager interface {
	Add(host string, ip4s, ip6s []net.IP) (n int, err error)
	Close() (err error)
}

IpsetManager is the ipset manager interface.

TODO(a.garipov): Perhaps generalize this into some kind of a NetFilter type, since ipset is exclusive to Linux?

func NewIpsetManager added in v0.107.0 

func NewIpsetManager(ipsetConf []string) (mgr IpsetManager, err error)

NewIpsetManager returns a new ipset. IPv4 addresses are added to an ipset with an ipv4 family; IPv6 addresses, to an ipv6 ipset. ipset must exist.

The syntax of the ipsetConf is: 

DOMAIN[,DOMAIN].../IPSET_NAME[,IPSET_NAME]...

The error is of type *aghos.UnsupportedError if the OS is not supported.

type NetIface added in v0.107.0 

type NetIface interface {
	Addrs() ([]net.Addr, error)
}

NetIface is the interface for network interface methods.

type NetInterface 

type NetInterface struct {
	// Addresses are the network interface addresses.
	Addresses []net.IP `json:"ip_addresses,omitempty"`
	// Subnets are the IP networks for this network interface.
	Subnets      []*net.IPNet     `json:"-"`
	Name         string           `json:"name"`
	HardwareAddr net.HardwareAddr `json:"hardware_address"`
	Flags        net.Flags        `json:"flags"`
	MTU          int              `json:"mtu"`
}

NetInterface represents an entry of network interfaces map.

func GetValidNetInterfacesForWeb 

func GetValidNetInterfacesForWeb() ([]*NetInterface, error)

GetValidNetInterfacesForWeb returns interfaces that are eligible for DNS and WEB only we do not return link-local addresses here

func (NetInterface) MarshalJSON 

func (iface NetInterface) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for NetInterface.

type SubnetDetector 

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

SubnetDetector describes IP address properties.

func NewSubnetDetector 

func NewSubnetDetector() (snd *SubnetDetector, err error)

NewSubnetDetector returns a new IP detector.

func (*SubnetDetector) IsLocallyServedNetwork 

func (snd *SubnetDetector) IsLocallyServedNetwork(ip net.IP) (is bool)

IsLocallyServedNetwork returns true if IP address is contained by any of locally-served IP address registries. It's safe for concurrent use.

func (*SubnetDetector) IsSpecialNetwork 

func (snd *SubnetDetector) IsSpecialNetwork(ip net.IP) (is bool)

IsSpecialNetwork returns true if IP address is contained by any of special-purpose IP address registries. It's safe for concurrent use.

type SystemResolvers 

type SystemResolvers interface {
	// Get returns the slice of local resolvers' addresses.  It should be
	// safe for concurrent use.
	Get() (rs []string)
	// contains filtered or unexported methods
}

SystemResolvers helps to work with local resolvers' addresses provided by OS.

func NewSystemResolvers 

func NewSystemResolvers(
	refreshIvl time.Duration,
	hostGenFunc HostGenFunc,
) (sr SystemResolvers, err error)

NewSystemResolvers returns a SystemResolvers with the cache refresh rate defined by refreshIvl. It disables auto-resfreshing if refreshIvl is 0. If nil is passed for hostGenFunc, the default generator will be used.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.