PHPのssh2://ストリームラッパーとは？使い方とコンテキストオプションを解説

はじめに

libssh2ライブラリは、暗号化された安全な通信経路を通じて、リモートマシン上のリソースへのアクセスを提供します。アクセスできる機能には、シェル操作、リモートコマンド実行（exec）、トンネリング、ファイル転送（SFTP）、SCPなどがあります。

PHPでは、これらのリソースに対応するストリームラッパーが用意されており、それぞれssh2.shell://、ssh2.exec://、ssh2.tunnel://、ssh2.sftp://、ssh2.scp://として利用できます。

なお、これらのラッパーはデフォルトでは有効になっていません。利用するには、PECLから提供されているSSH2拡張モジュールを別途インストールする必要があります。インストール後はphp.iniで拡張モジュールを有効にすることで、fopen()やfile_get_contents()などの標準的なファイルシステム関数からSSH接続を透過的に扱えるようになります。

基本的な使い方

各ラッパーは以下のような形式で記述します。URLスキームの後にユーザー名・パスワード・ホスト名・ポート番号を指定し、最後にパスやコマンドを続けます。

ssh2.shell://user:pass@example.com:22/xterm
ssh2.exec://user:pass@example.com:22/usr/local/bin/somecmd
ssh2.tunnel://user:pass@example.com:22/192.168.0.1:14
ssh2.sftp://user:pass@example.com:22/path/to/filename

上記の例では、それぞれ次のような用途を表しています。

• ssh2.shell://：リモートマシン上で対話型シェル（xterm）を開く
• ssh2.exec://：指定したコマンド（/usr/local/bin/somecmd）をリモートで実行する
• ssh2.tunnel://：リモートマシン経由で内部ネットワーク（192.168.0.1:14）へのトンネルを確立する
• ssh2.sftp://：SFTPプロトコルを使ってリモートファイルにアクセスする

また、scpによるファイル転送にはssh2.scp://ラッパーを使用します。

ssh2.*// のコンテキストオプション

stream_context_create()で作成したコンテキストを使うことで、SSH接続の詳細な挙動を制御できます。主なオプションは以下のとおりです。

補足：公開鍵認証の活用

パスワード認証の代わりに、pubkey_fileとprivkey_fileオプションを組み合わせて公開鍵認証を利用すると、より安全な接続が可能になります。URL内にパスワードを含める必要がなくなるため、スクリプトの可読性とセキュリティの両面でメリットがあります。