LoginSignup
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@oharu121(O Haru)

SSH2でJump Server経由のRemoteトンネルを作成

Last updated at Posted at 2025-04-26

はじめに

Jumpサーバーを経由してRemoteサーバーに接続し、そこからコマンド実行やファイル操作、Kubernetes設定を行う業務が増えてきました。

しかし、実運用では下記のような課題があります：

  • 接続が不安定（途中で切れる）
  • バッチ処理の途中で止まると復旧が面倒
  • ファイルや設定の環境差異でミスが発生

そこで私は、TypeScript + SSH2ライブラリを使って、
Jump経由のRemote接続をラップした安定化＆自動復活フレームワークを作りました。

🖼️ システム構成図

image.png

Remoteクラス：リモート通信の司令塔

リモートへのSSH接続、コマンド実行、SFTP転送など、すべてのリモート操作を1クラスに集約しています。

📦 主な責務

  • Jumpサーバー接続・ポートフォワーディング
  • リモートサーバー接続・コマンド実行
  • ファイル送受信（SFTP）
  • 公開鍵の自動生成・登録
  • シェルストリームの操作

💡 ハイライト

  • initJumpTunnel()：Jumpサーバーと接続＋鍵確認
  • fowardToRemote()：RemoteサーバーへSSHポートフォワーディング
  • uploadFileToRemote()：ローカル→Remoteへのファイル転送
  • execRemote(cmd)：リモートで任意コマンド実行
  • openShell()：インタラクティブシェルを開く
  • waitForString(stream, text)：シェル出力から特定文字を待機

🛠 安定化への工夫

  • SSH秘密鍵がなければ自動生成＋package.json更新
  • 再接続時はセッションを自動復旧
  • SessionDB により、prod/stg などの環境切替も安全に抽象化

1. クラス定義

Remote.ts
class Remote {
  private jumpTunnel?: Client;
  private remoteTunnel?: Client;
  private jumpSFTP?: SFTP;
  private remoteSFTP?: SFTP;
}

export default new Remote();

📌 ポイント

  • jumpTunnel: JumpサーバーとのSSHクライアントインスタンス
  • remoteTunnel: リモートサーバーへのSSHクライアントインスタンス
  • jumpSFTP, remoteSFTP: それぞれのSFTP用オブジェクト
  • Remoteクラスを インスタンス化して即エクスポート
    →どこでも import Remote from './Remote' で使える！

2. 接続情報取得 (環境に応じて切り替え)

  • Pomeriumポート番号取得
Remote.ts
private pomeriumPort(): number {
  const env = SessionDB.getEnv();
  return env === "prod" ? ports.POMERIUM_PORT_PROD : ports.POMERIUM_PORT_STG;
}
  • リモートホスト名取得
Remote.ts
private remoteHost(): string {
  const env = SessionDB.getEnv();
  return env === "prod" ? hosts.REMOTE_HOST_PROD : hosts.REMOTE_HOST_STG;
}
  • SSHユーザー名取得
Remote.ts
private remoteUsername(): string {
  const env = SessionDB.getEnv();
  return env === "prod" ? credentials.SSH_USERNAME_PROD : credentials.SSH_USERNAME_STG;
}
  • namespace取得
Remote.ts
public static namespace(): string {
  const env = SessionDB.getEnv();
  switch (env) {
    case "stg":
      return names.NAMESPACE_STG;
    case "prod":
      return names.NAMESPACE_PROD;
    default:
      return "";
  }
}
  • SSHプロファイル取得
Remote.ts
public static getSSHProfile(env: Env): ConnectConfig {
  const env = SessionDB.getEnv();
  switch (env) {
    case "prod":
      return {
        host: "127.0.0.1",
        port: ports.POMERIUM_PORT_PROD,
        username: credentials.SSH_USERNAME_PROD,
        password: credentials.JUMP_SERVER_PASSWORD_PROD,
        readyTimeout: 60000,
      };
    default:
      return {
        host: "127.0.0.1",
        port: ports.POMERIUM_PORT_STG,
        username: credentials.SSH_USERNAME_STG,
        password: credentials.JUMP_SERVER_PASSWORD_STG,
        readyTimeout: 60000,
      };
  }
}

3. トンネル初期化

  • Jumpトンネル初期化
Remote.ts
private async initJumpTunnel() {
  await this.connectJumpServer();
  await this.checkPublicKey();
}
  • Remoteトンネル初期化
Remote.ts
private async initRemoteTunnel() {
  await this.fowardToRemote();
  await Robin.start();
}

📌 ポイント

  • Jumpサーバー接続と公開鍵登録チェックを実施
  • Jumpサーバー経由でリモート接続＋Robin起動

4. 開鍵認証セットアップ

Remote.ts
private async checkPublicKey() {
  if (!packageJson.pubKeyEnabled) {
    await this.getPrivateKey();
    await this.checkAuthorizedKeys();
  }
}

📌 ポイント

  • まだ鍵認証が有効でないなら、秘密鍵作成＋公開鍵登録をする。

5. Jumpサーバー接続処理

Remote.ts
public async connectJumpServer(): Promise<void> {
  await CommandLine.initPomerium();
  return new Promise((resolve, reject) => {
    const jumpTunnel = new Client();
    jumpTunnel
      .on("ready", () => {
        Logger.success(`Connected to jump server on port ${this.pomeriumPort()}`);
        this.jumpTunnel = jumpTunnel;
        resolve();
      })
      .on("error", (err) => {
        Logger.error(`Failed to connect to port ${this.pomeriumPort()} locally.`);
        reject(err);
      })
      .connect(this.sshProfile());
  });
}

📌 ポイント

  • Pomeriumポートに接続 → 成功したらjumpTunnel保存

6. リモートサーバーへのポートフォワード接続

Remote.ts
public async fowardToRemote(): Promise<void> {
  if (!this.jumpTunnel) await this.initJumpTunnel();
  return new Promise((resolve, reject) => {
    if (!this.jumpTunnel) throw new Error();
    this.jumpTunnel.forwardOut(
      "127.0.0.1",
      8000,
      this.remoteHost(),
      22,
      (err, stream) => {
        if (err) reject(err);
        const remoteTunnel = new Client();
        remoteTunnel
          .on("ready", () => {
            Logger.success(`forwarded out to ${this.remoteHost()}`);
            this.remoteTunnel = remoteTunnel;
            resolve();
          })
          .on("error", (err) => reject(err))
          .connect({
            sock: stream,
            ...this.sshProfile(),
          } as ConnectConfig);
      }
    );
  });
}

📌 ポイント

  • Jumpサーバーを中継してリモートサーバー22番ポートにforwardOutする！

7. SFTP初期化

  • Jump用
Remote.ts
private async initJumpSFTP() {
  if (!this.jumpTunnel) await this.initJumpTunnel();
  if (!this.jumpTunnel) throw new Error();
  this.jumpSFTP = new SFTP(this.jumpTunnel);
}
  • Remote用
Remote.ts
private async initRemoteSFTP() {
  if (!this.remoteTunnel) await this.initRemoteTunnel();
  if (!this.remoteTunnel) throw new Error();
  this.remoteSFTP = new SFTP(this.remoteTunnel);
}

📌 ポイント

  • SSH接続セッションを渡して、SFTP通信できるように初期化

8. ファイルアップロード

public async uploadFileToRemote(fileName: string): Promise<void> {
  if (!this.remoteSFTP) await this.initRemoteSFTP();
  const localPath = `${paths.LOCAL_File_DIR}/${fileName}`;
  const remotePath = `${paths.REMOTE_File_DIR}/${fileName}`;
  await this.remoteSFTP?.fastput(localPath, remotePath);
}

📌 ポイント

: ローカルからリモートへファイル転送します。

9. SSH秘密鍵の取得・生成 getPrivateKey

Remote.ts
public static async getPrivateKey(): Promise<string | undefined> {
  let privateKey;
  let isPrivateKeyExisted;
  const sshDir = `C:\\Users\\${environment.OS_USERNAME}\\.ssh`;

  if (!fs.existsSync(sshDir)) {
    Logger.warning(`.ssh folder does not exist for user ${environment.OS_USERNAME}`);
    Logger.task(`Creating ${sshDir}...`);
    fs.mkdirSync(sshDir, { recursive: true });
  }

  try {
    privateKey = fs.readFileSync(`${sshDir}\\id_rsa`, "utf8");
    Logger.success("found private key locally.");
    isPrivateKeyExisted = true;
  } catch (err) {
    Logger.warning("Private key not found.");
    Logger.task(`Generating new SSH key pair for user ${environment.OS_USERNAME}...`);
    isPrivateKeyExisted = false;
  }

  if (!isPrivateKeyExisted) {
    packageJson.pubKeyEnabled = false;
    const updatedPackageJson = JSON.stringify(packageJson, null, 2);
    fs.writeFileSync("./package.json", updatedPackageJson, "utf-8");

    try {
      await exec(
        `ssh-keygen -t rsa -b 4096 -f C:\\Users\\${environment.OS_USERNAME}\\.ssh\\id_rsa -q -N ""`
      );
      Logger.success("SSH key pair generated successfully.");
    } catch (error) {
      Logger.error(`exec error: ${error}`);
    }
  }

  return privateKey;
}

📌 ポイント

  • .sshディレクトリがなければ作成
  • 秘密鍵がなければ ssh-keygen で作成
  • 作った場合は package.jsonを更新してフラグを保存

10. リモートコマンド実行

  • jump用
Remote.ts
public async execJump(cmd: string, debug: boolean = false): Promise<string> {
  if (!this.jumpTunnel) await this.initJumpTunnel();
  
  return new Promise((resolve, reject) => {
    if (!this.jumpTunnel) throw new Error();
    this.jumpTunnel.exec(cmd, (err, stream) => {
      if (err) reject(err);

      let data = "";
      let meta = "";
      stream.on("data", (chunk: Buffer) => (data += chunk.toString()));
      stream.stderr.on("data", (chunk: Buffer) => (meta += chunk.toString()));
      stream.on("end", () => {
        if (debug) console.log(meta);
        resolve(data);
      });
    });
  });
}

📌 ポイント

  • ジャンプサーバーでコマンドを実行して、その結果 (stdout) を返す。
  • stderrはデバッグオプションで表示できる。
  • remote用
Remote.ts
public async execRemote(cmd: string, debug: boolean = false): Promise<string> {
  if (!this.remoteTunnel) await this.initRemoteTunnel();
  
  return new Promise((resolve, reject) => {
    if (!this.remoteTunnel) throw new Error();
    this.remoteTunnel.exec(cmd, (err, stream) => {
      if (err) reject(err);

      let data = "";
      let meta = "";
      stream.on("data", (chunk: Buffer) => (data += chunk.toString()));
      stream.stderr.on("data", (chunk: Buffer) => (meta += chunk.toString()));
      stream.on("end", () => {
        if (debug) console.log(meta);
        resolve(data);
      });
    });
  });
}

📌 ポイント

  • リモートサーバーでコマンドを実行して、その結果 (stdout) を返す。
  • stderrはデバッグオプションで表示できる。

11. シェルセッションを開く

Remote.ts
public openShell(): Promise<ClientChannel> {
  if (!this.remoteTunnel) await this.initRemoteTunnel();
  
  return new Promise((resolve, reject) => {
    if (!this.remoteTunnel) throw new Error();
    this.remoteTunnel.shell((err, stream) => {
      if (err) reject(err);
      else resolve(stream);
    });
  });
}

📌 ポイント

  • 対話式のシェルストリーム (ClientChannel) を開く。
  • ログイン後にコマンドを打てるようにするため。

12. ストリームから特定文字列を待つ

Remote.ts
public async waitForString(
  stream: ClientChannel,
  expectedString: string
): Promise<string> {
  return new Promise((resolve, reject) => {
    let data = "";
    stream
      .on("data", (chunk: Buffer) => {
        Logger.info(chunk.toString());
        data += chunk.toString();
        if (data.includes(expectedString)) {
          resolve(data);
        }
      })
      .stderr.on("data", (data: Buffer) => {
        reject(new Error(`STDERR: ${data}`));
      })
      .on("close", () => {
        reject(new Error("unexpected stream close"));
      });
  });
}

📌 ポイント

  • シェル通信中、特定のキーワードが現れるのを待つ。
  • 例えば「ログイン成功」の文字列を待つ用途など。

Robinクラス：Kubernetesの認証＆コンテキスト操作

Jump→Remote接続後に、kubectlを操作する前提で、Kubernetesの文脈も整えています。

📦 主な処理

  • 古いRobinコンテキスト削除
  • Cluster VIP/namespace/tenant に応じた新しい設定適用
  • robin loginとkubectl configを自動で実行

💡 利点

  • SessionDBの環境情報から自動切替
  • マニュアル操作ゼロでk8s環境にログイン・接続可能

1. クラス定義

Robin.ts
import Remote form "./Remote";
class Robin {}

export default new Robin();

📌 ポイント

  • 前述の Remote クラスをインポートして、その execRemote を使う

2. 接続情報取得 (環境に応じて切り替え)

  • Namespace取得
Robin.ts
private namespace(): string {
  const env = SessionDB.getEnv();
  switch(env){
    case"stg1":
      return names.NAMESPACE_STG1;
    case"prod":
      return names.NAMESPACE_PROD;
    default:
      return"";
  }
}
  • tenant取得
Robin.ts
private tenant(): string {
  const env = SessionDB.getEnv();
  switch (env) {
    case "stg":
      return names.TENANT_STG;
    case "prod":
      return names.TENANT_PROD;
  }
}
  • cluster vip取得
Robin.ts
private clusterVIP(): string {
  const env = SessionDB.getEnv();
  switch (env) {
    case "stg":
      return hosts.CLUSTER_VIP_STG;
    case "prod":
      return hosts.CLUSTER_VIP_PROD;
  }
}

3. コンテキスト編集

  • 古いRobinコンテキスト削除
Robin.ts
private async removeOldContext(): Promise<void> {
  await Remote.execRemote("rm -rf ~/.robin");
}

📌 ポイント

  • リモートサーバー上の~/.robinディレクトリを削除する。
  • 新しいRobinコンテキスト追加
Robin.ts
private async addNewContext(): Promise<void> {
  const cmd = [
    `robin client`,
    `add-context ${this.clusterVIP}`,
    `--port ${ports.ROBIN_PORT}`,
    `--event-port ${ports.ROBIN_PORT}`,
    `--file-port ${ports.ROBIN_PORT}`,
    `--set-current --product platform`,
  ].join("");

  await Remote.execRemote(cmd).then((result) => {
    if (typeof result === "string") Logger.info(result);
  });
}

📌 ポイント

  • Robinクライアントで新しいコンテキストを作成
  • Cluster VIPやポート番号を使って設定
  • 成功したらログ出力

4. ログイン

Robin.ts
private async login(): Promise<void> {
  const cmd = [
    `robin login ${credentials.ROBIN_USERNAME_STG}`,
    `--password ${credentials.ROBIN_PASSWORD_STG}`,
    `--tenant ${this.tenant}`,
  ].join("");

  const robinLoginResult = await Remote.execRemote(cmd);

  if (typeof robinLoginResult === "string") {
    if (robinLoginResult.includes("is logged into")) {
      Logger.success(`Logged into Robin with ${this.tenant}`);
      Logger.info(robinLoginResult);
    } else {
      Logger.error("user can't login to robin");
      Logger.info(robinLoginResult);
      process.exit(1);
    }
  }
}

📌 ポイント

  • robin loginコマンドを実行
  • 成功したらログ、失敗したらエラーログ＋プロセス終了

5. kubeconfigファイル保存

Robin.ts
private async saveKubeConfig(): Promise<void> {
  const cmd = [
    `mkdir -p ~/.kube`,
    `&&`,
    `robin k8s get-kube-config`,
    `--save-as-file`,
    `--dest-dir ~/.kube`,
  ].join("");

  await Remote.execRemote(cmd);
}

📌 ポイント

  • リモート上に.kubeフォルダを作成
  • Robinからk8s設定ファイルを保存

6. 現在のk8sコンテキストをセット

Robin.ts
private async setCurrentContext(): Promise<void> {
  const cmd = [
    `kubectl config`,
    `set-context`,
    `--current`,
    `--namespace=${this.namespace}`,
  ].join("");

  await Remote.execRemote(cmd).then((result) => {
    if (typeof result === "string") Logger.info(result);
  });
}

📌 ポイント

  • kubectl config set-contextで、今使うnamespaceを指定する。

SFTPクラス：安全なファイル送受信のラッパー

SSHトンネル上でのファイル操作をまとめています。

📦 機能

  • fastput()：ローカル → リモートへアップロード
  • fastget()：リモート → ローカルへダウンロード
  • appendFile()：ログや結果の追記書き込み
  • readDir()：リモートディレクトリ一覧取得

1. クラス定義

SFTP.ts
class SFTP {
  private tunnel: Client;
  private sftpTunnel?: SFTPWrapper;

📌 ポイント

  • tunnel：SSH接続しているクライアント
  • sftpTunnel：SFTP用セッション（未初期化なら接続する）

2. コンストラクタ

SFTP.ts
constructor(tunnel: Client) {
  this.tunnel = tunnel;
}

📌 ポイント

  • 外から渡されたSSHクライアント (tunnel) を内部に保持する

3. SFTPセッション初期化

SFTP.ts
private initSftp(): Promise<void> {
  return new Promise((resolve, reject) => {
    this.tunnel.sftp((err, sftp) => {
      if (err) reject(err);
      this.sftpTunnel = sftp;
      resolve();
    });
  });
}

📌 ポイント

  • SSHトンネル (tunnel) を使って新たにSFTPセッションを開始する
  • 失敗したらエラー

4. ファイルアップロード

SFTP.ts
public async fastput(localPath: string, remotePath: string): Promise<boolean> {
  if (!this.sftpTunnel) await this.initSftp();

  await this.createIfNotExisted(path.dirname(remotePath));
  return new Promise((resolve) => {
    if (!this.sftpTunnel) throw new Error();

    this.sftpTunnel.fastPut(localPath, remotePath, {}, (err) => {
      if (err) resolve(false);
      else resolve(true);
    });
  });
}

📌 ポイント

  • SFTPセッションがなければ初期化
  • 先にアップロード先のディレクトリが存在するか確認・作成
  • fastPutでローカルファイルをリモートにアップロード

5. ファイルダウンロード

SFTP.ts
public async fastget(localPath: string, remotePath: string): Promise<boolean> {
  if (!this.sftpTunnel) await this.initSftp();

  return new Promise((resolve) => {
    if (!this.sftpTunnel) throw new Error();

    this.sftpTunnel.fastGet(remotePath, localPath, (err) => {
      if (err) resolve(false);
      else resolve(true);
    });
  });
}

📌 ポイント

  • リモートのファイルをローカルにダウンロードする

6. ディレクトリ存在チェック

SFTP.ts
public async checkDir(remotePath: string): Promise<boolean> {
  if (!this.sftpTunnel) await this.initSftp();

  return new Promise((resolve) => {
    if (!this.sftpTunnel) throw new Error();

    this.sftpTunnel.stat(remotePath, (err) => {
      if (err) resolve(false);
      else resolve(true);
    });
  });
}

📌 ポイント

  • 指定されたパスがリモートに存在するかチェックする

7. ディレクトリ作成

SFTP.ts
public async makeDir(remotePath: string): Promise<boolean> {
  if (!this.sftpTunnel) await this.initSftp();

  return new Promise((resolve) => {
    if (!this.sftpTunnel) throw new Error();

    this.sftpTunnel.mkdir(remotePath, (err) => {
      if (err) {
        console.log(err);
        resolve(false);
      } else {
        resolve(true);
      }
    });
  });
}

📌 ポイント

  • 指定されたパスにリモートでディレクトリを作成する

8. ファイル追記

SFTP.ts
public async appendFile(remotePath: string, text: string): Promise<void> {
  if (!this.sftpTunnel) await this.initSftp();

  return new Promise((resolve, reject) => {
    if (!this.sftpTunnel) throw new Error();

    this.sftpTunnel.appendFile(remotePath, text, (err) => {
      if (err) reject(err);
      else resolve();
    });
  });
}

📌 ポイント

  • 指定ファイルにテキストを追記する（なければエラー）

9. ディレクトリ一覧取得

SFTP.ts
public async readDir(path: string): Promise<FileEntry[]> {
  if (!this.sftpTunnel) await this.initSftp();

  return new Promise((resolve, reject) => {
    if (!this.sftpTunnel) throw new Error();

    this.sftpTunnel.readdir(path, (err, list) => {
      if (err) reject(err);
      else resolve(list);
    });
  });
}

📌 ポイント

  • 指定パスのディレクトリの中身一覧を取得する

10. パス存在チェック＆作成

SFTP.ts
public async createIfNotExisted(pathName: string): Promise<void> {
  const isPathExisted = await this.checkDir(pathName);
  if (!isPathExisted) {
    Logger.warning(`Cannot found ${pathName} for user ${credentials.SSH_USERNAME_STG}`);
    Logger.task(`Trying to create ${pathName} for user ${credentials.SSH_USERNAME_STG}`);
    const pathCreated = await this.makeDir(pathName);

    if (!pathCreated) {
      Logger.error(`Failed to create folder`);
      return;
    }

    Logger.success(`Successfully created remote folder for user ${credentials.SSH_USERNAME_STG}`);
  }
}

📌 ポイント

  • パスがなければmkdirする
  • 成功・失敗ログを出す

まとめ

Jumpサーバーを経由したRemote操作には以下のような課題がありますが…

  • 毎回SSHコマンドを打つのが面倒
  • 環境差異でうっかり事故る
  • リモート処理中に接続が切れるとリカバリが難しい

➡ 今回の実装により、

  • 秘密鍵の自動生成・登録
  • SFTP・コマンド・k8sを一気通貫で自動化
  • 安定して再接続＆復旧可能

が可能になりました。

応用は次の記事をご参照ください！

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?