Implement poc nfs

Author: twiggler

dissect/target/helpers/nfs/client.py

@@ -1,14 +1,19 @@
-from typing import Generic, NamedTuple, TypeVar
+from __future__ import annotations
+
+from typing import Generic, Iterator, NamedTuple, TypeVar
 
 from dissect.target.helpers.nfs.nfs import (
     CookieVerf3,
     EntryPlus3,
     FileAttributes3,
     FileHandle3,
     NfsStat,
+    Read3args,
     ReadDirPlusParams,
 )
 from dissect.target.helpers.nfs.serializer import (
+    Read3ArgsSerializer,
+    Read3ResultDeserializer,
     ReadDirPlusParamsSerializer,
     ReadDirPlusResultDeserializer,
 )
@@ -19,6 +24,10 @@
 Verifier = TypeVar("Verifier")
 
 
+class ReadFileError(Exception):
+    pass
+
+
 class ReadDirResult(NamedTuple):
     dir_attributes: FileAttributes3 | None
     entries: list[EntryPlus3]
@@ -30,6 +39,7 @@ class ReadDirResult(NamedTuple):
 class Client(Generic[Credentials, Verifier]):
     DIR_COUNT = 4096  # See https://datatracker.ietf.org/doc/html/rfc1813#section-3.3.17
     MAX_COUNT = 32768
+    READ_CHUNK_SIZE = 1024 * 1024
 
     def __init__(self, rpc_client: SunRpcClient[Credentials, Verifier]):
         self._rpc_client = rpc_client
@@ -39,7 +49,7 @@ def connect(cls, hostname: str, port: int, auth: AuthScheme[Credentials, Verifie
         rpc_client = SunRpcClient.connect(hostname, port, auth, local_port)
         return Client(rpc_client)
 
-    def readdirplus(self, dir: FileHandle3) -> list[EntryPlus3] | NfsStat:
+    def readdirplus(self, dir: FileHandle3) -> ReadDirResult | NfsStat:
         """Read the contents of a directory, including file attributes"""
 
         entries = list[EntryPlus3]()
@@ -61,3 +71,17 @@ def readdirplus(self, dir: FileHandle3) -> list[EntryPlus3] | NfsStat:
 
             cookie = result.entries[-1].cookie
             cookieverf = result.cookieverf
+
+    def readfile_by_handle(self, handle: FileHandle3) -> Iterator[bytes]:
+        """Read a file by its file handle"""
+        offset = 0
+        count = self.READ_CHUNK_SIZE
+        while True:
+            params = Read3args(handle, offset, count)
+            result = self._rpc_client.call(100003, 3, 6, params, Read3ArgsSerializer(), Read3ResultDeserializer())
+            if isinstance(result, NfsStat):
+                raise ReadFileError(f"Failed to read file: {result}")
+            yield result.data
+            if result.eof:
+                return
+            offset += result.count

dissect/target/helpers/nfs/demo.py

@@ -1,7 +1,9 @@
 import argparse
-from dissect.target.helpers.sunrpc.client import Client, auth_null, auth_unix
-from dissect.target.helpers.nfs.serializer import MountResultDeserializer
+
 from dissect.target.helpers.nfs.client import Client as NfsClient
+from dissect.target.helpers.nfs.nfs import EntryPlus3
+from dissect.target.helpers.nfs.serializer import MountResultDeserializer
+from dissect.target.helpers.sunrpc.client import Client, auth_null, auth_unix
 from dissect.target.helpers.sunrpc.serializer import (
     PortMappingSerializer,
     StringSerializer,
@@ -16,9 +18,6 @@
 NFS_PROGRAM = 100003
 NFS_V3 = 3
 
-hostname = "localhost"
-root = "/home/roel"
-
 
 # NFS client demo, showing how to connect to an NFS server and list the contents of a directory
 # Note: some nfs servers require connecting using a low port number (use --port)
@@ -29,6 +28,7 @@ def main():
     parser.add_argument("--port", type=int, default=0, help="The local port to bind to (default: 0)")
     parser.add_argument("--uid", type=int, default=1000, help="The user id to use for authentication")
     parser.add_argument("--gid", type=int, default=1000, help="The group id to use for authentication")
+    parser.add_argument("--index", type=int, default=0, help="The index of the file to read (starting at 1)")
     args = parser.parse_args()
 
     # RdJ: Perhaps move portmapper to nfs client and cache the mapping
@@ -38,16 +38,25 @@ def main():
     params_nfs = PortMapping(program=NFS_PROGRAM, version=NFS_V3, protocol=Protocol.TCP)
     nfs_port = port_mapper_client.call(100000, 2, 3, params_nfs, PortMappingSerializer(), UInt32Serializer())
 
-    mount_client = Client.connect(hostname, mount_port, auth_null(), args.port)
+    mount_client = Client.connect(args.hostname, mount_port, auth_null(), args.port)
     mount_result = mount_client.call(
         MOUNT_PROGRAM, MOUNT_V3, MOUNT, args.root, StringSerializer(), MountResultDeserializer()
     )
     mount_client.close()
 
     auth = auth_unix("twigtop", args.uid, args.gid, [])
-    nfs_client = NfsClient.connect(hostname, nfs_port, auth, args.port)
+    nfs_client = NfsClient.connect(args.hostname, nfs_port, auth, args.port)
     readdir_result = nfs_client.readdirplus(mount_result.filehandle)
-    print(readdir_result)
+    for index, entry in enumerate(readdir_result.entries, start=1):
+        if entry.attributes:
+            print(f"{index:<5} {entry.name:<30} {entry.attributes.size:<10}")
+
+    file_entry: EntryPlus3 = readdir_result.entries[args.index - 1]
+    if file_entry.attributes:
+        file_contents = nfs_client.readfile_by_handle(file_entry.handle)
+        with open(file_entry.name, "wb") as f:
+            for chunk in file_contents:
+                f.write(chunk)
 
 
 if __name__ == "__main__":

dissect/target/helpers/nfs/nfs.py

@@ -1,7 +1,11 @@
+from __future__ import annotations
+
 from dataclasses import dataclass
 from enum import Enum
 from typing import ClassVar
 
+# See https://datatracker.ietf.org/doc/html/rfc1057
+
 
 class NfsStat(Enum):
     NFS3_OK = 0
@@ -125,7 +129,7 @@ class EntryPlus3:
     fileid: int
     name: str
     cookie: int
-    attrs: FileAttributes3 | None
+    attributes: FileAttributes3 | None
     handle: FileHandle3 | None
 
 
@@ -135,3 +139,18 @@ class ReadDirPlusResult3:
     cookieverf: CookieVerf3
     entries: list[EntryPlus3]
     eof: bool
+
+
+@dataclass
+class Read3args:
+    file: FileHandle3
+    offset: int
+    count: int
+
+
+@dataclass
+class Read3resok:
+    file_attributes: FileAttributes3 | None
+    count: int
+    eof: bool
+    data: bytes

dissect/target/helpers/nfs/serializer.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import io
 
 from dissect.target.helpers.nfs.nfs import (
@@ -10,6 +12,8 @@
     MountStat,
     NfsStat,
     NfsTime3,
+    Read3args,
+    Read3resok,
     ReadDirPlusParams,
     ReadDirPlusResult3,
     SpecData3,
@@ -25,13 +29,13 @@
 
 class MountResultDeserializer(Deserializer[MountOK | MountStat]):
     def deserialize(self, payload: io.BytesIO) -> MountOK | None:
-        mountStat = self._read_enum(payload, MountStat)
-        if mountStat != MountStat.MNT3_OK:
-            return mountStat
+        mount_stat = self._read_enum(payload, MountStat)
+        if mount_stat != MountStat.MNT3_OK:
+            return mount_stat
         filehandle_bytes = self._read_var_length_opaque(payload)
-        authFlavors = self._read_var_length(payload, Int32Serializer())
+        auth_flavors = self._read_var_length(payload, Int32Serializer())
 
-        return MountOK(FileHandle3(filehandle_bytes), authFlavors)
+        return MountOK(FileHandle3(filehandle_bytes), auth_flavors)
 
 
 class ReadDirPlusParamsSerializer(Serializer[ReadDirPlusParams]):
@@ -73,10 +77,10 @@ def deserialize(self, payload: io.BytesIO) -> FileAttributes3:
         rdev = SpecDataSerializer().deserialize(payload)
         fsid = self._read_uint64(payload)
         fileid = self._read_uint64(payload)
-        timeDeserializer = NfsTimeSerializer()
-        atime = timeDeserializer.deserialize(payload)
-        mtime = timeDeserializer.deserialize(payload)
-        ctime = timeDeserializer.deserialize(payload)
+        time_deserializer = NfsTimeSerializer()
+        atime = time_deserializer.deserialize(payload)
+        mtime = time_deserializer.deserialize(payload)
+        ctime = time_deserializer.deserialize(payload)
 
         return FileAttributes3(type, mode, nlink, uid, gid, size, used, rdev, fsid, fileid, atime, mtime, ctime)
 
@@ -87,8 +91,8 @@ def deserialize(self, payload: io.BytesIO) -> EntryPlus3:
         name = self._read_string(payload)
         cookie = self._read_uint64(payload)
         attributes = self._read_optional(payload, FileAttributesSerializer())
-        handleBytes = self._read_optional(payload, OpaqueVarLengthSerializer())
-        handle = FileHandle3(handleBytes) if handleBytes is not None else None
+        handle_bytes = self._read_optional(payload, OpaqueVarLengthSerializer())
+        handle = FileHandle3(handle_bytes) if handle_bytes is not None else None
 
         return EntryPlus3(fileid, name, cookie, attributes, handle)
 
@@ -110,6 +114,27 @@ def deserialize(self, payload: io.BytesIO) -> ReadDirPlusResult3:
 
             entries.append(entry)
 
-        eof = self._read_enum(payload, Bool)
+        eof = self._read_enum(payload, Bool) == Bool.TRUE
 
         return ReadDirPlusResult3(dir_attributes, CookieVerf3(cookieverf), entries, eof)
+
+
+class Read3ArgsSerializer(Serializer[ReadDirPlusParams]):
+    def serialize(self, args: Read3args) -> bytes:
+        result = self._write_var_length_opaque(args.file.opaque)
+        result += self._write_uint64(args.offset)
+        result += self._write_uint32(args.count)
+        return result
+
+
+class Read3ResultDeserializer(Deserializer[Read3resok]):
+    def deserialize(self, payload: io.BytesIO) -> Read3resok:
+        stat = self._read_enum(payload, NfsStat)
+        if stat != NfsStat.NFS3_OK:
+            return stat
+
+        file_attributes = self._read_optional(payload, FileAttributesSerializer())
+        count = self._read_uint32(payload)
+        eof = self._read_enum(payload, Bool) == Bool.TRUE
+        data = self._read_var_length_opaque(payload)
+        return Read3resok(file_attributes, count, eof, data)

dissect/target/helpers/sunrpc/client.py

@@ -1,8 +1,10 @@
+from __future__ import annotations
+
+import random
 import socket
 from typing import Generic, NamedTuple, TypeVar
 
 from dissect.target.helpers.sunrpc import sunrpc
-import random
 from dissect.target.helpers.sunrpc.serializer import (
     AuthNullSerializer,
     AuthSerializer,
@@ -43,6 +45,7 @@ def auth_unix(machine: str | None, uid: int, gid: int, gids: list[int]) -> AuthS
     )
 
 
+# RdJ: Error handing is a bit minimalistic. Expand later on.
 class MismatchXidError(Exception):
     pass
 
@@ -139,8 +142,10 @@ def _receive(self) -> bytes:
 
             fragment_header = int.from_bytes(header, "big")
             fragment_size = fragment_header & 0x7FFFFFFF
-            fragment = self._sock.recv(fragment_size)
-            fragments.append(fragment)
+            while fragment_size > 0:
+                fragment = self._sock.recv(fragment_size)
+                fragments.append(fragment)
+                fragment_size -= len(fragment)
 
             # Check for last fragment or underflow
             if (fragment_header & 0x80000000) > 0 or len(fragment) < fragment_size:

dissect/target/helpers/sunrpc/serializer.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
-
+import io
 from abc import ABC, abstractmethod
 from enum import Enum
-import io
 from typing import Generic, TypeVar
+
 from dissect.target.helpers.sunrpc import sunrpc
 
 ProcedureParams = TypeVar("ProcedureParams")