dns-catalog_zone 0.1.3

data/lib/dns/catalog_zone/catalog_zone.rb

@@ -0,0 +1,125 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 Manabu Sonoda
+#
+# 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.
+
+require 'digest/sha1'
+
+module Dns
+  module CatalogZone
+    # for catalog zone
+    class CatalogZone
+      include Dns::CatalogZone
+      include Dns::CatalogZone::ZoneHelper
+
+      attr_reader :masters, :notifies, :allow_transfers
+      attr_reader :zones
+
+      # initialize zone
+      def initialize(zonename, rrsets)
+        @rrsets = rrsets
+        @zonename = Dnsruby::Name.create(zonename).to_s + '.'
+        @zones = {}
+        @templates = {}
+        @masters = {}
+        @notifies = {}
+        @allow_transfers = {}
+
+        version_name = Dnsruby::Name.create("version.#{@zonename}")
+        masters_name = Dnsruby::Name.create("masters.#{@zonename}")
+        notifies_name = Dnsruby::Name.create("notifies.#{@zonename}")
+        transfer_name = Dnsruby::Name.create("allow-transfer.#{@zonename}")
+
+        @rrsets.each do |rr|
+          # version
+          if rr.name == version_name && rr.type == Dnsruby::Types::TXT
+            @version = rr.strings.join('')
+          end
+          # global master option
+          add_masters(rr, '.') if rr.name == masters_name
+          add_masters(rr, rr.name.labels[0]) if rr.name.subdomain_of?(masters_name)
+
+          # global notify option
+          add_notifies(rr, '.') if rr.name == notifies_name
+          add_notifies(rr, rr.name.labels[0]) if rr.name.subdomain_of?(notifies_name)
+
+          # global allow-transfer option
+          add_allow_transfers(rr, '.') if rr.name == transfer_name
+          add_allow_transfers(rr, rr.name.labels[0]) if rr.name.subdomain_of?(transfer_name)
+        end
+        case @version
+        when '1'
+          parse_v1
+        else
+          raise ValidateError, "#{@version} is unknown Catalog zone schema version"
+        end
+      end
+
+      private
+
+      def parse_zones
+        zones_str = Dnsruby::Name.create("zones.#{@zonename}")
+        # step 1 load zones
+        @rrsets.each do |rr|
+          next unless rr.name.subdomain_of?(zones_str)
+          next unless rr.type == Dnsruby::Types::PTR
+          mhash = Digest::SHA1.hexdigest(rr.domainname.canonical)
+          if mhash != rr.name.labels[0].to_s
+            raise ValidateError, "#{rr.name.labels[0]} PTR #{mhash} is not equal hash."
+          end
+          @zones[rr.name.labels[0].to_s] = Dns::CatalogZone::Zone.new(rr.domainname)
+        end
+      end
+
+      def parse_zones_options
+        zones_name = Dnsruby::Name.create("zones.#{@zonename}")
+        @rrsets.each do |rr|
+          next unless rr.name.subdomain_of?(zones_name)
+          label = type = mhash = nil
+          if @zones[rr.name.labels[1].to_s]
+            label = '.'
+            type = rr.name.labels[0].to_s
+            mhash = rr.name.labels[1].to_s
+          elsif @zones[rr.name.labels[2].to_s]
+            label = rr.name.labels[0].to_s
+            type = rr.name.labels[1].to_s
+            mhash = rr.name.labels[2].to_s
+          end
+
+          case type
+          when 'masters'
+            @zones[mhash].add_masters(rr, label)
+          when 'notifies'
+            @zones[mhash].add_notifies(rr, label)
+          when 'allow-transfer'
+            @zones[mhash].add_allow_transfers(rr, label)
+          end
+        end
+      end
+
+      def parse_v1
+        # step 1 load zones
+        parse_zones
+        # step 2 load options
+        parse_zones_options
+      end
+    end
+  end
+end

data/lib/dns/catalog_zone/cli.rb

@@ -0,0 +1,88 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 Manabu Sonoda
+#
+# 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.
+
+require 'dns/catalog_zone'
+require 'thor'
+
+# The Cli class is used to catz cli application
+module Dns
+  module CatalogZone
+    class Cli < Thor
+      desc 'init', 'initializes a new environment by creating a CatalogZone'
+      def init(_zonename = 'catalog.example', _type = 'file')
+        unless File.exist? 'CatalogZone'
+          FileUtils.cp Dns::CatalogZone.root_path + '/share/CatalogZone', 'CatalogZone'
+        end
+      end
+      desc 'list', 'list setting'
+      def list
+        read_config
+        puts "name\tsource\tsoftware\tzonename\n"
+        @config.settings.each do |setting|
+          puts "#{setting.name}\t#{setting.source}\t" \
+               "#{setting.software}\t\t#{setting.zonename}\n"
+        end
+      end
+      desc 'checkconf [setting]', 'check config'
+      def checkconf(name = nil)
+        read_config
+        @config.settings.each do |setting|
+          next unless name == setting.name || name.nil?
+          setting.validate
+        end
+      end
+      desc 'make [setting]', 'make config file'
+      def make(name = nil)
+        read_config
+        @config.settings.each do |setting|
+          next unless name == setting.name || name.nil?
+          setting.validate
+          catalog_zone = make_CatalogZone(setting)
+          provider = make_config(setting, catalog_zone)
+          output(setting, provider)
+        end
+      end
+
+      private
+
+      def read_config
+        @config = Dns::CatalogZone::Config.read
+      end
+
+      def make_CatalogZone(setting)
+        source = Dns::CatalogZone::Source.create(setting)
+        Dns::CatalogZone::CatalogZone.new(setting.zonename, source.get)
+      end
+
+      def make_config(setting, catalog_zone)
+        provider = Dns::CatalogZone::Provider.create(setting)
+        provider.make(catalog_zone)
+        provider
+      end
+
+      def output(setting, provider)
+        output = Dns::CatalogZone::Output.create(setting)
+        output.output(provider.write)
+      end
+    end
+  end
+end

data/lib/dns/catalog_zone/config.rb

@@ -0,0 +1,83 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 Manabu Sonoda
+#
+# 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.
+
+module Dns
+  module CatalogZone
+    # The Setting class is basic config class
+    class Setting
+      def initialize(name)
+        @attributes = { 'name' => name, 'software' => 'nsd',
+                        'source' => 'file', 'output' => 'stdout',
+                        'zonename' => 'catalog.example', 'zonepath' => '%s',
+                        'output_path' => 'catalog.conf', 'port' => 53,
+                        'timeout' => 30 }
+      end
+
+      def method_missing(method_name, *params)
+        name = method_name.to_s
+        if (md = name.to_s.match(/([a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9])=$/))
+          @attributes[md[1]] = params[0]
+        elsif name.to_s =~ /([a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9])$/
+          @attributes[name]
+        else
+          raise ValidateError
+        end
+      end
+
+      def validate
+        Source.create(self).validate
+        Provider.create(self).validate
+        Output.create(self).validate
+      end
+    end
+
+    # The Config class is aggregative config class
+    class Config
+      attr_reader :settings
+      class << self
+        def read(filename = 'CatalogZone')
+          raise ConfigNotFound unless File.exist?(filename)
+          config = Config.new
+          config_str = ''
+          File.open(filename) do |file|
+            config_str = file.read
+          end
+          config.instance_eval config_str, filename
+          config
+        end
+      end
+      def initialize
+        @settings = []
+      end
+
+      def setting(name)
+        setting = Setting.new(name)
+        yield(setting)
+        @settings.push(setting)
+      end
+
+      def validate
+        @settings.each(&:validate)
+      end
+    end
+  end
+end

data/lib/dns/catalog_zone/errors.rb

@@ -0,0 +1,32 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 Manabu Sonoda
+#
+# 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.
+
+module Dns
+  module CatalogZone
+    class ConfigNotFound < RuntimeError; end
+    class ValidateError < RuntimeError; end
+    class CantOutput < RuntimeError; end
+    class AxfrError < RuntimeError; end
+    class TimeoutError < RuntimeError; end
+    class ZonePraseError < RuntimeError; end
+  end
+end

data/lib/dns/catalog_zone/helper.rb

@@ -0,0 +1,98 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 Manabu Sonoda
+#
+# 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.
+
+require 'camelizable'
+require 'digest/sha1'
+
+# add camelizable
+class String
+  include Camelizable
+end
+
+module Dns
+  # CatalogZone module
+  module CatalogZone
+    class << self
+      def root_path
+        File.expand_path('../../../../', __FILE__)
+      end
+
+      # %s zone name
+      # %h zone hash
+      # %S(1) first character %S(2) second character %S(3) third character
+      # %L(1) top label %L(2) second label
+      # %H(1) zone name hash 1 character
+      # %H(2) zone name hash 2 character
+      def convert_path(format, zonename)
+        mhash = Digest::SHA1.hexdigest(zonename.canonical)
+        path = format.clone
+        path.gsub!(/%S\(1\)/, zonename.to_s[0])
+        path.gsub!(/%S\(2\)/, zonename.to_s[1])
+        path.gsub!(/%S\(3\)/, zonename.to_s[2])
+        path.gsub!(/%L\(1\)/, zonename.labels[zonename.labels.size - 1].to_s)
+        path.gsub!(/%L\(2\)/, zonename.labels[zonename.labels.size - 2].to_s)
+        path.gsub!(/%H\(1\)/, mhash[0])
+        path.gsub!(/%H\(2\)/, mhash[1])
+        path.gsub!(/%s/, zonename.to_s)
+        path.gsub!(/%h/, mhash)
+        path
+      end
+    end
+    def host_rr?(rr)
+      rr.type == Dnsruby::Types.A || rr.type == Dnsruby::Types.AAAA
+    end
+
+    def txt_rr?(rr)
+      rr.type == Dnsruby::Types.TXT
+    end
+
+    def ptr_rr?(rr)
+      rr.type == Dnsruby::Types.PTR
+    end
+
+    def apl_rr?(rr)
+      rr.type == Dnsruby::Types.APL
+    end
+  end
+end
+
+module Dns
+  module CatalogZone
+    # ZoneHelper module
+    module ZoneHelper
+      def add_masters(rr, label)
+        @masters[label] = Dns::CatalogZone::Master.new unless @masters[label]
+        @masters[label].parse_master(rr)
+      end
+
+      def add_notifies(rr, label)
+        @notifies[label] = Dns::CatalogZone::Master.new unless @notifies[label]
+        @notifies[label].parse_master(rr)
+      end
+
+      def add_allow_transfers(rr, label)
+        @allow_transfers[label] = Dns::CatalogZone::Prefixes.new unless @allow_transfers[label]
+        @allow_transfers[label].parse_apl(rr)
+      end
+    end
+  end
+end

data/lib/dns/catalog_zone/master.rb

@@ -0,0 +1,47 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 Manabu Sonoda
+#
+# 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.
+
+module Dns
+  module CatalogZone
+    # Master class
+    class Master
+      include Dns::CatalogZone
+      attr_accessor :tsig, :port
+      attr_reader :addresses
+      def initialize(addresses = [], port = 53, tsig = nil)
+        @addresses = addresses
+        @port = port
+        @tsig = tsig
+      end
+
+      def add_address(address)
+        @addresses.push(address)
+        self
+      end
+
+      def parse_master(rr)
+        add_address(rr.rdata_to_string) if host_rr?(rr)
+        self.tsig = rr.strings.join('') if txt_rr?(rr)
+      end
+    end
+  end
+end