// Package config reads, parses, and represents the warewulf.conf // config file. // // warewulf.conf is a yaml-formatted configuration file that includes // configuration for the Warewulf daemon and commands, as well as the // DHCP, TFTP and NFS services that Warewulf manages. package config import ( "bytes" "fmt" "net" "net/netip" "os" "reflect" "github.com/pkg/errors" "github.com/creasty/defaults" "github.com/warewulf/warewulf/internal/pkg/wwlog" "gopkg.in/yaml.v3" ) var cachedConf WarewulfYaml // WarewulfYaml is the main Warewulf configuration structure. It stores // some information about the Warewulf server locally, and has // [WarewulfConf], [DHCPConf], [TFTPConf], and [NFSConf] sub-sections. type WarewulfYaml struct { Comment string `yaml:"comment,omitempty"` Ipaddr string `yaml:"ipaddr,omitempty"` Ipaddr6 string `yaml:"ipaddr6,omitempty"` Netmask string `yaml:"netmask,omitempty"` Network string `yaml:"network,omitempty"` Ipv6net string `yaml:"ipv6net,omitempty"` Fqdn string `yaml:"fqdn,omitempty"` Warewulf *WarewulfConf `yaml:"warewulf,omitempty"` DHCP *DHCPConf `yaml:"dhcp,omitempty"` TFTP *TFTPConf `yaml:"tftp,omitempty"` NFS *NFSConf `yaml:"nfs,omitempty"` SSH *SSHConf `yaml:"ssh,omitempty"` MountsContainer []*MountEntry `yaml:"container mounts,omitempty" default:"[{\"source\": \"/etc/resolv.conf\", \"dest\": \"/etc/resolv.conf\"}]"` Paths *BuildConfig `yaml:"paths,omitempty"` WWClient *WWClientConf `yaml:"wwclient,omitempty"` warewulfconf string } // New caches and returns a new [WarewulfYaml] initialized with empty // values, clearing replacing any previously cached value. func New() *WarewulfYaml { cachedConf = WarewulfYaml{} cachedConf.warewulfconf = "" cachedConf.Warewulf = new(WarewulfConf) cachedConf.DHCP = new(DHCPConf) cachedConf.TFTP = new(TFTPConf) cachedConf.NFS = new(NFSConf) cachedConf.SSH = new(SSHConf) cachedConf.Paths = new(BuildConfig) if err := defaults.Set(&cachedConf); err != nil { panic(err) } return &cachedConf } // Get returns a previously cached [WarewulfYaml] if it exists, or returns // a new WarewulfYaml. func Get() *WarewulfYaml { // NOTE: This function can be called before any log level is set // so using wwlog.Verbose or wwlog.Debug won't work if reflect.ValueOf(cachedConf).IsZero() { cachedConf = *New() } return &cachedConf } // Read populates [WarewulfYaml] with the values from a configuration // file. func (conf *WarewulfYaml) Read(confFileName string) error { wwlog.Debug("Reading warewulf.conf from: %s", confFileName) conf.warewulfconf = confFileName if data, err := os.ReadFile(confFileName); err != nil { return err } else if err := conf.Parse(data); err != nil { return err } else { return nil } } // Parse populates [WarewulfYaml] with the values from a yaml document. func (conf *WarewulfYaml) Parse(data []byte) error { // ipxe binaries are merged not overwritten, store defaults separate defIpxe := make(map[string]string) for k, v := range conf.TFTP.IpxeBinaries { defIpxe[k] = v delete(conf.TFTP.IpxeBinaries, k) } if err := yaml.Unmarshal(data, &conf); err != nil { return err } if len(conf.TFTP.IpxeBinaries) == 0 { conf.TFTP.IpxeBinaries = defIpxe } // check whether ip addr is CIDR type and configure related fields as required if ip, network, err := net.ParseCIDR(conf.Ipaddr); err == nil { conf.Ipaddr = ip.String() if conf.Network == "" { conf.Network = network.IP.String() } if conf.Netmask == "" { mask := network.Mask conf.Netmask = fmt.Sprintf("%d.%d.%d.%d", mask[0], mask[1], mask[2], mask[3]) } } return nil } // SetDynamicDefaults populates [WarewulfYaml] with plausible defaults for // the runtime environment. func (conf *WarewulfYaml) SetDynamicDefaults() (err error) { if conf.Ipaddr == "" || conf.Netmask == "" || conf.Network == "" { var mask net.IPMask var network *net.IPNet var ip net.IP cidr := conf.Ipaddr if conf.Ipaddr == "" { wwlog.Verbose("Configuration has no valid network, going to dynamic values") conn, err := net.Dial("udp", "8.8.8.8:80") if err == nil { defer conn.Close() ipaddr := conn.LocalAddr().(*net.UDPAddr).IP mask = ipaddr.DefaultMask() sz, _ := mask.Size() cidr = ipaddr.String() + fmt.Sprintf("/%d", sz) } else { cidr = "192.168.1.1/24" } } else if addr, err := netip.ParseAddr(conf.Ipaddr); err == nil { // if the ipaddr does not have mask appended, update it with default generated mask ipaddr := net.IP(addr.AsSlice()) sz, _ := ipaddr.DefaultMask().Size() cidr = fmt.Sprintf("%s/%d", conf.Ipaddr, sz) // otherwise, the following code will handle the ipaddr format: invalid or xxx.xxx.xxx.xxx/xx } ip, network, err = net.ParseCIDR(cidr) if err == nil { mask = network.Mask } else { return fmt.Errorf("Couldn't parse IP address: %w", err) } if conf.Netmask == "" { conf.Netmask = fmt.Sprintf("%d.%d.%d.%d", mask[0], mask[1], mask[2], mask[3]) wwlog.Verbose("Netmask address is not configured in warewulf.conf, using %s", conf.Netmask) } if conf.Network == "" { conf.Network = network.IP.String() wwlog.Verbose("Network is not configured in warewulf.conf, using %s", conf.Network) } // always update the ipaddr to valid ip conf.Ipaddr = ip.String() } if conf.DHCP.RangeStart == "" && conf.DHCP.RangeEnd == "" { start := net.ParseIP(conf.Network).To4() start[3] += 1 if start.Equal(net.ParseIP(conf.Ipaddr)) { start[3] += 1 } conf.DHCP.RangeStart = start.String() wwlog.Verbose("dhpd start is not configured in warewulf.conf, using %s", conf.DHCP.RangeStart) sz, _ := net.IPMask(net.ParseIP(conf.Netmask).To4()).Size() range_end := (1 << (32 - sz)) / 8 if range_end > 127 { range_end = 127 } end := net.ParseIP(conf.Network).To4() end[3] += byte(range_end) conf.DHCP.RangeEnd = end.String() wwlog.Verbose("dhpd end is not configured in warewulf.conf, using %s", conf.DHCP.RangeEnd) } // check validity of ipv6 net if conf.Ipaddr6 != "" { _, ipv6net, err := net.ParseCIDR(conf.Ipaddr6) if err != nil { wwlog.Error("Invalid ipv6 address specified, mut be CIDR notation: %s", conf.Ipaddr6) return errors.New("invalid ipv6 network") } if msize, _ := ipv6net.Mask.Size(); msize > 64 { wwlog.Error("ipv6 mask size must be smaller than 64") return errors.New("invalid ipv6 network size") } } return } // InitializedFromFile returns true if [WarewulfYaml] memory was read from // a file, or false otherwise. func (conf *WarewulfYaml) InitializedFromFile() bool { return conf.warewulfconf != "" } func (conf *WarewulfYaml) GetWarewulfConf() string { return conf.warewulfconf } func (config *WarewulfYaml) Dump() ([]byte, error) { var buf bytes.Buffer yamlEncoder := yaml.NewEncoder(&buf) yamlEncoder.SetIndent(2) err := yamlEncoder.Encode(config) return buf.Bytes(), err } func (config *WarewulfYaml) PersistToFile(configFile string) error { out, dumpErr := config.Dump() if dumpErr != nil { wwlog.Error("%s", dumpErr) return dumpErr } file, err := os.OpenFile(configFile, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o644) if err != nil { wwlog.Error("%s", err) return err } defer file.Close() _, err = file.WriteString(string(out)) if err != nil { return err } wwlog.Debug("persisted: %s", configFile) return nil }