diff --git a/README.md b/README.md index 0a27b5caca..2b2a679a22 100644 --- a/README.md +++ b/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: ``` diff --git a/nitrokey3/faq.rst b/nitrokey3/faq.rst index 26d8820bae..4a4c6f4681 100644 --- a/nitrokey3/faq.rst +++ b/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 \ No newline at end of file +.. include:: ../shared-faqs/hyperlinks.rst.inc +.. _test: ../nitrokey3/test-your-nk3.html diff --git a/nitrokey3/index.rst b/nitrokey3/index.rst index 72de859ee9..3e39d90e53 100644 --- a/nitrokey3/index.rst +++ b/nitrokey3/index.rst @@ -15,7 +15,8 @@ First check the: :glob: Frequently Asked Questions - + Test your nitrokey3 + Or choose your operating system: .. toctree:: diff --git a/nitrokey3/test-your-nk3.rst b/nitrokey3/test-your-nk3.rst new file mode 100644 index 0000000000..de92259037 --- /dev/null +++ b/nitrokey3/test-your-nk3.rst @@ -0,0 +1,31 @@ +Test your NitroKey 3 +==================== + +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=, ifs_blocks=42, efs_blocks=465, variant=) + 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 + diff --git a/nitrokey3/troubleshooting.rst.inc b/nitrokey3/troubleshooting.rst.inc index 91bbb14cfa..408e3e2bf7 100644 --- a/nitrokey3/troubleshooting.rst.inc +++ b/nitrokey3/troubleshooting.rst.inc @@ -1,12 +1,6 @@ Troubleshooting =============== -.. contents:: :local: - -.. toctree:: - :maxdepth: 1 - :glob: - Here you will find a collection of common issues. diff --git a/software/nitropy/all-platforms/installation.rst b/software/nitropy/all-platforms/installation.rst index 61fab0de39..35a691e916 100644 --- a/software/nitropy/all-platforms/installation.rst +++ b/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 `__ for more information. +See the `pipx Installation Guide `__ for more information. .. note:: **For Linux Users** - currently a transient dependency (``oscrypto``) is generating issues on some Linux distrubutions. diff --git a/storage/images/good_test_result.png b/storage/images/good_test_result.png new file mode 100644 index 0000000000..6847a37418 Binary files /dev/null and b/storage/images/good_test_result.png differ