dns_one 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f453b1c3de16a0ad2b5554fe8523ec273d0a357b
-  data.tar.gz: 9f1c9f5f11051b485b4240928499480e4debaea7
+  metadata.gz: 34e353b91f2c725a06a2bc095d1990e48e0ab914
+  data.tar.gz: dbed7b26aa08686cfceafd0dbd659df692dd5aef
 SHA512:
-  metadata.gz: 3b01bc36084734be73f3261f57506e535080f386893a459bf98f16c49873a355d292d64eda5680cceaa216d23db02369518b8e22d0f3de128e1f0217112b8e6d
-  data.tar.gz: d04807c66a45320c7a3038deae8f73011ff304bee095483ac6866226a6ef125f6125b52570210e3aded4ceeae6d57a7ac3d9bf7e4d2f35eca3630e074038579c
+  metadata.gz: 1e5cbbad25694937f59a0e2b4271b3ea2f180264b6f11f4d7209d2d5f4f51b1e69e2c511fbea333e0e768cb645db3160e30adfc028d2f23dc56edb2b6195c654
+  data.tar.gz: b59b7281f46ad5233461d07bb62ff8e6973bf51dea119a089a7d883699bb671200d79b1a7890213ca0dc71897c417409715511f837a4f32210bfe1e22c29acba

data/lib/dns_one/backend/db.rb

@@ -1,7 +1,7 @@
 module Backend; class BackendDB
     def initialize conf
         @query = conf.delete :query
-        @db_conf = conf
+        @conf = conf
         setup_db
     end
 
@@ -44,7 +44,27 @@ module Backend; class BackendDB
 
     def setup_db
         ActiveRecord::Base.logger = Log.logger
-        ActiveRecord::Base.establish_connection @db_conf
+
+        gem_name = { 
+            'postgresql' => 'pg',
+            'mysql'      => 'mysql',
+            'mysql2'     => 'mysql2'
+        }[ @conf[:adapter] ]
+          
+        unless gem_name
+            Util.die "Database adapter '#{@conf[:adapter]}' not supported. Aborting."
+        end
+
+        begin
+            require gem_name.to_s
+
+        rescue LoadError => e
+            Util.die "Error loading database dependency.\nMake sure #{gem_name} it is installed, if it is not, install with 'gem install #{gem_name}'\nError Details: #{e.desc}"
+        rescue => e
+            Util.die "Error loading database dependency.\n#{e.desc}"
+        end
+
+        ActiveRecord::Base.establish_connection @conf
     end
   
 end; end

data/lib/dns_one/cache.rb

@@ -18,5 +18,9 @@ module DnsOne; class Cache
     def find k
         @cache[k]
     end
+
+    def stat
+        "#{@cache.length}/#{@max_size}"
+    end
     
 end; end

data/lib/dns_one/cli.rb

@@ -10,8 +10,9 @@ class DnsOne::CLI < Thor
     desc "run", "run server"
     option :conf
     option :log
+    option :work_dir
     def run_srv
-        DnsOne::DnsOne.new(conf_file: options[:conf], log_file: options[:log]).start 
+        DnsOne::DnsOne.new(conf_file: options[:conf], log_file: options[:log], work_dir: options[:work_dir]).start 
     end
     default_task :run_srv
 

data/lib/dns_one/core_ext/blank.rb

@@ -0,0 +1,160 @@
+
+# activesupport-5.1.1/lib/active_support/core_ext/regexp.rb 
+
+class Regexp #:nodoc:
+  def multiline?
+    options & MULTILINE == MULTILINE
+  end
+
+  def match?(string, pos = 0)
+    !!match(string, pos)
+  end unless //.respond_to?(:match?)
+end
+
+# activesupport-5.1.1/lib/active_support/core_ext/object/blank.rb  
+
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, +false+, '', '   ', +nil+, [], and {} are all blank.
+  #
+  # This simplifies
+  #
+  #   !address || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class String
+  unless BLANK_RE
+    BLANK_RE = /\A[[:space:]]*\z/
+  end
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    # The regexp that matches blank strings is expensive. For the case of empty
+    # strings we can speed up this method (~3.5x) with an empty? call. The
+    # penalty for the rest of strings is marginal.
+    empty? || BLANK_RE.match?(self)
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Time #:nodoc:
+  # No Time is blank:
+  #
+  #   Time.now.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end

data/lib/dns_one/core_ext/exception.rb

@@ -0,0 +1,9 @@
+
+class Exception
+    def desc
+        "#{self.class}: #{ message }\n#{ backtrace&.join "\n" }"
+    end
+    def puts_stderr
+        STDERR.puts e.desc
+    end
+end

data/lib/dns_one/core_ext/string.rb

@@ -0,0 +1,13 @@
+
+class String
+    def to_a
+        [self]
+    end
+    def strip_text
+        split("\n")
+        .map{|l| l.strip}
+        .join("\n")
+    end
+end
+
+

data/lib/dns_one/log.rb

@@ -2,6 +2,7 @@
 class Log < Logger
     class << self
 
+        # 'def [d|i|w|e|f] msg' for DEBUG INFO WARN ERROR FATAL
         Logger::Severity::constants.each_with_index do |severity, severity_num|
             next if severity == :UNKNOWN
             method_name = severity.to_s[0].downcase
@@ -10,42 +11,67 @@ class Log < Logger
             end
         end
 
-        def setup file, syslog_name
+        def setup file, syslog_name, syslog_min_severity = Logger::WARN
+            @syslog_min_severity = syslog_min_severity
             @syslog = Syslog::Logger.new syslog_name
             @log_file = setfile file
             @logger = Logger.new @log_file
         end
 
-        def setfile file
-            if File.exists? file and File.writable? file
-                file
-            elsif File.writable? File.dirname(file)
-                file
+        def change_log_file file
+            new_log_file = setfile file, allow_stdout: false
+            if new_log_file and new_log_file != @log_file
+                @log_file = new_log_file
+                @logger = Logger.new @log_file
+            end
+        end
+
+        def exc e
+            e e.desc
+        end
+
+        def logger
+            @logger
+        end
+
+        def log_file_desc
+            case @log_file
+            when STDOUT
+                'STDOUT'
+            when STDERR
+                'STDERR'
             else
+                @log_file
+            end
+        end
+
+        private
+
+        def setfile file, allow_stdout: true
+            if [STDOUT, STDERR].include? file or
+               File.writable? file or
+               File.writable? File.dirname(file)
+                file
+            elsif allow_stdout
                 STDOUT
             end
         end
 
         def log severity, msg
             met_name = Logger::Severity::constants[severity].downcase
+
             @logger.send met_name, msg
-            if severity >= Logger::WARN
+
+            if severity >= @syslog_min_severity
                 @syslog.send met_name, msg
             end
+
             if severity == Logger::FATAL and 
                @log_file != STDOUT and 
                @log_file != STDERR
                 STDERR.puts msg
             end
         end
-
-        def exc e
-            e e.desc
-        end
-
-        def logger
-            @logger
-        end
     end
 end
 

data/lib/dns_one/server.rb

@@ -3,21 +3,23 @@ module DnsOne; class Server # < RExec::Daemon::Base
 
     DNS_DAEMON_RUN_AS = "dnsserver"
     DNS_DAEMON_INTERFACES = [
-        [:udp, "0.0.0.0", 153],
-        [:tcp, "0.0.0.0", 153],
-        [:udp, "::", 15300],
-        [:tcp, "::", 15300]
+        [:udp, "0.0.0.0", 53],
+        [:tcp, "0.0.0.0", 53],
+        [:udp, "::", 5300],
+        [:tcp, "::", 5300]
     ]
 
-    def initialize conf
-        ZoneSearch.instance.setup conf
+    def initialize conf, conf_zone_search
+        @conf = conf
+        ZoneSearch.instance.setup conf_zone_search
     end
 
     def run
+        conf = @conf
         RubyDNS::run_server(listen: dns_daemon_interfaces, logger: Log.logger) do
             on(:start) do
-                if RExec.current_user == 'root' and @conf.config.run_as
-                    RExec.change_user @conf.config.run_as
+                if RExec.current_user == 'root' and conf[:run_as]
+                    RExec.change_user conf[:run_as]
                 end
                 Log.i "Running as #{RExec.current_user}"
             end
@@ -42,7 +44,7 @@ module DnsOne; class Server # < RExec::Daemon::Base
     end
 
     def dns_daemon_interfaces
-        if Process.pid == 0
+        if RExec.current_user == 'root'
             DNS_DAEMON_INTERFACES
         else
             ports = DNS_DAEMON_INTERFACES.map do |port|

data/lib/dns_one/util.rb

@@ -22,4 +22,8 @@ module DnsOne; class Util; class << self
       end
   end
 
+  def match_root stat
+      stat.uid == 0 && stat.gid == 0
+  end
+
 end; end; end

data/lib/dns_one/version.rb

@@ -1,3 +1,3 @@
 module DnsOne
-    VERSION = "0.4.5"
+    VERSION = "0.4.7"
 end

data/lib/dns_one/zone_search.rb

@@ -9,10 +9,10 @@ module DnsOne; class ZoneSearch
         @conf = conf
         check_record_sets
         @backend = set_backend
-        @cache = Cache.new @conf.config[:cache_max]
+        @cache = Cache.new @conf[:cache_max]
 
         @ignore_subdomains_re = nil
-        if ignore_subdomains = @conf.config[:ignore_subdomains]
+        if ignore_subdomains = @conf[:ignore_subdomains]
             unless ignore_subdomains.empty?
                 subdoms = ignore_subdomains.strip.split(/\s+/).map(&:downcase).join('|')
                 @ignore_subdomains_re = /^(#{ subdoms })\./i
@@ -26,22 +26,24 @@ module DnsOne; class ZoneSearch
         Log.d "searching #{ dom_name }..."
 
         rec_set_name = find_record_set dom_name
-        Log.d "record set name #{ rec_set_name ? 'found' : 'not_found' }"
+        Log.d "record set name #{ rec_set_name ? 'found' : 'not found' } for #{dom_name} #{res_class}"
         rec_set_name or return
 
         if rec_set_name == ''
-            rec_set_name = @conf.record_sets.keys.first.to_s
+            rec_set_name = @conf[:ecord_sets].keys.first.to_s
         end
 
-        rec_set = @conf.record_sets[rec_set_name.to_sym]
-        Log.d "record set #{ rec_set ? 'found' : 'not found' }"
+        rec_set = @conf[:record_sets][rec_set_name.to_sym]
+        Log.d "record set #{ rec_set ? 'found' : 'not found' } for #{dom_name} #{res_class}"
         rec_set or return
 
         answer = nil
 
         unless res_class == IN::NS
-            answer = rec_set[ res_class.to_s.split('::').last.to_sym ]
-            answer = [answer] unless answer.is_a? Array
+            if rec = rec_set[ res_class.to_s.split('::').last.to_sym ]
+                answer = rec
+                answer = [answer] unless answer.is_a? Array
+            end
         end
 
         other_records = []
@@ -57,13 +59,13 @@ module DnsOne; class ZoneSearch
     private
 
     def set_backend
-        if file = @conf.backend[:file]
+        if file = @conf[:backend][:file]
             unless File.exists? file
                 Util.die "Domain list file #{file} not found."
             end
             Backend::BackendFile.new file          
         else
-            Backend::BackendDB.new @conf.backend
+            Backend::BackendDB.new @conf[:backend]
         end
     end
 
@@ -83,7 +85,7 @@ module DnsOne; class ZoneSearch
         enabled_cache = use_cache && @backend.allow_cache
 
         if enabled_cache and rec_set = @cache.find(dom_name)
-            Log.d "found in cache"
+            Log.d "found in cache (#{@cache.stat})"
             rec_set
         else
             if rec_set = @backend.find(dom_name)
@@ -96,11 +98,11 @@ module DnsOne; class ZoneSearch
     end
 
     def check_record_sets
-        unless @conf.record_sets and not @conf.record_sets.empty?
+        if @conf[:record_sets].blank?
             Util.die "Record sets cannot be empty. Check file."
         end
 
-        @conf.record_sets.each_pair do |rec_set_name, records|
+        @conf[:record_sets].each_pair do |rec_set_name, records|
             unless records[:NS] and records[:NS].length >= 1
                 Util.die "Record set #{rec_set_name} is invalid. It must have at least 1 NS record."
             end

data/lib/dns_one.rb

@@ -10,7 +10,10 @@ require 'rexec'
 
 # DnsOne
 
-require "dns_one/core_extensions"
+require "dns_one/core_ext/exception"
+require "dns_one/core_ext/string"
+require "dns_one/core_ext/blank"
+
 require "dns_one/log"
 require "dns_one/util"
 
@@ -24,30 +27,42 @@ require 'dns_one/backend/db'
 
 module DnsOne; class DnsOne
 
-	DEFAULT_LOG_FILE = "/var/log/dns_server.log"
+	DEFAULT_LOG_FILE = "/var/log/dns_one.log"
 	DEFAULT_CONF_FILE = '/etc/dns_one/conf.yml'
-	WORK_DIR = "/var/local/dnsserver"
+	WORK_DIR = "/var/local/dns_one"
 
 	CONF_DIR = "/etc/dns_one"
 	SYSLOG_NAME = 'dns_one'
 
-	def initialize conf_file: nil, log_file: nil
-		log_file  ||= DEFAULT_LOG_FILE
-		conf_file ||= DEFAULT_CONF_FILE
-
+	def initialize conf_file: nil, log_file: nil, work_dir: nil
+		cmd_log_file = log_file
+		log_file ||= DEFAULT_LOG_FILE
 		Log.setup log_file, SYSLOG_NAME
-		@conf = parse_conf conf_file
 
-		# check_root
+		conf_file ||= DEFAULT_CONF_FILE
+		@conf_all = parse_conf conf_file
+		@conf = @conf_all.main
+
+		work_dir ||= WORK_DIR
+
+		# Redefine log file if set in conf file
+		unless cmd_log_file
+			if f = @conf[:log_file].presence 
+				unless Log.change_log_file f
+					Log.w "Unable to change logfile to #{f}. Will continue with #{Log.log_file_desc}."
+				end
+			end
+		end
+
 		begin
-			Dir.chdir (@conf.config[:work_dir] || WORK_DIR)
+			Dir.chdir work_dir
 		rescue => e
 			Log.w "Cannot change working dir to #{WORK_DIR}. Will continue in #{Dir.pwd}."
 		end
 	end
 
 	def start
-		Server.new(@conf).run 
+		Server.new(@conf_all.server, @conf_all.zone_search).run 
 	end
 
 	private
@@ -58,9 +73,21 @@ module DnsOne; class DnsOne
 		conf = YAML.load_file conf_file
 		conf.deep_symbolize_keys!
 
-		conf[:config] ||= {}
-
-		OpenStruct.new conf
+		OpenStruct.new(
+			main: {
+				work_dir: conf[:work_dir],
+				log_file: conf[:log_file]
+			},
+			server: {
+				run_as: conf[:run_as]
+			},
+			zone_search: {
+				ignore_subdomains: conf[:ignore_subdomains],
+				cache_max: conf[:cache_max],
+				record_sets: conf[:record_sets],
+				backend: conf[:backend]
+			}
+		)
 	end
 
 	def check_conf_file conf_file
@@ -74,7 +101,7 @@ module DnsOne; class DnsOne
 				# Util.die "Conf file #{conf_file} must have mode 0600. Aborting." 
 		end
 
-		unless match_root conf_stat
+		unless Util.match_root conf_stat
 				# Util.die "Conf file #{conf_file} must have uid/gid set to root. Aborting." 
 		end
 	end

data/util/sample_conf.yml

@@ -1,8 +1,9 @@
 
 config:
   run_as: dnsserver                           # optional, but highly recommended! adduser --system dnsserver
-  ignore_subdomains: www en it es pt ru fr at # optional
+  ignore_subdomains: www en it es pt ru fr at # optional, defaults to an empty list
   # cache_max: 100000                         # optional, defaults to 10000
+  # log_file: /var/log/dns_one.log              # optional, defaults to /var/log/dns_one.log
 
 backend:
   ############## 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dns_one
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors:
 - Tom Lobato
@@ -136,7 +136,9 @@ files:
 - lib/dns_one/backend/file.rb
 - lib/dns_one/cache.rb
 - lib/dns_one/cli.rb
-- lib/dns_one/core_extensions.rb
+- lib/dns_one/core_ext/blank.rb
+- lib/dns_one/core_ext/exception.rb
+- lib/dns_one/core_ext/string.rb
 - lib/dns_one/log.rb
 - lib/dns_one/server.rb
 - lib/dns_one/setup.rb

data/lib/dns_one/core_extensions.rb

@@ -1,24 +0,0 @@
-
-class String
-    def to_a
-        [self]
-    end
-    def strip_text
-        split("\n")
-        .map{|l| l.strip}
-        .join("\n")
-    end
-end
-
-class Exception
-    def desc
-        "#{e.class}: #{ message }\n#{ backtrace&.join "\n" }"
-    end
-    def puts_stderr
-        STDERR.puts e.desc
-    end
-end
-
-def match_root stat
-    stat.uid == 0 && stat.gid == 0
-end