phpipam2masq 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bdfa6fce3a2f12fbfe0844ee15c9d331ad43e4e4a267490ab32f184136e105ed
+  data.tar.gz: f437e08008dd874957fdc6f4dc422ee210313bb9824fb1bbc9124223b19ab795
+SHA512:
+  metadata.gz: 730fe2449828280400e396c20eb2b40ec1f6a4f0d3d1ca94227a6113fca47053b7e3c313ee32bfdbb65ad97c89bb9a47400a5a31cf5c2047941476742bdaab2e
+  data.tar.gz: 5ad003c92a6163d912adff30a15808d7ca7fc2348f31c4206d264b243146711ace2dcf43bd9137fade3b6bb7fef294dbfb13dbfed31052a4d9944c631b7c0445

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+source 'http://gemserver.priv.svdasein.net:8088'
+
+# Specify your gem's dependencies in phpipam2masq.gemspec
+gem "pry"
+gem "pry-rescue"
+gem "pry-stack_explorer"
+gem "geminabox"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    phpipam2masq (0.1.4)
+      awesome_print (~> 1.0)
+      facets (~> 3.0)
+      faraday (~> 0.15)
+      ipaddress (~> 0.8)
+      json (~> 2.0)
+      sinatra (~> 2.0)
+      trollop (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  remote: http://gemserver.priv.svdasein.net:8088/
+  specs:
+    awesome_print (1.8.0)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.3)
+    coderay (1.1.2)
+    debug_inspector (0.0.3)
+    facets (3.1.0)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    geminabox (1.1.0)
+      builder
+      faraday
+      httpclient (>= 2.2.7)
+      nesty
+      reentrant_flock
+      sinatra (>= 1.2.7)
+    httpclient (2.8.3)
+    interception (0.5)
+    ipaddress (0.8.3)
+    json (2.1.0)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    mustermann (1.0.2)
+    nesty (1.0.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-rescue (1.4.5)
+      interception (>= 0.5)
+      pry
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rack (2.0.5)
+    rack-protection (2.0.3)
+      rack
+    rake (10.5.0)
+    reentrant_flock (0.1.1)
+    sinatra (2.0.3)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.3)
+      tilt (~> 2.0)
+    tilt (2.0.8)
+    trollop (2.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  geminabox
+  phpipam2masq!
+  pry
+  pry-rescue
+  pry-stack_explorer
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/Procfile

@@ -0,0 +1 @@
+updater: bundle exec rackup -o 0.0.0.0 -p 4567

data/README.md

@@ -0,0 +1,108 @@
+# phpipam2masq
+
+phpipam2masq is a small application that generates dnsmasq configuration files from a [phpipam](https://phpipam.net/) instance.  It's appropriate for SOHO use as it is and can (with some hacking) be made to work "ok" in a larger environment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'phpipam2masq'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phpipam2masq
+
+## Configuration
+
+Before using it, you must create a new api key in phpipam for the application:
+
+![API Key screenshot](img/apikey.png)
+
+You should also add a few custom fields to your phpipam installation:
+
+![Custom Fields screenshot](img/customfields.png)
+
+On your dnsmasq system (where you'll be running phpipam2masq), you need to make a configration
+destination directory.  It should look like this:
+
+	dest/
+	dest/dnsmasq.d/
+
+If you take the defaults (see below), dest is /etc and dnsmasq.d will likely already be there.
+
+The following files will be generated:
+
+	dest/dnsmasq.d/ranges
+	dest/dnsmasq.d/cnames
+	dest/dnsmasq-hosts.conf
+	dest/dnsmasq-dhcp-hosts.conf
+
+Finally, configure dnsmasq to point at the generated files:
+
+	addn-hosts=dest/dnsmasq-hosts.conf
+	dhcp-hostsfile=dest/dnsmasq-dhcp-hosts.conf
+	conf-dir=dest/dnsmasq.d
+ 
+## Usage
+
+phpipam2masq options can be specified entirely on the command line or in a configuration file.  Command line switches override config file settings.
+
+    Usage: phpipam2masq [options]
+
+    Options:
+    -c, --config=<s>      Config file path
+    -t, --destdir=<s>     Destination dir
+    -a, --apiurl=<s>      API URL
+    -u, --apiuser=<s>     Database user
+    -p, --apipass=<s>     Database password
+    -s, --sections=<s>    Section IDs (comma sep)
+    -d, --dhcptag=<i>     DHCP Tag value
+    -v, --verbose         Verbose output
+    -h, --help            Show this message
+
+Default values are:
+
+	defaults = {
+	    :config => '/etc/phpipam2masq.conf',
+	    :destdir => '/etc',
+	    :apiurl => 'http://localhost/api',
+	    :apiuser=> '',
+	    :apipass => '',
+	    :section => '0',
+	    :dhcptag => '4'
+	}
+
+The configuration file format is yaml:
+
+	---
+	apiurl: http://myhost/phpipam/api/masq (or the app name you chose)/
+	apiuser: myuser
+	apipass: mypass
+	sections: "<csv list of phpipam section numbers>"
+
+phpipam2masq re-generates all the files listed above each time you execute it.
+
+I've included a very slapped together web interface for this thing that you can use to update your dnsmasq configuration from a browser.  See the .ru in conf/ and the corresponding thing in exe/.  It's not secure and it's not elegant but it does the job for my home lab.  Feel free to embellish it.  I put a link to this in my phpipam "Instructions" page that pops up a little window that shows command output - very handy.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/svdasein/phpipam2masq.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "phpipam2masq"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/conf/dnsmasq-config-updater.ru

@@ -0,0 +1,5 @@
+require 'rubygems'
+version = ">= 0.a"
+gem 'phpipam2masq', version
+require Gem.bin_path('phpipam2masq', 'dnsmasqconfigupdater.rb', version)
+run Sinatra::Application

data/exe/dnsmasqconfigupdater.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'sinatra'
+
+set :bind, '0.0.0.0'
+
+get '/updateDnsmasq' do
+	output = String.new
+	output += Time.now.to_s
+	output += "\n#{%x(phpipam2masq.rb 2>&1)}"
+	output += Time.now.to_s
+	%Q(<pre>#{output}</pre>)
+end
+

data/exe/phpipam2masq.rb

@@ -0,0 +1,169 @@
+#!/usr/bin/env ruby
+
+require 'faraday'
+require 'json'
+require 'trollop'
+require 'facets'
+require 'awesome_print'
+require 'ipaddress'
+require 'yaml'
+
+defaults = {
+    :config => '/etc/phpipam2masq.conf',
+    :destdir => '/etc',
+    :apiurl => 'http://localhost/api',
+    :apiuser=> '',
+    :apipass => '',
+    :section => '0',
+    :dhcptag => '4'
+}
+
+opts = Trollop::options do
+  usage '[options]'
+  #version %Q{Version #{Gestio2masq::VERSION}}
+  opt :config, 'Config file path', :short => 'c', :type => :string
+  opt :destdir, 'Destination dir', :short => 't', :type => :string
+  opt :apiurl, 'API URL', :short => 'a', :type => :string
+  opt :apiuser, 'Database user', :short => 'u', :type => :string
+  opt :apipass, 'Database password', :short => 'p', :type => :string
+  opt :sections , "Section IDs (comma sep)", :short => 's', :type=>:string
+  opt :dhcptag , "DHCP Tag value", :short => 'd', :type=>:integer
+  opt :verbose, 'Verbose output', :short => 'v'
+end
+
+config_file = opts[:config]||defaults[:config]
+
+config = nil
+if File.exist?(config_file)
+  begin
+    config = YAML.load(File.read(config_file))
+  rescue => detail
+    puts detail.backtrace
+    puts %Q(Error reading config from file #{config_file})
+    exit(1)
+  end
+end
+
+if config.nil? or (config.class != Hash)
+  config = Hash.new
+else
+  # symbolize hash keys (json format compatibility)
+  config = Hash[config.map { |(k, v)| [k.to_sym, v] }]
+end
+
+# Precedence (low to high): defaults, config file, command line
+config = defaults.merge(config).merge(Hash(opts.select { |k, v| !v.nil? }))
+
+
+conn = Faraday.new(:url=>config[:apiurl])
+conn.basic_auth(config[:apiuser],config[:apipass])
+auth = conn.post('user/')
+auth = JSON.parse(auth.body)
+conn.headers['token'] = auth['data']['token']
+
+subnets = Hash.new
+config[:sections].split(',').each { |subnetid|
+	JSON.parse(conn.get("sections/#{subnetid}/subnets/").body)['data'].each  { |subnet|
+		subnets[subnet['id']] = subnet.symbolize_keys
+	}
+}
+
+addresses = Hash.new
+subnets.keys.each { |subnetid|
+	resp = JSON.parse(conn.get("subnets/#{subnetid}/addresses/").body)
+	if resp.has_key?('data')
+		resp['data'].each { |addr|
+			addr.symbolize_keys!
+			if not addr[:id].nil?
+				addresses[addr[:id]] = addr
+				addresses[addr[:id]][:subnet] = subnets[subnetid]
+			end
+		}
+	end
+}
+
+
+# Convert all the addreses keys to symbols
+
+hosts_entries = Array.new
+dhcp_hosts_entries = Array.new
+cnames_entries = Array.new
+addresses.values.each { |host|
+  if host[:tag] != config[:dhcptag] and host[:hostname].size > 0
+    if host[:mac] and host[:mac].size > 0
+      # static dhcp assignment
+      if host[:optiontag]
+        dhcp_hosts_entries.push("#{host[:mac]},set:#{host[:optiontag]},#{host[:hostname].split('.').shift},#{host[:ip]},#{host[:subnet][:leasetime]}")
+      else
+        dhcp_hosts_entries.push("#{host[:mac]},#{host[:hostname].split('.').shift},#{host[:ip]},#{host[:subnet][:leasetime]}")
+      end
+    end
+    # hostname
+    if host[:subnet] and host[:subnet][:Domain]
+      hosts_entries.push("#{host[:ip]}\t#{host[:hostname]}.#{host[:subnet][:Domain]}")
+    else
+      hosts_entries.push("#{host[:ip]}\t#{host[:hostname]}")
+    end
+    # cnames
+    if host[:CNAMEs]
+      host[:CNAMEs].split(',').each { |cname|
+        if host[:subnet] and host[:subnet][:Domain]
+          cnames_entries.push("cname=#{cname},#{host[:hostname]}.#{host[:subnet][:Domain]}")
+        else
+          cnames_entries.push("cname=#{cname},#{host[:hostname]}")
+        end
+      }
+    end
+  end
+}
+
+# This monster produces a hash, one kv for each subnet, where the v contains an array of ranges for the subnet in question.  This works
+# under the presumption that the phpipam api produces an ordered list of addresses when one dumps all addresses from a subnet (which
+# as of this writing appears to be true)
+subnetranges = Hash.new
+subnets.keys.each { |subnetid|
+	subnetranges[subnetid] = Array.new
+	rawrange = addresses.values.select {|each| each[:subnet][:id] == subnetid}.chunk {|each| each[:tag] == config[:dhcptag]}.select {|isDhcp,ary| isDhcp}
+	if rawrange.size > 0
+		# This next one ensures that we're dealing with immediately adjacent ip addresses by looking a the last octet of two in the list and
+		# seeing if they're immediately next to each other. If they are not we have multiple chunks in this subnet.
+		ranges = rawrange[0][1].chunk_while { |a,b| a[:ip].split('.').pop.to_i + 1 == b[:ip].split('.').pop.to_i}
+		ranges.to_a.each {|range|
+			subnetranges[subnetid].push(range)
+		}
+	end
+}
+
+
+ranges_entries = Array.new
+subnetranges.each_pair { |subnetid,ranges|
+	subnet = subnets[subnetid]
+	subnettag = subnet[:subnettag]
+	next if not subnettag or ranges.size == 0
+	ranges.each { |range|
+		first = range.first
+		last = range.last
+		mask = IPAddress.parse("#{subnet[:subnet]}/#{subnet[:mask]}").netmask
+		ranges_entries.push("dhcp-range=#{subnettag},#{first[:ip]},#{last[:ip]},#{mask},#{subnet[:dynleasetime]}")
+	}
+}
+
+
+puts "="*80 if config[:verbose]
+puts "RANGES: #{ranges_entries.size}"
+File.new(%Q(#{config[:destdir]}/dnsmasq.d/ranges), 'w').puts(ranges_entries.join("\n"))
+puts(ranges_entries.join("\n")) if config[:verbose]
+puts "="*80 if config[:verbose]
+puts "CNAMES: #{cnames_entries.size}"
+File.new(%Q(#{config[:destdir]}/dnsmasq.d/cnames), 'w').puts(cnames_entries.join("\n"))
+puts(cnames_entries.join("\n")) if config[:verbose]
+puts "="*80 if config[:verbose]
+puts "DHCP HOSTS: #{dhcp_hosts_entries.size}"
+File.new(%Q(#{config[:destdir]}/dnsmasq-dhcp-hosts.conf), 'w').puts(dhcp_hosts_entries.join("\n"))
+puts(dhcp_hosts_entries.join("\n")) if config[:verbose]
+puts "="*80 if config[:verbose]
+puts "HOSTS: #{hosts_entries.size}"
+File.new(%Q(#{config[:destdir]}/dnsmasq-hosts.conf), 'w').puts(hosts_entries.join("\n"))
+puts(hosts_entries.join("\n")) if config[:verbose]
+
+

data/lib/phpipam2masq.rb

@@ -0,0 +1,5 @@
+require "phpipam2masq/version"
+
+module Phpipam2masq
+  # Your code goes here...
+end

data/lib/phpipam2masq/version.rb

@@ -0,0 +1,3 @@
+module Phpipam2masq
+  VERSION = "1.0.3"
+end

data/phpipam2masq.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phpipam2masq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "phpipam2masq"
+  spec.version       = Phpipam2masq::VERSION
+  spec.authors       = ["Dave Parker"]
+  spec.email         = ["daveparker01@gmail.com"]
+
+  spec.summary       = %q{Logic to push phpipam configuration to a dnsmasq configuration}
+  spec.homepage      = "https://gitlab.com/svdasein/phpipam2masq"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'faraday', '~> 0.15'
+  spec.add_runtime_dependency 'json', '~> 2.0'
+  spec.add_runtime_dependency 'trollop', '~> 2.1'
+  spec.add_runtime_dependency 'facets', '~> 3.0'
+  spec.add_runtime_dependency 'awesome_print', '~> 1.0'
+  spec.add_runtime_dependency 'ipaddress', '~> 0.8'
+  spec.add_runtime_dependency 'sinatra', '~> 2.0'
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: phpipam2masq
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Dave Parker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- daveparker01@gmail.com
+executables:
+- dnsmasqconfigupdater.rb
+- phpipam2masq.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Procfile
+- README.md
+- bin/console
+- bin/setup
+- conf/dnsmasq-config-updater.ru
+- exe/dnsmasqconfigupdater.rb
+- exe/phpipam2masq.rb
+- img/apikey.png
+- img/customfields.png
+- lib/phpipam2masq.rb
+- lib/phpipam2masq/version.rb
+- phpipam2masq.gemspec
+homepage: https://gitlab.com/svdasein/phpipam2masq
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Logic to push phpipam configuration to a dnsmasq configuration
+test_files: []