net-tftp_latest_version 0.2.0

data/GPL.txt

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/LICENSE.txt

@@ -0,0 +1,58 @@
+Net::TFTP is copyrighted free software by Guillaume Marcais <guillaume.marcais@free.fr>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see GPL.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/README.txt

@@ -0,0 +1,31 @@
+== Description
+
+Implementation of the TFTP protocol. For more information, see
+lib/net/tftp.rb or generate the documentation:
+
+$ rdoc -x setup.rb
+
+== Installation
+
+1. Manual install:
+
+$ ruby setup.rb config
+$ ruby setup.rb setup
+
+Probably become administrator/root
+
+# ruby setup.rb install
+
+2. Gem package
+
+Create gem
+
+$ ruby net-tftp.gemspec
+
+Probably become administrator/root
+
+# gem install net-tftp.gem
+
+== License
+
+See LICENSE.txt

data/lib/net/tftp.rb

@@ -0,0 +1,631 @@
+#! /usr/bin/ruby
+
+#--
+# Copyright (c) 2004, Guillaume Marcais (guillaume.marcais@free.fr)
+# All rights reserved.
+# This file is distributed under the Ruby license.
+# http://net-tftp.rubyforge.org
+#++
+#
+# == Description
+# TFTP is used by many devices to upload or download their configuration,
+# firmware or else. It is a very simple file transfer protocol built on top
+# of UDP. It transmits data by chunck of 512 bytes. It waits for an ack after 
+# each data packet but does not do any data integrety checks. 
+# There is no authentication mechanism nor any way too list the content of 
+# the remote directories. It just sends or retrieves files.
+#
+# == Usage
+# Using Net::TFTP::Client is fairly trivial:
+# <pre>
+# <code>
+# require 'net/tftp'
+# t = Net::TFTP::Client.new('localhost')
+# t.getbinaryfile('remote_file', 'local_file')
+# t.putbinaryfile('local_file', 'remote_file')
+# </code>
+# </pre>
+#
+# To use the Net::TFTP::Server:
+# <pre>
+# <code>
+# require 'net/tftp'
+# tftp_server = Net::TFTP::Server.new(:data_directory => "/path/to/directory")
+# tftp_server.start  # starts the server and blocks the current thread.
+# </code>
+# </pre>
+# That's pretty much it. +getbinaryfile+ and +putbinaryfile+ can take a
+# block which will be called every time a block is sent/received.
+#
+# == Known limitations
+# * RFC 1350 mention a net-ascii mode. I am not quite sure what transformation
+#   on the data should be done and it is not (yet) implemented.
+# * None of the extensions of TFTP are implemented (RFC1782, RFC1783, RFC1784, 
+#   RFC1785, RFC2347, RFC2348, RFC2349).
+ 
+require 'socket'
+require 'timeout'
+require 'thread'
+
+module Net # :nodoc:
+
+  module TFTP # :nodoc:
+    
+  class TFTPError < StandardError; end
+  class TFTPTimeout < TFTPError; end
+  class TFTPProtocol < TFTPError
+    attr_reader :code
+    def initialize(msg, code)
+      super(msg)
+      @code = code
+    end
+  end
+
+  VERSION = "0.2.0"
+
+  # Errors
+  ERROR_DESCRIPTION = [
+    "Custom error",
+    "File not found",
+    "Access violation",
+    "Disk full",
+    "Illegal TFTP operation",
+    "Unknown transfer ID",
+    "File already exists",
+    "No such user",
+  ]
+  ERROR_UNDEF                 = 0
+  ERROR_FILE_NOT_FOUND        = 1
+  ERROR_ACCESS_VIOLATION      = 2
+  ERROR_DISK_FULL             = 3
+  ERROR_ILLEGAL_OPERATION     = 4
+  ERROR_UNKNOWN_TRANSFER_ID   = 5
+  ERROR_FILE_ALREADY_EXISTS   = 6
+  ERROR_NO_SUCH_USER          = 7
+  
+  # Opcodes
+  OP_RRQ   = 1
+  OP_WRQ   = 2
+  OP_DATA  = 3
+  OP_ACK   = 4
+  OP_ERROR = 5
+  
+  MINSIZE = 4
+  MAXSIZE = 516
+  DATABLOCK = 512
+  
+  DEFAULTS = {
+    :port => (Socket.getservbyname("tftp", "udp") rescue 69),
+    :timeout => 5,
+  }
+
+  module PacketOperations
+    def rrq_packet(file, mode)
+      [OP_RRQ, file, mode].pack("na#{file.size + 1}a#{mode.size + 1}")
+    end
+
+    def wrq_packet(file, mode)
+      [OP_WRQ, file, mode].pack("na#{file.size + 1}a#{mode.size + 1}")
+    end
+
+    def data_packet(block, data)
+      [OP_DATA, block, data].pack("nna*")
+    end
+
+    def ack_packet(block)
+      [OP_ACK, block].pack("nn")
+    end
+
+    def error_packet(code, message = nil)
+      message ||= ERROR_DESCRIPTION[code] || ""
+      [OP_ERROR, code, message].pack("nna#{message.size + 1}")
+    end
+
+    # Check if the packet is malformed (unknown opcode, too big, etc.),
+    # in which case it returns nil.
+    # If it is an error packet, raise an TFTPProtocol error.
+    # Returns scanned values otherwise.
+    def scan_packet(packet)
+      return nil if packet.size < MINSIZE || packet.size > MAXSIZE
+      opcode = packet.unpack("n")[0]
+      block_err = rest = nil
+      if opcode == OP_RRQ || opcode == OP_WRQ
+        block_err, rest = packet[2..-1].unpack("Z*Z*")
+      elsif opcode == OP_ERROR
+        block_err, rest = packet[2..-1].unpack("nZ*")
+      else
+        block_err = packet[2..-1].unpack("n")[0]
+        rest = packet[4..-1]
+      end
+      return nil if opcode.nil? || block_err.nil?
+      case opcode
+      when OP_RRQ, OP_WRQ
+        return [opcode, block_err, rest]
+      when OP_DATA
+        return [opcode, block_err, rest]
+      when OP_ACK
+        return [opcode, block_err]
+      when OP_ERROR
+        err_msg = "%s: %s"
+        err_msg %= [ERROR_DESCRIPTION[block_err] || "", rest.chomp("\000")]
+        raise TFTPProtocol.new(err_msg, block_err)
+      else
+        return nil
+      end
+    end
+  end #module PacketOperations
+  
+  class Client
+    include PacketOperations
+    class << self
+      # Alias for new
+      def open(host)
+        new(host)
+      end
+
+      # Return the number of blocks to send _size_ bytes.
+      def size_in_blocks(size)
+        s = size / DATABLOCK
+        s += 1 unless (size % DATABLOCK) == 0
+        s
+      end
+    end
+    
+    attr_accessor :timeout, :host
+
+    # Create a TFTP connection object to a host. Note that no actual
+    # network connection is made. This methods never fails.
+    # Parameters:
+    # [:port] The UDP port. See DEFAULTS
+    # [:timeout] Timeout in second for each ack packet. See DEFAULTS
+    def initialize(host, params = {})
+      @host = host
+      @port = params[:port] || DEFAULTS[:port]
+      @timeout = params[:timeout] || DEFAULTS[:timeout]
+    end
+
+    # Retrieve a file using binary mode.
+    # If the localfile name is omitted, it is set to the remotefile.
+    # The optional block receives the data in the block and the sequence number
+    # of the block starting at 1.
+    def getbinaryfile(remotefile, localfile = nil, &block) # :yields: data, seq
+      localfile ||= File.basename(remotefile)
+      File.open(localfile, "wb") do |f|
+        getbinary(remotefile, f, &block)
+      end
+    end
+
+    # Retrieve a file using binary mode and send content to an io object
+    # The optional block receives the data in the block and the sequence number
+    # of the block starting at 1.
+    def getbinary(remotefile, io, &block) # :yields: data, seq
+      s = UDPSocket.new
+      begin
+        peer_ip = IPSocket.getaddress(@host)
+      rescue
+        raise TFTPError, "Cannot find host '#{@host}'"
+      end
+
+      peer_tid = nil
+      seq = 1
+      from = nil
+      data = nil
+
+      # Initialize request
+      s.send(rrq_packet(remotefile, "octet"), 0, peer_ip, @port)
+      Timeout::timeout(@timeout, TFTPTimeout) do
+        loop do
+          packet, from = s.recvfrom(MAXSIZE, 0)
+          next unless peer_ip == from[3]
+          type, block, data = scan_packet(packet)
+          break if (type == OP_DATA) && (block == seq)
+        end
+      end
+      peer_tid = from[1]
+
+      # Get and write data to io
+      loop do
+        io.write(data)
+        s.send(ack_packet(seq), 0, peer_ip, peer_tid)
+        yield(data, seq) if block_given?
+        break if data.size < DATABLOCK
+        
+        seq += 1
+        Timeout::timeout(@timeout, TFTPTimeout) do
+          loop do
+            packet, from = s.recvfrom(MAXSIZE, 0)
+            next unless peer_ip == from[3]
+            if peer_tid != from[1]
+              s.send(error_packet(ERROR_UNKNOWN_TRANSFER_ID), 
+                     0, from[3], from[1])
+              next
+            end
+            type, block, data = scan_packet(packet)
+            break if (type == OP_DATA) && (block == seq)
+          end
+        end
+      end
+
+      return true
+    end
+
+    # Send a file in binary mode. The name of the remotefile is set to
+    # the name of the local file if omitted.
+    # The optional block receives the data in the block and the sequence number
+    # of the block starting at 1.
+    def putbinaryfile(localfile, remotefile = nil, &block) # :yields: data, seq
+      remotefile ||= File.basename(localfile)
+      File.open(localfile, "rb") do |f|
+        putbinary(remotefile, f, &block)
+      end
+    end
+
+    # Send the content read from io to the remotefile.
+    # The optional block receives the data in the block and the sequence number
+    # of the block starting at 1.
+    def putbinary(remotefile, io, &block) # :yields: data, seq
+      s = UDPSocket.new
+      peer_ip = IPSocket.getaddress(@host)
+      
+      peer_tid = nil
+      seq = 0
+      from = nil
+      data = nil
+      
+      # Initialize request
+      s.send(wrq_packet(remotefile, "octet"), 0, peer_ip, @port)
+      Timeout::timeout(@timeout, TFTPTimeout) do
+        loop do
+          packet, from = s.recvfrom(MAXSIZE, 0)
+          next unless peer_ip == from[3]
+          type, block, data = scan_packet(packet)
+          break if (type == OP_ACK) && (block == seq)
+        end
+      end
+      peer_tid = from[1]
+
+      loop do
+        data = io.read(DATABLOCK) || ""
+        seq += 1
+        s.send(data_packet(seq, data), 0, peer_ip, peer_tid)
+        
+        Timeout::timeout(@timeout, TFTPTimeout) do
+          loop do
+            packet, from = s.recvfrom(MAXSIZE, 0)
+            next unless peer_ip == from[3]
+            if peer_tid != from[1]
+              s.send(error_packet(ERROR_UNKNOWN_TRANSFER_ID), 
+                     0, from[3], from[1])
+              next
+            end
+            type, block, void = scan_packet(packet)
+            break if (type == OP_ACK) && (block == seq)
+          end
+        end
+
+        yield(data, seq) if block_given?
+        break if data.size < DATABLOCK
+      end
+      
+      return true
+    end
+
+  end #TFTP
+  
+  # Simple factory for returning RRQ and WRQ source/sinks.
+  class DefaultOpFactory
+    # Returns a handler for a 'get' file.  Throw a TFTPError if the
+    # resource is not allowed.
+    def rrq_operation_for(file_name, remote_host)
+      RRQOperation.new(file_name)
+    end
+    
+    # Returns the handler for 'put' file.  Throw a TFTPError if the
+    # resource is not allowed.
+    def wrq_operation_for(file_name, remote_host)
+      WRQOperation.new(file_name)
+    end
+  end
+  
+  class Server
+	  attr_accessor :options
+	  include PacketOperations
+	  
+	  # options: port, timeout, max_threads, data_directory, operation_factory
+	  def initialize(options = { :port => 69, :timeout => 5, :max_threads => 10 })
+	    @socket = UDPSocket.open
+	    @options = options.clone
+	    @op_factory = @options[:operation_factory] || DefaultOpFactory.new
+	    @options[:port] ||= DEFAULTS[:port]
+	    @options[:max_pkt_size] ||= 8000
+	    @options[:timeout] ||= DEFAULTS[:timeout]
+      @socket.bind("0.0.0.0", @options[:port])
+      @worker_threads = []
+      @queue = [] # queue of [data, remote_addr]
+      @mutex = Mutex.new
+      @condition_var = ConditionVariable.new
+      # Hash of IP:Port => TFTPOperation
+      @operations = {}
+    end
+    
+    def start
+      # Create worker threads
+      (@options[:max_threads] || 2).times do |i|
+        @worker_threads << Thread.new(self) do |server|
+          loop do
+            begin
+              server.dequeue_and_process
+            rescue Exception => e
+              puts e
+              puts e.backtrace.join("\n")
+            end
+          end
+        end
+      end
+
+      Thread.new(self) do |server|
+        loop do
+          sleep 6
+          begin
+            server.remove_expired_operations
+          rescue Exception => e
+            puts e
+            puts e.backtrace.join("\n")
+          end
+        end
+      end
+      
+      loop do
+        begin
+          data, remote_info = @socket.recvfrom(@options[:max_pkt_size])
+          dispatch(data, remote_info)
+        rescue Exception => e
+          puts "TFTP::Server exception: #{e}\n#{e.backtrace.join('\n')}"
+          break
+        end
+      end
+    end
+
+    def stop
+      @worker_threads.each { |thread| thread.kill }
+      @worker_threads.clear
+      @socket.close
+    end
+
+    def send_reply(block, remote_info)
+      # socket ops are 'thread' safe
+      @socket.send(block, 0, remote_info[3], remote_info[1])
+    end
+    
+    def dispatch(data, remote_info)
+      @mutex.synchronize do
+        @queue << [data, remote_info]
+        @condition_var.signal
+      end
+    end
+    
+    def work_unit
+      unit = nil
+      @mutex.synchronize do
+        loop do
+          unit = @queue.pop
+          break unless unit.nil?
+          @condition_var.wait(@mutex)
+        end
+      end
+      unit
+    end
+
+    def dequeue_and_process
+      data, remote_info = work_unit
+      scan = scan_packet(data) # operation, ([file_name, xfer type] || [block_num, data])
+
+      case scan[0]
+      when OP_WRQ
+        begin
+          add_operation(@op_factory.wrq_operation_for(full_path(scan[1]), remote_info), remote_info)
+          send_reply(ack_packet(0), remote_info)
+        rescue Exception => e
+          puts "*ERROR* #{e}\n#{e.backtrace.join('\n')}"
+          error_code = ERROR_ACCESS_VIOLATION
+          error_code = e.code if e.is_a?(TFTPProtocol)
+          send_reply(error_packet(error_code), remote_info)
+        end
+
+      when OP_RRQ
+        begin
+          rrq_op = add_operation(@op_factory.rrq_operation_for(full_path(scan[1]), remote_info), remote_info)
+          send_reply(data_packet(*rrq_op.data_block), remote_info)
+        rescue TFTPError => e
+          error_code = ERROR_ACCESS_VIOLATION
+          error_code = e.code if e.is_a?(TFTPProtocol)
+          send_reply(error_packet(error_code), remote_info)
+        end
+
+      when OP_DATA
+        op = operation_for(remote_info)
+        if op && op.is_a?(WRQOperation)
+          begin
+            bytes = op.incoming_data(scan[2], scan[1])
+            if bytes < 512
+              op.complete
+              # We don't remove the operation incase the client loses the last ack.
+              # We'll let the expiring wrapper remove it.
+              #remove_operation_for(remote_info)  
+            end
+            # We'll always ACK the given packet number since it could be a retry.
+            send_reply(ack_packet(scan[1]), remote_info)
+          rescue Exception => e
+            puts "OP_DATA ERROR: #{e}\n#{e.backtrace.join("\n")}"
+          end
+        else
+          send_reply(error_packet(ERROR_UNKNOWN_TRANSFER_ID), remote_info)
+        end
+
+      when OP_ACK
+        op = operation_for(remote_info)
+        if op && op.is_a?(RRQOperation)
+          send_reply(data_packet(*op.data_block), remote_info)
+        else
+          send_reply(error_packet(ERROR_UNKNOWN_TRANSFER_ID), remote_info)
+        end
+      else
+        send_reply(error_packet(ERROR_UNKNOWN_TRANSFER_ID), remote_info)
+      end
+    end
+    
+    def remote_key(remote_info)
+      "#{remote_info[3]}:#{remote_info[1]}"
+    end
+    
+    def add_operation(op, remote_info)
+      @mutex.synchronize do
+        # Double the timeout value for the auto-expiring to allow for retry operations
+        @operations[remote_key(remote_info)] = ExpiringWrapper.new(op, @options[:timeout] * 2)
+      end
+      op
+    end
+    
+    # Checks for an existing connection/operation for the given
+    # IP/port
+    def operation_for(remote_info)
+      @mutex.synchronize do
+        exp_wrapper = @operations[remote_key(remote_info)]
+        exp_wrapper.operation if exp_wrapper
+      end
+    end
+    
+    def remove_operation_for(remote_info)
+      @mutex.synchronize do
+        @operations.delete(remote_key(remote_info))
+      end
+    end
+    
+    # Removes operations/connections that haven't had any activity recently
+    def remove_expired_operations
+      @mutex.synchronize do
+        @operations.delete_if { |k,wop| wop.operation.abort if wop.expired? ; wop.expired? }
+      end
+    end
+    
+    private
+    def full_path(file_name)
+      # do some cleanup to prevent unwanted directory traversal
+      file_name = file_name.gsub("..", "").gsub(/^[\/\\]*/, "")
+      result = file_name
+      if @options[:data_directory]
+        result = "#{File.join(File.expand_path(@options[:data_directory]), file_name)}"
+      end
+      result
+    end
+    
+	end #TFTP::Server
+
+  # Base class for GET/PUT
+  class TFTPOperation
+    attr_reader :file_name
+  
+    def initialize(file_name)
+      @file_name = file_name
+      @fp = File.new(file_name, file_mode)
+      @complete = false
+      @aborted = false
+    end
+  
+    def complete
+      unless @complete
+        @fp.close unless @fp.closed?
+        @complete = true
+      end
+    end
+  
+    def complete?
+      @complete
+    end
+  
+    def aborted?
+      @aborted
+    end
+  
+    def abort
+      return false if complete? # Can't abort a completed operation.
+      @fp.close unless @fp.closed?
+      @aborted = true
+    end
+  end
+
+  # PUT
+  class WRQOperation < TFTPOperation
+    def initialize(file_name, fmode = "wb")
+      raise TFTPProtocol.new("File exists", ERROR_FILE_ALREADY_EXISTS) if File.exist?(file_name)
+      @file_mode = fmode
+      @last_block_num = 0
+      super file_name
+    end
+  
+    def incoming_data(data, block_num)
+      # Ignore writes if we're complete.  This case can occur if the final ACK was lost
+      if block_num == @last_block_num + 1
+        @fp.write(data) unless complete?
+        @last_block_num = block_num
+      elsif block_num == @last_block_num   # Didn't get last ack.
+        puts "Client lost ACK.  Ignoring resend." if $debug
+      else
+        # We got a block number that we shouldn't have
+        raise TFTPProtocol.new("Unexpected block number #{block_num}.  Expected #{@last_block_num + 1}.", ERROR_ILLEGAL_OPERATION)
+      end
+      data.size
+    end
+  
+    def file_mode
+      @file_mode
+    end
+  
+    def aborted
+      super
+      File.delete(@fp.path) unless complete?
+    end
+  end
+
+  # GET
+  # TODO: Handle retry/file repos logic
+  class RRQOperation < TFTPOperation
+    def initialize(file_name)
+      begin
+        super
+      rescue Errno::ENOENT => e
+        raise TFTPProtocol.new(e.message, ERROR_FILE_NOT_FOUND)
+      end
+      @block_num = 0
+    end
+  
+    def data_block(max_size = 512)
+      [@block_num += 1, @fp.read(max_size)]
+    end
+  
+    def file_mode
+      "rb"
+    end
+  end
+
+  # Simple wrapper that tracks last access time to allow for
+  # expiring of entries.  TTL is in seconds.
+  class ExpiringWrapper
+    def initialize(operation, time_to_live = 10)
+      @operation = operation
+      @last_access = Time.now
+      @time_to_live = time_to_live
+    end
+  
+    def operation
+      @last_access = Time.now
+      @operation
+    end
+  
+    def expired?
+      Time.now - @last_access >= @time_to_live
+    end
+  end
+
+  end #TFTP module
+end #Net module

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: net-tftp_latest_version
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Guillaume Marcais, Spiceworks
+autorequire: net/tftp
+bindir: bin
+cert_chain: []
+date: 2015-02-10 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: guillaume.marcais@free.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/net/tftp.rb
+- README.txt
+- LICENSE.txt
+- GPL.txt
+homepage: https://github.com/spiceworks/net-tftp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Net::TFTP is a pure Ruby implementation of the Trivial File Transfer Protocol
+  (RFC 1350)
+test_files: []