zoneparser

README

Zone Parser

Zone Parser is a simple to use Go library that can parse bind like DNS-Zones.

Reading existing zone files

func main() {
	zoneFile, _ := ioutil.ReadFile("myzonefile")
	zone := ParseZone(string(zoneFile))
}

Writing a Zone to a file

Note that ToZoneFile will not preserve the format of zones that where parsed by ParseZone.

func main() {
	zoneFile, _ := ioutil.ReadFile("myzonefile")
	zone := ParseZone(string(zoneFile))
	zoneFile = zone.ToZoneFile() // Returns zone as string
}

Updating the serial

Zone Parser can update the serial of your zone. There are two differend methods of serial updating available. You can use Zone.UpdateSerial for updating the serial with the current UTC UNIX timestamp or Zone.UpdateSerialRFC to update your zone with the RFC compliant serial representation.

func updateSerial(z *Zone) {
		z.UpdateSerial() // z.SOA.Serial -> UNIX timestamp
		z.UpdateSerialRFC() // z.SOA.Serial -> RFC compliant representation (yyyymmdd00)
}

Documentation

Index

• type ParseState
• type Record
• type Zone
  • func ParseZone(bindZone string) (*Zone, error)
  • func (z *Zone) AddPTR(IP string, Host string, Ttl uint) error
  • func (z *Zone) ToZoneFile() (string, error)
  • func (z *Zone) UpdateSerial()
  • func (z *Zone) UpdateSerialRFC() error
• type ZoneSOA
• type ZoneScanner
  • func (z *ZoneScanner) HasNext() bool
  • func (z *ZoneScanner) Next(n int) string
  • func (z *ZoneScanner) Peek(n int) string
  • func (z *ZoneScanner) SkipToEoL()
  • func (z *ZoneScanner) SkipWhitespace()

Types

type ParseState

type ParseState struct {
	Parenthesis  bool
	Quote        bool
	PreviousName string
}

ParseState represents the current state of the zone parser. ParseState is used by parseZone and does not need to be used manually.

type Record

type Record struct {
	Class   string
	Content string
	Host    string
	Ttl     uint
	Type    string
}

Record represents a single DNS resource record

type Zone

type Zone struct {
	SOA     *ZoneSOA
	Origin  string
	Records []Record
	Ttl     uint
}

Zone represents a DNS zone. It can either be instantiated manually or by using ToZoneFile

func ParseZone

func ParseZone(bindZone string) (*Zone, error)

ParseZone parses a bind-like zone file and returns a Zone struct.

func (*Zone) AddPTR

func (z *Zone) AddPTR(IP string, Host string, Ttl uint) error

AddPTR adds a creates a PTR from an IP address and adds it to the zone. If Ttl is 0 the default TTl from the zone is being used. Note: Legacy IP is currently not supported.

func (*Zone) ToZoneFile

func (z *Zone) ToZoneFile() (string, error)

ToZoneFile returns a string containing a bind-like zone file from the provided zone

func (*Zone) UpdateSerial

func (z *Zone) UpdateSerial()

UpdateSerial updates the serial number of the record with the current Unix time stamp. Note: This does not follow the official recommendation for zone serial numbers. Use UpdateSerialRFC instead, if you want RFC compliant serial numbers.

func (*Zone) UpdateSerialRFC

func (z *Zone) UpdateSerialRFC() error

UpdateSerialRFC updates the serial number of the record with the current date and a two digit serial.

type ZoneSOA

type ZoneSOA struct {
	Host       string
	Email      string
	Nameserver string
	Serial     string
	Refresh    string
	Retry      string
	Expire     string
	Minimum    string
}

ZoneSOA represents an SOA record

type ZoneScanner

type ZoneScanner struct {
	// contains filtered or unexported fields
}

ZoneScanner is a simple scanner that provides functionality for zone files. It should not be instantiated manually, instead use newZoneScanner

func (*ZoneScanner) HasNext

func (z *ZoneScanner) HasNext() bool

HasNext returns whether the scanner has a next char.

func (*ZoneScanner) Next

func (z *ZoneScanner) Next(n int) string

Next Returns the next n chars of the scanners content and sets the new position. If n is greater than the remaining content, only the remaining content will be returned.

func (*ZoneScanner) Peek

func (z *ZoneScanner) Peek(n int) string

Peek Returns the next n chars of the scanners content without changing the position. If n is greater than the remaining content, only the remaining content will be returned.

func (*ZoneScanner) SkipToEoL

func (z *ZoneScanner) SkipToEoL()

SkipToEoL goes to the end of the line

func (*ZoneScanner) SkipWhitespace

func (z *ZoneScanner) SkipWhitespace()

SkipWhitespace goes to the next char that is not whitespace