smart_proxy_ipam 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42b9945498eacd5e884248edc7770ac14fbda2b7315fd8f6997aa2fda7738323
-  data.tar.gz: 737a679b29622a526211670cbff2cf5e2a6e0b386f3ace537ce4ebc0a12b7e5b
+  metadata.gz: 03e5b4db2d3b9f5ffad35e382585f0d632c7bf312c9a0b643ff24989d11283d8
+  data.tar.gz: 34960551000adc62f823b7d66f81d3429530b0f39cc3b8f9301d92207c6c5a7b
 SHA512:
-  metadata.gz: '09f728a68de1da60906199cba9dada6d120ea31657f2369ba616b92c9a10dec3d3feba4e15051266af03e13e8d4be2d231841f17094b674d50fa5e2f630e0dfb'
-  data.tar.gz: bb3c04b61e6776dabda6c2e752b7376013045b247560887481bde4701bb4d2fbbaee8bc973e49b393b695ee16f72d17c8e297219b545609e8b07ea970c847bb4
+  metadata.gz: da0f3c2643eac27f95a041b8181097b874aadee8d1a46a8d549862870328cb9f40766d0def9688ff487cb27fc00b8a178522a75f90e2e813b60c99256e3b0068
+  data.tar.gz: 1f3f74603ab6822061a29018a2eb4ef98fd1071cb15c0af0e252da93cbbfe15b7fdc2e396d1a5a3ff3e9b29de97580ce46edae20b8c5357c76d317154ee4ce7d

data/README.md

@@ -17,8 +17,8 @@ for how to install Foreman plugins
 
 Once plugin is installed, you can use phpIPAM to get the next available IP address for a subnet:
 
-1. Create a subnet in Foreman of IPAM type "External IPAM". Click on the `Proxy` tab and associate the subnet with the External IPAM proxy. _NOTE: This subnet must actually exist in phpIPAM. There is no phpIPAM integration on the subnet creation at this time._
-2. Create a host in Foreman. When adding/editing interfaces, select the above created subnet, and the next available IP(pulled from phpIPAM) for the selected subnet will be displayed in the IPv4 address field. _NOTE: This is not supported for IPv6._
+1. Create a subnet in Foreman of IPAM type "External IPAM". Click on the `Proxy` tab and associate the subnet with a Smart Proxy that has the `external_ipam` feature enabled. _NOTE: This subnet must actually exist in phpIPAM. There is no integration with subnet creation at this time._
+2. Create a host in Foreman. When adding/editing interfaces, select the above created subnet, and the next available IP in the selected subnet will be pulled from phpIPAM, and displayed in the IPv4 address field. _NOTE: This is not supported for IPv6._
 
 ## Local development
 
@@ -32,29 +32,29 @@ git clone https://github.com/theforeman/smart-proxy
 ```
 3. Fork both the foreman plugin and smart proxy plugin repos, then clone
 
-foreman_phpipam repo: https://github.com/grizzthedj/smart_proxy_phpipam  
-smart_proxy_phpipam repo: https://github.com/grizzthedj/smart_proxy_phpipam
+foreman_ipam repo: https://github.com/grizzthedj/foreman_ipam  
+smart_proxy_ipam repo: https://github.com/grizzthedj/smart_proxy_ipam
 
 ```
-git clone https://github.com/<GITHUB_USER>/foreman_phpipam
-git clone https://github.com/<GITHUB_USER>/smart_proxy_phpipam
+git clone https://github.com/<GITHUB_USER>/foreman_ipam
+git clone https://github.com/<GITHUB_USER>/smart_proxy_ipam
 ```
-4. Add the foreman_phpipam plugin to `Gemfile.local.rb` in the Foreman bundler.d directory
+4. Add the foreman_ipam plugin to `Gemfile.local.rb` in the Foreman bundler.d directory
 ```
-gem 'foreman_phpipam', :path => '/path/to/foreman_phpipam'
+gem 'foreman_ipam', :path => '/path/to/foreman_ipam'
 ```
 5. From Foreman root directory run 
 ```
 bundle install
 bundle exec rails db:migrate
-bundle exec rails db:seed    # This adds 'phpIPAM' feature to Features table
+bundle exec rails db:seed    # This adds 'external_ipam' feature to Features table
 bundle exec foreman start
 ```
 6. Add the smart_proxy_phpipam plugin to `Gemfile.local.rb` in Smart Proxy bundler.d directory
 ```
-gem 'smart_proxy_phpipam', :path => '/path/to/smart_proxy_phpipam'
+gem 'smart_proxy_ipam', :path => '/path/to/smart_proxy_ipam'
 ```
-7. Copy `config/settings.d/phpipam.yml.example` to `config/settings.d/phpipam.yml` and replace values with your phpIPAM URL and credentials.
+7. Copy `config/settings.d/external_ipam.yml.example` to `config/settings.d/external_ipam.yml` and replace values with your phpIPAM URL and credentials.
 8. From Smart Proxy root directory run ... 
 ```
 bundle install
@@ -62,7 +62,7 @@ bundle exec smart-proxy start
 ```
 9. Navigate to Foreman UI at http://localhost:5000
 10. Add a Local Smart Proxy in the Foreman UI(Infrastructure => Smart Proxies)
-11. Ensure that the `external_ipam` feature is present on the proxy(http://proxy_url/features)
+11. Ensure that the `external_ipam` feature is present on the proxy(http://localhost:8000/features)
 12. Create a Subnet, and associate the subnet to the `external_ipam` proxy
  
 ## Contributing

data/lib/smart_proxy_ipam/phpipam/phpipam_api.rb

@@ -2,6 +2,7 @@ require 'sinatra'
 require 'smart_proxy_ipam/ipam'
 require 'smart_proxy_ipam/ipam_main'
 require 'smart_proxy_ipam/phpipam/phpipam_client'
+require 'smart_proxy_ipam/phpipam/phpipam_helper'
 
 # TODO: Refactor later to handle multiple IPAM providers. For now, it is 
 # just phpIPAM that is supported
@@ -9,6 +10,7 @@ module Proxy::Phpipam
   class Api < ::Sinatra::Base
     include ::Proxy::Log
     helpers ::Proxy::Helpers
+    helpers PhpipamHelper
 
     # Gets the next available IP address based on a given subnet
     # 
@@ -23,33 +25,23 @@ module Proxy::Phpipam
       content_type :json
 
       begin
+        err = validate_required_params(["cidr", "mac"], params)
+        return err if err.length > 0
+
         cidr = params[:cidr]
         mac = params[:mac]
-
-        if not cidr
-          return {:error => "A 'cidr' parameter for the subnet must be provided(e.g. 100.10.10.0/24)"}.to_json
-        end
-        if not mac
-          return {:error => "A 'mac' address must be provided(e.g. 00:0a:95:9d:68:10)"}.to_json
-        end
-
         phpipam_client = PhpipamClient.new
         subnet = JSON.parse(phpipam_client.get_subnet(cidr))
 
-        if !subnet.kind_of?(Array) && subnet['message'] && subnet['message'].downcase == "no subnets found"
-          return {:error => "The specified subnet does not exist in External IPAM."}.to_json
-        end
-        
-        subnet_id = subnet[0]['id']
-        ip = phpipam_client.get_next_ip(subnet_id, mac, cidr)
+        return {:error => errors[:no_subnet]}.to_json if no_subnets_found(subnet)
+
+        ip = phpipam_client.get_next_ip(subnet[0]['id'], mac, cidr)
 
-        if !ip.kind_of?(Array) && ip['message'] && ip['message'].downcase == "no free addresses found"
-          return {:error => "There are no more free addresses in subnet #{cidr}"}.to_json
-        end
+        return {:error => errors[:no_free_ip]}.to_json if no_free_ip_found(ip)
 
         {:cidr => cidr, :next_ip => ip['next_ip']}.to_json
-      rescue Errno::ECONNREFUSED
-        return {:error => "Unable to connect to External IPAM server"}.to_json
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        return {:error => errors[:no_connection]}.to_json
       end
     end
 
@@ -76,17 +68,15 @@ module Proxy::Phpipam
       content_type :json
 
       begin
-        cidr = params[:cidr]
-
-        if not cidr
-          return {:error => "A 'cidr' parameter for the subnet must be provided(e.g. 100.10.10.0/24)"}.to_json
-        end
+        err = validate_required_params(["cidr"], params)
+        return err if err.length > 0
 
         phpipam_client = PhpipamClient.new
-        subnet = phpipam_client.get_subnet(cidr)
+        subnet = JSON.parse(phpipam_client.get_subnet(params[:cidr]))
+        return {:error => errors[:no_subnet]}.to_json if no_subnets_found(subnet)
         subnet.to_json
-      rescue Errno::ECONNREFUSED
-        return {:error => "Unable to connect to External IPAM server"}.to_json
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        return {:error => errors[:no_connection]}.to_json
       end
     end
 
@@ -107,10 +97,9 @@ module Proxy::Phpipam
 
       begin
         phpipam_client = PhpipamClient.new
-        sections = phpipam_client.get_sections
-        sections.to_json
-      rescue Errno::ECONNREFUSED
-        return {:error => "Unable to connect to External IPAM server"}.to_json
+        phpipam_client.get_sections.to_json
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        return {:error => errors[:no_connection]}.to_json
       end
     end
 
@@ -173,17 +162,19 @@ module Proxy::Phpipam
       content_type :json 
 
       begin
+        err = validate_required_params(["section_name"], params)
+        return err if err.length > 0
+ 
         section_name = URI.decode(params[:section_name])
-        
-        if not section_name
-          return {:error => "A 'section_name' must be provided"}.to_json
-        end
-
         phpipam_client = PhpipamClient.new
-        subnets = phpipam_client.get_subnets(section_name)
+        section = phpipam_client.get_section(section_name)
+
+        return {:error => errors[:no_section]}.to_json if section.nil?
+
+        subnets = phpipam_client.get_subnets(section['id'].to_s)
         subnets.to_json
-      rescue Errno::ECONNREFUSED
-        return {:error => "Unable to connect to External IPAM server"}.to_json
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        return {:error => errors[:no_connection]}.to_json
       end
     end
 
@@ -201,23 +192,17 @@ module Proxy::Phpipam
       content_type :json 
 
       begin
-        cidr = params[:cidr]
-        ip = params[:ip]
-
-        return {:error => "Missing 'cidr' parameter. A CIDR IPv4 address must be provided(e.g. 100.10.10.0/24)"}.to_json if not cidr
-        return {:error => "Missing 'ip' parameter. An IPv4 address must be provided(e.g. 100.10.10.22)"}.to_json if not ip
+        err = validate_required_params(["cidr", "ip"], params)
+        return err if err.length > 0
 
         phpipam_client = PhpipamClient.new
-        subnet = phpipam_client.get_subnet(cidr)
+        subnet = JSON.parse(phpipam_client.get_subnet(params[:cidr]))
 
-        if subnet['message'] && subnet['message'].downcase == "no subnets found"
-          return {:error => "The specified subnet does not exist in External IPAM."}.to_json
-        end
+        return {:error => errors[:no_subnet]}.to_json if no_subnets_found(subnet)
 
-        subnet_id = JSON.parse(subnet)[0]['id']
-        phpipam_client.ip_exists(ip, subnet_id)
-      rescue Errno::ECONNREFUSED
-        return {:error => "Unable to connect to External IPAM server"}.to_json
+        phpipam_client.ip_exists(params[:ip], subnet[0]['id'])
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        return {:error => errors[:no_connection]}.to_json
       end
     end
 
@@ -236,26 +221,21 @@ module Proxy::Phpipam
       content_type :json
 
       begin
-        cidr = params[:cidr]
-        ip = params[:ip]
-
-        return {:error => "Missing 'cidr' parameter. A CIDR IPv4 address must be provided(e.g. 100.10.10.0/24)"}.to_json if not cidr
-        return {:error => "Missing 'ip' parameter. An IPv4 address must be provided(e.g. 100.10.10.22)"}.to_json if not ip
+        err = validate_required_params(["cidr", "ip"], params)
+        return err if err.length > 0
 
+        ip = params[:ip]
+        cidr = params[:cidr]
         phpipam_client = PhpipamClient.new
-        response = phpipam_client.get_subnet(cidr)
-
-        if response['message'] && response['message'].downcase == "no subnets found"
-          return {:error => "The specified subnet does not exist in External IPAM."}.to_json
-        end
+        subnet = JSON.parse(phpipam_client.get_subnet(cidr))
 
-        subnet_id = JSON.parse(response)[0]['id']
+        return {:error => errors[:no_subnet]}.to_json if no_subnets_found(subnet)
 
-        phpipam_client.add_ip_to_subnet(ip, subnet_id, 'Address auto added by Foreman')
+        phpipam_client.add_ip_to_subnet(ip, subnet[0]['id'], 'Address auto added by Foreman')
 
         {:message => "IP #{ip} added to subnet #{cidr} successfully."}.to_json
-      rescue Errno::ECONNREFUSED
-        return {:error => "Unable to connect to External IPAM server"}.to_json
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        return {:error => errors[:no_connection]}.to_json
       end
     end
 
@@ -273,28 +253,22 @@ module Proxy::Phpipam
       content_type :json
 
       begin
-        cidr = params[:cidr]
-        ip = params[:ip]
-
-        return {:error => "Missing 'cidr' parameter. A CIDR IPv4 address must be provided(e.g. 100.10.10.0/24)"}.to_json if not cidr
-        return {:error => "Missing 'ip' parameter. An IPv4 address must be provided(e.g. 100.10.10.22)"}.to_json if not ip
+        err = validate_required_params(["cidr", "ip"], params)
+        return err if err.length > 0
 
+        ip = params[:ip]
+        cidr = params[:cidr]
         phpipam_client = PhpipamClient.new
-        response = phpipam_client.get_subnet(cidr)
-
-        if response['message'] && response['message'].downcase == "no subnets found"
-          return {:error => "The specified subnet does not exist in External IPAM."}.to_json
-        end
+        subnet = JSON.parse(phpipam_client.get_subnet(cidr))
 
-        subnet_id = JSON.parse(response)[0]['id']
+        return {:error => errors[:no_subnet]}.to_json if no_subnets_found(subnet)
 
-        phpipam_client.delete_ip_from_subnet(ip, subnet_id)
+        phpipam_client.delete_ip_from_subnet(ip, subnet[0]['id'])
 
         {:message => "IP #{ip} deleted from subnet #{cidr} successfully."}.to_json
-      rescue Errno::ECONNREFUSED
-        return {:error => "Unable to connect to External IPAM server"}.to_json
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        return {:error => errors[:no_connection]}.to_json
       end
     end
-
   end
 end

data/lib/smart_proxy_ipam/phpipam/phpipam_client.rb

@@ -5,10 +5,12 @@ require 'monitor'
 require 'concurrent'
 require 'smart_proxy_ipam/ipam'
 require 'smart_proxy_ipam/ipam_main'
+require 'smart_proxy_ipam/phpipam/phpipam_helper'
 
 module Proxy::Phpipam
   class PhpipamClient
     include Proxy::Log
+    include PhpipamHelper
 
     MAX_RETRIES = 5
     DEFAULT_CLEANUP_INTERVAL = 120  # 2 mins
@@ -26,25 +28,20 @@ module Proxy::Phpipam
 
     def get_subnet(cidr)
       subnets = get("subnets/cidr/#{cidr.to_s}")
+      return {:error => errors[:no_subnet]}.to_json if no_subnets_found(subnets)
       response = []
 
-      if subnets
-        if subnets['message'] && subnets['message'].downcase == 'no subnets found'
-          return {:message => "no subnets found"}.to_json
-        else 
-          # Only return the relevant fields
-          subnets['data'].each do |subnet|
-            response.push({
-              :id => subnet['id'],
-              :subnet => subnet['subnet'],
-              :description => subnet['description'],
-              :mask => subnet['mask']
-            })
-          end
-
-          return response.to_json
-        end
+      # Only return the relevant fields
+      subnets['data'].each do |subnet|
+        response.push({
+          :id => subnet['id'],
+          :subnet => subnet['subnet'],
+          :description => subnet['description'],
+          :mask => subnet['mask']
+        })
       end
+
+      response.to_json
     end
 
     def add_ip_to_subnet(ip, subnet_id, desc)
@@ -52,6 +49,10 @@ module Proxy::Phpipam
       post('addresses/', data) 
     end
 
+    def get_section(section_name)
+      get("sections/#{section_name}/")["data"]
+    end
+
     def get_sections
       sections = get('sections/')['data']
       response = []
@@ -69,11 +70,7 @@ module Proxy::Phpipam
       response
     end
 
-    def get_subnets(section_name)
-      sections = get_sections
-      section = sections.select {|section| section[:name] == section_name}
-      return {:error => "Section '#{section_name}' not found"}.to_json if section.size == 0
-      section_id = section[0][:id].to_s 
+    def get_subnets(section_id)
       subnets = get("sections/#{section_id}/subnets/")
       response = [] 
 
@@ -103,8 +100,8 @@ module Proxy::Phpipam
         return {:ip => ip, :exists => false}.to_json
       else 
         response = get("subnets/#{subnet_id.to_s}/addresses/#{ip}/")
-    
-        if response && response['message'] && response['message'].downcase == 'no addresses found'
+
+        if ip_not_found_in_ipam(response)
           return {:ip => ip, :exists => false}.to_json
         else 
           return {:ip => ip, :exists => true}.to_json
@@ -127,11 +124,11 @@ module Proxy::Phpipam
 
       return response if response['message']
 
-      if subnet_hash&.key?(mac.to_sym)
+      if subnet_hash && subnet_hash.key?(mac.to_sym)
         response['next_ip'] = @@ip_cache[cidr.to_sym][mac.to_sym]
       else
         new_ip = response['data']
-        ip_not_in_cache = subnet_hash&.key(new_ip).nil?
+        ip_not_in_cache = subnet_hash && subnet_hash.key(new_ip).nil?
 
         if ip_not_in_cache
           next_ip = new_ip.to_s

data/lib/smart_proxy_ipam/phpipam/phpipam_helper.rb

@@ -0,0 +1,36 @@
+module PhpipamHelper
+  def validate_required_params(required_params, params)
+    err = []
+    required_params.each do |param|
+      if not params[param.to_sym] 
+        err.push errors[param.to_sym]
+      end
+    end
+    err.length == 0 ? [] : {:error => err}.to_json
+  end
+
+  def no_subnets_found(subnet)
+    !subnet.kind_of?(Array) && subnet['message'] && subnet['message'].downcase == "no subnets found"
+  end
+
+  def no_free_ip_found(ip)
+    !ip.kind_of?(Array) && ip['message'] && ip['message'].downcase == "no free addresses found"
+  end
+
+  def ip_not_found_in_ipam(ip)
+    ip && ip['message'] && ip['message'].downcase == 'no addresses found'
+  end
+  
+  def errors
+    {
+      :cidr => "A 'cidr' parameter for the subnet must be provided(e.g. 100.10.10.0/24)",
+      :mac => "A 'mac' address must be provided(e.g. 00:0a:95:9d:68:10)",
+      :ip => "Missing 'ip' parameter. An IPv4 address must be provided(e.g. 100.10.10.22)",
+      :section_name => "A 'section_name' must be provided",
+      :no_free_ip => "There are no more free addresses in this subnet",
+      :no_section => "Section not found in External IPAM.",
+      :no_subnet => "The specified subnet does not exist in External IPAM.",
+      :no_connection => "Unable to connect to External IPAM server"
+    }
+  end
+end

data/lib/smart_proxy_ipam/version.rb

@@ -1,6 +1,6 @@
 
 module Proxy
   module Ipam
-    VERSION = '0.0.11'
+    VERSION = '0.0.12'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_ipam
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Christopher Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2019-09-13 00:00:00.000000000 Z
 dependencies: []
 description: Smart proxy plugin for IPAM integration with various IPAM providers
 email: chrisjsmith001@gmail.com
@@ -27,6 +27,7 @@ files:
 - lib/smart_proxy_ipam/ipam_main.rb
 - lib/smart_proxy_ipam/phpipam/phpipam_api.rb
 - lib/smart_proxy_ipam/phpipam/phpipam_client.rb
+- lib/smart_proxy_ipam/phpipam/phpipam_helper.rb
 - lib/smart_proxy_ipam/version.rb
 - settings.d/external_ipam.yml
 - settings.d/external_ipam.yml.example