radd 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1b144c324d733fdabbee7eada3e800e3e9c1cba8aee8e2de1a02c67fd6e5a34
-  data.tar.gz: 27a536a5b377f7762a6c8bf26c9978e27ac08218745cca493af8f45680fc9f10
+  metadata.gz: aff371d343007b06413d5aeffa546a25824130d0ef8052b1ae7d300f97b665c7
+  data.tar.gz: cb860484d7cb6ad5531be423bffbdabecd96bdc5e9544fe97489cd747a6237f5
 SHA512:
-  metadata.gz: f46802e9687b2cd65da92e5866dce85e14a2a8de8fb04b1b1bf29431b485c4979c50f71292d850af787d7e7163a13c5b3282e5ac45548482d66f70ea8d1be5cf
-  data.tar.gz: d2a5de1d3da7ad395f77eda95bd72f39796bdb7b64c072ca1df336207c064ca405624f0f09142bac1c44ee937436696d0afbfbbb094000f24d4444e5b3d5b825
+  metadata.gz: 3eef89dbaad0dfc736443237743a9123452df584cb3c60f1f09a8fe83efe13ba70de21bd1c4ee7fd0e9043477250ed03d08e2a3652cbf4db39f47ac9202b0a36
+  data.tar.gz: 5c822bafd10f4fde3714a7eea8051bce9e34197f261ed6eeb8d452ec1a87c0688cd4b6a48ddf1fffdecfc1e71f5976ef850f699bbd7a064d98df07fdd939be53

data/bin/radd

@@ -6,4 +6,4 @@ require 'bundler/setup'
 require 'radd'
 require 'radd/cli'
 
-Radd::Cli.start
+Radd::Cli.run

data/lib/radd/app.rb

@@ -1,4 +1,6 @@
 Radd::App = Rack::Builder.app do
+  use Radd::Middleware
+
   map '/ip' do
     run Radd::IP
   end

data/lib/radd/cli.rb

@@ -2,34 +2,103 @@ require 'optparse'
 
 module Radd::Cli
 
+  COMMANDS = %w[help setup add delete list start].freeze
+
   class << self
 
-    def start
+    def load_config(**opts)
       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
+      parser.banner = 'Usage: radd COMMAND [--config FILE]'
+      parser.on('--config FILE', 'Config file') do |file|
+        config['file'] = file
       end
-      parser.on('--domain DOMAIN', 'Root FQDN') do |domain|
-        config['domain'] = domain
+
+      parser.parse!
+
+      Radd.configure!(config['file'], **opts)
+    end
+
+    def run
+      command = ARGV.shift
+      unless COMMANDS.include?(command)
+        puts "Unknown command #{command}"
+        exit(1)
       end
-      parser.on('--http-port [PORT]', 'HTTP port') do |port|
-        config['http_port'] = port
+      send(command)
+    end
+
+    def help
+      puts <<~EOS
+        Usage:
+          radd COMMAND [--config FILE]
+
+        You must specify one of the following commands:
+
+          setup        Create the database
+          add          Add new record
+          list         List available records
+          start        Run the server
+      
+      EOS
+    end
+
+    def setup
+      require_relative 'schema'
+      load_config(skip_db: true, skip_models: true)
+      Radd::Schema.create
+    end
+
+    def add
+      load_config
+      print "Enter name: "
+      name = STDIN.gets.chomp
+      print "Password: "
+      password = STDIN.gets.chomp
+      print "Re-type password: "
+      password_confirmation = STDIN.gets.chomp
+      raise "Password mismatch!" unless password == password_confirmation
+      record = Radd::Record.new(password: password)
+      record.name = name
+      record.save
+      puts "Added record '#{name}'\n"
+    end
+
+    def delete
+      load_config
+      print "Enter name: "
+      name = STDIN.gets.chomp
+      if record = Radd::Record.where(name: name).first
+        print "Do you really want to delete #{name} (y/N)?"
+        confirm = STDIN.gets.chomp
+        if 'y' == confirm
+          record.delete
+          puts "Record #{name} deleted"
+        end
+      else
+        puts "Record #{name} not found"
       end
-      parser.on('--dns-port [PORT]', 'DNS port') do |port|
-        config['dns_port'] = port
+    end
+
+    def list
+      load_config
+      puts
+      records = Radd::Record.all
+      tab = [records.map(&:name).map(&:size).max, 24].compact.max
+      records.each do |record|
+        puts "#{record.name.ljust(tab)}  #{record.ip.to_s.ljust(15)}  #{record.updated_at || 'never updated'}\n"
       end
-      parser.parse!
+      puts
+    end
 
-      Radd.configure!(config)
+    def start
+      load_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!"

data/lib/radd/config.rb

@@ -0,0 +1,40 @@
+module Radd
+
+  class << self
+    attr_reader :domain, :ip, :db, :http_host, :http_port, :dns_host, :dns_port, :ttl
+    
+    def configure!(file, skip_models: false, skip_db: false)
+      file_path = Pathname.new(file || 'radd.yml')
+      file_path = Radd.root + file_path unless file_path.absolute?
+      raise ConfigurationError, "could not open config file #{file_path}" unless file_path.file?
+      config = YAML.load(file_path.read)
+      raise ConfigurationError, 'domain missing' unless config['domain']
+      @domain = config['domain']
+      raise ConfigurationError, 'invalid IP' unless Radd.valid_ip?(config['ip'])
+      @ip = config['ip']
+      uri = URI.parse("http://#{config['http']}")
+      @http_host = uri.host || '127.0.0.1'
+      @http_port = uri.port || 3003
+      uri = URI.parse("dns://#{config['dns']}")
+      @dns_host = uri.host || '0.0.0.0'
+      @dns_port = uri.port || 53
+      raise ConfigurationError, 'invalid TTL' if config['ttl'] && config['ttl'] < 1
+      @ttl = config['ttl'] || 300
+      db_path = Pathname.new(config['db'] || 'radd.sqlite3')
+      db_path = Radd.root + db_path unless db_path.absolute?
+      @db = db_path
+      raise ConfigurationError, 'invalid database' if !skip_db && !Radd.db.file?
+      #
+      # Late loading required by Sequel architecture
+      #
+      require_relative 'db'
+      require_relative 'record' unless skip_models
+    end
+
+    # Check whether +ip+ is a valid IP address string
+    def valid_ip?(ip)
+      !!(ip && ip.match(Resolv::IPv4::Regex))
+    end
+  end
+  
+end

data/lib/radd/db.rb

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

data/lib/radd/errors.rb

@@ -0,0 +1,7 @@
+module Radd
+  class RaddError < StandardError; end
+  class ConfigurationError < StandardError; end
+  class Forbidden < RaddError; end
+  class InvalidRequest < RaddError; end
+  class UpdateError < RaddError; end
+end

data/lib/radd/ip.rb

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

data/lib/radd/middleware.rb

@@ -0,0 +1,12 @@
+module Radd
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env["rack.request"] = Rack::Request.new(env)
+      @app.call(env)
+    end
+  end
+end

data/lib/radd/nameserver.rb

@@ -1,6 +1,6 @@
 class Radd::Nameserver < Async::DNS::Server
   def initialize
-    super(Async::DNS::Endpoint.for(Radd.host, port: Radd.dns_port))
+    super(Async::DNS::Endpoint.for(Radd.dns_host, port: Radd.dns_port))
   end
   
   def process(name, resource_class, transaction)
@@ -12,7 +12,7 @@ class Radd::Nameserver < Async::DNS::Server
         ip = Radd.query(name)
       end
     end
-    return transaction.respond!(ip, ttl: 300) if ip
+    return transaction.respond!(ip, ttl: Radd.ttl) if ip
     transaction.fail!(:NXDomain)
   end
 end

data/lib/radd/schema.rb

@@ -0,0 +1,17 @@
+module Radd
+  module Schema
+    def self.create
+      if DB.table_exists?(:records)
+        puts "Database #{Radd.db} exists"
+        exit(1)
+      end
+      DB.create_table?(:records) do
+        String    :name, primary_key: true
+        String    :password_hash
+        String    :ip
+        DateTime  :updated_at
+      end
+      puts "Created database #{Radd.db}"
+    end
+  end
+end

data/lib/radd/tasks.rb

@@ -0,0 +1,39 @@
+namespace :radd do
+  task :config do
+    Radd::Cli.load_config
+  end
+
+  namespace :db do
+    desc 'Create database'
+    task create: :config do
+      load './db/schema.rb'
+    end
+  end
+  
+  desc 'Add record'
+  task add: :config do
+    print "Enter name: "
+    name = STDIN.gets.chomp
+    print "Password: "
+    password = STDIN.gets.chomp
+    print "Re-type password: "
+    password_confirmation = STDIN.gets.chomp
+    raise "Password mismatch!" unless password == password_confirmation
+    record = Radd::Record.new(password: password)
+    record.name = name
+    record.save
+    puts "Added record '#{name}'\n"
+  end
+  
+  desc 'List all records'
+  task list: :config do
+    puts
+    records = Radd::Record.all
+    tab = [records.map(&:name).map(&:size).max, 24].compact.max
+    records.each do |record|
+      puts "#{record.name.ljust(tab)}  #{record.ip.to_s.ljust(15)}  #{record.updated_at || 'never updated'}\n"
+    end
+    puts
+  end
+  
+end

data/lib/radd/update.rb

@@ -15,7 +15,14 @@ module Radd
     end
 
     def ip
-      addr = env['REMOTE_ADDR']
+      @ip ||= begin
+        addr = env['rack.request'].params['ip'] || remote_ip
+        addr && Radd.valid_ip?(addr) && addr
+      end
+    end
+
+    def remote_ip
+      addr = env['rack.request'].ip
       addr && Radd.valid_ip?(addr) && addr
     end
 
@@ -24,6 +31,7 @@ module Radd
       raise InvalidRequest.new('Invalid IP address') unless ip
       record.ip = ip
       record.save
+      Radd.logger.info "Updated record #{record.name} to #{ip} from #{remote_ip}"
       [200, {'Content-Type' => 'text/plain'}, ["OK #{ip}"]]
     rescue RaddError => boom
       status = case boom
@@ -32,8 +40,10 @@ module Radd
       else
         500
       end
+      Radd.logger.error boom
       respond status, "ERROR #{boom.message}"
     rescue Exception => e
+      Radd.logger.error e
       respond 500, "ERROR"
     end
 

data/lib/radd/version.rb

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

data/lib/radd/webserver.rb

@@ -1,6 +1,9 @@
 class Radd::Webserver < Async::HTTP::Server
   def initialize
-    endpoint = Async::HTTP::Endpoint.parse("http://#{Radd.host}:#{Radd.http_port}")
+    endpoint = Async::HTTP::Endpoint.parse("http://#{Radd.http_host}:#{Radd.http_port}")
+    # TODO: support UNIX endpoints
+    # endpoint = Async::HTTP::Endpoint.parse("http://127.0.0.1")
+    # endpoint.endpoint = IO::Endpoint.unix("/tmp/radd1.sock")
     middleware = Protocol::Rack::Adapter.new(Radd::App)
     super(middleware, endpoint)
   end

data/lib/radd.rb

@@ -2,6 +2,7 @@ require 'yaml'
 require 'sequel'
 require 'resolv'
 require 'bcrypt'
+require 'logger'
 
 require 'async'
 require 'async/dns'
@@ -9,52 +10,32 @@ require 'async/http/server'
 require 'async/http/endpoint'
 require 'protocol/rack/adapter'
 
+# require 'io/endpoint'
+# require 'io/endpoint/unix_endpoint'
+
 require_relative 'radd/version'
+require_relative 'radd/errors'
+require_relative 'radd/config'
 require_relative 'radd/ip'
-require_relative 'radd/db'
-require_relative 'radd/record'
 require_relative 'radd/update'
+require_relative 'radd/middleware'
 require_relative 'radd/nameserver'
 require_relative 'radd/webserver'
 require_relative 'radd/app'
+require_relative 'radd/cli'
 
 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'
+    def root=(path)
+      @root = Pathname.new(path)
     end
 
-    def dns_port
-      config['dns_port'] || 5300
-    end
-    
-    def http_port
-      config['http_port'] || 3000
+    def root
+      @root ||= Pathname.new(Dir.pwd)
     end
 
-    # Check whether +ip+ is a valid IP address string
-    def valid_ip?(ip)
-      !!(ip && ip.match(Resolv::IPv4::Regex))
+    def logger
+      @logger = Logger.new(STDOUT)
     end
 
     # Check whether +name+ is authorized with +password+
@@ -70,10 +51,6 @@ module Radd
       return unless record = Record.active.where(name: name).first
       record.ip
     end
-    
-    def run
-      
-    end
 
     private
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: radd
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Matthias Grosser
 bindir: bin
 cert_chain: []
-date: 2026-02-23 00:00:00.000000000 Z
+date: 2026-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: optparse
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: async-http
+  name: optparse
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: protocol-rack
+  name: async-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: async-dns
+  name: protocol-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,13 +80,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: irb
+  name: async-dns
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -149,6 +149,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
 description: Minimal dynamic DNS service
 email: mtgrosser@gmx.net
 executables:
@@ -156,22 +184,25 @@ executables:
 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/config.rb
 - lib/radd/db.rb
 - lib/radd/dns.rb
 - lib/radd/dns_service.rb
+- lib/radd/errors.rb
 - lib/radd/http.rb
 - lib/radd/http_service.rb
 - lib/radd/ip.rb
+- lib/radd/middleware.rb
 - lib/radd/nameserver.rb
 - lib/radd/record.rb
+- lib/radd/schema.rb
+- lib/radd/tasks.rb
 - lib/radd/update.rb
 - lib/radd/version.rb
 - lib/radd/webserver.rb

data/CHANGELOG

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/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