fx-tftp 0.7 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fb93e7d9a4839d3065a2ac891b2e9a9960631a9
-  data.tar.gz: 5bd896cb10fb366ff12062e469910ec923769b88
+  metadata.gz: 2eb12234e670c55c0c634f86118f62d56ca172a7
+  data.tar.gz: 9e02a93b38f29149e36c3294c751c78581675f13
 SHA512:
-  metadata.gz: d53e82bcbac0ef1765d7f350ad8946a066a5d264214a97d47b6c126417f08579bef6902eb29f74159c946d164cd902fe09090928da7ace928dc89866ef3ae9d7
-  data.tar.gz: 35263c555fe01030069daccf62283de35ab72f13e92f14aff5ed934e6d22b55d339ffd520470b48360445dce6d8c7a1928a6d1adc2136e86a34adb2c7190075b
+  metadata.gz: 1b2de98e63190ff5fca124b8a4e47fa90ac5a2247ad0e6d506a6457bee3cc0c1f646ed9a003d40fc8d437e2dec2cb14fe71c21e1ff1b883431d01f40c8f7fa29
+  data.tar.gz: b8654091eceed1f70276b2f090e5e228634ab22af969844f6820c58b1cde12e4a60c65e76fa8a22e97e074b647a16d7366c1b28eb8298806cec1c962bb485156

data/.gitignore

@@ -1,4 +1,11 @@
-doc/
-pkg/
-.yardoc/
-Gemfile.lock
+/.bundle/
+/vendor/
+/.ruby-version
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 rvm:
-  - ruby-head
+  - 2.2.3
+  - 2.1.7
+  - 2.0.0
   - 1.9.3
-install:
-  - gem install minitest
+before_install: gem install bundler -v 1.10.6
 script:
   - rake test

data/README.md

@@ -3,6 +3,7 @@
 * [Homepage](https://github.com/drbig/fx-tftp)
 * [Documentation](http://rubydoc.info/gems/fx-tftp/frames)
 
+
 ## Description
 
 FX-TFTP is a slightly over-OO-ed pure-Ruby implementation of plain [RFC1350](https://www.ietf.org/rfc/rfc1350.txt) TFTP *server*. It is very flexible and intended for hacking. Also, and more importantly, it **works**, contrary to other gems that are occupying space at RubyGems.
@@ -11,6 +12,28 @@ That flexibility may be useful if you're planning on massive custom TFTP-based b
 
 The included `tftpd` executable gives you a fully-fledged read-write TFTP server that also does logging, daemon mode and does not crap out on `SIGTERM`.
 
+
+## Quickstart
+
+Just in case you need an easy to use tftp server...
+Install via Rubygems:
+
+    $ gem install fx-tftp
+
+Then start the beast with any directory you want to serve (works for uploads and downloads as well):
+
+    $ sudo tftpd ~/router_firmwares_and_config_files/
+
+Further options:
+    
+    $ tftpd
+    Usage: tftpd [OPTIONS] DIR
+        -V, --version                    Show version and exit
+        -a, --address ADDRESS            Address to listen on (default: 0.0.0.0)
+        -p, --port PORT                  Port to listen on (default: 69)
+        -v, --verbose                    Enable verbose output
+
+
 ## Hacking
 
 Suppose we want to have a TFTP server that only supports reading, but the files served should depend on the IP block the client is connecting from:
@@ -28,18 +51,6 @@ Suppose we want to have a TFTP server that only supports reading, but the files
 
 When you combine filename inspection and `#send` and `#recv` methods working on plain `IO` objects you can easily whip up things like serving dynamically built scripts/binaries/archives based on parameters passed as the requested 'filename'.
 
-## Included executable
-
-    $ tftpd
-    Usage: tftpd [OPTIONS] PORT
-        -v, --version                    Show version and exit
-        -d, --debug                      Enable debug output
-        -l, --log PATH                   Log to file
-        -b, --background                 Fork into background
-        -m, --mode MODE                  Run in R/W only mode
-        -h, --host HOST                  Bind do host
-        -p, --path PATH                  Serving root directory
-        -o, --overwrite                  Overwrite existing files
 
 ## Contributing
 
@@ -50,6 +61,7 @@ Fell free to contributed patches using the common GitHub model (descried below).
  - Write code and tests, check, commit
  - Make a Pull Request
 
+
 ## Licensing
 
 Standard two-clause BSD license, see LICENSE.txt for details.

data/bin/tftpd

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-#
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
@@ -7,59 +6,42 @@ require 'logger'
 require 'optparse'
 require 'tftp'
 
-config = {:path => Dir.pwd, :host => '127.0.0.1', :fork => false,
-          :ver => false, :loglevel => Logger::INFO, :logfile => STDOUT,
-          :no_read => false, :no_write => false, :overwrite => false}
-
-def die!(msg)
-  STDERR.puts msg
-  exit(2)
-end
+# Defaults
+config = { :port => 69, :address => '0.0.0.0', :loglevel => Logger::WARN }
 
 op = OptionParser.new do |o|
-  o.banner = "Usage: #{$PROGRAM_NAME} [OPTIONS] PORT"
-  o.on('-v', '--version', 'Show version and exit')            {    config[:ver]       = true }
-  o.on('-d', '--debug', 'Enable debug output')                {    config[:loglevel]  = Logger::DEBUG }
-  o.on('-l', '--log PATH',  String, 'Log to file')            {|a| config[:logfile]   = a }
-  o.on('-b', '--background', 'Fork into background')          {|a| config[:fork]      = true }
-  o.on('-m', '--mode MODE', String, 'Run in R/W only mode')   do |a|
-    case a.downcase[0]
-    when 'r'
-      config[:no_write] = true
-    when 'w'
-      config[:no_read]  = true
-    else
-      config[:bad_mode] = true
-    end
+  o.banner = "Usage: #{$PROGRAM_NAME} [OPTIONS] DIR"
+  o.on '-V', '--version', 'Show version and exit' do
+    puts "fx-tftpd v#{TFTP::VERSION} Copyright (c) 2015, Piotr S. Staszewski"
+    exit
+  end
+  o.on '-a', '--address ADDRESS', String,
+    'Address to listen on (default: 0.0.0.0)' do |address|
+    config[:address] = address
+  end
+  o.on '-p', '--port PORT', Integer,
+    'Port to listen on (default: 69)' do |port|
+    abort 'Invalid port' if port < 1 || port > 65535
+    config[:port] = port
+  end
+  o.on '-v', '--verbose', 'Enable verbose output' do
+    config[:loglevel] = Logger::INFO
   end
-  o.on('-h', '--host HOST', String, 'Bind do host')           {|a| config[:host]      = a }
-  o.on('-p', '--path PATH', String, 'Serving root directory') {|a| config[:path]      = a }
-  o.on('-o', '--overwrite', 'Overwrite existing files')       {    config[:overwrite] = true }
-end
-op.parse! or die!(op)
-die!(op) if config[:bad_mode]
-
-if config[:ver]
-  puts "fx-tftpd v#{TFTP::VERSION} Copyright (c) 2015, Piotr S. Staszewski"
-  exit
 end
 
-die!('Serving root does not exists') unless File.exists? config[:path]
+config[:path] = op.parse!.first
+abort 'Last argument must be a directory' unless File.directory? config[:path]
 
-PORT = ARGV.shift.to_i
-die!(op) if PORT < 1 || PORT > 65535
+if config[:port] < 1024 && !Process.euid.zero?
+  abort 'Please run tftpd as root via sudo!'
+end
 
-log = Logger.new(config[:logfile])
+log = Logger.new(STDOUT)
 log.level = config[:loglevel]
-log.formatter = lambda {|s, d, p, m| "#{d.strftime('%Y-%m-%d %H:%M:%S.%3N')} | #{s.ljust(5)} | #{m}\n" }
-
-if config[:fork]
-  log.info 'Detaching from the console'
-  Process.daemon(true)
+log.formatter = lambda do |s, d, p, m|
+  "#{d.strftime('%Y-%m-%d %H:%M:%S.%3N')} | #{s.ljust(5)} | #{m}\n"
 end
-
 config[:logger] = log
-config[:port]   = PORT
 
 begin
   log.info "Serving from and to #{config[:path]}"

data/lib/tftp/tftp.rb

@@ -255,16 +255,6 @@ module TFTP
             return
           end
           log :info, "#{tag} Write request for #{req.filename} (#{req.mode})"
-          if File.exist? path
-            if @opts[:overwrite]
-              log :info, "#{tag} Overwrite existing file #{req.filename}"
-            else
-              log :warn, "#{tag} Refuse to overwrite existing file #{req.filename}"
-              sock.send(Packet::ERROR.new(6, 'File already exists.').encode, 0)
-              sock.close
-              return
-            end
-          end
           mode = 'w'
           mode += 'b' if req.mode == :octet
           io = File.open(path, mode)
@@ -288,28 +278,28 @@ module TFTP
     # test it for 10K or something.
     #
     # @attr handler [Handler] Session handler
-    # @attr host    [String]  Host the sockets bind to
+    # @attr address [String]  Address to listen to
     # @attr port    [Integer] Session dispatcher port
     # @attr clients [Hash]    Current sessions
     class Base
-      attr_reader :handler, :host, :port, :clients
+      attr_reader :handler, :address, :port, :clients
 
       # Initialize the server.
       #
       # Options:
       # 
-      #  - :host   => host to bind to (default: 127.0.0.1)
-      #  - :port   => dispatcher port (default: 69)
-      #  - :logger => logger instance
+      #  - :address => address to listen to (default: '0.0.0.0')
+      #  - :port    => dispatcher port (default: 69)
+      #  - :logger  => logger instance
       #
       # @param handler  [Handler]  Initialized session handler
       # @param opts     [Hash]     Options
       def initialize(handler, opts = {})
         @handler = handler
 
-        @host = opts[:host] || '127.0.0.1'
-        @port = opts[:port] || 69
-        @logger = opts[:logger]
+        @address = opts[:address] || '0.0.0.0'
+        @port    = opts[:port] || 69
+        @logger  = opts[:logger]
 
         @clients = Hash.new
         @run = false
@@ -319,9 +309,9 @@ module TFTP
       #
       # This is obviously blocking.
       def run!
-        log :info, "UDP server loop at #{@host}:#{@port}"
+        log :info, "UDP server loop at #{@address}:#{@port}"
         @run = true
-        Socket.udp_server_loop(@host, @port) do |msg, src|
+        Socket.udp_server_loop(@address, @port) do |msg, src|
           break unless @run
 
           addr = src.remote_address
@@ -338,7 +328,7 @@ module TFTP
           log :debug, "#{tag} -> PKT: #{pkt.inspect}"
           tid = get_tid
           tag = "[#{addr.ip_address}:#{addr.ip_port.to_s.ljust(5)}:#{tid.to_s.ljust(5)}]"
-          sock = addr.connect_from(@host, tid)
+          sock = addr.connect_from(@address, tid)
           @clients[tid] = tag
 
           unless pkt.is_a?(Packet::RRQ) || pkt.is_a?(Packet::WRQ)
@@ -363,7 +353,7 @@ module TFTP
       def stop
         log :info, 'Stopping UDP server loop'
         @run = false
-        UDPSocket.new.send('break', 0, @host, @port)
+        UDPSocket.new.send('break', 0, @address, @port)
       end
 
       private

data/lib/tftp/version.rb

@@ -1,4 +1,4 @@
 module TFTP
   # Current version string.
-  VERSION = '0.7'
+  VERSION = '1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fx-tftp
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '1.0'
 platform: ruby
 authors:
 - Piotr S. Staszewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks