ssh-config 4.4.3 → 5.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ssh-config",
   "description": "SSH config parser and stringifier",
-  "version": "4.4.3",
+  "version": "5.0.0",
   "author": "Chen Yangjian (https://www.cyj.me)",
   "repository": {
     "type": "git",
@@ -24,7 +24,7 @@
     "mocha": "^8.2.1",
     "nyc": "^15.1.0",
     "sinon": "^17.0.1",
-    "typescript": "^4.6.3"
+    "typescript": "^5.4.4"
   },
   "scripts": {
     "lint": "eslint --ext ts .",

package/src/ssh-config.d.ts

@@ -9,14 +9,22 @@ export interface Directive {
     after: string;
     param: string;
     separator: Separator;
-    value: string | string[];
+    value: string | {
+        val: string;
+        separator: string;
+        quoted?: boolean;
+    }[];
     quoted?: boolean;
 }
 export interface Section extends Directive {
     config: SSHConfig;
 }
 export interface Match extends Section {
-    criteria: Record<string, string | string[]>;
+    criteria: Record<string, string | {
+        val: string;
+        separator: string;
+        quoted?: boolean;
+    }[]>;
 }
 export interface Comment {
     type: LineType.COMMENT;

package/src/ssh-config.js

@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringify = exports.parse = exports.LineType = void 0;
+exports.LineType = void 0;
+exports.parse = parse;
+exports.stringify = stringify;
 const glob_1 = __importDefault(require("./glob"));
 const child_process_1 = require("child_process");
 const os_1 = __importDefault(require("os"));
@@ -17,7 +19,7 @@ var LineType;
 (function (LineType) {
     LineType[LineType["DIRECTIVE"] = 1] = "DIRECTIVE";
     LineType[LineType["COMMENT"] = 2] = "COMMENT";
-})(LineType = exports.LineType || (exports.LineType = {}));
+})(LineType || (exports.LineType = LineType = {}));
 const MULTIPLE_VALUE_PROPS = [
     'IdentityFile',
     'LocalForward',
@@ -69,7 +71,8 @@ function match(criteria, context) {
     };
     for (const key in criteria) {
         const criterion = criteria[key];
-        if (!testCriterion(key, criterion)) {
+        const values = Array.isArray(criterion) ? criterion.map(({ val }) => val) : criterion;
+        if (!testCriterion(key, values)) {
             return false;
         }
     }
@@ -133,7 +136,7 @@ class SSHConfig extends Array {
             for (const line of this) {
                 if (line.type !== LineType.DIRECTIVE)
                     continue;
-                if (line.param === 'Host' && (0, glob_1.default)(line.value, context.params.Host)) {
+                if (line.param === 'Host' && (0, glob_1.default)(Array.isArray(line.value) ? line.value.map(({ val }) => val) : line.value, context.params.Host)) {
                     let canonicalizeHostName = false;
                     let canonicalDomains = [];
                     setProperty(line.param, line.value);
@@ -144,15 +147,15 @@ class SSHConfig extends Array {
                                 canonicalizeHostName = true;
                             }
                             if (/^CanonicalDomains$/i.test(subline.param) && Array.isArray(subline.value)) {
-                                canonicalDomains = subline.value;
+                                canonicalDomains = subline.value.map(({ val }) => val);
                             }
                         }
                     }
-                    if (canonicalDomains.length > 0 && canonicalizeHostName) {
+                    if (canonicalDomains.length > 0 && canonicalizeHostName && context.params.Host === context.params.OriginalHost) {
                         for (const domain of canonicalDomains) {
-                            const host = `${line.value}.${domain}`;
-                            const { stdout } = (0, child_process_1.spawnSync)('nslookup', [host]);
-                            if (!/server can't find/.test(stdout.toString())) {
+                            const host = `${context.params.OriginalHost}.${domain}`;
+                            const { status, stderr } = (0, child_process_1.spawnSync)('nslookup', [host]);
+                            if (status === 0 && !/can't find/.test(stderr.toString())) {
                                 context.params.Host = host;
                                 setProperty('Host', host);
                                 doPass();
@@ -224,7 +227,7 @@ class SSHConfig extends Array {
                 type: LineType.DIRECTIVE,
                 param,
                 separator: ' ',
-                value,
+                value: Array.isArray(value) ? value.map((val, i) => ({ val, separator: i === 0 ? '' : ' ' })) : value,
                 before: sectionLineFound ? indent : indent.replace(/  |\t/, ''),
                 after: '\n',
             };
@@ -272,7 +275,7 @@ class SSHConfig extends Array {
                 type: LineType.DIRECTIVE,
                 param,
                 separator: ' ',
-                value,
+                value: Array.isArray(value) ? value.map((val, i) => ({ val, separator: i === 0 ? '' : ' ' })) : value,
                 before: '',
                 after: '\n',
             };
@@ -302,9 +305,9 @@ class SSHConfig extends Array {
         return config;
     }
 }
-exports.default = SSHConfig;
 SSHConfig.DIRECTIVE = LineType.DIRECTIVE;
 SSHConfig.COMMENT = LineType.COMMENT;
+exports.default = SSHConfig;
 /**
  * Parse SSH config text into structured object.
  */
@@ -393,6 +396,11 @@ function parse(text) {
     function values() {
         const results = [];
         let val = '';
+        // whether current value is quoted or not
+        let valQuoted = false;
+        // the separator preceding current value
+        let valSeparator = ' ';
+        // whether current context is within quotations or not
         let quoted = false;
         let escaped = false;
         while (chr && !RE_LINE_BREAK.test(chr)) {
@@ -408,15 +416,18 @@ function parse(text) {
             }
             else if (quoted) {
                 val += chr;
+                valQuoted = true;
             }
             else if (/[ \t=]/.test(chr)) {
                 if (val) {
-                    results.push(val);
+                    results.push({ val, separator: valSeparator, quoted: valQuoted });
                     val = '';
+                    valQuoted = false;
+                    valSeparator = chr;
                 }
                 // otherwise ignore the space
             }
-            else if (chr === '#') {
+            else if (chr === '#' && results.length > 0) {
                 break;
             }
             else {
@@ -425,11 +436,11 @@ function parse(text) {
             chr = next();
         }
         if (quoted || escaped) {
-            throw new Error(`Unexpected line break at ${results.concat(val).join(' ')}`);
+            throw new Error(`Unexpected line break at ${results.map(({ val }) => val).concat(val).join(' ')}`);
         }
         if (val)
-            results.push(val);
-        return results.length > 1 ? results : results[0];
+            results.push({ val, separator: valSeparator, quoted: valQuoted });
+        return results.length > 1 ? results : results[0].val;
     }
     function directive() {
         const type = LineType.DIRECTIVE;
@@ -450,11 +461,11 @@ function parse(text) {
         if (/^Match$/i.test(param)) {
             const criteria = {};
             if (typeof result.value === 'string') {
-                result.value = [result.value];
+                result.value = [{ val: result.value, separator: '', quoted: result.quoted }];
             }
             let i = 0;
             while (i < result.value.length) {
-                const keyword = result.value[i];
+                const { val: keyword } = result.value[i];
                 switch (keyword.toLowerCase()) {
                     case 'all':
                     case 'canonical':
@@ -466,7 +477,7 @@ function parse(text) {
                         if (i + 1 >= result.value.length) {
                             throw new Error(`Missing value for match criteria ${keyword}`);
                         }
-                        criteria[keyword] = result.value[i + 1];
+                        criteria[keyword] = result.value[i + 1].val;
                         i += 2;
                         break;
                 }
@@ -505,7 +516,6 @@ function parse(text) {
     }
     return configWas;
 }
-exports.parse = parse;
 /**
  * Stringify structured object into SSH config text.
  */
@@ -513,7 +523,11 @@ function stringify(config) {
     let str = '';
     function formatValue(value, quoted) {
         if (Array.isArray(value)) {
-            return value.map(chunk => formatValue(chunk, RE_SPACE.test(chunk))).join(' ');
+            let result = '';
+            for (const { val, separator, quoted } of value) {
+                result += (result ? separator : '') + formatValue(val, quoted || RE_SPACE.test(val));
+            }
+            return result;
         }
         return quoted ? `"${value}"` : value;
     }
@@ -523,14 +537,14 @@ function stringify(config) {
         const value = formatValue(line.value, quoted);
         return `${line.param}${line.separator}${value}`;
     }
-    const format = line => {
+    const format = (line) => {
         str += line.before;
         if (line.type === LineType.COMMENT) {
             str += line.content;
         }
         else if (line.type === LineType.DIRECTIVE && MULTIPLE_VALUE_PROPS.includes(line.param)) {
-            [].concat(line.value).forEach(function (value, i, values) {
-                str += formatDirective({ ...line, value });
+            (Array.isArray(line.value) ? line.value : [line.value]).forEach((value, i, values) => {
+                str += formatDirective({ ...line, value: typeof value !== 'string' ? value.val : value });
                 if (i < values.length - 1)
                     str += `\n${line.before}`;
             });
@@ -539,12 +553,11 @@ function stringify(config) {
             str += formatDirective(line);
         }
         str += line.after;
-        if (line.config) {
+        if ('config' in line) {
             line.config.forEach(format);
         }
     };
     config.forEach(format);
     return str;
 }
-exports.stringify = stringify;
 //# sourceMappingURL=ssh-config.js.map