wamupd 1.1.1

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jonathan Walker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+Wamupd
+======
+
+Introduction
+------------
+
+Wamupd was originally created by roguelazer - for the original application,
+see http://www.roguelazer.com/code/wamupd/. This version is primarily forked
+to support the stable versions of Ruby (1.9), mDNSResponder (258.18), 
+Avahi (0.6.29), D-Bus (1.4.6), and FreeBSD (8.2) at the time of writing. It 
+also fixes some threading issues, adds logging, rc.d support, and FreeBSD 
+packaging.
+
+Requirements
+------------
+
+ * ruby19
+ * ruby-dbus *(see my fork on [GitHub](https://github.com/johnnywalker/ruby-dbus))*
+ * algorithms
+ * rubygems
+ * dnsruby
+ * logger
+
+ruby-dbus v0.6.0 does _not_ work properly on FreeBSD due to a problem with the
+initial null byte sent to D-Bus for unix socket authentication. FreeBSD
+supports the SCM\_CREDS socket option, so a simple patch is required.
+
+Installing
+----------
+
+After cloning this repository, use gmake to create the wamupd package and then 
+install the resulting file:
+
+    git clone https://github.com/johnnywalker/wamupd
+    cd wamupd
+    gmake
+    sudo pkg_add wamupd.tbz
+
+Once installed, create the configuration file using the distribution template
+and enable the wamupd service in your /etc/rc.conf:
+
+    cd /usr/local/etc/
+    sudo cp wamupd.yaml.dist wamupd.yaml
+    sudo vim wamupd.yaml (edit appropriately)
+    sudo echo wamupd_enable="YES" >>/etc/rc.conf
+    sudo service wamupd start
+
+Specify custom arguments to wamupd as needed using the wamupd\_flags entry in 
+/etc/rc.conf. In order to get more information on the arguments available, try this:
+
+    sudo service wamupd stop
+    sudo /usr/local/sbin/wamupd run -- -h
+
+The default flags used are:
+
+    wamupd_flags="-c /usr/local/etc/wamupd.yaml -A /usr/local/etc/avahi/services -a -i"
+
+A log is created at /var/log/wamupd.log, but this only contains small amounts
+of information. In order to debug your configuration, make sure the service
+isn't running and then execute the /usr/local/sbin/wamupd program in the 
+foreground (note: the typical arguments used are "-A -a -i" - the "--" separates
+the daemon command from the script arguments):
+
+    sudo service wamupd stop
+    sudo /usr/local/sbin/wamupd run -- -A -a -i
+
+To uninstall, simply use pkg_delete:
+
+    sudo pkg_delete wamupd
+
+Usage
+-----
+
+    Usage: wamupd run -- [options] service-file
+        -c, --config FILE                Get configuration data from FILE
+                                         If FILE is not provided, defaults to /usr/local/etc/wamupd.yaml
+        -A, --avahi-services [DIRECTORY] Load Avahi service definitions from DIRECTORY
+                                           If DIRECTORY is not provided, defaults to /usr/local/etc/avahi/services
+                                           If the -A flag is omitted altogether, static records will not be added.
+        -i, --[no-]ip-addresses          Enable/Disable Publishing A and AAAA records
+        -a, --avahi                      Load Avahi services over D-BUS
+        -h, --help                       Show this message
+
+Configuration
+-------------
+
+Make a wamupd.yaml file in /usr/local/etc/ in normal YAML style. Available
+parameters include:
+  - hostname: the hostname of this machine
+  - zone: the zone to write to
+  - dns\_server: the dns server that controls the above zone
+  - dns\_port: the port to talk to
+  - dnssec\_key\_name: the key name for DNSSEC. Do not specify if you're
+    not using DNSSEC
+  - dnssec\_key\_hmac: the key value for DNSSEC.
+  - ttl: the standard TTL to use.
+  - transport: either "tcp" or "udp"

data/Rakefile

@@ -0,0 +1,24 @@
+gemspec = eval(File.read(Dir["*.gemspec"].first))
+
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build gem locally"
+task :build => :gemspec do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/#{gemspec.name}-#{gemspec.version}"
+end
+
+desc "Clean automatically generated files"
+task :clean do
+  FileUtils.rm_rf "pkg"
+end

data/bin/wamupd

@@ -0,0 +1,314 @@
+#!/usr/local/bin/ruby
+# Copyright (C) 2009-2010 James Brown <roguelazer@roguelazer.com>.
+#
+# This file is part of wamupd.
+#
+# wamupd is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# wamupd is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with wamupd.  If not, see <http://www.gnu.org/licenses/>.
+#
+# == Synopsis
+# 
+# wamupd: Read avahi service descriptions and current IP information, then
+# use that information to generate Wide-Area mDNS Updates
+#
+# == Usage
+#
+# wamupd service-file
+#
+# -a, --avahi
+#   Load Avahi services over D-BUS
+# -A DIRECTORY, --avahi-services DIRECTORY
+#   Load Avahi service definitions from DIRECTORY
+#   If DIRECTORY is not provided, defaults to /etc/avahi/services
+#   If the -A flag is omitted altogether, static records will not be added.
+# -c FILE, --config FILE:
+#   Get configuration data from FILE
+# -i, --ip-addreses (or --no-ip-addresses)
+#   Enable/Disable Publishing A and AAAA records
+# -h, --help:
+#   Show this help
+
+require 'rubygems'
+require 'daemons'
+
+options = {
+  :dir_mode   => :system,
+  :multiple   => false,
+}
+
+Daemons.run_proc('wamupd', options) do 
+
+    require "wamupd"
+    require "getoptlong"
+    require "optparse"
+    require "singleton"
+    require "timeout"
+    require "logger"
+
+    # Wamupd is a module that is used to namespace all of the wamupd code.
+    module Wamupd
+        DEFAULT_CONFIG_FILE = "/usr/local/etc/wamupd.yaml"
+        DEFAULT_AVAHI_SERVICES_DIR = "/usr/local/etc/avahi/services"
+
+        app = Daemons.controller.group.applications.first
+
+        Options = Struct.new(:config, :ip_addresses, :avahi, :avahi_services_dir, :avahi_services)
+        $options = Options.new
+        $options.config = DEFAULT_CONFIG_FILE
+        $options.ip_addresses = false
+        $options.avahi = false
+        $options.avahi_services = false
+        $options.avahi_services_dir = DEFAULT_AVAHI_SERVICES_DIR
+       
+        OptionParser.new do |opts|
+          opts.banner = "Usage: wamupd run -- [options] service-file"
+
+          opts.on("-c", "--config FILE", 
+              "Get configuration data from FILE",
+                "If FILE is not provided, defaults to " + DEFAULT_CONFIG_FILE) do |cfg|
+            $options.config = cfg
+          end
+
+          opts.on("-A", "--avahi-services [DIRECTORY]", 
+            "Load Avahi service definitions from DIRECTORY",
+            "  If DIRECTORY is not provided, defaults to " + DEFAULT_AVAHI_SERVICES_DIR,
+            "  If the -A flag is omitted altogether, static records will not be added.") do |services|
+            if services then
+              $options.avahi_services_dir = services
+            end
+            $options.avahi_services = true
+          end
+
+          opts.on("-i", "--[no-]ip-addresses", "Enable/Disable Publishing A and AAAA records") do |ips|
+            $options.ip_addresses = ips
+          end
+
+          opts.on("-a", "--avahi", "Load Avahi services over D-BUS") do |avahi|
+            $options.avahi = true
+          end 
+
+          opts.on("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+        end.parse!(app.app_argv)
+
+        unless Daemons.controller.options[:ontop]
+            $logger = Logger.new(app.logfile, 'monthly')
+            $logger.level = Logger::INFO
+        else
+            $logger = Logger.new(STDOUT)
+            $logger.level = Logger::DEBUG
+        end
+    
+        CurrentProcess.change_privilege('nobody', 'nogroup')
+
+
+        # Main wamupd object
+        class Main
+            include Singleton
+
+            # Process command-line objects
+            def process_args
+                @config_file = $options.config
+                @avahi_dir = $options.avahi_services_dir
+                @bools[:ip] = $options.ip_addresses
+                @bools[:avahi] = $options.avahi
+                @bools[:avahi_services] = $options.avahi_services
+            end
+
+            # Construct the object and process all command-line options
+            def initialize
+                @exiting = false
+
+                @bools = {
+                    :publish=>false,
+                    :unpublish=>false,
+                    :avahi=>false,
+                    :avahi_services=>false,
+                    :ip=>false
+                }
+
+                $settings = MainSettings.instance()
+
+                process_args()
+
+                # Load settings
+                if (not File.exists?(@config_file))
+                    $stderr.puts "Could not find configuration file #{@config_file}"
+                    $stderr.puts "Try running with --help?"
+                    exit
+                end
+                $settings.load_from_yaml(@config_file)
+
+                if (@bools[:ip])
+                    @d = DNSIpController.new()
+                end
+
+                if (@bools[:avahi] or @bools[:avahi_services])
+                    @a = Wamupd::DNSAvahiController.new()
+                end
+
+                if (@bools[:avahi_services])
+                    @avahi_services = AvahiServiceFile.load_from_directory(@avahi_dir)
+                end
+                :w
+
+                if (@bools[:avahi])
+                    @am = Wamupd::AvahiModel.new
+                end
+            end
+
+            # Actually run the program.
+            #
+            # This call doesn't return until SIGTERM is caught.
+            def run
+                $logger.debug "Starting main function"
+
+                update_queue = Queue.new
+                DNSUpdate.queue = update_queue
+
+                threads = []
+                if (@bools[:avahi] or @bools[:avahi_services])
+                    # Handle the DNS controller
+                    threads << Thread.new {
+                        @a.on(:added) { |item,id|
+                            $logger.debug('dns_controller') { "Added #{item.type_in_zone_with_name} (id=\"#{id}\")" }
+                        }
+                        @a.on(:deleted) { |item|
+                            $logger.debug('dns_controller') { "Deleted #{item.type_in_zone_with_name}" }
+                        }
+                        @a.on(:renewed) { |item|
+                            $logger.debug('dns_controller') { "Renewed #{item.type_in_zone_with_name}" }
+                        }
+                        @a.run
+                    }
+
+                    # Lease maintenance
+                    threads << Thread.new {
+                        @a.update_leases
+                    }
+                end
+
+                publish_static
+                
+                if (@bools[:avahi])
+                    @am.on(:added) { |avahi_service|
+                        @a.queue << Wamupd::Action.new(Wamupd::ActionType::ADD, avahi_service)
+                        $logger.debug('avahi_listener') { "Found service: #{avahi_service}" }
+                    }
+                    # Handle listening to D-BUS
+                    threads << Thread.new {
+                        $logger.debug('dbus_listener') { "Starting" }
+                        @am.run
+                    }
+                end
+                
+                if (@bools[:ip])
+                    threads << Thread.new{
+                        $logger.debug('ip_controller') { "Starting" }
+                        @d.update_leases
+                    }
+                end
+
+                threads << Thread.new {
+                    while (1)
+                        response_id, response, exception = update_queue.pop
+                        $logger.debug('reporter') { "Got back response #{response_id}" }
+                        if (not exception.nil?)
+                            if (exception.kind_of?(Dnsruby::TsigNotSignedResponseError))
+                                # Do nothing
+                            else
+                                $logger.warn('reporter') { "Error: #{exception}" }
+                                $logger.warn('reporter') { response }
+                            end
+                        end
+                        if (response.rcode != Dnsruby::RCode::NOERROR)
+                            $logger.warn('reporter') { "Got an unexpected rcode (#{response.rcode})" }
+                            $logger.warn('reporter') { response }
+                        end
+                        if DNSUpdate.outstanding.delete(response_id).nil?
+                            $logger.warn('reporter') { "Got back an unexpected response ID" }
+                            $logger.warn('reporter') { response }
+                        end
+                    end
+                }
+
+                stop_proc = proc { stop_threads(threads) }
+                trap(1, stop_proc)
+                trap(2, stop_proc)
+                trap(15, stop_proc)
+
+                $logger.info "Wamupd started"
+                while (!@exiting)
+                  sleep(10)
+                end
+
+                threads.each { |t|
+                    t.join
+                }
+
+              exit
+            end
+
+            def stop_threads(threads)
+              if (not @exiting) then
+                @exiting = true
+
+                $logger.info "Unregistering services..."
+                if (@bools[:avahi] or @bools[:avahi_services])
+                    @a.exit
+                end
+                if (@bools[:avahi])
+                    @am.exit
+                end
+                if (@bools[:ip])
+                    @d.unpublish
+                end
+                sleep($settings.max_dns_response_time)
+                threads.each { |t|
+                    t.exit
+                }
+                $logger.info "Wamupd stopped"
+              end
+            end
+
+            def publish_static
+                if (@d)
+                    @d.on(:added) { |type,address|
+                        $logger.debug('static_publisher') { "Added #{type} record for #{address}" }
+                    }
+                    @d.on(:removed) { |type,address|
+                        $logger.debug('static_publisher') { "Removed #{type} record for #{address}" }
+                    }
+                    @d.publish
+                end
+
+                if (@avahi_services)
+                    @avahi_services.each { |avahi_service_file|
+                        avahi_service_file.each { |avahi_service|
+                            @a.queue << Wamupd::Action.new(Wamupd::ActionType::ADD, avahi_service)
+                            $logger.debug('static_publisher') { "Found static Avahi service: #{avahi_service}" }
+                        }
+                    }
+                end
+            end
+
+            private :process_args, :publish_static, :exit
+        end
+    end
+
+
+    w = Wamupd::Main.instance
+    w.run
+end

data/lib/wamupd/action.rb

@@ -0,0 +1,40 @@
+# Copyright (C) 2010 James Brown <roguelazer@roguelazer.com>.
+#
+# This file is part of wamupd.
+#
+# wamupd is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# wamupd is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with wamupd.  If not, see <http://www.gnu.org/licenses/>.
+
+module Wamupd
+    # Possible actions in the system. Essentially, an enum
+    class ActionType
+        ADD=1
+        DELETE=2
+        QUIT=4
+    end
+
+    # A command wrapper
+    class Action
+        # The action to be performed. A Wamupd::ActionType
+        attr_reader :action
+
+        # The associated record (might be an AvahiService, or whatever else
+        # is appropriate). Might be nil
+        attr_reader :record
+
+        def initialize(action, record=nil)
+            @action=action
+            @record=record
+        end
+    end
+end