@electerm/ssh2 1.17.2 → 1.18.0

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;
@@ -2949,15 +2951,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.0",
   "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",