radd 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1b144c324d733fdabbee7eada3e800e3e9c1cba8aee8e2de1a02c67fd6e5a34
+  data.tar.gz: 27a536a5b377f7762a6c8bf26c9978e27ac08218745cca493af8f45680fc9f10
+SHA512:
+  metadata.gz: f46802e9687b2cd65da92e5866dce85e14a2a8de8fb04b1b1bf29431b485c4979c50f71292d850af787d7e7163a13c5b3282e5ac45548482d66f70ea8d1be5cf
+  data.tar.gz: d2a5de1d3da7ad395f77eda95bd72f39796bdb7b64c072ca1df336207c064ca405624f0f09142bac1c44ee937436696d0afbfbbb094000f24d4444e5b3d5b825

data/CHANGELOG

@@ -0,0 +1,7 @@
+* 0.2.0
+
+Use RubyDNS
+
+* 0.1.0
+
+Use knot DNS

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2026 Matthias Grosser
+
+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,12 @@
+radd
+====
+
+Minimal dynamic DNS service
+
+rake radd:db:create
+
+rake radd:add
+
+rake radd:list
+
+rake radd:delete

data/bin/console

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

data/bin/radd

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+Warning[:experimental] = false
+
+require 'bundler/setup'
+require 'radd'
+require 'radd/cli'
+
+Radd::Cli.start

data/lib/radd/app.rb

@@ -0,0 +1,12 @@
+Radd::App = Rack::Builder.app do
+  map '/ip' do
+    run Radd::IP
+  end
+
+  map '/update' do
+    use Rack::Auth::Basic, 'Authorization required' do |user, password|
+      Radd.authorized?(user, password)
+    end
+    run Radd::Update
+  end
+end

data/lib/radd/cli.rb

@@ -0,0 +1,43 @@
+require 'optparse'
+
+module Radd::Cli
+
+  class << self
+
+    def start
+      config = {}
+      parser = OptionParser.new
+      parser.banner = 'Usage: radd -i IP -d DOMAIN [options]'
+      parser.on('--ip IP', 'Public IP address') do |ip|
+        config['ip'] = ip
+      end
+      parser.on('--domain DOMAIN', 'Root FQDN') do |domain|
+        config['domain'] = domain
+      end
+      parser.on('--http-port [PORT]', 'HTTP port') do |port|
+        config['http_port'] = port
+      end
+      parser.on('--dns-port [PORT]', 'DNS port') do |port|
+        config['dns_port'] = port
+      end
+      parser.parse!
+
+      Radd.configure!(config)
+      puts "Starting Radd server for #{Radd.domain}"
+
+      dns, http = Radd::Nameserver.new, Radd::Webserver.new
+
+      Async do
+        dns_task, http_task = dns.run, http.run
+
+        watchdog = Async do
+          sleep(1) while !http_task.failed? && !dns_task.failed?
+          puts "Task failed!"
+          exit(1)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/radd/db.rb

@@ -0,0 +1,3 @@
+require 'sequel'
+
+DB = Sequel.connect("sqlite://#{Pathname.new(__FILE__).dirname.join('..', '..', 'db', 'radd.sqlite3')}")

data/lib/radd/dns.rb

@@ -0,0 +1,18 @@
+class Radd::DNS < Async::DNS::Server
+  def initialize
+    super(Async::DNS::Endpoint.for(Radd.host, port: Radd.dns_port))
+  end
+  
+  def process(name, resource_class, transaction)
+    name = name.downcase
+    if Resolv::DNS::Resource::IN::A == resource_class
+      if Radd.domain == name
+        ip = Radd.ip
+      else
+        ip = Radd.query(name)
+      end
+    end
+    return transaction.respond!(ip, ttl: 300) if ip
+    transaction.fail!(:NXDomain)
+  end
+end

data/lib/radd/dns_service.rb

@@ -0,0 +1,12 @@
+class Radd::DNSService < Async::Service::GenericService
+  def setup(container)
+    super
+    
+    container.run(count: 1, restart: false) do |instance|
+      instance.ready!
+      puts "DNS service starting..."
+      
+      Radd::DNS.new.run
+    end
+  end
+end

data/lib/radd/http.rb

@@ -0,0 +1,7 @@
+class Radd::HTTP < Async::HTTP::Server
+  def initialize
+    endpoint = Async::HTTP::Endpoint.parse("http://#{Radd.host}:#{Radd.http_port}")
+    middleware = Protocol::Rack::Adapter.new(Radd::App)
+    super(middleware, endpoint)
+  end
+end

data/lib/radd/http_service.rb

@@ -0,0 +1,12 @@
+class Radd::HTTPService < Async::Service::GenericService
+  def setup(container)
+    super
+    
+    container.run(count: 1, restart: false) do |instance|
+      instance.ready!
+      puts "HTTP service starting..."
+      
+      Radd::HTTP.new.run
+    end
+  end
+end

data/lib/radd/ip.rb

@@ -0,0 +1,6 @@
+module Radd
+  # IP address query responder
+  IP = Proc.new do |env|
+    [200, {"Content-Type" => "text/plain"}, [env['REMOTE_ADDR']]]
+  end
+end

data/lib/radd/nameserver.rb

@@ -0,0 +1,18 @@
+class Radd::Nameserver < Async::DNS::Server
+  def initialize
+    super(Async::DNS::Endpoint.for(Radd.host, port: Radd.dns_port))
+  end
+  
+  def process(name, resource_class, transaction)
+    name = name.downcase
+    if Resolv::DNS::Resource::IN::A == resource_class
+      if Radd.domain == name
+        ip = Radd.ip
+      else
+        ip = Radd.query(name)
+      end
+    end
+    return transaction.respond!(ip, ttl: 300) if ip
+    transaction.fail!(:NXDomain)
+  end
+end

data/lib/radd/record.rb

@@ -0,0 +1,22 @@
+class Radd::Record < Sequel::Model
+  class << self
+    def active
+      exclude(ip: nil)
+    end
+  end
+
+  def password=(password)
+    self.password_hash = BCrypt::Password.create(password)
+  end
+
+  def validate
+    super
+    errors.add(:name, "is invalid") if !name || !name.match(/\A[a-z0-9]([A-z0-9_\-]*)\z/)
+    errors.add(:ip,   "is invalid") if ip && !Radd.valid_ip?(ip)
+  end
+
+  def before_save
+    super
+    self.updated_at = Time.now
+  end
+end

data/lib/radd/update.rb

@@ -0,0 +1,51 @@
+module Radd
+  class Update
+    attr_reader :env
+
+    def self.call(env)
+      new(env).call
+    end
+
+    def initialize(env)
+      @env = env
+    end
+
+    def record
+      @record ||= Record.where(name: name).first
+    end
+
+    def ip
+      addr = env['REMOTE_ADDR']
+      addr && Radd.valid_ip?(addr) && addr
+    end
+
+    def call
+      raise Forbidden unless record
+      raise InvalidRequest.new('Invalid IP address') unless ip
+      record.ip = ip
+      record.save
+      [200, {'Content-Type' => 'text/plain'}, ["OK #{ip}"]]
+    rescue RaddError => boom
+      status = case boom
+      when InvalidRequest, Sequel::ValidationFailed then 422
+      when Forbidden then 403
+      else
+        500
+      end
+      respond status, "ERROR #{boom.message}"
+    rescue Exception => e
+      respond 500, "ERROR"
+    end
+
+    private
+
+    def name
+      env['REMOTE_USER']
+    end
+
+    def respond(status, body)
+      [status, {'Content-Type' => 'text/plain'}, ["#{status} #{body}\n"]]
+    end
+
+  end
+end

data/lib/radd/version.rb

@@ -0,0 +1,3 @@
+module Radd
+  VERSION = '1.1.0'
+end

data/lib/radd/webserver.rb

@@ -0,0 +1,7 @@
+class Radd::Webserver < Async::HTTP::Server
+  def initialize
+    endpoint = Async::HTTP::Endpoint.parse("http://#{Radd.host}:#{Radd.http_port}")
+    middleware = Protocol::Rack::Adapter.new(Radd::App)
+    super(middleware, endpoint)
+  end
+end

data/lib/radd.rb

@@ -0,0 +1,90 @@
+require 'yaml'
+require 'sequel'
+require 'resolv'
+require 'bcrypt'
+
+require 'async'
+require 'async/dns'
+require 'async/http/server'
+require 'async/http/endpoint'
+require 'protocol/rack/adapter'
+
+require_relative 'radd/version'
+require_relative 'radd/ip'
+require_relative 'radd/db'
+require_relative 'radd/record'
+require_relative 'radd/update'
+require_relative 'radd/nameserver'
+require_relative 'radd/webserver'
+require_relative 'radd/app'
+
+module Radd
+  class RaddError < StandardError; end
+  class ConfigurationError < StandardError; end
+  class Forbidden < RaddError; end
+  class InvalidRequest < RaddError; end
+  class UpdateError < RaddError; end
+
+  class << self
+    def configure!(config)
+      @config = config.slice(*%w[domain ip host dns_port http_port])
+      raise Radd::ConfigurationError, 'domain missing' unless Radd.domain
+      raise Radd::ConfigurationError, 'invalid IP' unless Radd.valid_ip?(Radd.ip)
+    end
+    
+    def domain
+      config['domain']
+    end
+
+    def ip
+      config['ip']
+    end
+    
+    def host
+      config['host'] || '127.0.0.1'
+    end
+
+    def dns_port
+      config['dns_port'] || 5300
+    end
+    
+    def http_port
+      config['http_port'] || 3000
+    end
+
+    # Check whether +ip+ is a valid IP address string
+    def valid_ip?(ip)
+      !!(ip && ip.match(Resolv::IPv4::Regex))
+    end
+
+    # Check whether +name+ is authorized with +password+
+    def authorized?(name, password)
+      return false unless record = Record.where(name: name).first
+      BCrypt::Password.new(record.password_hash) == password
+    end
+
+    # Query the database for +fqdn+
+    def query(fqdn)
+      return unless fqdn
+      return unless name = fqdn2name(fqdn)
+      return unless record = Record.active.where(name: name).first
+      record.ip
+    end
+    
+    def run
+      
+    end
+
+    private
+
+    def config
+      @config
+    end
+
+    def fqdn2name(fqdn)
+      if match = fqdn.downcase.match(/\A([a-z0-9-]{1,63})\.#{Regexp.escape(domain)}\z/)
+        match.captures[0]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: radd
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Matthias Grosser
+bindir: bin
+cert_chain: []
+date: 2026-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: protocol-rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async-dns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minimal dynamic DNS service
+email: mtgrosser@gmx.net
+executables:
+- radd
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- LICENSE
+- README.md
+- bin/console
+- bin/radd
+- lib/radd.rb
+- lib/radd/app.rb
+- lib/radd/cli.rb
+- lib/radd/db.rb
+- lib/radd/dns.rb
+- lib/radd/dns_service.rb
+- lib/radd/http.rb
+- lib/radd/http_service.rb
+- lib/radd/ip.rb
+- lib/radd/nameserver.rb
+- lib/radd/record.rb
+- lib/radd/update.rb
+- lib/radd/version.rb
+- lib/radd/webserver.rb
+homepage: https://github.com/mtgrosser/radd
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 4.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Roll your own dynamic DNS
+test_files: []