f-46: dhcp: add the dhcp binary, its unit and its wrapper #46

cmd/dhcp reçoit quatre paramètres en clair — interface, state, socket, conf —
sur le modèle de dnsmasq. Il ne compose aucun chemin, ne découpe aucun nom
composite et ignore le netns dans lequel il tourne : seul le wrapper en a besoin,
pour y entrer.

La boucle de lecture UDP est écrite à la main plutôt que confiée à
server4.Serve, qui lance une goroutine par datagramme sans borne et ne pose
aucun recover. Elle traite en ligne, réutilise un tampon de 1500 octets et pose
un recover par datagramme. NewIPv4UDPConn est conservé pour le SO_BROADCAST et
le bind à l'interface. Une réponse destinée à un client sans adresse part en
broadcast.

dhcp.run_dir n'est pas une clé de configuration : le wrapper code /run/two/dhcp
en dur et le Go utilise dhcpapi.DefaultRunDir, comme dhcp.DefaultConfDir pour
dnsmasq. Un test lit le script et vérifie que les deux s'accordent.

Le défaut dhcp.backend reste dnsmasq : un agent.yml de 0.1.0 se comporte comme
avant. deploy.sh et le pipeline publient le binaire, l'unit et le script.

La boucle est testée sur une vraie socket UDP en loopback. Neuf mutations, dont
une qui a révélé que le recover n'était couvert par rien.

Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>

internal/api/dhcp/paths.go

@@ -0,0 +1,29 @@
+package dhcpapi
+
+import (
+	"path/filepath"
+)
+
+const (
+	DefaultRunDir = "/run/two/dhcp"
+	SocketExt     = ".sock"
+	StateExt      = ".state"
+	UnitExt       = ".service"
+	UnitName      = "dhcp@"
+)
+
+func Instance(vpc, bridge string) string {
+	return vpc + "_" + bridge
+}
+
+func Unit(instance string) string {
+	return UnitName + instance + UnitExt
+}
+
+func SocketPath(runDir, instance string) string {
+	return filepath.Join(runDir, instance+SocketExt)
+}
+
+func StatePath(runDir, instance string) string {
+	return filepath.Join(runDir, instance+StateExt)
+}

internal/api/dhcp/paths_test.go

@@ -0,0 +1,69 @@
+package dhcpapi
+
+import (
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestInstance_JoinsVPCAndBridge(t *testing.T) {
+	if got := Instance("vp-admin", "br-000001"); got != "vp-admin_br-000001" {
+		t.Errorf("Instance = %s, want vp-admin_br-000001", got)
+	}
+}
+
+func TestUnit_NamesTheTemplatedService(t *testing.T) {
+	if got := Unit(Instance("vp-admin", "br-000001")); got != "dhcp@vp-admin_br-000001.service" {
+		t.Errorf("Unit = %s", got)
+	}
+}
+
+func TestSocketPath_SitsUnderTheRunDir(t *testing.T) {
+	got := SocketPath(DefaultRunDir, Instance("vp-admin", "br-000001"))
+	if got != "/run/two/dhcp/vp-admin_br-000001.sock" {
+		t.Errorf("SocketPath = %s", got)
+	}
+}
+
+func TestStatePath_SitsUnderTheRunDir(t *testing.T) {
+	got := StatePath(DefaultRunDir, Instance("vp-admin", "br-000001"))
+	if got != "/run/two/dhcp/vp-admin_br-000001.state" {
+		t.Errorf("StatePath = %s", got)
+	}
+}
+
+func TestPaths_NameTheVPCSoAListingIsReadable(t *testing.T) {
+	got := SocketPath(DefaultRunDir, Instance("vp-admin", "br-000001"))
+	if !strings.Contains(got, "vp-admin") {
+		t.Errorf("path = %s, want the vpc visible when listing the run dir", got)
+	}
+}
+
+func TestPaths_DistinguishTwoSubnetsOfTheSameVPC(t *testing.T) {
+	a := SocketPath(DefaultRunDir, Instance("vp-admin", "br-000001"))
+	b := SocketPath(DefaultRunDir, Instance("vp-admin", "br-000002"))
+	if a == b {
+		t.Error("two subnets must not share a control socket")
+	}
+}
+
+func TestSocketPath_StaysUnderTheUnixPathLimit(t *testing.T) {
+	got := SocketPath(DefaultRunDir, Instance("vp-000000", "br-000000"))
+	if len(got) > 100 {
+		t.Errorf("socket path is %d bytes (%s): sun_path caps at 104 on darwin and 108 on linux", len(got), got)
+	}
+}
+
+func TestDefaultRunDir_MatchesTheWrapperScript(t *testing.T) {
+	const script = "../../../scripts/run-dhcp-in-netns.sh"
+
+	raw, err := os.ReadFile(script)
+	if err != nil {
+		t.Fatalf("read %s: %v", script, err)
+	}
+
+	want := `RUN_DIR="` + DefaultRunDir + `"`
+	if !strings.Contains(string(raw), want) {
+		t.Errorf("%s does not set %s: the agent would talk to a socket the server never creates", script, want)
+	}
+}

internal/config/agent/dhcp.go

@@ -0,0 +1,17 @@
+package configuration
+
+import "fmt"
+
+const (
+	BackendDnsmasq = "dnsmasq"
+	BackendTwo     = "two"
+)
+
+func ValidBackend(backend string) error {
+	switch backend {
+	case BackendDnsmasq, BackendTwo:
+		return nil
+	default:
+		return fmt.Errorf("unknown dhcp backend %q: expected %q or %q", backend, BackendDnsmasq, BackendTwo)
+	}
+}

internal/config/agent/dhcp_test.go

@@ -0,0 +1,56 @@
+package configuration
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+func writeConfig(t *testing.T, body string) string {
+	t.Helper()
+	path := filepath.Join(t.TempDir(), "agent.yml")
+	if err := os.WriteFile(path, []byte(body), 0o600); err != nil {
+		t.Fatalf("WriteFile: %v", err)
+	}
+	return path
+}
+
+func TestValidBackend_AcceptsTheTwoKnownBackends(t *testing.T) {
+	for _, backend := range []string{BackendDnsmasq, BackendTwo} {
+		if err := ValidBackend(backend); err != nil {
+			t.Errorf("ValidBackend(%q) = %v, want nil", backend, err)
+		}
+	}
+}
+
+func TestValidBackend_RejectsAnythingElse(t *testing.T) {
+	for _, backend := range []string{"", "dhcpd", "DNSMASQ", "two "} {
+		if err := ValidBackend(backend); err == nil {
+			t.Errorf("ValidBackend(%q) = nil, want an error", backend)
+		}
+	}
+}
+
+func TestLoadConfig_DefaultsToDnsmasq(t *testing.T) {
+	path := writeConfig(t, "database:\n  path: /tmp/two\n")
+
+	cfg, err := LoadConfig(path)
+	if err != nil {
+		t.Fatalf("LoadConfig: %v", err)
+	}
+	if cfg.DHCP.Backend != BackendDnsmasq {
+		t.Errorf("backend = %q, want %q: a 0.1.0 config must keep behaving as before", cfg.DHCP.Backend, BackendDnsmasq)
+	}
+}
+
+func TestLoadConfig_ReadsTheTwoBackend(t *testing.T) {
+	path := writeConfig(t, "dhcp:\n  backend: two\n")
+
+	cfg, err := LoadConfig(path)
+	if err != nil {
+		t.Fatalf("LoadConfig: %v", err)
+	}
+	if cfg.DHCP.Backend != BackendTwo {
+		t.Errorf("backend = %q, want two", cfg.DHCP.Backend)
+	}
+}

internal/config/agent/struct.go

@@ -31,6 +31,9 @@ type Config struct {
 	Metadata struct {
 		RunDir string `mapstructure:"run_dir"`
 	} `mapstructure:"metadata"`
+	DHCP struct {
+		Backend string `mapstructure:"backend"`
+	} `mapstructure:"dhcp"`
 	Admin struct {
 		Enabled bool   `mapstructure:"enabled"`
 		Address string `mapstructure:"address"`
@@ -67,6 +70,7 @@ func LoadConfig(path string) (*Config, error) {
 	v.SetDefault("dispatcher.timeout_seconds", 300)
 	v.SetDefault("dispatcher.poll_seconds", 2)
 	v.SetDefault("metadata.run_dir", "/run/two/metadata")
+	v.SetDefault("dhcp.backend", BackendDnsmasq)
 	v.SetDefault("qemu.ovmf_code_path", "/usr/share/OVMF/OVMF_CODE.fd")
 	v.SetDefault("qemu.ovmf_vars_template", "/usr/share/OVMF/OVMF_VARS.fd")
 	v.SetDefault("qemu.uefi_vars_dir", "/run/two/vms/uefi")

internal/dhcpd/listener.go

@@ -0,0 +1,68 @@
+package dhcpd
+
+import (
+	"log/slog"
+	"net"
+
+	"github.com/insomniacslk/dhcp/dhcpv4"
+)
+
+const MaxDatagramBytes = 1500
+
+var clientBroadcast = net.IPv4bcast
+
+func replyTo(peer net.Addr) net.Addr {
+	udp, ok := peer.(*net.UDPAddr)
+	if !ok {
+		return peer
+	}
+	if udp.IP == nil || udp.IP.IsUnspecified() {
+		return &net.UDPAddr{IP: clientBroadcast, Port: udp.Port}
+	}
+	return udp
+}
+
+func (s *Store) serveDatagram(conn net.PacketConn, raw []byte, peer net.Addr, logger *slog.Logger) {
+	defer func() {
+		if r := recover(); r != nil {
+			logger.Error("dhcp datagram handling panicked", "peer", peer, "panic", r)
+		}
+	}()
+
+	req, err := dhcpv4.FromBytes(raw)
+	if err != nil {
+		logger.Debug("malformed dhcp datagram", "peer", peer, "error", err)
+		return
+	}
+
+	reply, err := s.Handle(req)
+	if err != nil {
+		logger.Error("building dhcp reply failed",
+			"peer", peer, "mac", req.ClientHWAddr, "type", req.MessageType(), "error", err)
+		return
+	}
+	if reply == nil {
+		logger.Debug("no reply for datagram", "mac", req.ClientHWAddr, "type", req.MessageType())
+		return
+	}
+
+	target := replyTo(peer)
+	if _, err := conn.WriteTo(reply.ToBytes(), target); err != nil {
+		logger.Error("sending dhcp reply failed", "target", target, "mac", req.ClientHWAddr, "error", err)
+		return
+	}
+	logger.Info("dhcp reply sent",
+		"mac", req.ClientHWAddr, "type", reply.MessageType(), "ip", reply.YourIPAddr, "target", target)
+}
+
+func (s *Store) Serve(conn net.PacketConn, logger *slog.Logger) error {
+	buf := make([]byte, MaxDatagramBytes)
+
+	for {
+		n, peer, err := conn.ReadFrom(buf)
+		if err != nil {
+			return err
+		}
+		s.serveDatagram(conn, buf[:n], peer, logger)
+	}
+}

internal/dhcpd/listener_test.go

@@ -0,0 +1,206 @@
+package dhcpd
+
+import (
+	"io"
+	"log/slog"
+	"net"
+	"sync"
+	"testing"
+	"time"
+
+	"github.com/insomniacslk/dhcp/dhcpv4"
+)
+
+func discard() *slog.Logger {
+	return slog.New(slog.NewTextHandler(io.Discard, nil))
+}
+
+func loopbackPair(t *testing.T) (*net.UDPConn, *net.UDPConn) {
+	t.Helper()
+
+	server, err := net.ListenUDP("udp4", &net.UDPAddr{IP: net.IPv4(127, 0, 0, 1)})
+	if err != nil {
+		t.Fatalf("ListenUDP server: %v", err)
+	}
+	t.Cleanup(func() { server.Close() })
+
+	client, err := net.ListenUDP("udp4", &net.UDPAddr{IP: net.IPv4(127, 0, 0, 1)})
+	if err != nil {
+		t.Fatalf("ListenUDP client: %v", err)
+	}
+	t.Cleanup(func() { client.Close() })
+
+	return server, client
+}
+
+func exchange(t *testing.T, s *Store, raw []byte) *dhcpv4.DHCPv4 {
+	t.Helper()
+
+	server, client := loopbackPair(t)
+	go s.Serve(server, discard())
+
+	if _, err := client.WriteToUDP(raw, server.LocalAddr().(*net.UDPAddr)); err != nil {
+		t.Fatalf("WriteToUDP: %v", err)
+	}
+
+	if err := client.SetReadDeadline(time.Now().Add(500 * time.Millisecond)); err != nil {
+		t.Fatalf("SetReadDeadline: %v", err)
+	}
+	buf := make([]byte, MaxDatagramBytes)
+	n, _, err := client.ReadFromUDP(buf)
+	if err != nil {
+		return nil
+	}
+
+	reply, err := dhcpv4.FromBytes(buf[:n])
+	if err != nil {
+		t.Fatalf("the reply must be a valid dhcp packet: %v", err)
+	}
+	return reply
+}
+
+func TestServe_AnswersAKnownMAC(t *testing.T) {
+	s := configuredStore(t)
+
+	reply := exchange(t, s, request(t, dhcpv4.MessageTypeDiscover, mac(t, "00:22:33:00:00:0a")).ToBytes())
+	if reply == nil {
+		t.Fatal("a known mac must be answered on the wire")
+	}
+	if reply.MessageType() != dhcpv4.MessageTypeOffer {
+		t.Errorf("message type = %s, want OFFER", reply.MessageType())
+	}
+	if !reply.YourIPAddr.Equal(net.ParseIP("10.0.5.10")) {
+		t.Errorf("yiaddr = %s, want 10.0.5.10", reply.YourIPAddr)
+	}
+}
+
+func TestServe_StaysSilentForAnUnknownMAC(t *testing.T) {
+	s := configuredStore(t)
+
+	if reply := exchange(t, s, request(t, dhcpv4.MessageTypeDiscover, mac(t, "00:22:33:ff:ff:ff")).ToBytes()); reply != nil {
+		t.Errorf("an unknown mac must get nothing on the wire, got %s", reply.MessageType())
+	}
+}
+
+func TestServe_StaysSilentOnARelease(t *testing.T) {
+	s := configuredStore(t)
+
+	if reply := exchange(t, s, request(t, dhcpv4.MessageTypeRelease, mac(t, "00:22:33:00:00:0a")).ToBytes()); reply != nil {
+		t.Errorf("a RELEASE must get nothing on the wire, got %s", reply.MessageType())
+	}
+}
+
+func TestServe_SurvivesAMalformedDatagram(t *testing.T) {
+	s := configuredStore(t)
+	server, client := loopbackPair(t)
+	go s.Serve(server, discard())
+
+	target := server.LocalAddr().(*net.UDPAddr)
+	for _, garbage := range [][]byte{{}, {0x01}, make([]byte, 1200)} {
+		if _, err := client.WriteToUDP(garbage, target); err != nil {
+			t.Fatalf("WriteToUDP: %v", err)
+		}
+	}
+
+	if _, err := client.WriteToUDP(request(t, dhcpv4.MessageTypeDiscover, mac(t, "00:22:33:00:00:0a")).ToBytes(), target); err != nil {
+		t.Fatalf("WriteToUDP: %v", err)
+	}
+	if err := client.SetReadDeadline(time.Now().Add(time.Second)); err != nil {
+		t.Fatalf("SetReadDeadline: %v", err)
+	}
+	buf := make([]byte, MaxDatagramBytes)
+	if _, _, err := client.ReadFromUDP(buf); err != nil {
+		t.Fatalf("the loop must survive garbage and keep serving: %v", err)
+	}
+}
+
+func TestServe_ReturnsWhenTheConnectionCloses(t *testing.T) {
+	s := configuredStore(t)
+	server, _ := loopbackPair(t)
+
+	done := make(chan error, 1)
+	go func() { done <- s.Serve(server, discard()) }()
+
+	server.Close()
+	select {
+	case err := <-done:
+		if err == nil {
+			t.Error("Serve must report why it stopped")
+		}
+	case <-time.After(time.Second):
+		t.Fatal("Serve did not return after the connection closed")
+	}
+}
+
+type explodingConn struct {
+	net.PacketConn
+	mu     sync.Mutex
+	writes int
+}
+
+func (c *explodingConn) WriteTo(b []byte, addr net.Addr) (int, error) {
+	c.mu.Lock()
+	first := c.writes == 0
+	c.writes++
+	c.mu.Unlock()
+
+	if first {
+		panic("write exploded")
+	}
+	return c.PacketConn.WriteTo(b, addr)
+}
+
+func TestServe_SurvivesAPanicWhileHandlingADatagram(t *testing.T) {
+	s := configuredStore(t)
+	server, client := loopbackPair(t)
+	go s.Serve(&explodingConn{PacketConn: server}, discard())
+
+	target := server.LocalAddr().(*net.UDPAddr)
+	raw := request(t, dhcpv4.MessageTypeDiscover, mac(t, "00:22:33:00:00:0a")).ToBytes()
+
+	for range 2 {
+		if _, err := client.WriteToUDP(raw, target); err != nil {
+			t.Fatalf("WriteToUDP: %v", err)
+		}
+		time.Sleep(50 * time.Millisecond)
+	}
+
+	if err := client.SetReadDeadline(time.Now().Add(time.Second)); err != nil {
+		t.Fatalf("SetReadDeadline: %v", err)
+	}
+	buf := make([]byte, MaxDatagramBytes)
+	if _, _, err := client.ReadFromUDP(buf); err != nil {
+		t.Fatalf("a panic on one datagram must not kill the serving loop: %v", err)
+	}
+}
+
+func TestReplyTo_BroadcastsWhenTheClientHasNoAddress(t *testing.T) {
+	got := replyTo(&net.UDPAddr{IP: net.IPv4zero, Port: 68})
+
+	udp, ok := got.(*net.UDPAddr)
+	if !ok {
+		t.Fatalf("target = %T, want *net.UDPAddr", got)
+	}
+	if !udp.IP.Equal(net.IPv4bcast) {
+		t.Errorf("target = %s, want 255.255.255.255: the client cannot be reached by unicast yet", udp.IP)
+	}
+	if udp.Port != 68 {
+		t.Errorf("port = %d, want the client port to be kept", udp.Port)
+	}
+}
+
+func TestReplyTo_KeepsTheUnicastPeerWhenItHasAnAddress(t *testing.T) {
+	got := replyTo(&net.UDPAddr{IP: net.ParseIP("10.0.5.10"), Port: 68})
+
+	udp := got.(*net.UDPAddr)
+	if !udp.IP.Equal(net.ParseIP("10.0.5.10")) {
+		t.Errorf("target = %s, want the renewing client itself", udp.IP)
+	}
+}
+
+func TestReplyTo_BroadcastsWhenThePeerIPIsNil(t *testing.T) {
+	udp := replyTo(&net.UDPAddr{Port: 68}).(*net.UDPAddr)
+	if !udp.IP.Equal(net.IPv4bcast) {
+		t.Errorf("target = %s, want 255.255.255.255", udp.IP)
+	}
+}