zmatsuo / pageant-

ssh ageant for windows

このプログラムについて

Windows用のssh agentです。putty pageantをベースにしています。

次のことを目指しています。

• 秘密鍵を利用する様々なssh関連のプログラムから利用できる
• 秘密鍵を手元(ローカル)に置いておいて、コピーを作らなくても済むようにする

次の経路でssh関連のプログラムと通信を行うことができます。

• pageant (putty ssh-agent compatible)
• ssh-agent unix domain socket (Cygwin emulation)
• ssh-agent unix domain socket (Windows Native)
• Microsoft ssh *1 (Named Pipe,Microsoft ssh-agant compatible)
• ssh-agent TCP接続 (socat(WSL)からの接続用)

まだまだ気になるところはありますが、概ね動作します。

できること

• sshの秘密鍵のパスフレーズを記憶,適当なタイミングで忘れることができます
• スマートキー(マイナンバーカード)を使うことができます
• よく使われる秘密鍵ファイルフォーマットをサポートしています(Putty形式,OpenSSH形式,ssh.com形式)
• 読み込んだ秘密鍵からsshサーバー用公開鍵を抽出できます

インストール

• インストーラを使用する場合 インストーラ(pageant+-xxx.exe)を実行してください
• アーカイブファイルを使用する場合 ファイルを解いて適当なフォルダに置いてください

起動

• 他のsshエージェントを止めます
  • pageant(putty)
  • ssh-pageant(Cygwinなど)
  • Microsoft OpenSSH ageant
• pageant+を起動します
• 鍵ファイルの追加
  • 署名で使用する鍵ファイルを追加します。
  • 'Add Key file'ボタンを押してファイルを追加
• ssh-add -lで鍵を表示できればok

エージェントの利用

• エージェントとの通信経路はアプリケーションによって異なっています。
• OpenSSHから利用するには環境変数の設定が必要になります。

Git for Windows

• Git for Windows 内の ssh を使用する場合
  • 環境変数 SSH_AUTH_SOCK を設定します。
    • set SSH_AUTH_SOCK=c:\path\.ssh-agent-cygwin など
  • Unix Domain Socket(Cygwin emulation) を指定します。
  • "C:\Program Files\Git\usr\bin\ssh-add.exe" -l など で鍵一覧が表示されればokです。
• PuTTY の plink を使用する場合
  • 環境変数 GIT_SSH に plink.exe のフルパスを設定します。
  • set GIT_SSH=C:\Program Files\PuTTY\plink.exe

OpenSSH(WSL)

• 環境変数 SSH_AUTH_SOCK を設定します。
  • export SSH_AUTH_SOCK=/mnt/c/path/.ssh-agent など
• Unix domain Socket (Windows Native)を使用します
• /usr/bin/ssh-add -l などで鍵一覧が表示されればokです。
• Windows 10 version 1803 Redstone 4(RS4)以降で利用可能です

socat + TCPでもWSLから利用できます

OpenSSH(Cygwin)

• 環境変数 SSH_AUTH_SOCK を設定します。
  • export SSH_AUTH_SOCK=c:/path/.ssh-agent-cygwin など
• Unix Domain Socket(Cygwin emulation) を指定します。
• c:/cygwin64/bin/ssh-add -l などで鍵一覧が表示されればokです。

OpenSSH(msys2)

• 環境変数 SSH_AUTH_SOCK を設定します。
  • export SSH_AUTH_SOCK=/c/path/.ssh-agent-cygwin など
• Unix Domain Socket(Cygwin emulation) を指定します。
• /c/msys64/usr/bin/ssh-add -l などで鍵一覧が表示されればokです。

OpenSSH(Micorsoft版)

• 環境変数 SSH_AUTH_SOCK を設定します。
  • 設定されていなければデフォルトの \\.\pipe\openssh-ssh-agent を使用します
• Unix Domain Socket(Microsoft Named Pipe) を指定します。
• c:\Windows\System32\OpenSSH\ssh-add -l などで鍵一覧が表示されればokです。

リレー

エージェントの通信を別のエージェントにリレーすることができます。

リモートデスクトップ経由(RDP relay)

• 接続した先(サーバ側)
  • pageant+を起動、設定のSSH Agent relay on RDP Serverをチェックする
• ローカル(クライアント側)
  • pageant+を起動、設定のSSH Agent relay on RDP Clientをチェックする (チェックを入れた後のmstscの実行から有効になります)
  • pageant compatibleのチェックも入れる
• リモートデスクトップ(mstsc.exe)で接続する
• Add Rdp Keyからダイアログを出す
• View client keyを押してクライアント側の鍵一覧を表示する
• Import Keyを押して鍵を取り込む

マイナンバーカード(スマートカード)

• マイナンバーカードに対応したOpenSCをインストールしておく opensc 0.17.0 からマイナンバーカード対応のようです 0.18.0で動作確認しました
• 'Add PKCS Cert'ボタンを押す
• C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dllを選ぶ
• 証明書選択で次のものを選ぶ
  • カード名が数字とアルファベット
  • 発行者が Japan Agency for Local
• pinは、利用者証明用電子証明書(マイナポータルへのログインなどに使用)に設定したもの

BT pageant+

• Add BTボタンを押す
• BT pageant+が動作しているデバイスを選択
• connectボタンを押す
• デバイスを選択
• 鍵を選択
• 鍵取込ボタンを押す

公開鍵の取得

• key listの鍵一覧から、公開鍵を取得することができます
• key listを表示して、鍵を1つ選択する
• 公開鍵ボタンを押す
• クリップボードにコピーされた文字列を、サーバーの ~/.ssh/authorized_keys に追加する

制限

鍵ファイル

• 楕円曲線暗号系のテストはあまり行っていません

動作確認できたスマートカード

putty-CACを元にしたCAPI(Cryptographic API)経由、pkcs#11経由で対応しています。 手元に使えるハードウェアが限られているのでほとんどテストできていません。

動作したリーダー+カード

• SCR3310-NTTCom + マイナンバーカード
• ACS ACR122 + マイナンバーカード
• yubiko yubikey neo pivモード

うまく自動起動しなくなったとき

pageant+のスタートタップ登録をもう一度やり直してください

通信できるプログラム

次のプログラムと通信できます。

terminal

• putty
• teraterm

WSL(Windows Subsystem for Linux)

• OpenSSH
  • Windows Native unix domain socket経由
  • socatを経由したソケット接続

OpenSSH

• OpenSSH
  • Windows 10 version 1803(Redstone 4)より正式版となったMicorsoftによる移植版

cygwin/msys ssh family

• cygwin/msys ssh
• mobaxterm (you need reset SSH_AUTH_SOCK)
• TortoiseSVN/TortoiseGit(modified plink)
• SourceTree
• Git for Windows

client

• Bivise ssh client

scp

• winscp
• filezilla

設定

プログラムの設定はpageant+が動作しているPCのレジストリに保存します。

iniファイルに保存することもできます。

1. レジストリでiniファイルを指定

• HKEY_CURRENT_USER\Software\pageant+\IniFile

このレジストリが設定してあると、指定iniファイルを使用します。 REG_EXPAND_SZの場合は環境変数参照(%HOME%など)があると展開されます。 (%HOME%\.pageant+.iniなど)。

設定がない場合、iniファイルを探します。

2. 自動で探す

次の順でファイルを探します。見つかったらそのファイルを使用します。

• %HOME%\.pageant+_[host].ini
• %HOME%\.pageant+.ini
• %HOMEDRIVE%%HOMEPATH%\.pageant+_[host].ini
• %HOMEDRIVE%%HOMEPATH%\.pageant+.ini
• %USERPROFILE%\.pageant+_[host].ini
• %USERPROFILE%\.pageant+.ini
• %APPDATA%\pageant+\pageant+_[host].ini
• %APPDATA%\pageant+\pagent+.ini
• [pageant+.exe(又はdll)と同じフォルダ]\pageant+_[host].ini
• [pageant+.exe(又はdll)と同じフォルダ]\pageant+.ini
• [pageant+.exe(又はdll)のカレントフォルダ]\pageant+_[host].ini
• [pageant+.exe(又はdll)のカレントフォルダ]\pageant+.ini

3. 上記すべて見つからなかった場合

レジストリに保存する

• HKEY_CURRENT_USER\Software\pageant+

参照したプロジェクトなど

• PuTTY https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html
• PuTTY-CAC https://risacher.org/putty-cac/

reference.txt を参照してください。

ビルド準備

リリース用ビルド

準備

Visual Studo 2017をインストールあらかじめインストールしてください(MinGW、32bitでのコンパイルはテストしていません)。

VS 2017 用 x64 Native Tools コマンド プロンプトを開いて次のコマンドを実行してください。

cd libs
runonce.bat
build_qt_static.bat

ビルド

ソースフォルダでコマンドプロンプトで次の通りに実行してください。

mkdir build
cd build
cmake .. -G "Visual Studio 15 2017 Win64"
cmake --build . --config Release
make_installer.bat

開発用ビルド

• 準備

  • https://www.qt.io/ から Qtをダウンロードしてインストールする
  • not_cmake/make_version.batを実行して not_cmake/version.cppを生成しておく

• Visual Studio 2017を使用する場合

  • Vsiual Studio 2017にQt Visual Studio Toolsをインストールする
  • pageant+.slnをVisual Studio 2017で開く

• Qt Creatorを使用する場合

  • pageant+.proをQt Creatorで開く

X11 Forwarding (Cygwin/X + ssh)

Cygwin/Xを使っていて、cygwin系のssh -Yを使用するとX11 Forwardingがう まくいくのに、puttyやMS sshなどではうまくいかないのは、Xサーバーがtcp をlistenしていないためです。

startxwin -- -listen tcpなどでtcp経由で接続できるようになります。

• http://x.cygwin.com/docs/faq/cygwin-x-faq.html#q-xserver-nolisten-tcp-default

license

• PuttyはMIT
• このプロジェクトはそれにならって基本MIT
• Putty-CACの元になったPutty SCがGNUのようなので、それに由来するソースはGNU
• バイナリで配布するときはGNU