redzone 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGIzOTRjZmY0MmE1YmNmYTA0YjFlODAxYzY5NzgxNDg0YmI5ODc3MA==
+  data.tar.gz: !binary |-
+    YWY5OGI0YzMyOWNjMGNjOWY4ZThkOGJkMmJjMzBmNzYzYzRjNWQyMQ==
+SHA512:
+  metadata.gz: !binary |-
+    NTI0Y2ZhZjhmMTg3Y2VkODc3MDBhMDY0N2VlZmRjODhiMWJkODgxOTU3MmZk
+    NzBkZTYwNzk0ODVlYzBlNzYxNGViN2EzZjQwOTlhZTI2NTgzNmY2MzczM2My
+    ZDg4NjFmYTM5NzE0YmQ4MDRiZjI5NzdjOWM1ZWM4N2E1YTgwNWE=
+  data.tar.gz: !binary |-
+    MTYzMTc3YjRkNjA2OTA3YjVhY2Q4ZDRjOTk2ZDkyYzJmZGFhNzY2ZTkzY2Qx
+    NTVjMzk5NTU5ODAxODQ1N2Y3ZjVmZTg0N2VlMGI5OWI2MmUzODM3NmVlNzcy
+    MDQzOGY4MTAzZDRmZTE0YmU1NGNlODYzNjlmYTViOTE2ZTYxZDk=

data/.gitignore

@@ -0,0 +1,11 @@
+/.idea/
+/.yardoc/
+/.bundle/
+/pkg/
+Gemfile.lock
+.DS_Store
+/tmp/
+/doc/
+/features/reports
+/spec/reports
+/vendor/

data/Gemfile

@@ -0,0 +1,17 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'cucumber'
+  gem 'mocha', :require => 'mocha/api'
+  gem 'ci_reporter'
+  gem 'aruba'
+end
+
+group :development do
+  gem 'yard'
+  gem 'redcarpet', '~> 2.3.0'
+end

data/LICENSE.md

@@ -0,0 +1,10 @@
+# @markup markdown
+# @title MIT License
+
+Copyright (C) 2014 Justen Walker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# RedZone - Generate BIND zone files from simple YAML syntax
+
+Introduction
+------------
+
+RedZone is a command-line utility for generating BIND DNS zone files from a YAML file. The tools follows the
+UNIX philosophy and therefore does not attempt to do anything besides this.
+
+RedZone was inspired by Daniel P. Berrange's [NoZone](http://search.cpan.org/~danberr/NoZone-1.0/lib/NoZone.pm) i
+script which does something very similar in Perl.
+The notable differences are:
+ - Added support for reverse-dns generation
+ - Removed zone inheritance, opting instead to just
+   use a common section from which all zones inherit details.
+ - No generation of named.conf.
+
+Disclaimer
+----------
+
+This gem was just released (pre 1.0) and probably doesn't have everything (or anything) you want yet.
+
+During pre 1.0, things may change that break backwards compatibility between releases. Most likely these breaking
+changes would be related to the YAML file syntax.
+
+### Current TODO List
+
+- More test coverage for existing features
+
+Installation
+------------
+
+TODO: Publish to RubyGems.org
+
+Usage
+-----
+
+```
+RedZone commands:
+  redzone generate DIR    # Generates a bind database files into the given directory.
+  redzone help [COMMAND]  # Describe available commands or one specific command
+  redzone version         # Shows the current version of redzone
+
+Options:
+  [--zones=ZONES]  # RedZone zone file. (Default: /etc/redzone/zones.yml)
+```
+
+### Generating zone databases
+
+- Create a zones.yml file (See [zones.yml.example]) in `/etc/redzone`
+- Execute `redzone generate /var/named`
+- Each zone and reverse record database should be present in /var/named
+
+For example, if your zone.yml file is like the zones.yml.example file
+then the resulting db files are:
+- `0.0.0.0.0.0.0.0.0.0.c.f.ip6.arpa.db`
+- `1.168.192.in-addr.arpa.db`
+- `32.12.in-addr.arpa.db`
+- `9.8.7.6.4.3.2.1.1.0.0.2.ip6.arpa.db`
+- `qa.redzone.com.db`
+- `redzone.com.db`
+
+How to Contribute
+-----------------
+
+### Running the tests
+
+    $ bundle
+    $ bundle exec rake spec
+
+### Installing locally
+
+    $ bundle
+    $ [bundle exec] rake install
+
+### Reporting Issues
+
+Please include a reproducible test case.
+
+License
+-------
+
+Copyright (c) 2013 Justen Walker.
+
+Released under the terms of the MIT License. For further information, please see the file [LICENSE.md].

data/Rakefile

@@ -0,0 +1,32 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require "yard"
+
+yard_files = ['lib/**/*.rb','-','LICENSE.md']
+yard_opts  = [ 
+    '--markup', 'markdown',
+    '--markup-provider', 'redcarpet',
+    '--readme', 'README.md',
+    '--no-private',
+    '--exclude', 'lib/*/cli.rb'
+]
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = yard_files
+  t.options = yard_opts
+end
+task :yard_server => [:yard] do
+  system "yard server --reload"
+end
+begin
+  require 'ci/reporter/rake/rspec'
+rescue LoadError
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/unit/**/*_spec.rb"
+end
+
+task :default do
+  sh %{rake -T}
+end

data/bin/redzone

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+
+lib = File.expand_path('../../lib',__FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'redzone/cli'
+RedZone::Cli.start(ARGV)

data/lib/redzone/arpa.rb

@@ -0,0 +1,66 @@
+require 'ipaddr'
+
+module RedZone
+  # Arpa definition
+  class Arpa
+    # Reverse DNS name 
+    # @return [String] dns name
+    attr_reader :name
+
+    # Network
+    # @return [IPAddr]
+    attr_reader :network
+
+    # Get the list of PTR records
+    # @return [Array<Record>] PTR records
+    attr_reader :records
+
+    # Constructs a new MailExchange entry
+    # @param [Hash<String, SOA>] opt
+    # @option opt [String] :name Arpa DNS name (Required)
+    # @option opt [String] :network IP address with network mask (Required)
+    # @option opt [SOA,String] :soa SOA record  (Required)
+    def initialize(opt) 
+      raise ArgumentError, ':name is required' unless opt.has_key?(:name)
+      raise ArgumentError, ':network is required' unless opt.has_key?(:network)
+      raise ArgumentError, ':soa is required' unless opt.has_key?(:soa)
+      @name     = opt[:name]
+      @network  = IPAddr.new(opt[:network])
+      @soa      = opt[:soa]
+      @records  = []
+    end
+
+    # Writes the Arpa to the given IO stream
+    # @param [IO] io IO Stream
+    def write(io)
+      io << @soa
+      @records.each do |r|
+        io << r
+      end
+      io << "\n"
+    end
+
+    # Adds a machine to the arpa network for reverse-address lookup
+    # only if the machine is in this network.
+    # @param [Machine] machine
+    # @param [String] domain name
+    def add(machine,domain)
+      fqdn   = "#{machine.name}.#{domain}."
+      substr = ".#{@name}"
+      if @network.ipv4? and machine.ipv4? and @network.include?(machine.ipv4)
+        ip = machine.ipv4.reverse
+        ip.slice!(substr)
+        records   << Record.new(:name => ip, :type => "PTR", :data => fqdn, :comment => "Machine #{machine.name}")
+      end
+      if @network.ipv6? and machine.ipv6? and @network.include?(machine.ipv6)
+        ip = machine.ipv6.ip6_arpa
+        ip.slice!(substr)
+        records   << Record.new(:name => ip, :type => "PTR", :data => fqdn, :comment => "Machine #{machine.name}")
+      end
+    end
+
+    def add_record(record)
+      records << record
+    end
+  end
+end

data/lib/redzone/cli.rb

@@ -0,0 +1,33 @@
+require 'thor'
+
+require 'redzone/zone_config'
+require 'redzone/zonefile_writer'
+require 'redzone/environment'
+module RedZone
+  # RedZone Command-line actions
+  class Cli < Thor
+    package_name 'RedZone'
+    class_option :zones, :type => :string, :desc => <<-eos.strip
+      RedZone zone file. (Default: #{RedZone::Environment.default_zonefile})
+    eos
+    #class_option :config, :type => :string, :desc => <<-eos.strip
+    #  RedZone configuration file. (Default: #{RedZone::Environment.default_configfile})
+    #eos
+  
+    desc 'generate DIR', <<-eos.strip
+      Generates a bind database files into the given directory.
+    eos
+    #  Generates a bind database files into the given directory.
+    def generate(dir)
+      c = ZoneConfig.new(options[:zones])
+      writer = ZonefileWriter.new(c)
+      writer.write_zones(Pathname.new(dir))
+    end
+    
+    desc 'version', 'Shows the current version of redzone'
+    # Prints the current RedZone version to the console
+    def version
+      say "redzone v#{RedZone::VERSION}"
+    end
+  end
+end

data/lib/redzone/environment.rb

@@ -0,0 +1,20 @@
+module RedZone
+  # RedZone environment properties
+  module Environment
+    # Get the default etc path
+    # @return [Pathname] default etc path
+    def self.default_etc
+      Pathname.new('/etc/redzone')
+    end
+    # Get the default location of the zone file
+    # @return [Pathname] default zones.yml path
+    def self.default_zonefile
+      self.default_etc.join('zones.yml')
+    end
+    # Get the default location of the config file
+    # @return [Pathname] default config.yml path
+    def self.default_configfile
+      self.default_etc.join('config.yml')
+    end
+ end
+end

data/lib/redzone/lifetime.rb

@@ -0,0 +1,55 @@
+module RedZone
+  # Simple time parser for TTL/SOA lifetimes
+  #
+  # The simple time format format is a number followed by a time unit.
+  #
+  # ie: `<Number> [Unit]`
+  #
+  # Where the `Unit` is one of
+  #
+  # - `M`: Minute(s)
+  # - `H`: Hour(s)
+  # - `D`: Day(s)
+  # - `W`: Week(s)
+  #
+  # If the units are missing, it is assumed to be in seconds
+  # 
+  class Lifetime
+    # Constructs a lifetime object from a string
+    # @param [String] str time stirng
+    def initialize(str)
+      if str.upcase =~ /([0-9]+)\s*([HDWM]?)/
+        i    = $1.to_i
+        pl   = "s" if i > 1
+        pl ||= ""
+        time = case $2
+          when 'H' then [i * 3600,"#{i} Hour#{pl}"]
+          when 'D' then [i * 86400,"#{i} Day#{pl}"]
+          when 'M' then [i * 60,"#{i} Minute#{pl}"]
+          when 'W' then [i * 604800,"#{i} Week#{pl}"]
+          else [i,"#{i} Second#{pl}"]
+        end
+        @time = time.first
+        @str  = time.last
+      end
+    end
+    # Returns the lifetime as seconds
+    # @return [Integer] seconds
+    def seconds
+      @time
+    end
+    # Returns the string representaton of the lifetime
+    #
+    # Examples:
+    #
+    # - 300 Seconds
+    # - 1 Minute
+    # - 2 Hours
+    # - 1 Day
+    # - 2 Weeks
+    # @return [String]
+    def to_s
+      @str
+    end
+  end
+end

data/lib/redzone/machine.rb

@@ -0,0 +1,70 @@
+require 'ipaddr'
+
+module RedZone
+  # Machine entry
+  # @attr [String] name Relative domain name
+  # @attr [IPAddr] ipv4 IPV4 Address
+  # @attr [IPAddr] ipv6 IPV6 Address
+  class Machine
+    attr_reader :name,:ipv4,:ipv6
+    # Construct a new machine entry
+    # @param [String] name Relative domain name
+    # @param [Hash] config Machine configuration
+    # @option config [String] :ipv4 IPV4 Address
+    # @option config [String] :ipv6 IPV6 Address
+    def initialize(name,config) 
+      @name  = name
+      if config.is_a? Hash
+        @alias = nil
+        @ipv4  = IPAddr.new(config[:ipv4]) if config.has_key?(:ipv4)
+        @ipv6  = IPAddr.new(config[:ipv6]) if config.has_key?(:ipv6)
+      elsif config.is_a? Machine
+        @alias = config
+        @ipv4  = config.ipv4
+        @ipv6  = config.ipv6
+      end
+    end
+    # Returns true if this machine is an alias of another
+    # @return [Boolean] true if the machine is an alias
+    def alias? 
+      not @alias.nil?
+    end
+    # Returns a new machine that is an alias of this machine.
+    # If this machine is already an alias, it delegates this call
+    # to the aliased machine rather than this one.
+    # @return [Machine]
+    def alias(name)
+      if @alias.nil?
+        Machine.new(name,self)
+      else
+        @alias.alias(name)
+      end
+    end
+    # Test if the machine has an ipv4 address
+    # @return [Boolean] if the machine has an ipv4 address
+    def ipv4?
+      not @ipv4.nil?
+    end
+    # Test if the machine has an ipv6 address
+    # @return [Boolean] if the machine has an ipv6 address
+    def ipv6?
+      not @ipv6.nil?
+    end
+    # Get the list of A/AAAA records
+    # @return [Array<Record>]
+    def records
+      r = []
+      comment = "Machine #{@alias.name}" if not @alias.nil?
+      if ipv4?
+        ipv4opt = {:name => @name, :data => @ipv4.to_s, :type => 'A', :comment => comment }
+        r << Record.new(ipv4opt)
+      end
+      if ipv6?
+
+        ipv6opt = {:name => @name, :data => @ipv6.to_s, :type => 'AAAA', :comment => comment }
+        r << Record.new(ipv6opt)
+      end
+      r
+    end
+  end
+end

data/lib/redzone/mail_exchange.rb

@@ -0,0 +1,28 @@
+module RedZone
+  # A mail server record
+  class MailExchange
+    # MX Server name / alias
+    attr_reader :name
+
+    # Get the target machine hosting the mail exchange
+    attr_reader :machine
+    
+    # MX Priority
+    attr_reader :priority
+ 
+    # Constructs a new MailExchange entry
+    # @param [String]  name Server name / alias
+    # @param [Machine] machine Target machine
+    # @param [Integer] priority MX priority setting
+    def initialize(name,machine,priority) 
+      @name     = name
+      @machine  = machine.alias(@name)
+      @priority = priority
+    end
+    # Get the list of MX records
+    # @return [Array<Record>]
+    def records
+      [Record.new(:name => "@", :type => "MX", :data => "#{@priority} #{@name}")]
+    end
+  end
+end

data/lib/redzone/name_server.rb

@@ -0,0 +1,24 @@
+module RedZone
+  # NameServer record
+  class NameServer
+    # Name Server name / alias
+    attr_reader :name
+
+    # Get the target machine hosting the name server
+    attr_reader :machine
+
+    # Constructs a new NameServer
+    # @param [String]  name Server name / alias
+    # @param [Machine] machine Target machine
+    def initialize(name,machine) 
+      @name     = name
+      @machine  = machine.alias(@name)
+    end
+
+    # Get the list of NS records
+    # @return [Array<Record>]
+    def records
+      [Record.new(:name => "@", :type => "NS", :data => "#{@name}")]
+    end
+  end
+end

data/lib/redzone/record.rb

@@ -0,0 +1,37 @@
+require 'redzone/lifetime'
+module RedZone
+  # DNS Record
+  class Record
+    # Returns a new instance of a domain record
+    # @param [Hash] record
+    # @option record [String] :name    The record name (Required)
+    # @option record [String] :class   ('IN') The record class. (Optional)
+    # @option record [String] :ttl     The ttl for the record (Optional)
+    # @option record [String] :type    The type of record, eg: CNAME, A, AAAA. (Required)
+    # @option record [String] :data    The record data (Required)
+    # @option record [String] :comment A comment for the record
+    def initialize(record)
+      raise ArgumentError, ':name is required' unless record.has_key?(:name)
+      raise ArgumentError, ':type is required' unless record.has_key?(:type)
+      raise ArgumentError, ':data is required' unless record.has_key?(:data) 
+      @name    = record[:name]
+      @class   = record[:class] || 'IN'
+      @type    = record[:type]
+      if record.has_key?(:ttl) and not record[:ttl].nil?
+        @ttl     = Lifetime.new(record[:ttl]).seconds
+      end
+      @data    = record[:data]
+      if @type == "TXT"
+        @data = '"%s"' % [@data.gsub(/^\s*"?|"?\s*$/,'').gsub(/\n/,'')]
+      end
+      if record.has_key?(:comment) and not record[:comment].nil?
+        @comment = " ; %s" % [record[:comment]]
+      end
+    end
+    # Returns the domain record as a string to be written in the zone file
+    # @return [String] record line
+    def to_s
+      "%-20s %-8s %s    %-8s %-20s%s\n" % [@name, @ttl, @class, @type, @data, @comment || '']
+    end
+  end
+end

data/lib/redzone/soa.rb

@@ -0,0 +1,64 @@
+require 'redzone/lifetime'
+module RedZone
+  # A DNS Start of Authority (SOA) record
+  #
+  # Example
+  # -------
+  #
+  #
+  #        $ORIGIN  example.com.
+  #        $TTL     3600 ; TTL = 1 Hour
+  #        @        IN    SOA    ns1    hostmaster.example.com. (
+  #                       20140104 ; sn  = serial number
+  #                       3600 ; ref = refresh = 1 Hour
+  #                       600 ; rt  = update retry = 10 Minutes
+  #                       86400 ; ex  = expiry = 1 Day
+  #        )
+  #
+  class SOA
+    # Returns a new instance of a zone SOA record
+    # @param [Hash] opts
+    # @option opts [String] :domain     Zone (domain) name
+    # @option opts [String] :ns         Primary name server
+    # @option opts [String] :hostmaster Email address of the zone file maintainer ('@' replaced by '.')
+    # @option opts [String] :refresh    Time between refreshes from slave servers
+    # @option opts [String] :retry      Time between retrying failed zone transfers
+    # @option opts [String] :expire     The maximum time that a secondary server will keep trying to complete a zone transfer.
+    # @option opts [String] :ttl        The minimum time-to-live that applies to all resource records in the zone file
+    def initialize(opts)
+      @domain     = opts[:domain]
+      @ns         = opts[:ns]
+      @hostmaster = escape(opts[:hostmaster]   || "hostmaster.#{@domain}") 
+      @ttl        = Lifetime.new(opts[:ttl]     || '1H')
+      @refresh    = Lifetime.new(opts[:refresh] || '1H')
+      @retry      = Lifetime.new(opts[:retry]   || '10M')
+      @expire     = Lifetime.new(opts[:expire]  || '1D')
+    end
+    # Returns the SOA record with the serial set to the current unix timestamp
+    # @return [String] SOA Record
+    def to_s
+      to_soa(Time.now.to_i)
+    end
+
+    # Returns the SOA record with the given serial number
+    # @param [Integer] serial Serial number (Usually YYYYMMDDnn)
+    # @return [String] SOA Record
+    def to_soa(serial)
+      io = StringIO.new
+      io << "$ORIGIN  #{@domain}.\n"
+      io << "$TTL     #{@ttl.seconds} ; TTL = #{@ttl}\n"
+      io << "@        IN    SOA    #{@ns}    #{@hostmaster} (\n"
+      io << "               %-10s ; sn  = serial number\n" % [serial]
+      io << "               %-10s ; ref = refresh = %s\n"  % [@refresh.seconds,@refresh] 
+      io << "               %-10s ; rt  = retry   = %s\n"  % [@retry.seconds,@retry]
+      io << "               %-10s ; ex  = expiry  = %s\n"  % [@expire.seconds,@expire]
+      io << "               %-10s ; ttl = %s\n"  % [@ttl.seconds,@ttl]
+      io << ")\n\n"
+      io.string
+    end
+    private 
+    def escape(email)
+      email.gsub(/@/,'.')
+    end
+  end
+end

data/lib/redzone/version.rb

@@ -0,0 +1,6 @@
+# Red Zone module
+#
+module RedZone
+  # Current version of RedZone
+  VERSION = '0.0.1'
+end