Update keepassxc.rst

Nitrokey · Apr 3, 2024 · 548fb4a · 548fb4a
1 parent a8e56fa
commit 548fb4a
Showing 1 changed file with 22 additions and 41 deletions.
diff --git a/software/nk-app2/keepassxc.rst b/software/nk-app2/keepassxc.rst
@@ -2,28 +2,20 @@ KeePassXC
 =========
 .. _keepassxc:
 
-KeePassXC protected with Nitrokey 3:
-
-More information about `KeePassXC  <https://keepassxc.org/>`__:
+These instructions describe how to protect and encrypt a `KeePassXC <https://keepassxc.org/>`__ password database with Nitrokey 3.
 
 .. note::
 
-    The protection of a KeePassXC database with a Nitrokey 3
-    is supported since **KeePassXC version 2.7.6**.
-
-.. important::
-
-    * The Nitrokey 3 can be used as the only factor to unlock the KeePassXC database. 
-    * The Nitrokey 3 can be used as a second factor in addition to a passphrase to unlock the KeePassXC database.
+    KeePassXC version 2.7.6 or newer is required.
 
-    .. warning::
+.. warning::
 
-       The database can no longer be unlocked if the Nitrokey 3 is lost or unavailable! Thus, you may want to set up a second Nitrokey 3 with the same HMAC secret as a backup device.  
+    The database can no longer be unlocked if the Nitrokey 3 is lost or unavailable! Thus, you may want to set up a second Nitrokey 3 with the same HMAC secret as a backup device.  
 
 First Step: Generate a HMAC Secret With the Nitrokey App 2
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-1. Open Nitrokey App 2
+1. Open `Nitrokey App 2 </software/nk-app2/>`__
 2. Select the Nitrokey 3
 3. Select the ``PASSWORDS`` tab
 4. Click on ``ADD`` to create a new credential
@@ -34,17 +26,14 @@ First Step: Generate a HMAC Secret With the Nitrokey App 2
     - The credential is automatically named in ``HmacSlot2``.
     - No extra attributes can be saved for the HMAC credential.
     - The HMAC secret must be *exactly 20 bytes* long and in *Base32* format. That is exactly 32 characters.
-    - It is possible to save 1 HMAC secret on a Nitrokey 3.
+    - It is possible to save exactly one HMAC secret on a Nitrokey 3.
 
 6. To generate a secret, there is a button in the field on the right-hand. 
-   It is also possible to enter your own secret that conforms.
+   It is also possible to enter your own secret, as long as it is compliant.
 
 .. important::
 
-    * The secret can **only** be seen before saving.
-    * If the KeePassXC database is to be used with another Nitrokey 3,
-      the challenge-response secret must be copied; 
-      this is **only** possible **before saving** the credential.
+    The secret can **only** be seen before saving. If the KeePassXC database is to be used with another Nitrokey 3, the challenge-response secret must be copied which is **only** possible **before saving** the credential.
 
 7. Click on ``SAVE`` to save the credential
 
@@ -56,50 +45,42 @@ First Option: Protect an Existing KeePassXC Database With a Nitrokey 3
 3. Select ``Database`` -> ``Database Security...`` from the menu bar
 4. Select ``Security`` on the left side
 5. Click on the ``Add additional protection...`` button in the ``Database Credentials`` tab
-6. Scroll down to ``Challenge-Response``
-   -> Click on ``Add Challenge-Response``
+6. Scroll down to ``Challenge-Response`` and click on ``Add Challenge-Response``
 7. Now if the Nitrokey 3 is plugged in and a HMAC was generated before, Nitrokey 3 should be displayed in the field.
 
-   Click on ``OK`` to to add the Nitrokey 3 to the existing KeePassXC database
+   Click on ``OK`` to add the Nitrokey 3 to the existing KeePassXC database
 
 .. note::
 
-    * If the Nitrokey 3 is added to ``Add Challenge-Response``, it is the second factor in addition to the passphrase of a two-factor authorization to protect the KeePassXC database.
-    * If the database is only to be protected by the Nitrokey 3, the passphrase on the button ``Remove Password`` can be deleted.
+    By default the Nitrokey 3 is used as a second factor in addition to the passphrase. To protect the database by the Nitrokey 3 exclusively, delete the passphrase by clicking the button ``Remove Password``.
 
 .. tip::
 
-    If the Nirokey 3 is not recognized, close KeePassXC again completely.
-    Before restarting KeePassXC, connect the Nitrokey 3 to the PC.
+    If the Nirokey 3 is not recognized, close KeePassXC completely. Then connect the Nitrokey 3 to your computer before restarting KeePassXC.
 
 
 
-Second Option: Creating a KeePassXC Database, protected by Nitrokey 3
+Second Option: Creating a KeePassXC Database, Protected by Nitrokey 3
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 1. Open KeePassXC 
-2. Select ``Database`` -> ``New Database...`` from the menu bar.
-   Or use the keyboard shortcut ``Ctrl+Shift+N`` to create a new KeePassXC database.
+2. Select ``Database`` -> ``New Database...`` from the menu bar to create a new KeePassXC database.
 3. Fill in the display name and an optional description for your new database and click on ``Continue``
-4. Further database encryption settings can now be configured here or the default settings can be retained.
-   The settings can also be changed later in the database settings. `More Information <https://keepassxc.org/docs/>`__
+4. `Further database encryption settings <https://keepassxc.org/docs/>`__ can now be configured here or the default settings can be retained.
+   The settings can also be changed later in the database settings. 
 
    Click on ``Continue`` to confirm the settings
 5. **Database Credential**
 
-   Here you can now enter a password as a second factor to unlock the database.
-   To connect the Nitrokey 3 on which the HMAC secret was generated to the new KeePassXC database,
-   click on ``Add additional protection...``
-6. Scroll down to ``Challenge-Response``
-   Click on ``Add Challenge-Response``
+   Here you can enter a password as a second factor to unlock the database.
+   To connect the Nitrokey 3 (on which the HMAC secret was generated) to the new KeePassXC database, click on ``Add additional protection...``
+6. Scroll down to ``Challenge-Response`` and click on ``Add Challenge-Response``
 7. Now if the Nitrokey 3 is plugged in and a HMAC was generated before, Nitrokey 3 should be displayed in the field.
-   Click on ``Continue`` to complete the creation of the new KeePassXC database
+   Click on ``Continue`` to complete the creation of the new KeePassXC database.
 
 .. note::
 
-    * If the database is only to be protected by the Nitrokey 3, the passphrase can simply be left empty.
-    * If a passphrase is also entered, the Nitrokey 3 is the second factor of the two-factor authorization to protect the KeePassXC database.
+    If the passphrase is left empty, the database will be protected by the Nitrokey 3 exclusively. If a passphrase is entered, the database will be protected by the passphrase **and** the Nitrokey 3.
 
 .. tip::
 
-    If the Nirokey 3 is not recognized, close KeePassXC again completely.
-    Before restarting KeePassXC, connect the Nitrokey 3 to the PC.
+    If the Nitrokey 3 is not recognized, close KeePassXC completely. Then connect the Nitrokey 3 to your computer before restarting KeePassXC.