github.com/mvdan/u-root-coreutils@v0.0.0-20230122170626-c2eef2898555/cmds/boot/pxeboot/pxeboot.go

// Copyright 2017-2018 the u-root Authors. All rights reserved
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Command pxeboot implements PXE-based booting.
//
// pxeboot combines a DHCP client with a TFTP/HTTP client to download files as
// well as pxelinux and iPXE configuration file parsing.
//
// PXE-based booting requests a DHCP lease, and looks at the BootFileName and
// ServerName options (which may be embedded in the original BOOTP message, or
// as option codes) to find something to boot.
//
// This BootFileName may point to:
//
// - an iPXE script beginning with #!ipxe
//
//   - a pxelinux.0, in which case we will ignore the pxelinux and try to parse
//     pxelinux.cfg/<files>
package main

import (
	"context"
	"flag"
	"fmt"
	"log"
	"net"
	"strings"
	"time"

	"github.com/mvdan/u-root-coreutils/pkg/boot"
	"github.com/mvdan/u-root-coreutils/pkg/boot/bootcmd"
	"github.com/mvdan/u-root-coreutils/pkg/boot/menu"
	"github.com/mvdan/u-root-coreutils/pkg/boot/netboot"
	"github.com/mvdan/u-root-coreutils/pkg/curl"
	"github.com/mvdan/u-root-coreutils/pkg/dhclient"
	"github.com/mvdan/u-root-coreutils/pkg/sh"
	"github.com/mvdan/u-root-coreutils/pkg/ulog"

	"github.com/insomniacslk/dhcp/dhcpv4"
)

var (
	ifName      = "^e.*"
	noLoad      = flag.Bool("no-load", false, "get DHCP response, print chosen boot configuration, but do not download + exec it")
	noExec      = flag.Bool("no-exec", false, "download boot configuration, but do not exec it")
	noNetConfig = flag.Bool("no-net-config", false, "get DHCP response, but do not apply the network config it to the kernel interface")
	skipBonded  = flag.Bool("skip-bonded", false, "Skip NICs that have already been added to a bond")
	verbose     = flag.Bool("v", false, "Verbose output")
	ipv4        = flag.Bool("ipv4", true, "use IPV4")
	ipv6        = flag.Bool("ipv6", true, "use IPV6")
	cmdAppend   = flag.String("cmd", "", "Kernel command to append for each image")
	bootfile    = flag.String("file", "", "Boot file name (default tftp) or full URI to use instead of DHCP.")
	server      = flag.String("server", "0.0.0.0", "Server IP (Requires -file for effect)")
)

const (
	dhcpTimeout = 5 * time.Second
	dhcpTries   = 3
)

// NetbootImages requests DHCP on every ifaceNames interface, and parses
// netboot images from the DHCP leases. Returns bootable OSes.
func NetbootImages(ifaceNames string) ([]boot.OSImage, error) {
	filteredIfs, err := dhclient.Interfaces(ifaceNames)
	if err != nil {
		return nil, err
	}

	if *skipBonded {
		filteredIfs = dhclient.FilterBondedInterfaces(filteredIfs, *verbose)
	}

	ctx, cancel := context.WithTimeout(context.Background(), (1<<dhcpTries)*dhcpTimeout)
	defer cancel()

	c := dhclient.Config{
		Timeout: dhcpTimeout,
		Retries: dhcpTries,
	}
	if *verbose {
		c.LogLevel = dhclient.LogSummary
	}
	r := dhclient.SendRequests(ctx, filteredIfs, *ipv4, *ipv6, c, 30*time.Second)

	for {
		select {
		case <-ctx.Done():
			return nil, ctx.Err()

		case result, ok := <-r:
			if !ok {
				return nil, fmt.Errorf("nothing bootable found, all interfaces are configured or timed out")
			}
			iname := result.Interface.Attrs().Name
			if result.Err != nil {
				log.Printf("Could not configure %s for %s: %v", iname, result.Protocol, result.Err)
				continue
			}

			if *noNetConfig {
				log.Printf("Skipping configuring %s with lease %s", iname, result.Lease)
			} else if err := result.Lease.Configure(); err != nil {
				log.Printf("Failed to configure lease %s: %v", result.Lease, err)
				// Boot further regardless of lease configuration result.
				//
				// If lease failed, fall back to use locally configured
				// ip/ipv6 address.
			}

			// Don't use the other context, as it's for the DHCP timeout.
			imgs, err := netboot.BootImages(context.Background(), ulog.Log, curl.DefaultSchemes, result.Lease)
			if err != nil {
				log.Printf("Failed to boot lease %v: %v", result.Lease, err)
				continue
			}

			return imgs, nil
		}
	}
}

func newManualLease() (dhclient.Lease, error) {
	filteredIfs, err := dhclient.Interfaces(ifName)
	if err != nil {
		return nil, err
	}

	d, err := dhcpv4.New()
	if err != nil {
		return nil, err
	}

	d.BootFileName = *bootfile
	d.ServerIPAddr = net.ParseIP(*server)

	return dhclient.NewPacket4(filteredIfs[0], d), nil
}

func dumpNetDebugInfo() {
	log.Println("Dump debug info of network status")
	commands := []string{"ip link", "ip addr", "ip route show table all", "ip -6 route show table all", "ip neigh"}
	for _, cmd := range commands {
		cmds := strings.Split(cmd, " ")
		name := cmds[0]
		args := cmds[1:]
		sh.RunWithLogs(name, args...)
	}
}

func main() {
	flag.Parse()
	if len(flag.Args()) > 1 {
		log.Fatalf("Only one regexp-style argument is allowed, e.g.: " + ifName)
	}
	if len(flag.Args()) > 0 {
		ifName = flag.Args()[0]
	}

	var images []boot.OSImage
	var err error
	if *bootfile == "" {
		images, err = NetbootImages(ifName)
		if err != nil {
			dumpNetDebugInfo()
		}
	} else {
		log.Printf("Skipping DHCP for manual target..")
		var l dhclient.Lease
		l, err = newManualLease()
		if err == nil {
			images, err = netboot.BootImages(context.Background(), ulog.Log, curl.DefaultSchemes, l)
		}
	}

	if err != nil {
		log.Printf("Netboot failed: %v", err)
	}

	for _, img := range images {
		img.Edit(func(cmdline string) string {
			return cmdline + " " + *cmdAppend
		})
	}

	menuEntries := menu.OSImages(*verbose, images...)
	menuEntries = append(menuEntries, menu.Reboot{})
	menuEntries = append(menuEntries, menu.StartShell{})

	// Boot does not return.
	bootcmd.ShowMenuAndBoot(menuEntries, nil, *noLoad, *noExec)
}