dhcp

README

dhcp

DHCP library and CLI server with multiple backends. All IP addresses are served as DHCP reservations. There are no leases.

Backends

• Tink gRPC server
  • This backend is the main use case. It pulls hardware data from the Tink gRPC API for use in serving DHCP clients.
• Tink Kubernetes CRDs
  • This backend is also the main use case. It pulls hardware data from Kubernetes CRDs for use in serving DHCP clients.
• File based
  • This backend is for mainly for testing and development. It reads a file for hardware data to use in serving DHCP clients. See example.yaml for the data model.
• Cacher server
  • This backend is mainly for backward compatibility in Boots. It pulls hardware data from the Cacher API for use in serving DHCP clients. It is planned for deprecation in Boots.

Definitions

DHCP Reservation: A fixed IP address that is reserved for a specific client.

DHCP Lease: An IP address, that can potentially change, that is assigned to a client by the DHCP server. The IP is typically pulled from a pool or subnet of available IP addresses.

Documentation

Overview

Package dhcp providers UDP listening and serving functionality.

Index

• Variables
• func Serve(ctx context.Context, c net.PacketConn, h ...Handler) error
• type Handler
• type Listener
  • func (l *Listener) Handler(conn net.PacketConn, peer net.Addr, pkt *dhcpv4.DHCPv4)
  • func (l *Listener) ListenAndServe(ctx context.Context, h ...Handler) error
  • func (l *Listener) Serve(ctx context.Context, c net.PacketConn) error
  • func (l *Listener) Shutdown() error

Variables

var ErrNoConn = &noConnError{}

ErrNoConn is an error im still not sure i want to use.

Functions

func Serve

func Serve(ctx context.Context, c net.PacketConn, h ...Handler) error

Serve will listen for DHCP messages on the given net.PacketConn and call the handler for each.

Types

type Handler

type Handler interface {
	// Handle is used for how to respond to DHCP messages.
	Handle(net.PacketConn, net.Addr, *dhcpv4.DHCPv4)
}

Handler is the interface is responsible for responding to DHCP messages.

type Listener

type Listener struct {
	Addr netip.AddrPort
	// contains filtered or unexported fields
}

Listener is a DHCPv4 server.

func (*Listener) Handler

func (l *Listener) Handler(conn net.PacketConn, peer net.Addr, pkt *dhcpv4.DHCPv4)

Handler is the main handler passed to the server4 function. Internally it allows for multiple handlers to be defined. Each handler in l.handlers then executed for every received packet.

func (*Listener) ListenAndServe

func (l *Listener) ListenAndServe(ctx context.Context, h ...Handler) error

ListenAndServe will listen for DHCP messages and call the given handler for each.

func (*Listener) Serve

func (l *Listener) Serve(ctx context.Context, c net.PacketConn) error

Serve will listen for DHCP messages on the given net.PacketConn and call the handler in *Listener for each. If no handler is specified, a Noop handler will be used.

func (*Listener) Shutdown

func (l *Listener) Shutdown() error

Shutdown closes the listener.