smart_proxy_ipam 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf80d5537986cfb15d05ac927e2c0498a9cdcab10c98866dab18b4ead3a91131
-  data.tar.gz: 57d175cf91379394aae2f6ba477d0c89a84b4774363e9e391bc473fa9454bc5f
+  metadata.gz: f64f77c875cf2954bfe2d9fb2e1c56e1848e402ec8259959382771da8cd7158b
+  data.tar.gz: a4e3900fd2ad8a2ec16e9ab3887dd6412ce567b16f7cdb98278407c80add8e9c
 SHA512:
-  metadata.gz: 47f2404f8982398568a8d6d1984116658e7dd9eead7679f836c74bef9772bab678b084b82cdddfbfcc8d6b6b19adf3962510c5b566c0f7a1b80d53b9e9505da8
-  data.tar.gz: e3dc74e8020a7af4c7f660ef7204c03130088a58dd5fff23a0d18440061d3f602182f6a13f0a1d363429ad860499ce87ab33f71fa524a7f10f8006075f469e44
+  metadata.gz: 3608be9d60dda80356bdf9e9c59f79cf0edcd1c69210cb7c10aa818237ec85e1485e8fd12d2ee1c1d527ca3ab926d1090ef20c2a6bc4faf8f2c4b262f86df44c
+  data.tar.gz: a99d59aab8ce7b3f1a1b6d4b90e861fef90435c9071e0b42d3f7863834a660050d8e96af471473b4e6f0a0b8db8b1f1d212502e01ac80073e79a1542d731fff6

data/README.md

@@ -1,8 +1,12 @@
-# smart_proxy_phpipam
+# smart_proxy_ipam
 
-Foreman Smart Proxy plugin for IPAM integration with [phpIPAM](https://phpipam.net/). 
+Foreman Smart Proxy plugin for IPAM integration with various IPAM providers.
+
+Currently supported Providers: 
+1. [phpIPAM](https://phpipam.net/). 
+
+Provides a basic Dashboard for viewing phpIPAM sections, subnets. Also supports obtaining of the next available IPv4 address for a given subnet(via [IPAM Smart Proxy Plugin](https://github.com/grizzthedj/smart_proxy_ipam)).
 
-Used for obtaining the next available IPv4 address from phpIPAM, for a given subnet.
 
 ## Installation
 

data/lib/smart_proxy_ipam/ipam_http_config.ru

@@ -1,11 +1,6 @@
 
 require 'smart_proxy_ipam/phpipam/phpipam_api'
-require 'smart_proxy_ipam/ipam/ipam_api'
 
-map '/phpipam' do
+map '/ipam' do
   run Proxy::Phpipam::Api
 end
-
-map '/ipam' do
-  run Proxy::Ipam::Api
-end

data/lib/smart_proxy_ipam/phpipam/phpipam_api.rb

@@ -3,11 +3,27 @@ require 'smart_proxy_ipam/ipam'
 require 'smart_proxy_ipam/ipam_main'
 require 'smart_proxy_ipam/phpipam/phpipam_client'
 
+# TODO: Refactor later to handle multiple IPAM providers. For now, it is 
+# just phpIPAM that is supported
 module Proxy::Phpipam
   class Api < ::Sinatra::Base
     include ::Proxy::Log
     helpers ::Proxy::Helpers
 
+    get '/providers' do
+      content_type :json
+      {ipam_providers: ['phpIPAM']}.to_json
+    end
+
+    # Gets the next available IP address based on a given subnet
+    # 
+    # Input:   cidr(string): CIDR address in the format: "100.20.20.0/24"
+    # Returns: Hash with "next_ip", or hash with "error"
+    # Examples: 
+    #   Response if success: 
+    #     {"cidr":"100.20.20.0/24","next_ip":"100.20.20.11"}
+    #   Response if error:   
+    #     {"error":"The specified subnet does not exist in phpIPAM."}
     get '/next_ip' do
       content_type :json
 
@@ -22,10 +38,10 @@ module Proxy::Phpipam
         response = phpipam_client.get_subnet(cidr)
 
         if response['message'] && response['message'].downcase == "no subnets found"
-          return {error: "The specified subnet does not exist in phpIPAM."}.to_json
+          return {error: "The specified subnet does not exist in External IPAM."}.to_json
         end
   
-        subnet_id = response['data'][0]['id']
+        subnet_id = JSON.parse(response)[0]['id']
         response = phpipam_client.get_next_ip(subnet_id)
 
         if response['message'] && response['message'].downcase == "no free addresses found"
@@ -34,10 +50,29 @@ module Proxy::Phpipam
 
         {cidr: cidr, next_ip: response['data']}.to_json
       rescue Errno::ECONNREFUSED
-        return {error: "Unable to connect to phpIPAM server"}.to_json
+        return {error: "Unable to connect to External IPAM server"}.to_json
       end
     end
 
+    # Gets the subnet from phpIPAM
+    # 
+    # Input:   cidr(string): CIDR address in the format: "100.20.20.0/24"
+    # Returns: JSON with "data" key on success, or JSON with "error" key when there is an error
+    # Examples: 
+    #   Response if subnet exists:
+    #     {
+    #       "code":200,"success":true,"data":[{"id":"12","subnet":"100.30.30.0","mask":"24",
+    #       "sectionId":"5", "description":"Test Subnet","linked_subnet":null,"firewallAddressObject":null,
+    #       "vrfId":"0","masterSubnetId":"0","allowRequests":"0","vlanId":"0","showName":"0","device":"0",
+    #       "permissions":"[]","pingSubnet":"0","discoverSubnet":"0","DNSrecursive":"0","DNSrecords":"0",
+    #       "nameserverId":"0","scanAgent":"0","isFolder":"0","isFull":"0","tag":"2","threshold":"0",
+    #       "location":"0","editDate":null,"lastScan":null,"lastDiscovery":null}],"time":0.009
+    #     }
+    #
+    #   Response if subnet not exists):
+    #     {
+    #       "code":200,"success":0,"message":"No subnets found","time":0.01
+    #     }
     get '/get_subnet' do
       content_type :json
 
@@ -52,10 +87,22 @@ module Proxy::Phpipam
         subnet = phpipam_client.get_subnet(cidr)
         subnet.to_json
       rescue Errno::ECONNREFUSED
-        return {error: "Unable to connect to phpIPAM server"}.to_json
+        return {error: "Unable to connect to External IPAM server"}.to_json
       end
     end
 
+    # Get a list of sections from external ipam
+    #
+    # Input: None
+    # Returns: An array of sections on success, hash with "error" key otherwise
+    # Examples
+    #   Response if success: [
+    #     {"id":"5","name":"Awesome Section","description":"A totally awesome Section","masterSection":"0",
+    #      "permissions":"[]","strictMode":"1","subnetOrdering":"default","order":null,
+    #      "editDate":"2019-04-19 21:49:55","showVLAN":"1","showVRF":"1","showSupernetOnly":"1","DNS":null}]
+    #   ]
+    #   Response if error:   
+    #     {"error":"Unable to connect to phpIPAM server"}
     get '/sections' do
       content_type :json
 
@@ -64,10 +111,65 @@ module Proxy::Phpipam
         sections = phpipam_client.get_sections
         sections.to_json
       rescue Errno::ECONNREFUSED
-        return {error: "Unable to connect to phpIPAM server"}.to_json
+        return {error: "Unable to connect to External IPAM server"}.to_json
       end
     end
 
+    # Get a list of subnets for given external ipam section
+    #
+    # Input: section_id(integer). The id of the external ipam section
+    # Returns: Array of subnets(as json) in "data" key on success, hash with error otherwise
+    # Examples:
+    #   Response if success: 
+    #     {  
+    #       "code":200,
+    #       "success":true,
+    #       "data":[  
+    #         {  
+    #             "id":"24",
+    #             "subnet":"100.10.10.0",
+    #             "mask":"24",
+    #             "sectionId":"10",
+    #             "description":"wrgwgwefwefw",
+    #             "linked_subnet":null,
+    #             "firewallAddressObject":null,
+    #             "vrfId":"0",
+    #             "masterSubnetId":"0",
+    #             "allowRequests":"0",
+    #             "vlanId":"0",
+    #             "showName":"0",
+    #             "device":"0",
+    #             "permissions":"[]",
+    #             "pingSubnet":"0",
+    #             "discoverSubnet":"0",
+    #             "DNSrecursive":"0",
+    #             "DNSrecords":"0",
+    #             "nameserverId":"0",
+    #             "scanAgent":"0",
+    #             "isFolder":"0",
+    #             "isFull":"0",
+    #             "tag":"2",
+    #             "threshold":"0",
+    #             "location":"0",
+    #             "editDate":null,
+    #             "lastScan":null,
+    #             "lastDiscovery":null,
+    #             "usage":{  
+    #               "used":"0",
+    #               "maxhosts":"254",
+    #               "freehosts":"254",
+    #               "freehosts_percent":100,
+    #               "Offline_percent":0,
+    #               "Used_percent":0,
+    #               "Reserved_percent":0,
+    #               "DHCP_percent":0
+    #             }
+    #         }
+    #       ],
+    #       "time":0.012
+    #     }
+    #   Response if error:   
+    #     {"error":"Unable to connect to phpIPAM server"}
     get '/sections/:section_id/subnets' do
       content_type :json 
 
@@ -82,10 +184,20 @@ module Proxy::Phpipam
         subnets = phpipam_client.get_subnets(section_id)
         subnets.to_json
       rescue Errno::ECONNREFUSED
-        return {error: "Unable to connect to phpIPAM server"}.to_json
+        return {error: "Unable to connect to External IPAM server"}.to_json
       end
     end
 
+    # Checks whether an IP address has already been taken in external ipam.
+    #
+    # Inputs: 1. ip(string). IP address to be checked.
+    #         2. cidr(string): CIDR address in the format: "100.20.20.0/24"
+    # Returns: JSON object with 'exists' field being either true or false
+    # Example: 
+    #   Response if exists: 
+    #     {"ip":"100.20.20.18","exists":true}
+    #   Response if not exists:
+    #     {"ip":"100.20.20.18","exists":false}
     get '/ip_exists' do
       content_type :json 
 
@@ -100,31 +212,27 @@ module Proxy::Phpipam
         subnet = phpipam_client.get_subnet(cidr)
 
         if subnet['message'] && subnet['message'].downcase == "no subnets found"
-          return {error: "The specified subnet does not exist in phpIPAM."}.to_json
+          return {error: "The specified subnet does not exist in External IPAM."}.to_json
         end
 
-        subnet_id = subnet['data'][0]['id']
-        usage = phpipam_client.get_subnet_usage(subnet_id)
-
-        # We need to check subnet usage first in the case there are zero ips in the subnet. Checking
-        # the ip existence on an empty subnet returns a malformed response from phpIPAM, containing
-        # HTML in the JSON response.
-        if usage['data']['used'] == "0"
-          return {ip: ip, exists: false}.to_json
-        else 
-          response = phpipam_client.ip_exists(ip, subnet_id)
-      
-          if response && response['message'] && response['message'].downcase == 'no addresses found'
-            return {ip: ip, exists: false}.to_json
-          else 
-            return {ip: ip, exists: true}.to_json
-          end
-        end
+        subnet_id = JSON.parse(subnet)[0]['id']
+        phpipam_client.ip_exists(ip, subnet_id)
       rescue Errno::ECONNREFUSED
-        return {error: "Unable to connect to phpIPAM server"}.to_json
+        return {error: "Unable to connect to External IPAM server"}.to_json
       end
     end
 
+    # Adds an IP address to the specified subnet 
+    #
+    # Inputs: 1. ip(string). IP address to be added.
+    #         2. subnet_id(integer). The id of the external ipam subnet
+    #         3. description(string). IP address description
+    # Returns: Hash with "message" on success, or hash with "error" 
+    # Examples:
+    #   Response if success: 
+    #     {"message":"IP 100.10.10.123 added to subnet 100.10.10.0/24 successfully."}
+    #   Response if error:   
+    #     {"error":"The specified subnet does not exist in phpIPAM."}
     post '/add_ip_to_subnet' do
       content_type :json
 
@@ -139,19 +247,29 @@ module Proxy::Phpipam
         response = phpipam_client.get_subnet(cidr)
 
         if response['message'] && response['message'].downcase == "no subnets found"
-          return {error: "The specified subnet does not exist in phpIPAM."}.to_json
+          return {error: "The specified subnet does not exist in External IPAM."}.to_json
         end
 
-        subnet_id = response['data'][0]['id']
+        subnet_id = JSON.parse(response)[0]['id']
 
         phpipam_client.add_ip_to_subnet(ip, subnet_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 phpIPAM server"}.to_json
+        return {error: "Unable to connect to External IPAM server"}.to_json
       end
     end
 
+    # Deletes IP address from a given subnet
+    #
+    # Inputs: 1. ip(string). IP address to be checked.
+    #         2. cidr(string): CIDR address in the format: "100.20.20.0/24"
+    # Returns: JSON object
+    # Example:
+    #   Response if success: 
+    #     {"code": 200, "success": true, "message": "Address deleted", "time": 0.017}
+    #   Response if error:   
+    #     {"code": 404, "success": 0, "message": "Address does not exist", "time": 0.008}
     post '/delete_ip_from_subnet' do
       content_type :json
 
@@ -166,16 +284,16 @@ module Proxy::Phpipam
         response = phpipam_client.get_subnet(cidr)
 
         if response['message'] && response['message'].downcase == "no subnets found"
-          return {error: "The specified subnet does not exist in phpIPAM."}.to_json
+          return {error: "The specified subnet does not exist in External IPAM."}.to_json
         end
 
-        subnet_id = response['data'][0]['id']
+        subnet_id = JSON.parse(response)[0]['id']
 
         phpipam_client.delete_ip_from_subnet(ip, subnet_id)
 
         {message: "IP #{ip} deleted from subnet #{cidr} successfully."}.to_json
       rescue Errno::ECONNREFUSED
-        return {error: "Unable to connect to phpIPAM server"}.to_json
+        return {error: "Unable to connect to External IPAM server"}.to_json
       end
     end
 

data/lib/smart_proxy_ipam/phpipam/phpipam_client.rb

@@ -6,22 +6,40 @@ require 'smart_proxy_ipam/ipam'
 require 'smart_proxy_ipam/ipam_main'
 
 module Proxy::Phpipam
-  class PhpipamClient  
+  class PhpipamClient
     def initialize 
       conf = Proxy::Ipam.get_config[:phpipam]
       @phpipam_config = {url: conf[:url], user: conf[:user], password: conf[:password]}
-      @api_base = conf[:url] + '/api/' + conf[:user] + '/'
+      @api_base = "#{conf[:url]}/api/#{conf[:user]}/"
       @token = nil
     end
 
-    def get_subnet(cidr)
-      url = 'subnets/cidr/' + cidr.to_s + '/'
-      get(url) 
+    def init_reservations
+      @@ipam_reservations = {}
     end
 
-    def get_next_ip(subnet_id)
-      url = 'subnets/' + subnet_id.to_s + '/first_free/'
-      get(url)
+    def get_subnet(cidr)
+      url = "subnets/cidr/#{cidr.to_s}"
+      subnets = get(url)
+      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 to Foreman
+          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
+      end
     end
 
     def add_ip_to_subnet(ip, subnet_id, desc)
@@ -30,26 +48,74 @@ module Proxy::Phpipam
     end
 
     def get_sections
-      get('sections/')['data']
+      sections = get('sections/')['data']
+      response = []
+
+      if sections
+        sections.each do |section|
+          response.push({
+            "id": section['id'],
+            "name": section['name'],
+            "description": section['description']
+          })
+        end
+      end
+
+      response
     end
 
     def get_subnets(section_id)
-      get('sections/' + section_id.to_s + '/subnets/')
+      subnets = get("sections/#{section_id.to_s}/subnets/")
+      response = []
+
+      if subnets && subnets['data']
+        # Only return the relevant data
+        subnets['data'].each do |subnet|
+          response.push({
+            "id": subnet['id'],
+            "subnet": subnet['subnet'],
+            "mask": subnet['mask'],
+            "sectionId": subnet['sectionId'],
+            "description": subnet['description']
+          })
+        end
+      end
+
+      response
     end
 
     def ip_exists(ip, subnet_id)
-      get('subnets/' + subnet_id.to_s + '/addresses/' + ip + '/')
+      usage = get_subnet_usage(subnet_id)
+
+      # We need to check subnet usage first in the case there are zero ips in the subnet. Checking
+      # the ip existence on an empty subnet returns a malformed response from phpIPAM, containing
+      # HTML in the JSON response.
+      if usage['data']['used'] == "0"
+        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'
+          return {ip: ip, exists: false}.to_json
+        else 
+          return {ip: ip, exists: true}.to_json
+        end
+      end
     end
 
+    
     def get_subnet_usage(subnet_id)
-      get('subnets/' + subnet_id.to_s + '/usage/')
+      get("subnets/#{subnet_id.to_s}/usage/")
     end
 
     def delete_ip_from_subnet(ip, subnet_id)
-      delete('addresses/' + ip + '/' + subnet_id.to_s + '/') 
+      delete("addresses/#{ip}/#{subnet_id.to_s}/") 
     end
 
-    private
+    def get_next_ip(subnet_id)
+      url = "subnets/#{subnet_id.to_s}/first_free/"
+      get(url)
+    end
 
     def get(path, body=nil)
       authenticate

data/lib/smart_proxy_ipam/version.rb

@@ -1,6 +1,6 @@
 
 module Proxy
   module Ipam
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/settings.d/external_ipam.yml

@@ -6,7 +6,3 @@
     :url: 'http://172.16.16.217'
     :user: 'foreman'
     :password: 'Test1234!'
-  :netbox: 
-    :url: 'http://172.16.16.217'
-    :user: 'netbox'
-    :password: 'Test1234!'

data/settings.d/external_ipam.yml.example

@@ -6,7 +6,3 @@
     :url: 'http://phpipam.example.com'
     :user: 'phpipam_api_user'
     :password: 'phpipam_password'
-  :netbox: 
-    :url: 'http://netbox.example.com'
-    :user: 'netbox_api_user'
-    :password: 'netbox_api_password'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_ipam
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Christopher Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies: []
 description: Smart proxy plugin for IPAM integration with various IPAM providers
 email: chrisjsmith001@gmail.com
@@ -23,7 +23,6 @@ files:
 - bundler.d/ipam.rb
 - lib/smart_proxy_ipam.rb
 - lib/smart_proxy_ipam/ipam.rb
-- lib/smart_proxy_ipam/ipam/ipam_api.rb
 - lib/smart_proxy_ipam/ipam_http_config.ru
 - lib/smart_proxy_ipam/ipam_main.rb
 - lib/smart_proxy_ipam/phpipam/phpipam_api.rb

data/lib/smart_proxy_ipam/ipam/ipam_api.rb

@@ -1,15 +0,0 @@
-require 'sinatra'
-require 'smart_proxy_ipam/ipam'
-require 'smart_proxy_ipam/ipam_main'
-
-module Proxy::Ipam
-  class Api < ::Sinatra::Base
-    include ::Proxy::Log
-    helpers ::Proxy::Helpers
-
-    get '/providers' do
-      content_type :json
-      {ipam_providers: ['phpIPAM']}.to_json
-    end
-  end
-end