resolvconf

README

Package resolvconf provides utility code to query and update DNS configuration in /etc/resolv.conf

Documentation

Overview

Package resolvconf provides utility code to query and update DNS configuration in /etc/resolv.conf

Index

• Constants
• func GetNameservers(resolvConf []byte, kind int) []string
• func GetNameserversAsCIDR(resolvConf []byte) []string
• func GetOptions(resolvConf []byte) []string
• func GetSearchDomains(resolvConf []byte) []string
• type File
  • func Build(path string, dns, dnsSearch, dnsOptions []string) (*File, error)
  • func FilterResolvDNS(resolvConf []byte, ipv6Enabled bool) (*File, error)
  • func Get() (*File, error)
  • func GetIfChanged() (*File, error)
  • func GetLastModified() *File
  • func GetSpecific(path string) (*File, error)

Constants

const (
	// DefaultResolvConf points to the default file used for dns configuration on a linux machine
	DefaultResolvConf = "/etc/resolv.conf"
)

Functions

func GetNameservers

func GetNameservers(resolvConf []byte, kind int) []string

GetNameservers returns nameservers (if any) listed in /etc/resolv.conf

func GetNameserversAsCIDR

func GetNameserversAsCIDR(resolvConf []byte) []string

GetNameserversAsCIDR returns nameservers (if any) listed in /etc/resolv.conf as CIDR blocks (e.g., "1.2.3.4/32") This function's output is intended for net.ParseCIDR

func GetOptions

func GetOptions(resolvConf []byte) []string

GetOptions returns options (if any) listed in /etc/resolv.conf If more than one options line is encountered, only the contents of the last one is returned.

func GetSearchDomains

func GetSearchDomains(resolvConf []byte) []string

GetSearchDomains returns search domains (if any) listed in /etc/resolv.conf If more than one search line is encountered, only the contents of the last one is returned.

Types

type File

type File struct {
	Content []byte
	Hash    string
}

File contains the resolv.conf content and its hash

func Build

func Build(path string, dns, dnsSearch, dnsOptions []string) (*File, error)

Build writes a configuration file to path containing a "nameserver" entry for every element in dns, a "search" entry for every element in dnsSearch, and an "options" entry for every element in dnsOptions.

func FilterResolvDNS

func FilterResolvDNS(resolvConf []byte, ipv6Enabled bool) (*File, error)

FilterResolvDNS cleans up the config in resolvConf. It has two main jobs:

1. It looks for localhost (127.*|::1) entries in the provided resolv.conf, removing local nameserver entries, and, if the resulting cleaned config has no defined nameservers left, adds default DNS entries
2. Given the caller provides the enable/disable state of IPv6, the filter code will remove all IPv6 nameservers if it is not enabled for containers

func Get

func Get() (*File, error)

Get returns the contents of /etc/resolv.conf and its hash

func GetIfChanged

func GetIfChanged() (*File, error)

GetIfChanged retrieves the host /etc/resolv.conf file, checks against the last hash and, if modified since last check, returns the bytes and new hash. This feature is used by the resolv.conf updater for containers

func GetLastModified

func GetLastModified() *File

GetLastModified retrieves the last used contents and hash of the host resolv.conf. Used by containers updating on restart

func GetSpecific

func GetSpecific(path string) (*File, error)

GetSpecific returns the contents of the user specified resolv.conf file and its hash