help/setup-two-step-login-yubikey.md at 1b8c9e53f74db68c1cbb4222f2bb220b3817c61a

mirror of https://github.com/bitwarden/help synced 2025-12-06 00:03:30 +00:00

Files

fred_the_tech_writer 1b8c9e53f7 Q1 Release (#356 )

* q1 release additions & extras

* saml samples addition

* safari app extension note

* invitation validity

2021-01-19 10:43:58 -05:00

4.7 KiB

Raw Blame History

layout, title, categories, featured, popular, tags, order

layout

title

Setup YubiKey

Complete the following steps to enable Two-step Login using Yubikey:

{% callout warning %} Losing access to your Yubikey can permanently lock you out of your Vault, unless you write down and keep your Two-step Login Recovery Code in a safe place.

[Get your Recovery Code]({% link _articles/two-step-login/lost-two-step-device.md %}) from the Two-step Login screen before enabling any method. {% endcallout %}

Log in to the Web Vault{:target="_blank"}.
Select Settings from the top navigation bar.
Select Two-step Login from the left-side menu.
Locate the YubiKey OTP Security Key option and select the Manage button.

{% image two-step/twostep-options-yubioverlay.png Select the Manage button %}

You will be prompted to enter your Master Password to continue.
Plug the YubiKey into your computer's USB port.
Select the first empty YubiKey input field in the dialog in your Web Vault.
Touch the Yubikey's button.

If you will be using the YubiKey for a NFC-enabled mobile device, check the One of my keys supports NFC checkbox.
Select Save. A green Enabled message will indicate that Two-step Login using YubiKey has been enabled.
Select the Close button and confirm that the YubiKey OTP Security Key option is now enabled, as indicated by a green checkbox ( {% icon fa-check %} ).

Repeat this process to add up to 5 YubiKeys to your account.

{% callout info %} When you setup Two-step Login, you should logout of all your Bitwarden apps to immediately activate Two-step Login for each app. You will eventually be logged out automatically. {% endcallout %}

Use YubiKey

The following assumes that YubiKey is your highest-priority enabled method. Complete the following steps to access your Vault using Two-step Login:

Log in to your Bitwarden Vault on any app and enter your Email Address and Master Password.

You will be prompted to insert your YubiKey into your computer's USB port or hold your YubiKey against the back of your NFC-enabled device:

{% image two-step/yubikey/using-yubi.png %}

If you're using a non-NFC YubiKey on a Mobile Device:
1. Plug your YubiKey into the device.
2. Tap Cancel to end the NFC prompt.
3. Tap the text input field, denoted by a gray underline.
4. Tap or press your YubiKey button to insert your code.
Select or tap Continue to finish logging in.

You will not be required to complete your secondary Two-step Login step to Unlock your Vault once logged in. For help configuring Log Out vs. Lock behavior, see [Vault Timeout Options]({% link _articles/account/vault-timeout.md %}).

NFC Troubleshooting

If your YubiKey's NFC functionality isn't working properly:

Check that NFC is enabled:

Download YubiKey Manager{:target="_blank"}.
Plug the YubiKey into your device.
Select the Interfaces tab, and check that all boxes in the NFC section are checked.

Check that NFC is configured properly:

Download the YubiKey Personalization Tool{:target="_blank"}.
Plug the YubiKey into your device.
Select the Tools tab.
Select the NDEF Programming button.
Select the the configuration slot you would like the YubiKey to use over NFC.
Select the Program button.

(Android-only) Check the following:

That you checked the One of my keys supports NFC checkbox during setup.
That your Android device supports NFC{:target="_blank"} and is known to work properly{:target="_blank"} with YubiKey NEO or YubiKey 5 NFC.
That you have NFC enabled on your Android device (Settings → More).
That your keyboard layout/format/mode is set to QWERTY.

4.7 KiB Raw Blame History