YubiKey の設定をするパソコン向けのアプリケーションYubiKey Manager のインストール手順を解説します。
使い方はよく分かっていないので、今回はインストールの解説だけです。
- YubiKey Manager – Yubico
YubiKey Manager について
YubiKey Manager はYubico社が開発しているもので、ウィンドウ操作で使うGUI ツールと、コマンドライン操作で使うCLI ツール の2種類のツールが提供されています。
- YubiKey Manager (GUI) – dev.yubico
- YubiKey Manager CLI – dev.yubico
Mac へのインストール方法を調べてみると、下記のような感じでした。
| Homebrew 以外 | Homebrew | |
|---|---|---|
| GUIツール | pkgファイルをダウンロード | なし |
| CLIツール | pip コマンドを実行 | あり |
GUI ツールにはCLI ツールも含まれているので、今回はGUI ツールをインストールすることにしました。
なお、CLI ツールは単体でのインストールができますが、GUI ツールは単体でのインストールはできなそうでした。
あと、アプリケーションはMac 向け以外に、Linux、Windows 向けも用意されていました。
環境
今回はM1 ProチップのMacBook Pro にインストールしました。
OS はmacOS Monterey（12.2.1）です。
※ インストール後に確認したら、Intel CPU 向けのアプリケーションでした（Rosetta のインストールが必要）
インストール（GUI ツール）
1. パッケージファイルのダウンロード
YubiKey Manager のダウンロードページにある青字の”macOS Download” をクリックして最新版のpkg ファイルをダウンロードします。
- YubiKey Manager のダウンロードページ – Yubico
5/9時点では 1.2.4 (2021.10.26) 「yubikey-manager-qt-1.2.4-mac.pkg」がダウンロードされました。
古いバージョンをダウンロードできるページもあります（↓）
- yubikey-manager-qt > Releases – dev.yubico
2. インストール
ダウンロードしたpkgファイルをダブルクリックするとインストーラが起動するので、指示に従ってインストールします。
（一般的な手順でインストールできたので、詳細は省略します）
インストールが完了すると、アプリケーションにYubiKey Manager のアイコンが表示されているはずです。
3. キー操作の受信設定
システム環境設定を開いてYubiKey Manager によるキーボードの入力監視を許可します。
- [セキュリティとプライバシー] をクリック
- [プライバシー]タブ > [入力監視] を選択し、[YubiKey Manager.app] のチェックをON
4. GUI ツールの初回起動
YubiKey Manager を起動します。
もし、前述「3. キー操作の受信設定」をスキップしていると下記のウィンドウが開くので、[“システム環境設定”を開く] をクリックしてシステム環境設定を開いて設定します。
5. GUI ツールの動作確認
パソコンのUSB ポートにYubiKey を挿入します。
※ USB-C ポートしかないので変換アダプタをかませました
挿入するとYubiKey が認識され、ファームウェアやシリアル番号の情報が表示されました。
6. CLI ツールのPATHを通す
続けて、GUI のパッケージをインストールすると、CLI ツール（ykman）も一緒にインストールされるので、CLI ツールの初期設定について解説しておきます。
GUI のパッケージでインストールすると、CLI ツール（ykman）は/Applications/YubiKey Manager.app/Contents/MacOS にインストールされます。
上記フォルダへのcd やフルパス指定せずにykman で実行できるようにPATH を通します。
~/.zshrc に下記を追記します。
export PATH=$PATH:/Applications/YubiKey\ Manager.app/Contents/MacOSターミナルを既に開いている場合は、source ~/.zshrc を実行して設定を反映します。
7. CLI ツールの動作確認
試しにいくつかコマンドを実行してみます。
ykman -v
→ CLIツールのバージョン情報が出力される
YubiKey Manager (ykman) version: 4.0.7
ykman list --serials
→ YubiKeyのシリアル番号が出力される
ykman --device <シリアル番号> info
→ YubiKeyのデバイス情報が出力される
Device type: YubiKey 5 NFC
Serial number: <シリアル番号>
Firmware version: 5.4.3
Form factor: Keychain (USB-A)
Enabled USB interfaces: OTP, FIDO, CCID
NFC transport is enabled.
Applications USB NFC
FIDO2 Enabled Enabled
OTP Enabled Enabled
FIDO U2F Enabled Enabled
OATH Enabled Enabled
YubiHSM Auth Enabled Enabled
OpenPGP Enabled Enabled
PIV Enabled Enabled- Using the YubiKey Manager CLI > Mac – YubiKey Manager (ykman) CLI and GUI Guide
GUI ツールの画面構成
今後の作業ため、GUI ツールの画面構成を貼り付けておきます。
YubiKey 5 NFC の初期状態を後で確認できるようにすることも兼ねて。
Applications
FIDO2
PIV
Interfaces
ついでにSecurity Key NFC を挿入
Homeは、YubiKey 5 では表示されていたシリアル番号がないです。
Applications はFIDO2 だけが選択可能です
Interfaces はFIDO2 とFIDO U2F の2つだけです
ykman list --serials
→ 何も出力されない
ykman info
→ YubiKeyのデバイス情報が出力される
Device type: Security Key NFC
Firmware version: 5.1.2
Form factor: Keychain (USB-A)
Enabled USB interfaces: FIDO
NFC transport is enabled.
Applications USB NFC
FIDO2 Enabled Enabled
OTP Not available Not available
FIDO U2F Enabled Enabled
OATH Not available Not available
YubiHSM Auth Not available Not available
OpenPGP Not available Not available
PIV Not available Not availableSecurity Key NFC はシリアル番号が分からなかったけれど、シリアル番号を指定せずにデバイスの情報を確認することはできました。
あとがき
手持ちのMacBook Pro はUSB-C ポートしかないので、YubiKey 5C NFC を買った方がよかったかも。10ドル高いけど。
YubiKey Manager 以外にもYubico社が提供しているツールがあったので、最初見た時は混乱した。整理してみると開発停止になっていたりするので、YubiKey Manager に集約することになったのかもしれない。
- YubiKey Personalization Tool (GUI/CLI) ※開発中止
- YubiKey PIV Manager (GUI) ※開発中止
- Yubico PIV Tool (CLI) ※開発継続している(→GitHub)
- Yubico Authenticator ※開発継続している？
他にも探したら何か見つかるかもしれませんが止めておきます。
Yubico Authenticator というクロスプラットフォームに使える感じの認証アプリがちょっと気になる。
参考
- YubiKey Manager – Yubico
- YubiKey Manager（GUI） – dev.yubico
- YubiKey Manager CLI – dev.yubico
- ykman – Homebrew Formulae
- yubikey-manager-qt > Releases – dev.yubico
- YubiKey Manager (ykman) CLI and GUI Guide – yubico docs
- Using the YubiKey Manager CLI > Mac – YubiKey Manager (ykman) CLI and GUI Guide
- YubiKey の開発者向けツール【YubiKeyとは-part3】(2018.12.18) – YubiOn（ソフト技研）