nfs-rb 1.0.0

data/lib/nfs/version.rb

@@ -0,0 +1,3 @@
+module NFS
+  VERSION = '1.0.0'
+end

data/lib/nfs/xdr.rb

@@ -0,0 +1,300 @@
+# Ruby XDR. XDR codec for Ruby. Based on RFC 4506.
+
+module NFS
+  module XDR
+    class Void
+      def encode(value)
+        ''
+      end
+
+      def decode(string)
+        nil
+      end
+    end
+
+    class SignedInteger
+      def encode(value)
+        [value].pack('N')
+      end
+
+      def decode(string)
+        string.slice!(0..3).unpack('N').pack('I').unpack('i')[0]
+      end
+    end
+
+    class UnsignedInteger
+      def encode(value)
+        [value].pack('N')
+      end
+
+      def decode(string)
+        string.slice!(0..3).unpack('N')[0]
+      end
+    end
+
+    class Enumeration < SignedInteger
+      def initialize(&block)
+        @values = {}
+        @names = {}
+
+        if block_given?
+          instance_eval(&block)
+        end
+      end
+
+      def name(v_name, value)
+        @values[v_name] = value
+        @names[value] = v_name
+      end
+
+      def encode(name)
+        super(@values[name])
+      end
+
+      def decode(string)
+        @names[super(string)]
+      end
+    end
+
+    class Boolean < Enumeration
+      def initialize
+        super
+
+        name :TRUE, 1
+        name :FALSE, 0
+      end
+    end
+
+    class FloatNum
+      def encode(value)
+        [value].pack('g')
+      end
+
+      def decode(string)
+        string.slice!(0..3).unpack('g')[0]
+      end
+    end
+
+    class DoubleNum
+      def encode(value)
+        [value].pack('G')
+      end
+
+      def decode(string)
+        string.slice!(0..7).unpack('G')[0]
+      end
+    end
+
+    def self.pad(n, align)
+      r = n % align
+      r = align if r == 0
+      n + align - r
+    end
+
+    class FixedString
+      def initialize(n)
+        @n = n
+      end
+
+      def encode(value)
+        [value.to_s].pack('a' + XDR.pad(@n, 4).to_s)
+      end
+
+      def decode(string)
+        superstring = string.slice!(0, XDR.pad(@n, 4))
+        superstring.nil? ? '' : superstring[0, @n]
+      end
+    end
+
+    class DynamicString
+      def initialize(n = nil)
+        @n = n
+        @length = UnsignedInteger.new
+      end
+
+      def encode(value)
+        value = value.to_s
+        n = value.size
+        n = @n if !@n.nil? && @n < n
+        @length.encode(n) + [value].pack('a' + XDR::pad(n, 4).to_s)
+      end
+
+      def decode(string)
+        length = @length.decode(string)
+        superstring = string.slice!(0, XDR.pad(length, 4))
+        superstring.nil? ? '' : superstring[0, length]
+      end
+    end
+
+    class FixedOpaque < FixedString
+    end
+
+    class Opaque < DynamicString
+    end
+
+    class FixedArray
+      def initialize(type, n)
+        @type, @n = type, n
+      end
+
+      def encode(value)
+        n.times do |i|
+          @type.encode(value[i])
+        end
+      end
+
+      def decode(string)
+        Array.new(n) do
+          @type.decode(string)
+        end
+      end
+    end
+
+    class DynamicArray
+      def initialize(type, n)
+        @type, @n = type, n
+        @length = UnsignedInteger.new
+      end
+
+      def encode(value)
+        n = value.size
+
+        if !@n.nil? && @n < n
+          n = @n
+        end
+
+        result = @length.encode(n)
+
+        n.times do |i|
+          result << @type.encode(value[i])
+        end
+
+        result
+      end
+
+      def decode(string)
+        length = @length.decode(string)
+
+        Array.new(length) do
+          @type.decode(string)
+        end
+      end
+    end
+
+    class Optional < DynamicArray
+      def initialize(type)
+        super(type, 1)
+      end
+
+      def encode(value)
+        if value.nil?
+          super([])
+        else
+          super([value])
+        end
+      end
+
+      def decode(string)
+        result = super(string)
+
+        if result.empty?
+          nil
+        else
+          result[0]
+        end
+      end
+    end
+
+    class Structure
+      def initialize(&block)
+        @components = []
+        @names = []
+        instance_eval(&block) if block_given?
+      end
+
+      def component(name, type)
+        @components << [name, type]
+        @names << name
+      end
+
+      def encode(value)
+        ''.tap do |result|
+          @components.each do |component|
+            unless value.include?(component[0])
+              raise 'missing structure component ' + component[0].to_s
+            end
+
+            result << component[1].encode(value[component[0]])
+          end
+        end
+      end
+
+      def decode(string)
+        @components.each_with_object({}) do |component, result|
+          result[component[0]] = component[1].decode(string)
+        end
+      end
+    end
+
+    # Each arm of the union is represented as a struct
+    class Union
+      def initialize(disc_type, &block)
+        @disc_type = disc_type
+        @arms = {}
+        @default_arm = nil
+        instance_eval(&block) if block_given?
+      end
+
+      # Add an arm
+      def arm(disc_value, struct = nil, &block)
+        if block_given?
+          struct = Structure.new(&block)
+        end
+
+        @arms[disc_value] = struct
+      end
+
+      # Set the default arm
+      def default(struct = nil, &block)
+        if block_given?
+          struct = Structure.new(&block)
+        end
+
+        @default_arm = struct
+      end
+
+      def encode(struct)
+        disc = struct[:_discriminant]
+        arm = @default_arm
+        arm = @arms[disc] if @arms.include?(disc)
+        result = @disc_type.encode(disc)
+
+        unless arm.nil?
+          result << arm.encode(struct)
+        end
+
+        result
+      end
+
+      def decode(string)
+        disc = @disc_type.decode(string)
+        arm = @default_arm
+
+        if @arms.include?(disc)
+          arm = @arms[disc]
+        end
+
+        result = nil
+
+        if arm.nil?
+          result = {}
+        else
+          result = arm.decode(string)
+        end
+
+        result[:_discriminant] = disc
+        result
+      end
+    end
+  end
+end

data/nfs-rb.gemspec

@@ -0,0 +1,17 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'nfs/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'nfs-rb'
+  s.version  = ::NFS::VERSION
+  s.authors  = ['Cameron Dutro', 'Brian Ollenberger']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'http://github.com/camertron/nfs'
+  s.description = s.summary = 'An NFS v2 server implemented in pure Ruby.'
+  s.platform = Gem::Platform::RUBY
+  s.require_path = 'lib'
+
+  s.executables << 'nfs-rb'
+
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'LICENSE', 'CHANGELOG.md', 'README.md', 'Rakefile', 'nfs-rb.gemspec']
+end

data/spec/nfs_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'NFS' do
+  it 'supports directory listing' do
+    files = Dir.chdir($dest_dir) do
+      Dir.glob("*.*")
+    end
+
+    expect(files.sort).to eq(['file1.txt', 'file2.txt'].sort)
+  end
+
+  it 'supports reading files' do
+    %w(file1.txt file2.txt).each do |file|
+      orig_contents = File.read(File.join($orig_dir, file))
+      dest_contents = File.read(File.join($dest_dir, file))
+      expect(dest_contents).to eq(orig_contents)
+    end
+  end
+
+  it 'supports file stats' do
+    %w(file1.txt file2.txt).each do |file|
+      orig_stat = File.lstat(File.join($orig_dir, 'file1.txt'))
+      dest_stat = File.lstat(File.join($dest_dir, 'file1.txt'))
+      expect(orig_stat.size).to eq(dest_stat.size)
+      expect(orig_stat.mtime.to_i).to eq(dest_stat.mtime.to_i)
+      expect(orig_stat.ctime.to_i).to eq(dest_stat.ctime.to_i)
+    end
+  end
+end

data/spec/orig_dir/file1.txt

@@ -0,0 +1 @@
+Hello world!

data/spec/orig_dir/file2.txt

@@ -0,0 +1,3 @@
+Oy! This is a other file.
+
+With multiple lines.

data/spec/run_server.rb

@@ -0,0 +1,10 @@
+require 'nfs'
+
+nfs_server = NFS::Server.new(
+  dir: File.expand_path(File.join('.', 'orig_dir'), __dir__),
+  host: '127.0.0.1',
+  port: 1234,
+  protocol: :tcp
+)
+
+nfs_server.join

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+$:.push(File.dirname(__FILE__))
+
+require 'rspec'
+require 'fileutils'
+require 'nfs'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    $orig_dir = File.expand_path(File.join('.', 'orig_dir'), __dir__)
+    $dest_dir = File.expand_path(File.join('.', 'dest_dir'), __dir__)
+
+    FileUtils.mkdir_p($dest_dir)
+
+    $server_pid = Process.spawn(
+      "bundle exec ruby #{File.join('spec', 'run_server.rb')}"
+    )
+
+    system(
+      "mount -t nfs -o "\
+        'rsize=8192,wsize=8192,timeo=1,nfsvers=2,proto=tcp,'\
+        "port=1234,mountport=1234,"\
+        "hard,intr,nolock 127.0.0.1:/ "\
+        "#{$dest_dir}"
+    )
+
+    if $?.exitstatus != 0
+      fail "Unable to mount NFS volume at #{$dest_dir}"
+      exit 1
+    end
+  end
+
+  config.after(:suite) do
+    system("umount #{$dest_dir}")
+
+    if $?.exitstatus != 0
+      fail "Unable to unmount NFS volume at #{$dest_dir}"
+      exit 2
+    end
+
+    Process.kill('HUP', $server_pid)
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: nfs-rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+- Brian Ollenberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-16 00:00:00.000000000 Z
+dependencies: []
+description: An NFS v2 server implemented in pure Ruby.
+email:
+- camertron@gmail.com
+executables:
+- nfs-rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/nfs-rb
+- lib/nfs.rb
+- lib/nfs/default_logger.rb
+- lib/nfs/file_proxy.rb
+- lib/nfs/filehandle.rb
+- lib/nfs/handler.rb
+- lib/nfs/mount.rb
+- lib/nfs/nfs.rb
+- lib/nfs/server.rb
+- lib/nfs/sunrpc.rb
+- lib/nfs/sunrpc/client.rb
+- lib/nfs/sunrpc/procedure.rb
+- lib/nfs/sunrpc/program.rb
+- lib/nfs/sunrpc/server.rb
+- lib/nfs/sunrpc/tcp_server.rb
+- lib/nfs/sunrpc/udp_server.rb
+- lib/nfs/sunrpc/version.rb
+- lib/nfs/version.rb
+- lib/nfs/xdr.rb
+- nfs-rb.gemspec
+- spec/nfs_spec.rb
+- spec/orig_dir/file1.txt
+- spec/orig_dir/file2.txt
+- spec/run_server.rb
+- spec/spec_helper.rb
+homepage: http://github.com/camertron/nfs
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: An NFS v2 server implemented in pure Ruby.
+test_files: []