smart_proxy_ipam 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aabee347a7edd212a629d75d24d812cbe772d16cc7626ee7691d550c28091d8
-  data.tar.gz: a516d9a3925ededc68b1a1738c9eb6d406e09e8769e042201fb28a86ba8071f0
+  metadata.gz: d0624875b34dd0cd44fcaa5446e22b5a9f4c2d9ee6426445ba8605fd80ee9df6
+  data.tar.gz: 9cecc6b2070e5fd02d1f42a7aa849b79a92d05dc18a660f2f5baf45af97bf368
 SHA512:
-  metadata.gz: 4956e02e3637c56c9274a36488723d1a49099362d238b57bbc41a9549c39ea75ecc0af1f4a88738cf3d0636c1c154b9b7ab1a146b98a11cf898700f062bbe4cc
-  data.tar.gz: d339ecc86c1d1f23e770fac2bd83d1f4245333a99b893c6cce847c47af29d89017e6c8f634f62c3f0f97cce5298f569dad7c28bedc55662d787a81fc5242327a
+  metadata.gz: 10ec0acd80412ff6cd523f99701cc1f57a61d67c6cf2e30b4c986c4cd61553443310ab32aa8f5116d8cbce8f5245c46c2a422f719f27d25cc5297550f5c465cf
+  data.tar.gz: c9324940694102cfccbf3088091f2a2fb6a978261d3ab2bb3d65fba88c7cd6d678dfc67a3b24f785035db4edaebd0b12729c4bb2df54d4c811bb7a58a11a0091

data/lib/smart_proxy_ipam/phpipam/phpipam_api.rb

@@ -31,10 +31,15 @@ module Proxy::Phpipam
 
         mac = params[:mac]
         cidr = params[:address] + '/' + params[:prefix]
+        section_name = params[:group]
+
         phpipam_client = PhpipamClient.new
-        subnet = JSON.parse(phpipam_client.get_subnet(cidr))
+        subnet = JSON.parse(phpipam_client.get_subnet(cidr, section_name))
+
         return {:code => subnet['code'], :error => subnet['message']}.to_json if no_subnets_found(subnet)
-        ipaddr = phpipam_client.get_next_ip(subnet['data'][0]['id'], mac, cidr)
+
+        ipaddr = phpipam_client.get_next_ip(subnet['data']['id'], mac, cidr, section_name)
+        
         return {:code => subnet['code'], :error => ipaddr['message']}.to_json if no_free_ip_found(JSON.parse(ipaddr))
 
         ipaddr
@@ -95,7 +100,7 @@ module Proxy::Phpipam
     #   ]
     #   Response if :error =>   
     #     {"error":"Unable to connect to phpIPAM server"}
-    get '/sections' do
+    get '/groups' do
       content_type :json
 
       begin
@@ -107,6 +112,37 @@ module Proxy::Phpipam
       end
     end
 
+    # Get a single sections from external ipam
+    #
+    # Input: Section name
+    # Returns: A JSON section on success, hash with "error" key otherwise
+    # Examples
+    #   Response if success: 
+    #     {"code":200,"success":true,"data":{"id":"80","name":"Development #1","description":null,
+    #      "masterSection":"0","permissions":"[]","strictMode":"1","subnetOrdering":"default","order":null,
+    #      "editDate":"2020-02-11 10:57:01","showVLAN":"1","showVRF":"1","showSupernetOnly":"1","DNS":null},"time":0.004}
+    #   Response if not found: 
+    #     {"code":404,"error":"Not Found"}
+    #   Response if :error =>   
+    #     {"error":"Unable to connect to phpIPAM server"}
+    get '/groups/:group_name' do
+      content_type :json 
+
+      begin
+        err = validate_required_params(["group_name"], params)
+        return err if err.length > 0
+ 
+        phpipam_client = PhpipamClient.new
+        section = JSON.parse(phpipam_client.get_section(params[:group_name]))
+
+        return {:code => section['code'], :error => section['message']}.to_json if no_section_found(section)
+        section.to_json
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        logger.debug(errors[:no_connection])
+        raise 
+      end
+    end
+
     # Get a list of subnets for given external ipam section/group
     #
     # Input: section_name(string). The name of the external ipam section/group
@@ -162,16 +198,15 @@ module Proxy::Phpipam
     #     }
     #   Response if :error =>   
     #     {"error":"Unable to connect to External IPAM server"}
-    get '/sections/:section_name/subnets' do
+    get '/groups/:group_name/subnets' do
       content_type :json 
 
       begin
-        err = validate_required_params(["section_name"], params)
+        err = validate_required_params(["group_name"], params)
         return err if err.length > 0
- 
-        section_name = CGI.unescape(params[:section_name])
+
         phpipam_client = PhpipamClient.new
-        section = JSON.parse(phpipam_client.get_section(section_name))
+        section = JSON.parse(phpipam_client.get_section(params[:group_name]))
 
         return {:code => section['code'], :error => section['message']}.to_json if no_section_found(section)
 
@@ -204,12 +239,13 @@ module Proxy::Phpipam
 
         ip = params[:ip]
         cidr = params[:address] + '/' + params[:prefix]
+        section_name = params[:group]
         phpipam_client = PhpipamClient.new
-        subnet = JSON.parse(phpipam_client.get_subnet(cidr))
+        subnet = JSON.parse(phpipam_client.get_subnet(cidr, section_name))
 
         return {:code => subnet['code'], :error => subnet['message']}.to_json if no_subnets_found(subnet)
 
-        phpipam_client.ip_exists(ip, subnet['data'][0]['id'])
+        phpipam_client.ip_exists(ip, subnet['data']['id'])
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
         logger.debug(errors[:no_connection])
         raise 
@@ -239,12 +275,14 @@ module Proxy::Phpipam
 
         ip = params[:ip]
         cidr = params[:address] + '/' + params[:prefix]
+        section_name = URI.escape(params[:group])
+
         phpipam_client = PhpipamClient.new
-        subnet = JSON.parse(phpipam_client.get_subnet(cidr))
+        subnet = JSON.parse(phpipam_client.get_subnet(cidr, section_name))
 
         return {:code => subnet['code'], :error => subnet['message']}.to_json if no_subnets_found(subnet)
 
-        phpipam_client.add_ip_to_subnet(ip, subnet['data'][0]['id'], 'Address auto added by Foreman')
+        phpipam_client.add_ip_to_subnet(ip, subnet['data']['id'], 'Address auto added by Foreman')
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
         logger.debug(errors[:no_connection])
         raise 
@@ -272,14 +310,46 @@ module Proxy::Phpipam
 
         ip = params[:ip]
         cidr = params[:address] + '/' + params[:prefix]
+        section_name = URI.escape(params[:group])
         phpipam_client = PhpipamClient.new
-        subnet = JSON.parse(phpipam_client.get_subnet(cidr))
+        subnet = JSON.parse(phpipam_client.get_subnet(cidr, section_name))
 
         return {:code => subnet['code'], :error => subnet['message']}.to_json if no_subnets_found(subnet)
 
-        phpipam_client.delete_ip_from_subnet(ip, subnet['data'][0]['id'])
+        phpipam_client.delete_ip_from_subnet(ip, subnet['data']['id'])
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-        return {:error => errors[:no_connection]}.to_json
+        logger.debug(errors[:no_connection])
+        raise 
+      end
+    end
+
+    # Checks whether a subnet exists in a specific section.
+    #
+    # Params: 1. address:   The network address of the IPv4 or IPv6 subnet.
+    #         2. prefix:    The subnet prefix(e.g. 24)
+    #         3. group:     The name of the section
+    #
+    # Returns: JSON object with 'data' field is exists, otherwise field with 'error'
+    # 
+    # Example: 
+    #   Response if exists: 
+    #     {"code":200,"success":true,"data":{"id":"147","subnet":"172.55.55.0","mask":"29","sectionId":"84","description":null,"linked_subnet":null,"firewallAddressObject":null,"vrfId":"0","masterSubnetId":"0","allowRequests":"0","vlanId":"0","showName":"0","device":"0","permissions":"[]","pingSubnet":"0","discoverSubnet":"0","resolveDNS":"0","DNSrecursive":"0","DNSrecords":"0","nameserverId":"0","scanAgent":"0","customer_id":null,"isFolder":"0","isFull":"0","tag":"2","threshold":"0","location":"0","editDate":null,"lastScan":null,"lastDiscovery":null,"calculation":{"Type":"IPv4","IP address":"\/","Network":"172.55.55.0","Broadcast":"172.55.55.7","Subnet bitmask":"29","Subnet netmask":"255.255.255.248","Subnet wildcard":"0.0.0.7","Min host IP":"172.55.55.1","Max host IP":"172.55.55.6","Number of hosts":"6","Subnet Class":false}},"time":0.009}
+    #   Response if not exists:
+    #     {"code":404,"error":"No subnet 172.66.66.0/29 found in section :group"}
+    get '/group/:group/subnet/:address/:prefix' do
+      content_type :json 
+
+      begin
+        err = validate_required_params(["address", "prefix", "group"], params)
+        return err if err.length > 0
+
+        cidr = params[:address] + '/' + params[:prefix]
+
+        phpipam_client = PhpipamClient.new
+        phpipam_client.get_subnet_by_section(cidr, params[:group])
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        logger.debug(errors[:no_connection])
+        raise 
       end
     end
   end

data/lib/smart_proxy_ipam/phpipam/phpipam_client.rb

@@ -4,6 +4,7 @@ require 'net/http'
 require 'monitor'
 require 'concurrent'
 require 'time'
+require 'uri'
 require 'smart_proxy_ipam/ipam'
 require 'smart_proxy_ipam/ipam_main'
 require 'smart_proxy_ipam/phpipam/phpipam_helper'
@@ -14,7 +15,7 @@ module Proxy::Phpipam
     include PhpipamHelper
 
     MAX_RETRIES = 5
-    DEFAULT_CLEANUP_INTERVAL = 120  # 2 mins
+    DEFAULT_CLEANUP_INTERVAL = 60  # 2 mins
     @@ip_cache = nil
     @@timer_task = nil
 
@@ -27,13 +28,35 @@ module Proxy::Phpipam
       start_cleanup_task if @@timer_task.nil?
     end
 
-    def get_subnet(cidr)
+    def get_subnet(cidr, section_name = nil)
+      if section_name.nil? || section_name.empty?
+        get_subnet_by_cidr(cidr)
+      else
+        get_subnet_by_section(cidr, section_name)
+      end
+    end
+
+    def get_subnet_by_section(cidr, section_name)
+      section = JSON.parse(get_section(section_name))
+      subnets = JSON.parse(get_subnets(section['data']['id']))
+      subnet_id = nil
+
+      subnets['data'].each do |subnet|
+        subnet_cidr = subnet['subnet'] + '/' + subnet['mask']
+        subnet_id = subnet['id'] if subnet_cidr == cidr
+      end
+      
+      return {:code => 404, :error => "No subnet #{cidr} found in section #{URI.unescape(section_name)}"}.to_json if subnet_id.nil?
+      
+      response = get("subnets/#{subnet_id.to_s}/")
+      response.body
+    end
+
+    def get_subnet_by_cidr(cidr)
       response = get("subnets/cidr/#{cidr.to_s}")
       json_body = JSON.parse(response.body)
-
       return response.body if no_subnets_found(json_body)
-
-      json_body['data'] = filter_fields(json_body, [:id, :subnet, :description, :mask])
+      json_body['data'] = filter_fields(json_body, [:id, :subnet, :description, :mask])[0]
       response.body = json_body.to_json
       response.header['Content-Length'] = json_body.to_s.length
       response.body
@@ -78,15 +101,17 @@ module Proxy::Phpipam
       response.body
     end
 
-    def get_next_ip(subnet_id, mac, cidr)
+    def get_next_ip(subnet_id, mac, cidr, section_name)
       response = get("subnets/#{subnet_id.to_s}/first_free/")
       json_body = JSON.parse(response.body)
-      subnet_hash = @@ip_cache[cidr.to_sym]
+      section = section_name.nil? ? "" : section_name
+      @@ip_cache[section.to_sym] = {} if @@ip_cache[section.to_sym].nil?
+      subnet_hash = @@ip_cache[section.to_sym][cidr.to_sym]
 
       return {:code => json_body['code'], :error => json_body['message']}.to_json if json_body['message']
 
       if subnet_hash && subnet_hash.key?(mac.to_sym)
-        json_body['data'] = @@ip_cache[cidr.to_sym][mac.to_sym][:ip]
+        json_body['data'] = @@ip_cache[section_name.to_sym][cidr.to_sym][mac.to_sym][:ip]
       else
         next_ip = nil
         new_ip = json_body['data']
@@ -94,9 +119,9 @@ module Proxy::Phpipam
 
         if ip_not_in_cache
           next_ip = new_ip.to_s
-          add_ip_to_cache(new_ip, mac, cidr)
+          add_ip_to_cache(new_ip, mac, cidr, section)
         else
-          next_ip = find_new_ip(subnet_id, new_ip, mac, cidr)
+          next_ip = find_new_ip(subnet_id, new_ip, mac, cidr, section)
         end
 
         return {:code => 404, :error => "Unable to find another available IP address in subnet #{cidr}"}.to_json if next_ip.nil?
@@ -119,49 +144,68 @@ module Proxy::Phpipam
     private
 
     # @@ip_cache structure
+    # 
+    # Groups of subnets are cached under the External IPAM Group name. For example,
+    # "IPAM Group Name" would be the section name in phpIPAM. All IP's cached for subnets
+    # that do not have an External IPAM group specified, they are cached under the "" key.
+    #
     # {  
-    #   "100.55.55.0/24":{  
-    #      "00:0a:95:9d:68:10": {"ip": "100.55.55.1", "timestamp": "2019-09-17 12:03:43 -D400"}
+    #   "": {
+    #     "100.55.55.0/24":{  
+    #       "00:0a:95:9d:68:10": {"ip": "100.55.55.1", "timestamp": "2019-09-17 12:03:43 -D400"}
+    #     },
+    #   },
+    #   "IPAM Group Name": {
+    #     "123.11.33.0/24":{  
+    #       "00:0a:95:9d:68:33": {"ip": "123.11.33.1", "timestamp": "2019-09-17 12:04:43 -0400"},
+    #       "00:0a:95:9d:68:34": {"ip": "123.11.33.2", "timestamp": "2019-09-17 12:05:48 -0400"},
+    #       "00:0a:95:9d:68:35": {"ip": "123.11.33.3", "timestamp:: "2019-09-17 12:06:50 -0400"}
+    #     }
     #   },
-    #   "123.11.33.0/24":{  
-    #      "00:0a:95:9d:68:33": {"ip": "123.11.33.1", "timestamp": "2019-09-17 12:04:43 -0400"}
-    #      "00:0a:95:9d:68:34": {"ip": "123.11.33.2", "timestamp": "2019-09-17 12:05:48 -0400"}
-    #      "00:0a:95:9d:68:35": {"ip": "123.11.33.3", "timestamp:: "2019-09-17 12:06:50 -0400"}
+    #   "Another IPAM Group": {
+    #     "185.45.39.0/24":{  
+    #       "00:0a:95:9d:68:55": {"ip": "185.45.39.1", "timestamp": "2019-09-17 12:04:43 -0400"},
+    #       "00:0a:95:9d:68:56": {"ip": "185.45.39.2", "timestamp": "2019-09-17 12:05:48 -0400"}
+    #     }
     #   }
     # }
     def init_cache
-      logger.debug("Clearing ip cache.")
       @@m.synchronize do
         if @@ip_cache and not @@ip_cache.empty?
-          @@ip_cache.each do |key, values|
-            values.each do |mac, value|
-              if Time.now - Time.parse(value[:timestamp]) > DEFAULT_CLEANUP_INTERVAL
-                @@ip_cache[key].delete(mac)
+          logger.debug("Processing ip cache.")
+          @@ip_cache.each do |section, subnets|
+            subnets.each do |cidr, macs|
+              macs.each do |mac, ip|
+                if Time.now - Time.parse(ip[:timestamp]) > DEFAULT_CLEANUP_INTERVAL
+                  @@ip_cache[section][cidr].delete(mac)
+                end
               end
+              @@ip_cache[section].delete(cidr) if @@ip_cache[section][cidr].nil? or @@ip_cache[section][cidr].empty?
             end
-            @@ip_cache.delete(key) if @@ip_cache[key].nil? or @@ip_cache[key].empty?
           end
         else
-          @@ip_cache = {}
+          logger.debug("Clearing ip cache.")
+          @@ip_cache = {:"" => {}}
         end
       end
     end
 
-    def add_ip_to_cache(ip, mac, cidr)
-      logger.debug("Adding IP #{ip} to cache for subnet #{cidr}")
+    def add_ip_to_cache(ip, mac, cidr, section_name)
+      logger.debug("Adding IP #{ip} to cache for subnet #{cidr} in section #{section_name}")
       @@m.synchronize do
         # Clear cache data which has the same mac and ip with the new one 
-        @@ip_cache.each do |key, values|
+        section_hash = @@ip_cache[section_name.to_sym]
+        section_hash.each do |key, values|
           if values.keys.include? mac.to_sym
-            @@ip_cache[key].delete(mac.to_sym)
+            @@ip_cache[section_name.to_sym][key].delete(mac.to_sym)
           end
-          @@ip_cache.delete(key) if @@ip_cache[key].nil? or @@ip_cache[key].empty?
+          @@ip_cache[section_name.to_sym].delete(key) if @@ip_cache[section_name.to_sym][key].nil? or @@ip_cache[section_name.to_sym][key].empty?
         end   
-        
-        if @@ip_cache.key?(cidr.to_sym)
-          @@ip_cache[cidr.to_sym][mac.to_sym] = {:ip => ip.to_s, :timestamp => Time.now.to_s}
+      
+        if section_hash.key?(cidr.to_sym)
+          @@ip_cache[section_name.to_sym][cidr.to_sym][mac.to_sym] = {:ip => ip.to_s, :timestamp => Time.now.to_s}
         else
-          @@ip_cache = @@ip_cache.merge({cidr.to_sym => {mac.to_sym => {:ip => ip.to_s, :timestamp => Time.now.to_s}}})
+          @@ip_cache = @@ip_cache.merge({section_name.to_sym => {cidr.to_sym => {mac.to_sym => {:ip => ip.to_s, :timestamp => Time.now.to_s}}}})
         end
       end
     end
@@ -169,7 +213,7 @@ module Proxy::Phpipam
     # Called when next available IP from external IPAM has been cached by another user/host, but 
     # not actually persisted in external IPAM. Will increment the IP(MAX_RETRIES times), and 
     # see if it is available in external IPAM.
-    def find_new_ip(subnet_id, ip, mac, cidr)
+    def find_new_ip(subnet_id, ip, mac, cidr, section_name)
       found_ip = nil
       temp_ip = ip
       retry_count = 0
@@ -179,9 +223,9 @@ module Proxy::Phpipam
         verify_ip = JSON.parse(ip_exists(new_ip, subnet_id))
 
         # If new IP doesn't exist in IPAM and not in the cache
-        if ip_not_found_in_ipam(verify_ip) && !ip_exists_in_cache(new_ip, cidr, mac)
+        if ip_not_found_in_ipam(verify_ip) && !ip_exists_in_cache(new_ip, cidr, mac, section_name)
           found_ip = new_ip.to_s
-          add_ip_to_cache(found_ip, mac, cidr)
+          add_ip_to_cache(found_ip, mac, cidr, section_name)
           break
         end
 
@@ -200,8 +244,8 @@ module Proxy::Phpipam
       IPAddr.new(ip.to_s).succ.to_s
     end
 
-    def ip_exists_in_cache(ip, cidr, mac)
-      @@ip_cache[cidr.to_sym] && @@ip_cache[cidr.to_sym].to_s.include?(ip.to_s)      
+    def ip_exists_in_cache(ip, cidr, mac, section_name)
+      @@ip_cache[section_name.to_sym][cidr.to_sym] && @@ip_cache[section_name.to_sym][cidr.to_sym].to_s.include?(ip.to_s)      
     end
 
     # Checks if given IP is within a subnet. Broadcast address is considered unusable

data/lib/smart_proxy_ipam/phpipam/phpipam_helper.rb

@@ -10,7 +10,7 @@ module PhpipamHelper
   end
 
   def no_subnets_found(subnet)
-    !subnet.kind_of?(Array) && subnet['message'] && subnet['message'].downcase == "no subnets found"
+    subnet['message'] && subnet['message'].downcase == "no subnets found"
   end
 
   def no_section_found(section)

data/lib/smart_proxy_ipam/version.rb

@@ -1,6 +1,6 @@
 
 module Proxy
   module Ipam
-    VERSION = '0.0.16'
+    VERSION = '0.0.17'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_ipam
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Christopher Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-20 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies: []
 description: Smart proxy plugin for IPAM integration with various IPAM providers
 email: chrisjsmith001@gmail.com