bitwarden/help
1
0
Fork 0
mirror of https://github.com/bitwarden/help synced 2025-12-06 00:03:30 +00:00
Code Issues Releases Wiki Activity
Files
80a0b17ac689afebb2f07a0b8e4fcc733ecfffb0
help/_articles/account/setup-two-step-login-yubikey.md
David Choi 80a0b17ac6 Staging (#294) 
* jekyll redirect from

* Organizations rev (#262)

* Organizations revisions initial commit.

* API doc updates

* Fix absolute link causing build failure.

* Add import to org article, and downstream order changes.

* Bitwarden 101 videos: 1st steps toward proliferating these throughout /help.

* Added 'Create Your Account' article, which references B101 Videos.

* About SSO redirect & promote importing for orgs up the list

* Create Org FAQs & trim Feature FAQs accordingly.

* Image for Org FAQs

* Move 'About the Business Portal' to Orgs category, and re-order accordingly.

* Final edits.

* Dchoi/bootstrap upgrade (#264)

* bootstrap 4 upgrade and cleanup update gulp tasks

* bootstrap package updates

* renaming file convention

* general outline of help outline

* bitwarden help cleanup

* article cleanup

* article general styling complete

* bootstrap help page upgrades

* sidebar updates

* Dchoi/bootstrap upgrade (#267)

* bootstrap 4 upgrade and cleanup update gulp tasks

* bootstrap package updates

* renaming file convention

* general outline of help outline

* bitwarden help cleanup

* article cleanup

* article general styling complete

* bootstrap help page upgrades

* sidebar updates

* toc dynamic and more updates

* fix callout conditions

* sidebar collapse functionality added

* sidebar header toggle functionality

* sidebar article fixes

* Update sidebar.html

Fix sidebar Release Notes link.

* Update releasenotes.md

Remove unnecessary category tag.

* Delete release-notes.md

Remove unnecessary category.

* Update why-choose-bitwarden-for-your-team.md

Test table image differentiation

* Update why-choose-bitwarden-for-your-team.md

Second image differentiation test

* removed links from category breadcrumb and replaced with badges

Co-authored-by: fred_the_tech_writer <69817454+fschillingeriv@users.noreply.github.com>
2020-11-13 14:23:00 -08:00

5.1 KiB
Raw Blame History

layout, title, categories, featured, popular, tags
layout title categories featured popular tags
article Set up two-step login with YubiKey
account-management
false false
two-step login
2fa
two factor authentication
account
yubikey
yubi
yubico

Bitwarden supports two-step login via YubiKey{:target="_blank"}. Any YubiKey that supports OTP capabilities{:target="_blank"} can be used. This includes all YubiKey 4 and 5 series devices as well as YubiKey NEO and YubiKey NFC.

{% callout info %} Due to platform limitations, YubiKeys cannot be used on all Bitwarden applications. You should enable another two-step login provider so that you can access your account when YubiKeys cannot be used.

Supported platforms:

  • Web vault on a device with a USB port that can accept your YubiKey.
  • Browser extensions on a device with a USB port that can accept your YubiKey.
  • Desktop app on a device with a USB port that can accept your YubiKey.
  • CLI on a device with a USB port that can accept your YubiKey.
  • Android on a device with NFC capabilities{:target="_blank"} or a USB port that can accept your YubiKey. Read more here{:target="_blank"}.
  • iOS on a device with NFC capabilities{:target="_blank"} or via lightning port with YubiKey 5Ci. {% endcallout %}

Enable Two-step Login with YubiKey

{% callout warning %} Two-step login can permanently lock you out of your account. It is very important that you write down and keep your [two-step login recovery code]({% link _articles/account/lost-two-step-device.md %}) in a safe place in the event that you lose access to your YubiKey. {% endcallout %}

  1. Log in to the web vault at https://vault.bitwarden.com

  2. Click Settings in the top navigation bar, then click Two-step Login from the side menu.

  3. Select the Manage button for the YubiKey OTP Security Key option and then type in your master password to continue. {% image two-step/yubikey/select.png %}

  4. Follow the instructions shown:

    • Plug the YubiKey (NEO, 4, or 5 series) into your computer's USB port.
    • Select in the first empty Key input field.
    • Touch the YubiKey's button.

    Repeat this process for each YubiKey you wish to add to your account. You can add up to five YubiKeys to your account. {% image two-step/yubikey/config.png %}

  5. If you are using a YubiKey that has NFC capabilities (YubiKey NEO or YubiKey 5 NFC), check the One of my keys supports NFC checkbox. This option enables the use of your YubiKey on Android and iOS devices that support NFC.

  6. Click the Enable button. A green alert will appear at the top stating that two-step login has been enabled.

  7. Click the Close button and confirm that the YubiKey OTP Security Key option now shows as Enabled. {% image two-step/yubikey/enabled.png %}

Test

  1. IMPORTANT: Ensure that you have copied down your [two-step login recovery code]({% link _articles/account/lost-two-step-device.md %}) in case something goes wrong.

  2. Log out of the Bitwarden web vault.

  3. Log back into the Bitwarden web vault. You should now be prompted with a YubiKey two-step login option. Insert your YubiKey and touch its button to complete logging in.

  4. Log out of and back in to any other Bitwarden applications that you are using to confirm that two-step login via YubiKey is properly working. You will eventually be logged out automatically. If the application (or device) your are using does not support YubiKey you will be presented with other two-step login options that you have configured (if any).

    Web {% image two-step/yubikey/web.png %}

    Desktop {% image two-step/yubikey/desktop.png %}

    Browser extension {% image two-step/yubikey/browser.png %}

    Android {% image two-step/yubikey/android.png %}

    iOS {% image two-step/yubikey/ios.png %}

Android

If you are having trouble getting the YubiKey NEO or YubiKey 5 NFC to work on your Android device, confirm the following:

  1. You have checked the One of my keys supports NFC checkbox from step 5 above.
  2. Your Android device supports NFC{:target="_blank"} and is known to work properly{:target="_blank"} with YubiKey NEO or YubiKey 5 NFC.
  3. You have NFC enabled on your Android device. Enable NFC by going to Android Settings → More and enable the NFC option.
  4. Your keyboard layout/format/mode is set to QWERTY.

If the YubiKey NEO or YubiKey 5 NFC can be used on your Android device you will be prompted with a YubiKey option while logging in to Bitwarden. Simply place the YubiKey on the back of your Android device near the NFC receiver. If you do not know where your NFC receiver is located, you may need to move it around some, trying different areas. Once Bitwarden detects the YubiKey it will automatically validate and log you in.