murakumo 0.1.0

data/README

@@ -0,0 +1,57 @@
+= Murakumo
+
+== Description
+
+Murakumo is the internal DNS server which manages name information using a gossip protocol.
+
+== Source Code
+
+https://bitbucket.org/winebarrel/murakumo
+
+== Dependency
+
+* RubyDNS
+* SQLite
+* MessagePack
+
+== Install
+
+  gem install murakumo
+  cp /usr/local/lib/ruby/gems/1.8/gems/murakumo-*/etc/murakumo.server /etc/init.d/murakumo
+  chmod 755 /etc/init.d/murakumo
+  /etc/init.d/murakumo start
+
+== Example
+=== display of a list of a record
+
+  shell> mrkmctl -L
+  IP address       TTL     Priority  Activity  Hostname
+  ---------------  ------  --------  --------  ----------
+  10.11.12.13          60  Origin    Active    my-host
+
+=== addition of a record 
+
+  shell> mrkmctl -A foo.bar,300,master
+  shell> mrkmctl -L
+  IP address       TTL     Priority  Activity  Hostname
+  ---------------  ------  --------  --------  ----------
+  10.11.12.13          60  Origin    Active    dev-01
+  10.11.12.13         300  Master    Active    foo.bar
+
+=== deletion of a record 
+
+  shell> mrkmctl -D foo.bar
+  shell> mrkmctl -L
+  IP address       TTL     Priority  Activity  Hostname
+  ---------------  ------  --------  --------  ----------
+  10.11.12.13          60  Origin    Active    my-host
+
+=== addition of a node
+
+  shell> mrkmctl -a 10.11.12.14
+  shell> mrkmctl -L
+  IP address       TTL     Priority  Activity  Hostname
+  ---------------  ------  --------  --------  ----------
+  10.11.12.13          60  Origin    Active    my-host
+  10.11.12.14          60  Origin    Active    other-host
+

data/bin/mrkmctl

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'cli/mrkmctl'

data/bin/murakumo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'cli/murakumo'

data/etc/murakumo.server

@@ -0,0 +1,95 @@
+#!/bin/sh
+# chkconfig: 345 64 36
+# description: The internal DNS server which manages name information using a gossip protocol.
+# processname: /usr/local/bin/murakumo
+# config: /etc/murakumo.yml
+
+prog=/usr/local/bin/murakumo
+ctlprog=/usr/local/bin/mrkmctl
+conf=/etc/murakumo.yml
+
+if [ "$1" != "configure"  -a ! -e "$conf" ]; then
+  echo "configuration file is not found: $conf"
+  exit 1
+fi
+
+case "$1" in
+start)
+  $prog -c $conf -d start
+  ;;
+stop)
+  $prog -c $conf -d stop
+  ;;
+status)
+  $prog -c $conf -d status
+  ;;
+restart)
+  $prog -c $conf -d restart
+  ;;
+save)
+  $ctlprog -y > ${conf}.new
+
+  if [ $? -eq 0 ]; then
+    cp ${conf}.new $conf
+    echo "configuration file was updated: $conf" 
+  fi
+
+  rm -f ${conf}.new
+  ;;
+configure)
+  if [ -e "$conf" ]; then
+    echo "configuration file already exists."
+    exit 1
+  fi
+
+  bind_addr=0.0.0.0
+  ip_addr=`/sbin/ifconfig eth0 | awk -F'[: ]+' '/inet/{print $4}'`
+  hostname=`hostname`
+  resolver=`grep nameserver /etc/resolv.conf | fgrep -v 127.0.0.1 | head -n 1 | awk '{print $2}'`
+
+  if [ -n "$resolver" ]; then
+    resolver="$resolver, 8.8.8.8"
+  else
+    resolver="8.8.8.8"
+  fi
+
+  cat <<EOF > $conf
+---
+address: $bind_addr
+port: 53
+
+auth-key: onion
+log-level: info
+resolver: $resolver
+max-ip-number: 8
+
+host: $ip_addr, $hostname, 60
+
+#alias:
+#  - foo,60,master
+#  - bar,60,backup
+
+#health-check:
+#  foo:
+#    interval: 5
+#    timeout: 5
+#    healthy: 2
+#    unhealthy: 2
+#    script: |
+#      tcp_check 80
+#  bar:
+#    interval: 5
+#    timeout: 5
+#    healthy: 2
+#    unhealthy: 2
+#    script: |
+#      http_get '/index.html'
+EOF
+
+  echo "configuration file was created: $conf"
+  echo -e "\033[0;31mPlease set 127.0.0.1 to resolv.conf.\033[0;39m" 
+  ;;
+*)
+  echo $"Usage: $0 {start|stop|restart|status|save|configureh}"
+  exit 1
+esac

data/etc/murakumo.yml.sample

@@ -0,0 +1,33 @@
+---
+# configuration of dns 
+address: 0.0.0.0
+port: 53
+
+auth-key: onion
+log-level: info
+resolver: 8.8.8.8
+max-ip-num: 8
+
+# Ip address, hostname, ttl
+host: 10.11.12.13, my-host, 60
+
+# alias hostname, ttl, master/backup
+alias: 
+  - foo,60,master
+  - bar,60,master
+
+health-check:
+  foo:
+    interval: 5
+    timeout: 5
+    healthy: 10
+    unhealthy: 2
+    script: |
+      tcp_check 80
+  bar:
+    interval: 5
+    timeout: 5
+    healthy: 10
+    unhealthy: 2
+    script: |
+      http_get '/index.html'

data/lib/cli/mrkmctl.rb

@@ -0,0 +1,74 @@
+require 'drb/drb'
+require 'yaml'
+
+require 'cli/mrkmctl_options'
+require 'misc/murakumo_const'
+
+# オプションをパース
+options = mrkmctl_parse_args
+
+# リモートオブジェクトを生成
+there = DRbObject.new_with_uri("drbunix:#{options[:socket]}")
+
+cmd, arg = options[:command]
+
+# 各コマンドの処理
+begin
+  case cmd
+  # 一覧表示
+  when :list
+    records = if arg.kind_of?(String)
+                # 引数がある場合はフィルタリング
+                there.list_records.select {|r| r[0..1].any?{|i| i.start_with?(arg) } }
+              else
+                there.list_records
+              end
+
+    puts <<-EOF
+IP address       TTL     Priority  Activity  Hostname
+---------------  ------  --------  --------  ----------
+    EOF
+    records.each do |r|
+      r[3] = (r[3] == Murakumo::ORIGIN ? 'Origin' : r[3] == Murakumo::MASTER ? 'Master' : 'Backup')
+      r[4] = (r[4] == Murakumo::ACTIVE ? 'Active' : 'Inactive')
+      puts '%-15s  %6d  %-8s  %-8s  %s' % r.values_at(0, 2, 3, 4, 1)
+    end
+
+  # レコードの追加・更新
+  when :add
+    is_success, errmsg = there.add_or_rplace_records(arg)
+    is_success or raise(errmsg)
+
+  # レコードの削除
+  when :delete
+    is_success, errmsg = there.delete_records(arg)
+    is_success or raise(errmsg)
+
+  # ノードの追加
+  when :add_node
+    is_success, errmsg = there.add_nodes(arg)
+    is_success or raise(errmsg)
+
+  # ノードの削除
+  when :delete_node
+    is_success, errmsg = there.delete_nodes(arg)
+    is_success or raise(errmsg)
+
+  # 属性の取得
+  when :get
+    puts "#{arg}=#{there.get_attr(arg)}"
+
+  # 属性の設定
+  when :set
+    is_success, errmsg = there.set_attr(*arg)
+    is_success or raise(errmsg)
+
+  # 設定の出力
+  when :yaml
+    puts there.to_hash.to_yaml
+
+  end
+rescue => e
+  $stderr.puts "error: #{e.message}"
+  exit 1
+end

data/lib/cli/mrkmctl_options.rb

@@ -0,0 +1,122 @@
+require 'optopus'
+
+require 'misc/murakumo_const'
+
+Version = '0.1.0'
+
+def mrkmctl_parse_args
+  optopus do
+    desc 'displays a list of a record'
+    option :list, '-L', '--list [NAME]'
+
+    desc 'adds or updates a record: <hostname>[,<TTL>[,{master|backup}]]'
+    option :add, '-A', '--add RECORD', :type => Array, :multiple => true do |value|
+      (1 <= value.length and value.length <= 3) or invalid_argument
+
+      hostname, ttl, master_backup = value
+
+      # hostname
+      /\A[0-9a-z\.\-]+\Z/i =~ hostname or invalid_argument
+
+      # TTL
+      unless ttl.nil? or (/\A\d+\Z/ =~ ttl and ttl.to_i > 0)
+        invalid_argument
+      end
+
+      # MASTER or BACKUP
+      master_backup.nil? or /\A(master|backup)\Z/i =~ master_backup or invalid_argument
+    end
+
+    desc 'deletes a record'
+    option :delete, '-D', '--delete NAME', :multiple => true do |value|
+      /\A[0-9a-z\.\-]+\Z/i =~ value or invalid_argument
+    end
+
+    desc 'adds a node'
+    option :add_node, '-a', '--add-node HOST', :multiple => true do |value|
+      unless [/\A\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\Z/, /\A[0-9a-z\.\-]+\Z/i].any? {|i| i =~ value }
+        invalid_argument
+      end
+    end
+
+    desc 'deletes a node'
+    option :delete_node, '-d', '--delete-node HOST', :multiple => true do |value|
+      unless [/\A\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\Z/, /\A[0-9a-z\.\-]+\Z/i].any? {|i| i =~ value }
+        invalid_argument
+      end
+    end
+
+    desc "gets an attribute: #{Murakumo::ATTRIBUTES.keys.join(',')}"
+    option :get, '-g', '--get ATTR' do |value|
+      Murakumo::ATTRIBUTES.keys.include?(value.to_sym) or invalid_argument
+    end
+
+    desc "sets an attribute (name=value): #{Murakumo::ATTRIBUTES.keys.join(',')}"
+    option :set, '-s', '--set ATTR' do |value|
+      /\A.+=.+\Z/ =~ value or invalid_argument
+      name, val = value.split('=', 2)
+      Murakumo::ATTRIBUTES.keys.include?(name.to_sym) or invalid_argument
+
+      if name == 'log_level'
+        %w(debug info warn error fatal).include?(val) or invalid_argument
+      end
+    end
+
+    desc ' configuration file is outputted by yaml'
+    option :yaml, '-y', '--yaml'
+
+    desc 'path of a socket file'
+    option :socket, '-S', '--socket PATH', :default => '/var/tmp/murakumo.sock'
+
+    after do |options|
+      # add
+      if options[:add]
+        options[:add] = options[:add].map do |r|
+          r = r.map {|i| i ? i.to_s.strip : i }
+          [nil, 60, 'master'].each_with_index {|v, i| r[i] ||= v }
+
+          [
+            r[0], # name
+            r[1].to_i, # TTL
+            ((/master/i =~ r[2].to_s) ? Murakumo::MASTER : Murakumo::BACKUP),
+          ]
+        end
+      end
+
+      # 一応、uniq
+      [:delete, :add_node, :delete_node].each do |key|
+        if options[key]
+          options[key] = options[key].uniq
+        end
+      end
+
+      if options[:get]
+        options[:get] = options[:get].to_sym
+      end
+
+      if options[:set]
+        options[:set] = options[:set].split('=', 2)
+        options[:set][0] = options[:set][0].to_sym
+      end
+
+      # command
+      commands = [:list, :add, :delete, :add_node, :delete_node, :get, :set, :yaml].map {|k|
+        [k, options[k]]
+      }.select {|i| not i[1].nil? }
+
+      opt_keys = %w(-L -A -D --add-node --delete-node --get --set --yaml)
+
+      if commands.length < 1
+        parse_error('command is not specified', *opt_keys)
+      elsif commands.length > 1
+        parse_error('cannot use together', *opt_keys)
+      end
+
+      options[:command] = commands.first
+    end
+
+    error do |e|
+      abort(e.message)
+    end
+  end
+end

data/lib/cli/murakumo.rb

@@ -0,0 +1,20 @@
+require 'cli/murakumo_options'
+require 'srv/murakumo_server'
+
+# オプションをパース
+options = murakumo_parse_args
+
+# サーバの初期化
+Murakumo::Server.init(options)
+
+if options[:daemon]
+  # デーモン化する場合
+  # RExecに処理を委譲するのでARGVの先頭にdaemonizeのコマンドを格納
+  ARGV.unshift options[:daemon].to_s
+
+  Murakumo::Server.pid_directory = options[:pid_dir]
+  Murakumo::Server.daemonize
+else
+  # デーモン化しない場合
+  Murakumo::Server.run
+end

data/lib/cli/murakumo_options.rb

@@ -0,0 +1,158 @@
+require 'logger'
+require 'optopus'
+require 'resolv'
+require 'socket'
+
+require 'misc/murakumo_const'
+
+Version = '0.1.0'
+
+def murakumo_parse_args
+  optopus do
+    desc 'key for authentication (required)'
+    option :auth_key, '-K', '--auth-key STRING', :required => true
+
+    desc 'ip address to bind'
+    option :dns_address, '-a', '--address IP', :default => '0.0.0.0' do |value|
+      /\A\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\Z/ =~ value or invalid_argument
+    end
+
+    desc 'port number of a name service'
+    option :dns_port, '-p', '--port NUM', :type => Integer, :default => 53
+
+    desc 'initial node list of gossip protocols'
+    option :initial_nodes, '-i', '--initial-nodes IP_LIST', :type => Array, :default => [] do |value|
+      value.all? {|i| /\A\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\Z/ =~ i } or invalid_argument
+    end
+
+    desc "host's resource record : <ip_addr>[,<hostname>[,<TTL>]] (required)"
+    option :host, '-H', '--host RECORD', :type => Array, :required => true do |value|
+      (1 <= value.length and value.length <= 3) or invalid_argument
+
+      ip_addr, hostname, ttl = value
+
+      # ip address
+      /\A\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\Z/ =~ ip_addr or invalid_argument
+
+      # hostname
+      /\A[0-9a-z\.\-]+\Z/i =~ hostname or invalid_argument
+
+      # TTL
+      unless ttl.nil? or (/\A\d+\Z/ =~ ttl and ttl.to_i > 0)
+        invalid_argument
+      end
+    end # :host
+
+    desc 'resource record of an alias: <hostname>[,<TTL>[,{master|backup}]]'
+    option :aliases, '-A', '--alias RECORD', :type => Array, :multiple => true do |value|
+      (1 <= value.length and value.length <= 3) or invalid_argument
+
+      hostname, ttl, master_backup = value
+
+      # hostname
+      /\A[0-9a-z\.\-]+\Z/ =~ hostname or invalid_argument
+
+      # TTL
+      unless ttl.nil? or (/\A\d+\Z/ =~ ttl and ttl.to_i > 0)
+        invalid_argument
+      end
+
+      # MASTER or BACKUP
+      master_backup.nil? or /\A(master|backup)\Z/i =~ master_backup or invalid_argument
+    end # :aliases
+
+    desc 'ip address of a default resolver'
+    option :resolver, '-r', '--resolver IP_LIST', :type => Array  do |value|
+      unless value.all? {|i| /\A\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\Z/ =~ i }
+        invalid_argument
+      end
+    end
+
+    desc 'path of a socket file'
+    option :socket, '-S', '--socket PATH', :default => '/var/tmp/murakumo.sock'
+
+    desc 'maximum number of the IP address returned as a response'
+    option :max_ip_num, '-n', '--max-ip-num NUM', :type => Integer, :default => 8 do |value|
+      invalid_argument if value < 1
+    end
+
+    desc 'command of daemonize: {start|stop|restart|status}'
+    option :daemon, '-d', '--daemon CMD', :type => [:start, :stop, :restart, :status]
+
+    desc 'directory of a pid file'
+    option :pid_dir, '-f', '--pid-dir PATH'
+
+    desc 'output path of a log'
+    option :log_path, '-l', '--log-path PATH'
+
+    desc 'output level of a log'
+    option :log_level, '-L', '--log-level LEVEL', :type => [:debug, :info, :warn, :error, :fatal], :default => :info
+
+    desc 'path of a configuration file'
+    config_file '-c', '--config PATH'
+
+    desc 'port number of a gossip service'
+    option :gossip_port, '-P', '--gossip-port NUM', :type => Integer, :default => 10870
+
+    desc 'lifetime of the node of a gossip protocol'
+    option :gossip_node_lifetime, '-T', '--gossip-node-lifetime NUM', :type => Integer, :default => 10
+
+    desc 'transmitting interval of a gossip protocol'
+    option :gossip_send_interval, '-I', '--gossip-send-interval NUM', :type => Float, :default => 0.3
+
+    desc 'reception timeout of a gossip protocol'
+    option :gossip_receive_timeout, '-O', '--gossip-receive-timeout NUM', :type => Integer, :default => 3
+
+    after do |options|
+      # resolver
+      if options[:resolver]
+        options[:resolver] = options[:resolver].map {|i| i.strip }
+        options[:resolver] = Resolv::DNS.new(:nameserver => options[:resolver])
+      end
+
+      # initial nodes
+      if options[:initial_nodes]
+        options[:initial_nodes] = options[:initial_nodes].map {|i| i.strip }
+      end
+
+      # host
+      options[:host] = options[:host].map {|i| i.strip }
+      options[:host][1] ||= Socket.gethostname
+      options[:host][2] = (options[:host][2] || 60).to_i # TTL
+
+      # aliases
+      config_file_aliases = options.config_file ? options.config_file['alias'] : nil
+
+      if config_file_aliases
+       if config_file_aliases.kind_of?(Array)
+          options[:aliases] = config_file_aliases.map {|i| i.split(',') }
+        else
+          options[:aliases] = [options[:aliases]]
+        end
+      end
+
+      options[:aliases] = (options[:aliases] || []).map do |r|
+        r = r.map {|i| i.to_s.strip }
+        [nil, 60, 'master'].each_with_index {|v, i| r[i] ||= v }
+
+        [
+          r[0], # name
+          r[1].to_i, # TTL
+          ((/master/i =~ r[2].to_s) ? Murakumo::MASTER : Murakumo::BACKUP),
+        ]
+      end
+
+      # logger
+      if not options[:log_path] and options[:daemon]
+        options[:log_path] = '/var/log/murakumo.log'
+      end
+
+      options[:logger] = Logger.new(options[:log_path] || $stderr)
+      options[:logger].level = Logger.const_get(options[:log_level].to_s.upcase)
+    end
+
+    error do |e|
+      abort(e.message)
+    end
+  end
+end