matchd 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "matchd"
+
+# 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/matchd

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+load File.expand_path("../../exe/matchd", __FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/examples/registry.yml

@@ -0,0 +1,30 @@
+---
+version: 1
+rules:
+#   # exact match:
+#   - match: mydomain.test
+#     resource_class: A
+#     respond: "10.0.0.80"
+#
+#   # using ruby regular expressions to match any sub-domains
+#   - match: /^(\w+\.)*mydomain\.test$/
+#     resource_class: A
+#     respond: "10.0.0.80"
+#
+#   # IPv6 records
+#   - match: /^(\w+\.)*mydomain\.test$/
+#     resource_class: AAAA
+#     respond: "fe80::A:0:0:0050"
+#
+#   # MX records
+#   - match: mydomain.test
+#     resource_class: MX
+#     respond:
+#       preference: 10
+#       host: 'mail.mydomain.test.'
+#
+#   - match: mydomain.test
+#     resource_class: NS
+#     respond:
+#       - host: 'ns1.mydomain.test.'
+#       - host: 'ns2.mydomain.test.'

data/exe/matchd

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require "pp"
+require "rubygems"
+require "matchd/cli"
+
+Matchd::CLI::Main.start(ARGV)

data/lib/matchd.rb

@@ -0,0 +1,31 @@
+require "matchd/version"
+
+module Matchd
+  autoload :Config,   "matchd/config"
+  autoload :Control,  "matchd/control"
+  autoload :Glue,     "matchd/glue"
+  autoload :Helpers,  "matchd/helpers"
+  autoload :Registry, "matchd/registry"
+  autoload :Response, "matchd/response"
+  autoload :Rule,     "matchd/rule"
+  autoload :Server,   "matchd/server"
+
+  def self.configure(&block)
+    Config.configure(&block)
+  end
+
+  def self.configure_from_file!(config_file = Config::DEFAULT_CONFIG_FILE)
+    Config.configure do |config|
+      YAML.load_file(config_file).each do |k, v|
+        config.public_send("#{k}=", v)
+      end
+    end
+  end
+
+  def self.root
+    File.expand_path('..', __dir__)
+  end
+
+  extend Response::Factory
+  extend Rule::Factory
+end

data/lib/matchd/cli.rb

@@ -0,0 +1,10 @@
+require "thor"
+
+module Matchd
+  module CLI
+    autoload :ConfigFileOption, "matchd/cli/config_file_option"
+
+    autoload :Config, "matchd/cli/config"
+    autoload :Main,   "matchd/cli/main"
+  end
+end

data/lib/matchd/cli/config.rb

@@ -0,0 +1,36 @@
+module Matchd::CLI
+  class Config < Thor
+    include Thor::Actions
+
+    add_runtime_options!
+    class_option :verbose, type: :boolean, aliases: "-v", group: :runtime,
+                           desc: "Print out additional logging information"
+
+    desc "setup [options]", "Creates the basic configuration files"
+    option :base,
+      aliases: "-b",
+      type: :string,
+      default: Matchd::Config::DEFAULT_DOT_DIR,
+      desc: "the base directory for all config files"
+    option :config_file,
+      aliases: "-C",
+      type: :string,
+      default: Matchd::Config::DEFAULT_CONFIG_FILE,
+      desc: "Name of the config file to create. Relative to 'base' or absolute path"
+    def setup
+      opts = options.dup
+
+      dot_dir     = File.expand_path(opts.delete(:base))
+      config_file = File.expand_path(opts.delete(:config_file), dot_dir)
+
+      Matchd.configure { |c| c.dot_dir = dot_dir }
+
+      empty_directory(dot_dir, opts)
+
+      create_file(config_file, YAML.dump(Matchd::Config.config.to_h), opts)
+
+      sample_registry = File.expand_path(File.join("examples", "registry.yml"), Matchd.root)
+      create_file(Matchd::Config.registry_file, File.binread(sample_registry), opts)
+    end
+  end
+end

data/lib/matchd/cli/config_file_option.rb

@@ -0,0 +1,23 @@
+module Matchd::CLI
+  # A little patch to allow a "class_option" for letting Matchd be configured
+  # using the given or default config file
+  module ConfigFileOption
+    def self.included(receiver)
+      receiver.class_exec do
+        class_option :config,
+          type: :string,
+          aliases: "-c",
+          group: :runtime,
+          default: Matchd::Config::DEFAULT_CONFIG_FILE,
+          desc: "The config file to read"
+
+        no_commands do
+          def initialize(args = [], local_options = {}, config = {})
+            super
+            Matchd.configure_from_file!(options[:config]) if File.file?(options[:config])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/matchd/cli/main.rb

@@ -0,0 +1,45 @@
+require "matchd"
+
+module Matchd::CLI
+  class Main < Thor
+    package_name "Matchd"
+
+    include ConfigFileOption
+
+    desc "start [options]", "Start the matchd dns service"
+    option :deamonize,
+      default: true,
+      type: :boolean,
+      desc: "Start as background daemon."
+    def start
+      Matchd::Control.new.start(ontop: !options[:deamonize])
+    end
+
+    desc "stop", "Stop the running matchd dns daemon"
+    def stop
+      Matchd::Control.new.stop
+    end
+
+    desc "status", "Print process status information"
+    def status
+      Matchd::Control.new.status
+    end
+
+    desc "restart", "Restart the running matchd daemon"
+    long_desc "Stop and Start with new options. " \
+              "This is the same as running stop and start successively.\n\n" \
+              "If your configuration changes the 'dot_dir' you'll need to stop using the old config and start with the new one."
+    option :deamonize,
+      default: true,
+      type: :boolean,
+      desc: "Restart as background daemon.",
+      long_desc: ""
+    def restart
+      invoke :stop
+      invoke :start
+    end
+
+    desc "config SUBCOMMAND ...ARGS", "manage configuration files"
+    subcommand "config", Config
+  end
+end

data/lib/matchd/config.rb

@@ -0,0 +1,39 @@
+require "yaml"
+require "dry-configurable"
+
+module Matchd
+  module Config
+    DEFAULT_PORT = 15353
+    DEFAULT_DOT_DIR = File.join(ENV["HOME"], ".matchd")
+    DEFAULT_CONFIG_FILE = File.join(DEFAULT_DOT_DIR, "config.yml")
+
+    extend Dry::Configurable
+
+    # Base directory for config and daemon files
+    setting(:dot_dir, DEFAULT_DOT_DIR, reader: true) { |f| File.expand_path(f) }
+
+    # where the server will listen on
+    setting(
+      :listen,
+      [
+        { "protocol" => "udp", "ip" => "127.0.0.1", "port" => DEFAULT_PORT },
+        { "protocol" => "udp", "ip" => "::1",       "port" => DEFAULT_PORT }
+      ],
+      reader: true
+    )
+
+    # The upstream resolver for passthrough requests.
+    # "system" will try to read your systems DNS setup.
+    # Give a specific config like this:
+    #
+    #   [{"protocol" => "udp", "ip" => "1.1.1.1", "port" => 53},
+    #    {"protocol" => "tcp", "ip" => "1.1.1.1", "port" => 53}]
+    #
+    setting(:resolver, "system", reader: true)
+
+    setting(:registry_file, "registry.yml")
+    def self.registry_file
+      File.expand_path(config.registry_file, dot_dir)
+    end
+  end
+end

data/lib/matchd/control.rb

@@ -0,0 +1,56 @@
+require "daemons"
+
+module Matchd
+  # Controls the demonizing of a {Matchd::Server}
+  class Control
+    def initialize(options = {})
+      @name = options.delete(:name, "matchd")
+    end
+
+    def start(options = {})
+      run! "start", ontop: options.fetch(:ontop, false)
+    end
+
+    def stop
+      run! "stop"
+    end
+
+    def status
+      run! "status"
+    end
+
+    def restart(options = {})
+      stop
+      start(options)
+    end
+
+    # @private
+    def run!(argv, options = {})
+      run_options = { ARGV: Array(argv), **options, **daemon_opts }
+      Daemons.run_proc(@name, run_options) do
+        require "matchd/server"
+        Matchd::Server.new(*server_opts).run
+      end
+    end
+
+    # @private
+    def server_opts
+      [
+        Matchd::Registry.load_file(Matchd::Config.registry_file),
+        Matchd::Config.listen,
+        { resolver: Matchd::Config.resolver }
+      ]
+    end
+
+    # @private
+    def daemon_opts
+      daemon_dir = Matchd::Config.dot_dir
+      {
+        dir_mode: :normal,
+        dir: daemon_dir,
+        log_output: true,
+        log_dir: daemon_dir
+      }
+    end
+  end
+end

data/lib/matchd/glue.rb

@@ -0,0 +1,6 @@
+module Matchd
+  # Wrappers for dealing with other lib's data structures
+  module Glue
+    autoload :AsyncEndpoint, "matchd/glue/async_endpoint"
+  end
+end

data/lib/matchd/glue/async_endpoint.rb

@@ -0,0 +1,93 @@
+module Matchd::Glue
+  # Wrapper for allowing a more flexible way of defining interfaces for Asyc-*
+  module AsyncEndpoint
+    class << self
+      # Examples:
+      #
+      #   # classic triplet array
+      #   AsyncIntrface.parse([:udp, "0.0.0.0", 53])
+      #   AsyncIntrface.parse([[:udp, "0.0.0.0", 53], [:tcp, "0.0.0.0", 53]])
+      #
+      #   # Hash notation
+      #   AsyncIntrface.parse({"protocol" => :udp, "ip" => "0.0.0.0", "port" => 53})
+      #   AsyncIntrface.parse({protocol: :udp, ip: "0.0.0.0", port: 53})
+      #   AsyncIntrface.parse([{protocol: :udp, ip: "0.0.0.0", port: 53}, {protocol: :tcp, ip: "0.0.0.0", port: 53}])
+      #
+      #   # URI strings
+      #   AsyncIntrface.parse("udp://0.0.0.0:53")
+      #   AsyncIntrface.parse(["udp://0.0.0.0:53", "tcp://0.0.0.0:53"])
+      def parse(args)
+        val =
+          case args
+          when Array
+            if triplet = parse_array(args)
+              [triplet]
+            else
+              args.flat_map { |e| parse(e) }
+            end
+          when Hash
+            [parse_hash(args)]
+          when String
+            [parse_uri(args)]
+          end
+
+        return nil unless val
+
+        val.compact!
+
+        val.empty? ? nil : val
+      end
+
+      # Supported DNS protocols
+      PROTOCOLS = %w(udp tcp).freeze
+
+      # Default port used when the port is omitted in Hash or String notation.
+      DEFAULT_PORT = 53
+
+      private
+
+      # @private
+      # parses the classic triplet array notation
+      # `[:udp, "0.0.0.0", 53]`
+      # and returns just the thing if all data is present.
+      # To ensure proper triplet detection, all values are required. No port default.
+      def parse_array(args)
+        protocol, ip, port = args
+
+        return nil unless PROTOCOLS.include?(protocol.to_s) && ip && port
+
+        [protocol.to_sym, ip, port]
+      end
+
+      # @private
+      # parses a single Hash with named components in string or symbol keys
+      # `{"protocol" => :udp, "ip" => "0.0.0.0", "port" => 53}` or
+      # `{protocol: :udp, ip: "0.0.0.0", port: 53}`
+      # and returns it's triplet notation if all parts are present.
+      # there's no additional array wrapping.
+      def parse_hash(args)
+        protocol = args["protocol"] || args[:protocol]
+        ip       = args["ip"]       || args[:ip]
+        port     = args["port"]     || args[:port] || DEFAULT_PORT
+
+        return nil unless PROTOCOLS.include?(protocol.to_s) && ip
+
+        [protocol.to_sym, ip, port]
+      end
+
+      # @private
+      # parses a URI string
+      # `"udp://0.0.0.0:53"` or `"tcp://0.0.0.0:53"`
+      def parse_uri(args)
+        uri = URI.parse(args)
+        protocol = uri.scheme
+        ip       = uri.host
+        port     = uri.port || DEFAULT_PORT
+
+        return nil unless PROTOCOLS.include?(protocol.to_s) && ip
+
+        [protocol.to_sym, ip, port]
+      end
+    end
+  end
+end