2. 技術

WSLとSSHを活用したリモート開発環境の構築と設定方法

2024.06.30
  1. はじめに – SSHとは何か、なぜ重要なのか

SSHとは「Secure Shell」の略で、安全にリモートコンピュータに接続するためのプロトコルです。簡単に言えば、インターネットを通じて別のコンピュータを操作するための「鍵」のようなものです。

なぜSSHが重要なのでしょうか？

  • セキュリティ：通信が暗号化されるため、情報が盗まれる心配が少ない
  • リモート作業：自宅から会社のサーバーにアクセスするなど、場所を問わず作業できる
  • 自動化：スクリプトを使って定期的なタスクを自動実行できる
  1. SSHの基本 – コマンドラインでの接続方法

SSHを使ってリモートサーバーに接続する最も基本的な方法は、コマンドラインを使うことです。

Windows 10以降では、OpenSSHクライアントが標準で搭載されています。これにより、LinuxやmacOSと同じようにSSH接続が可能になりました。

基本的な接続コマンドは以下の通りです：

ssh ユーザー名@サーバーのIPアドレス

例えば、ユーザー名が「john」で、接続先のサーバーIPが「192.168.1.100」の場合：

john@192.168.1.100

このコマンドを入力すると、パスワードを要求されます。正しいパスワードを入力すると、リモートサーバーに接続されます。

しかし、パスワード認証には問題があります：

  • パスワードが盗まれるリスクがある
  • 接続のたびにパスワードを入力する必要がある

そこで、より安全で便利な「公開鍵認証」を使用することをお勧めします。

公開鍵認証の設定手順：

  1. ローカルマシンで鍵ペア（公開鍵と秘密鍵）を生成
  2. 公開鍵をリモートサーバーにコピー
  3. 秘密鍵を使って接続

鍵ペアの生成コマンド：

ssh-keygen -t rsa -b 4096

このコマンドを実行すると、鍵の保存場所とパスフレーズを聞かれます。デフォルトの保存場所（通常はC:\Users\ユーザー名\.ssh\）でよければそのままEnterを押します。パスフレーズは任意ですが、設定することをお勧めします。

公開鍵をサーバーにコピーするコマンド：

ssh-copy-id ユーザー名@サーバーのIPアドレス

これで基本的な設定は完了です。次に、秘密鍵を使って接続します：

ssh -i C:\Users\ユーザー名\.ssh\id_rsa ユーザー名@サーバーのIPアドレス

この方法で接続すると、パスワードの入力は不要になります（パスフレーズを設定した場合は、初回接続時にパスフレーズの入力が必要です）。

ここまでで、SSHの基本的な概念と使用方法を説明しました。次のセクションでは、SSHの設定ファイル（config）の利用について説明します。これにより、接続がさらに便利になります。

  1. SSHの設定ファイル（config）の利用

SSHの設定ファイル（config）を使用すると、接続をより簡単かつ効率的に行えるようになります。この設定ファイルは、複数のサーバーへの接続情報を一元管理し、短いコマンドで接続できるようにします。

configファイルの場所:
Windows: C:\Users\<ユーザー名>.ssh\config
macOS/Linux: ~/.ssh/config

基本的な設定例:

Host myserver
    HostName 192.168.1.100
    User john
    IdentityFile ~/.ssh/id_rsa
    Port 22

この設定により、ssh myserver というコマンドだけで接続できるようになります。

configファイルの主なメリット:

  1. 簡潔な接続コマンド:
    長いIPアドレスやユーザー名を覚える必要がなくなります。
  2. 複数サーバーの管理:
    異なるサーバーごとに設定を分けて管理できます。
  3. 再利用可能な設定:
    一度設定すれば、どのターミナルからでも同じ設定で接続できます。
  4. 詳細な設定:
    プロキシの使用やポートフォワーディングなど、高度な設定も可能です。

より詳細な設定例:

# サーバー1の設定
Host server1
    HostName 192.168.1.101
    User user1
    IdentityFile ~/.ssh/id_rsa_server1
    Port 2222

# サーバー2の設定
Host server2
    HostName example.com
    User user2
    IdentityFile ~/.ssh/id_rsa_server2
    ProxyJump jumphost

# デフォルト設定
Host *
    ForwardAgent yes
    ServerAliveInterval 60

この設定では、ssh server1 や ssh server2 で簡単に接続できます。また、すべての接続に対して ForwardAgent と ServerAliveInterval が適用されます。

  1. Visual Studio Code (VS Code) とSSH

VS CodeはMicrosoftが開発した強力なコードエディタで、Remote – SSH拡張機能を使用することで、リモートサーバー上のファイルを直接編集できます。

VS Codeでリモート開発を始める手順:

  1. VS Codeのインストール:
    公式サイト (https://code.visualstudio.com/) からダウンロードしてインストールします。
  2. Remote – SSH拡張機能のインストール:
  • VS Codeを開き、左側の拡張機能アイコンをクリック
  • 検索バーに “Remote – SSH” と入力
  • Microsoftの公式拡張機能をインストール
  1. SSHの設定:
    前述のconfigファイルを使用します。VS Codeは自動的にこの設定を読み込みます。
  2. リモートサーバーへの接続:
  • F1キーを押すか、Ctrl+Shift+Pでコマンドパレットを開く
  • “Remote-SSH: Connect to Host…” と入力
  • configファイルに設定したホスト名を選択
  1. リモートファイルの編集:
    接続後、VS Code上でリモートサーバーのファイルを直接開いて編集できます。

VS CodeでのSSH利用のメリット:

  • グラフィカルなファイル操作: ファイルエクスプローラーを使って視覚的にファイルを管理できます。
  • 統合ターミナル: VS Code内でリモートサーバーのターミナルを使用できます。
  • 拡張機能の活用: ほとんどのVS Code拡張機能がリモート環境でも使用可能です。
  • デバッグ機能: リモートでのデバッグが容易になります。

注意点:
初回接続時、VS CodeはリモートサーバーにVS Codeサーバーファイルをインストールします。これは自動的に行われますが、インターネット接続が必要です。

  1. WSLとDockerの活用

WSL（Windows Subsystem for Linux）とDockerを組み合わせることで、Windows上でより柔軟な開発環境を構築できます。これらのツールを使うことで、LinuxベースのアプリケーションやコンテナをWindowsで直接実行できるようになります。

WSLとは：
WSLは、Windows上でLinuxのコマンドラインツールやアプリケーションを直接実行できるようにする機能です。これにより、WindowsとLinuxの長所を組み合わせた開発環境を作ることができます。

Dockerとは：
Dockerは、アプリケーションとその依存関係を「コンテナ」と呼ばれる軽量な実行環境にパッケージ化するツールです。これにより、異なる環境間でアプリケーションを簡単に移動・実行できるようになります。

WSLとDockerを組み合わせる利点：

  1. クロスプラットフォーム開発：
    Windows上でLinuxベースのツールやアプリケーションを使用できます。
  2. 環境の一貫性：
    Dockerコンテナを使用することで、開発環境と本番環境の差異を最小限に抑えられます。
  3. リソース効率：
    WSL2はWindows上で軽量なLinux VMを実行するため、従来の仮想マシンよりも効率的です。
  4. VS Codeとの連携：
    VS CodeのRemote – WSL拡張機能を使用すると、WSL内のファイルを直接編集できます。

設定手順：

  1. WSLのインストール：
  • Windowsの「設定」→「アプリ」→「プログラムと機能」→「Windowsの機能の有効化または無効化」を開く
  • 「Windows Subsystem for Linux」にチェックを入れる
  • 再起動後、Microsoft StoreからUbuntuなどのLinuxディストリビューションをインストール
  1. Docker Desktopのインストール：
  • Docker公式サイトからDocker Desktopをダウンロードしてインストール
  • インストール後、設定からWSL2との統合を有効にする
  1. VS Code拡張機能のインストール：
  • Remote – WSL拡張機能をインストール
  • Docker拡張機能をインストール
  1. WSL上でのDocker使用：
  • WSLのターミナルを開き、docker --versionコマンドでDockerが正しくインストールされていることを確認
  • 必要に応じてsudo service docker startでDockerデーモンを起動

使用例：

  1. WSLでのLinuxコマンド実行：
    WSLのターミナルを開いて、Linuxコマンドを直接実行できます。例：
   ls -la
   grep "pattern" file.txt
  1. DockerコンテナのWSL上での実行：
    WSLターミナルで以下のようにDockerコマンドを実行できます。
   docker run -it ubuntu bash

これにより、Ubuntu OSのコンテナが起動し、そのbashシェルに接続されます。

  1. VS CodeでのWSL開発：
  • VS Codeを開き、左下の緑色のアイコンをクリック
  • 「Remote-WSL: New Window」を選択
  • WSL環境内のファイルを直接編集できるようになります
  1. DockerコンテナのVS Codeでの使用：
  • VS Codeの左側のDockerアイコンをクリック
  • コンテナ一覧から対象のコンテナを右クリック
  • 「Attach Visual Studio Code」を選択してコンテナ内の環境でVS Codeを使用

これらの機能を組み合わせることで、Windows上でLinuxやDocker、そしてVS Codeを seamlessに使用できる強力な開発環境を構築できます。

  1. 高度な使用例とトラブルシューティング

ここでは、SSHの高度な使用例といくつかの一般的な問題の解決方法を紹介します。

A. 高度な使用例

  1. SSHトンネリング（ポートフォワーディング）:
    SSHトンネリングを使用すると、セキュアな通信チャネルを介してポートを転送できます。 ローカルポートフォワーディングの例:
   ssh -L 8080:localhost:80 user@remote_host

この例では、ローカルの8080ポートへのアクセスがリモートホストの80ポートに転送されます。

  1. SSHを使用したファイル転送:
    scpコマンドを使用して、セキュアにファイルを転送できます。 ローカルからリモートへのファイル転送:
   scp local_file.txt user@remote_host:/path/to/destination/

リモートからローカルへのファイル転送:

   scp user@remote_host:/path/to/remote_file.txt /local/path/
  1. SSHを使用したGitリポジトリのクローン:
    GitHubなどのリモートリポジトリからSSHを使用してクローンする例:
   git clone git@github.com:username/repository.git
  1. SSHエージェントフォワーディング:
    複数のサーバー間でSSH認証を引き継ぐ場合に便利です。
   ssh -A user@remote_host

B. トラブルシューティング

  1. 接続エラー:
    問題: “Connection refused” エラーが表示される
    解決策:
  • サーバーのSSHサービスが実行中か確認
  • ファイアウォールの設定を確認
  • 正しいIPアドレスとポート番号を使用しているか確認
  1. 認証エラー:
    問題: “Permission denied (publickey)” エラーが表示される
    解決策:
  • 公開鍵が正しくサーバーに登録されているか確認
  • 秘密鍵のパーミッションが適切か確認 (Linuxの場合、chmod 600 ~/.ssh/id_rsa)
  • -v オプションを使用して詳細なデバッグ情報を確認 (ssh -v user@remote_host)
  1. 遅い接続:
    問題: SSHの接続が極端に遅い
    解決策:
  • DNS逆引きを無効にする (ssh -o "UseDNS no" user@remote_host)
  • 圧縮を有効にする (ssh -C user@remote_host)
  • クライアント側のコンフィグファイルに ServerAliveInterval 60 を追加
  1. WSLでのDocker接続エラー:
    問題: WSLからDockerデーモンに接続できない
    解決策:
  • Docker Desktopの設定でWSL統合が有効になっているか確認
  • WSLを再起動 (wsl --shutdown を実行後、WSLを再度開く)
  1. VS CodeのRemote-SSH接続エラー:
    問題: VS CodeがリモートサーバーへのSSH接続に失敗する
    解決策:
  • SSHの設定ファイル（config）が正しく設定されているか確認
  • VS Codeの出力パネルでSSH: Remoteログを確認し、エラーの詳細を把握
  • リモートサーバーのSSHサービスが適切に設定されているか確認
  1. Dockerコンテナ内でのSSH接続:
    問題: Dockerコンテナ内からSSH接続ができない
    解決策:
  • コンテナ内にSSHクライアントをインストール
  • ホストのSSH鍵をコンテナにマウント
  • Dockerfileでの設定例:
    FROM ubuntu:20.04 RUN apt-get update && apt-get install -y openssh-client COPY ~/.ssh/id_rsa /root/.ssh/id_rsa RUN chmod 600 /root/.ssh/id_rsa

これらの高度な使用例とトラブルシューティングのヒントは、SSHを使用する上でよく遭遇する課題に対処するのに役立ちます。次のセクションでは、これまでの内容をまとめ、SSHスキルを向上させるための次のステップについて説明します。

  1. まとめと次のステップ

これまでの内容を振り返り、SSHスキルをさらに向上させるための方向性を提示します。

まとめ：

  1. SSHの基本：
  • SSHはリモートサーバーに安全に接続するためのプロトコル
  • 公開鍵認証を使用することで、セキュリティと利便性が向上
  1. SSHの設定ファイル（config）：
  • 複数のサーバー設定を一元管理
  • 接続コマンドを簡略化
  1. Visual Studio Codeとの連携：
  • Remote – SSH拡張機能を使用してリモート開発が可能
  • グラフィカルなインターフェースでリモートファイルを編集
  1. WSLとDockerの活用：
  • Windows上でLinux環境とコンテナを利用
  • 開発環境の柔軟性と一貫性を向上
  1. 高度な使用例：
  • SSHトンネリング
  • ファイル転送（scp）
  • Gitリポジトリのクローン
  • SSHエージェントフォワーディング
  1. トラブルシューティング：
  • 接続エラー、認証エラー、パフォーマンス問題への対処法

次のステップ：

  1. セキュリティの強化：
  • 強力なパスフレーズの使用
  • 定期的な鍵の更新
  • 多要素認証の導入
  1. 自動化とスクリプティング：
  • SSHを使用したバッチ処理の自動化
  • Ansibleなどの構成管理ツールの学習
  1. 高度なネットワーク設定：
  • VPNとSSHの組み合わせ
  • リバースSSHトンネルの活用
  1. クラウドサービスとの連携：
  • AWS、GCP、AzureなどのクラウドプラットフォームでのSSH利用
  • クラウド特有のSSH鍵管理の学習
  1. SSHプロトコルの深い理解：
  • SSHの内部動作メカニズムの学習
  • 暗号化アルゴリズムの理解
  1. セキュリティ監査：
  • SSHログの分析と監視
  • 侵入検知システム（IDS）との連携
  1. コンテナオーケストレーション：
  • KubernetesなどのツールでのSSH活用
  • コンテナ化されたアプリケーションのリモートデバッグ
  1. CI/CDパイプラインでのSSH活用：
  • 自動デプロイメントプロセスへのSSHの統合
  • セキュアな継続的インテグレーション/デリバリの実現
  1. モバイルデバイスからのSSH利用：
  • スマートフォンやタブレットからのリモートサーバー管理
  • モバイル特有のセキュリティ考慮事項の理解
  1. SSHの最新動向のフォロー：
    • 新しいSSHプロトコルバージョンや機能の学習
    • セキュリティ脆弱性と対策の最新情報の把握

これらの次のステップは、SSHスキルを更に深め、より高度な使用シナリオに対応するための道筡を提供します。個人の興味や職業上のニーズに合わせて、これらの分野から重点的に学習を進めることをお勧めします。

SSHは常に進化し続ける技術であり、セキュリティと効率性の両面で重要な役割を果たしています。継続的な学習と実践を通じて、より安全で効率的なリモート管理やデプロイメントプロセスを実現することができます。

日本の制限されたレンタルサーバーでは？

WSLとSSHは、Visual Studio Codeのリモートエクスプローラで簡単に切り替えられます。たとえWSLのディストリビューションが停止していても、接続を試みることで、自動的にディストリビューションが起動します。

しかし、SSH機能が制限されているサーバーでは、これがうまく動作しないことがあります。そんな時に使える方法があります。この方法は、Stable Diffusionの画像出力先を変更する際にも使用しましたが、リモートストレージを自分のパソコンにマウントするというものです。この方法を使えば、VS Codeでリモートディレクトリのファイルやフォルダを確認したり、編集したりすることが可能になります。

具体的には、ロリポップのストレージを、RcloneとWinSFPというツールを使ってパソコンにマウントします。

Rcloneを便利に使う（stable diffusionの画像出力先変更）
https://minokamo.tokyo/2024/06/16/7328


© Minokamo Citizens Blog All rights reserved.