radd 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3839d4afb39cef8bced2dd146aff7ef7a08dd7e130f2bd534cd820856e6f9c90
-  data.tar.gz: d3ff659868d45d89068ab1628090c7f40370407cd2a162d17ddca5c5bf1c8a21
+  metadata.gz: f9fddd23ad9d4e45fcfef31f6e5d976b13511fc6089a3f77267395ff8d62bfb6
+  data.tar.gz: 530c66e7a340a9709de98025c4cc697b50d1358371d7ef7e351cd756a30611f8
 SHA512:
-  metadata.gz: 5d79c2896c91af7aee9d4d4c4d86f250f03f1f5fcf8233379c47be57eab5d6d519b0dc2008db930326a6420f0afcc91c7aedbe57c0563919b7acb647bc3d259c
-  data.tar.gz: ad478c2fea9f293b3164d3ab7e73b059b87ce84a2493063962261c0c0b82922d39b0e3a1ac88185b61ccde9738cfb52db997971495900c7aabc6766682a8974c
+  metadata.gz: f0a3ff47b7c18794df7a34972dacc6ec4434c9dc1b749797655518e79d5509fbc4d01326d34906c3904c22498663cce5224d4214b593cf91588398c3c29ab6cf
+  data.tar.gz: 431664ea22d21ba782c577c940746bfd43083855054cf60befb9b6414d52d3ba281524448eb8639b19a77549440749f43a0528564c6fa0e22992146eaf00175b

data/README.md

@@ -1,12 +1,39 @@
-radd
-====
+# radd
 
 Minimal dynamic DNS service
 
-rake radd:db:create
 
-rake radd:add
+## Installation
 
-rake radd:list
+```
+gem install radd
+```
 
-rake radd:delete
+## Configuration
+
+```yaml
+# radd.yml
+ip: 10.1.2.3
+http: 127.0.0.1:3000
+dns: 0.0.0.0:53
+domain: example.com
+mname: ns.example.com
+rname: hostmaster.example.com
+db: radd.sqlite3
+```
+
+## Usage
+
+```
+radd COMMAND [--config FILE]
+```
+
+You must specify one of the following commands:
+
+```
+setup        Create the database
+add          Add new record
+delete       Delete record
+list         List available records
+start        Run the server
+```

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,19 +2,100 @@ require 'optparse'
 
 module Radd::Cli
 
+  COMMANDS = %w[help setup add delete list start].freeze
+
   class << self
 
-    def load_config
+    def load_config(**opts)
       config = {}
       parser = OptionParser.new
-      parser.banner = 'Usage: radd --config [FILE]'
+      parser.banner = 'Usage: radd COMMAND [--config FILE]'
       parser.on('--config FILE', 'Config file') do |file|
         config['file'] = file
       end
 
       parser.parse!
 
-      Radd.configure!(config['file'])
+      Radd.configure!(config['file'], **opts)
+    end
+
+    def run
+      command = ARGV.shift
+      if COMMANDS.include?(command)
+        send(command)
+      elsif command.nil?
+        help
+        exit 1
+      elsif '--help' == command
+        help
+      else
+        puts "Unknown command #{command}"
+        exit 1
+      end
+    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
+          delete       Delete 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
+    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
+      puts
     end
 
     def start
@@ -25,7 +106,6 @@ module Radd::Cli
 
       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

@@ -1,44 +1,38 @@
 module Radd
 
   class << self
-    def configure!(file)
+    attr_reader :domain, :ip, :db, :http_host, :http_port, :dns_host, :dns_port, :ttl,
+                :mname, :rname
+    
+    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 Radd::ConfigurationError, "could not open config file #{file_path}" unless file_path.file?
-      @config = YAML.load(file_path.read).slice(*%w[domain ip host dns_port http_port db])
-      raise Radd::ConfigurationError, 'domain missing' unless Radd.domain
-      raise Radd::ConfigurationError, 'invalid IP' unless Radd.valid_ip?(Radd.ip)
-      db_path = Pathname.new(@config.delete('db') || 'db/radd.sqlite3')
+      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
+      raise ConfigurationError, 'master name missing' unless config['mname']
+      @mname = config['mname']
+      @rname = config['rname'] || "hostmaster.#{domain}"
+      db_path = Pathname.new(config['db'] || 'radd.sqlite3')
       db_path = Radd.root + db_path unless db_path.absolute?
-      @config['db'] = db_path
-      raise Radd::ConfigurationError, 'invalid database' unless Radd.db.file?
+      @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'
-    end
-    
-    def domain
-      @config['domain']
-    end
-
-    def ip
-      @config['ip']
-    end
-    
-    def db
-      @config['db']
-    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
+      require_relative 'record' unless skip_models
     end
 
     # Check whether +ip+ is a valid IP address string

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,18 +1,17 @@
 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)
     name = name.downcase
-    if Resolv::DNS::Resource::IN::A == resource_class
-      if Radd.domain == name
-        ip = Radd.ip
-      else
-        ip = Radd.query(name)
-      end
+    case resource_class
+    when Resolv::DNS::Resource::IN::A
+      ip = Radd.domain == name ? Radd.ip : Radd.query(name)
+      return transaction.respond!(ip, ttl: Radd.ttl) if ip
+    when Resolv::DNS::Resource::IN::SOA
+      return transaction.respond!(Radd.mname, Radd.rname, Radd.serial, 10800, 1800, 604800, 1800)
     end
-    return transaction.respond!(ip, ttl: 300) 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.2.0'
+  VERSION = '1.4.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,11 +10,15 @@ 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/update'
+require_relative 'radd/middleware'
 require_relative 'radd/nameserver'
 require_relative 'radd/webserver'
 require_relative 'radd/app'
@@ -24,11 +29,15 @@ module Radd
     def root=(path)
       @root = Pathname.new(path)
     end
-    
+
     def root
       @root ||= Pathname.new(Dir.pwd)
     end
-    
+
+    def logger
+      @logger = Logger.new(STDOUT)
+    end
+
     # Check whether +name+ is authorized with +password+
     def authorized?(name, password)
       return false unless record = Record.where(name: name).first
@@ -42,7 +51,11 @@ module Radd
       return unless record = Record.active.where(name: name).first
       record.ip
     end
-    
+
+    def serial
+      Radd.db&.stat&.mtime.to_i
+    end
+
     private
 
     def config

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: radd
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Matthias Grosser
 bindir: bin
 cert_chain: []
-date: 2026-04-28 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: yaml
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,13 +94,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: irb
+  name: rack
   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:
@@ -108,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,7 +122,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,7 +136,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,13 +150,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bcrypt
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  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:
@@ -170,7 +184,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG
 - LICENSE
 - README.md
 - bin/radd
@@ -185,8 +198,11 @@ files:
 - 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