mostly finished nk3, still needs restructure of index and features + …

…some minor issues
Nitrokey · Jul 31, 2024 · 810e576 · 810e576
1 parent 494c83e
commit 810e576
Show file tree

Hide file tree

Showing 101 changed files with 45 additions and 228 deletions.
diff --git a/index.rst b/index.rst
@@ -8,7 +8,8 @@ Nitrokey Documentation
    nitrokeys/index
    hsm/index
    start/index
-   nitropadpc/index
+   nitropad/index
+   nitropc/index
    nitrophone/index
    nextbox/index
    nethsm/index

diff --git a/...s/desktop-login/images/smart-policy/1.png → ...gin/third-party/images/smart-policy/1.png b/...s/desktop-login/images/smart-policy/1.png → ...gin/third-party/images/smart-policy/1.png
diff --git a/...s/desktop-login/images/smart-policy/2.png → ...gin/third-party/images/smart-policy/2.png b/...s/desktop-login/images/smart-policy/2.png → ...gin/third-party/images/smart-policy/2.png
diff --git a/...s/desktop-login/images/smart-policy/3.png → ...gin/third-party/images/smart-policy/3.png b/...s/desktop-login/images/smart-policy/3.png → ...gin/third-party/images/smart-policy/3.png
diff --git a/...s/desktop-login/images/smart-policy/4.png → ...gin/third-party/images/smart-policy/4.png b/...s/desktop-login/images/smart-policy/4.png → ...gin/third-party/images/smart-policy/4.png
diff --git a/...s/desktop-login/images/smart-policy/5.png → ...gin/third-party/images/smart-policy/5.png b/...s/desktop-login/images/smart-policy/5.png → ...gin/third-party/images/smart-policy/5.png
diff --git a/...s/desktop-login/images/smart-policy/6.png → ...gin/third-party/images/smart-policy/6.png b/...s/desktop-login/images/smart-policy/6.png → ...gin/third-party/images/smart-policy/6.png
diff --git a/nitrokeys/features/desktop-login/index.rst → ...tures/desktop-login/third-party/index.rst b/nitrokeys/features/desktop-login/index.rst → ...tures/desktop-login/third-party/index.rst
diff --git a/nitrokeys/features/desktop-login/pam.rst → ...eatures/desktop-login/third-party/pam.rst b/nitrokeys/features/desktop-login/pam.rst → ...eatures/desktop-login/third-party/pam.rst
diff --git a/...s/features/desktop-login/smart-policy.rst → ...esktop-login/third-party/smart-policy.rst b/...s/features/desktop-login/smart-policy.rst → ...esktop-login/third-party/smart-policy.rst
diff --git a/nitrokeys/features/fido/2fa-nextcloud.rst → ...okeys/features/fido/2fa/2fa-nextcloud.rst b/nitrokeys/features/fido/2fa-nextcloud.rst → ...okeys/features/fido/2fa/2fa-nextcloud.rst
diff --git a/nitrokeys/features/fido/2fa-odoo.rst → nitrokeys/features/fido/2fa/2fa-odoo.rst b/nitrokeys/features/fido/2fa-odoo.rst → nitrokeys/features/fido/2fa/2fa-odoo.rst
diff --git a/nitrokeys/features/fido/2fa-website.rst → nitrokeys/features/fido/2fa/2fa-website.rst b/nitrokeys/features/fido/2fa-website.rst → nitrokeys/features/fido/2fa/2fa-website.rst
diff --git a/nitrokeys/features/fido/desktop-login.rst → ...okeys/features/fido/2fa/desktop-login.rst b/nitrokeys/features/fido/desktop-login.rst → ...okeys/features/fido/2fa/desktop-login.rst
diff --git a/nitrokeys/features/fido/images/fidou2f-1.png → ...ys/features/fido/2fa/images/fidou2f-1.png b/nitrokeys/features/fido/images/fidou2f-1.png → ...ys/features/fido/2fa/images/fidou2f-1.png
diff --git a/nitrokeys/features/fido/images/fidou2f-2.png → ...ys/features/fido/2fa/images/fidou2f-2.png b/nitrokeys/features/fido/images/fidou2f-2.png → ...ys/features/fido/2fa/images/fidou2f-2.png
diff --git a/nitrokeys/features/fido/images/fidou2f-3.png → ...ys/features/fido/2fa/images/fidou2f-3.png b/nitrokeys/features/fido/images/fidou2f-3.png → ...ys/features/fido/2fa/images/fidou2f-3.png
diff --git a/nitrokeys/features/fido/images/fidou2f-4.png → ...ys/features/fido/2fa/images/fidou2f-4.png b/nitrokeys/features/fido/images/fidou2f-4.png → ...ys/features/fido/2fa/images/fidou2f-4.png
diff --git a/nitrokeys/features/fido/images/fidou2f-5.png → ...ys/features/fido/2fa/images/fidou2f-5.png b/nitrokeys/features/fido/images/fidou2f-5.png → ...ys/features/fido/2fa/images/fidou2f-5.png
diff --git a/...s/features/fido/images/u2f-fido-pam-2.png → ...atures/fido/2fa/images/u2f-fido-pam-2.png b/...s/features/fido/images/u2f-fido-pam-2.png → ...atures/fido/2fa/images/u2f-fido-pam-2.png
diff --git a/nitrokeys/features/fido/index.rst → nitrokeys/features/fido/2fa/index.rst b/nitrokeys/features/fido/index.rst → nitrokeys/features/fido/2fa/index.rst
diff --git a/nitrokeys/features/openpgp/index.rst b/nitrokeys/features/openpgp/index.rst
@@ -52,6 +52,8 @@ You can find further information about the usage on these pages:
 -  to use `OpenPGP encryption with
    Outlook <openpgp-outlook.html>`_
 
+- `OpenPGP Touch Confirmation (Nitrokey 3 only) <uif.html>`_
+
 -  to use `Claws
    Mail <https://www.claws-mail.org/plugin.php?plugin=gpg>`__, an email
    client (and news reader) for Linux and Windows

diff --git a/...keys/nitrokey3/shared/openpgp-uif.rst.inc → nitrokeys/features/openpgp/uif.rst b/...keys/nitrokey3/shared/openpgp-uif.rst.inc → nitrokeys/features/openpgp/uif.rst
diff --git a/.../nitrokey3/windows/piv/access_control.rst → nitrokeys/features/piv/access_control.rst b/.../nitrokey3/windows/piv/access_control.rst → nitrokeys/features/piv/access_control.rst
diff --git a/...y3/windows/piv/certificate_management.rst → ...s/features/piv/certificate_management.rst b/...y3/windows/piv/certificate_management.rst → ...s/features/piv/certificate_management.rst
diff --git a/...s/nitrokey3/windows/piv/factory_reset.rst → nitrokeys/features/piv/factory_reset.rst b/...s/nitrokey3/windows/piv/factory_reset.rst → nitrokeys/features/piv/factory_reset.rst
diff --git a/...es/client_logon_with_active_directory.rst → ...es/client_logon_with_active_directory.rst b/...es/client_logon_with_active_directory.rst → ...es/client_logon_with_active_directory.rst
diff --git a/...ys/nitrokey3/windows/piv/guides/index.rst → nitrokeys/features/piv/guides/index.rst b/...ys/nitrokey3/windows/piv/guides/index.rst → nitrokeys/features/piv/guides/index.rst
diff --git a/nitrokeys/nitrokey3/windows/piv/index.rst → nitrokeys/features/piv/index.rst b/nitrokeys/nitrokey3/windows/piv/index.rst → nitrokeys/features/piv/index.rst
diff --git a/.../nitrokey3/windows/piv/key_management.rst → nitrokeys/features/piv/key_management.rst b/.../nitrokey3/windows/piv/key_management.rst → nitrokeys/features/piv/key_management.rst
diff --git a/nitrokeys/index.rst b/nitrokeys/index.rst
@@ -9,3 +9,4 @@ Nitrokeys
     Pro <pro/index>
     Storage <storage/index>
     Start <start/index>
+    Nitrokey3 <nitrokey3/index>
diff --git a/nitrokeys/nitrokey3/features.rst b/nitrokeys/nitrokey3/features.rst
@@ -27,6 +27,11 @@ features are realized.
      - USB
      - yes
 
+   * - `SMIME`_
+     - Asymmetric cryptography; keep your private key(s) secure; email encryption
+     - USB
+     - yes
+
    * - `Password Safe`_
      - (One-Time-)Passwords securely stored on your Nitrokey 3
      - USB
@@ -70,15 +75,16 @@ data migrations from test to stable firmwares will not be implemented.**
      - no
 
 
-.. _FIDO2: https://github.com/Nitrokey/fido-authenticator
-.. _OpenPGP Card: https://github.com/Nitrokey/opcard-rs
+.. _FIDO2: ../features/fido/index.html
+.. _OpenPGP Card: ../features/openpgp/index.html
 .. _Password Safe: https://github.com/Nitrokey/trussed-secrets-app
 .. _Admin App: https://github.com/Nitrokey/admin-app
-.. _PIV: https://github.com/Nitrokey/piv-authenticator
+.. _PIV: ../features/piv/index
 .. _WebSmartCard: https://github.com/Nitrokey/nitrokey-websmartcard
+.. _SMIME: ../features/smime/index.html
 
-.. _pynitrokey: ../software/nitropy
-.. _NitrokeyApp2: ../software/nk-app2
+.. _pynitrokey: ../software/nitropy/index.html
+.. _NitrokeyApp2: ../software/nk-app2/index.html
 
 .. _Test Firmware: linux/firmware-update#firmware-release-types
 

diff --git a/nitrokeys/nitrokey3/firmware-update.rst.inc → nitrokeys/nitrokey3/firmware-update.rst b/nitrokeys/nitrokey3/firmware-update.rst.inc → nitrokeys/nitrokey3/firmware-update.rst
@@ -88,3 +88,18 @@ Examples:
 
 This is mostly relevant for users that rely on a feature from the test releases.
 Users of the stable firmware can always update to the latest available firmware version.
+
+Troubleshooting (Linux):
+----------------
+
+**Issue:** I get ``permission denied for /dev/hidrawX`` during update.
+  This likely means your user has not the needed permissions to
+  read/write the device. Please make sure you have set up the correct
+  `udev-rules`_. Download this `udev-rules`_ set and place it in your
+  udev rules directory (e.g., ``/etc/udev/rules.d``). Then remove
+  your Nitrokey 3 from the USB slot and run: 
+  ``udevadm control --reload-rules && udevadm trigger`` or reboot
+  your machine. Afterwards the update should work without the 
+  permission issue.
+
+.. _udev-rules: https://raw.githubusercontent.com/Nitrokey/libnitrokey/master/data/41-nitrokey.rules
diff --git a/nitrokeys/nitrokey3/index.rst b/nitrokeys/nitrokey3/index.rst
@@ -3,28 +3,15 @@ Nitrokey 3
 
 .. contents:: :local:
 
-
-The Nitrokey 3 currently supports:
-
-* FIDO2
-* Password-Safe & One-Time Passwords (OTP)
-* OpenPGP Card (`Secure Element Backend or Software Backend`_)
-
-Additional features like PIV are available in test firmware releases. See the `release notes`_ on GitHub for more information.
-
-.. _Secure Element Backend or Software Backend: faq#how-can-I-use-the-se050-secure-element
-.. _release notes: https://github.com/Nitrokey/nitrokey-3-firmware/releases
-
 First check the:
 
 .. toctree::
    :maxdepth: 1
    :glob:
 
    Frequently Asked Questions <faq>
-   features
+   Getting Started <getting-started>
 
-Or choose your operating system:
 
 or check out the features:
 
@@ -33,4 +20,15 @@ or check out the features:
    :glob:
 
    Features <features>
+   set pin <set-pins>
+   firmware-update <firmware-update>
+   main <main>
+   nitropy <nitropy>
+   desktop login <../features/desktop-login/index>
+   reset <reset>
+   passwordless microsoft <../features/fido/passwordless-microsoft>
 
+Additional features like PIV (Windows only) are available in test firmware releases. See the `release notes`_ on GitHub for more information.
+
+.. _Secure Element Backend or Software Backend: faq#how-can-I-use-the-se050-secure-element
+.. _release notes: https://github.com/Nitrokey/nitrokey-3-firmware/releases
diff --git a/nitrokeys/nitrokey3/linux/keepassxc.rst → nitrokeys/nitrokey3/keepassxc.rst b/nitrokeys/nitrokey3/linux/keepassxc.rst → nitrokeys/nitrokey3/keepassxc.rst
diff --git a/nitrokeys/nitrokey3/linux/2fa-odoo.rst b/nitrokeys/nitrokey3/linux/2fa-odoo.rst
diff --git a/nitrokeys/nitrokey3/linux/adsk.rst b/nitrokeys/nitrokey3/linux/adsk.rst
diff --git a/nitrokeys/nitrokey3/linux/desktop-login.rst b/nitrokeys/nitrokey3/linux/desktop-login.rst
diff --git a/nitrokeys/nitrokey3/linux/firmware-update.rst b/nitrokeys/nitrokey3/linux/firmware-update.rst
diff --git a/nitrokeys/nitrokey3/linux/images b/nitrokeys/nitrokey3/linux/images
diff --git a/nitrokeys/nitrokey3/linux/index.rst b/nitrokeys/nitrokey3/linux/index.rst
diff --git a/nitrokeys/nitrokey3/linux/nitropy.rst b/nitrokeys/nitrokey3/linux/nitropy.rst
diff --git a/nitrokeys/nitrokey3/linux/openpgp-keygen-backup.rst b/nitrokeys/nitrokey3/linux/openpgp-keygen-backup.rst
diff --git a/nitrokeys/nitrokey3/linux/openpgp-keygen-gpa.rst b/nitrokeys/nitrokey3/linux/openpgp-keygen-gpa.rst
diff --git a/nitrokeys/nitrokey3/linux/openpgp-keygen-on-device.rst b/nitrokeys/nitrokey3/linux/openpgp-keygen-on-device.rst
diff --git a/nitrokeys/nitrokey3/linux/openpgp-outlook.rst b/nitrokeys/nitrokey3/linux/openpgp-outlook.rst
diff --git a/nitrokeys/nitrokey3/linux/openpgp-thunderbird.rst b/nitrokeys/nitrokey3/linux/openpgp-thunderbird.rst
diff --git a/nitrokeys/nitrokey3/linux/openpgp-uif.rst b/nitrokeys/nitrokey3/linux/openpgp-uif.rst
diff --git a/nitrokeys/nitrokey3/linux/openpgp.rst b/nitrokeys/nitrokey3/linux/openpgp.rst
diff --git a/nitrokeys/nitrokey3/linux/reset.rst b/nitrokeys/nitrokey3/linux/reset.rst
diff --git a/nitrokeys/nitrokey3/linux/set-pins.rst b/nitrokeys/nitrokey3/linux/set-pins.rst
diff --git a/nitrokeys/nitrokey3/linux/smime-outlook.rst b/nitrokeys/nitrokey3/linux/smime-outlook.rst
diff --git a/nitrokeys/nitrokey3/linux/smime-thunderbird.rst b/nitrokeys/nitrokey3/linux/smime-thunderbird.rst
diff --git a/nitrokeys/nitrokey3/linux/smime.rst b/nitrokeys/nitrokey3/linux/smime.rst
diff --git a/nitrokeys/nitrokey3/linux/troubleshooting.rst b/nitrokeys/nitrokey3/linux/troubleshooting.rst
diff --git a/nitrokeys/nitrokey3/mac/2fa-odoo.rst b/nitrokeys/nitrokey3/mac/2fa-odoo.rst
diff --git a/nitrokeys/nitrokey3/mac/adsk.rst b/nitrokeys/nitrokey3/mac/adsk.rst
diff --git a/nitrokeys/nitrokey3/mac/firmware-update.rst b/nitrokeys/nitrokey3/mac/firmware-update.rst
diff --git a/nitrokeys/nitrokey3/mac/index.rst b/nitrokeys/nitrokey3/mac/index.rst
diff --git a/nitrokeys/nitrokey3/mac/keepassxc.rst b/nitrokeys/nitrokey3/mac/keepassxc.rst
diff --git a/nitrokeys/nitrokey3/mac/nitropy.rst b/nitrokeys/nitrokey3/mac/nitropy.rst
diff --git a/nitrokeys/nitrokey3/mac/openpgp-keygen-backup.rst b/nitrokeys/nitrokey3/mac/openpgp-keygen-backup.rst
diff --git a/nitrokeys/nitrokey3/mac/openpgp-keygen-gpa.rst b/nitrokeys/nitrokey3/mac/openpgp-keygen-gpa.rst
diff --git a/nitrokeys/nitrokey3/mac/openpgp-keygen-on-device.rst b/nitrokeys/nitrokey3/mac/openpgp-keygen-on-device.rst
diff --git a/nitrokeys/nitrokey3/mac/openpgp-outlook.rst b/nitrokeys/nitrokey3/mac/openpgp-outlook.rst
diff --git a/nitrokeys/nitrokey3/mac/openpgp-thunderbird.rst b/nitrokeys/nitrokey3/mac/openpgp-thunderbird.rst
diff --git a/nitrokeys/nitrokey3/mac/openpgp-uif.rst b/nitrokeys/nitrokey3/mac/openpgp-uif.rst
diff --git a/nitrokeys/nitrokey3/mac/openpgp.rst b/nitrokeys/nitrokey3/mac/openpgp.rst
diff --git a/nitrokeys/nitrokey3/mac/reset.rst b/nitrokeys/nitrokey3/mac/reset.rst
diff --git a/nitrokeys/nitrokey3/mac/set-pins.rst b/nitrokeys/nitrokey3/mac/set-pins.rst
diff --git a/nitrokeys/nitrokey3/mac/smime-outlook.rst b/nitrokeys/nitrokey3/mac/smime-outlook.rst
diff --git a/nitrokeys/nitrokey3/mac/smime-thunderbird.rst b/nitrokeys/nitrokey3/mac/smime-thunderbird.rst
diff --git a/nitrokeys/nitrokey3/mac/smime.rst b/nitrokeys/nitrokey3/mac/smime.rst
diff --git a/nitrokeys/nitrokey3/mac/troubleshooting.rst b/nitrokeys/nitrokey3/mac/troubleshooting.rst
diff --git a/nitrokeys/nitrokey3/shared/main.rst → nitrokeys/nitrokey3/main.rst b/nitrokeys/nitrokey3/shared/main.rst → nitrokeys/nitrokey3/main.rst
diff --git a/nitrokeys/nitrokey3/shared/nitropy.rst → nitrokeys/nitrokey3/nitropy.rst b/nitrokeys/nitrokey3/shared/nitropy.rst → nitrokeys/nitrokey3/nitropy.rst
diff --git a/nitrokeys/nitrokey3/shared/reset.rst.inc → nitrokeys/nitrokey3/reset.rst b/nitrokeys/nitrokey3/shared/reset.rst.inc → nitrokeys/nitrokey3/reset.rst
diff --git a/nitrokeys/nitrokey3/shared/set-pins.rst.inc → nitrokeys/nitrokey3/set-pins.rst b/nitrokeys/nitrokey3/shared/set-pins.rst.inc → nitrokeys/nitrokey3/set-pins.rst
@@ -54,8 +54,8 @@ Setting PIN with the Chrom(e|ium) webbrowser
 
 .. start-fido2-windows-settings-application
 
-Settings PIN with Windows Settings application
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Settings PIN with Windows Settings application (Windows only)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 1. Open the Windows "Settings" application.
 2. Open the "Accounts" menu.

diff --git a/nitrokeys/nitrokey3/shared/openpgp.rst.inc b/nitrokeys/nitrokey3/shared/openpgp.rst.inc
diff --git a/nitrokeys/nitrokey3/windows/2fa-odoo.rst b/nitrokeys/nitrokey3/windows/2fa-odoo.rst
diff --git a/nitrokeys/nitrokey3/windows/adsk.rst b/nitrokeys/nitrokey3/windows/adsk.rst
diff --git a/nitrokeys/nitrokey3/windows/firmware-update.rst b/nitrokeys/nitrokey3/windows/firmware-update.rst
diff --git a/nitrokeys/nitrokey3/windows/images/enabling-u2f-on-firefox b/nitrokeys/nitrokey3/windows/images/enabling-u2f-on-firefox
diff --git a/nitrokeys/nitrokey3/windows/images/passwordless-microsoft b/nitrokeys/nitrokey3/windows/images/passwordless-microsoft
diff --git a/nitrokeys/nitrokey3/windows/index.rst b/nitrokeys/nitrokey3/windows/index.rst
diff --git a/nitrokeys/nitrokey3/windows/keepassxc.rst b/nitrokeys/nitrokey3/windows/keepassxc.rst
diff --git a/nitrokeys/nitrokey3/windows/openpgp-csp.rst b/nitrokeys/nitrokey3/windows/openpgp-csp.rst
diff --git a/nitrokeys/nitrokey3/windows/openpgp-keygen-backup.rst b/nitrokeys/nitrokey3/windows/openpgp-keygen-backup.rst
diff --git a/nitrokeys/nitrokey3/windows/openpgp-keygen-gpa.rst b/nitrokeys/nitrokey3/windows/openpgp-keygen-gpa.rst
diff --git a/nitrokeys/nitrokey3/windows/openpgp-keygen-on-device.rst b/nitrokeys/nitrokey3/windows/openpgp-keygen-on-device.rst
diff --git a/nitrokeys/nitrokey3/windows/openpgp-outlook.rst b/nitrokeys/nitrokey3/windows/openpgp-outlook.rst
diff --git a/nitrokeys/nitrokey3/windows/openpgp-thunderbird.rst b/nitrokeys/nitrokey3/windows/openpgp-thunderbird.rst
diff --git a/nitrokeys/nitrokey3/windows/openpgp-uif.rst b/nitrokeys/nitrokey3/windows/openpgp-uif.rst
diff --git a/nitrokeys/nitrokey3/windows/openpgp.rst b/nitrokeys/nitrokey3/windows/openpgp.rst
diff --git a/nitrokeys/nitrokey3/windows/passwordless-microsoft.rst b/nitrokeys/nitrokey3/windows/passwordless-microsoft.rst
diff --git a/nitrokeys/nitrokey3/windows/reset.rst b/nitrokeys/nitrokey3/windows/reset.rst
diff --git a/nitrokeys/nitrokey3/windows/set-pins.rst b/nitrokeys/nitrokey3/windows/set-pins.rst
diff --git a/nitrokeys/nitrokey3/windows/smime-outlook.rst b/nitrokeys/nitrokey3/windows/smime-outlook.rst
diff --git a/nitrokeys/nitrokey3/windows/smime-thunderbird.rst b/nitrokeys/nitrokey3/windows/smime-thunderbird.rst