nkapp2 doc update

source/components/software/nk-app2/getting-started.rst

@@ -0,0 +1,29 @@
+Getting Started
+===============
+
+Home Page
+*********
+
+The home page allows quick access to essential functions, including checking the current app version, saving log files, and getting support.
+
+.. figure:: ./images/home-page.png
+
+App Version
+***********
+
+To ensure you are using the latest version of the application, click “Check for App Update.”
+
+.. figure:: ./images/app-version.png
+
+if no updates are available, the button will display “App is up to date.”
+
+Log File
+********
+
+The “Save Log File” option lets you export a record of the application’s recent activity, including actions, errors, and system messages. This log file can help diagnose and resolve issues with the application.
+
+Need Help?
+**********
+
+Click the “?” icon or "Instructions and help" link on the home page for quick access to help content and troubleshooting.
+

source/components/software/nk-app2/index.rst

@@ -1,6 +1,13 @@
 Nitrokey App 2
 ==============
-Nitrokey App 2 is the graphical application for Nitrokey 3 devices. For Nitrokey Pro and Nitrokey Storage, use `Nitrokey App 1 <https://www.nitrokey.com/download>`__ instead.
+Nitrokey App 2 is the graphical application for Nitrokey 3 devices. For Nitrokey Pro and Nitrokey Storage, use  instead.
+
+The Nitrokey App 2 is a graphical application designed to manage Nitrokey 3 devices. It provides a user-friendly interface for configuring FIDO2 authentication, password storage, firmware updates, and PIN management.
+Available languages: English, German, French, Italian, Polish, and Arabic. Language change requires application restart.
+
+.. note::
+
+   This application is compatible only with Nitrokey 3 devices. For Nitrokey Pro and Nitrokey Storage devices, please use `Nitrokey App 1 <https://www.nitrokey.com/download>`__.
 
 Installation
 ------------

source/components/software/nk-app2/passwords.rst

@@ -23,3 +23,63 @@ Entries are divided into two categories: unprotected (shown as an open lock) and
 You can choose to create a protected entry by checking the "Protect with PIN" box when adding a new entry.
 
 You also have the option to require user presence in the form of a required touch on the Nitrokey 3 to access the entry by checking the "Require User Presence" box.
+
+Store and Manage Various Credentials
+------------------------------------
+
+When adding credentials in the Passwords tab, select an algorithm from the drop down menu. Plain usernames using a password, HOTPs, TOTPs, and HMAC are all supported.
+
+.. figure:: ./images/credential-example.png
+
+Select the “None” option to skip two-factor authentication and use a standard username and password combination. Enter a username and a password that only you know, as shown in the example above. The method relies solely on your password for authentication.
+
+Password Algorithms
+*******************
+
+To use a password algorithm, go to security settings of the application you want to secure and enable two-factor authentication. Choose the “Authenticator App” or “Manual Setup” option if available. 
+
+The service will show a secret key. Copy this secret key to enter into your credential setup. Open the password manager app and add a new credential. Choose the algorithm you want to use and paste the secret key. Save the credential.
+
+TOTP
+++++
+
+A two-factor authentication code that changes at regular time intervals. Enter the shared secret key into the field provided.
+
+.. figure:: ./images/TOTP-secret.png
+
+After the credential is saved, click the “OTP” button to generate a 6 digit code that expires in 60 seconds. The system you’re logging into generates the same code using the shared key and current time to verify your identity.
+
+.. figure:: ./images/TOTP-code.png
+
+HOTP
+++++
+
+A two factor authentication code that changes each time you trigger it. Enter the shared secret key into the field provided.
+
+.. figure:: ./images/HOTP-secret.png
+
+Once the credential is saved, click the “OTP” button to generate a 6 digit code based on a counter. The system you’re logging into uses the same counter and key to verify the code. The counter only increases when the code is used, press the button again to generate a new code.
+
+.. figure:: ./images/HOTP-code.png
+
+HMAC
+++++
+
+A security method used to confirm that data is authentic and has not been altered by combining a secret key with a message. Enter the shared secret key in the field provided or click the refresh button to have the app generate a secret key for you.
+
+.. figure:: ./images/HMAC-secret.png
+
+Once the credential is saved, the app will use a hash function to generate a code and verify the integrity of your message based on your secret key. 
+
+Verification Requirements
+*************************
+
+If a PIN has been set, it must be entered before making any changes. You are allowed only 8 attempts before lockout.
+
+For certain actions, you will be prompted to press your Nitrokey to continue. Watch for a flashing green light on your Nitrokey device and icon.
+
+.. figure:: ./images/flashing-green-icon.png
+
+You may also apply these additional settings to your credentials when creating them. Simply check the boxes for any options you wish to enable.
+
+.. figure:: ./images/additional-settings.png

source/components/software/nk-app2/pin.rst

@@ -1,7 +1,8 @@
-PIN Settings for FIDO2 and OTP in the Nitrokey App 2
-====================================================
+PIN Managment
+=============
 
-These instructions describe how to set or change the PINs for FIDO2 and OTP in the Nitrokey App 2. 
+To enhance security, PINs can be created to restrict access to FIDO2 features and password storage.
+Click the “settings” tab to create, edit, or reset your PINs. 
 
 Prerequisite
 ^^^^^^^^^^^^
@@ -20,28 +21,46 @@ First Steps:
 3. Select the ``SETTINGS`` tab.
 4. On the left-hand side of the ``SETTINGS`` tab, a tree structure with various options is available. 
 
-FIDO2 PIN Settings
-^^^^^^^^^^^^^^^^^^
+FIDO2
+^^^^^
 
-1. Select ``FIDO2``.
-    * A branch with ``FIDO2 PIN SETTINGS`` opens below ``FIDO2``. The status of the FIDO2 PIN is now available on the left-hand side of the ``SETTINGS`` tab, including a short description.
-2. Select ``FIDO2 PIN SETTINGS`` to set or change the PIN. 
+FIDO2 is an authentication standard that enables secure and password-less access to online services.
+
+.. figure:: ./images/FIDO2-menu.png
+
+Click the “FIDO2” drop down menu to change your PIN or remove any previous set credentials with the factory reset option. 
+
+.. Note::
+
+    Factory reset for FIDO2 can only be done within 10 seconds of plugging in your device.
+
+1. Select ``Pin Change`` to set or change the PIN. 
     * Depending on the status of the Fido2 PIN, the input mask for setting or changing the PIN is now displayed. 
-3. To set the FIDO2 PIN, enter the new PIN and repeat it in the provided boxes. To change the PIN, enter the current PIN in the box provided.
+2. To set the FIDO2 PIN, enter the new PIN and repeat it in the provided boxes. To change the PIN, enter the current PIN in the box provided.
     * PIN length minimum 4 characters
     * If the repetition of the new PIN is not correct, it will not be accepted.
-4. Select the ``SAVE`` button.
+3. Select the ``SAVE`` button.
     * If the ``SAVE`` button is greyed out, the entries are not correct. 
     * When you hover over the ``SAVE`` button, a list of reasons is displayed.
     * The ``PIN_INVALID`` error message, when changing the PIN, indicates that the current PIN is incorrect. 
 
-OTP PIN Settings
-^^^^^^^^^^^^^^^^
+Passwords
+^^^^^^^^^
+
+Store various credentials and OTPs within passwords.
+
+.. figure:: ./images/password-menu.png
+
+Click the “Passwords” drop down menu to change your PIN or factory reset and remove all your credentials in Passwords.
+
+.. Note:: 
+
+    You will be asked to press your Nitrokey to confirm factory reset.
 
-1. Select ``OTP``.
-    * A branch with ``OTP PIN SETTINGS`` opens below ``OTP``. The status of the OTP PIN is now available on the left-hand side of the ``SETTINGS`` tab, including a short description.
+1. Select ``Passwords``.
+    * A branch with ``Pin Change`` opens below ``Passwords``. The status of the OTP PIN is now available on the left-hand side of the ``SETTINGS`` tab, including a short description.
     * Information about the version, serial number and PIN attempt counter is also available.
-2. Select ``OTP PIN SETTINGS`` to set or change the PIN. 
+2. Select ``Pin Change`` to set or change the PIN. 
     * Depending on the status of the OTP PIN, the input mask for setting or changing the PIN is now displayed. 
 3. To set the OTP PIN, enter the new PIN and repeat it in the provided boxes. To change the PIN, enter the current PIN in the box provided.
     * PIN length minimum 4 characters

source/components/software/nk-app2/update.rst

@@ -0,0 +1,19 @@
+Firmware Updates
+================
+
+Automatic Updates
+*****************
+
+Open the “overview” tab to automatically and manually update your device. Click “Check for Update”  button to start the automatic update process. The firmware files will be downloaded and used to update your Nitrokey. 
+
+.. figure:: ./images/overview.png
+
+Manual (Local) Update
+*********************
+
+If you have the firmware files already on your computer, click “More Options” to manually update the device with your local firmware.
+
+.. figure:: ./images/local-firmware.png
+
+.. important:: 
+    When updating your device, remove all other Nitrokey 3 devices except the one being updated.