frida-fs 3.0.1 → 4.0.1

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,16 +1,25 @@
-const stream = require('stream');
+import stream from 'stream';
 
 const {platform, pointerSize} = Process;
 
+const S_IFMT = 0xf000;
+const S_IFREG = 0x8000;
+const S_IFDIR = 0x4000;
+const S_IFCHR = 0x2000;
+const S_IFBLK = 0x6000;
+const S_IFIFO = 0x1000;
+const S_IFLNK = 0xa000;
+const S_IFSOCK = 0xc000;
+
 const universalConstants = {
-  S_IFMT: 0xf000,
-  S_IFREG: 0x8000,
-  S_IFDIR: 0x4000,
-  S_IFCHR: 0x2000,
-  S_IFBLK: 0x6000,
-  S_IFIFO: 0x1000,
-  S_IFLNK: 0xa000,
-  S_IFSOCK: 0xc000,
+  S_IFMT,
+  S_IFREG,
+  S_IFDIR,
+  S_IFCHR,
+  S_IFBLK,
+  S_IFIFO,
+  S_IFLNK,
+  S_IFSOCK,
 
   S_IRWXU: 448,
   S_IRUSR: 256,
@@ -403,6 +412,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: {
@@ -422,28 +449,73 @@ const statSpecs = {
     },
   },
 };
-const statSpec = statSpecs[`${platform}-${pointerSize * 8}`] || null;
+let cachedStatSpec = null;
 const statBufSize = 256;
 
-function Stats() {
+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;
+  }
+
+  isDirectory() {
+    return (this.mode & S_IFMT) === S_IFDIR;
+  }
+
+  isCharacterDevice() {
+    return (this.mode & S_IFMT) === S_IFCHR;
+  }
+
+  isBlockDevice() {
+    return (this.mode & S_IFMT) === S_IFBLK;
+  }
+
+  isFIFO() {
+    return (this.mode & S_IFMT) === S_IFIFO;
+  }
+
+  isSymbolicLink() {
+    return (this.mode & S_IFMT) === S_IFLNK;
+  }
+
+  isSocket() {
+    return (this.mode & S_IFMT) === S_IFSOCK;
+  }
 }
 
 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)
@@ -466,6 +538,8 @@ function performStat(impl, path) {
         case 'buffer':
           return buf;
         default:
+          if (property in target)
+            return target[property];
           const value = statsReadField.call(receiver, property);
           return (value !== null) ? value : undefined;
       }
@@ -491,7 +565,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');
@@ -574,11 +648,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) {
@@ -596,13 +677,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;
@@ -610,25 +694,49 @@ function addApiPlaceholder(api, entry) {
   });
 }
 
-module.exports = {
+export function createReadStream(path) {
+  return new ReadStream(path);
+}
+
+export function createWriteStream(path) {
+  return new WriteStream(path);
+}
+
+export const readdir = callbackify(readdirSync);
+export const readFile = callbackify(readFileSync);
+export const readlink = callbackify(readlinkSync);
+export const unlink = callbackify(unlinkSync);
+export const stat = callbackify(statSync);
+export const lstat = callbackify(lstatSync);
+
+export {
   constants,
-  createReadStream(path) {
-    return new ReadStream(path);
-  },
-  createWriteStream(path) {
-    return new WriteStream(path);
-  },
-  readdir: callbackify(readdirSync),
   readdirSync,
   list,
-  readFile: callbackify(readFileSync),
   readFileSync,
-  readlink: callbackify(readlinkSync),
   readlinkSync,
-  unlink: callbackify(unlinkSync),
   unlinkSync,
-  stat: callbackify(statSync),
   statSync,
-  lstat: callbackify(lstatSync),
   lstatSync,
+  Stats,
+};
+
+export default {
+  constants,
+  createReadStream,
+  createWriteStream,
+  readdir,
+  readdirSync,
+  list,
+  readFile,
+  readFileSync,
+  readlink,
+  readlinkSync,
+  unlink,
+  unlinkSync,
+  stat,
+  statSync,
+  lstat,
+  lstatSync,
+  Stats,
 };

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "frida-fs",
-  "version": "3.0.1",
+  "version": "4.0.1",
   "description": "Create a stream from a filesystem resource",
   "main": "index.js",
+  "type": "module",
   "files": [
     "/index.js"
   ],