frida-fs 4.0.0 → 5.0.0

package/README.md

@@ -9,3 +9,13 @@ const fs = require('frida-fs');
 
 fs.createReadStream('/etc/hosts').pipe(networkStream);
 ```
+
+```js
+const fs = require('frida-fs');
+
+for (const elm of fs.list("/proc/self/")) {
+  console.log(JSON.stringify(elm));
+}
+
+console.log(fs.readFileSync("/etc/hosts"));
+```

package/index.js

@@ -1,4 +1,7 @@
-import stream from 'stream';
+import {Buffer} from 'buffer';
+import process from 'process';
+import {Readable} from 'readable-stream/lib/readable.js';
+import {Writable} from 'readable-stream/lib/writable.js';
 
 const {platform, pointerSize} = Process;
 
@@ -87,7 +90,7 @@ const SEEK_END = 2;
 
 const EINTR = 4;
 
-class ReadStream extends stream.Readable {
+class ReadStream extends Readable {
   constructor(path) {
     super({
       highWaterMark: 4 * 1024 * 1024
@@ -99,8 +102,10 @@ class ReadStream extends stream.Readable {
     const pathStr = Memory.allocUtf8String(path);
     const fd = getApi().open(pathStr, constants.O_RDONLY, 0);
     if (fd.value === -1) {
-      this.emit('error', new Error(`Unable to open file (${getErrorString(fd.errno)})`));
-      this.push(null);
+      process.nextTick(() => {
+        this.emit('error', new Error(`Unable to open file (${getErrorString(fd.errno)})`));
+        this.push(null);
+      });
       return;
     }
 
@@ -127,6 +132,7 @@ class ReadStream extends stream.Readable {
     .catch(error => {
       this._readRequest = null;
       this._closeInput();
+      this.emit('error', error);
       this.push(null);
     });
   }
@@ -139,7 +145,7 @@ class ReadStream extends stream.Readable {
   }
 }
 
-class WriteStream extends stream.Writable {
+class WriteStream extends Writable {
   constructor(path) {
     super({
       highWaterMark: 4 * 1024 * 1024
@@ -153,8 +159,10 @@ class WriteStream extends stream.Writable {
     const mode = constants.S_IRUSR | constants.S_IWUSR | constants.S_IRGRP | constants.S_IROTH;
     const fd = getApi().open(pathStr, flags, mode);
     if (fd.value === -1) {
-      this.emit('error', new Error(`Unable to open file (${getErrorString(fd.errno)})`));
-      this.push(null);
+      process.nextTick(() => {
+        this.emit('error', new Error(`Unable to open file (${getErrorString(fd.errno)})`));
+        this.push(null);
+      });
       return;
     }
 
@@ -412,6 +420,24 @@ const statSpecs = {
       'blksize': [ 48, 'S32' ],
     }
   },
+  'linux-32-stat64': {
+    size: 104,
+    fields: {
+      'dev': [ 0, 'U64' ],
+      'mode': [ 16, 'U32' ],
+      'nlink': [ 20, 'U32' ],
+      'ino': [ 96, 'U64' ],
+      'uid': [ 24, 'U32' ],
+      'gid': [ 28, 'U32' ],
+      'rdev': [ 32, 'U64' ],
+      'atime': [ 72, readTimespec32 ],
+      'mtime': [ 80, readTimespec32 ],
+      'ctime': [ 88, readTimespec32 ],
+      'size': [ 48, 'S64' ],
+      'blocks': [ 64, 'S64' ],
+      'blksize': [ 56, 'S32' ],
+    }
+  },
   'linux-64': {
     size: 144,
     fields: {
@@ -431,9 +457,34 @@ const statSpecs = {
     },
   },
 };
-const statSpec = statSpecs[`${platform}-${pointerSize * 8}`] || null;
+let cachedStatSpec = null;
 const statBufSize = 256;
 
+function getStatSpec() {
+  if (cachedStatSpec !== null)
+    return cachedStatSpec;
+
+  const api = getApi();
+  const stat64Impl = api.stat64 ?? api.__xstat64;
+
+  let platformId = `${platform}-${pointerSize * 8}`;
+  if (platformId === 'linux-32') {
+    if (stat64Impl !== undefined)
+      platformId += '-stat64';
+  }
+
+  const statSpec = statSpecs[platformId];
+  if (statSpec === undefined)
+    throw new Error('Current OS is not yet supported; please open a PR');
+
+  statSpec._stat = stat64Impl ?? api.stat;
+  statSpec._lstat = api.lstat64 ?? api.__lxstat64 ?? api.lstat;
+
+  cachedStatSpec = statSpec;
+
+  return statSpec;
+}
+
 class Stats {
   isFile() {
     return (this.mode & S_IFMT) === S_IFREG;
@@ -465,21 +516,14 @@ class Stats {
 }
 
 function statSync(path) {
-  const api = getApi();
-  const impl = api.stat64 || api.stat;
-  return performStat(impl, path);
+  return performStat(getStatSpec()._stat, path);
 }
 
 function lstatSync(path) {
-  const api = getApi();
-  const impl = api.lstat64 || api.lstat;
-  return performStat(impl, path);
+  return performStat(getStatSpec()._lstat, path);
 }
 
 function performStat(impl, path) {
-  if (statSpec === null)
-    throw new Error('Current OS is not yet supported; please open a PR');
-
   const buf = Memory.alloc(statBufSize);
   const result = impl(Memory.allocUtf8String(path), buf);
   if (result.value !== 0)
@@ -529,7 +573,7 @@ function statsHasField(name) {
 }
 
 function statsReadField(name) {
-  let field = statSpec.fields[name];
+  let field = getStatSpec().fields[name];
   if (field === undefined) {
     if (name === 'birthtime') {
       return statsReadField.call(this, 'ctime');
@@ -612,11 +656,18 @@ const apiSpec = [
   ['unlink', SF, 'int', ['pointer']],
   ['stat', SF, 'int', ['pointer', 'pointer']],
   ['stat64', SF, 'int', ['pointer', 'pointer']],
+  ['__xstat64', SF, 'int', ['int', 'pointer', 'pointer'], invokeXstat],
   ['lstat', SF, 'int', ['pointer', 'pointer']],
   ['lstat64', SF, 'int', ['pointer', 'pointer']],
+  ['__lxstat64', SF, 'int', ['int', 'pointer', 'pointer'], invokeXstat],
   ['strerror', NF, 'pointer', ['int']],
 ];
 
+function invokeXstat(impl, path, buf) {
+  const STAT_VER_LINUX = 3;
+  return impl(STAT_VER_LINUX, path, buf);
+}
+
 let cachedApi = null;
 function getApi() {
   if (cachedApi === null) {
@@ -634,13 +685,16 @@ function addApiPlaceholder(api, entry) {
   Object.defineProperty(api, name, {
     configurable: true,
     get() {
-      const [, Ctor, retType, argTypes] = entry;
+      const [, Ctor, retType, argTypes, wrapper] = entry;
 
       let impl = null;
       const address = Module.findExportByName(null, name);
       if (address !== null)
         impl = new Ctor(address, retType, argTypes);
 
+      if (wrapper !== undefined)
+        impl = wrapper.bind(null, impl);
+
       Object.defineProperty(api, name, { value: impl });
 
       return impl;
@@ -649,11 +703,11 @@ function addApiPlaceholder(api, entry) {
 }
 
 export function createReadStream(path) {
-    return new ReadStream(path);
+  return new ReadStream(path);
 }
 
 export function createWriteStream(path) {
-    return new WriteStream(path);
+  return new WriteStream(path);
 }
 
 export const readdir = callbackify(readdirSync);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "frida-fs",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "Create a stream from a filesystem resource",
   "main": "index.js",
   "type": "module",
@@ -15,5 +15,8 @@
   "bugs": {
     "url": "https://github.com/nowsecure/frida-fs/issues"
   },
-  "homepage": "https://github.com/nowsecure/frida-fs#readme"
+  "homepage": "https://github.com/nowsecure/frida-fs#readme",
+  "dependencies": {
+    "readable-stream": "^4.0.0"
+  }
 }