@electerm/ssh2 1.17.2 → 1.18.1

package/lib/client.js

@@ -244,6 +244,8 @@ class Client extends EventEmitter {
                                        ? cfg.debug
                                        : undefined);
 
+    this.config.sftpEncoding = cfg.sftpEncoding || 'utf8';
+
     if (cfg.agentForward === true && !this.config.allowAgentFwd) {
       throw new Error(
         'You must set a valid agent path to allow agent forwarding'
@@ -604,7 +606,7 @@ class Client extends EventEmitter {
           };
           const instance = (
             isSFTP
-            ? new SFTP(this, chanInfo, { debug })
+            ? new SFTP(this, chanInfo, { debug, encoding: this.config.sftpEncoding })
             : new Channel(this, chanInfo)
           );
           this._chanMgr.update(info.recipient, instance);

package/lib/protocol/SFTP.js

@@ -8,6 +8,7 @@ const {
   Writable: WritableStream
 } = require('stream');
 const { inherits, types: { isDate } } = require('util');
+const iconv = require('iconv-lite');
 
 const FastBuffer = Buffer[Symbol.species];
 
@@ -147,6 +148,7 @@ class SFTP extends EventEmitter {
     this._version = -1;
     this._extensions = {};
     this._biOpt = cfg.biOpt;
+    this._encoding = cfg.encoding || 'utf8';
     this._pktLenBytes = 0;
     this._pktLen = 0;
     this._pktPos = 0;
@@ -339,7 +341,8 @@ class SFTP extends EventEmitter {
       uint32        pflags
       ATTRS         attrs
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + pathLen + 4 + 4 + attrsLen);
 
@@ -349,7 +352,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, pathLen, p);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
     writeUInt32BE(buf, flags, p += pathLen);
     writeUInt32BE(buf, attrsFlags, p += 4);
     if (attrsLen) {
@@ -734,7 +737,8 @@ class SFTP extends EventEmitter {
       uint32     id
       string     filename
     */
-    const fnameLen = Buffer.byteLength(filename);
+    const fnameBuf = iconv.encode(filename, this._encoding);
+    const fnameLen = fnameBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + fnameLen);
 
@@ -744,7 +748,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, fnameLen, p);
-    buf.utf8Write(filename, p += 4, fnameLen);
+    buf.set(fnameBuf, p += 4);
 
     this._requests[reqid] = { cb };
 
@@ -762,8 +766,10 @@ class SFTP extends EventEmitter {
       string     oldpath
       string     newpath
     */
-    const oldLen = Buffer.byteLength(oldPath);
-    const newLen = Buffer.byteLength(newPath);
+    const oldBuf = iconv.encode(oldPath, this._encoding);
+    const newBuf = iconv.encode(newPath, this._encoding);
+    const oldLen = oldBuf.length;
+    const newLen = newBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + oldLen + 4 + newLen);
 
@@ -773,9 +779,9 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, oldLen, p);
-    buf.utf8Write(oldPath, p += 4, oldLen);
+    buf.set(oldBuf, p += 4);
     writeUInt32BE(buf, newLen, p += oldLen);
-    buf.utf8Write(newPath, p += 4, newLen);
+    buf.set(newBuf, p += 4);
 
     this._requests[reqid] = { cb };
 
@@ -806,7 +812,8 @@ class SFTP extends EventEmitter {
       string     path
       ATTRS      attrs
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + pathLen + 4 + attrsLen);
 
@@ -816,7 +823,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, pathLen, p);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
     writeUInt32BE(buf, flags, p += pathLen);
     if (attrsLen) {
       p += 4;
@@ -844,7 +851,8 @@ class SFTP extends EventEmitter {
       uint32     id
       string     path
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + pathLen);
 
@@ -854,7 +862,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, pathLen, p);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
 
     this._requests[reqid] = { cb };
 
@@ -987,7 +995,8 @@ class SFTP extends EventEmitter {
       uint32     id
       string     path
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + pathLen);
 
@@ -997,7 +1006,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, pathLen, p);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
 
     this._requests[reqid] = { cb };
 
@@ -1014,7 +1023,8 @@ class SFTP extends EventEmitter {
       uint32     id
       string     path
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + pathLen);
 
@@ -1024,7 +1034,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, pathLen, p);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
 
     this._requests[reqid] = { cb };
 
@@ -1041,7 +1051,8 @@ class SFTP extends EventEmitter {
       uint32     id
       string     path
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + pathLen);
 
@@ -1051,7 +1062,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, pathLen, p);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
 
     this._requests[reqid] = { cb };
 
@@ -1080,7 +1091,8 @@ class SFTP extends EventEmitter {
       string     path
       ATTRS      attrs
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + pathLen + 4 + attrsLen);
 
@@ -1090,7 +1102,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, pathLen, p);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
     writeUInt32BE(buf, flags, p += pathLen);
     if (attrsLen) {
       p += 4;
@@ -1205,7 +1217,8 @@ class SFTP extends EventEmitter {
       uint32     id
       string     path
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + pathLen);
 
@@ -1215,7 +1228,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, pathLen, p);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
 
     this._requests[reqid] = {
       cb: (err, names) => {
@@ -1243,8 +1256,10 @@ class SFTP extends EventEmitter {
       string     linkpath
       string     targetpath
     */
-    const linkLen = Buffer.byteLength(linkPath);
-    const targetLen = Buffer.byteLength(targetPath);
+    const linkBuf = iconv.encode(linkPath, this._encoding);
+    const targetBuf = iconv.encode(targetPath, this._encoding);
+    const linkLen = linkBuf.length;
+    const targetLen = targetBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + linkLen + 4 + targetLen);
 
@@ -1256,14 +1271,14 @@ class SFTP extends EventEmitter {
     if (this._isOpenSSH) {
       // OpenSSH has linkpath and targetpath positions switched
       writeUInt32BE(buf, targetLen, p);
-      buf.utf8Write(targetPath, p += 4, targetLen);
+      buf.set(targetBuf, p += 4);
       writeUInt32BE(buf, linkLen, p += targetLen);
-      buf.utf8Write(linkPath, p += 4, linkLen);
+      buf.set(linkBuf, p += 4);
     } else {
       writeUInt32BE(buf, linkLen, p);
-      buf.utf8Write(linkPath, p += 4, linkLen);
+      buf.set(linkBuf, p += 4);
       writeUInt32BE(buf, targetLen, p += linkLen);
-      buf.utf8Write(targetPath, p += 4, targetLen);
+      buf.set(targetBuf, p += 4);
     }
 
     this._requests[reqid] = { cb };
@@ -1281,7 +1296,8 @@ class SFTP extends EventEmitter {
       uint32     id
       string     path
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + pathLen);
 
@@ -1291,7 +1307,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, reqid, 5);
 
     writeUInt32BE(buf, pathLen, p);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
 
     this._requests[reqid] = {
       cb: (err, names) => {
@@ -1325,8 +1341,10 @@ class SFTP extends EventEmitter {
       string    oldpath
       string    newpath
     */
-    const oldLen = Buffer.byteLength(oldPath);
-    const newLen = Buffer.byteLength(newPath);
+    const oldBuf = iconv.encode(oldPath, this._encoding);
+    const newBuf = iconv.encode(newPath, this._encoding);
+    const oldLen = oldBuf.length;
+    const newLen = newBuf.length;
     let p = 9;
     const buf =
       Buffer.allocUnsafe(4 + 1 + 4 + 4 + 24 + 4 + oldLen + 4 + newLen);
@@ -1339,9 +1357,9 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, 24, p);
     buf.utf8Write('posix-rename@openssh.com', p += 4, 24);
     writeUInt32BE(buf, oldLen, p += 24);
-    buf.utf8Write(oldPath, p += 4, oldLen);
+    buf.set(oldBuf, p += 4);
     writeUInt32BE(buf, newLen, p += oldLen);
-    buf.utf8Write(newPath, p += 4, newLen);
+    buf.set(newBuf, p += 4);
 
     this._requests[reqid] = { cb };
 
@@ -1364,7 +1382,8 @@ class SFTP extends EventEmitter {
       string    "statvfs@openssh.com"
       string    path
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + 19 + 4 + pathLen);
 
@@ -1376,7 +1395,7 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, 19, p);
     buf.utf8Write('statvfs@openssh.com', p += 4, 19);
     writeUInt32BE(buf, pathLen, p += 19);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
 
     this._requests[reqid] = { extended: 'statvfs@openssh.com', cb };
 
@@ -1437,8 +1456,10 @@ class SFTP extends EventEmitter {
       string    oldpath
       string    newpath
     */
-    const oldLen = Buffer.byteLength(oldPath);
-    const newLen = Buffer.byteLength(newPath);
+    const oldBuf = iconv.encode(oldPath, this._encoding);
+    const newBuf = iconv.encode(newPath, this._encoding);
+    const oldLen = oldBuf.length;
+    const newLen = newBuf.length;
     let p = 9;
     const buf =
       Buffer.allocUnsafe(4 + 1 + 4 + 4 + 20 + 4 + oldLen + 4 + newLen);
@@ -1451,9 +1472,9 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, 20, p);
     buf.utf8Write('hardlink@openssh.com', p += 4, 20);
     writeUInt32BE(buf, oldLen, p += 20);
-    buf.utf8Write(oldPath, p += 4, oldLen);
+    buf.set(oldBuf, p += 4);
     writeUInt32BE(buf, newLen, p += oldLen);
-    buf.utf8Write(newPath, p += 4, newLen);
+    buf.set(newBuf, p += 4);
 
     this._requests[reqid] = { cb };
 
@@ -1524,7 +1545,8 @@ class SFTP extends EventEmitter {
       string    path
       ATTRS     attrs
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf =
       Buffer.allocUnsafe(4 + 1 + 4 + 4 + 20 + 4 + pathLen + 4 + attrsLen);
@@ -1538,7 +1560,7 @@ class SFTP extends EventEmitter {
     buf.utf8Write('lsetstat@openssh.com', p += 4, 20);
 
     writeUInt32BE(buf, pathLen, p += 20);
-    buf.utf8Write(path, p += 4, pathLen);
+    buf.set(pathBuf, p += 4);
 
     writeUInt32BE(buf, flags, p += pathLen);
     if (attrsLen) {
@@ -1573,7 +1595,8 @@ class SFTP extends EventEmitter {
       string    "expand-path@openssh.com"
       string    path
     */
-    const pathLen = Buffer.byteLength(path);
+    const pathBuf = iconv.encode(path, this._encoding);
+    const pathLen = pathBuf.length;
     let p = 9;
     const buf = Buffer.allocUnsafe(4 + 1 + 4 + 4 + 23 + 4 + pathLen);
 
@@ -1585,8 +1608,8 @@ class SFTP extends EventEmitter {
     writeUInt32BE(buf, 23, p);
     buf.utf8Write('expand-path@openssh.com', p += 4, 23);
 
-    writeUInt32BE(buf, pathLen, p += 20);
-    buf.utf8Write(path, p += 4, pathLen);
+    writeUInt32BE(buf, pathLen, p += 23);
+    buf.set(pathBuf, p += 4);
 
     this._requests[reqid] = {
       cb: (err, names) => {
@@ -2949,15 +2972,14 @@ const CLIENT_HANDLERS = {
     if (count !== undefined) {
       let names = [];
       for (let i = 0; i < count; ++i) {
-        // We are going to assume UTF-8 for filenames despite the SFTPv3
-        // spec not specifying an encoding because the specs for newer
-        // versions of the protocol all explicitly specify UTF-8 for
-        // filenames
-        const filename = bufferParser.readString(true);
+        // Decode filenames using the configured encoding
+        const filenameBuf = bufferParser.readString();
+        const filename = (filenameBuf ? iconv.decode(filenameBuf, sftp._encoding) : '');
 
         // `longname` only exists in SFTPv3 and since it typically will
-        // contain the filename, we assume it is also UTF-8
-        const longname = bufferParser.readString(true);
+        // contain the filename, we assume it uses the same encoding
+        const longnameBuf = bufferParser.readString();
+        const longname = (longnameBuf ? iconv.decode(longnameBuf, sftp._encoding) : '');
 
         const attrs = readAttrs(sftp._biOpt);
         if (attrs === undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@electerm/ssh2",
-  "version": "1.17.2",
+  "version": "1.18.1",
   "author": "Brian White <mscdex@mscdex.net>",
   "description": "SSH2 client and server modules written in pure JavaScript for node.js",
   "main": "./lib/index.js",
@@ -9,7 +9,8 @@
   },
   "dependencies": {
     "asn1": "^0.2.6",
-    "bcrypt-pbkdf": "^1.0.2"
+    "bcrypt-pbkdf": "^1.0.2",
+    "iconv-lite": "^0.7.2"
   },
   "devDependencies": {
     "@mscdex/eslint-config": "^1.1.0",