Class: Zonefile

Inherits:
Object
  • Object
show all
Defined in:
lib/zonefile/zonefile.rb

Overview

Ruby Zonefile - Parse and manipulate DNS Zone Files.

Description

This class can read, manipulate and create DNS zone files. It supports A, AAAA, MX, NS, SOA, TXT, CNAME, PTR and SRV records. The data can be accessed by the instance method of the same name. All except SOA return an array of hashes containing the named data. SOA directly returns the hash since there can only be one SOA information.

The following hash keys are returned per record type:

  • SOA

    - :ttl, :primary, :email, :serial, :refresh, :retry, :expire, :minimumTTL

  • A

    - :name, :ttl, :class, :host

  • MX

    - :name, :ttl, :class, :pri, :host

  • NS

    - :name, :ttl, :class, :host

  • CNAME

    - :name, :ttl, :class, :host

  • TXT

    - :name, :ttl, :class, :text

  • A4 (AAAA)

    - :name, :ttl, :class, :host

  • PTR

    - :name, :ttl, :class, :host

  • SRV

    - :name, :ttl, :class, :pri, :weight, :port, :host

Examples

Read a Zonefile

zf = Zonefile.from_file('/path/to/zonefile.db')

# Display MX-Records
zf.mx.each do |mx_record|
   puts "Mail Exchagne with priority: #{mx_record[:pri]} --> #{mx_record[:host]}"
end

# Show SOA TTL
puts "Record Time To Live: #{zf.soa[:ttl]}"

# Show A-Records
zf.a.each do |a_record|
   puts "#{a_record[:name]} --> #{a_record[:host]}"
end

Manipulate a Zonefile

zf = Zonefile.from_file('/path/to/zonefile.db')

# Change TTL and add an A-Record

zf.soa[:ttl] = '123123'	# Change the SOA ttl
zf.a << { :class => 'IN', :name => 'www', :host => '192.168.100.1', :ttl => 3600 }  # add A-Record

# Setting PTR records (deleting existing ones)

zf.ptr = [ { :class => 'IN', :name=>'1.100.168.192.in-addr.arpa', :host => 'my.host.com' },
           { :class => 'IN', :name=>'2.100.168.192.in-addr.arpa', :host => 'me.host.com' } ]

# Increase Serial Number
zf.new_serial

# Print new zonefile
puts "New Zonefile: \n#{zf.output}"

Author

Martin Boese, based on Simon Flack Perl library DNS::ZoneParse

Constant Summary collapse

RECORDS = 
%w{ mx a a4 ns cname txt ptr srv soa }

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(zonefile = '', file_name = nil, origin = nil) ⇒ Zonefile

create a new zonefile object by passing the content of the zonefile



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/zonefile/zonefile.rb', line 123

def initialize(zonefile = '', file_name= nil, origin= nil)
  @data = zonefile
  @filename = file_name
  @origin = origin || (file_name ? file_name.split('/').last : '')
 
  @records = {}
  @soa = {}
  RECORDS.each { |r| @records[r.intern] = [] }
  parse
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/zonefile/zonefile.rb', line 87

def method_missing(m, *args)
  mname = m.to_s.sub("=","")
  return super unless RECORDS.include?(mname)
  
  if m.to_s[-1].chr == '=' then
    @records[mname.intern] = args.first
    @records[mname.intern]
  else 
    @records[m]
  end
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



81
82
83
 
# File 'lib/zonefile/zonefile.rb', line 81

def data
  @data
end

#origin ⇒ Object (readonly)

global $ORIGIN option



83
84
85
 
# File 'lib/zonefile/zonefile.rb', line 83

def origin
  @origin
end

#records ⇒ Object (readonly)

Returns the value of attribute records.



79
80
81
 
# File 'lib/zonefile/zonefile.rb', line 79

def records
  @records
end

#soa ⇒ Object (readonly)

Returns the value of attribute soa.



80
81
82
 
# File 'lib/zonefile/zonefile.rb', line 80

def soa
  @soa
end

#ttl ⇒ Object (readonly)

global $TTL option



85
86
87
 
# File 'lib/zonefile/zonefile.rb', line 85

def ttl
  @ttl
end

Class Method Details

.from_file(file_name, origin = nil) ⇒ Object

Create a new object by reading the content of a file



143
144
145
 
# File 'lib/zonefile/zonefile.rb', line 143

def self.from_file(file_name, origin = nil)
   Zonefile.new(File.read(file_name), file_name.split('/').last, origin)
end

.simplify(zf) ⇒ Object

Compact a zonefile content - removes empty lines, comments, converts tabs into spaces etc…



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/zonefile/zonefile.rb', line 102

def self.simplify(zf)
   # concatenate everything split over multiple lines in parentheses - remove ;-comments in block
   zf = zf.gsub(/(\([^\)]*?\))/) { |m| m.split(/\n/).map { |l| l.gsub(/\;.*$/, '') }.join("\n").gsub(/[\r\n]/, '') }

   zf.split(/\n/).map do |line|
       r = line.gsub(/\t/, ' ')
       r = r.gsub(/\s+/, ' ')
       		# FIXME: this is ugly and not accurate, couldn't find proper regex:
       		#   Don't strip ';' if it's quoted. Happens a lot in TXT records.
       (0..(r.length - 1)).find_all { |i| r[i].chr == ';' }.each do |comment_idx|
          if !r[(comment_idx+1)..-1].index(/['"]/) then
             r = r[0..(comment_idx-1)]
             break
          end
       end
       r
   end.delete_if { |line| line.empty? || line[0].chr == ';'}.join("\n")
end

Instance Method Details

#add_record(type, data = {}) ⇒ Object 



147
148
149
 
# File 'lib/zonefile/zonefile.rb', line 147

def add_record(type, data= {})
   @records[type.downcase.intern] << data
end

#empty? ⇒ Boolean

True if no records (except sao) is defined in this file

Returns:

  • (Boolean) 


135
136
137
138
139
140
 
# File 'lib/zonefile/zonefile.rb', line 135

def empty?
  RECORDS.each do |r|
     return false unless @records[r.intern].empty?
  end
  true
end

#new_serial ⇒ Object

Generates a new serial number in the format of YYYYMMDDII if possible



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/zonefile/zonefile.rb', line 152

def new_serial
  base = "%04d%02d%02d" % [Time.now.year, Time.now.month, Time.now.day ]

  if ((@soa[:serial].to_i / 100) > base.to_i) then
      ns = @soa[:serial].to_i + 1
      @soa[:serial] = ns.to_s
      return ns.to_s
  end
  
  ii = 0
  while (("#{base}%02d" % ii).to_i <= @soa[:serial].to_i) do
   ii += 1
  end
  @soa[:serial] = "#{base}%02d" % ii   
end

#output ⇒ Object

Build a new nicely formatted Zonefile



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/zonefile/zonefile.rb', line 255

def output
   out =<<-ENDH
;
;  Database file #{@filename || 'unknown'} for #{@origin || 'unknown'} zone.
;	Zone version: #{self.soa[:serial]}
;
#{self.soa[:origin]}		#{self.soa[:ttl]} IN  SOA  #{self.soa[:primary]} #{self.soa[:email]} (
			#{self.soa[:serial]}	; serial number
			#{self.soa[:refresh]}	; refresh
			#{self.soa[:retry]}	; retry
			#{self.soa[:expire]}	; expire
			#{self.soa[:minimumTTL]}	; minimum TTL
			)

#{@origin ? "$ORIGIN #{@origin}" : ''}
#{@ttl ? "$TTL #{@ttl}" : ''}
			
; Zone NS Records
ENDH
  self.ns.each do |ns|
    out <<  "#{ns[:name]}	#{ns[:ttl]}	#{ns[:class]}	NS	#{ns[:host]}\n"
  end
  out << "\n; Zone MX Records\n" unless self.mx.empty?
  self.mx.each do |mx|
    out << "#{mx[:name]}	#{mx[:ttl]}	#{mx[:class]}	MX	#{mx[:pri]} #{mx[:host]}\n"
  end
  
  out << "\n; Zone A Records\n" unless self.a.empty?
  self.a.each do |a|
       out <<  "#{a[:name]}	#{a[:ttl]}	#{a[:class]}	A	#{a[:host]}\n"
  end   

  out << "\n; Zone CNAME Records\n" unless self.cname.empty?
  self.cname.each do |cn|
    out << "#{cn[:name]}	#{cn[:ttl]}	#{cn[:class]}	CNAME	#{cn[:host]}\n"
  end  

  out << "\n; Zone AAAA Records\n" unless self.a4.empty?
  self.a4.each do |a4|
    out << "#{a4[:name]}	#{a4[:ttl]}	#{a4[:class]}	AAAA	#{a4[:host]}\n"
  end

  out << "\n; Zone TXT Records\n" unless self.txt.empty?
  self.txt.each do |tx|
    out << "#{tx[:name]}	#{tx[:ttl]}	#{tx[:class]}	TXT	#{tx[:text]}\n"
  end

  out << "\n; Zone SRV Records\n" unless self.srv.empty?
  self.srv.each do |srv|
    out << "#{srv[:name]}	#{srv[:ttl]}	#{srv[:class]}	SRV	#{srv[:pri]} #{srv[:weight]} #{srv[:port]}	#{srv[:host]}\n"
  end
  
  out << "\n; Zone PTR Records\n" unless self.ptr.empty?
  self.ptr.each do |ptr|
    out << "#{ptr[:name]}	#{ptr[:ttl]}	#{ptr[:class]}	PTR	#{ptr[:host]}\n"
  end
  
  out
end

#parse ⇒ Object 



246
247
248
249
250
 
# File 'lib/zonefile/zonefile.rb', line 246

def parse
   Zonefile.simplify(@data).each_line do |line|
       parse_line(line)      
   end
end

#parse_line(line) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/zonefile/zonefile.rb', line 168

def parse_line(line)
   valid_name = /[\@a-z_\-\.0-9\*]+/i
   valid_ip6  = /[\@a-z_\-\.0-9\*:]+/i
   rr_class   = /\b(?:IN|HS|CH)\b/i
   rr_type    = /\b(?:NS|A|CNAME)\b/i
   rr_ttl     = /(?:\d+[wdhms]?)+/i
   ttl_cls    = Regexp.new("(?:(#{rr_ttl})\s)?(?:(#{rr_class})\s)?")

   data = {}
   if line =~ /^\$ORIGIN\s*(#{valid_name})/ix then
       @origin = $1
   elsif line =~ /^(#{valid_name})? \s*
                #{ttl_cls}
                (#{rr_type}) \s
                (#{valid_name})
              /ix then
             (name, ttl, dclass, type, host) = [$1, $2, $3, $4, $5]
            add_record($4, :name => $1, :ttl => $2, :class => $3, :host => $5)
   elsif line=~/^(#{valid_name})? \s*
               #{ttl_cls}
               AAAA \s
               (#{valid_ip6})               
               /x then
             add_record('a4', :name => $1, :ttl => $2, :class => $3, :host => $4)
   elsif line=~/^(#{valid_name})? \s*
                #{ttl_cls}
                MX \s
                (\d+) \s
                (#{valid_name})
              /ix then
              add_record('mx', :name => $1, :ttl => $2, :class => $3, :pri => $4.to_i, :host => $5)
   elsif line=~/^(#{valid_name})? \s*
                #{ttl_cls}
                SRV \s
                (\d+) \s
                (\d+) \s
                (\d+) \s
                (#{valid_name})
              /ix
       add_record('srv', :name => $1, :ttl => $2, :class => $3, :pri => $4, :weight => $5,
                         :port => $6, :host => $7)
   elsif line=~/^(#{valid_name}) \s+
                #{ttl_cls}
                SOA \s+
                (#{valid_name}) \s+
                (#{valid_name}) \s*
                \(?\s*
                    (#{rr_ttl}) \s+
                    (#{rr_ttl}) \s+
                    (#{rr_ttl}) \s+
                    (#{rr_ttl}) \s+
                    (#{rr_ttl}) \s*
                \)?
              /ix
           ttl = @soa[:ttl] || $2 || ''
           @soa[:origin] = $1
           @soa[:ttl] = ttl
           @soa[:primary] = $4
           @soa[:email] = $5
           @soa[:serial] = $6
           @soa[:refresh] = $7
           @soa[:retry] = $8
           @soa[:expire] = $9
           @soa[:minimumTTL] = $10

   elsif line=~ /^(#{valid_name})? \s*
               #{ttl_cls}
               PTR \s+
               (#{valid_name})
              /ix
           add_record('ptr', :name => $1, :class => $3, :ttl => $2, :host => $4)
   elsif line =~ /^(#{valid_name})? \s* #{ttl_cls} TXT \s+ (.*)$/ix
            add_record('txt', :name => $1, :ttl => $2, :class => $3, :text => $4.strip)
   elsif line =~ /\$TTL\s+(#{rr_ttl})/i 
           @ttl = $1
   end
end