ssh_tunnel_proxy 1.2.10 → 2.0.1

package/dist/cjs/ssh2-node.js

@@ -0,0 +1,188 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+var process = require("process");
+var fs_1 = require("fs");
+var os_1 = require("os");
+var commander_1 = require("commander");
+var index_1 = require("./index");
+function get_default_config() {
+    var configs = [];
+    try {
+        configs = JSON.parse((0, fs_1.readFileSync)((0, os_1.homedir)() + '/.config/ssh_tunnel_proxy/config.json').toString());
+    }
+    catch (err) {
+        console.log('Error loading config file:', err);
+    }
+    return configs;
+}
+function main() {
+    var _this = this;
+    var program = new commander_1.Command();
+    program
+        .name('ssh2-node')
+        .description('Nodejs ssh2 command line client')
+        .version('1.2.12')
+        .option('-4 --forceIPv4 [forceIPv4]', 'Only connect via resolved IPv4 address for host. Default: false')
+        .option('-6 --forceIPv6 [forceIPv6]', 'Only connect via resolved IPv6 address for host. Default: false')
+        .option('-b --bind [bind]', 'bind_address')
+        .option('-C --compress [compress]', 'Requests compression of all data')
+        .option('-c --cipher [cipher]', 'cipher_spec')
+        .option('-D --dynamic_forward [dynamic_forward]', " Specifies a local 'dynamic' application-level port forwarding.")
+        .option('-e --escape [escape]', 'escape_char Sets the escape character for sessions with a pty.')
+        .option('-F --config [config]', 'configfile')
+        .option('-f --background [background]', 'Requests ssh to go to background just before command execution.')
+        .option('-g --local_forward_remote [local_forward_remote]', 'Allows remote hosts to connect to local forwarded ports.')
+        .option('-i --identity [identity]', 'Private key filename.')
+        .option('-L --local_forward_out [local_forward_out...]', 'bind_address:port:host:hostport')
+        .option('-l --login_name [login_name]', 'login_name')
+        .option('-N --no_exec [no_exec]', 'Do not execute a remote command.')
+        .option('-n --redirect_stdin [redirect_stdin]', 'Redirects stdin from /dev/null')
+        .option('-o --option [option]', 'option')
+        .option('-p --port [port]', 'port Port to connect to on the remote host.')
+        .option('-q --quiet [quiet]', 'Quiet mode. Causes most warning and diagnostic messages to be suppressed.')
+        .option('-R --local_forward_in [local_forward_in...]', 'bind_address:port:host:hostport')
+        .option('-s --subsystem [subsystem]', 'May be used to request invocation of a subsystem on the remote system.')
+        .option('-T --disable_tty [disable_tty]', 'Disable pseudo-tty allocation.')
+        .option('-t --force_tty [force_tty]', 'Force pseudo-tty allocation.')
+        .option('-V --version [version]', 'Display the version number and exit.')
+        .option('-v --verbose [verbose]', 'Verbose mode. Causes ssh to print debugging messages about its progress.')
+        .option('-W --forward_stdin_stdout [forward_stdin_stdout]', 'host:port Requests that standard input and output on the client be forwarded to host on port ver the secure channel.')
+        .option('-X --x11 [x11]', 'Enables X11 forwarding.')
+        .option('-x --x11_disable [x11_disable]', 'Disables X11 forwarding.')
+        .option('-Y --x11_trusted [x11_trusted]', 'Enables trusted X11 forwarding.')
+        .option('-y --log [log]', 'Send log information using the syslog(3)')
+        .option('-H --ngrok [ngrok]', 'Obtain connectiion hostport from ngrok')
+        .option('-J --keychain_service [keychain_service]', 'Service name to obtain private key from system keychain.')
+        .option('-j --keychain_account [keychain_account]', 'Account name to obtain private key from system keychain.')
+        .argument('[userhost_arg]', 'Connect to hostname in config.')
+        .argument('[exec...]', 'Command to exec on remote host.');
+    program.parse(process.argv);
+    var opts = program.opts();
+    var args = program.processedArgs;
+    var username = '';
+    var config_host = '';
+    var host = '';
+    var userhost_arg = "".concat(args[0]);
+    args.shift();
+    var cmd = args.join(' ');
+    var exec = [];
+    if (cmd.length > 0)
+        exec.push(cmd);
+    if (userhost_arg) {
+        if (userhost_arg.indexOf('@') >= 0) {
+            var userhost = userhost_arg.split('@');
+            username = userhost[0];
+            host = userhost[1];
+        }
+        else {
+            config_host = userhost_arg;
+        }
+    }
+    else {
+        console.log('user@host or host name in config not provided');
+        return;
+    }
+    var configs = [];
+    if (config_host) {
+        configs = get_default_config();
+    }
+    if (!config_host) {
+        var config = {
+            hostname: 'cli',
+            username: username,
+            host: host,
+            private_key_filename: opts.identity.trim(),
+        };
+        configs = [config];
+    }
+    var keypairStorage = new index_1.KeypairStorage();
+    var remote_server = '';
+    configs.forEach(function (config) { return __awaiter(_this, void 0, void 0, function () {
+        var service_name, _a, sshTunnelProxy;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    if (config.disabled)
+                        return [2];
+                    if (config_host && config_host !== config.hostname)
+                        return [2];
+                    remote_server = config_host;
+                    if (!config.service_name) return [3, 2];
+                    config.server_name = config.hostname || config_host || 'ssh_tunnel_proxy';
+                    service_name = config.service_name || 'ssh_client';
+                    _a = config;
+                    return [4, keypairStorage.get_keypair(service_name, config.server_name)];
+                case 1:
+                    _a.private_key = _b.sent();
+                    _b.label = 2;
+                case 2:
+                    opts.port && (config.port = opts.port);
+                    opts.local_forward_out && (config.proxy_ports = opts.local_forward_out);
+                    opts.local_forward_in && (config.remote_ports = opts.local_forward_in);
+                    opts.keychain_service && (config.service_name = opts.keychain_service);
+                    opts.keychain_account && (config.server_name = opts.keychain_account);
+                    opts.ngrok && (config.ngrok_api = opts.ngrok);
+                    opts.identity && (config.private_key_filename = opts.identity.trim());
+                    opts.compress && (config.compress = opts.compress);
+                    opts.cypher && (config.cypher = opts.cypher);
+                    if (exec.length > 0) {
+                        config.exec = exec;
+                    }
+                    else {
+                        config.shell = true;
+                    }
+                    sshTunnelProxy = new index_1.SSHTunnelProxy();
+                    sshTunnelProxy.debug_en = opts.verbose;
+                    return [4, sshTunnelProxy.connectSSH(config, null)];
+                case 3:
+                    _b.sent();
+                    if (exec.length > 0) {
+                        process.exit();
+                    }
+                    return [2];
+            }
+        });
+    }); });
+    if (config_host && !remote_server) {
+        console.log("Remote host ".concat(config_host, " not found"));
+    }
+}
+exports.main = main;
+//# sourceMappingURL=ssh2-node.js.map

package/dist/cjs/ssh2-node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssh2-node.js","sourceRoot":"","sources":["../../src/ssh2-node.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,iCAAmC;AACnC,yBAAkC;AAClC,yBAA6B;AAC7B,uCAAoC;AACpC,iCAAoE;AAGpE,SAAS,kBAAkB;IACzB,IAAI,OAAO,GAAqB,EAAE,CAAC;IACnC,IAAI;QACF,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAA,YAAO,GAAE,GAAG,uCAAuC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;KACpG;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC;KAChD;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAgB,IAAI;IAApB,iBA0JC;IAzJC,IAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;IAE9B,OAAO;SACJ,IAAI,CAAC,WAAW,CAAC;SACjB,WAAW,CAAC,iCAAiC,CAAC;SAC9C,OAAO,CAAC,QAAQ,CAAC;SAEjB,MAAM,CAAC,4BAA4B,EAAE,iEAAiE,CAAC;SACvG,MAAM,CAAC,4BAA4B,EAAE,iEAAiE,CAAC;SAGvG,MAAM,CAAC,kBAAkB,EAAE,cAAc,CAAC;SAC1C,MAAM,CAAC,0BAA0B,EAAE,kCAAkC,CAAC;SACtE,MAAM,CAAC,sBAAsB,EAAE,aAAa,CAAC;SAC7C,MAAM,CAAC,wCAAwC,EAAE,iEAAiE,CAAC;SACnH,MAAM,CAAC,sBAAsB,EAAE,gEAAgE,CAAC;SAChG,MAAM,CAAC,sBAAsB,EAAE,YAAY,CAAC;SAC5C,MAAM,CAAC,8BAA8B,EAAE,iEAAiE,CAAC;SACzG,MAAM,CACL,kDAAkD,EAClD,0DAA0D,CAC3D;SAEA,MAAM,CAAC,0BAA0B,EAAE,uBAAuB,CAAC;SAG3D,MAAM,CAAC,+CAA+C,EAAE,iCAAiC,CAAC;SAC1F,MAAM,CAAC,8BAA8B,EAAE,YAAY,CAAC;SAGpD,MAAM,CAAC,wBAAwB,EAAE,kCAAkC,CAAC;SACpE,MAAM,CAAC,sCAAsC,EAAE,gCAAgC,CAAC;SAEhF,MAAM,CAAC,sBAAsB,EAAE,QAAQ,CAAC;SACxC,MAAM,CAAC,kBAAkB,EAAE,6CAA6C,CAAC;SACzE,MAAM,CAAC,oBAAoB,EAAE,2EAA2E,CAAC;SACzG,MAAM,CAAC,6CAA6C,EAAE,iCAAiC,CAAC;SAExF,MAAM,CAAC,4BAA4B,EAAE,wEAAwE,CAAC;SAC9G,MAAM,CAAC,gCAAgC,EAAE,gCAAgC,CAAC;SAC1E,MAAM,CAAC,4BAA4B,EAAE,8BAA8B,CAAC;SACpE,MAAM,CAAC,wBAAwB,EAAE,sCAAsC,CAAC;SACxE,MAAM,CAAC,wBAAwB,EAAE,0EAA0E,CAAC;SAC5G,MAAM,CACL,kDAAkD,EAClD,sHAAsH,CACvH;SAEA,MAAM,CAAC,gBAAgB,EAAE,yBAAyB,CAAC;SACnD,MAAM,CAAC,gCAAgC,EAAE,0BAA0B,CAAC;SACpE,MAAM,CAAC,gCAAgC,EAAE,iCAAiC,CAAC;SAC3E,MAAM,CAAC,gBAAgB,EAAE,0CAA0C,CAAC;SACpE,MAAM,CAAC,oBAAoB,EAAE,wCAAwC,CAAC;SACtE,MAAM,CAAC,0CAA0C,EAAE,0DAA0D,CAAC;SAC9G,MAAM,CAAC,0CAA0C,EAAE,0DAA0D,CAAC;SAC9G,QAAQ,CAAC,gBAAgB,EAAE,gCAAgC,CAAC;SAC5D,QAAQ,CAAC,WAAW,EAAE,iCAAiC,CAAC,CAAC;IAE5D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAC5B,IAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC;IACnC,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,IAAI,WAAW,GAAG,EAAE,CAAC;IACrB,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAM,YAAY,GAAG,UAAG,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC;IAClC,IAAI,CAAC,KAAK,EAAE,CAAC;IACb,IAAM,GAAG,GAAW,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnC,IAAM,IAAI,GAAkB,EAAE,CAAC;IAC/B,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC;QAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEnC,IAAI,YAAY,EAAE;QAChB,IAAI,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAClC,IAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzC,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YACvB,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;SACpB;aAAM;YACL,WAAW,GAAG,YAAY,CAAC;SAC5B;KACF;SAAM;QAEL,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;QAC7D,OAAO;KACR;IAED,IAAI,OAAO,GAAqB,EAAE,CAAC;IAGnC,IAAI,WAAW,EAAE;QACf,OAAO,GAAG,kBAAkB,EAAE,CAAC;KAChC;IAGD,IAAI,CAAC,WAAW,EAAE;QAChB,IAAM,MAAM,GAAc;YACxB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,IAAI;YACV,oBAAoB,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;SAC3C,CAAC;QACF,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC;KACpB;IAGD,IAAM,cAAc,GAAG,IAAI,sBAAc,EAAE,CAAC;IAC5C,IAAI,aAAa,GAAG,EAAE,CAAC;IACvB,OAAO,CAAC,OAAO,CAAC,UAAO,MAAiB;;;;;oBAEtC,IAAI,MAAM,CAAC,QAAQ;wBAAE,WAAO;oBAG5B,IAAI,WAAW,IAAI,WAAW,KAAK,MAAM,CAAC,QAAQ;wBAAE,WAAO;oBAC3D,aAAa,GAAG,WAAW,CAAC;yBAGxB,MAAM,CAAC,YAAY,EAAnB,cAAmB;oBACrB,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,QAAQ,IAAI,WAAW,IAAI,kBAAkB,CAAC;oBACpE,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,YAAY,CAAC;oBACzD,KAAA,MAAM,CAAA;oBAAe,WAAM,cAAc,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,EAAA;;oBAAvF,GAAO,WAAW,GAAG,SAAkE,CAAC;;;oBAI1F,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;oBACvC,IAAI,CAAC,iBAAiB,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;oBACxE,IAAI,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;oBACvE,IAAI,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;oBACvE,IAAI,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;oBACtE,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC9C,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;oBACtE,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACnD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;oBAG7C,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;wBACnB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;qBACpB;yBAAM;wBACL,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;qBACrB;oBAGK,cAAc,GAAG,IAAI,sBAAc,EAAE,CAAC;oBAC5C,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;oBACvC,WAAM,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,EAAA;;oBAA7C,SAA6C,CAAC;oBAG9C,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;wBACnB,OAAO,CAAC,IAAI,EAAE,CAAC;qBAChB;;;;SACF,CAAC,CAAC;IAGH,IAAI,WAAW,IAAI,CAAC,aAAa,EAAE;QACjC,OAAO,CAAC,GAAG,CAAC,sBAAe,WAAW,eAAY,CAAC,CAAC;KACrD;AACH,CAAC;AA1JD,oBA0JC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,65 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { Server, Socket } from 'net';
+import { Writable } from 'stream';
+import { EventEmitter } from 'events';
+import { Client, Channel } from 'electron-ssh2';
+import { KeypairStorage } from './keypair_storage';
+import { NgrokApi } from './ngrok_service';
+import { main } from './ssh2-node';
+interface Listener {
+    [key: string]: Server;
+}
+export type SSHConfig = {
+    hostname: string;
+    username: string;
+    password?: string;
+    host?: string;
+    port?: string;
+    proxy_ports?: Array<string>;
+    remote_ports?: Array<string>;
+    private_key?: string | null;
+    private_key_filename?: string | null;
+    disabled?: boolean;
+    server_name?: string;
+    service_name?: string;
+    compress?: string;
+    cypher?: string;
+    exec?: Array<string>;
+    shell?: boolean;
+    ngrok_api?: string;
+    keepaliveInterval?: number;
+};
+export declare class SSHTunnelProxy extends EventEmitter {
+    protected client: Client;
+    protected keypairStorage: KeypairStorage;
+    protected config: SSHConfig;
+    protected listener: Listener;
+    protected retries: number;
+    protected networkOnline: boolean;
+    protected _tunnelReadyTimeout: ReturnType<typeof setTimeout>;
+    debug_en: boolean;
+    debug_ssh: boolean;
+    constructor();
+    protected close_sockets(proxy_ports: Array<string>): void;
+    protected setup_ssh_forward(socket: Socket, remote_hostname: string, remote_port: string): void;
+    setupProxyPorts(proxy_ports: Array<string>): Promise<void>;
+    execCmd(cmd: string, dataStream?: Writable, errStream?: Writable): Promise<void>;
+    protected remote_shell(err: Error, stream: Channel): void;
+    protected cleanup_events(client: Client): void;
+    do_ssh_connect(opts: SSHConfig): Promise<void>;
+    validate_port_number(port: number, whitelist: object): boolean;
+    validate_local_forward(proxy_ports: Array<string>, whitelist: object): boolean;
+    protected ssh_retry_connect(opts: SSHConfig): void;
+    protected ssh_start_tunnel(opts: SSHConfig): Promise<unknown>;
+    connectSSH(opts: SSHConfig, whitelist: object | null): Promise<void>;
+    onNetworkOnline(): void;
+    onNetworkOffline(): void;
+    generateAndStoreKeypair(serviceName: string, account: string): void;
+    getPublicKey(serviceName: string, account: string): void;
+    getClient(): Client;
+    protected debug(...args: any[]): void;
+}
+export { KeypairStorage, NgrokApi, main as sshcli };