tftp 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2013 Michael Pellon <michael@p3ll0n.net>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+#### TFTP
+
+[![Code Climate](https://codeclimate.com/github/p3ll0n/tftp.png)](https://codeclimate.com/github/p3ll0n/tftp)
+
+tftp is a pure Ruby TFTP library.
+
+It includes client and server classes, with sample implementations.
+
+##### The TFTP Protocol
+
+Trivial File Transfer Protocol (TFTP) is a file transfer protocol implemented 
+on top of the User Datagram Protocol (UDP) notable for its simplicity.
+
+Its simple design makes it ideal for low memory platforms where it is commonly
+used for booting devices without any storage (routers) and as a part of 
+network based installation systems.
+
+TFTP is currently defined by RFC 1350.
+
+Due to its complete lack of an authentication mechanism it is strongly advised
+the TFTP run only one private, local networks. 

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)

data/lib/tftp.rb

@@ -0,0 +1,3 @@
+require 'bindata'
+
+require 'tftp/protocol'

data/lib/tftp/error.rb

@@ -0,0 +1,22 @@
+module TFTP
+  # An exception raised by TFTP code.
+  class Error < StandardError
+    
+    MESSAGES = {
+      :invalid_block_num    => "Block nums must begin with 1 and increase by one for each new block of data.",
+      :no_filename_provided => "All RRQ/WRQ packets are required to have a filename.",
+      :unsupported_mode => "Octet is the only mode currently supported."
+    }
+
+    def self.message(key, *args)
+      string = MESSAGES[key] or raise "[TFTP BUG] No error messages for #{key}"
+      (args.empty? ? string : string % args).rstrip
+    end
+
+    # @param message [String] The error message
+    def initialize(message = nil)
+      super(message)
+    end
+
+  end
+end

data/lib/tftp/protocol.rb

@@ -0,0 +1,80 @@
+require 'tftp/error'
+
+module TFTP
+  module Protocol
+
+    # Opcodes
+    OP_RRQ    = 1 # Read request
+    OP_WRQ    = 2 # Write request
+    OP_DATA   = 3 # Data
+    OP_ACK    = 4 # Acknowledgment
+    OP_ERROR  = 5 # Error
+
+    MIN_PACKET_SIZE   = 4   # Minimum packet size
+    MAX_PACKET_SIZE   = 516 # Maximum packet size
+    DATABLOCK_SIZE    = 512 # Size of blocks used to send files
+
+    VALID_MODES = ['netascii', 'octet']
+
+    # RRQ Packet
+    class RRQ < BinData::Record
+      bit16   :opcode
+      stringz :filename
+      stringz :mode
+    end  
+
+    # WRQ Packet
+    class WRQ < BinData::Record
+      bit16   :opcode
+      stringz :filename
+      stringz :mode
+
+      def create(opts = {})
+        self.opcode = OP_WRQ
+        
+        if opts[:filename] == nil
+          raise TFTP::Error.message(:no_filename_provided)
+        else
+          self.filename = opts[:filename]
+        end
+
+        self.mode = opts.fetch(:mode, "octet")
+        
+        raise TFTP::Error.message(:unsupported_mode) if !VALID_MODES.any?{ |s| s.casecmp(self.mode)==0 }
+
+        self
+      end 
+    end  
+
+    # Data Packet
+    class Data < BinData::Record
+      bit16  :opcode
+      bit16  :block_num
+      string :data
+    end
+
+    # ACK Packet
+    class ACK < BinData::Record
+      bit16  :opcode
+      bit16  :block_num
+
+      def create(opts = {})
+        self.opcode = OP_ACK
+        self.block_num = opts.fetch(:block_num, 0)
+
+	# Catch the invalid block nums
+        raise TFTP::Error.message(:invalid_block_num) if opts[:block_num].to_i < 0
+
+        self
+      end
+    end
+
+    # Error Packet
+    class Error < BinData::Record
+      bit16   :opcode
+      bit16   :error_code
+      stringz :error_msg
+    end
+
+  end
+end

data/lib/tftp/version.rb

@@ -0,0 +1,3 @@
+module Tftp
+  VERSION = '0.1.0'
+end

data/spec/helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'should_not/rspec'
+require 'tftp'

data/spec/protocol_spec.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+describe 'TFTP::Protocol' do
+  context "when creating packets" do
+    describe 'TFTP::Protocol::ACK.create' do
+
+      let(:packet) { TFTP::Protocol::ACK.new }
+
+      context "when not providing a block number" do
+        it { packet.create.to_binary_s.should == "\x00\x04\x00\x00" }
+      end
+
+      context "when providing a valid block number, e.g., 1" do
+        it { packet.create({:block_num => 1}).to_binary_s.should == "\x00\x04\x00\x01" }
+      end
+
+      context "when not providing a valid block number, e.g. -1" do
+        it { expect { packet.create({:block_num => -1}) }.to raise_error(RuntimeError, 'Block nums must begin with 1 and increase by one for each new block of data.') }
+      end
+
+    end
+
+    describe 'TFTP::Protocol::WRQ.create' do
+
+      let(:packet) { TFTP::Protocol::WRQ.new }
+
+      context "when not providing a filename" do
+        it { expect { packet.create }.to raise_error(RuntimeError, 'All RRQ/WRQ packets are required to have a filename.') }
+      end
+
+      context "when not providing a mode" do
+        it { packet.create({:filename => "test.txt"}).to_binary_s.should == "\x00\x02test.txt\x00octet\x00" }
+      end
+
+      context "when providing an unsupported mode" do
+        it { expect { packet.create({:filename => "test.txt", :mode => "badmode"})}.to raise_error(RuntimeError, 'Octet is the only mode currently supported.') }
+      end
+
+    end    
+
+  end
+end

data/tftp.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tftp/version'
+
+Gem::Specification.new do |spec|
+  spec.name           = "tftp"
+  spec.version        = Tftp::VERSION
+  spec.authors        = ["Michael Pellon"]
+  spec.email          = ["michael@p3ll0n.net"]
+  spec.description    = %q{A pure Ruby TFTP library.}
+  spec.summary        = %q{A pure Ruby TFTP library.}
+  spec.homepage       = "https://github.com/p3ll0n/tftp"
+  spec.license        = "ISC"
+
+  spec.files          = `git ls-files`.split("\n")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/}) 
+  spec.require_paths  = ["lib"]
+ 
+  spec.add_dependency "bindata", "~> 1.5.0"
+
+  spec.add_development_dependency "rake", "~> 10.1.0"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "should_not", "~> 1.0.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: tftp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease:
+platform: ruby
+authors:
+- Michael Pellon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: should_not
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    none: false
+  prerelease: false
+  type: :development
+description: A pure Ruby TFTP library.
+email:
+- michael@p3ll0n.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tftp.rb
+- lib/tftp/error.rb
+- lib/tftp/protocol.rb
+- lib/tftp/version.rb
+- spec/helper.rb
+- spec/protocol_spec.rb
+- tftp.gemspec
+homepage: https://github.com/p3ll0n/tftp
+licenses:
+- ISC
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: A pure Ruby TFTP library.
+test_files:
+- spec/helper.rb
+- spec/protocol_spec.rb