nfs-rb 1.0.0

data/lib/nfs/mount.rb

@@ -0,0 +1,94 @@
+# The XDR representation of the NFS mount protocol. Based on RFC 1094.
+
+module NFS
+  module Mount
+    include SUNRPC
+
+    MNTPATHLEN = 1024 # maximum bytes in a pathname argument
+    MNTNAMLEN = 255   # maximum bytes in a name argument
+
+    # The fhandle is the file handle that the server passes to the client.
+    # All file operations are done using the file handles to refer to a file
+    # or a directory. The file handle can contain whatever information the
+    # server needs to distinguish an individual file.
+    # -just use nfs_fh from the nfs protocol.
+
+    # If a status of zero is returned, the call completed successfully, and
+    # a file handle for the directory follows. A non-zero status indicates
+    # some sort of error. The status corresponds with UNIX error numbers.
+    FhStatus = Union.new(NFS::NFSStat) do
+      arm :NFS_OK do
+        component :fhs_fhandle, NFS::NFSFh
+      end
+
+      default do
+      end
+    end
+
+    # The type dirpath is the pathname of a directory
+    DirPath = DynamicString.new(MNTPATHLEN)
+
+    # The type name is used for arbitrary names (hostnames, groupnames)
+    Name = DynamicString.new(MNTNAMLEN)
+
+    # A list of who has what mounted
+    MountBody = Structure.new do
+      component :ml_hostname, Name
+      component :ml_directory, DirPath
+      component :ml_next, Optional.new(self)
+    end
+
+    MountList = Optional.new(MountBody)
+
+    # A list of netgroups
+    GroupNode = Structure.new do
+      component :gr_name, Name
+      component :gr_next, Optional.new(self)
+    end
+
+    Groups = Optional.new(GroupNode)
+
+    # A list of what is exported and to whom
+    ExportNode = Structure.new do
+      component :ex_dir, DirPath
+      component :ex_groups, Groups
+      component :ex_next, Optional.new(self)
+    end
+
+    Exports = Optional.new(ExportNode)
+
+    MOUNTVERS = 1
+
+    MOUNTPROG = Program.new(100005) do
+      version(MOUNTVERS) do
+        # If fhs_status is 0, then fhs_fhandle contains the
+        # file handle for the directory. This file handle may
+        # be used in the NFS protocol. This procedure also adds
+        # a new entry to the mount list for this client mounting
+        # the directory.
+        # Unix authentication required.
+        procedure FhStatus, :MNT, 1, DirPath
+
+        # Returns the list of remotely mounted filesystems. The
+        # mountlist contains one entry for each hostname and
+        # directory pair.
+        procedure MountList, :DUMP, 2, Void.new
+
+        # Removes the mount list entry for the directory
+        # Unix authentication required.
+        procedure Void.new, :UMNT, 3, DirPath
+
+        # Removes all of the mount list entries for this client
+        # Unix authentication required.
+        procedure Void.new, :UMNTALL, 4, Void.new
+
+        # Returns a list of all the exported filesystems, and which
+        # machines are allowed to import it.
+        procedure Exports, :EXPORT, 5, Void.new
+
+        # Identical to MOUNTPROC_EXPORT above
+        procedure Exports, :EXPORTALL, 6, Void.new
+      end
+    end
+  end
+end

data/lib/nfs/nfs.rb

@@ -0,0 +1,259 @@
+# A port of the NFSv2 XDR specification to Ruby XDR/SUNRPC. Based on RFC 1094.
+
+module NFS
+  module NFS
+    include SUNRPC
+
+    PORT       = 2049
+    MAXDATA    = 8192
+    MAXPATHLEN = 1024
+    MAXNAMELEN = 255
+    FHSIZE     = 32
+    FIFO_DEV   = -1 # size kludge for named pipes
+
+    MODE_FMT  = 0170000 # type of file
+    MODE_DIR  = 0040000 # directory
+    MODE_CHR  = 0020000 # character special
+    MODE_BLK  = 0060000 # block special
+    MODE_REG  = 0100000 # regular
+    MODE_LNK  = 0120000 # symbolic link
+    MODE_SOCK = 0140000 # socket
+    MODE_FIFO = 0010000 # fifo
+
+    NFSStat = Enumeration.new do
+      name :NFS_OK, 0              # no error
+      name :NFSERR_PERM, 1         # Not owner
+      name :NFSERR_NOENT, 2        # No such file or directory
+      name :NFSERR_IO, 5           # I/O error
+      name :NFSERR_NXIO, 6         # No such device or address
+      name :NFSERR_ACCES, 13       # Permission denied
+      name :NFSERR_EXIST, 17       # File exists
+      name :NFSERR_NODEV, 19       # No such device
+      name :NFSERR_NOTDIR, 20      # Not a directory
+      name :NFSERR_ISDIR, 21       # Is a directory
+      name :NFSERR_INVAL, 22       # Invalid argument
+      name :NFSERR_FBIG, 27        # File too large
+      name :NFSERR_NOSPC, 28       # No space left on device
+      name :NFSERR_ROFS, 30        # Read-only file system
+      name :NFSERR_NAMETOOLONG, 63 # File name too long
+      name :NFSERR_NOTEMPTY, 66    # Directory not empty
+      name :NFSERR_DQUOT, 69       # Disc quota exceeded
+      name :NFSERR_STALE, 70       # Stale NFS file handle
+      name :NFSERR_WFLUSH, 99      # Write cache flushed
+    end
+
+    FType = Enumeration.new do
+      name :NFNON, 0  # non-file
+      name :NFREG, 1  # regular file
+      name :NFDIR, 2  # directory
+      name :NFBLK, 3  # block special
+      name :NFCHR, 4  # character special
+      name :NFLNK, 5  # symbolic link
+      name :NFSOCK, 6 # unix domain sockets
+      name :NFBAD, 7  # unused
+      name :NFFIFO, 8 # named pipe
+    end
+
+    NFSFh = Structure.new do
+      component :data, FixedOpaque.new(FHSIZE)
+    end
+
+    NFSTime = Structure.new do
+      component :seconds, UnsignedInteger.new
+      component :useconds, UnsignedInteger.new
+    end
+
+    FAttr = Structure.new do
+      component :type, FType                    # file type
+      component :mode, UnsignedInteger.new      # protection mode bits
+      component :nlink, UnsignedInteger.new     # number of hard links
+      component :uid, UnsignedInteger.new       # owner user id
+      component :gid, UnsignedInteger.new       # owner group id
+      component :size, UnsignedInteger.new      # file size in bytes
+      component :blocksize, UnsignedInteger.new # prefered block size
+      component :rdev, UnsignedInteger.new      # special device number
+      component :blocks, UnsignedInteger.new    # Kb of disk used by file
+      component :fsid, UnsignedInteger.new      # device number
+      component :fileid, UnsignedInteger.new    # inode number
+      component :atime, NFSTime # time of last access
+      component :mtime, NFSTime # time of last modification
+      component :ctime, NFSTime # time of last change
+    end
+
+    SAttr = Structure.new do
+      component :mode, UnsignedInteger.new # protection mode bits
+      component :uid, UnsignedInteger.new  # owner user id
+      component :gid, UnsignedInteger.new  # owner group id
+      component :size, UnsignedInteger.new # file size in bytes
+      component :atime, NFSTime            # time of last access
+      component :mtime, NFSTime            # time of last modification
+    end
+
+    Filename = DynamicString.new(MAXNAMELEN)
+    NFSPath = DynamicString.new(MAXPATHLEN)
+
+    AttrStat = Union.new(NFSStat) do
+      arm :NFS_OK do
+        component :attributes, FAttr
+      end
+
+      default do
+      end
+    end
+
+    SAttrArgs = Structure.new do
+      component :file, NFSFh
+      component :attributes, SAttr
+    end
+
+    DirOpArgs = Structure.new do
+      component :dir, NFSFh
+      component :name, Filename
+    end
+
+    DirOpOkRes = Structure.new do
+      component :file, NFSFh
+      component :attributes, FAttr
+    end
+
+    DirOpRes = Union.new(NFSStat) do
+      arm :NFS_OK do
+        component :diropres, DirOpOkRes
+      end
+
+      default do
+      end
+    end
+
+    ReadLinkRes = Union.new(NFSStat) do
+      arm :NFS_OK do
+        component :data, NFSPath
+      end
+
+      default do
+      end
+    end
+
+    # Arguments to remote read
+    ReadArgs = Structure.new do
+      component :file, NFSFh                       # handle for file
+      component :offset, UnsignedInteger.new     # byte offset in file
+      component :count, UnsignedInteger.new      # immediate read count
+      component :totalcount, UnsignedInteger.new # read count from offset
+    end
+
+    # Status OK portion of remote read reply
+    ReadOkRes = Structure.new do
+      component :attributes, FAttr # Attributes needed for pagin ??
+      component :data, Opaque.new(MAXDATA)
+    end
+
+    ReadRes = Union.new(NFSStat) do
+      arm :NFS_OK do
+        component :reply, ReadOkRes
+      end
+
+      default do
+      end
+    end
+
+    # Arguments to remote write
+    WriteArgs = Structure.new do
+      component :file, NFSFh                     # handle for file
+      component :beginoffset, UnsignedInteger.new # begin. byte offset in file
+      component :offset, UnsignedInteger.new      # curr. byte offset in file
+      component :totalcount, UnsignedInteger.new  # write count to this offset
+      component :data, Opaque.new(MAXDATA)        # data
+    end
+
+    CreateArgs = Structure.new do
+      component :where, DirOpArgs
+      component :attributes, SAttr
+    end
+
+    RenameArgs = Structure.new do
+      component :from, DirOpArgs
+      component :to, DirOpArgs
+    end
+
+    LinkArgs = Structure.new do
+      component :from, NFSFh
+      component :to, DirOpArgs
+    end
+
+    SymlinkArgs = Structure.new do
+      component :from, DirOpArgs
+      component :to, NFSPath
+      component :attributes, SAttr
+    end
+
+    NFSCookie = UnsignedInteger.new
+
+    # Arguments to readdir
+    ReadDirArgs = Structure.new do
+      component :dir, NFSFh                   # directory handle
+      component :cookie, NFSCookie             # cookie
+      component :count, UnsignedInteger.new # directory bytes to read
+    end
+
+    Entry = Structure.new do
+      component :fileid, UnsignedInteger.new
+      component :name, Filename
+      component :cookie, NFSCookie
+      component :nextentry, Optional.new(self)
+    end
+
+    DirList = Structure.new do
+      component :entries, Optional.new(Entry)
+      component :eof, Boolean.new
+    end
+
+    ReadDirRes = Union.new(NFSStat) do
+      arm :NFS_OK do
+        component :reply, DirList
+      end
+    end
+
+    StatFsOkRes = Structure.new do
+      component :tsize, UnsignedInteger.new  # preferred xfer size in bytes
+      component :bsize, UnsignedInteger.new  # file system block size
+      component :blocks, UnsignedInteger.new # total blocks in file system
+      component :bfree, UnsignedInteger.new  # free blocks in fs
+      component :bavail, UnsignedInteger.new # free blocks avail to non-root
+    end
+
+    StatFsRes = Union.new(NFSStat) do
+      arm :NFS_OK do
+        component :reply, StatFsOkRes
+      end
+
+      default do
+      end
+    end
+
+    # Remote file service routines
+    NFS_VERSION = 2
+
+    NFS_PROGRAM = Program.new(100003) do
+      version(NFS_VERSION) do
+        procedure AttrStat, :GETATTR, 1, NFSFh
+        procedure AttrStat, :SETATTR, 2, SAttrArgs
+        procedure Void.new, :ROOT, 3, Void.new
+        procedure DirOpRes, :LOOKUP, 4, DirOpArgs
+        procedure ReadLinkRes, :READLINK, 5, NFSFh
+        procedure ReadRes, :READ, 6, ReadArgs
+        procedure Void.new, :WRITECACHE, 7, Void.new
+        procedure AttrStat, :WRITE, 8, WriteArgs
+        procedure DirOpRes, :CREATE, 9, CreateArgs
+        procedure NFSStat, :REMOVE, 10, DirOpArgs
+        procedure NFSStat, :RENAME, 11, RenameArgs
+        procedure NFSStat, :LINK, 12, LinkArgs
+        procedure NFSStat, :SYMLINK, 13, SymlinkArgs
+        procedure DirOpRes, :MKDIR, 14, CreateArgs
+        procedure NFSStat, :RMDIR, 15, DirOpArgs
+        procedure ReadDirRes, :READDIR, 16, ReadDirArgs
+        procedure StatFsRes, :STATFS, 17, NFSFh
+      end
+    end
+  end
+end

data/lib/nfs/server.rb

@@ -0,0 +1,39 @@
+module NFS
+  class Server
+    attr_reader :dir, :host, :port, :protocol
+
+    def initialize(dir:, host:, port:, protocol:)
+      @dir = dir
+      @host = host
+      @port = port
+      @protocol = protocol
+
+      @handler = Handler.new(FileProxy.open(dir))
+      @server = server_class.new(@handler.programs, port, host)
+    end
+
+    def join
+      @server.join
+    end
+
+    def start
+      @server.start
+    end
+
+    def shutdown
+      @server.shutdown
+    end
+
+    private
+
+    def server_class
+      if protocol == :tcp
+        SUNRPC::TCPServer
+      elsif protocol == :udp
+        SUNRPC::UDPServer
+      else
+        raise "Unsupported protocol #{protocol}, expected :tcp or :udp"
+      end
+    end
+  end
+end

data/lib/nfs/sunrpc.rb

@@ -0,0 +1,365 @@
+# Ruby XDR based implementation of SUNRPC. Based on RFC 1057.
+
+module NFS
+  module SUNRPC
+    autoload :Client,    'nfs/sunrpc/client'
+    autoload :Procedure, 'nfs/sunrpc/procedure'
+    autoload :Program,   'nfs/sunrpc/program'
+    autoload :Server,    'nfs/sunrpc/server'
+    autoload :TCPServer, 'nfs/sunrpc/tcp_server'
+    autoload :UDPClient, 'nfs/sunrpc/udp_client'
+    autoload :UDPServer, 'nfs/sunrpc/udp_server'
+    autoload :Version,   'nfs/sunrpc/version'
+
+    include XDR
+
+    MAXAUTHLEN = 400
+    AUTH_UNIX_MAXMACHINENAMELEN = 255
+    AUTH_UNIX_MAXGIDS = 16
+
+    AuthFlavor = Enumeration.new do
+      name :AUTH_NULL, 0
+      name :AUTH_UNIX, 1
+      name :AUTH_SHORT, 2
+      name :AUTH_DES, 3
+      # and more to be defined?
+    end
+
+    OpaqueAuth = Structure.new do
+      component :flavor, AuthFlavor
+      component :body, Opaque.new(MAXAUTHLEN)
+    end
+
+    AuthUnix = Structure.new do
+      component :stamp, UnsignedInteger.new
+      component :machinename, DynamicString.new(AUTH_UNIX_MAXMACHINENAMELEN)
+      component :uid, UnsignedInteger.new
+      component :gid, UnsignedInteger.new
+      component :gids, DynamicArray.new(UnsignedInteger.new, AUTH_UNIX_MAXGIDS)
+    end
+
+    AuthDESNamekind = Enumeration.new do
+      name :ADN_FULLNAME, 0
+      name :ADN_NICKNAME, 1
+    end
+
+    DESBlock = FixedOpaque.new(8)
+
+    MAXNETNAMELEN = 255
+
+    AuthDESFullname = Structure.new do
+      component :name, DynamicString.new(MAXNETNAMELEN) # name of client
+      component :key, DESBlock                          # PK encrypted conversation key
+      component :window, FixedOpaque.new(4)             # encrypted window
+    end
+
+    AuthDESCred = Union.new(AuthDESNamekind) do
+      arm :ADN_FULLNAME do
+        component :adc_fullname, AuthDESFullname
+      end
+
+      arm :ADN_NICKNAME do
+        component :adc_nickname, SignedInteger.new
+      end
+    end
+
+    Timestamp = Structure.new do
+      component :seconds, UnsignedInteger.new  # seconds
+      component :useconds, UnsignedInteger.new # microseconds
+    end
+
+    AuthDESVerfClnt = Structure.new do
+      component :adv_timestamp, DESBlock         # encrypted timestamp
+      component :adv_winverf, FixedOpaque.new(4) # encrypted window verifier
+    end
+
+    AuthDESVerfSvr = Structure.new do
+      component :adv_timeverf, DESBlock          # encrypted verifier
+      component :adv_nickname, SignedInteger.new # nickname for client (unencrypted)
+    end
+
+    MsgType = Enumeration.new do
+      name :CALL, 0
+      name :REPLY, 1
+    end
+
+    ReplyStat = Enumeration.new do
+      name :MSG_ACCEPTED, 0
+      name :MSG_DENIED, 1
+    end
+
+    AcceptStat = Enumeration.new do
+      name :SUCCESS, 0       # RPC executed successfully
+      name :PROG_UNAVAIL, 1  # remote hasn't exported program
+      name :PROG_MISMATCH, 2 # remote can't support version number
+      name :PROC_UNAVAIL, 3  # program can't support procedure
+      name :GARBAGE_ARGS, 4  # procedure can't decode params
+    end
+
+    RejectStat = Enumeration.new do
+      name :RPC_MISMATCH, 0 # RPC version number != 2
+      name :AUTH_ERROR, 1   # remote can't authenticate caller
+    end
+
+    AuthStat = Enumeration.new do
+      name :AUTH_BADCRED, 1      # bad credentials (seal broken)
+      name :AUTH_REJECTEDCRED, 2 # client must begin new session
+      name :AUTH_BADVERF, 3      # bad verifier (seal broken)
+      name :AUTH_REJECTEDVERF, 4 # verifier expired or replayed
+      name :AUTH_TOOWEAK, 5      # rejected for security reasons
+    end
+
+    CallBody = Structure.new do
+      component :rpcvers, UnsignedInteger.new # must be equal to two (2)
+      component :prog, UnsignedInteger.new
+      component :vers, UnsignedInteger.new
+      component :proc, UnsignedInteger.new
+      component :cred, OpaqueAuth
+      component :verf, OpaqueAuth
+      # procedure specific parameters start here
+    end
+
+    AcceptedReply = Structure.new do
+      component :verf, OpaqueAuth
+      component :reply_data, Union.new(AcceptStat) do
+        arm :SUCCESS do
+          component :results, FixedOpaque.new(0)
+          # Procedure specific results start here
+        end
+
+        arm :PROG_MISMATCH do
+          component :mismatch_info, Structure.new do
+            component :low, UnsignedInteger.new
+            component :high, UnsignedInteger.new
+          end
+        end
+
+        default do
+          # Void. Cases include PROG_UNAVAIL, PROC_UNAVAIL, and GARBAGE_ARGS.
+        end
+      end
+    end
+
+    RejectedReply = Union.new(RejectStat) do
+      arm :RPC_MISMATCH do
+        component :mismatch_info, Structure.new do
+          component :low, UnsignedInteger.new
+          component :high, UnsignedInteger.new
+        end
+      end
+
+      arm :AUTH_ERROR do
+        component :stat, AuthStat
+      end
+    end
+
+    ReplyBody = Union.new(ReplyStat) do
+      arm :MSG_ACCEPTED do
+        component :areply, AcceptedReply
+      end
+
+      arm :MSG_DENIED do
+        component :rreply, RejectedReply
+      end
+    end
+
+    RpcMsg = Structure.new do
+      component :xid, UnsignedInteger.new
+      component :body, (Union.new(MsgType) do
+        arm :CALL do
+          component :cbody, CallBody
+        end
+
+        arm :REPLY do
+          component :rbody, ReplyBody
+        end
+      end)
+    end
+
+    # Server Exceptions
+
+    class IgnoreRequest < Exception
+      def encode(xid)
+        nil
+      end
+    end
+
+    # Abstract base of "rejected" errors
+    class RequestDenied < Exception
+      def encode(xid)
+        RpcMsg.encode({
+          xid: xid,
+          body: {
+            _discriminant: :REPLY,
+            rbody: {
+              _discriminant: :MSG_DENIED,
+              rreply: rreply
+            }
+          }
+        })
+      end
+    end
+
+    class RpcMismatch < RequestDenied
+      # RPC mismatch takes the xid since, it won't actually have one
+      # passed to its encode method.
+      def initialize(low, high, xid)
+        @low, @high, @xid = low, high, xid
+      end
+
+      def encode(xid)
+        RpcMsg.encode({
+          xid: @xid,
+          body: {
+            _discriminant: :REPLY,
+            rbody: {
+              _discriminant: :MSG_DENIED,
+              rreply: rreply
+            }
+          }
+        })
+      end
+
+      private
+
+      def rreply
+        {
+          _discriminant: :RPC_MISMATCH,
+          mismatch_info: {
+            low: @low,
+            high: @high
+          }
+        }
+      end
+    end
+
+    # Abstract base of authentication errors
+    class AuthenticationError < RequestDenied
+      private
+
+      def rreply
+        {
+          _discriminant: :AUTH_ERROR,
+          stat: AuthStat
+        }
+      end
+    end
+
+    class BadCredentials < AuthenticationError
+      private
+
+      def auth_stat
+        :AUTH_BADCRED
+      end
+    end
+
+    class RejectedCredentials < AuthenticationError
+      private
+
+      def auth_stat
+        :AUTH_REJECTEDCRED
+      end
+    end
+
+    class BadVerifier < AuthenticationError
+      private
+
+      def auth_stat
+        :AUTH_BADVERF
+      end
+    end
+
+    class RejectedVerifier < AuthenticationError
+      private
+
+      def auth_stat
+        :AUTH_REJECTEDVERF
+      end
+    end
+
+    class TooWeak < AuthenticationError
+      private
+
+      def auth_stat
+        :AUTH_TOOWEAK
+      end
+    end
+
+    # Abstract base of errors where the message was "accepted"
+    class AcceptedError < Exception
+      def encode(xid)
+        RpcMsg.encode({
+          xid: xid,
+          body: {
+            _discriminant: :REPLY,
+            rbody: {
+              _discriminant: :MSG_ACCEPTED,
+              areply: areply
+            }
+          }
+        })
+      end
+    end
+
+    # Program not supported
+    class ProgramUnavailable < AcceptedError
+      private
+
+      def areply
+        {
+          verf: { flavor: :AUTH_NULL, body: '' },
+          reply_data: {
+            _discriminant: :PROG_UNAVAIL
+          }
+        }
+      end
+    end
+
+    # Version not supported
+    class ProgramMismatch < AcceptedError
+      def initialize(low, high)
+        @low, @high = low, high
+      end
+
+      private
+
+      def areply
+        {
+          verf: { flavor: :AUTH_NULL, body: '' },
+          reply_data: {
+            _discriminant: :PROG_MISMATCH,
+            low: @low,
+            high: @high
+          }
+        }
+      end
+    end
+
+    # Procedure not supported
+    class ProcedureUnavailable < AcceptedError
+      private
+
+      def areply
+        {
+          verf: { flavor: :AUTH_NULL, body: '' },
+          reply_data: {
+            _discriminant: :PROC_UNAVAIL
+          }
+        }
+      end
+    end
+
+    class GarbageArguments < AcceptedError
+      private
+
+      def areply
+        {
+          verf: { flavor: :AUTH_NULL, body: '' },
+          reply_data: {
+            _discriminant: :GARBAGE_ARGS
+          }
+        }
+      end
+    end
+  end
+end