From 973cd6a98bb0f416fdb4c708da763a14da7153ab Mon Sep 17 00:00:00 2001 From: DougTW Date: Fri, 13 Sep 2019 15:54:13 -0700 Subject: [PATCH] Editorial changes to yubikey-u2f.rst (#785) Signed-off-by: DougTW --- source/tutorials/yubikey-u2f.rst | 71 +++++++++++++++----------------- 1 file changed, 34 insertions(+), 37 deletions(-) diff --git a/source/tutorials/yubikey-u2f.rst b/source/tutorials/yubikey-u2f.rst index db61e0a0..3d3c9805 100644 --- a/source/tutorials/yubikey-u2f.rst +++ b/source/tutorials/yubikey-u2f.rst @@ -1,44 +1,40 @@ .. _yubikey-u2f: -YubiKey\* Support +YubiKey\* Support ################# -YubiKey\* is a USB security token manufactured by `Yubico`_. Depending on the -model, a YubiKey can support different authentication protocols including: -One-Time Password (OTP), Smart card, FIDO2, and Universal 2nd Factor (U2F). - -These instructions will go over configuring a YubiKey for U2F authentication -through a web browser on a |CL-ATTR| system. - -A list of `websites -accepting U2F authentication with the YubiKey`_ is available on the Yubico -website. See the Yubico website to learn more about the Yubikey: -https://www.yubico.com/getstarted/meet-the-yubikey/ - - +This tutorial explains how to configure a YubiKey\* for U2F authentication +through a web browser on a |CL-ATTR| system. .. contents:: :local: :depth: 1 +Description +*********** +YubiKey is a USB security token manufactured by `Yubico`_. Depending on the +model, a YubiKey can support different authentication protocols including +One-Time Password (OTP), Smart card, FIDO2, and Universal 2nd Factor (U2F). -Prerequisites +A list of `websites that accept U2F authentication with the YubiKey`_ +is available on the Yubico website. See the Yubico website to learn more about +the Yubikey: https://www.yubico.com/getstarted/meet-the-yubikey/ + +Prerequisites ************* -This tutorial assumes you have: +This tutorial assumes you have: #. |CL| installed and running. -#. Mozilla Firefox installed on |CL|. +#. Mozilla Firefox installed on |CL|. #. A YubiKey. - - -Enable Linux udev rules for YubiKey +Enable Linux udev rules for YubiKey *********************************** -:command:`udev` is the Linux device manager which handles events when USB +:command:`udev` is the Linux device manager that handles events when USB devices are added and removed. Custom rules needs to be created to properly identify the YubiKey and provide applications access. @@ -47,45 +43,45 @@ YubiKey with Linux `_ -#. Create the udev rules folder under :file:`/etc` - +#. Create the udev rules folder under :file:`/etc`. + .. code:: bash - + sudo mkdir -p /etc/udev/rules.d/ #. Download the u2f rules from the Yubico GitHub: .. code:: bash - + curl -O https://raw.githubusercontent.com/Yubico/libu2f-host/master/70-u2f.rules - + #. Move the downloaded :file:`70-u2f.rules` file into the :file:`/etc/udev` - folder + folder. .. code:: bash - + sudo mv 70-u2f.rules /etc/udev/rules.d/ #. The udev rules should automatically be reloaded. However, they can be - manually reloaded or reboot the system: + manually reloaded or you can reboot the system. .. code:: bash - + sudo udevadm control --reload-rules && sudo udevadm trigger -#. Plugin and validate the YubiKey appears as a USB device: +#. Plugin and validate the YubiKey appears as a USB device. .. code:: bash - + lsusb -Enable U2F in Mozilla Firefox +Enable U2F in Mozilla Firefox ***************************** Firefox comes with U2F web authentication support disabled by default. U2F @@ -102,12 +98,12 @@ support in Mozilla Firefox settings. .. code:: bash - + about:config #. Click the *I accept the risk!* button to continue to the advanced settings -#. Search for the :command:`security.webauth.u2f` and double-click it +#. Search for the :command:`security.webauth.u2f` and double-click it so *Value* becomes **true**. @@ -115,7 +111,7 @@ Your YubiKey is now usable on |CL| with Mozilla Firefox with websites that support U2F authentication. -Related topics +Related topics ************** - |CL| :ref:`security` @@ -123,4 +119,5 @@ Related topics .. _`Yubico`: https://www.yubico.com/ -.. _`websites accepting U2F authentication with the YubiKey`: https://www.yubico.com/works-with-yubikey/catalog/#protocol=universal-2nd-factor-(u2f)&usecase=all&key=all +.. _`websites that accept U2F authentication with the YubiKey`: +.. https://www.yubico.com/works-with-yubikey/catalog/#protocol=universal-2nd-factor-(u2f)&usecase=all&key=all