141 lines
4.2 KiB
Go
141 lines
4.2 KiB
Go
// Package dhcpsvc contains the AdGuard Home DHCP service.
|
|
//
|
|
// TODO(e.burkov): Add tests.
|
|
package dhcpsvc
|
|
|
|
import (
|
|
"context"
|
|
"net"
|
|
"net/netip"
|
|
"time"
|
|
|
|
"github.com/AdguardTeam/AdGuardHome/internal/next/agh"
|
|
"golang.org/x/exp/slices"
|
|
)
|
|
|
|
// Lease is a DHCP lease.
|
|
//
|
|
// TODO(e.burkov): Consider moving it to [agh], since it also may be needed in
|
|
// [websvc].
|
|
type Lease struct {
|
|
// IP is the IP address leased to the client.
|
|
IP netip.Addr
|
|
|
|
// Expiry is the expiration time of the lease.
|
|
Expiry time.Time
|
|
|
|
// Hostname of the client.
|
|
Hostname string
|
|
|
|
// HWAddr is the physical hardware address (MAC address).
|
|
HWAddr net.HardwareAddr
|
|
|
|
// IsStatic defines if the lease is static.
|
|
IsStatic bool
|
|
}
|
|
|
|
// Clone returns a deep copy of l.
|
|
func (l *Lease) Clone() (clone *Lease) {
|
|
if l == nil {
|
|
return nil
|
|
}
|
|
|
|
return &Lease{
|
|
Expiry: l.Expiry,
|
|
Hostname: l.Hostname,
|
|
HWAddr: slices.Clone(l.HWAddr),
|
|
IP: l.IP,
|
|
IsStatic: l.IsStatic,
|
|
}
|
|
}
|
|
|
|
type Interface interface {
|
|
agh.ServiceWithConfig[*Config]
|
|
|
|
// Enabled returns true if DHCP provides information about clients.
|
|
Enabled() (ok bool)
|
|
|
|
// HostByIP returns the hostname of the DHCP client with the given IP
|
|
// address. The address will be netip.Addr{} if there is no such client,
|
|
// due to an assumption that a DHCP client must always have an IP address.
|
|
HostByIP(ip netip.Addr) (host string)
|
|
|
|
// MACByIP returns the MAC address for the given IP address leased. It
|
|
// returns nil if there is no such client, due to an assumption that a DHCP
|
|
// client must always have a MAC address.
|
|
MACByIP(ip netip.Addr) (mac net.HardwareAddr)
|
|
|
|
// IPByHost returns the IP address of the DHCP client with the given
|
|
// hostname. The hostname will be an empty string if there is no such
|
|
// client, due to an assumption that a DHCP client must always have a
|
|
// hostname, either set or generated.
|
|
IPByHost(host string) (ip netip.Addr)
|
|
|
|
// Leases returns all the active DHCP leases.
|
|
//
|
|
// TODO(e.burkov): Consider implementing iterating methods with appropriate
|
|
// signatures instead of cloning the whole list.
|
|
Leases() (ls []*Lease)
|
|
|
|
// AddLease adds a new DHCP lease. It returns an error if the lease is
|
|
// invalid or already exists.
|
|
AddLease(l *Lease) (err error)
|
|
|
|
// UpdateStaticLease changes an existing DHCP lease. It returns an error if
|
|
// there is no lease with such hardware addressor if new values are invalid
|
|
// or already exist.
|
|
UpdateStaticLease(l *Lease) (err error)
|
|
|
|
// RemoveLease removes an existing DHCP lease. It returns an error if there
|
|
// is no lease equal to l.
|
|
RemoveLease(l *Lease) (err error)
|
|
|
|
// Reset removes all the DHCP leases.
|
|
Reset() (err error)
|
|
}
|
|
|
|
// Empty is an [Interface] implementation that does nothing.
|
|
type Empty struct{}
|
|
|
|
// type check
|
|
var _ agh.ServiceWithConfig[*Config] = Empty{}
|
|
|
|
// Start implements the [Service] interface for Empty.
|
|
func (Empty) Start() (err error) { return nil }
|
|
|
|
// Shutdown implements the [Service] interface for Empty.
|
|
func (Empty) Shutdown(_ context.Context) (err error) { return nil }
|
|
|
|
// Config implements the [ServiceWithConfig] interface for Empty.
|
|
func (Empty) Config() (conf *Config) { return nil }
|
|
|
|
// type check
|
|
var _ Interface = Empty{}
|
|
|
|
// Enabled implements the [Interface] interface for Empty.
|
|
func (Empty) Enabled() (ok bool) { return false }
|
|
|
|
// HostByIP implements the [Interface] interface for Empty.
|
|
func (Empty) HostByIP(_ netip.Addr) (host string) { return "" }
|
|
|
|
// MACByIP implements the [Interface] interface for Empty.
|
|
func (Empty) MACByIP(_ netip.Addr) (mac net.HardwareAddr) { return nil }
|
|
|
|
// IPByHost implements the [Interface] interface for Empty.
|
|
func (Empty) IPByHost(_ string) (ip netip.Addr) { return netip.Addr{} }
|
|
|
|
// Leases implements the [Interface] interface for Empty.
|
|
func (Empty) Leases() (leases []*Lease) { return nil }
|
|
|
|
// AddLease implements the [Interface] interface for Empty.
|
|
func (Empty) AddLease(_ *Lease) (err error) { return nil }
|
|
|
|
// UpdateStaticLease implements the [Interface] interface for Empty.
|
|
func (Empty) UpdateStaticLease(_ *Lease) (err error) { return nil }
|
|
|
|
// RemoveLease implements the [Interface] interface for Empty.
|
|
func (Empty) RemoveLease(_ *Lease) (err error) { return nil }
|
|
|
|
// Reset implements the [Interface] interface for Empty.
|
|
func (Empty) Reset() (err error) { return nil }
|