@maiyunnet/kebab 2.0.0

package/lib/ssh/shell.ts

@@ -0,0 +1,123 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-6-8 22:13
+ * Last: 2020-4-10 16:08:32, 2022-12-30 00:03:40, 2023-4-22 21:06:57
+ */
+import * as ssh2 from 'ssh2';
+import * as lCore from '~/lib/core';
+
+export class Connection {
+
+    /** --- 连接对象 --- */
+    private readonly _client: ssh2.ClientChannel;
+
+    public constructor(stream: ssh2.ClientChannel) {
+        this._client = stream;
+    }
+
+    /**
+     * --- 发送指令 ---
+     * @param cmd 指令
+     * @param encoding 编码
+     */
+    public send(cmd: string | Buffer, encoding?: BufferEncoding): Promise<boolean> {
+        return new Promise((resolve) => {
+            const cb = (e: any): void => {
+                if (e) {
+                    resolve(false);
+                }
+                else {
+                    resolve(true);
+                }
+            };
+            if (encoding) {
+                this._client.write(cmd, encoding, cb);
+            }
+            else {
+                this._client.write(cmd, cb);
+            }
+        });
+    }
+
+    /**
+     * --- 发送带换行的内容（发送并执行） ---
+     * @param cmd 指令
+     * @param encoding 编码
+     */
+    public async sendLine(cmd: string, encoding?: BufferEncoding): Promise<boolean> {
+        return this.send(cmd + '\n', encoding);
+    }
+
+    /**
+     * --- 发送 Enter 键 ---
+     */
+    public async sendEnter(): Promise<boolean> {
+        return this.send('\n');
+    }
+
+    /**
+     * --- 发送 Tab 键 ---
+     */
+    public async sendTab(): Promise<boolean> {
+        return this.send('\t');
+    }
+
+    /**
+     * --- 发送中断 ---
+     */
+    public async sendCtrlC(): Promise<boolean> {
+        return this.send('\x03');
+    }
+
+    /**
+     * --- 关闭 shell ---
+     * @param cmd 命令
+     * @param encoding 编码
+     */
+    public close(cmd?: string | Buffer, encoding?: BufferEncoding): Promise<void> {
+        return new Promise((resolve) => {
+            if (encoding) {
+                this._client.end(cmd, encoding, () => {
+                    resolve();
+                });
+            }
+            else {
+                this._client.end(cmd, () => {
+                    resolve();
+                });
+            }
+        });
+    }
+
+    /**
+     * --- 获取返回值 ---
+     * @param tryCount 如果无知重试次数，1 次为 10 毫秒 ---
+     */
+    public async getContent(tryCount: number = 10): Promise<Buffer> {
+        let nowCount: number = 0;
+        let data: Buffer = Buffer.from('');
+        while (true) {
+            const r: Buffer | null = this._client.read();
+            if (r !== null) {
+                data = Buffer.concat([data, r], data.byteLength + r.byteLength);
+                nowCount = 0;
+            }
+            else {
+                ++nowCount;
+                if (nowCount === tryCount) {
+                    break;
+                }
+                await lCore.sleep(10);
+            }
+        }
+        return data;
+    }
+
+    /**
+     * --- 获取响应读取流对象 ---
+     */
+    public getStream(): ssh2.ClientChannel {
+        return this._client;
+    }
+
+}

package/lib/ssh.js

@@ -0,0 +1,171 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connection = void 0;
+exports.get = get;
+const ssh2 = __importStar(require("ssh2"));
+const shell = __importStar(require("./ssh/shell"));
+const sftp = __importStar(require("./ssh/sftp"));
+class Connection {
+    constructor() {
+        this._client = new ssh2.Client();
+    }
+    connect(opt) {
+        return new Promise((resolve) => {
+            if (!opt.mproxy) {
+                this._client.on('error', function () {
+                    resolve(false);
+                }).on('ready', () => {
+                    resolve(true);
+                }).connect(opt);
+                return;
+            }
+            this._mclient = new ssh2.Client();
+            const old = {
+                'host': opt.host,
+                'port': opt.port,
+                'username': opt.username,
+                'password': opt.password,
+                'privateKey': opt.privateKey
+            };
+            opt.host = opt.mproxy.host;
+            opt.port = opt.mproxy.port;
+            opt.username = opt.mproxy.username;
+            opt.password = opt.mproxy.password;
+            if (opt.privateKey) {
+                delete opt.privateKey;
+            }
+            this._mclient.on('error', function () {
+                resolve(false);
+            }).on('ready', () => {
+                if (!old.host || !old.port || !this._mclient) {
+                    resolve(false);
+                    return;
+                }
+                this._mclient.forwardOut('0.0.0.0', 12345, old.host, old.port, (err, stream) => {
+                    if (err) {
+                        this._mclient?.end();
+                        resolve(false);
+                        return;
+                    }
+                    this._client.on('error', () => {
+                        this._mclient?.end();
+                        resolve(false);
+                    }).on('ready', () => {
+                        resolve(true);
+                    }).on('close', () => {
+                        this._mclient?.end();
+                    }).connect({
+                        'sock': stream,
+                        'username': old.username,
+                        'password': old.password,
+                        'privateKey': old.privateKey
+                    });
+                });
+            }).connect(opt);
+        });
+    }
+    disconnect() {
+        this._client.end();
+    }
+    exec(command) {
+        return new Promise((resolve) => {
+            this._client.exec(command, function (err, channel) {
+                if (err ?? !channel) {
+                    resolve(false);
+                    return;
+                }
+                let data = Buffer.from('');
+                channel.on('close', () => {
+                    resolve(data);
+                }).on('data', function (chunk) {
+                    data = Buffer.concat([data, chunk], data.length + chunk.length);
+                }).stderr.on('data', function (chunk) {
+                    data = Buffer.concat([data, chunk], data.length + chunk.length);
+                });
+            });
+        });
+    }
+    getShell() {
+        return new Promise((resolve) => {
+            this._client.shell(function (err, channel) {
+                if (err ?? !channel) {
+                    resolve(null);
+                    return;
+                }
+                resolve(new shell.Connection(channel));
+            });
+        });
+    }
+    getSftp() {
+        return new Promise((resolve) => {
+            this._client.sftp((err, ssftp) => {
+                if (err ?? !ssftp) {
+                    resolve(null);
+                    return;
+                }
+                (async () => {
+                    const pwdb = await this.exec('pwd');
+                    let pwd = '/';
+                    if (pwdb) {
+                        pwd = pwdb.toString().trim();
+                        if (!pwd.endsWith('/')) {
+                            pwd = pwd + '/';
+                        }
+                    }
+                    resolve(new sftp.Connection(ssftp, pwd));
+                })().catch(function () {
+                    resolve(null);
+                });
+            });
+        });
+    }
+    getStream() {
+        return new Promise((resolve) => {
+            this._client.shell(function (err, stream) {
+                if (err) {
+                    resolve(null);
+                }
+                resolve(stream);
+            });
+        });
+    }
+}
+exports.Connection = Connection;
+async function get(opt) {
+    const conn = new Connection();
+    const rtn = await conn.connect(opt);
+    return rtn ? conn : null;
+}

package/lib/ssh.ts

@@ -0,0 +1,191 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-6-8 21:34:35
+ * Last: 2020-04-06 21:22:46, 2022-09-12 00:19:05, 2024-3-4 14:46:11
+ */
+
+// --- 第三方 ---
+import * as ssh2 from 'ssh2';
+// --- 自己 ---
+import * as shell from './ssh/shell';
+import * as sftp from './ssh/sftp';
+
+interface IExtOptions {
+    'mproxy'?: {
+        'host': string;
+        'port': number;
+        'username': string;
+        'password': string;
+    };
+}
+
+/** 主连接对象 */
+export class Connection {
+
+    /** --- SSH 对象 --- */
+    private readonly _client: ssh2.Client;
+
+    /** --- 中转服务器 --- */
+    private _mclient?: ssh2.Client;
+
+    public constructor() {
+        this._client = new ssh2.Client();
+    }
+
+    /**
+     * --- 发起连接 ---
+     * @param opt 选项
+     */
+    public connect(opt: ssh2.ConnectConfig & IExtOptions): Promise<boolean> {
+        return new Promise((resolve) => {
+            if (!opt.mproxy) {
+                this._client.on('error', function() {
+                    resolve(false);
+                }).on('ready', () => {
+                    resolve(true);
+                }).connect(opt);
+                return;
+            }
+            this._mclient = new ssh2.Client();
+            const old = {
+                'host': opt.host,
+                'port': opt.port,
+                'username': opt.username,
+                'password': opt.password,
+                'privateKey': opt.privateKey
+            };
+            opt.host = opt.mproxy.host;
+            opt.port = opt.mproxy.port;
+            opt.username = opt.mproxy.username;
+            opt.password = opt.mproxy.password;
+            if (opt.privateKey) {
+                delete opt.privateKey;
+            }
+            this._mclient.on('error', function() {
+                resolve(false);
+            }).on('ready', () => {
+                if (!old.host || !old.port || !this._mclient) {
+                    resolve(false);
+                    return;
+                }
+                this._mclient.forwardOut('0.0.0.0', 12345, old.host, old.port, (err, stream) => {
+                    if (err) {
+                        this._mclient?.end();
+                        resolve(false);
+                        return;
+                    }
+                    this._client.on('error', () => {
+                        this._mclient?.end();
+                        resolve(false);
+                    }).on('ready', () => {
+                        resolve(true);
+                    }).on('close', () => {
+                        this._mclient?.end();
+                    }).connect({
+                        'sock': stream,
+                        'username': old.username,
+                        'password': old.password,
+                        'privateKey': old.privateKey
+                    });
+                });
+            }).connect(opt);
+        });
+    }
+
+    /**
+     * --- 断开此连接 socket ---
+     */
+    public disconnect(): void {
+        this._client.end();
+    }
+
+    /**
+     * --- 执行一个命令并获取返回值，请不要在此执行无尽命令，否则获取不到返回值 ---
+     * @param command 命令内容
+     */
+    public exec(command: string): Promise<Buffer | false> {
+        return new Promise((resolve) => {
+            this._client.exec(command, function(err?: Error, channel?: ssh2.ClientChannel): void {
+                if (err ?? !channel) {
+                    resolve(false);
+                    return;
+                }
+                let data = Buffer.from('');
+                channel.on('close', () => {
+                    resolve(data);
+                }).on('data', function(chunk: Buffer) {
+                    data = Buffer.concat([data, chunk], data.length + chunk.length);
+                }).stderr.on('data', function(chunk: Buffer) {
+                    data = Buffer.concat([data, chunk], data.length + chunk.length);
+                });
+            });
+        });
+    }
+
+    /**
+     * --- 获取 Shell 执行对象 ---
+     */
+    public getShell(): Promise<shell.Connection | null> {
+        return new Promise((resolve) => {
+            this._client.shell(function(err, channel) {
+                if (err ?? !channel) {
+                    resolve(null);
+                    return;
+                }
+                resolve(new shell.Connection(channel));
+            });
+        });
+    }
+
+    /**
+     * --- 获取 Sftp 执行对象 ---
+     */
+    public getSftp(): Promise<sftp.Connection | null> {
+        return new Promise((resolve) => {
+            this._client.sftp((err, ssftp) => {
+                if (err ?? !ssftp) {
+                    resolve(null);
+                    return;
+                }
+                (async () => {
+                    const pwdb = await this.exec('pwd');
+                    let pwd = '/';
+                    if (pwdb) {
+                        pwd = pwdb.toString().trim();
+                        if (!pwd.endsWith('/')) {
+                            pwd = pwd + '/';
+                        }
+                    }
+                    resolve(new sftp.Connection(ssftp, pwd));
+                })().catch(function() {
+                    resolve(null);
+                });
+            });
+        });
+    }
+
+    /**
+     * --- 直接获取原生 shell stream 对象 ---
+     */
+    public getStream(): Promise<ssh2.ClientChannel | null> {
+        return new Promise((resolve) => {
+            this._client.shell(function(err, stream) {
+                if (err) {
+                    resolve(null);
+                }
+                resolve(stream);
+            });
+        });
+    }
+
+}
+
+/**
+ * --- 创建一个 SSH 连接 ---
+ * @param opt 选项
+ */
+export async function get(opt: ssh2.ConnectConfig & IExtOptions): Promise<Connection | null> {
+    const conn = new Connection();
+    const rtn = await conn.connect(opt);
+    return rtn ? conn : null;
+}