smart_proxy_dhcp_bluecat 0.1.0

data/lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_main.rb

@@ -0,0 +1,109 @@
+require 'dhcp_common/server'
+
+module Proxy::DHCP::BlueCat
+  class Provider < ::Proxy::DHCP::Server
+    include Proxy::Log
+    include Proxy::Util
+
+    attr_reader :connection
+    def initialize(connection, managed_subnets)
+      @connection = connection
+      @managed_subnets = managed_subnets
+      super('bluecat', managed_subnets, nil)
+    end
+
+    def subnets
+      logger.debug('START subnets')
+      subnets = @connection.get_subnets
+      logger.debug('END subnets')
+      logger.debug('Returned: ' + subnets.class.to_s + ': ' + subnets.to_s)
+      subnets
+    end
+
+    def all_hosts(network_address)
+      logger.debug('START all_hosts with network_address: ' + network_address.to_s)
+      hosts = @connection.get_hosts(network_address)
+      logger.debug('END all_hosts with network_address: ' + network_address.to_s)
+      logger.debug('Returned: ' + hosts.class.to_s + ': ' + hosts.to_s)
+      hosts
+    end
+
+    def all_leases(network_address)
+      logger.debug('START all_leases with network_address: ' + network_address.to_s)
+      hosts = @connection.get_hosts(network_address)
+      logger.debug('END all_leases with network_address: ' + network_address.to_s)
+      logger.debug('Returned: ' + hosts.class.to_s + ': ' + hosts.to_s)
+      hosts
+    end
+
+    def unused_ip(subnet, mac_address, from_ip_address, to_ip_address)
+      logger.debug('START unused_ip with subnet: ' + subnet.to_s + ' mac_address: ' + mac_address.to_s + ' from_ip_address: ' + from_ip_address.to_s + ' to_ip_address: ' + to_ip_address.to_s)
+      ip = @connection.get_next_ip(subnet, from_ip_address, to_ip_address)
+      logger.debug('END unused_ip with subnet: ' + subnet.to_s + ' mac_address: ' + mac_address.to_s + ' from_ip_address: ' + from_ip_address.to_s + ' to_ip_address: ' + to_ip_address.to_s)
+      logger.debug('Returned: ' + ip.class.to_s + ': ' + ip.to_s)
+      ip
+    end
+
+    def find_record(subnet_address, address)
+      logger.debug('START find_record with subnet_address: ' + subnet_address.to_s + ' address: ' + address.to_s)
+      records = if IPAddress.valid?(address)
+                  find_records_by_ip(subnet_address, address)
+                else
+                  find_record_by_mac(subnet_address, address)
+                end
+      logger.debug('END find_record with subnet_address: ' + subnet_address.to_s + ' address: ' + address.to_s)
+      logger.debug('Returned: ' + records.class.to_s + ': ' + records.to_s)
+      return [] if records.nil?
+      records
+    end
+
+    def find_records_by_ip(subnet_address, ip)
+      logger.debug('START find_records_by_ip with subnet_address: ' + subnet_address.to_s + ' ip: ' + ip.to_s)
+      records = @connection.get_hosts_by_ip(ip)
+      logger.debug('END find_records_by_ip with subnet_address: ' + subnet_address.to_s + ' ip: ' + ip.to_s)
+      logger.debug('Returned: ' + records.class.to_s + ': ' + records.to_s)
+      return [] if records.nil?
+      records
+    end
+
+    def find_record_by_mac(subnet_address, mac_address)
+      logger.debug('START find_record_by_mac with subnet_address: ' + subnet_address.to_s + ' mac_address: ' + mac_address.to_s)
+      record = @connection.get_host_by_mac(mac_address)
+      logger.debug('END find_record_by_mac with subnet_address: ' + subnet_address.to_s + ' mac_address: ' + mac_address.to_s)
+      logger.debug('Returned: ' + record.class.to_s + ': ' + record.to_s)
+      record
+    end
+
+    def find_subnet(subnet_address)
+      logger.debug('START find_subnet with subnet_address: ' + subnet_address.to_s)
+      net = @connection.find_mysubnet(subnet_address)
+      logger.debug('END find_subnet with subnet_address: ' + subnet_address.to_s)
+      logger.debug('Returned: ' + net.class.to_s + ': ' + net.to_s)
+      net
+    end
+
+    def get_subnet(subnet_address)
+      logger.debug('START get_subnet with subnet_address: ' + subnet_address.to_s)
+      net = @connection.find_mysubnet(subnet_address)
+      logger.debug('END get_subnet with subnet_address: ' + subnet_address.to_s)
+      logger.debug('Returned: ' + net.class.to_s + ': ' + net.to_s)
+      net
+    end
+
+    def add_record(options)
+      logger.debug('START add_record with options: ' + options.to_s)
+      @connection.add_host(options)
+      logger.debug('END add_record with options: ' + options.to_s)
+    end
+
+    def del_record(record)
+      logger.debug('START del_record with record: ' + record.to_s)
+      if record.empty?
+        logger.debug('record empty, nothing to do')
+      else
+        @connection.remove_host(record.ip)
+      end
+      logger.debug('END del_record with record: ' + record.to_s)
+    end
+  end
+end

data/lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_plugin.rb

@@ -0,0 +1,34 @@
+module Proxy::DHCP::BlueCat
+  class Plugin < ::Proxy::Provider
+    plugin :dhcp_bluecat, ::Proxy::DHCP::BlueCat::VERSION
+
+    validate_presence :scheme, :verify, :host, :parent_block, :view_name, :config_id, :config_name, :server_id, :username, :password
+
+    requires :dhcp, '>= 1.16'
+
+    load_classes ::Proxy::DHCP::BlueCat::PluginConfiguration
+    load_dependency_injection_wirings ::Proxy::DHCP::BlueCat::PluginConfiguration
+
+    load_validators scheme_validator: ::Proxy::DHCP::BlueCat::SchemeValidator,
+                    verify_validator: ::Proxy::DHCP::BlueCat::VerifyValidator,
+                    host_validator: ::Proxy::DHCP::BlueCat::HostValidator,
+                    parent_block_validator: ::Proxy::DHCP::BlueCat::ParentBlockValidator,
+                    view_name_validator: ::Proxy::DHCP::BlueCat::ViewNameValidator,
+                    config_id_validator: ::Proxy::DHCP::BlueCat::ConfigIdValidator,
+                    config_name_validator: ::Proxy::DHCP::BlueCat::ConfigNameValidator,
+                    server_id_validator: ::Proxy::DHCP::BlueCat::ServerIdValidator,
+                    username_validator: ::Proxy::DHCP::BlueCat::UsernameValidator,
+                    password_validator: ::Proxy::DHCP::BlueCat::PasswordValidator
+
+    validate :scheme, scheme_validator: true
+    validate :verify, verify_validator: true
+    validate :host, host_validator: true
+    validate :parent_block, parent_block_validator: true
+    validate :view_name, view_name_validator: true
+    validate :config_id, config_id_validator: true
+    validate :config_name, config_name_validator: true
+    validate :server_id, server_id_validator: true
+    validate :username, username_validator: true
+    validate :password, password_validator: true
+  end
+end

data/lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_version.rb

@@ -0,0 +1,7 @@
+module Proxy
+  module DHCP
+    module BlueCat
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/lib/smart_proxy_dhcp_bluecat/module_loader.rb

@@ -0,0 +1,6 @@
+class ::Proxy::DHCP::BlueCat::ModuleLoader < ::Proxy::DefaultModuleLoader
+  def log_provider_settings(settings)
+    super(settings)
+    logger.warn('http is used for connection to BlueCat address manager') if settings[:scheme] != 'https'
+  end
+end

data/lib/smart_proxy_dhcp_bluecat/plugin_configuration.rb

@@ -0,0 +1,33 @@
+module Proxy::DHCP::BlueCat
+  class PluginConfiguration
+    def load_classes
+      require 'dhcp_common/dhcp_common'
+      require 'smart_proxy_dhcp_bluecat/bluecat_api'
+      require 'smart_proxy_dhcp_bluecat/dhcp_bluecat_main'
+    end
+
+    def load_dependency_injection_wirings(c, settings)
+      c.dependency :connection, (lambda do
+                                   BlueCat.new(
+                                     settings[:scheme],
+                                     settings[:verify],
+                                     settings[:host],
+                                     settings[:parent_block],
+                                     settings[:view_name],
+                                     settings[:config_name],
+                                     settings[:config_id],
+                                     settings[:server_id],
+                                     settings[:username],
+                                     settings[:password]
+                                   )
+                                 end)
+
+      c.dependency :dhcp_provider, (lambda do
+                                      ::Proxy::DHCP::BlueCat::Provider.new(
+                                        c.get_dependency(:connection),
+                                        settings[:subnets]
+                                      )
+                                    end)
+    end
+  end
+end

data/lib/smart_proxy_dhcp_bluecat/settings_validator.rb

@@ -0,0 +1,62 @@
+module ::Proxy::DHCP::BlueCat
+  class SchemeValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if ['http', 'https'].include?(settings[:scheme])
+      raise ::Proxy::Error::ConfigurationError, "Setting 'scheme' can be set to either 'http' or 'https'"
+    end
+  end
+  class VerifyValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if [true, false].include?(settings[:verify])
+      raise ::Proxy::Error::ConfigurationError, "Setting 'verify' can be set to either 'true' or 'false' (bool)"
+    end
+  end
+  class HostValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if ['http', 'https'].include?(settings[:scheme])
+      raise ::Proxy::Error::ConfigurationError, "Setting 'scheme' can be set to either 'http' or 'https'"
+    end
+  end
+  class ParentBlockValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if settings[:parent_block].is_a?(Integer)
+      raise ::Proxy::Error::ConfigurationError, "Setting 'parent_block' must be (integer)"
+    end
+  end
+  class ViewNameValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if settings[:view_name].is_a?(String)
+      raise ::Proxy::Error::ConfigurationError, "Setting 'view_name' must be (string)"
+    end
+  end
+  class ConfigIdValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if settings[:config_id].is_a?(Integer)
+      raise ::Proxy::Error::ConfigurationError, "Setting 'parent_block' must be (integer)"
+    end
+  end
+  class ConfigNameValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if settings[:config_name].is_a?(String)
+      raise ::Proxy::Error::ConfigurationError, "Setting 'config_name' must be (string)"
+    end
+  end
+  class ServerIdValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if settings[:server_id].is_a?(Integer)
+      raise ::Proxy::Error::ConfigurationError, "Setting 'server_id' must be (integer)"
+    end
+  end
+  class UsernameValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if settings[:username].is_a?(String)
+      raise ::Proxy::Error::ConfigurationError, "Setting 'username' must be (string)"
+    end
+  end
+  class PasswordValidator < ::Proxy::PluginValidators::Base
+    def validate!(settings)
+      return true if settings[:password].is_a?(String)
+      raise ::Proxy::Error::ConfigurationError, "Setting 'password' must be (string)"
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: smart_proxy_dhcp_bluecat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthias Hähnel
+- The Foreman Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+description: BlueCat DHCP provider plugin for Foreman's smart proxy
+email:
+- matthias.haehnel@sixt.com
+- theforeman.rubygems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/dhcp_bluecat.yml.example
+- lib/smart_proxy_dhcp_bluecat.rb
+- lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_main.rb
+- lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_plugin.rb
+- lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_version.rb
+- lib/smart_proxy_dhcp_bluecat/module_loader.rb
+- lib/smart_proxy_dhcp_bluecat/plugin_configuration.rb
+- lib/smart_proxy_dhcp_bluecat/settings_validator.rb
+- lib/smart_proxy_dhcp_bluecat/bluecat_api.rb
+- lib/lib/smart_proxy_dhcp_bluecat/bluecat_api.rb
+- lib/lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_main.rb
+- lib/lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_plugin.rb
+- lib/lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_version.rb
+- lib/lib/smart_proxy_dhcp_bluecat/module_loader.rb
+- lib/lib/smart_proxy_dhcp_bluecat/plugin_configuration.rb
+- lib/lib/smart_proxy_dhcp_bluecat/settings_validator.rb
+- lib/lib/smart_proxy_dhcp_bluecat.rb
+- bundler.d/dhcp_bluecat.rb
+- README.md
+- LICENSE
+homepage: https://github.com/theforeman/smart_proxy_dhcp_bluecat
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: BlueCat DHCP provider plugin for Foreman's smart proxy
+test_files: []