add support for UEFI HTTP Boot

this closes tinkerbell#210

Signed-off-by: Rui Lopes <rgl@ruilopes.com>

.gitignore

@@ -6,7 +6,8 @@
 /cmd/boots/boots
 /cmd/boots/boots-*-*
 coverage.txt
-tftp/ipxe/
+ipxe/ipxe/*.efi
+ipxe/ipxe/*.kpxe
 !deploy/stack/.env
 .vagrant
 deploy/stack/state/webroot/misc/osie/current/*

dhcp/pxe.go

@@ -7,19 +7,20 @@ import (
 
 	dhcp4 "github.com/packethost/dhcp4-go"
 	"github.com/pkg/errors"
+	"github.com/tinkerbell/boots/ipxe"
 	"go.opentelemetry.io/otel/trace"
 )
 
 // from https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml
 var procArchTypes = []string{
-	"x86 BIOS",
+	"x86 BIOS", // #0 x86_64
 	"NEC/PC98 (DEPRECATED)",
 	"Itanium",
 	"DEC Alpha (DEPRECATED)",
 	"Arc x86 (DEPRECATED)",
 	"Intel Lean Client (DEPRECATED)",
 	"x86 UEFI",
-	"x64 UEFI",
+	"x64 UEFI", // #7 x86_64
 	"EFI Xscale (DEPRECATED)",
 	"EBC",
 	"ARM 32-bit UEFI",
@@ -28,10 +29,10 @@ var procArchTypes = []string{
 	"PowerPC ePAPR",
 	"POWER OPAL v3",
 	"x86 uefi boot from http",
-	"x64 uefi boot from http",
+	"x64 uefi boot from http", // #16 x86_64
 	"ebc boot from http",
 	"arm uefi 32 boot from http",
-	"arm uefi 64 boot from http",
+	"arm uefi 64 boot from http", // #19 aarch64
 	"pc/at bios boot from http",
 	"arm 32 uboot",
 	"arm 64 uboot",
@@ -59,9 +60,9 @@ func ProcessorArchType(req *dhcp4.Packet) string {
 func Arch(req *dhcp4.Packet) string {
 	arch := ProcessorArchType(req)
 	switch arch {
-	case "x86 BIOS", "x64 UEFI":
+	case "x86 BIOS", "x64 UEFI", "x64 uefi boot from http":
 		return "x86_64"
-	case "ARM 64-bit UEFI":
+	case "ARM 64-bit UEFI", "arm uefi 64 boot from http":
 		return "aarch64"
 	default:
 		return arch
@@ -83,14 +84,24 @@ func IsPXE(req *dhcp4.Packet) bool {
 	}
 	class, ok := req.GetString(dhcp4.OptionClassID)
 
-	return ok && strings.HasPrefix(class, "PXEClient")
+	return ok && (strings.HasPrefix(class, "PXEClient") || strings.HasPrefix(class, "HTTPClient"))
+}
+
+func IsHTTPClient(req *dhcp4.Packet) bool {
+	if ipxe.IsIPXE(req) {
+		return true
+	}
+
+	classID, ok := req.GetString(dhcp4.OptionClassID)
+
+	return ok && strings.HasPrefix(classID, "HTTPClient")
 }
 
 func SetupPXE(ctx context.Context, rep, req *dhcp4.Packet) bool {
+	if !IsPXE(req) {
+		return false // not a PXE client
+	}
 	if !copyGUID(rep, req) {
-		if class, ok := req.GetString(dhcp4.OptionClassID); !ok || !strings.HasPrefix(class, "PXEClient") {
-			return false // not a PXE client
-		}
 		dhcplog.With("mac", req.GetCHAddr(), "xid", req.GetXID()).Info("no client GUID provided")
 	}
 
@@ -123,18 +134,23 @@ func SetupPXE(ctx context.Context, rep, req *dhcp4.Packet) bool {
 	return true
 }
 
-func SetFilename(rep *dhcp4.Packet, filename string, nextServer net.IP, pxeClient bool) {
+func SetFilename(rep *dhcp4.Packet, filename string, nextServer net.IP, httpServerFQDN string, httpClient bool) {
+	rep.SetSIAddr(nextServer) // next-server: IP address of the TFTP Server.
+
+	if httpClient {
+		filename = "http://" + httpServerFQDN + "/" + filename
+		rep.SetString(dhcp4.OptionClassID, "HTTPClient")
+	} else {
+		rep.SetString(dhcp4.OptionClassID, "PXEClient")
+	}
+
 	file := rep.File()
 	if len(filename) > len(file) {
 		err := errors.New("filename too long, would be truncated")
 		// req CHaddr and XID == req's
 		dhcplog.With("mac", rep.GetCHAddr(), "xid", rep.GetXID(), "filename", filename).Fatal(err)
 	}
-	if pxeClient {
-		rep.SetString(dhcp4.OptionClassID, "PXEClient")
-	}
-	rep.SetSIAddr(nextServer) // next-server: IP address of the TFTP/HTTP Server.
-	copy(file, filename)      // filename: Executable (or iPXE script) to boot from.
+	copy(file, filename) // filename: Executable (or iPXE script) to boot from.
 }
 
 func copyGUID(rep, req *dhcp4.Packet) bool {

ipxe/dhcp_options.go

@@ -75,6 +75,7 @@ func IsPacketIPXE(req *dhcp4.Packet) bool {
 	// TODO: make this actually check for iPXE and use ipxe' build system's ability to set name.
 	// This way we could set to something like "Packet iPXE" and then just look for that in the identifier sent in dhcp.
 	// This also means we won't lose ipxe's version number for logging and such.
+	// see https://ipxe.org/appnote/userclass
 	if om := GetEncapsulatedOptions(req); om != nil {
 		if ov, ok := om.GetOption(OptionVersion); ok {
 			return ok && bytes.Equal(ov, packetVersion)

ipxe/files.go

@@ -0,0 +1,9 @@
+package ipxe
+
+import "embed"
+
+//go:embed ipxe/ipxe.efi
+//go:embed ipxe/snp-hua.efi
+//go:embed ipxe/snp-nolacp.efi
+//go:embed ipxe/undionly.kpxe
+var Files embed.FS

job/dhcp.go

@@ -86,7 +86,7 @@ func (j Job) configureDHCP(ctx context.Context, rep, req *dhcp4.Packet) bool {
 			ipxe.Setup(rep)
 		}
 
-		j.setPXEFilename(rep, isPacket, isARM, isUEFI)
+		j.setPXEFilename(rep, isPacket, isARM, isUEFI, dhcp.IsHTTPClient(req))
 	} else {
 		span.AddEvent("did not SetupPXE because packet is not a PXE request")
 	}
@@ -113,7 +113,7 @@ func (j Job) areWeProvisioner() bool {
 	return j.hardware.HardwareProvisioner() == j.ProvisionerEngineName()
 }
 
-func (j Job) setPXEFilename(rep *dhcp4.Packet, isPacket, isARM, isUEFI bool) {
+func (j Job) setPXEFilename(rep *dhcp4.Packet, isPacket, isARM, isUEFI, isHTTPClient bool) {
 	if j.HardwareState() == "in_use" {
 		if j.InstanceID() == "" {
 			j.Error(errors.New("setPXEFilename called on a job with no instance"))
@@ -139,16 +139,15 @@ func (j Job) setPXEFilename(rep *dhcp4.Packet, isPacket, isARM, isUEFI bool) {
 	}
 
 	var filename string
-	var pxeClient bool
 	if !isPacket {
 		if j.PArch() == "hua" || j.PArch() == "2a2" {
-			filename = "snp-hua.efi"
+			filename = "ipxe/snp-hua.efi"
 		} else if isARM {
-			filename = "snp-nolacp.efi"
+			filename = "ipxe/snp-nolacp.efi"
 		} else if isUEFI {
-			filename = "ipxe.efi"
+			filename = "ipxe/ipxe.efi"
 		} else {
-			filename = "undionly.kpxe"
+			filename = "ipxe/undionly.kpxe"
 		}
 	} else if !j.isPXEAllowed() {
 		// Always honor allow_pxe.
@@ -162,11 +161,10 @@ func (j Job) setPXEFilename(rep *dhcp4.Packet, isPacket, isARM, isUEFI bool) {
 
 		os := j.OperatingSystem()
 		j.With("instance.state", j.instance.State, "os_slug", os.Slug, "os_distro", os.Distro, "os_version", os.Version).Info()
-		pxeClient = true
 		filename = "/nonexistent"
 	} else {
-		pxeClient = true
-		filename = "http://" + conf.PublicFQDN + "/auto.ipxe"
+		isHTTPClient = true
+		filename = "auto.ipxe"
 	}
 
 	if filename == "" {
@@ -176,5 +174,5 @@ func (j Job) setPXEFilename(rep *dhcp4.Packet, isPacket, isARM, isUEFI bool) {
 		return
 	}
 
-	dhcp.SetFilename(rep, filename, conf.PublicIPv4, pxeClient)
+	dhcp.SetFilename(rep, filename, conf.PublicIPv4, conf.PublicFQDN, isHTTPClient)
 }

job/dhcp_test.go

@@ -15,17 +15,18 @@ func TestSetPXEFilename(t *testing.T) {
 	conf.PublicFQDN = "boots-testing.packet.net"
 
 	var setPXEFilenameTests = []struct {
-		name     string
-		hState   string
-		id       string
-		iState   string
-		slug     string
-		plan     string
-		allowPXE bool
-		packet   bool
-		arm      bool
-		uefi     bool
-		filename string
+		name       string
+		hState     string
+		id         string
+		iState     string
+		slug       string
+		plan       string
+		allowPXE   bool
+		httpClient bool
+		packet     bool
+		arm        bool
+		uefi       bool
+		filename   string
 	}{
 		{name: "just in_use",
 			hState: "in_use"},
@@ -42,17 +43,20 @@ func TestSetPXEFilename(t *testing.T) {
 			filename: "undionly.kpxe"},
 		{name: "active custom ipxe with allow pxe",
 			hState: "in_use", id: "$instance_id", iState: "active", allowPXE: true,
-			filename: "undionly.kpxe"},
+			filename: "ipxe/undionly.kpxe"},
 		{name: "hua",
-			plan: "hua", filename: "snp-hua.efi"},
+			plan: "hua", filename: "ipxe/snp-hua.efi"},
 		{name: "2a2",
-			plan: "2a2", filename: "snp-hua.efi"},
+			plan: "2a2", filename: "ipxe/snp-hua.efi"},
 		{name: "arm",
-			arm: true, filename: "snp-nolacp.efi"},
+			arm: true, filename: "ipxe/snp-nolacp.efi"},
 		{name: "x86 uefi",
-			uefi: true, filename: "ipxe.efi"},
+			uefi: true, filename: "ipxe/ipxe.efi"},
+		{name: "x86 uefi http client",
+			uefi: true, allowPXE: true, httpClient: true,
+			filename: "http://" + conf.PublicFQDN + "/ipxe/ipxe.efi"},
 		{name: "all defaults",
-			filename: "undionly.kpxe"},
+			filename: "ipxe/undionly.kpxe"},
 		{name: "packet iPXE",
 			packet: true, filename: "/nonexistent"},
 		{name: "packet iPXE PXE allowed",
@@ -87,7 +91,7 @@ func TestSetPXEFilename(t *testing.T) {
 				instance: instance,
 			}
 			rep := dhcp4.NewPacket(42)
-			j.setPXEFilename(&rep, tt.packet, tt.arm, tt.uefi)
+			j.setPXEFilename(&rep, tt.packet, tt.arm, tt.uefi, tt.httpClient)
 			filename := string(bytes.TrimRight(rep.File(), "\x00"))
 
 			if tt.filename != filename {

job/http.go

@@ -21,8 +21,10 @@ func (j Job) ServeFile(w http.ResponseWriter, req *http.Request, i Installers) {
 		return
 	}
 
-	w.WriteHeader(http.StatusNotFound)
-	j.With("file", base).Info("file not found")
+	// serve iPXE to HTTP clients.
+	// NB this must handle HEAD/GET and return Content-Length for odd clients
+	//    like the Seeed Studio Odyssey X86J4105 board.
+	ipxeFilesHandler.ServeHTTP(w, req)
 }
 
 func (j Job) ServePhoneHomeEndpoint(w http.ResponseWriter, req *http.Request) {

job/job.go

@@ -3,23 +3,33 @@ package job
 import (
 	"context"
 	"net"
+	"net/http"
 	"os"
 	"time"
 
 	"github.com/packethost/pkg/log"
 	"github.com/pkg/errors"
 	"github.com/tinkerbell/boots/conf"
 	"github.com/tinkerbell/boots/dhcp"
+	"github.com/tinkerbell/boots/ipxe"
 	"github.com/tinkerbell/boots/packet"
 	tw "github.com/tinkerbell/tink/protos/workflow"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"
 	"go.opentelemetry.io/otel/trace"
 )
 
+var joblog log.Logger
+var ipxeFilesHandler http.Handler
 var client packet.Client
 var provisionerEngineName string
 
+func Init(l log.Logger) {
+	joblog = l.Package("http")
+	ipxeFilesHandler = http.FileServer(http.FS(ipxe.Files))
+	initRSA()
+}
+
 // SetClient sets the client used to interact with the api.
 func SetClient(c packet.Client) {
 	client = c

job/logging.go

@@ -2,17 +2,8 @@ package job
 
 import (
 	"context"
-
-	"github.com/packethost/pkg/log"
 )
 
-var joblog log.Logger
-
-func Init(l log.Logger) {
-	joblog = l.Package("http")
-	initRSA()
-}
-
 func (j Job) Fatal(err error, args ...interface{}) {
 	j.Logger.AddCallerSkip(1).Error(err, args...)
 	panic(err)

rules.mk

@@ -52,7 +52,7 @@ generated_go_files := \
 .PHONY: $(generated_go_files)
 
 # build all the ipxe binaries
-generated_ipxe_files := tftp/ipxe/ipxe.efi tftp/ipxe/snp-hua.efi tftp/ipxe/snp-nolacp.efi tftp/ipxe/undionly.kpxe tftp/ipxe/snp-hua.efi
+generated_ipxe_files := ipxe/ipxe/ipxe.efi ipxe/ipxe/snp-hua.efi ipxe/ipxe/snp-nolacp.efi ipxe/ipxe/undionly.kpxe ipxe/ipxe/snp-hua.efi
 
 # go generate
 go_generate:
@@ -71,15 +71,15 @@ include ipxev.mk
 ipxeconfigs := $(wildcard ipxe/ipxe/*.h)
 
 # copy ipxe binaries into location available for go embed
-tftp/ipxe/ipxe.efi: ipxe/ipxe/build/bin-x86_64-efi/ipxe.efi
-tftp/ipxe/snp-nolacp.efi: ipxe/ipxe/build/bin-arm64-efi/snp.efi
-tftp/ipxe/undionly.kpxe: ipxe/ipxe/build/bin/undionly.kpxe
-tftp/ipxe/ipxe.efi tftp/ipxe/snp-nolacp.efi tftp/ipxe/undionly.kpxe:
-	mkdir -p tftp/ipxe
+ipxe/ipxe/ipxe.efi: ipxe/ipxe/build/bin-x86_64-efi/ipxe.efi
+ipxe/ipxe/snp-nolacp.efi: ipxe/ipxe/build/bin-arm64-efi/snp.efi
+ipxe/ipxe/undionly.kpxe: ipxe/ipxe/build/bin/undionly.kpxe
+ipxe/ipxe/ipxe.efi ipxe/ipxe/snp-nolacp.efi ipxe/ipxe/undionly.kpxe:
+	mkdir -p ipxe/ipxe
 	cp $^ $@
 
-tftp/ipxe/snp-hua.efi:
-	mkdir -p tftp/ipxe
+ipxe/ipxe/snp-hua.efi:
+	mkdir -p ipxe/ipxe
 # we dont build the snp-hua.efi binary. It's checked into git, so here we just copy it over
 	cp ipxe/bin/snp-hua.efi $@