smee

type BackendReader interface {
	// Read data (from a backend) based on a mac address
	// and return DHCP headers and options, including netboot info.
	GetByMac(context.Context, net.HardwareAddr) (data.Hardware, error)
	GetByIP(context.Context, net.IP) (data.Hardware, error)
}

type Config struct {
	// Backend is the backend to use for getting data.
	Backend BackendReader
	// DHCP is the configuration for the DHCP service.
	DHCP DHCP
	// IPXE is the configuration for the iPXE service.
	IPXE IPXE
	// ISO is the configuration for the ISO service.
	ISO ISO
	// OTEL is the configuration for OpenTelemetry.
	OTEL OTEL
	// Syslog is the configuration for the syslog service.
	Syslog Syslog
	// TFTP is the configuration for the TFTP service.
	TFTP TFTP
	// TinkServer is the configuration for the Tinkerbell server.
	TinkServer TinkServer
	// HTTP is the configuration for the HTTP service.
	HTTP HTTP
	// TLS is the configuration for TLS.
	TLS TLS
}

type DHCP struct {
	// Enabled configures whether the DHCP server is enabled.
	Enabled bool
	// EnableNetbootOptions configures whether sending netboot options is enabled.
	EnableNetbootOptions bool
	// Mode determines the behavior of the DHCP server.
	// See the DHCPMode type for valid values.
	Mode DHCPMode
	// BindAddr is the local address to which to bind the DHCP server and listen for DHCP packets.
	BindAddr netip.Addr
	BindPort uint16
	// BindInterface is the local interface to which to bind the DHCP server and listen for DHCP packets.
	BindInterface string
	// IPForPacket is the IP address to use in the DHCP packet for DHCP option 54.
	IPForPacket netip.Addr
	// SyslogIP is the IP address to use in the DHCP packet for DHCP option 7.
	SyslogIP netip.Addr
	// TFTPIP is the IP address to use in the DHCP packet for DHCP option 66.
	TFTPIP netip.Addr
	// TFTPPort is the port to use in the DHCP packet for DHCP option 66.
	TFTPPort uint16
	// IPXEHTTPBinaryURL is the URL to the iPXE binary server serving via HTTP.
	IPXEHTTPBinaryURL *url.URL
	// IPXEHTTPScript is the URL to the iPXE script to use.
	IPXEHTTPScript IPXEHTTPScript
}

type DHCPMode string

type HTTP struct {
	// BindHTTPSPort is the local port to listen on for the HTTPS server.
	BindHTTPSPort uint16
}

type IPXE struct {
	EmbeddedScriptPatch string
	HTTPBinaryServer    IPXEHTTPBinaryServer
	HTTPScriptServer    IPXEHTTPScriptServer

	// IPXEBinary are the options to use when serving iPXE binaries via TFTP or HTTP.
	IPXEBinary IPXEHTTPBinary
}

type IPXEHTTPBinary struct {
	// InjectMacAddrFormat is the format to use when injecting the mac address into the iPXE binary URL.
	// Valid values are "colon", "dot", "dash", "no-delimiter", and "empty".
	// For example, colon: http://1.2.3.4/ipxe/ipxe.efi -> http://1.2.3.4/ipxe/40:15:ff:89:cc:0e/ipxe.efi
	InjectMacAddrFormat constant.MACFormat
	// IPXEArchMapping will override the default architecture to binary mapping.
	IPXEArchMapping map[iana.Arch]constant.IPXEBinary
}

type IPXEHTTPBinaryServer struct {
	Enabled bool
}

type IPXEHTTPScript struct {
	URL *url.URL
	// InjectMacAddress will prepend the hardware mac address to the ipxe script URL file name.
	// For example: http://1.2.3.4/my/loc/auto.ipxe -> http://1.2.3.4/my/loc/40:15:ff:89:cc:0e/auto.ipxe
	// Setting this to false is useful when you are not using the auto.ipxe script in Smee.
	InjectMacAddress bool
}

type IPXEHTTPScriptServer struct {
	Enabled         bool
	BindAddr        netip.Addr
	BindPort        uint16
	Retries         int
	RetryDelay      int
	OSIEURL         *url.URL
	TrustedProxies  []string
	ExtraKernelArgs []string
}

type ISO struct {
	Enabled           bool
	UpstreamURL       *url.URL
	PatchMagicString  string
	StaticIPAMEnabled bool
}

type OTEL struct {
	Endpoint         string
	InsecureEndpoint bool
}

type Syslog struct {
	// BindAddr is the local address to which to bind the syslog server.
	BindAddr netip.Addr
	// BindPort is the local port to which to bind the syslog server.
	BindPort uint16
	// Enabled is a flag to enable or disable the syslog server.
	Enabled bool
}

type TFTP struct {
	// BindAddr is the local address to which to bind the TFTP server.
	BindAddr netip.Addr
	// BindPort is the local port to which to bind the TFTP server.
	BindPort uint16
	// BlockSize is the block size to use when serving TFTP requests.
	BlockSize int
	// SinglePort configures whether to use single-port TFTP mode.
	SinglePort bool
	// Timeout is the timeout for each serving each TFTP request.
	Timeout time.Duration
	// Enabled is a flag to enable or disable the TFTP server.
	Enabled bool
}

type TLS struct {
	Certs []tls.Certificate
}

type TinkServer struct {
	UseTLS      bool
	InsecureTLS bool
	AddrPort    string
}