Nitropy nk3 test

README.md

@@ -41,6 +41,12 @@ Before pushing your changes to the Github repository, commit often and test the
 
 ## Local Preview
 
+Install virtualenv with pip:
+
+```
+pip install virtualenv
+```
+
 Setup Sphinx and components:
 
 ```

nitrokey3/faq.rst

@@ -10,7 +10,8 @@ Nitrokey 3 FAQ
 **Q:** How can I check if my Nitrokey 3 is working?
    On `WebAuthn.io`_ you can check various high-level functionalities, while
    `webautn.bin.coffee`_ provides good developer level details (technical)
-   details. 
+   details.
+   You can also `test`_ your Nitrokey.
 
 **Q:** Where is the right spot for NFC on my smartphone?
    Use `nfc.fail`_ to find the right spot!
@@ -48,4 +49,5 @@ Nitrokey 3 FAQ
 **Q:** How to use Nitrokey 3 with Azure Entra ID (Active Directory)?
    After `disabling Enforce Attestation`_ Nitrokey 3 is supported by Azure Entra ID out of the box.
 
-.. include:: ../shared-faqs/hyperlinks.rst.inc 
+.. include:: ../shared-faqs/hyperlinks.rst.inc 
+.. _test: ../nitrokey3/test.html

nitrokey3/index.rst

@@ -21,7 +21,8 @@ First check the:
    :glob:
 
    Frequently Asked Questions <faq>
-
+   Test <test>
+
 Or choose your operating system:
 
 .. toctree::

nitrokey3/test.rst

@@ -0,0 +1,31 @@
+Test
+====
+
+This guide describes how to test the Nitrokey 3.
+
+
+1. Make sure you have the latest `pynitrokey` version installed, please check the `installation instructions`_ for your OS.
+2. Run ``nitropy nk3 test`` this will launch several tests over your key.
+3. During the test, when asked touch the key.
+
+This is an example of a working key::
+
+   $ nitropy nk3 test 
+   Command line tool to interact with Nitrokey devices 0.4.46
+   Found 1 Nitrokey 3 device(s):
+   - Nitrokey 3 at /dev/hidraw2
+   Running tests for Nitrokey 3 at /dev/hidraw2
+   [1/5]   uuid            UUID query                      SUCCESS         DBA5FA34F3DE6F579F26FC62CD8C6F5D
+   [2/5]   version         Firmware version query          SUCCESS         v1.6.0
+   [3/5]   status          Device status                   SUCCESS         Status(init_status=<InitStatus.0: 0>, ifs_blocks=42, efs_blocks=465, variant=<Variant.LPC55: 1>)
+   Running SE050 test: |                                                                                                                                
+   [4/5]   se050           SE050                           SKIPPED         Testing SE050 functionality is not supported by the device
+   Please press the touch button on the device ...
+   Please press the touch button on the device ...
+   [5/5]   fido2           FIDO2                           SUCCESS  
+   5 tests, 4 successful, 1 skipped, 0 failed
+   Summary: 1 device(s) tested, 1 successful, 0 failed
+
+
+.. _installation instructions: ../software/nitropy/all-platforms/installation.html
+

nitrokey3/troubleshooting.rst.inc

@@ -1,12 +1,6 @@
 Troubleshooting
 ===============
 
-.. contents:: :local:
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
 Here you will find a collection of common issues.
 
 

software/nitropy/all-platforms/installation.rst

@@ -25,7 +25,7 @@ Before installing nitropy, you have to install and configure pipx::
     python3 -m pip install --user pipx
     python3 -m pipx ensurepath
 
-See the `pipx Installation Guide <https://pypa.github.io/pipx/installation/>`__ for more information.
+See the `pipx Installation Guide <https://pipx.pypa.io/stable/>`__ for more information.
 
 .. note::
    **For Linux Users** - currently a transient dependency (``oscrypto``) is generating issues on some Linux distrubutions.