dsh-remote 0.8.18 → 0.8.21

package/lib/pool.js

@@ -0,0 +1,511 @@
+// Persistent SSH/SFTP connection pool (one identity → one live client).
+import ssh2 from 'ssh2'
+import { readFileSync } from 'node:fs'
+import { homedir } from 'node:os'
+import path from 'node:path'
+import { toSftpPath, truncate } from './paths.js'
+import { createHostKeyGuard } from './hostkey.js'
+
+const { Client } = ssh2
+
+export class SshPool {
+  constructor(config, opts = {}) {
+    this.config = config
+    this._knownHostsFile = opts.knownHostsFile
+    this.client = null
+    this.connecting = null
+    this.proxyPool = null
+    // Generational token: bumped on every target change / close so a stale
+    // in-flight connect can never hand this pool a connection to an old host.
+    this.epoch = 0
+    /** Auto-detected remote platform: unknown | windows | posix (per target). */
+    this.platform = 'unknown'
+    /** Resolved Git Bash bash.exe path on Windows remotes ('' when none). */
+    this.gitBashPath = ''
+    /** Resolved terminal strategy: native | git-bash. */
+    this.shellMode = 'native'
+    /** In-flight platform detection promise (cached). */
+    this._detecting = null
+    /** Optional async resolver for a machine-stored (keychain) password. */
+    this.passwordResolver = null
+    /** Optional hook called with the live client after a successful connect. */
+    this.onReady = null
+    /** Optional hook called when the pool closes. */
+    this.onCloseHook = null
+  }
+
+  resolveKeyPath() {
+    const p = this.config.privateKeyPath
+    if (!p) return ''
+    if (p.startsWith('~/') || p === '~') return path.join(homedir(), p.slice(1))
+    return p
+  }
+
+  setTarget({ host, port, username, password, privateKeyPath, passphrase, workspace, useAgent, keyboardInteractive, proxy, hostKeyMode }) {
+    if (host !== undefined) this.config.host = String(host)
+    if (port !== undefined && Number(port)) this.config.port = Number(port)
+    if (username !== undefined) this.config.username = String(username)
+    if (password !== undefined && password !== null) this.config.password = String(password)
+    if (privateKeyPath !== undefined) this.config.privateKeyPath = String(privateKeyPath)
+    if (passphrase !== undefined) this.config.passphrase = String(passphrase)
+    if (workspace !== undefined) this.config.workspace = String(workspace)
+    if (useAgent !== undefined) this.config.useAgent = !!useAgent
+    if (keyboardInteractive !== undefined) this.config.keyboardInteractive = !!keyboardInteractive
+    if (proxy !== undefined) this.config.proxy = proxy
+    if (hostKeyMode !== undefined) this.config.hostKeyMode = String(hostKeyMode)
+    // the new target may be a different OS — re-detect on the next command
+    this.platform = 'unknown'
+    this.gitBashPath = ''
+    this.shellMode = 'native'
+    this._detecting = null
+    this.close()
+    return this
+  }
+
+  connect() {
+    if (this.client) return Promise.resolve(this.client)
+    if (this.connecting) return this.connecting
+    const epoch = this.epoch
+    const pending = this._doConnect(epoch)
+    this.connecting = pending
+    const clear = () => {
+      if (this.epoch === epoch && this.connecting === pending) this.connecting = null
+    }
+    pending.then(clear, clear)
+    return pending
+  }
+
+  async _doConnect(epoch) {
+    const isCurrent = () => this.epoch === epoch
+    const knownHostsFile = typeof this._knownHostsFile === 'function' ? this._knownHostsFile() : this._knownHostsFile
+    const guard = createHostKeyGuard(this.config, knownHostsFile)
+    const client = new Client()
+    let settled = false
+    const fail = (err) => {
+      if (settled) return
+      settled = true
+      if (isCurrent() && this.client === client) this.client = null
+      throw guard.lastError ? new Error(guard.lastError) : err
+    }
+
+    // Proxy jump: SSH to the bastion first, then tunnel to the target through it.
+    let sock = null
+    const proxyCfg = this.config.proxy
+    if (proxyCfg && proxyCfg.host) {
+      try {
+        this.proxyPool = new SshPool({
+          ...this.config,
+          host: proxyCfg.host,
+          port: Number(proxyCfg.port) || 22,
+          username: proxyCfg.username || this.config.username || 'root',
+          password: proxyCfg.password || '',
+          privateKeyPath: proxyCfg.privateKeyPath || '',
+          passphrase: proxyCfg.passphrase || '',
+          proxy: undefined,
+        }, { knownHostsFile: this._knownHostsFile })
+        const pclient = await this.proxyPool.connect()
+        if (!isCurrent()) throw new Error('ssh target changed during proxy connect')
+        sock = await new Promise((res, rej) => {
+          pclient.forwardOut('127.0.0.1', 0, this.config.host, this.config.port, (e, ch) => (e ? rej(new Error('proxy forward to target failed: ' + ((e && e.message) || e))) : res(ch)))
+        })
+      } catch (err) {
+        return fail(err)
+      }
+    }
+
+    return new Promise((resolve, reject) => {
+      const rejectOnce = (err) => {
+        if (settled) return
+        settled = true
+        if (isCurrent() && this.client === client) this.client = null
+        reject(guard.lastError ? new Error(guard.lastError) : err)
+      }
+      client.on('ready', () => {
+        if (settled) return
+        settled = true
+        if (!isCurrent()) {
+          try { client.end() } catch {}
+          reject(new Error('ssh target changed during connect'))
+          return
+        }
+        this.client = client
+        resolve(client)
+        if (this.onReady) { try { this.onReady(client) } catch {} }
+      })
+      client.on('error', (e) => rejectOnce(e))
+      client.on('close', () => {
+        if (isCurrent() && this.client === client) this.client = null
+        rejectOnce(new Error('ssh connection closed'))
+      })
+
+      const buildOpts = async () => {
+        const opts = {
+          host: this.config.host,
+          port: this.config.port,
+          username: this.config.username,
+          readyTimeout: this.config.connectTimeoutMs,
+          keepaliveInterval: 15000,
+          keepaliveCountMax: 3,
+          hostVerifier: (key) => guard.verifier(key),
+        }
+        if (sock) opts.sock = sock
+        if (this.config.useAgent) {
+          const sockPath = process.env.SSH_AUTH_SOCK
+          if (sockPath) opts.agent = sockPath
+        }
+        let password = this.config.password || ''
+        if (!password && this.passwordResolver) {
+          try { password = (await this.passwordResolver()) || '' } catch {}
+        }
+        if (password) {
+          opts.password = password
+          opts.tryKeyboard = true
+        } else if (this.config.keyboardInteractive && !this.config.privateKeyPath) {
+          opts.tryKeyboard = true
+        }
+        if (this.config.privateKeyPath) {
+          const keyPath = this.resolveKeyPath()
+          if (!keyPath) {
+            throw new Error('no credentials: set a password or a privateKeyPath to connect')
+          }
+          let key
+          try {
+            key = readFileSync(keyPath)
+          } catch (err) {
+            throw new Error(`cannot read private key "${keyPath}": ${err && err.message}`)
+          }
+          opts.privateKey = key
+          opts.passphrase = this.config.passphrase || undefined
+        } else if (!password && !opts.agent) {
+          throw new Error('no credentials: set a password, a privateKeyPath, or enable useAgent to connect')
+        }
+        return opts
+      }
+
+      buildOpts().then(
+        (opts) => {
+          if (opts.tryKeyboard) {
+            client.on('keyboard-interactive', (name, instructions, lang, prompts, finish) => {
+              finish(prompts.map(() => this.config.password || ''))
+            })
+          }
+          client.connect(opts)
+        },
+        (err) => rejectOnce(err),
+      )
+    })
+  }
+
+  /** Detect the remote platform + locate Git Bash once; cached per target. */
+  detect() {
+    if (this.platform !== 'unknown') return Promise.resolve()
+    if (this._detecting) return this._detecting
+    this._detecting = this._detect().finally(() => {
+      this._detecting = null
+    })
+    return this._detecting
+  }
+
+  async _detect() {
+    let res
+    try {
+      // `cmd /c ver` works under cmd.exe, PowerShell AND Git Bash (all print
+      // "Microsoft Windows …"); on POSIX hosts `cmd` simply doesn't exist.
+      res = await this._execRaw('cmd /c ver', { timeoutMs: Math.min(this.config.commandTimeoutMs, 8000) })
+    } catch (err) {
+      this.platform = 'unknown'
+      this.shellMode = 'native'
+      return
+    }
+    const out = String(res.stdout || '') + '\n' + String(res.stderr || '')
+    if (res.code === 0 && /microsoft windows/i.test(out)) {
+      this.platform = 'windows'
+      await this._resolveGitBash()
+      return
+    }
+    // inconclusive — probe for a Git-Bash/MSYS remote (uname prints MINGW64_NT…)
+    try {
+      const u = await this._execRaw('uname -s', { timeoutMs: Math.min(this.config.commandTimeoutMs, 8000) })
+      if (/mingw|msys|cygwin/i.test(String(u.stdout || ''))) {
+        this.platform = 'windows'
+        await this._resolveGitBash()
+        return
+      }
+    } catch {}
+    this.platform = 'posix'
+    this.shellMode = 'native'
+    this.gitBashPath = ''
+  }
+
+  /** On a Windows remote, locate Git Bash (config path → PATH → common installs). */
+  async _resolveGitBash() {
+    const cfg = String(this.config.shell || '').trim()
+    if (cfg && cfg !== 'git-bash' && cfg !== 'native') {
+      if (await this._cmdExists(cfg)) {
+        this.gitBashPath = cfg
+        this.shellMode = 'git-bash'
+        return
+      }
+    }
+    if (cfg === 'native') {
+      this.shellMode = 'native'
+      this.gitBashPath = ''
+      return
+    }
+    try {
+      const r = await this._execRaw('cmd /c where bash', { timeoutMs: 8000 })
+      const first = String(r.stdout || '').trim().split(/\r?\n/)[0].trim()
+      if (first) {
+        this.gitBashPath = first
+        this.shellMode = 'git-bash'
+        return
+      }
+    } catch {}
+    const candidates = [
+      'C:\\Program Files\\Git\\bin\\bash.exe',
+      'C:\\Program Files (x86)\\Git\\bin\\bash.exe',
+      ...(process.env.LOCALAPPDATA ? [process.env.LOCALAPPDATA + '\\Programs\\Git\\bin\\bash.exe'] : []),
+      '%LOCALAPPDATA%\\Programs\\Git\\bin\\bash.exe',
+    ]
+    for (const c of candidates) {
+      if (await this._cmdExists(c)) {
+        this.gitBashPath = c
+        this.shellMode = 'git-bash'
+        return
+      }
+    }
+    this.shellMode = 'git-bash' // wanted but not found — commands fall back to raw
+    this.gitBashPath = ''
+  }
+
+  async _cmdExists(p) {
+    try {
+      const r = await this._execRaw(`cmd /c if exist "${p}" (echo Y) else (echo N)`, { timeoutMs: 8000 })
+      return /Y/.test(String(r.stdout || ''))
+    } catch {
+      return false
+    }
+  }
+
+  /** Run one remote command; resolves { code, signal, stdout, stderr }.
+   * On Windows remotes with Git Bash the script is piped to `bash -s` over the
+   * exec-channel stdin — no shell quoting round-trip, so any content (quotes,
+   * backslashes, newlines) survives verbatim. */
+  exec(command, timeoutMsOrOpts) {
+    const opts = timeoutMsOrOpts && typeof timeoutMsOrOpts === 'object' ? timeoutMsOrOpts : { timeoutMs: timeoutMsOrOpts }
+    return this.detect().then(() => {
+      if (this.platform === 'windows' && this.gitBashPath) {
+        const script = String(command)
+        return this._execRaw(`"${this.gitBashPath}" -s`, { ...opts, timeoutMs: opts.timeoutMs || this.config.commandTimeoutMs }, (stream) => {
+          try { stream.end(script) } catch {}
+        })
+      }
+      return this._execRaw(command, opts)
+    })
+  }
+
+  /** Raw exec (no detection / no wrapper). Optional stdinWriter(stream) feeds
+   * the remote process stdin (used by the Git Bash `-s` mode). */
+  _execRaw(command, opts, stdinWriter) {
+    const timeoutMs = (opts && opts.timeoutMs) || this.config.commandTimeoutMs
+    return this.connect().then(
+      (client) =>
+        new Promise((resolve, reject) => {
+          let retried = false
+          const runOn = (c) => {
+            const execOpts = {}
+            if (opts && opts.pty) execOpts.pty = true
+            if (opts && opts.env && typeof opts.env === 'object') execOpts.env = opts.env
+            c.exec(command, execOpts, (err, stream) => {
+              if (err) {
+                // Channel-open failure — or a session termination — usually
+                // means the pooled connection died server-side (idle timeout /
+                // network reset) while keepalive hadn't noticed. Drop it and
+                // retry ONCE on a fresh connection.
+                if (!retried && /channel open failure|open failed|unexpected .* session termination|session termination|disconnect/i.test(String((err && err.message) || err))) {
+                  retried = true
+                  this.invalidate()
+                  return this.connect().then(
+                    (fresh) => runOn(fresh),
+                    (e2) => reject(new Error('ssh exec failed (reconnect): ' + ((e2 && e2.message) || e2))),
+                  )
+                }
+                return reject(new Error('ssh exec failed: ' + ((err && err.message) || err)))
+              }
+              let stdout = ''
+              let stderr = ''
+              let settled = false
+              let exitCode = null
+              let exitSignal = null
+              const hardCap = Math.max(this.config.maxOutputChars * 4, 1024 * 1024)
+              const settle = () => {
+                if (settled) return
+                settled = true
+                clearTimeout(timer)
+                resolve({
+                  code: exitCode,
+                  signal: exitSignal,
+                  stdout: truncate(stdout, this.config.maxOutputChars),
+                  stderr: truncate(stderr, this.config.maxOutputChars),
+                })
+              }
+              const timer = setTimeout(() => {
+                if (settled) return
+                exitCode = -1
+                exitSignal = 'TIMEOUT'
+                // Kill the remote command (SIGTERM) rather than just dropping the
+                // channel, so a runaway process cannot keep running and holding
+                // the SSH connection after we've given up on its output.
+                try {
+                  if (typeof stream.signal === 'function') stream.signal('SIGTERM')
+                } catch {}
+                const hardClose = setTimeout(() => {
+                  try { stream.close() } catch {}
+                }, 800)
+                if (typeof hardClose.unref === 'function') hardClose.unref()
+                settle()
+              }, timeoutMs)
+              stream.on('close', (code, signal) => {
+                if (settled) return
+                exitCode = code
+                exitSignal = signal
+                settle()
+              })
+              stream.on('data', (d) => {
+                if (stdout.length < hardCap) stdout += d
+              })
+              stream.stderr.on('data', (d) => {
+                if (stderr.length < hardCap) stderr += d
+              })
+              stream.on('error', (e) => {
+                if (settled) return
+                settled = true
+                clearTimeout(timer)
+                reject(new Error('ssh stream error: ' + ((e && e.message) || e)))
+              })
+              if (stdinWriter) {
+                try { stdinWriter(stream) } catch {}
+              }
+            })
+          }
+          runOn(client)
+        }),
+    )
+  }
+
+  /** Resolve a promisified SFTP client. All paths normalized via toSftpPath(). */
+  sftp() {
+    return this.connect().then(
+      (client) =>
+        new Promise((resolve, reject) => {
+          let retried = false
+          const runOn = (c) => {
+            c.sftp((err, sftp) => {
+              if (err) {
+                // Same dead-connection recovery as exec(): a channel open
+                // failure — or a session termination (remote closed the
+                // SFTP subchannel, e.g. transient network blip / sshd idle
+                // drop) — means the pooled connection is stale: drop it and
+                // retry ONCE on a fresh connection.
+                if (!retried && /channel open failure|open failed|unexpected sftp session termination|session termination|disconnect/i.test(String((err && err.message) || err))) {
+                  retried = true
+                  this.invalidate()
+                  return this.connect().then(
+                    (fresh) => runOn(fresh),
+                    (e2) => reject(new Error('ssh sftp failed (reconnect): ' + ((e2 && e2.message) || e2))),
+                  )
+                }
+                return reject(new Error('ssh sftp failed: ' + ((err && err.message) || err)))
+              }
+              const withTimeout = (fn) => (...args) =>
+                new Promise((r2, j2) => {
+                  const timer = setTimeout(() => j2(new Error('sftp operation timed out')), this.config.commandTimeoutMs)
+                  const done = (e, v) => {
+                    clearTimeout(timer)
+                    e ? j2(e) : r2(v)
+                  }
+                  try { fn(...args, done) } catch (e) { clearTimeout(timer); j2(e) }
+                })
+              const P = (p) => toSftpPath(p)
+              resolve({
+                readdir: (dir) => withTimeout((d, cb) => sftp.readdir(d, cb))(P(dir)),
+                stat: (p) => withTimeout((d, cb) => sftp.stat(d, cb))(P(p)),
+                lstat: (p) => withTimeout((d, cb) => sftp.lstat(d, cb))(P(p)),
+                mkdir: (dir) => withTimeout((d, cb) => sftp.mkdir(d, cb))(P(dir)),
+                rmdir: (dir) => withTimeout((d, cb) => sftp.rmdir(d, cb))(P(dir)),
+                unlink: (p) => withTimeout((d, cb) => sftp.unlink(d, cb))(P(p)),
+                rename: (p, d) => withTimeout((a, b, cb) => sftp.rename(a, b, cb))(P(p), P(d)),
+                realpath: (p) => withTimeout((d, cb) => sftp.realpath(d, cb))(P(p)),
+                readFile: (p) => withTimeout((d, cb) => sftp.readFile(d, cb))(P(p)),
+                writeFile: (p, data) => withTimeout((d, data2, cb) => sftp.writeFile(d, data2, cb))(P(p), data),
+                fastGet: (p, lp) => withTimeout((d, l, cb) => sftp.fastGet(d, l, cb))(P(p), lp),
+                fastPut: (lp, p) => withTimeout((l, d, cb) => sftp.fastPut(l, d, cb))(lp, P(p)),
+                // Range read for oversized previews: never downloads the whole file.
+                readPartial: (p, offset, length) => withTimeout((d, off, len, cb) => {
+                  sftp.open(d, 'r', (e, handle) => {
+                    if (e) return cb(e)
+                    const buf = Buffer.alloc(len)
+                    sftp.read(handle, buf, 0, len, off, (e2, bytesRead, data) => {
+                      sftp.close(handle, () => {})
+                      if (e2) return cb(e2)
+                      cb(null, Buffer.isBuffer(data) ? data.subarray(0, bytesRead) : buf.subarray(0, bytesRead))
+                    })
+                  })
+                })(P(p), offset, length),
+              })
+            })
+          }
+          runOn(client)
+        }),
+    )
+  }
+
+  /**
+   * Drop the cached client and force a fresh connection on the next call.
+   * Called when a channel open fails (e.g. "Channel open failure: open
+   * failed") — the pooled SSH connection is usually dead server-side while
+   * keepalive has not yet noticed, and reusing it keeps failing. The epoch
+   * bump orphans any in-flight connect; the client is ended so ssh2 frees
+   * its sockets.
+   */
+  invalidate() {
+    this.epoch++
+    const client = this.client
+    this.client = null
+    const pending = this.connecting
+    this.connecting = null
+    if (pending && typeof pending.catch === 'function') {
+      try { pending.catch(() => {}) } catch {}
+    }
+    if (this.proxyPool) {
+      try { this.proxyPool.close() } catch {}
+      this.proxyPool = null
+    }
+    if (client) {
+      try { client.end() } catch {}
+    }
+  }
+
+  close() {
+    this.epoch++
+    const client = this.client
+    this.client = null
+    const pending = this.connecting
+    this.connecting = null
+    if (pending && typeof pending.catch === 'function') {
+      try { pending.catch(() => {}) } catch {}
+    }
+    if (this.proxyPool) {
+      try { this.proxyPool.close() } catch {}
+      this.proxyPool = null
+    }
+    if (client) {
+      try {
+        client.end()
+      } catch {}
+    }
+    if (this.onCloseHook) {
+      try { this.onCloseHook() } catch {}
+    }
+  }
+}

package/lib/remote-fs.js

@@ -0,0 +1,143 @@
+// Shared remote SFTP helpers used by both rw_* tools and the sidebar HTTP routes.
+import { joinRemotePath, normalizeRemotePath } from './paths.js'
+
+/** Structured listing: name + type + size + mtime + mode (SFTP protocol-level). */
+export async function listDirStructured(sftp, p) {
+  const target = normalizeRemotePath(p || '/')
+  let list
+  try {
+    list = await sftp.readdir(target)
+  } catch (err) {
+    const msg = String((err && err.message) || err)
+    if (/no such file|not found|does not exist|ENOENT/i.test(msg)) {
+      return { path: target, items: [], missing: true }
+    }
+    throw new Error('browse failed: ' + msg)
+  }
+  const items = []
+  const symIdx = []
+  for (const e of list) {
+    const name = String(e.filename)
+    if (name === '.' || name === '..' || !name) continue
+    const a = e.attrs || {}
+    let type
+    if (a.isSymbolicLink && a.isSymbolicLink()) {
+      type = 'symlink'
+      symIdx.push(items.length)
+    } else if (a.isDirectory && a.isDirectory()) {
+      type = 'dir'
+    } else {
+      type = 'file'
+    }
+    items.push({
+      type,
+      name,
+      size: typeof a.size === 'number' ? a.size : 0,
+      mtime: typeof a.mtime === 'number' ? a.mtime : 0,
+      mode: typeof a.mode === 'number' ? a.mode.toString(8) : '',
+    })
+  }
+  if (symIdx.length) {
+    await Promise.all(symIdx.map(async (i) => {
+      const full = joinRemotePath(target, items[i].name)
+      try {
+        const st = await sftp.lstat(full)
+        items[i].type = st && st.isDirectory && st.isDirectory() ? 'dir' : 'file'
+      } catch { /* degrade to file */ }
+    }))
+  }
+  return { path: target, items }
+}
+
+/** Windows drive letters as display-form dir entries ("This PC" root view). */
+export async function listRemoteDrives(sshPool) {
+  let letters = []
+  try {
+    const res = await sshPool.exec('cmd /c fsutil fsinfo drives', { timeoutMs: Math.min(sshPool.config.commandTimeoutMs || 8000, 8000) })
+    letters = [...String(res.stdout || '').matchAll(/([a-zA-Z]):\\?/g)].map((mm) => mm[1].toUpperCase())
+  } catch {}
+  if (!letters.length) {
+    try {
+      const res = await sshPool.exec('ls -d /[a-z] 2>/dev/null', { timeoutMs: Math.min(sshPool.config.commandTimeoutMs || 8000, 8000) })
+      letters = String(res.stdout || '')
+        .split(/\s+/)
+        .map((s) => s.replace(/^\/+|\/+$/g, ''))
+        .filter((s) => /^[a-zA-Z]$/.test(s))
+        .map((s) => s.toUpperCase())
+    } catch {}
+  }
+  return [...new Set(letters)].sort().map((l) => ({ name: l + ':\\', path: l + ':\\', type: 'dir', drive: true, size: 0, mtime: 0 }))
+}
+
+/** Recursive remote delete (bounded): unlink files bottom-up, then rmdir. */
+export async function removeRemoteTree(sftp, p, maxFiles = 2000) {
+  let removed = 0
+  const walk = async (dir) => {
+    if (removed >= maxFiles) return
+    let entries = []
+    try { entries = (await sftp.readdir(dir)) || [] } catch { return }
+    for (const e of entries) {
+      if (removed >= maxFiles) return
+      const name = String(e.filename)
+      if (name === '.' || name === '..') continue
+      const fp = joinRemotePath(dir, name)
+      const isDir = !!(e.attrs && e.attrs.isDirectory && e.attrs.isDirectory())
+      if (isDir) await walk(fp)
+      else {
+        try { await sftp.unlink(fp); removed++ } catch {}
+      }
+    }
+    try { await sftp.rmdir(dir); removed++ } catch { /* already gone or non-empty */ }
+  }
+  await walk(p)
+  return removed
+}
+
+function looksBinary(buf) {
+  const n = Math.min(buf.length, 8192)
+  for (let i = 0; i < n; i++) if (buf[i] === 0) return true
+  return false
+}
+
+/**
+ * Read a remote file for the sidebar/editor. Oversized files use a range read
+ * (`readPartial`) so we never `fastGet` the whole blob onto disk.
+ */
+export async function previewRemoteFile(sftp, target, opts = {}) {
+  const {
+    maxBytes = 256 * 1024,
+    encoding = 'utf-8',
+    decodeBuf = (buf) => buf.toString('utf8'),
+  } = opts
+  const cap = Math.min(Math.max(Number(maxBytes) || 256 * 1024, 1024), 2 * 1024 * 1024)
+  const st = await sftp.stat(target)
+  const mtime = st && typeof st.mtime === 'number' ? st.mtime : 0
+  const size = st && typeof st.size === 'number' ? st.size : 0
+  let buf
+  let truncated = false
+  if (size > cap) {
+    truncated = true
+    if (typeof sftp.readPartial === 'function') {
+      buf = await sftp.readPartial(target, 0, cap)
+    } else {
+      const full = await sftp.readFile(target)
+      buf = full.subarray(0, cap)
+    }
+  } else {
+    buf = await sftp.readFile(target)
+  }
+  if (looksBinary(buf)) {
+    return {
+      ok: true, binary: true, size, mtime,
+      head: buf.slice(0, Math.min(buf.length, 4096)).toString('base64'),
+      truncated,
+    }
+  }
+  let content = decodeBuf(buf, encoding).replace(/\r\n/g, '\n')
+  if (!truncated && content.length > cap) {
+    truncated = true
+    content = content.slice(0, cap)
+  }
+  if (truncated) content += `\n…[truncated: ${Math.max(0, size - cap)} more bytes]`
+  return { ok: true, binary: false, content, truncated, size, mtime }
+}