YubiKey
YubiKey は小さな USB セキュリティトークンです。モデルにも依りますが、以下のようなことができます:
- スマートカードのように振る舞う(CCID protocol を使用) - PGP と PIV 秘密鍵の両方を保存できます。
- Universal 2nd Factor (U2F) リクエストを処理する。
- 約 30 個のオープン認証イニシアチブ (OATH) 資格情報を保存・クエリする。
- Yubico OTP モードか HMAC-SHA1 モードでチャレンジレスポンス認証を処理する。
- ワンタイムパスワード (OTP) を生成する - Yubico's AES based standard。
- 63 文字までの静的パスワードを"入力"する。
多くの機能を提供する一方、YubiKey の新しいバージョンはオープンソースとしてリリースされていません。代替としては Solo、TKey、Nitrokey があります。
目次
- 1 インストール
- 2 入力
- 3 出力
- 4 USB 接続モード
- 5 ワンタイムパスワード
- 6 OATH
- 7 U2F
- 8 CCID スマートカード
- 9 使用例
- 10 ヒントとテクニック
- 11 メンテナンス/アップグレード
- 12 トラブルシューティング
- 12.1 YubiKey が HID デバイスとして機能しない
- 12.2 ykman が YubiKey に接続できない
- 12.3 Error: Failed connecting to YubiKey 5 [OTP+FIDO+CCID]. Make sure the application have the required permissions.
- 12.4 YubiKey がゲスト VM 内でバインドできない
- 12.5 Error: [key] could not be locally signed or gpg: No default secret key: No public key
- 12.6 YubiKey が Yubico Authenticator で消えたり現れたりする
- 12.7 YubiKey core error: timeout
インストール
管理ツール
- YubiKey Manager — USB を通して YubiKey の設定とクエリをするための Python ライブラリとコマンドラインツール(
ykman)。オプションの GUI あり。
- YubiKey Personalization — OTP USB 接続を通して YubiKey の設定とクエリをするためのライブラリとツール。ykman よりも強力ですが、使うのが難しいです。オプションの GUI あり。
- https://developers.yubico.com/yubikey-personalization/ || yubikey-personalization, yubikey-personalization-gui
認証ツール
- Yubico PAM — Yubico OTP または チャレンジレスポンス認証による PAM ユーザ認証。
- Yubico Authenticator for Desktop — USB を通して YbiKey から OATH コードを読み込む GUI。古いスロットベースの実装 (YubiKey Standard と Edge) と新しい OATH 実装をサポート (YubiKey NEO と 4)。注: archlinux/packaging/packages/yubioath-desktop。
- Yubico Authenticator 6.0+ for Desktop — Yubico Authenticator 6.0+ (バージョン 6.0 及びそれ以降) は、YubiKey の第二要素クレデンシャルを管理するためのアプリケーションです。バージョン 6.0 から、コードベースが Flutter フレームワークを使って完全に書き換えられました。
- libfido2 — クライアントサイドの U2F サポート。ウェブブラウザで U2F プロトコルを YubiKey による認証のために利用できるようになります。
- YubiKey Full Disk Encryption — チャレンジレスポンスモードを使用し、強力な LUKS パスフレーズを生成します。完全なディスク暗号化をサポート。
入力
YubiKey は、USB を通して API を呼び出したりボタンを押したりする形で入力を受け付けます。
ボタンはとても敏感です。状況にも依りますが、ボタンを押すと以下のどれか1つを行います:
- 静的パスワードやワンタイムパスワード(OTP)をトリガーする(短く押すとスロット1、長く押すとスロット2)。これはデフォルトの挙動で、うっかりトリガーしてしまうことは簡単です。
- 機能やアクセスを確定/許可する。LED が点灯し、ユーザに入力を促します。
- スマートカードを挿入/除去する。
出力
YubiKey は以下の入力を出力に変換します:
- キーストローク(USB キーボードをエミュレートします)、静的パスワードや OTP をタイプするために使用します。(静的パスワードはキーロガーに対して脆弱であることに注意してください。)
- 組み込みの LED は:
- 挿入した際に一度光ります。トラブルシューティングに便利です。
- API の応答を許可するためにボタンを押すことを要求された際に安定して光ります。
- USB を通した API 応答。これは以下のように使用されます:
- チャレンジレスポンス認証(Yubico OTP モードか HMAC-SHA1 モードを使って計算されます)
- U2F チャレンジレスポンス認証
- CCID スマートカード関連のリクエスト
USB 接続モード
YubiKey のモデルによりますが、デバイスは3つまでの異なる USB インターフェイスを提供します。これらのインターフェイスのうち2つは USB HID (Human Interface Device) デバイスクラスを実装しています; 3つ目はスマートカードインターフェイス(CCID)です。3つすべて独立して有効化/無効化できます。これにより、それらに関連したプロトコルの制御ができます。
以下の表はどのプロトコルがどのインターフェイスを使用するかを示しています:
| プロトコル | インターフェイス |
|---|---|
| OTP | Keyboard HID |
| FIDO | Other HID |
| PIV | CCID |
| OpenPGP | CCID |
| OATH | CCID |
ykman は "modes" という用語を使用します、OTP、FIDO、CCID と名付けられています。
有効になっているモードを取得
バージョン 5 以前の YubiKey では:
$ ykman config mode
Current connection mode is: OTP+FIDO+CCID
YubiKey バージョン 5 では:
$ ykman info
Device type: YubiKey 5 NFC Serial number: XXXXXXXXX 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
モードをセット
すべてのモードが出荷時から有効化されています。変更するには:
$ ykman mode [OPTIONS] MODE
MODEには文字列を使用できます。例えば、OTP+FIDO+CCID。短い形式もあります:o+f+c。MODEにはモード番号を使用できます。複数の有効化するモードをエンコードしたものです。
以下にモード番号の表があります:
| 0 | OTP device only. |
| 1 | CCID device only. |
| 2 | OTP/CCID composite device. |
| 3 | U2F device only. |
| 4 | OTP/U2F composite device. |
| 5 | U2F/CCID composite device. |
| 6 | OTP/U2F/CCID composite device. |
| 81 | CCID device only, with touch-eject. |
オプション:
--touch-eject- ボタンを押すとスマートカードを挿入/除去します。これは CCID のみのモードでのみ動作します; FIDO と OTP は無効化されていなければなりません。--autoeject-timeout SECONDS- 一定時間立つとスマートカードを自動的に除去します。--touch-ejectと同じような制限があります。--chalresp-timeout SECONDS- チャレンジレスポンス認証のタイムアウトを設定します。
さらなる情報は、ykman mode --help を見てください。
ワンタイムパスワード
どういうわけか、この機能には誤解を招く名前が付けられています。この機能には静的パスワードとチャレンジレスポンス認証の機能も含まれているのです。
2つのスロットがこの機能のために提供されています。それぞれのスロットには、短くボタンを押したり、長くボタンを押すことでアクセスできます。それぞれのスロットは以下のうち1つを設定できます:
- Yubico OTP
- OATH-HOTP
- OATH-TOTP
- チャレンジレスポンス認証
- 静的パスワード
それぞれの機能には、作成時に提供できる複数の設定オプションがあります。しかし、一度設定すると読み返すことができません。ykman otp swap により、スロット1とスロット2を入れ替えることはできます。
工場出荷時の設定
新しい YubiKey では、Yubico OTP がスロット1に事前に設定されています。この初期の AES 共通鍵はその YubiKey と Yubico の認証サーバーに保存されています。これにより、YubiCloud に対して認証でき、Yubico Forum ウェブサイトや https://demo.yubico.com と組み合わせて Yubico OTP を使用できます。
Yubico OTP
Yubico OTP は共通鍵暗号に基づいています。より具体的には、それぞれの YubiKey にはそのデバイスにユニークな128ビットの AES 鍵が含まれており、この鍵は検証サーバーにも保存されています。パスワードを尋ねられた際には、YubiKey は鍵の ID、カウンタ、乱数などの異なるフィールドを連結し、その結果を暗号化することでトークンを作成します。
この OTP は対象のシステムに送られ、検証サーバーに渡されます。検証サーバー(同じく秘密鍵を所有しています)はそれを復号し、内部の情報を検証します。その結果は対象のシステムに返されます。そして、システムはアクセスを許可するかどうかを判断することができます。
YubiCloud と検証サーバー
Yubico は、YubiCloud と呼ばれる、無料かつ制限無しでアクセスできる検証サーバーを提供しています。YubiCloud はすべての YubiKey の工場出荷時の設定を把握しており、これは (例えば) yubico-pam によって使用される「デフォルト」の検証サービスです。Yubico はまた、サーバーのオープンソースの実装も提供しています。
設定と使用
スロットに新しいキーを生成してください。そして、それを YubiCloud にアップロードしてください(ブラウザで開きます):
$ ykman otp yubiotp --generate-key --upload 2
さらなる情報は、ykman otp yubiotp --help で見てください。
セキュリティリスク
AES 鍵の漏洩
ご想像の通り、AES 鍵は絶対に秘密にする必要があります。Yubikey から AES 鍵を抜き取ることはできません (少なくともソフトウェアを使って抜き取るのは不可能に近い)。AES 鍵は検証サーバーにも存在するため、このサーバーのセキュリティというのがとても重要になります。
検証リクエスト/レスポンスの盗聴
システムは検証サーバーの決定に従っているため、検証サーバーになりすます攻撃が考えられます。これを防ぐには、対象のシステムが、HMAC か HTTPS を使用して、検証サーバーを認証する必要があります。
チャレンジレスポンス認証
チャレンジは YubiKey に送られ、YubeKey はとある秘密に基づいてレスポンスを計算します。同じチャレンジに対しては常に同じレスポンスが返されます。その秘密無しでは、この計算は現実的ではありません。たとえ、大量のチャレンジレスポンス認証を行ったとしてもです。
これは以下のように利用できます:
- 真の二要素認証: ユーザーはチャレンジを与えられ、パスワードに加えて正しいレスポンスを返さなければなりません。両方が秘密鍵を持っていなければなりません。
- 「準」二要素認証: チャレンジはパスワードのように振る舞い、サーバーは正しいレスポンスを保持しています。これは OTP ではなく、レスポンス鍵を手に入れれば誰でもアクセス許可を得ることができます。しかし、サーバーが秘密鍵を必要としないので、よりシンプルです。
2つのチャレンジレスポンス認証アルゴリズムがあります:
- HMAC-SHA1
- Yubico OTP
これは、yubikey-personalization-gui を使って GUI で、あるいは以下の指示で設定できます。
HMAC-SHA1 アルゴリズム
生成された鍵を使ってスロット2をチャレンジレスポンス認証モードで設定してください:
$ ykman otp chalresp --generate 2
キーを与えるための --generate フラグは省略できます (ykman otp chalresp --help を参照)。キーを与える主な利点は、バックアップ用の2つ目のデバイスをセットアップする際に使用できることです。例えば、openssl rand -hex 20 は適切な鍵を生成します。
Yubico OTP アルゴリズム
ykman は chal-yubico アルゴリズムの設定にはサポートしていないようです。しかし、ykpersonalize を使用できます。スロット2にランダムな鍵を生成してください:
$ ykpersonalize -2 -ochal-resp -ochal-yubico
さらなる情報は ykpersonalize(1) を見てください。
チャレンジを送信
チャレンジを送信してレスポンスを受信するには、ykchalresp -slot challenge コマンドを使用できます。例えば:
$ ykchalresp -2 archie
12a19763be77d75af46fb76f0b737c117fa47205
このコマンドは、プログラム済みのスロット2のユニークな 40 バイトの SHA1 ハッシュ値を返します。チャレンジが異なると、異なるユニークなレスポンスが返されます。
静的パスワード
静的パスワードも生成できます:
$ ykman otp static --generate slot
あるいは、パスワードを与えることも:
$ ykman otp static slot password
複数のオプションがあります; 生成されるパスワードの長さと文字セットや、Enter キーストロークを送るかどうかを設定できます。詳細は ykman otp static --help で見てください。
エミュレートされた USB キーボードの限界、「なぜ私のパスワードは弱く見えるのか」
ほとんどのキーボードレイアウトで YubiKey が機能するようにするために、パスワードはデフォルトで ModHex アルファベット(cbdefghijklnrtuv)、数値 0-9、! に制限されています。これらの文字は非常に多くのキーボードレイアウトで同じスキャンコードを使用し、ほとんどのコンピュータで互換性が保証されます。
Yubico はこの問題に関する白書を提供しています。
OATH
YubiKey は2つの OATH 実装を提供します:
- OATH API
- 新しい手法であり、モデルによっては約30個の認証情報を格納できます。(YubiKey 4、NEO、それ以降)
- OTP slot
- 古い手法であり、両方の OTP スロットが1つの認証情報を格納できます。(チャレンジレスポンス認証をサポートするすべてのモデル)
OATH API
GUI がお好みならば、yubioath-desktop を使用できます。
ykman は、ykman oath uri を使って URI 形式のコードを追加できます。以下は、QR コードのイメージから認証情報を追加するワンライナーです:
$ zbarimg qr_code.png --quiet --raw | xargs ykman oath uri
手動で行うこともできます。TOTP 鍵をプログラムし、コードを生成するためにボタンへのタッチを要求します:
$ ykman oath add --touch name secret
HOTP 鍵をプログラムします:
$ ykman oath add --oath-type HOTP name secret
認証情報を一覧表示します:
$ ykman oath list
コードを生成します:
$ ykman oath code query
利用可能なサブコマンドをすべて見るには、ykman oath --help を実行してください。それぞれのサブコマンドの情報を見るには、ykman oath subcommand --help を使ってください。
OTP スロット実装
スロット2で HOTP をプログラムします:
$ ykman otp hotp 2 key
TOTP をプログラムします:
$ ykman otp chalresp --totp slot key
HOTP を生成します:
$ ykman otp calculate slot
TOTP を生成します:
$ ykman otp calculate --totp slot
ykman otp --help と https://developers.yubico.com/OATH/ も参照してください。
U2F
YubiKey を用いた Universal 2nd Factor (U2F) はとても単純です。鍵そのものに対する設定は必要ありません。このモードは一部のドキュメントやユーティリティでは 'FIDO' とも呼ばれていることに注意してください。ykman ユーティリティを通じていくつかの限定された管理オプションがあります:
- PIN を設定:
ykman fido access change-pin - 個別の資格情報を削除:
ykman fido credentials delete QUERY - すべての資格情報と PIN をリセット:
ykman fido reset
U2F を認証に使用するには、U2F の指示を見てください。
WebAuthn も参照。
CCID スマートカード
CCID (Chip Card Interface Device) は、スマートカードリーダーとして振る舞う USB デバイスによって使用されたり、YubiKey のように USB を通して直接接続するセキュリティトークンで使用されたりする USB 標準デバイスクラスです。HID (Human Interface Device) と CCID は両方とも USB デバイスクラスです。つまり、これらは USB 仕様の同じカテゴリに属すということです。HID は、キーボードなどのようなコンピュータ周辺機器のための仕様です。YubiKey は、OTP モードと FIDO モードで使用されたときは USB (HID) キーボードのように働きます。しかし、PIV アプリケーションを使用する時や OpenPGP デバイスとして使用する時は CCID プロトコルに切り替わります。
CCID モードは 2015 年11以降に出荷された YubiKey のすべてでデフォルトで有効になっているはずです[1]。少なくとも CCID モードは有効化してください。#有効になっているモードを取得 を見てください。
PIV
YubiKey NEO 以降から、YubiKey はチップ上に PIV (Personal Identity Verification) アプリケーションが含まれています。PIV は、RSA や ECC(楕円曲線暗号) を使用するトークンが個人電子証明書にどのように使用されるかを定めた米国政府規格(FIPS 201)です。YubiKey NEO は RSA 暗号のみをサポートしますが、その後のモデル(YubiKey 4 と 5)は RSA と ECC の両方をサポートします。PIV トークンの特徴は、秘密鍵を保護しオンチップで動作するように構築されているという点です。秘密鍵は、トークン上にインストールされた後は決してトークン外に出ることはありません。オプションで、オンチップの乱数生成器を使って秘密鍵をオンチップで生成することもできます。秘密鍵がオンチップで生成された場合、秘密鍵はチップの外部で処理されることはなく、トークンから秘密鍵を復元する方法もありません。PIV メカニズムを使用する際は、YubiKey は CCID デバイスとして機能します。
OpenPGP スマートカード
YubiKey は標準の GPG スマートカードとしてとして振る舞うことができます; セットアップと使用法に関する説明は GnuPG#スマートカード セクションを見てください。Yubico は https://developers.yubico.com/PGP/ でドキュメントも提供しています。
他の機能(U2F と OTP)を使用したくない場合、ボタンはキーを挿入/除去するように設定でき、自動除去のタイムアウトも設定できます。詳細は #USB 接続モード を見てください。
デフォルトのユーザ PIN は 123456 で、デフォルトの admin PIN は 12345678 です。デフォルトの PUK も 12345678 です。覚えておきましょう。
使用例
このセクションでは、様々な認証の目的での YubiKey の使用法について説明しています。しかし、以下は使用法について完全に網羅されたリストではありません。
LUKS による完全なディスク暗号化
複数の選択肢があります:
- チャレンジレスポンス認証: とあるチャレンジに対するレスポンスが LUKS 鍵として使用されます。チャレンジは、真の二要素認証においてはパスワードとして機能し、一要素認証においてはチャレンジは平文で保存することができます。
- GnuPG: YubiKey の PGP スマートカードの機能を使用します。長いパスフレーズ無しで強力な二要素認証を提供します。
- FIDO HMAC Secret: あなたの YubiKey が U2F をサポートしているのであれば、共通鍵を返すように設定できます。
共通の前提条件
- LUKS により暗号化された起動可能なシステム。少なくとも1つの空きキースロットがあり、
encryptmkinitcpio フックを使用していること。- mkinitcpio-ykfdeAUR を例外として、
sd-encryptはこれらのツールの全てでサポートされていません。
- mkinitcpio-ykfdeAUR を例外として、
- LUKS ヘッダーのバックアップ(任意ですが、推奨)
チャレンジレスポンス認証
完全な手順については yubikey-full-disk-encryption の 公式ドキュメント を見てください。大まかには:
- yubikey-full-disk-encryption をインストール。
/etc/ykfde.confを設定。- 対象のディスクを登録:
# ykfde-enroll -d /dev/DISK -s LUKS_SLOT ykfdemkinitcpio フック をencryptフックの前に追加。- Initramfs の再生成
いくつかの利用可能なバリエーションがあります:
- 2FA: デフォルトの挙動。対象デバイスの登録時、および起動時にパスワードとしてチャレンジを与えなければなりません。
- 1FA:
ykfde.confにYKFDE_CHALLENGEを設定してください。これは平文で保存されることに注意してください。このファイルに対する非ルートユーザの読み込みアクセスを禁止することを検討してください。 - NFC サポート (実験的)
- サスペンドと復帰のサポート (実験的) サスペンド時に、暗号化されたボリュームが自動的にロックされます。復帰時に自動でアンロックします。
設定の変更を行った時は、変更を反映させるために initramfs の再生成を行わなければなりません。
systemd ベースの initramfs
sd-encrypt フックのユーザは mkinitcpio-ykfdeAUR か mkinitcpio-ykfde-gitAUR をインストールし、プロジェクトのドキュメントにある手順に従ってください。手順は、大まかに言えば yubikey-full-disk-encryption に似ています。
GnuPG 暗号化キーファイル
これを行うためのツールの一つは initramfs-scencrypt です。完全な手順についてはドキュメントを見てください。2022年10月以降、このパッケージは、GitHub で PKGBUILD が提供されていますが、AUR に存在せず、徹底的にテストもされていないことに注意してください。
Dm-crypt のページではいくつかの代替策が提示されています。しかし、それらの殆どがフォーラムの古い投稿へのリンクです。
FIDO2 プロトコルの HMAC secret extension
YubiKey を完全ディスク暗号化に使うもう一つの方法は、HMAC Secret Extension を使用して、YubiKey から LUKS のパスワードを取得することです。これはパスフレーズによって保護することができます。この機能には、少なくともファームウェア 5.2.3+ のYubiKey 5 が必要です。 パスフレーズによる保護の方法では、khefinAUR をインストールし、プロジェクトのドキュメントにある手順に従ってください。 systemd 248 以降での(任意で PIN による保護が施された)1要素による方法では、FIDO2 キーを LUKS2 キースロットとして使用できます。手順は作者のブログ投稿で見られます。
KeePass
KeePass は YubiKey をサポートするように設定できます。手順は YubiKey セクション を見てください。
SSH 鍵
CCID
あなたの YubiKey が CCID スマートカードをサポートしているのであれば、GPG 鍵や PIV 鍵のどちらかをベースとしてハードウェアによる SSH 鍵 として使用することができます。Yubico は品質の良いドキュメントを提供しています:
- PGP と PIV の両方の可能性から見た概要、それらの利点と欠点を挙げています。
- PGP 認証のための手順
- ユーザ証明書による PIV 認証のための手順
- #PKCS11 による PIV 認証のための手順
U2F
YubiKey の U2F の機能を使用してハードウェアによる SSH 鍵を作成することもできます。手順は SSH 鍵#FIDO/U2F を見てください。
PIV
yubikey-agentAUR は SSH 鍵 を PIV トークンとして保存します。セットアップガイドは https://github.com/FiloSottile/yubikey-agent#readme を見てください。
PAM を用いた Linux ユーザ認証
ユーザ認証のために PAM を使用するすべてのものは、ユーザ認証のプロセスの一つの要素として YubiKey を使用するように設定できます。これには sudo、su、ssh、スクリーンロッカー、ディスプレイマネージャー、そして Linux システムがユーザを認証する必要のあるほぼすべての場面を含みます。その柔軟な設定により、システム全体や特定のアプリケーション、あるいはアプリケーションのグループに対して、あなたのニーズに合う認証要件を自由に設定することができます。例えば、ローカルセッションではパスワードの代わりとして YubiKey を受け入れ、リモートのセッションでは両方を要求することができます。これがどのように機能し、どのように設定するのかを理解するために、Arch Wiki の記事に加えて、pam(8) や pam.conf(5) を読むことをおすすめします。
YubiKey がサポートするプロトコルを PAM に統合するのに利用できるモジュールが複数あります:
- pam-u2f - FIDO2 規格による #U2F をサポート。どの手法を使うべきかわからない場合、これが良い選択です。
- Arch Wiki の記事
- Yubico の公式ドキュメント、サポートされるモジュールパラメータのリストがあります。
- Man ページ: pam_u2f(8)、pamu2fcfg(1)
- oath-toolkit - #OATH ワンタイムパスワードをサポート(HOTP か TOTP)。
- yubico-pam - #Yubico OTP と チャレンジレスポンス認証 OTP をサポート。Yubico OTP モードでは認証サーバーへのネットワーク接続が必要であることに注意してください。チャレンジレスポンス認証では必要ありません。
- Yubico の公式ドキュメント
- pam_yubico(8) - チャレンジレスポンス認証モードを設定するのに使用される
modeパラメータに注意してください。
PAM の設定はこの記事の範囲を超えますが、簡単な概要としては:
- 認証されたキーを含むファイルをホームディレクトリ内か一元的に作成する。
- 適切な PAM 設定ファイルの適切な場所に、以下のフォーマットに従う行を追加する:
auth [required|sufficient] [module_name].so [module arguments]
- 多要素認証には
auth required、単一要素認証にはauth sufficient。 module_name- 例:pam_u2f.so。インストールされているモジュールのリストを見てください:ls /usr/lib/security- モジュールの設定引数は、キーファイルの場所や、認証するためにどの手法をモジュールが使用すべきかなどです。
SSH における注意事項
- Yubico は追加のガイダンスを公開しています。これは Ubuntu の古いバージョン向けですが、アップデートされている Arch システムにも適用できます。
- 遠隔地にあるサーバを YubiKey を使用するように設定する場合、追加で少なくとも一つの緊急用 SSH セッションを開いておくべきです。こうすれば、設定ミスにより締め出されないで済みます。
/etc/ssh/sshd_configに以下の設定が含まれていることを確認してください。openssh に同梱されているsshd_configはデフォルトでこれらが正しく設定されています。
ChallengeResponseAuthentication no UsePAM yes
ブラウザ/web 統合
多くのウェブサービスが FIDO ハードウェアトークンをサポートし始めています。詳細は U2F や WebAuthn のページを見てください。しかし、通常、するべきことといえば libfido2 をインストールして 試してみることくらいです。
ヒントとテクニック
YubiKey デバイスの挿入/除去時にアクションを実行する
例えば、USB スロットから YubiKey を抜いた時にアクションを実行したいとしましょう。/etc/udev/rules.d/80-yubikey-actions.rules を作成し、以下の内容を追加してください:
ACTION=="remove", ENV{ID_VENDOR}=="Yubico", ENV{ID_VENDOR_ID}=="1050", ENV{ID_MODEL_ID}=="0010|0111|0112|0113|0114|0115|0116|0401|0402|0403|0404|0405|0406|0407|0410", RUN+="/usr/local/bin/script args"
注意すべきなのは、ほとんどのキーはこの例でカバーされていますが、すべてのバージョンの YubiKey で動作するとは限らないということです。lsusb の出力を見て、ベンダーとモデル ID をデバイスの説明と共に得るか、udevadm を使って情報を得る必要があります。もちろん、YubiKey の挿入時にスクリプトを実行したい場合は、アクションを "remove" ではなく "add" にしてください。
挿入時に Yubico Authenticator を開始する
Authenticator は長時間実行される GUI プロセスです。Udev ルール内で直接実行すると、プロセスが udev の処理をブロックしてしまいます。フォークすると、イベント処理の終了後に udev は無条件で (フォークによって生成された) プロセスをキルしてしまいます。なので、authenticator を udev ルールから開始することはできません。しかし、systemd.device を使うことができます。
上記と同じように、/etc/udev/rules.d/80-yubikey-actions.rules を作成して、以下の内容を書き込んでください:
ENV{ID_VENDOR}=="Yubico", ENV{ID_VENDOR_ID}=="1050", ENV{ID_MODEL_ID}=="0010|0111|0112|0113|0114|0115|0116|0401|0402|0403|0404|0405|0406|0407|0410", SYMLINK+="yubikey", TAG+="systemd"
そして、新しい systemd ユーザーユニットを作成してください:
~/.config/systemd/user/yubioath-desktop.service
[Unit] Description=Autostart Yubico Authenticator # Uncomment if you want to stop the authenticator when unplugged. #StopPropagatedFrom=dev-yubikey.device [Install] WantedBy=dev-yubikey.device [Service] Type=oneshot ExecStart=/usr/bin/yubioath-desktop
そして、このユニットを有効化してください。systemctl が、このユニットが存在しない dev-yubikey.device ユニットの依存関係として追加されたことを警告してきますが、問題ありません。このユニットは、YubiKey が挿入されると開始されます。
メンテナンス/アップグレード
YubiKey NEO 用に OATH アプレットをインストールする
以下のステップで、YubiKey NEO に OATH アプレットをインストールできます。Google Play Store の Yubico Authenticator を使えるようになります。
NEO を CCID デバイスとして設定する
- yubikey-personalization-gui (yubikey-personalization-gui-gitAUR) をインストール。
- udev ルールを追加して再起動すれば root にならなくても YubiKey を扱えるようになります。
ykpersonalize -m82を実行し、yを入力、エンターを押す。
アプレットをインストールする
- gpshellAUR、gppcscconnectionpluginAUR、globalplatformAUR、pcsclite をインストール。
pcscd.serviceを起動。- 最も最近の CAP ファイルを ykneo-oath サイトからダウンロード。
gpinstall.txtを GitHub からダウンロード。- gpinstall.txt を編集して
install -fileから始まる行を CAP ファイルが置かれているパスに修正。 - ターミナルを開き、
gpshell path/to/gpinstall.txtを実行。 - 理想的には、大量のテキストが流れて、最後に以下のようなものが書かれていることです:
Command --> 80E88013D7C000C400BE00C700CA00CA00B400BE00CE00D200D500D700B000DB00C700DF00BEFFFF00BE00E400AC00AE00AE00DB00E700A A00EA00ED00ED00ED00BE00EF00F100F400F100F700FA00FF00BE00F700AA01010103010700CA00C400B400AA00F700B400AA00B600C7010C 010C00AA0140012001B0056810B0013005600000056810E0011006B4B44304B44404B44106B44B4405B443400343B002410636810E06B4B44 407326810B004B43103441003334002B102B404B3B403BB4003B440076820A4100221024405B4341008B44600000231066820A100 Wrapped command --> 84E88013DFC000C400BE00C700CA00CA00B400BE00CE00D200D500D700B000DB00C700DF00BEFFFF00BE00E400AC00AE00AE00DB00E700A A00EA00ED00ED00ED00BE00EF00F100F400F100F700FA00FF00BE00F700AA01010103010700CA00C400B400AA00F700B400AA00B600C7010C 010C00AA0140012001B0056810B0013005600000056810E0011006B4B44304B44404B44106B44B4405B443400343B002410636810E06B4B44 407326810B004B43103441003334002B102B404B3B403BB4003B440076820A4100221024405B4341008B44600000231066820A15D848CB77 27D0EDA00 Response <-- 009000 Command --> 80E60C002107A000000527210108A00000052721010108A000000527210101010003C901000000 Wrapped command --> 84E60C002907A000000527210108A00000052721010108A000000527210101010003C9010000B4648127914A4C7C00 Response <-- 009000 card_disconnect release_context
- NEO を抜き、Yubico Authenticator アプリで試す。
(任意)Yubico Authenticator デスクトップクライアントをインストールする
yubioath-desktop をインストールすることで、Yubico Authenticator のデスクトップバージョンを取得できます。
pcscd.service が実行中の間に、yubioath-desktop を実行して、プロンプトが表示されたら YubiKey を挿入してください。
トラブルシューティング
Yubikey が最後に機能したときからアップデートを実行した場合特に、再起動を行ってください。一部の機能が問題なく動いているようでも再起動してください。
YubiKey が HID デバイスとして機能しない
この記事で説明されているように、udev ルールを追加してください:
/etc/udev/rules.d/10-security-key.rules
KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0664", GROUP="users", ATTRS{idVendor}=="2581", ATTRS{idProduct}=="f1d0"
その後、udevadm trigger を実行してください。
ykman が YubiKey に接続できない
マネージャが YubiKey への接続に失敗する場合、pcscd.service か pcscd.socket が起動していることを確認してください。
Error: Failed connecting to YubiKey 5 [OTP+FIDO+CCID]. Make sure the application have the required permissions.
これは、scdaemon がすでにデバイスの排他的な制御を取得している場合に ykman がデバイスの oath 認証情報にアクセスした際に発生する可能性があります。[2]
これを修正するには、~/.gnupg/scdaemon.conf 内であなたのデバイスに対して reader-port オプションを正しい値で設定することができます。[3]
YubiKey NEO と YubiKey 4 の場合:
reader-port Yubico Yubikey
YubiKey 5 の場合:
reader-port Yubico Yubi
YubiKey がゲスト VM 内でバインドできない
YubiKey がゲストで利用可能であると仮定すると、この問題はドライバがホストのデバイスにバインドしている結果です。デバイスのバインドを解除するには、ホストの dmesg からバスとポートの情報を手に入れる必要があります:
# dmesg | grep -B1 Yubico | tail -n 2 | head -n 1 | sed -E 's/^\[[^]]+\] usb ([^:]*):.*/\1/'
出力の USB id は X-Y.Z または X-Y の形式であるはずです。そして、ホスト上で、find を使って /sys/bus/usb/drivers を検索し、YubiKey がバインドしているドライバを探します (例: usbhid または usbfs)。
$ find /sys/bus/usb/drivers -name "*X-Y.Z*"
デバイスのバインドを解除するには、先のコマンドの出力を使ってください (つまり、/sys/bus/usb/drivers/DRIVER/X-Y.Z:1.0):
# echo 'X-Y.Z:1.0' > /sys/bus/usb/drivers/DRIVER/unbind
Error: [key] could not be locally signed or gpg: No default secret key: No public key
これは、YubiKey が挿入された状態で非標準的なキーリングでキーの署名をしようとした際に起こります(例えば、Pacman が pacman-key --populate で行うように)。解決策は、問題を起こしている YubiKey を取り外してやり直すことです。
YubiKey が Yubico Authenticator で消えたり現れたりする
これは、CCID ドライバがインストールされていない際に起こります。ccid パッケージをインストールする必要があります。
YubiKey core error: timeout
おそらく間違ったスロットを使用しています。もう一方のスロットで試してみてください。