ssh-config 4.3.0 → 4.4.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ssh-config",
   "description": "SSH config parser and stringifier",
-  "version": "4.3.0",
+  "version": "4.4.1",
   "author": "Chen Yangjian (https://www.cyj.me)",
   "repository": {
     "type": "git",

package/src/ssh-config.d.ts

@@ -1,9 +1,9 @@
-declare enum LineType {
+export declare enum LineType {
     DIRECTIVE = 1,
     COMMENT = 2
 }
-type Separator = ' ' | '=' | '\t';
-interface Directive {
+export type Separator = ' ' | '=' | '\t';
+export interface Directive {
     type: LineType.DIRECTIVE;
     before: string;
     after: string;
@@ -12,29 +12,37 @@ interface Directive {
     value: string | string[];
     quoted?: boolean;
 }
-interface Section extends Directive {
+export interface Section extends Directive {
     config: SSHConfig;
 }
-interface Match extends Section {
+export interface Match extends Section {
     criteria: Record<string, string | string[]>;
 }
-interface Comment {
+export interface Comment {
     type: LineType.COMMENT;
     before: string;
     after: string;
     content: string;
 }
-type Line = Match | Section | Directive | Comment;
-interface FindOptions {
+export type Line = Match | Section | Directive | Comment;
+export interface FindOptions {
     Host?: string;
 }
-interface MatchOptions {
+export interface MatchOptions {
     Host: string;
     User?: string;
 }
-declare class SSHConfig extends Array<Line> {
+export default class SSHConfig extends Array<Line> {
     static readonly DIRECTIVE: LineType.DIRECTIVE;
     static readonly COMMENT: LineType.COMMENT;
+    /**
+     * Parse SSH config text into structured object.
+     */
+    static parse(text: string): SSHConfig;
+    /**
+     * Stringify structured object into SSH config text.
+     */
+    static stringify(config: SSHConfig): string;
     /**
      * Query SSH config by host.
      */
@@ -81,8 +89,3 @@ export declare function parse(text: string): SSHConfig;
  * Stringify structured object into SSH config text.
  */
 export declare function stringify(config: SSHConfig): string;
-declare const _default: typeof SSHConfig & {
-    parse: typeof parse;
-    stringify: typeof stringify;
-};
-export default _default;

package/src/ssh-config.js

@@ -3,21 +3,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringify = exports.parse = void 0;
+exports.stringify = exports.parse = exports.LineType = void 0;
 const glob_1 = __importDefault(require("./glob"));
 const child_process_1 = require("child_process");
 const os_1 = __importDefault(require("os"));
 const RE_SPACE = /\s/;
 const RE_LINE_BREAK = /\r|\n/;
 const RE_SECTION_DIRECTIVE = /^(Host|Match)$/i;
-const RE_MULTI_VALUE_DIRECTIVE = /^(GlobalKnownHostsFile|Host|IPQoS|SendEnv|UserKnownHostsFile|ProxyCommand|Match)$/i;
+const RE_MULTI_VALUE_DIRECTIVE = /^(GlobalKnownHostsFile|Host|IPQoS|SendEnv|UserKnownHostsFile|ProxyCommand|Match|CanonicalDomains)$/i;
 const RE_QUOTE_DIRECTIVE = /^(?:CertificateFile|IdentityFile|IdentityAgent|User)$/i;
 const RE_SINGLE_LINE_DIRECTIVE = /^(Include|IdentityFile)$/i;
 var LineType;
 (function (LineType) {
     LineType[LineType["DIRECTIVE"] = 1] = "DIRECTIVE";
     LineType[LineType["COMMENT"] = 2] = "COMMENT";
-})(LineType || (LineType = {}));
+})(LineType = exports.LineType || (exports.LineType = {}));
 const MULTIPLE_VALUE_PROPS = [
     'IdentityFile',
     'LocalForward',
@@ -43,27 +43,27 @@ function getIndent(config) {
 function match(criteria, context) {
     const testCriterion = (key, criterion) => {
         switch (key.toLowerCase()) {
-            case "all":
+            case 'all':
                 return true;
-            case "final":
+            case 'final':
                 if (context.inFinalPass) {
                     return true;
                 }
                 context.doFinalPass = true;
                 return false;
-            case "exec":
+            case 'exec':
                 const command = `function main {
           ${criterion}
         }
         main`;
                 return (0, child_process_1.spawnSync)(command, { shell: true }).status === 0;
-            case "host":
+            case 'host':
                 return (0, glob_1.default)(criterion, context.params.HostName);
-            case "originalhost":
+            case 'originalhost':
                 return (0, glob_1.default)(criterion, context.params.OriginalHost);
-            case "user":
+            case 'user':
                 return (0, glob_1.default)(criterion, context.params.User);
-            case "localuser":
+            case 'localuser':
                 return (0, glob_1.default)(criterion, context.params.LocalUser);
         }
     };
@@ -76,6 +76,18 @@ function match(criteria, context) {
     return true;
 }
 class SSHConfig extends Array {
+    /**
+     * Parse SSH config text into structured object.
+     */
+    static parse(text) {
+        return parse(text);
+    }
+    /**
+     * Stringify structured object into SSH config text.
+     */
+    static stringify(config) {
+        return stringify(config);
+    }
     compute(opts) {
         if (typeof opts === 'string')
             opts = { Host: opts };
@@ -97,27 +109,47 @@ class SSHConfig extends Array {
                 list.push(value);
             }
             else if (obj[name] == null) {
-                if (name === "HostName") {
+                if (name === 'HostName') {
                     context.params.HostName = value;
                 }
-                else if (name === "User") {
+                else if (name === 'User') {
                     context.params.User = value;
                 }
                 obj[name] = value;
             }
         };
         if (opts.User !== undefined) {
-            setProperty("User", opts.User);
+            setProperty('User', opts.User);
         }
         const doPass = () => {
             for (const line of this) {
                 if (line.type !== LineType.DIRECTIVE)
                     continue;
                 if (line.param === 'Host' && (0, glob_1.default)(line.value, context.params.Host)) {
+                    let canonicalizeHostName = false;
+                    let canonicalDomains = [];
                     setProperty(line.param, line.value);
                     for (const subline of line.config) {
                         if (subline.type === LineType.DIRECTIVE) {
                             setProperty(subline.param, subline.value);
+                            if (/^CanonicalizeHostName$/i.test(subline.param) && subline.value === 'yes') {
+                                canonicalizeHostName = true;
+                            }
+                            if (/^CanonicalDomains$/i.test(subline.param) && Array.isArray(subline.value)) {
+                                canonicalDomains = subline.value;
+                            }
+                        }
+                    }
+                    if (canonicalDomains.length > 0 && canonicalizeHostName) {
+                        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())) {
+                                context.params.Host = host;
+                                setProperty('Host', host);
+                                doPass();
+                                break;
+                            }
                         }
                     }
                 }
@@ -262,6 +294,7 @@ class SSHConfig extends Array {
         return config;
     }
 }
+exports.default = SSHConfig;
 SSHConfig.DIRECTIVE = LineType.DIRECTIVE;
 SSHConfig.COMMENT = LineType.COMMENT;
 /**
@@ -402,16 +435,16 @@ function parse(text) {
             delete result.quoted;
         if (/^Match$/i.test(param)) {
             const criteria = {};
-            if (typeof result.value === "string") {
+            if (typeof result.value === 'string') {
                 result.value = [result.value];
             }
             let i = 0;
             while (i < result.value.length) {
                 const keyword = result.value[i];
                 switch (keyword.toLowerCase()) {
-                    case "all":
-                    case "canonical":
-                    case "final":
+                    case 'all':
+                    case 'canonical':
+                    case 'final':
                         criteria[keyword] = [];
                         i += 1;
                         break;
@@ -500,5 +533,4 @@ function stringify(config) {
     return str;
 }
 exports.stringify = stringify;
-exports.default = Object.assign(SSHConfig, { parse, stringify });
 //# sourceMappingURL=ssh-config.js.map