blondy-dhcpd 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae29d05c58be4df1ba9ed1bbb261272d0704fc3e
-  data.tar.gz: fc31f7a889b49b1c20d0af9d8da1d6ffbe794852
+  metadata.gz: cff451085750256df70f852e290cc0486a4662e2
+  data.tar.gz: b04ecbb33b1926fdd552572b1f5b4d4e89114c5e
 SHA512:
-  metadata.gz: 2574b0e7689854ac759562a3c66a1f67e2e4126f554421c9401c6665e944f36fc46e98d017eef47b84a03357691903d30252459560267ae695ec7b6e3056fcc4
-  data.tar.gz: 362900db015b131b562e166308fc125207e1c15c43a626c2d0f2a7300128863ac0c1f8fc20590344761dfe6c6a6b63f955ac5080237221fd4bd84e3e884ad401
+  metadata.gz: 325c913489b1c2dc5f2030d3f92028b9d0b3336064fba0c0b59e7cacdb814a591fe42bc56dd1f6587ff7b698bfbcb83e3911d029c8d6721c90932668ca1374e2
+  data.tar.gz: d1b8714e9e7054d4ddb07b20620178701da0190fb49732e83c0c9dd60a598f6428e199d931c87eb3db1bd603d20907d5ddc1093bc85daf11d0ea335e41c022e0

data/Gemfile

@@ -2,11 +2,14 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'net-dhcp', :git => 'https://github.com/mjtko/net-dhcp-ruby'
+gem 'net-dhcp', :git => 'https://github.com/presto53/net-dhcp-ruby', :branch => 'fixed'
 gem 'log4r'
 gem 'eventmachine'
+gem 'em-http-request'
 
 group :test do
   gem 'rspec'
+  gem 'webmock'
+  gem 'simplecov'
 end
 

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/blondy-dhcpd.png)](http://badge.fury.io/rb/net-dhcp) [![Build Status](https://travis-ci.org/presto53/blondy-dhcpd.png)](https://travis-ci.org/presto53/blondy-dhcpd)
+[![Gem Version](https://badge.fury.io/rb/blondy-dhcpd.png)](http://badge.fury.io/rb/net-dhcp) [![Build Status](https://travis-ci.org/presto53/blondy-dhcpd.png)](https://travis-ci.org/presto53/blondy-dhcpd) [![Code Climate](https://codeclimate.com/repos/52eb8ff6e30ba06ec2002a03/badges/132cfa29229385341bee/gpa.png)](https://codeclimate.com/repos/52eb8ff6e30ba06ec2002a03/feed)
 
 blondy-dhcpd
 ============
@@ -6,9 +6,21 @@ DHCPd with remote pools
 
 Installation
 ---------------
+    gem install blondy-dhcpd
 
 Configuration
 ---------------
+Default config path is /etc/blondy
+
+You can change it by set BLONDY_CONFIGPATH environment variable.
+
+**Example config /etc/blondy/dhcpd.yml**:
+
+    log_path: '/var/log/blondy'
+    pid_path: '/var/run/blondy'
+    server_ip: '192.168.1.1'
+    client_key: 'AAAbbbCcC'
+    master: 'https://192.168.1.10'
 
 Usage
 ---------------

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TODO.md

@@ -0,0 +1,3 @@
+TODO
+---------------
+- TLS for pool hook

data/bin/blondy-dhcpd

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+require 'eventmachine'
+require 'blondy/dhcpd/logger'
+require 'blondy/dhcpd/config'
+require 'blondy/dhcpd/server'
+
+module Blondy
+  module DHCPD
+    # Check if daemon already running
+    if /^\// =~ CONFIG['pid_path']
+      @pidf = "#{CONFIG['pid_path'].gsub(/\/*$/,'')}/blondy-dhcpd.pid"
+      running_pid = File.open(@pidf, 'r').read.chomp rescue nil
+      running_pgid = Process.getpgid(running_pid.to_i) rescue nil if running_pid
+      if running_pgid
+	Logger.error 'Daemon already running.'
+	exit 1
+      end
+    else
+      Logger.error 'PID path is wrong or not set.'
+      exit 1
+    end
+
+    # Daemonize
+    Process.daemon unless @options[:debug]
+
+    # Write PID
+    File.write(@pidf, "#{Process.pid}\n")
+    Logger.info "Starting dhcpd with pid #{Process.pid}"
+
+    # Signal handlers
+    @signals = Array.new
+    class << self
+      def shutdown(exit_code)
+	Logger.info "Shutdown server..."
+	EM.stop if EM.reactor_running?
+	File.delete(@pidf) if File.exists?(@pidf)
+	exit exit_code
+      end
+      def term_handler
+	Logger.info "Server received TERM signal."
+	shutdown(0)
+      end
+      def int_handler
+	Logger.info "Server received INT signal."
+	shutdown(0)
+      end
+    end
+
+    # Start server
+    if Process.uid != 0
+      Logger.error 'Failed to start server. Server should be started by root.'
+      shutdown(1)
+      exit 1
+    else
+      EM.run do
+	Signal.trap('TERM') { @signals << :term }
+	Signal.trap('INT') { @signals << :int }
+	# Check for signals periodically
+	EM.add_periodic_timer(1) do
+	  term_handler if @signals.include?(:term)
+	  int_handler if @signals.include?(:int)
+	end
+	EM.open_datagram_socket('0.0.0.0', 67, Server)
+      end
+    end
+  end
+end

data/blondy-dhcpd.gemspec

@@ -21,8 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
 
   spec.add_runtime_dependency 'eventmachine', '>= 0.12.0'
+  spec.add_runtime_dependency 'em-http-request'
   spec.add_runtime_dependency 'net-dhcp', '>= 1.1.1'
   spec.add_runtime_dependency 'log4r'
 end

data/lib/blondy/dhcpd/cache.rb

@@ -0,0 +1,33 @@
+
+module Blondy
+  module DHCPD
+    class Cache
+      @cache = Hash.new
+      class << self
+	def add(hwaddr,type, data)
+	  @cache[type] = Hash.new unless @cache[type]
+	  @cache[type][hwaddr] = Hash.new unless @cache[type][hwaddr]
+	  @cache[type][hwaddr][:data] = data
+	  @cache[type][hwaddr][:time] = Time.now
+	end
+	def query(hwaddr, type)
+	  begin
+	    @cache[type][hwaddr][:data] ? @cache[type][hwaddr] : false
+	  rescue
+	    false
+	  end
+	end
+	def flush
+	  @cache.clear
+	end
+	def purge(sec)
+	  @cache.each do |type, data|
+	    data.each_key do |hwaddr|
+	      @cache[type].delete hwaddr if (Time.now - @cache[type][hwaddr][:time]) >= sec
+	    end
+	  end
+	end
+      end
+    end
+  end
+end

data/lib/blondy/dhcpd/config.rb

@@ -0,0 +1,56 @@
+require 'optparse'
+require 'yaml'
+require 'log4r'
+
+module Blondy
+  module DHCPD
+    # Set default config
+    default_config = '/etc/blondy/dhcpd.yml'
+    config_file = default_config
+
+    # Read command line options
+    @options = Hash.new
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: dhcpd.rb [options]'
+      opts.on('-d', '--debug', 'Run foreground for debug') { @options[:debug] = true }
+      opts.on_tail('-h', '--help', 'Show this message') do
+	puts opts
+	exit 0
+      end
+    end.parse!
+
+    # Load config from file
+    begin
+      config_file = "#{ENV['BLONDY_CONFIGPATH']}/dhcpd.yml" if ENV['BLONDY_CONFIGPATH']
+      CONFIG = YAML::load(File.open(config_file))
+    rescue
+      STDERR.puts "No config file. \nPlease check that #{default_config} exist or BLONDY_CONFIGPATH is set."
+      exit 1
+    end
+
+    # Check for client key
+    unless CONFIG['client_key']
+      Logger.error 'You should set client_key.'
+      exit 1
+    end
+    # Check for master address
+    unless /^http(s)?:\/\/.*/ =~ CONFIG['master']
+      Logger.error 'You should set master server.'
+      exit 1
+    end
+
+    # Set logging to file
+    if CONFIG['log_path']
+      begin
+	if /^\// =~ CONFIG['log_path']
+	  log_path = CONFIG['log_path'].gsub(/\/*$/,'')
+	  format = Log4r::PatternFormatter.new(:pattern => "[%l] [%d] %m")
+	  Logger.outputters << Log4r::FileOutputter.new('blondy-dhcpd.log', filename: "#{log_path}/blondy-dhcpd.log" , formatter: format)
+	end
+	Logger.level = ((1..7).include?(CONFIG['log_level']) ? CONFIG['log_level'] : 1)
+      rescue
+	Logger.error 'Error while open log file.'
+      end
+    end
+  end
+end

data/lib/blondy/dhcpd/dispatcher.rb

@@ -1,26 +1,97 @@
 require 'net-dhcp'
 require 'ostruct'
 require 'ipaddr'
+require_relative 'pool'
 
 module Blondy
   module DHCPD
     class Dispatcher
-      def self.dispatch(data, ip, port)
-	@data = DHCP::Message.from_udp_payload(data)
-	reply = OpenStruct.new
-	if @data.kind_of?(DHCP::Discover)
-	  if @data.giaddr == 0
-	    reply.ip = '255.255.255.255'
-	    reply.port = 68
+      class << self
+	def dispatch(data, ip, port)
+	  @data = DHCP::Message.from_udp_payload(data) rescue raise(IncorrectMessage, 'Incorrect message received.')
+	  raise(IncorrectMessage, 'Incorrect message received.') unless @data
+	  set_hwaddr
+	  reply
+	end
+
+	private
+
+	def reply
+	  msg_class = @data.class.to_s.gsub(/^.*::/, '').downcase
+	  handle(msg_class)
+	end
+
+	def handle(msg_class)
+	  if %w{discover request inform release}.include?(msg_class)
+	    @pool = Pool.query(@data.hwaddr, msg_class.to_sym)
+	    @pool ? call("#{msg_class}_handler".to_sym) : false
 	  else
-	    reply.ip = IPAddr.new(@data.giaddr, family = Socket::AF_INET).to_s
-	    reply.port = 67
+	    raise NoMessageHandler, 'No appropriate handler for message.'
 	  end
-	  reply.data = DHCP::Offer.new
 	end
-	reply.data.xid = @data.xid
-	reply
+
+	def call(method)
+	    @reply = OpenStruct.new
+	    send(method)
+	end
+
+	def discover_handler
+	    @reply.data = DHCP::Offer.new
+	    create_reply
+	end
+
+	def request_handler
+	    @reply.data = DHCP::ACK.new
+	    create_reply
+	end
+
+	def release_handler
+	  @reply.data = nil
+	end
+
+	def inform_handler
+	  @reply.data = DHCP::ACK.new
+	  create_reply
+	end
+
+	def create_reply
+	  set_src
+	  set_pool_data
+	  set_other
+	  @reply
+	end
+
+	def set_hwaddr
+	  DHCP::Message.class_eval {attr_accessor :hwaddr}
+	  @data.hwaddr = @data.chaddr.take(@data.hlen).map {|x| x.to_s(16).size<2 ? '0'+x.to_s(16) : x.to_s(16)}.join(':')
+	end
+
+	def set_src
+	  if @data.giaddr == 0 and @data.ciaddr != 0
+	    @reply.ip = IPAddr.new(@data.ciaddr, family = Socket::AF_INET).to_s
+	    @reply.port = 68
+	  elsif @data.giaddr != 0
+	    @reply.ip = IPAddr.new(@data.giaddr, family = Socket::AF_INET).to_s
+	    @reply.port = 67
+	  else
+	    @reply.ip = '255.255.255.255'
+	    @reply.port = 68
+	  end
+	end
+
+	def set_pool_data
+	  @reply.data.yiaddr = @pool.data.yiaddr
+	  @reply.data.fname = @pool.data.fname
+	  @reply.data.options = @pool.data.options
+	end
+
+	def set_other
+	  @reply.data.siaddr = IPAddr.new(Blondy::DHCPD::CONFIG['server_ip']).to_i
+	  @reply.data.xid = @data.xid if @data.xid
+	end
       end
     end
   end
 end
+
+

data/lib/blondy/dhcpd/logger.rb

@@ -0,0 +1,10 @@
+require 'log4r'
+
+module Blondy
+  module DHCPD
+    # Set logger
+    Logger = Log4r::Logger.new 'ruby-dhcpd'
+    Logger.outputters << Log4r::Outputter.stdout
+  end
+end
+

data/lib/blondy/dhcpd/pool.rb

@@ -0,0 +1,78 @@
+require 'em-http'
+require 'json'
+require 'ipaddr'
+require_relative 'reply'
+require_relative 'cache'
+
+module Blondy
+  module DHCPD
+    class Pool
+      class << self
+	def query(hwaddr, type)
+	  reply = Cache.query(hwaddr,type)
+	  if reply
+	    reply[:data]
+	  else
+	    http = EM::HttpRequest.new(Blondy::DHCPD::CONFIG['master']).
+	      get(head: {'x-blondy-key' => Blondy::DHCPD::CONFIG['client_key']}, query: {'type' => type.to_s, 'hwaddr' => hwaddr})
+	    http.callback do
+	      if http.response_header.status != 200
+		Logger.error "Remote server reply with #{http.response_header.status} error code."
+	      else
+		data = transform(http.response, type)
+		Cache.add(hwaddr,type, data) if data
+	      end
+	      data
+	    end
+	    http.errback do
+	      Logger.error 'Remote pool server is unavailable.'
+	    end
+	    false
+	  end
+	end
+
+	private
+
+	def transform(json, type)
+	  begin
+	    data = JSON.parse(json)
+	    if type == :discover
+	      reply_type = $DHCP_MSG_OFFER
+	    elsif type == :request
+	      reply_type = $DHCP_MSG_ACK
+	    else
+	      raise UnsupportedReqType
+	    end
+	    Reply.new(data, reply_type).get
+	  rescue UnsupportedReqType
+	    # Unsupported request type
+	    Logger.error 'Unsupported type received.'
+	    false
+	  rescue JSON::ParserError
+	    # Wrong json
+	    Logger.error 'Remote server send invalid json.'
+	    false
+	  rescue NoMethodError
+	    Logger.error 'Remote server send invalid text data in json.'
+	    # Wrong data in json
+	    false
+	  rescue IPAddr::AddressFamilyError
+	    # Wrong data in json (address family must be specified)
+	    Logger.error 'Remote server send invalid ip or nemask in json.'
+	    false
+	  rescue IPAddr::InvalidAddressError
+	    # Wrong data in json (invalid address)
+	    Logger.error 'Remote server send invalid ip or nemask in json.'
+	    false
+	  rescue
+	    # Unknown error
+	    Logger.error 'Unknown error.'
+	    false
+	  end
+	end
+      end
+    end
+  end
+end
+class UnsupportedReqType < StandardError
+end

data/lib/blondy/dhcpd/reply.rb

@@ -0,0 +1,37 @@
+require 'net-dhcp'
+require 'ostruct'
+require 'ipaddr'
+
+module Blondy
+  module DHCPD
+    class Reply
+      def initialize(data, reply_type)
+	  @result = OpenStruct.new 
+	  @result.data = OpenStruct.new
+	  @data = data
+	  @reply_type = reply_type
+	  @result.data.fname = data['fname'].unpack('C128').map {|x| x ? x : 0}
+	  @result.data.yiaddr = IPAddr.new(data['yiaddr']).to_i
+	  @result.data.options = [
+	    DHCP::MessageTypeOption.new({payload: [@reply_type]}),
+	    DHCP::ServerIdentifierOption.new({payload: array_from(Blondy::DHCPD::CONFIG['server_ip'])}),
+	    DHCP::DomainNameOption.new({payload: data['domain'].unpack('C*')}),
+	    DHCP::DomainNameServerOption.new({payload: array_from(data['dns'])}),
+	    DHCP::IPAddressLeaseTimeOption.new({payload: [7200].pack('N').unpack('C*')}),
+	    DHCP::SubnetMaskOption.new({payload: array_from(data['netmask'])}),
+	    DHCP::RouterOption.new({payload: array_from(data['gw'])})
+	  ]
+      end
+
+      def get
+	@result
+      end
+
+      private
+      
+      def array_from(ip)
+	ip.split('.').map {|octet| octet.to_i} if IPAddr.new(ip)
+      end
+    end
+  end
+end

data/lib/blondy/dhcpd/server.rb

@@ -1,18 +1,51 @@
 require 'net-dhcp'
 require 'eventmachine'
 require 'socket'
+require 'log4r'
+require_relative 'dispatcher'
 
 module Blondy
   module DHCPD
     # Main class for handling connections
     class Server < EM::Connection
+      def initialize
+	@buffer = String.new
+	super
+      end
       # Fires up Dispatcher and send reply back by callback
       def receive_data(data)
+	@buffer.clear if (@buffer.size + data.size) > 1000
+	@buffer += data
+
+	if @buffer.unpack('C4Nn2N4C16C192NC*').include?($DHCP_MAGIC)
+	  process_message(@buffer.dup)
+	  @buffer.clear
+	end
+      end
+
+      private
+
+      def process_message(buffer)
 	ip, port = Socket.unpack_sockaddr_in(get_peername)
-	action = proc { Dispatcher.dispatch(data, ip, port) }
-	callback = proc { |reply| send_datagram(reply.data.pack, reply.ip, reply.port) if reply }
+	action = proc do
+	  begin
+	    Dispatcher.dispatch(buffer, ip, port)
+	  rescue NoMessageHandler
+	    Logger.warn 'No handler for message found. Ignore.'
+	    false
+	  rescue IncorrectMessage
+	    Logger.warn 'Incorrect message received. Ignore.'
+	    false
+	  end
+	end
+	callback = proc { |reply| send_datagram(reply.data.pack, reply.ip, reply.port) if reply && reply.data }
 	EM.defer(action,callback)
       end
     end
   end
 end
+
+class NoMessageHandler < StandardError
+end
+class IncorrectMessage < StandardError
+end

data/lib/blondy/dhcpd/version.rb

@@ -1,5 +1,5 @@
 module Blondy
   module Dhcpd
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/cache_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module Blondy
+  module DHCPD
+    describe 'Cache' do
+      subject(:cache) {Cache}
+      let(:data) do
+	pool_query_result = OpenStruct.new 
+	pool_query_result.data = OpenStruct.new 
+	pool_query_result.data.fname = 'test.txt'.unpack('C128').map {|x| x ? x : 0}
+	pool_query_result.data.yiaddr = IPAddr.new('192.168.5.150').to_i
+	pool_query_result.data.options = [
+	  DHCP::MessageTypeOption.new({payload: [$DHCP_MSG_OFFER]}),
+	  DHCP::ServerIdentifierOption.new({payload: Blondy::DHCPD::CONFIG['server_ip'].split('.').map {|octet| octet.to_i}}),
+	  DHCP::DomainNameOption.new({payload: 'example.com'.unpack('C*')}),
+	  DHCP::DomainNameServerOption.new({payload: [8,8,8,8]}),
+	  DHCP::IPAddressLeaseTimeOption.new({payload: [7200].pack('N').unpack('C*')}),
+	  DHCP::SubnetMaskOption.new({payload: [255, 255, 255, 255]}),
+	  DHCP::RouterOption.new({payload: [192, 168, 1, 3]})
+	]
+	pool_query_result
+      end
+
+      before(:each) do
+	cache.flush
+      end
+
+      it 'add host to cache' do
+	cache.query('11:11:11:11:11:11', :discover).should == false 
+	cache.add('11:11:11:11:11:11', :discover, data)
+	cache.query('11:11:11:11:11:11', :discover)[:data].should == data
+      end
+      it 'flush cache' do
+	cache.add('11:11:11:11:11:11', :discover, data)
+	cache.add('12:11:11:11:11:11', :discover, data)
+	cache.flush
+	cache.query('11:11:11:11:11:11', :discover).should == false
+	cache.query('12:11:11:11:11:11', :discover).should == false
+      end
+      it 'delete entries older than N' do
+	@time = Time.now
+	Time.stub(:now) {@time}
+	cache.add('11:11:11:11:11:11', :discover, data)
+	Time.stub(:now) {@time+5}
+	cache.purge(3)
+	cache.query('11:11:11:11:11:11', :discover).should == false
+      end
+    end
+  end
+end