smart_proxy_ipam 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0624875b34dd0cd44fcaa5446e22b5a9f4c2d9ee6426445ba8605fd80ee9df6
-  data.tar.gz: 9cecc6b2070e5fd02d1f42a7aa849b79a92d05dc18a660f2f5baf45af97bf368
+  metadata.gz: 58e0c15cc7ee1369b7a1c5b7fa7cfcae0c7c54d75c8fc6486f02c8672447e0f8
+  data.tar.gz: f7937ba79296964dbfb142c3655e8c0c2c6f97745c10c40fcb3b3eec2b2390d2
 SHA512:
-  metadata.gz: 10ec0acd80412ff6cd523f99701cc1f57a61d67c6cf2e30b4c986c4cd61553443310ab32aa8f5116d8cbce8f5245c46c2a422f719f27d25cc5297550f5c465cf
-  data.tar.gz: c9324940694102cfccbf3088091f2a2fb6a978261d3ab2bb3d65fba88c7cd6d678dfc67a3b24f785035db4edaebd0b12729c4bb2df54d4c811bb7a58a11a0091
+  metadata.gz: 68a637fbf28997b2fff0d961f1d8c6b5ffb6dcd8b32824bc25753a913429ba168e94261c3c9706ad1f2edeb786926c3626c91912c4b14976e34013f7e1bb419d
+  data.tar.gz: 291c8293ee1e81b577ac96e25fbcb497c6438c9a1d6c4411f7e91e073dfbf3d77847115cf0621a9c0c279f0d20bd259eed148e81375551c6fa6f5540c4fa6e9e

data/lib/smart_proxy_ipam/phpipam/phpipam_api.rb

@@ -36,11 +36,12 @@ module Proxy::Phpipam
         phpipam_client = PhpipamClient.new
         subnet = JSON.parse(phpipam_client.get_subnet(cidr, section_name))
 
-        return {:code => subnet['code'], :error => subnet['message']}.to_json if no_subnets_found(subnet)
+        return {:code => subnet['code'], :error => subnet['error']}.to_json if no_subnets_found?(subnet)
 
         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_parsed = JSON.parse(ipaddr)
+
+        return {:code => 404, :error => ipaddr_parsed['error']}.to_json if no_free_ip_found?(ipaddr_parsed)
 
         ipaddr
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
@@ -105,7 +106,9 @@ module Proxy::Phpipam
 
       begin
         phpipam_client = PhpipamClient.new
-        phpipam_client.get_sections
+        sections = phpipam_client.get_sections
+        return {:code => 200, :data => []}.to_json if no_sections_found?(JSON.parse(sections))
+        sections
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
         logger.debug(errors[:no_connection])
         raise 
@@ -125,17 +128,18 @@ module Proxy::Phpipam
     #     {"code":404,"error":"Not Found"}
     #   Response if :error =>   
     #     {"error":"Unable to connect to phpIPAM server"}
-    get '/groups/:group_name' do
+    get '/groups/:group' do
       content_type :json 
 
       begin
-        err = validate_required_params(["group_name"], params)
+        err = validate_required_params(["group"], params)
         return err if err.length > 0
  
         phpipam_client = PhpipamClient.new
-        section = JSON.parse(phpipam_client.get_section(params[:group_name]))
+        section = JSON.parse(phpipam_client.get_section(params[:group]))
 
-        return {:code => section['code'], :error => section['message']}.to_json if no_section_found(section)
+        return {:code => section['code'], :error => section['message']}.to_json if no_section_found?(section)
+        puts "SECTION: " + section.to_json
         section.to_json
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
         logger.debug(errors[:no_connection])
@@ -198,19 +202,19 @@ module Proxy::Phpipam
     #     }
     #   Response if :error =>   
     #     {"error":"Unable to connect to External IPAM server"}
-    get '/groups/:group_name/subnets' do
+    get '/groups/:group/subnets' do
       content_type :json 
 
       begin
-        err = validate_required_params(["group_name"], params)
+        err = validate_required_params(["group"], params)
         return err if err.length > 0
 
         phpipam_client = PhpipamClient.new
-        section = JSON.parse(phpipam_client.get_section(params[:group_name]))
+        section = JSON.parse(phpipam_client.get_section(params[:group]))
 
-        return {:code => section['code'], :error => section['message']}.to_json if no_section_found(section)
+        return {:code => 404, :error => errors[:no_section]}.to_json if no_section_found?(section)
 
-        phpipam_client.get_subnets(section['data']['id'].to_s)
+        phpipam_client.get_subnets(section['data']['id'].to_s, false)
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
         logger.debug(errors[:no_connection])
         raise 
@@ -243,9 +247,15 @@ module Proxy::Phpipam
         phpipam_client = PhpipamClient.new
         subnet = JSON.parse(phpipam_client.get_subnet(cidr, section_name))
 
-        return {:code => subnet['code'], :error => subnet['message']}.to_json if no_subnets_found(subnet)
+        return {:code => 404, :error => subnet['error']}.to_json if no_subnets_found?(subnet)
+
+        ip_exists = JSON.parse(phpipam_client.ip_exists(ip, subnet['data']['id']))
 
-        phpipam_client.ip_exists(ip, subnet['data']['id'])
+        if ip_exists['data']
+          return {:code => 200, :exists => true}.to_json
+        else
+          return {:code => 404, :exists => false}.to_json 
+        end
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
         logger.debug(errors[:no_connection])
         raise 
@@ -280,9 +290,15 @@ module Proxy::Phpipam
         phpipam_client = PhpipamClient.new
         subnet = JSON.parse(phpipam_client.get_subnet(cidr, section_name))
 
-        return {:code => subnet['code'], :error => subnet['message']}.to_json if no_subnets_found(subnet)
+        return {:code => 404, :error => subnet['error']}.to_json if no_subnets_found?(subnet)
 
-        phpipam_client.add_ip_to_subnet(ip, subnet['data']['id'], 'Address auto added by Foreman')
+        add_ip = JSON.parse(phpipam_client.add_ip_to_subnet(ip, subnet['data']['id'], 'Address auto added by Foreman'))
+
+        if add_ip['message'] && add_ip['message'] == "Address created"
+          return {:code => 200}.to_json
+        else
+          return {:code => 500, :error => add_ip['message']}.to_json
+        end
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
         logger.debug(errors[:no_connection])
         raise 
@@ -314,9 +330,15 @@ module Proxy::Phpipam
         phpipam_client = PhpipamClient.new
         subnet = JSON.parse(phpipam_client.get_subnet(cidr, section_name))
 
-        return {:code => subnet['code'], :error => subnet['message']}.to_json if no_subnets_found(subnet)
+        return {:code => 404, :error => subnet['error']}.to_json if no_subnets_found?(subnet)
+
+        delete_ip = JSON.parse(phpipam_client.delete_ip_from_subnet(ip, subnet['data']['id']))
 
-        phpipam_client.delete_ip_from_subnet(ip, subnet['data']['id'])
+        if delete_ip['message'] && delete_ip['message'] == "Address deleted"
+          return {:code => 200}.to_json
+        else 
+          return {:code => 500, :error => delete_ip['message']}.to_json
+        end
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
         logger.debug(errors[:no_connection])
         raise 

data/lib/smart_proxy_ipam/phpipam/phpipam_client.rb

@@ -36,9 +36,9 @@ module Proxy::Phpipam
       end
     end
 
-    def get_subnet_by_section(cidr, section_name)
+    def get_subnet_by_section(cidr, section_name, include_id = true)
       section = JSON.parse(get_section(section_name))
-      subnets = JSON.parse(get_subnets(section['data']['id']))
+      subnets = JSON.parse(get_subnets(section['data']['id'], include_id))
       subnet_id = nil
 
       subnets['data'].each do |subnet|
@@ -49,14 +49,19 @@ module Proxy::Phpipam
       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}/")
+      json_body = JSON.parse(response.body)
+      json_body['data'] = filter_hash(json_body['data'], [:id, :subnet, :mask, :description]) if json_body['data']
+      json_body = filter_hash(json_body, [:code, :data, :error, :message])
+      response.body = json_body.to_json
+      response.header['Content-Length'] = json_body.to_s.length
       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])[0]
+      json_body = filter_hash(json_body, [:code, :data, :error, :message])
       response.body = json_body.to_json
       response.header['Content-Length'] = json_body.to_s.length
       response.body
@@ -64,22 +69,31 @@ module Proxy::Phpipam
 
     def get_section(section_name)
       response = get("sections/#{section_name}/")
+      json_body = JSON.parse(response.body)
+      json_body['data'] = filter_hash(json_body['data'], [:id, :name, :description]) if json_body['data']
+      json_body = filter_hash(json_body, [:code, :data, :error, :message])
+      response.body = json_body.to_json
+      response.header['Content-Length'] = json_body.to_s.length
       response.body
     end
 
     def get_sections
       response = get('sections/')
       json_body = JSON.parse(response.body)
-      json_body['data'] = filter_fields(json_body, [:id, :name, :description])
+      json_body['data'] = filter_fields(json_body, [:id, :name, :description]) if json_body['data']
+      json_body = filter_hash(json_body, [:code, :data, :error, :message])
       response.body = json_body.to_json
       response.header['Content-Length'] = json_body.to_s.length
       response.body
     end
 
-    def get_subnets(section_id)
+    def get_subnets(section_id, include_id = true)
       response = get("sections/#{section_id}/subnets/")
+      fields = [:subnet, :mask, :description]
+      fields.push(:id) if include_id
       json_body = JSON.parse(response.body)
-      json_body['data'] = filter_fields(json_body, [:id, :subnet, :mask, :sectionId, :description])
+      json_body['data'] = filter_fields(json_body, fields) if json_body['data']
+      json_body = filter_hash(json_body, [:code, :data, :error, :message])
       response.body = json_body.to_json
       response.header['Content-Length'] = json_body.to_s.length
       response.body
@@ -87,17 +101,30 @@ module Proxy::Phpipam
 
     def ip_exists(ip, subnet_id)
       response = get("subnets/#{subnet_id.to_s}/addresses/#{ip}/")
+      json_body = JSON.parse(response.body)
+      json_body['data'] = filter_fields(json_body, [:ip]) if json_body['data']
+      json_body = filter_hash(json_body, [:code, :data, :error, :message])
+      response.body = json_body.to_json
+      response.header['Content-Length'] = json_body.to_s.length
       response.body
     end
 
     def add_ip_to_subnet(ip, subnet_id, desc)
       data = {:subnetId => subnet_id, :ip => ip, :description => desc}
       response = post('addresses/', data)
+      json_body = JSON.parse(response.body)
+      json_body = filter_hash(json_body, [:code, :error, :message])
+      response.body = json_body.to_json
+      response.header['Content-Length'] = json_body.to_s.length
       response.body
     end
 
     def delete_ip_from_subnet(ip, subnet_id)
       response = delete("addresses/#{ip}/#{subnet_id.to_s}/") 
+      json_body = JSON.parse(response.body)
+      json_body = filter_hash(json_body, [:code, :error, :message])
+      response.body = json_body.to_json
+      response.header['Content-Length'] = json_body.to_s.length
       response.body
     end
 
@@ -130,6 +157,8 @@ module Proxy::Phpipam
         json_body['data'] = next_ip
       end
 
+      json_body = {:code => json_body['code'], :data => json_body['data']}
+
       response.body = json_body.to_json
       response.header['Content-Length'] = json_body.to_s.length
       response.body
@@ -223,7 +252,7 @@ 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, section_name)
+        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, section_name)
           break

data/lib/smart_proxy_ipam/phpipam/phpipam_helper.rb

@@ -9,19 +9,23 @@ module PhpipamHelper
     err.length == 0 ? [] : {:code => 400, :error => err}.to_json
   end
 
-  def no_subnets_found(subnet)
-    subnet['message'] && subnet['message'].downcase == "no subnets found"
+  def no_subnets_found?(subnet)
+    subnet['error'] && subnet['error'].downcase == "no subnets found"
   end
 
-  def no_section_found(section)
+  def no_section_found?(section)
     section['message'] && section['message'].downcase == "not found"
   end
 
-  def no_free_ip_found(ip)
-    !ip.kind_of?(Array) && ip['message'] && ip['message'].downcase == "no free addresses found"
+  def no_sections_found?(sections)
+    sections['message'] && sections['message'].downcase == "no sections available"
   end
 
-  def ip_not_found_in_ipam(ip)
+  def no_free_ip_found?(ip)
+    ip['error'] && ip['error'].downcase == "no free addresses found"
+  end
+
+  def ip_not_found_in_ipam?(ip)
     ip && ip['message'] && ip['message'].downcase == 'no addresses found'
   end
   
@@ -36,13 +40,23 @@ module PhpipamHelper
     data
   end
 
+  # Returns a hash with only the fields given in the fields param
+  def filter_hash(hash, fields) 
+    new_hash = {}
+    fields.each do |field| 
+      new_hash[field.to_sym] = hash[field.to_s] if hash[field.to_s]
+    end
+    new_hash
+  end
+
   def errors
     {
       :cidr => "A 'cidr' parameter for the subnet must be provided(e.g. IPv4: 100.10.10.0/24, IPv6: 2001:db8:abcd:12::/124)",
       :mac => "A 'mac' address must be provided(e.g. 00:0a:95:9d:68:10)",
       :ip => "Missing 'ip' parameter. An IPv4 or IPv6 address must be provided(e.g. IPv4: 100.10.10.22, IPv6: 2001:db8:abcd:12::3)",
       :section_name => "A 'section_name' must be provided",
-      :no_connection => "Unable to connect to External IPAM server"
+      :no_connection => "Unable to connect to External IPAM server",
+      :no_section => "Group not found in External IPAM"
     }
   end
 end

data/lib/smart_proxy_ipam/version.rb

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

metadata

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