Skip to content

Commit c54f599

Browse files
nkapp2 doc update (#493)
--------- Co-authored-by: jans23 <[email protected]>
1 parent c48d0e9 commit c54f599

File tree

12 files changed

+150
-64
lines changed

12 files changed

+150
-64
lines changed
20.3 KB
Loading
6.05 KB
Loading
4.14 KB
Loading
5.79 KB
Loading
47.8 KB
Loading
5.44 KB
Loading
60.6 KB
Loading
16.5 KB
Loading
Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
Nitrokey App 2
22
==============
3-
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.
3+
4+
The Nitrokey App 2 is a graphical application designed to manage Nitrokey 3 devices. It provides a user-friendly interface for configuring FIDO2 authentication, passwords, firmware updates, and PIN management.
5+
Available languages: English, German, French, Italian, Polish, and Arabic. Language change requires application restart.
6+
7+
.. note::
8+
9+
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>`__.
410

511
Installation
612
------------
7-
Download it for `Linux <installation-linux.html>`__ , `Windows <installation-windows.html>`__ or `macOS <installation-mac.html>`__ (pipenv only).
813

14+
Download it for `Linux <installation-linux.html>`__ , `Windows <installation-windows.html>`__ or `macOS <installation-mac.html>`__.
915

10-
Supported Features
11-
------------------
1216

13-
- Updating the firmware
14-
- One-Time Passwords (OTP)
15-
- Password Storage
17+
Getting Started
18+
---------------
1619

17-
Planned Features
18-
----------------
20+
- `Passwords <./passwords.html>`__
21+
- `PIN Managment <./pin.html>`__
22+
- `KeePassXC <./keepassxc.html>`__
23+
- `Firmware Update <./update.html>`__
1924

20-
- PIN management
21-
- macOS support
2225

2326
.. toctree::
2427
:maxdepth: 1
@@ -27,3 +30,24 @@ Planned Features
2730

2831
*
2932

33+
Overview
34+
--------
35+
36+
.. figure:: ./images/overview.png
37+
38+
39+
The overview allows quick access to check the current app version, saving log files, and getting support.
40+
41+
42+
App Version
43+
***********
44+
45+
To ensure you are using the latest version of the application, click “Check for App Update.”
46+
If no updates are available, the button will display “App is up to date.”
47+
If an update is available it will change the button text to "update available"
48+
And by clicking once more it will open the release GitHub page where the latest one is on top. From here you will be able to download the binary if you want to do perfom a manual install
49+
50+
Log File
51+
********
52+
53+
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.
Lines changed: 60 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,73 @@
11
Passwords
22
=========
33

4-
.. note::
5-
You can store up to 50 passwords.
6-
74
Password entries may consist of:
85

9-
* Login
6+
* Login name
107
* Password
118
* Comment (for e.g. a website reference)
12-
* OTP (HOTP or TOTP)
9+
* One-Time Passwords (HOTP and TOTP)
10+
* Hash-Based Message Authentication Code (HMAC)
11+
12+
.. note::
13+
14+
All fields are optional and can be edited and added at any time using the "Edit" button.
15+
16+
You can store up to 100 passwords.
17+
18+
.. figure:: ./images/credential-example.png
19+
20+
21+
Adding Credentials
22+
******************
23+
24+
1. To add a new entry click on the "Add" button.
25+
2. Enter your user name.
26+
3. Enter the password or OTP secret
27+
4. You can enter the web address to the field Comment.
28+
5. If you want to store a regular password, let "None" in the algorithm field. If you want to store a OTP or HMAC, choose the appropriate algorithm (see below) and copy the OTP secret or QR code that is given by the website (you want to login to) into the field next to it.
29+
30+
.. figure:: ./images/TOTP-secret.png
31+
32+
.. figure:: ./images/HOTP-secret.png
33+
34+
6. You can choose to add more security by checking the "Require PIN" or "Require Touch" boxes. Credentials with "Require PIN" (shown as a closed lock) can only be accessed by entering a device the PIN when clicking on "Show Protected Passwords". Unprotected credentials (shown as an open lock) can be accessed without entering a device PIN.
35+
36+
7. Once all desired fields are filled click on "Save".
37+
38+
.. Note::
39+
40+
You need first to set a device PIN before using "Require PIN". Otherwise it will show an error.
41+
The device PIN can be set or changed in the `settings <./pin.html#passwords>`__).
42+
43+
.. important::
44+
45+
You are allowed only 8 attempts to enter a device PIN otherwise you will not be able to access or create new credentials and you will need to perform a factory reset in order to use this feature again.
46+
47+
Login
48+
*****
49+
50+
Once your credential is stored you can login to your account with these steps:
51+
52+
1. Select on the left side your Nitrokey on which your credential is stored.
53+
2. Click on the "Passwords" tab.
54+
3. Click on your desired credential, if your credential is protected click on "Show Protected Passwords" first.
55+
4. If it's a regular password, copy the username and the password into the login prompt. If it's a OTP credential, click the “OTP” icon to generate the OTP and enter the OTP code into the appropriate field in the login prompt. (For HOTP, press the button again to generate a new code.)
56+
57+
.. figure:: ./images/TOTP-code.png
1358

14-
All fields are optional and can be edited and added at any time using the "Edit" button.
59+
OTP Algorithms
60+
**************
1561

16-
For a list of websites supporting OTP have a look at `dongleauth.com <https://www.dongleauth.com/>`__.
62+
One-Time Passwords (OTPs) are used as multi-factor authentication (MFA) designed to make it much harder for hackers to access protected information such as online accounts.
63+
With the Nitrokey App 2 and your Nitrokey you can use two different MFA:
1764

18-
Usage
19-
-----
65+
* TOTP or Time-based One-Time Password is a two-factor authentication code that changes at regular time intervals (e.g. 60 seconds). This is the standard typically used by websites.
66+
* HOTP or HMAC-based One-Time Password is a two factor authentication code that changes each time it's requested and validated. It is rarely used today.
67+
* HMAC is primarily used with KeePassXC.
2068

21-
Entries are divided into two categories: unprotected (shown as an open lock) and protected (shown as a closed lock). Unprotected entries can be accessed directly. Protected entries can only be accessed with the PIN.
69+
.. Note::
2270

23-
You can choose to create a protected entry by checking the "Protect with PIN" box when adding a new entry.
71+
For a list of websites supporting OTPs have a look at `dongleauth.com <https://www.dongleauth.com/>`__.
2472

25-
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.
73+
You can test TOTP with `this <https://authenticationtest.com/totpChallenge/>`__ website.

0 commit comments

Comments
 (0)