16 |
17 |
--------------------------------------------------------------------------------
/source/components/nethsm/container/container-hardware-restriction.rst.inc:
--------------------------------------------------------------------------------
1 | Compared to the NetHSM hardware the following functions are not implemented at the software container's REST API:
2 |
3 | * Network configuration
4 | * Factory reset
5 | * Reboot
6 | * Software update
7 |
--------------------------------------------------------------------------------
/source/components/nethsm/container/index.rst:
--------------------------------------------------------------------------------
1 | Container
2 | =========
3 |
4 | Please refer to the following chapters to learn more about the NetHSM container images.
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 | :glob:
9 |
10 | production-image.rst
11 | test-image.rst
12 |
--------------------------------------------------------------------------------
/source/components/nethsm/images/bmc-boot-device-override.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/bmc-boot-device-override.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/bmc-kvm-console.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/bmc-kvm-console.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/bmc-kvm-system-software-boot-selection.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/bmc-kvm-system-software-boot-selection.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/bmc-kvm-system-software-installation-selection.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/bmc-kvm-system-software-installation-selection.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/bmc-power-on.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/bmc-power-on.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/bmc-usb-attach-image-selection.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/bmc-usb-attach-image-selection.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/bmc-usb-attach.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/bmc-usb-attach.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/nethsm1-back-with-labels.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/nethsm1-back-with-labels.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/nethsm1-front-with-labels.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/nethsm1-front-with-labels.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/nethsm1-side-with-seal-raw.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/nethsm1-side-with-seal-raw.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/nethsm1-side-with-seal.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/nethsm1-side-with-seal.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/nethsm1-top-with-seal-positions.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/nethsm1-top-with-seal-positions.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/nethsm2-back-with-labels.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/nethsm2-back-with-labels.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/nethsm2-front-with-labels.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/nethsm2-front-with-labels.png
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-back-raw.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-back-raw.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-back.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-back.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-bottom-raw.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-bottom-raw.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-bottom.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-bottom.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-front-raw.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-front-raw.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-front.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-front.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-left-raw.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-left-raw.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-left.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-left.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-top-raw.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-top-raw.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-top-seal.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-top-seal.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/images/package-top.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nethsm/images/package-top.jpg
--------------------------------------------------------------------------------
/source/components/nethsm/ssh.rst:
--------------------------------------------------------------------------------
1 | SSH
2 | ===
3 |
4 | You can use NetHSM for SSH authentication. You need to pass the PKCS#11 module path in the command line or the SSH configuration.
5 |
6 | .. tabs::
7 | .. tab:: Command line
8 | .. code-block:: bash
9 |
10 | ssh -I /usr/lib/x86_64-linux-gnu/pkcs11/libnethsm_pkcs11.so user@host
11 |
12 | .. tab:: SSH config
13 | .. code-block::
14 |
15 | Host example.com
16 | PKCS11Provider /usr/lib/x86_64-linux-gnu/pkcs11/libnethsm_pkcs11.so
17 |
18 | .. note::
19 | You can also set up SSH to use the NetHSM by default. To do so, add the following lines to your ``~/.ssh/config`` file:
20 |
21 | .. code-block::
22 |
23 | Host *
24 | PKCS11Provider /usr/lib/x86_64-linux-gnu/pkcs11/libnethsm_pkcs11.so
25 |
26 |
27 | SSH will search for a key on the NetHSM that is accepted by the server.
28 |
29 | To list the keys of a NetHSM in a SSH ``authorized_keys`` format, use the following command:
30 |
31 | .. code-block:: bash
32 |
33 | ssh-keygen -D /usr/lib/x86_64-linux-gnu/pkcs11/libnethsm_pkcs11.so -e
34 |
--------------------------------------------------------------------------------
/source/components/nextbox/clients/android.rst:
--------------------------------------------------------------------------------
1 | Connect Your Android or iOS Smartphone
2 | ======================================
3 |
4 |
5 | Connect the NextBox with your smartphone
6 | ----------------------------------------
7 |
8 | 1. Download the Nextcloud app from the app store or play store.
9 |
10 | .. figure:: /components/nextbox/images/gettingstarted/sp_1.jpg
11 | :alt: imgsp1
12 | :scale: 30 %
13 |
14 | 2. Cick on "Sign in".
15 |
16 | .. figure:: /components/nextbox/images/gettingstarted/sp_2.jpg
17 | :alt: imgsp2
18 | :scale: 30 %
19 |
20 | 3. Enter your domain.
21 |
22 | .. figure:: /components/nextbox/images/gettingstarted/sp_3.jpg
23 | :alt: imgsp3
24 | :scale: 30 %
25 |
26 | 4. Enter your username and password and click "Log in".
27 |
28 | .. figure:: /components/nextbox/images/gettingstarted/sp_4.jpg
29 | :alt: imgsp4
30 | :scale: 30 %
31 |
32 | 5. Now you have access to your NextBox with your smartphone!
33 |
34 | .. figure:: /components/nextbox/images/gettingstarted/sp_5.jpg
35 | :alt: imgsp5
36 | :scale: 30 %
37 |
38 |
--------------------------------------------------------------------------------
/source/components/nextbox/clients/index.rst:
--------------------------------------------------------------------------------
1 | Desktop And Mobile Synchronization
2 | ==================================
3 |
4 | .. contents:: :local:
5 |
6 | Choose your operating system or device:
7 |
8 | .. toctree::
9 | :maxdepth: 1
10 | :glob:
11 |
12 | Android/iOS
13 | Windows
14 | Mac OS X
15 | Linux
16 |
--------------------------------------------------------------------------------
/source/components/nextbox/clients/linux.rst:
--------------------------------------------------------------------------------
1 | Connect Your Linux Computer
2 | ===============================
3 |
4 | .. contents:: :local:
5 |
6 | Connect using the Nextcloud App
7 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8 |
9 | 1. Download the client application from: https://nextcloud.com/install/
10 |
11 | .. hint:: Most distributions do provide the Nextcloud client via their
12 | package managers. (e.g., Ubuntu, Arch Linux, Mint, ...)
13 |
14 | 2. After starting the ``nextcloud`` application, you will find it
15 | as a tray icon.
16 |
17 | 3. Add an account using your public server url, username and password.
18 | Further you can choose the target directory the files should be synced
19 | to.
20 |
21 |
22 | Connect using WebDAV
23 | ^^^^^^^^^^^^^^^^^^^^^
24 |
25 | * Mounting Nextcloud using WebDAV can be done directly via most file
26 | managers, by adding a "remote server".
27 |
28 | * Additionally you can mount your Nextcloud files using WebDAV via
29 | commandline and `/etc/fstab` by installing the `davfs2` package.
30 |
31 | * To mount use:
32 |
33 | .. code-block:: bash
34 |
35 | mount -t davfs https://my.domain.tld/remote.php/webdav/ /mnt/target/path
36 |
37 |
38 |
--------------------------------------------------------------------------------
/source/components/nextbox/faq/index.rst:
--------------------------------------------------------------------------------
1 | NextBox FAQ
2 | ==========================
3 |
4 | .. toctree::
5 | :maxdepth: 1
6 | :glob:
7 |
8 | Generic
9 | Hardware
10 | Software
11 | Nextcloud
12 | Remote Access
13 |
14 |
15 |
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/1.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/10.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/10.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/2.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/3.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/4.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/5.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/6.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/7.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/8.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/9.5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/9.5.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/9.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/Screenshot_20210328-225924_Nextcloud.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/Screenshot_20210328-225924_Nextcloud.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/Screenshot_20210328-225959_Nextcloud.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/Screenshot_20210328-225959_Nextcloud.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/Screenshot_20210328-230010_Package installer.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/Screenshot_20210328-230010_Package installer.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/nextbox-app.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/nextbox-app.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/sp_1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/sp_1.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/sp_2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/sp_2.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/sp_3.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/sp_3.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/sp_4.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/sp_4.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/gettingstarted/sp_5.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/gettingstarted/sp_5.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/hardware-overview/back-side.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/hardware-overview/back-side.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/hardware-overview/back-side.raw.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/hardware-overview/back-side.raw.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/hardware-overview/front-side.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/hardware-overview/front-side.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/hardware-overview/front-side.raw.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/hardware-overview/front-side.raw.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/hardware-overview/right-side.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/hardware-overview/right-side.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/hardware-overview/right-side.raw.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/hardware-overview/right-side.raw.jpg
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_app/nextc-connect.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_app/nextc-connect.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_app/nextc-download.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_app/nextc-download.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_app/nextc-finder.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_app/nextc-finder.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_app/nextc-inital-setup.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_app/nextc-inital-setup.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_app/nextc-login.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_app/nextc-login.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_app/nextc-menu-bar-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_app/nextc-menu-bar-icon.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_webdav/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_webdav/1.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_webdav/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_webdav/2.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_webdav/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_webdav/3.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/mac_webdav/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/mac_webdav/4.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/storage-one.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/storage-one.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/storage-settings.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/storage-settings.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/storage-two.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/storage-two.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/technical/nextbox_bridge_backside.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/technical/nextbox_bridge_backside.jpeg
--------------------------------------------------------------------------------
/source/components/nextbox/images/technical/nextbox_bridge_backside_raw.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/technical/nextbox_bridge_backside_raw.jpeg
--------------------------------------------------------------------------------
/source/components/nextbox/images/technical/nextbox_bridge_backside_screws.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/technical/nextbox_bridge_backside_screws.jpeg
--------------------------------------------------------------------------------
/source/components/nextbox/images/technical/nextbox_bridge_top_usb.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/technical/nextbox_bridge_top_usb.jpeg
--------------------------------------------------------------------------------
/source/components/nextbox/images/technical/nextbox_bridge_top_usb_raw.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/technical/nextbox_bridge_top_usb_raw.jpeg
--------------------------------------------------------------------------------
/source/components/nextbox/images/technical/nextbox_led_button.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/technical/nextbox_led_button.jpeg
--------------------------------------------------------------------------------
/source/components/nextbox/images/technical/nextbox_led_button.raw.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/technical/nextbox_led_button.raw.jpeg
--------------------------------------------------------------------------------
/source/components/nextbox/images/walkthrough/dns-url.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/walkthrough/dns-url.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/walkthrough/no-padlock.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/walkthrough/no-padlock.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/walkthrough/padlock.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/walkthrough/padlock.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/walkthrough/proxy-url.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/walkthrough/proxy-url.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/win_app/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/win_app/1.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/win_app/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/win_app/2.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/win_app/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/win_app/4.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/win_app/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/win_app/5.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/win_app/nextc-login.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/win_app/nextc-login.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/win_webdav/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/win_webdav/6.png
--------------------------------------------------------------------------------
/source/components/nextbox/images/win_webdav/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nextbox/images/win_webdav/8.png
--------------------------------------------------------------------------------
/source/components/nextbox/index.rst:
--------------------------------------------------------------------------------
1 | NextBox
2 | ============================
3 |
4 | .. toctree::
5 | :maxdepth: 1
6 | :glob:
7 |
8 | gettingstarted
9 | hardware-overview
10 | external-storage
11 | clients/index
12 | backup-restore
13 | remote/index
14 | technical/index
15 | faq/index
16 |
17 |
--------------------------------------------------------------------------------
/source/components/nextbox/remote/ipv6-settings.rst:
--------------------------------------------------------------------------------
1 | IPv6-related Settings
2 | =====================
3 |
4 | Issue
5 | ---------
6 |
7 | You have properly set up one of the DNS configurations, :doc:`port-forwarding`
8 | and :doc:`dns-rebind` and still your NextBox is not available / reachable.
9 |
10 | .. hint::
11 | This is in particular important for Fritz!Box owners and/or DS-Lite internet
12 | connections.
13 |
14 |
15 | Details
16 | -------
17 |
18 | First test your (sub-)domain using a 3rd party service like `IPv6 Test`_ to test
19 | your NextBox' IPv6 reachability. If this fails this is another indicator that your
20 | IPv6 settings are not correct.
21 |
22 |
23 |
24 | Solution
25 | ------------
26 |
27 | Some routers might have a bad default configuration for IPv6. Therefore please
28 | ensure that your router is configured to pass IPv6 addresses to your network
29 | clients (called ``IA_NA``), if this not done, no IPv6 connection can be established
30 | to your NextBox from the outside, thus your NextBox is not reachable.
31 |
32 | On a recent *Fritz!Box* you will find this configuration inside:
33 | "Home Network -> "Network" -> "Network Settings" -> "IPv6 Configuration"
34 | Inside this view inside the section: "DHCPv6 Server in the Home Network" activate:
35 | "Enable DHCPv6 server in the FRITZ!Box for the home network:" and below this the last
36 | radio button has to be active: "Assign DNS server, prefix (IA_PD) and IPv6 address (IA_NA)"
37 | instead of the default, which is the 1st radio button.
38 |
39 |
40 |
41 | .. _IPv6 Test: https://ready.chair6.net/
42 |
43 |
44 |
--------------------------------------------------------------------------------
/source/components/nextbox/remote/port-forwarding.rst:
--------------------------------------------------------------------------------
1 | Port Forwarding & Firewall Configuration
2 | ========================================
3 |
4 | Issue
5 | ---------
6 |
7 | You have your dynamic DNS correctly set up, but your NextBox is not reachable using the domain.
8 |
9 | Before looking into this topic, make sure your domain correctly resolves to your IP.
10 |
11 |
12 | Details
13 | -------
14 |
15 | For both IPv4 and IPv6 you need to properly configure your internet router to allow access to your
16 | NextBox. While most internet routers will refer to this configuration as *port forwarding*, in fact
17 | IPv4 based (dynamic) DNS will resolve to your router's IP. But IPv6 in contrast will resolve to a
18 | (globally) unique IP, which refers to your NextBox.
19 |
20 | Therefore in technical terms IPv4 needs port forwarding to be enabled and for IPv6 you need to open
21 | the firewall to allow access to your NextBox. But in reality most routers do not differentiate
22 | between those and just name it *port sharing* for either IPv4 or IPv6.
23 |
24 |
25 | Solution
26 | ------------
27 |
28 | **The port-forwarding and/or firewall rules have to be configured to allow traffic on
29 | ports 80 (HTTP-Server) and 443 (HTTPS-Server).**
30 |
31 | On a recent *Fritz!Box* you will find this configuration inside: "Internet -> Permit Access -> Port Sharing"
32 |
33 |
34 |
35 |
36 |
37 |
--------------------------------------------------------------------------------
/source/components/nextbox/remote/static.rst:
--------------------------------------------------------------------------------
1 | Static DNS Configuration
2 | =============================================
3 |
4 | This configuration shall be used, if you configured DNS and thus a domain
5 | for your NextBox in e.g., your internet router.
6 |
7 | In contrast to the :doc:`backwards proxy ` remote access method, this approach
8 | will ensure full end-to-end encryption using your very own TLS certificate acquired from
9 | `Let's Encrypt`_.
10 |
11 | In order to use the configured domain with your NextBox and its Nextcloud
12 | instance you must provide the full domain here to trust this domain inside
13 | your Nextcloud instance.
14 |
15 | For instance inside a "Fritz!Box" this can be done by navigating to:
16 | "Internet -> Permit Access -> DynDNS" and configuring a dynamic DNS provider
17 | of your choice.
18 |
19 |
20 | .. _Let's Encrypt: https://letsencrypt.org
21 |
22 |
23 |
--------------------------------------------------------------------------------
/source/components/nextbox/technical/factory-reset.rst:
--------------------------------------------------------------------------------
1 | Factory Reset
2 | =======================
3 |
4 |
5 | .. Warning::
6 |
7 | Factory Resetting your NextBox will inevitably **delete all your files** on
8 | the NextBox and any configuration settings.
9 |
10 | **To factory reset your NextBox simply press the hardware button for 5 seconds.**
11 |
12 | The NextBox LED will change to *blue* once you press the button, after the 5
13 | seconds have passed the color will change to blinking red (see :doc:`LED documentation `).
14 | Once the LED has finally reached *green* again your NextBox is ready for the initial setup as
15 | described in :doc:`Getting Started <../gettingstarted>`
16 |
17 | .. figure:: /components/nextbox/images/technical/nextbox_led_button.jpeg
18 | :alt: img1
19 | :align: center
20 |
21 | .. hint::
22 | The hardware button is a pinhole-style button similar to other embedded
23 | devices. In order to press it, it is recommended to use a thin (~1mm)
24 | needle-like pin. E.g., the pin to remove a sim-card from a smartphone is
25 | working great. **Further take care to not press the button too hard,
26 | be careful, there should be a recognizable haptic feedback (button click)
27 | with minimal applied force.**
28 |
29 |
30 |
--------------------------------------------------------------------------------
/source/components/nextbox/technical/index.rst:
--------------------------------------------------------------------------------
1 | Technical Documentation
2 | ===================================
3 |
4 |
5 | .. toctree::
6 | :maxdepth: 1
7 | :glob:
8 |
9 | led-colors
10 | factory-reset
11 | soft-reset
12 | replace-drive
13 |
14 |
--------------------------------------------------------------------------------
/source/components/nextbox/technical/soft-reset.rst:
--------------------------------------------------------------------------------
1 | Soft Reset
2 | =======================
3 |
4 | **If ever your NextBox doesn't start or behaves strangely the soft reset might fix your problems**
5 | The soft reset functionality tries to fix some common failures on your NextBox.
6 | So whenever something is wrong, e.g. the NextBox doesn't start, the first thing you could try is
7 | a soft reset.
8 |
9 | **To start the soft reset on your NextBox simply press the hardware button 2 times within 2 seconds.**
10 |
11 | The NextBox LED will change to *blue* on every press, after the second press
12 | it will change to blinking blue (see :doc:`LED documentation `).
13 | Once the LED has finally reached *green* again for at least 20 seconds your NextBox is ready for use again.
14 | Please do not unplug your NextBox during this process as that might break something.
15 |
16 | .. figure:: /components/nextbox/images/technical/nextbox_led_button.jpeg
17 | :alt: img1
18 | :align: center
19 |
20 | .. hint::
21 | The hardware button is a pinhole-style button similar to other embedded
22 | devices. In order to press it, it is recommended to use a thin (~1mm)
23 | needle-like pin. E.g., the pin to remove a sim-card from a smartphone is
24 | working great. **Further take care to not press the button too hard,
25 | be careful, there should be a recognizable haptic feedback (button click)
26 | with minimal applied force.**
27 |
28 |
29 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/encrypted-storage/index.rst:
--------------------------------------------------------------------------------
1 | Encrypted Mobile Storage
2 | ========================
3 |
4 | .. product-table:: storage
5 |
6 | Prior of using the encrypted mobile storage you need to install and initialize the Nitrokey Storage and download the latest `Nitrokey App `__.
7 |
8 | 1. Start the Nitrokey App.
9 | 2. Press its tray icon and select "unlock encrypted volume" in the menu.
10 | 3. Enter your User PIN in the appearing popup window.
11 | 4. If this is the first time you may need to create a partition on the encrypted volume. Windows will open an appropriate window and ask you to do so. On GNU+Linux and Mac you may need to open a partition manager and create a partition manually. You can create as many partitions as you want. We recommend FAT(32) if you want to access the partition from various operating systems.
12 | 5. Now you can use the encrypted volume as you would use any other ordinary USB drive. But all data stored on it will be encrypted in the Nitrokey hardware automatically.
13 | 6. To remove or lock the encrypted volume you should unmount/eject it first.
14 | 7. Afterwards you can disconnect the Nitrokey or select "lock encrypted volume" from the Nitrokey App menu.
15 |
16 | The Nitrokey Storage is able to create hidden volumes as well. Please have a look at the corresponding instructions for `hidden volumes <../hidden-storage/index.html>`_.
17 |
18 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/10.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/10.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/11.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/11.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/12.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/12.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/8.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/fido2/images/passwordless-microsoft/9.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/index.rst:
--------------------------------------------------------------------------------
1 | FIDO2
2 | =====
3 |
4 | .. product-table:: nk3 passkey fido2
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 | :glob:
9 |
10 | Website Login
11 | Nextcloud Login
12 | Passwordless Microsoft Login (Windows only)
13 | Android / NitroPhone
14 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/fido2/nextcloud.rst:
--------------------------------------------------------------------------------
1 | Two-Factor Authentication And Passwordless Login For Nextcloud Accounts
2 | =======================================================================
3 |
4 | .. product-table:: fido2 nk3 passkey
5 |
6 | These are the basic steps for registering the Nitrokey as a second factor or setting up passwordless login of a Nextcloud account.
7 |
8 | .. raw:: html
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/hidden-storage/images/hidden/format-dialog.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/hidden-storage/images/hidden/format-dialog.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/hidden-storage/images/hidden/format-tool.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/hidden-storage/images/hidden/format-tool.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/hidden-storage/images/hidden/hidden-storage-partition.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/hidden-storage/images/hidden/hidden-storage-partition.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/hidden-storage/images/hidden/hidden-storage-passphrase.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/hidden-storage/images/hidden/hidden-storage-passphrase.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/hidden-storage/images/hidden/setup_hidden_volume.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/hidden-storage/images/hidden/setup_hidden_volume.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/hsm/dnssec.rst:
--------------------------------------------------------------------------------
1 | DNSSEC
2 | ======================
3 |
4 |
5 | .. product-table:: hsm
6 |
7 | .. contents:: :local:
8 |
9 |
10 | Protect your domain name resolution using DNSSEC and a Nitrokey HSM as secure key store. It's based on Smartcard-HSM which is why the following resources apply:
11 |
12 | * Luis D Espinoza Sanchez & Eberhard W Lisse held a `session on using the SmartCard-HSM for DNSSEC `__ at the 2015 ICAAN Meeting in Singapore.
13 | * Jan-Piet Mens wrote a nice article about `integrating the SmartCard-HSM with PowerDNS `__.
14 | * Integration with `OpenDNSSEC `__ has been successfully tested.
15 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/hsm/index.rst:
--------------------------------------------------------------------------------
1 | HSM Features
2 | ============
3 |
4 | .. product-table:: hsm
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 |
9 | S/MIME <../openpgp-card/smime/index>
10 | GPA <../openpgp-card/gpa>
11 | DNSSEC (Linux only)
12 | Automatic Screen Lock (Linux only) <../misc/automatic-screen-lock>
13 | Import Keys Certs
14 | stunnel (Linux only) <../openpgp-card/stunnel>
15 | Certificate Authority <../openpgp-card/certificate-authority>
16 | IPSec (Linux only) <../openpgp-card/ipsec>
17 | N-of-m Schemes
18 | PKCS11-URL
19 | Apache 2 TLS
20 |
21 | OpenPGP Card Features
22 | #####################
23 |
24 | The Nitrokey HSM is essentially a more potent OpenPGP Card, thus some of the OpenPGP Card features are also applicable for the HSM - although might need some adjustments.
25 |
26 | * `Hard Disk Encryption <../openpgp-card/hard-disk-encryption/index.html>`_
27 | * `Windows login <../openpgp-card/desktop-login/smart-policy.html>`__
28 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/index.rst:
--------------------------------------------------------------------------------
1 | Features
2 | ========
3 |
4 | .. card:: FIDO2
5 | :link: fido2/index
6 | :link-type: doc
7 |
8 | .. card:: U2F
9 | :link: u2f/index
10 | :link-type: doc
11 |
12 | .. card:: (Timed)-One-Time-Passwords (TOTP)
13 | :link: totp/index
14 | :link-type: doc
15 |
16 | .. card:: OpenPGP Card
17 | :link: openpgp-card/index
18 | :link-type: doc
19 |
20 | .. card:: Password Safe
21 | :link: password-safe/index
22 | :link-type: doc
23 |
24 | .. card:: Encrypted Mobile Storage
25 | :link: encrypted-storage/index
26 | :link-type: doc
27 |
28 | .. card:: Hidden Storage
29 | :link: hidden-storage/index
30 | :link-type: doc
31 |
32 | .. card:: Hardware Security Module
33 | :link: hsm/index
34 | :link-type: doc
35 |
36 | .. card:: PIV Smartcard
37 | :link: piv/index
38 | :link-type: doc
39 |
40 | .. card:: Miscellaneous
41 | :link: misc/index
42 | :link-type: doc
43 |
44 |
45 | .. toctree::
46 | :maxdepth: 1
47 | :glob:
48 | :hidden:
49 |
50 | FIDO2
51 | U2F
52 | TOTP
53 | OpenPGP card
54 | Password Safe
55 | Encrypted Mobile Storage
56 | Hidden Storage
57 | HSM
58 | PIV (Windows only)
59 | Miscellaneous
60 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/misc/index.rst:
--------------------------------------------------------------------------------
1 | Miscellaneous
2 | =============
3 |
4 | .. toctree::
5 | :maxdepth: 1
6 |
7 | Automatic Screen Lock
8 | Elliptic Curves (ECC) Support
9 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/desktop-login/images/smart-policy/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/desktop-login/index.rst:
--------------------------------------------------------------------------------
1 | Desktop Login
2 | =============
3 |
4 | .. product-table:: nk3 pro start storage
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 | :glob:
9 |
10 | PAM (Linux)
11 | Smart Policy (Windows)
12 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/hard-disk-encryption/images/luks/luks_7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/change-pins/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/change-pins/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/change-pins/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/change-pins/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/change-pins/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/change-pins/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/change-pins/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/change-pins/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/change-pins/App-change-pin.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/change-pins/App-change-pin.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/8.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/eidauthenticate/9.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa-keygen/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa/8.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/gpa/9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/gpa/9.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/10.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/10.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/11.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/11.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/8.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/openpgp-csp/9.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/outlook/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/outlook/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/outlook/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/outlook/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/outlook/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/outlook/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/outlook/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/outlook/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/10.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/10.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/11.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/11.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/12.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/12.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/13.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/13.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/14.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/14.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/8.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/images/thunderbird/9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/images/thunderbird/9.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/index.rst:
--------------------------------------------------------------------------------
1 | OpenPGP Card
2 | ============
3 |
4 | .. product-table:: nk3 pro start storage
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 |
9 | Overview
10 | Keygen with GPA
11 | Keygen with Backup
12 | Keygen on device
13 | Windows Login and S/MIME Email Encryption with Active Directory
14 | Thunderbird
15 | Outlook
16 | Touch Confirmation (Nitrokey 3 only)
17 | OpenVPN
18 | Claws Mail, an email client (and news reader) for Linux and Windows
19 | Evolution, an email client for the Gnome Desktop on Linux systems
20 | GPGTools on macOS
21 | Desktop Login
22 | SSH
23 | IPSec
24 | Hard Disk Encryption
25 | Stunnel
26 | Gnu Privacy Assistant (GPA)
27 | EID
28 | Certificate-authority
29 | GnuPG with Fedora
30 | Change Pins
31 | Additional Decryption Subkeys (ADSK) with GnuPG
32 |
33 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/openpgp-outlook.rst:
--------------------------------------------------------------------------------
1 | Outlook
2 | =======
3 |
4 | .. product-table:: nk3 pro storage start
5 |
6 | .. contents:: :local:
7 |
8 | .. note::
9 |
10 | Unfortunately, there is no solution to use OpenPGP in Outlook for
11 | macOS yet.
12 |
13 | Prerequisites
14 | -------------
15 |
16 | If you do not have PGP-Keys on your Nitrokey yet, please look at `this page `_ first.
17 |
18 | You need to have GnuPG installed on your System. The newest GnuPG version for Windows can be found `here `__. You need to make sure to have “GpgOL” checked during installation process (see below).
19 |
20 | .. figure:: images/outlook/1.png
21 | :alt: img1
22 |
23 |
24 |
25 | Usage
26 | -----
27 |
28 | After installing GPG4Win along with GpgOL, you will see a new icon labeled “Secure” in the composing window. To encrypt and sign a mail you just click on the sign like seen below.
29 |
30 | .. figure:: images/outlook/2.png
31 | :alt: img2
32 |
33 |
34 |
35 | GnuPG will start signing and encrypting the mail as soon as you click on ‘send’. You are requested to choose the identity you want to sign with and encrypt for.
36 |
37 | .. figure:: images/outlook/3.png
38 | :alt: img3
39 |
40 |
41 |
42 | Furthermore, you are asked for typing in the User PIN of the Nitrokey for signing the mail.
43 |
44 | .. figure:: images/outlook/4.png
45 | :alt: img4
46 |
47 |
48 |
49 | You will be asked automatically for your User PIN if you want to read an encrypted mail.
50 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/openvpn/images/viscosity/viscosity-1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/openvpn/images/viscosity/viscosity-1.jpg
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/openvpn/images/viscosity/viscosity-2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/openvpn/images/viscosity/viscosity-2.jpg
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/openvpn/images/viscosity/viscosity-3.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/openvpn/images/viscosity/viscosity-3.jpg
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/openvpn/images/viscosity/viscosity-4.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/openvpn/images/viscosity/viscosity-4.jpg
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/openvpn/index.rst:
--------------------------------------------------------------------------------
1 | OpenVPN
2 | =======
3 |
4 | .. product-table:: nk3 storage pro start
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 |
9 | EasyRSA
10 | Viscosity
11 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/smime/images/smime-outlook/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/smime/images/smime-outlook/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/smime/images/smime-outlook/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/smime/images/smime-outlook/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/smime/images/smime-outlook/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/smime/images/smime-outlook/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/smime/images/smime-thunderbird/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/smime/images/smime-thunderbird/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/smime/images/smime-thunderbird/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/smime/images/smime-thunderbird/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/smime/images/smime-thunderbird/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/smime/images/smime-thunderbird/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/smime/images/smime-thunderbird/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/smime/images/smime-thunderbird/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/smime/images/smime/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/smime/images/smime/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/openpgp-card/ssh/images/putty/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/stunnel.rst:
--------------------------------------------------------------------------------
1 | Stunnel
2 | =======
3 |
4 | .. product-table:: hsm pro storage start nk3
5 |
6 | .. contents:: :local:
7 |
8 | `Stunnel `__ works as an SSL encryption wrapper between remote client and local (inetd-startable) or remote server. It can be used to add SSL functionality to commonly used inetd daemons like POP2, POP3, and IMAP servers without any changes in the programs' code.
9 |
10 | Stunnel is able to load OpenSC PKCS#11 engine using this configuration:
11 |
12 | .. code-block:: bash
13 |
14 | engine=dynamic
15 | engineCtrl=SO_PATH:/usr/lib/opensc/engine_pkcs11.so
16 | engineCtrl=ID:pkcs11
17 | engineCtrl=LIST_ADD:1
18 | engineCtrl=LOAD
19 | engineCtrl=MODULE_PATH:/usr/lib/pkcs11/opensc-pkcs11.so
20 | engineCtrl=INIT
21 |
22 | [service]
23 | engineNum=1
24 | key=id_45
25 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/openpgp-card/uif.rst:
--------------------------------------------------------------------------------
1 | Touch Confirmation (UIF)
2 | ========================
3 |
4 | .. product-table:: nk3
5 |
6 | .. contents:: :local:
7 |
8 | The Nitrokey 3 OpenPGP Card functionality supports touch button confirmations (so called User Interaction Flags, UIF) when performing cryptographic key operations. It can be configured separately for each operation (Signature, Decryption and Authentication).
9 |
10 | UIF supports 3 modes:
11 |
12 | - Disabled: The device never prompts for user presence, which is the default behaviour
13 | - Enabled: The device always prompts for user presence
14 | - Permanentaly Enabled: Behaves like Enabled, but can only be reverted to Disabled through a factory-reset
15 |
16 | Configuration
17 | -------------
18 |
19 | With GnuPG 2.3 or more recent:
20 |
21 | ::
22 |
23 | $ gpg --card-edit
24 | …
25 | UIF setting ......: Sign=off Decrypt=off Auth=off
26 | …
27 | gpg/card> admin
28 |
29 | Then, set the UIF flag accordingly:
30 |
31 | - For signature operation: ``uif 1 on`` or ``uif 1 off`` or with ``uif 1 permanent``.
32 | - For decryption operation: ``uif 2 on`` or ``uif 2 off`` or ``uif 2 permanent``.
33 | - For authentication operation: ``uif 3 on`` or ``uif 3 off`` or ``uif 3 permanent``.
34 |
35 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/password-safe/index.rst:
--------------------------------------------------------------------------------
1 | Password Safe
2 | =============
3 |
4 | .. product-table:: nk3 pro storage
5 |
6 |
7 | In the Nitrokey Pro 2 and the Nitrokey Storage 2 you can store up to 16 password credentials.
8 | The Nitrokey 3 is able to store many more, how to set them up using NitrokeyApp2 is documented in
9 | :doc:`Passwords <../../../software/nk-app2/passwords>` - although you can also use
10 | :doc:`nitropy <../../../software/nitropy/index>`.
11 |
12 | Furthermore the Nitrokey 3 supports unlocking you KeepassXC database. You can find the
13 | guide to realize this at :doc:`KeepassXC <../../../software/nk-app2/keepassxc>`.
14 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/piv/certificate_management.rst:
--------------------------------------------------------------------------------
1 | Certificate Management
2 | ======================
3 |
4 | .. product-table:: nk3
5 |
6 | Every private key has a certificate associated. The certificates can be read and written.
7 | The size of a certificate is limited by the transport layer and about 6kB.
8 |
9 |
10 | Read Certificate
11 | ----------------
12 |
13 | Certificates can be read from the Nitrokey per key slot.
14 |
15 | The certificate can be retrieved as follows.
16 |
17 | .. code-block::
18 |
19 | nitropy nk3 piv --experimental read-certificate --key
20 |
21 |
22 | Write Certificate
23 | -----------------
24 |
25 | Certificates can be written to the Nitrokey per key slot.
26 |
27 | .. code-block::
28 |
29 | nitropy nk3 piv --experimental write-certificate --key
30 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/piv/factory_reset.rst:
--------------------------------------------------------------------------------
1 | Factory Reset
2 | =============
3 |
4 | .. product-table:: nk3
5 |
6 | The PIV smart card can be reset to factory defaults.
7 | It can only be reset if the PIN and PUK are blocked.
8 |
9 | .. warning::
10 | Performing a factory reset of the PIV smart card will delete all private keys and certificates.
11 |
12 | The reset to factory defaults can be performed as follows.
13 |
14 | .. code-block::
15 |
16 | nitropy nk3 piv --experimental factory-reset
17 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/piv/guides/index.rst:
--------------------------------------------------------------------------------
1 | Guides
2 | ======
3 |
4 | .. product-table:: nk3
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 | :glob:
9 |
10 | client_logon_with_active_directory.rst
11 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/piv/index.rst:
--------------------------------------------------------------------------------
1 | PIV (Personal Identity Verification)
2 | ====================================
3 |
4 | .. product-table:: nk3
5 |
6 | The *Personal Identity Verfication* (PIV) smart card is based on the NIST special publication `SP 800-73 `__.
7 | It is available as of firmware version 1.8 and higher.
8 |
9 | .. toctree::
10 | :maxdepth: 1
11 | :glob:
12 |
13 | Access Control
14 | Certificate Management
15 | Factory Reset
16 | Key Management
17 |
18 | Guides
19 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/google.rst:
--------------------------------------------------------------------------------
1 | Two-factor Authentication for Google
2 | ====================================
3 |
4 | .. product-table:: nk3 pro storage
5 |
6 | .. contents:: :local:
7 |
8 | These are the basic steps for registering the Nitrokey Pro or Nitrokey Storage as a second factor of a Google account:
9 |
10 | 1. Go to `https://myaccount.google.com/security#signin `__
11 | 2. Click “2-Step Verification” on the right side
12 | 3. You need to define a first 2-Step Verfication (e.g. your phone number) method to have access to the alternative second step option (the first 2-Step Verification can’t be the security key)
13 | 4. Choose “Authenticator App” as second step (though you won’t actually need the app)
14 | 5. Choose Android and press on “Can’t scan it” below the QR code to see the secret key
15 | 6. Copy the key (you can ignore the whitespaces, they do not get copied anyway) and paste the key into the corresponding field in the Nitrokey App
16 | 7. Click “Next” and follow the instructions (but you use the Nitrokey App instead of the Google Authenticator app to generate the keys)
17 | 8. It is possible to use the same secret key for the Google Autenticator app and the Nitrokey App as well. Just make sure to follow the above procedure and use the QR code for the Authenticator app afterwards before clicking “Next”. Now you can use either the Google Authenticator app or the Nitrokey App.
18 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/10.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/10.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/11.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/11.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/12.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/12.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/13.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/13.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/14.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/14.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/8.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/microsoft/9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/microsoft/9.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/nextcloud/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/nextcloud/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/nextcloud/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/nextcloud/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/nextcloud/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/nextcloud/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/nextcloud/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/nextcloud/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/nextcloud/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/nextcloud/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/nextcloud/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/nextcloud/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/nextcloud/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/nextcloud/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/nextcloud/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/nextcloud/8.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/nextcloud/9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/nextcloud/9.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/otp/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/otp/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/otp/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/otp/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/otp/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/otp/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/otp/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/otp/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/otp/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/otp/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/otp/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/otp/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/otp/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/otp/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/images/otp/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/totp/images/otp/8.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/totp/index.rst:
--------------------------------------------------------------------------------
1 | Two-factor Authentication with One-Time Passwords (OTP)
2 | =======================================================
3 |
4 | .. product-table:: nk3 pro storage
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 |
9 | General Instructions
10 | Microsoft
11 | Google
12 | Nextcloud
13 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/u2f/2fa.rst:
--------------------------------------------------------------------------------
1 | Two-Factor Authentication (2FA)
2 | ===============================
3 |
4 | .. product-table:: fido2 u2f nk3 passkey
5 |
6 | 1. Open one of the `websites that support FIDO
7 | U2F `__.
8 | 2. Log in to the website and enable two-factor authentication in your
9 | account settings. (In most cases you will find a link to the
10 | documentation of the supported web service at
11 | `dongleauth.com `__)
12 | 3. Register your Nitrokey in the account settings by touching the
13 | button to activate the Nitrokey. After you have successfully
14 | configured the device, you must activate the Nitrokey this way
15 | each time you log in.
16 |
17 | You are now ready to go.
18 |
19 | .. important::
20 | The Nitrokey App can not be used for the Nitrokey U2F.
21 |
22 | Troubleshooting (Linux)
23 | -----------------------
24 |
25 | - If the Nitrokey is not accepted immediately, you may need to copy
26 | this file
27 | `41-nitrokey.rules `__
28 | to ``etc/udev/rules.d/``. In very rare cases, the system will need
29 | the `older
30 | version `__
31 | of this file.
32 |
33 | - After copying the file, restart udev via
34 | ``sudo service udev restart``.
35 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/u2f/images/desktop-login/fidou2f-5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/u2f/images/desktop-login/u2f-fido-pam-2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/features/u2f/images/desktop-login/u2f-fido-pam-2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/features/u2f/index.rst:
--------------------------------------------------------------------------------
1 | U2F
2 | ===
3 |
4 | .. product-table:: u2f fido2 nk3 passkey
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 |
9 | Desktop Login (Linux only)
10 | Odoo Login
11 | Two Factor Authentication <2fa>
12 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/fido2/faq.rst:
--------------------------------------------------------------------------------
1 | Nitrokey FIDO2 FAQ
2 | ==================
3 |
4 | .. faq:: Which Operating Systems are supported?
5 |
6 | Windows, Linux, and Mac OS X. Also some support (FIDO2) for Android.
7 |
8 | .. faq:: What can I use the Nitrokey for?
9 |
10 | See the `overview `_ of supported use cases.
11 |
12 | .. faq:: What happens if I lose my FIDO device?
13 |
14 | When securing accounts using FIDO (two-factor authentication and
15 | passwordless login), you should configure another factor in your account as
16 | a backup. Depending on the service this backup factor can be a phone number,
17 | an app or even a second Nitrokey FIDO2. If you lose a Nitrokey FIDO2, you
18 | can still log in with the second Nitrokey FIDO2 (or with another second
19 | factor).
20 |
21 | .. faq:: How large is the storage capacity?
22 |
23 | The Nitrokey FIDO2 doesn't contain storage capability for ordinary data (it can only store cryptographic keys).
24 |
25 | .. faq:: How many keys can my Nitrokey FIDO2 store?
26 |
27 | It can store up to 50 passkeys also known as discoverable credentials and an unlimited number of non-discoverable credentials.
28 |
29 | .. faq:: How to use Nitrokey FIDO2 with Azure Entra ID (Active Directory)?
30 |
31 | After `disabling Enforce Attestation`_ Nitrokey FIDO2 is supported by Azure Entra ID out of the box.
32 |
33 |
34 | .. include:: ../../shared-faqs/hyperlinks.rst.inc
35 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/fido2/firmware-update.rst:
--------------------------------------------------------------------------------
1 | Firmware Update
2 | ===============
3 |
4 | This guide describes how to update the firmware on the Nitrokey FIDO2.
5 |
6 | .. important::
7 | User Data is retained during firmware update. Anyways, be sure to **always** have another device (or login method) registered with your service, if for some reason your data is not retained.
8 |
9 | How to Update
10 | -------------
11 |
12 | .. important::
13 | Never disconnect the Nitrokey FIDO2 or abort the process while updating,
14 | this will likely render your device useless!
15 |
16 | Webupdate
17 | ^^^^^^^^^
18 |
19 | The easiest way to update a Nitrokey FIDO2 is to open `update.nitrokey.com `_ in your browser and follow the instructions on the web page.
20 |
21 | Using the command line
22 | ^^^^^^^^^^^^^^^^^^^^^^
23 |
24 | If the webupdate doesn't work for you, you can also use our command line tool.
25 |
26 | 1. Make sure you have the latest `pynitrokey` version installed, please check the `installation instructions`_ for your OS.
27 | 2. Run ``nitropy fido2 update``.
28 | 3. Once instructed by ``nitropy`` touch the device to activate bootloader.
29 | 4. *macOS only:* If instructed by ``nitropy`` run update command again.
30 | 5. Please wait until the process finished. (This may vary depending on your operating system
31 |
32 | In case of any errors please take the logs from ``/tmp`` directory (``/tmp/nitropy.log.*``).
33 |
34 |
35 |
36 | .. _installation instructions: /software/nitropy/all-platforms/installation.html
37 |
38 |
39 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/fido2/index.rst:
--------------------------------------------------------------------------------
1 | Nitrokey FIDO2
2 | ==============
3 |
4 | .. contents:: :local:
5 |
6 | First check the:
7 |
8 | .. toctree::
9 | :maxdepth: 1
10 | :glob:
11 |
12 | Getting Started
13 | Frequently Asked Questions
14 |
15 | and the product guides:
16 |
17 | .. toctree::
18 | :maxdepth: 1
19 |
20 | Firmware update
21 | Reset
22 |
23 | or check out the features:
24 |
25 | * `FIDO2 <../features/fido2/index.html>`_
26 | * `U2F <../features/u2f/index.html>`_
27 |
28 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/hsm/index.rst:
--------------------------------------------------------------------------------
1 | Nitrokey HSM 2
2 | ==============
3 |
4 | .. contents:: :local:
5 |
6 | First check the:
7 |
8 | .. toctree::
9 | :maxdepth: 1
10 | :glob:
11 |
12 | Getting Started
13 | Frequently Asked Questions
14 |
15 | or check out the features:
16 |
17 | * `HSM <../features/hsm/index.html>`_
--------------------------------------------------------------------------------
/source/components/nitrokeys/nitrokey3/firmware-update-qubes.rst:
--------------------------------------------------------------------------------
1 | Firmware Update With Qubes OS
2 | =============================
3 |
4 | .. only:: comment
5 |
6 | .. contents:: :local:
7 |
8 | This guide describes how to update Nitrokey 3's firmware with nitropy in Qubes OS.
9 |
10 | .. important::
11 | please read the general `firmware update instructions`_ before! Since for specifc versions there are limitations regarding what data is possible to migrate to the new version.
12 |
13 | .. _firmware update instructions: ./firmware-update.html
14 |
15 |
16 | Setup
17 | -----
18 |
19 | Install nitropy in a app VM of your choice following the `installation instructions`_.
20 |
21 | .. _installation instructions: ../../software/nitropy/all-platforms/installation.html
22 |
23 |
24 | How to Update
25 | -------------
26 |
27 | .. important::
28 | Never disconnect the Nitrokey 3 or abort the process while updating,
29 | because it will likely render your device unusable!
30 |
31 | 1. Run ``nitropy nk3 reboot --bootloader`` in app VM.
32 | 2. Once instructed by ``nitropy`` touch the device to activate the bootloader.
33 | 3. This will detach the Nitrokey from the app VM, and the bootloader will apear in sys-usb.
34 | 4. Attach the bootloader to the app VM.
35 | 5. Run ``nitropy nk3 update`` and follow the instructions.
36 | 6. During the finalization the Nitrokey will be detached. Re-attach the Nitrokey back to th app VM to finish the update.
37 |
38 | In case of any errors please take the logs from ``/tmp`` directory (``/tmp/nitropy.log.*``).
39 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/nitrokey3/index.rst:
--------------------------------------------------------------------------------
1 | Nitrokey 3
2 | ==========
3 |
4 | .. contents:: :local:
5 |
6 | First check the:
7 |
8 | .. toctree::
9 | :maxdepth: 1
10 | :glob:
11 |
12 | Getting Started
13 | Frequently Asked Questions
14 | Overview
15 |
16 | and the product guides:
17 |
18 | .. toctree::
19 | :maxdepth: 1
20 |
21 | Firmware Update
22 | Firmware Update Qubes
23 | Set Pins
24 | LED and Touch Button
25 | nitropy
26 | Reset
27 | Secure Element
28 | Troubleshooting
29 | USBGuard
30 |
31 | or check out the features:
32 |
33 | * `FIDO2 <../features/fido2/index.html>`_
34 | * `U2F <../features/u2f/index.html>`_
35 | * `OpenPGP Card <../features/openpgp-card/index.html>`_
36 | * `Password Safe <../features/password-safe/index.html>`_
37 | * `PIV (Windows only) <../features/piv/index.html>`_
38 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/nitrokey3/led.rst:
--------------------------------------------------------------------------------
1 | LED and Touch Button
2 | ====================
3 |
4 | +----------------+------------------------------------+
5 | | LED Color | Event |
6 | +================+====================================+
7 | | White blinking | Waiting for button touch |
8 | +----------------+------------------------------------+
9 | | Red blinking | HEADS: HOTP verification failed |
10 | +----------------+------------------------------------+
11 | | Green blinking | HEADS: HOTP verification sucessful |
12 | +----------------+------------------------------------+
13 | | Green shining | Processing |
14 | +----------------+------------------------------------+
15 | | Red shining | Device failure |
16 | +----------------+------------------------------------+
17 |
18 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/nitrokey3/reset.rst:
--------------------------------------------------------------------------------
1 | Factory Reset
2 | =============
3 |
4 | .. contents:: :local:
5 |
6 | Each functionality of the Nitrokey 3 can be reset individually.
7 |
8 | FIDO2
9 | -----
10 |
11 | The Factory Reset operation deletes all (and generates new) secret FIDO2 keys stored in the Nitrokey:
12 |
13 | * nitropy tool: ``nitropy fido2 reset`` (execution requires Administrator rights)
14 | * Google Chrome: `Manage security keys` via the direct link: `chrome://settings/securityKeys`
15 |
16 | Passwords
17 | ---------
18 |
19 | Static passwords and One-Time Passwords (OTP) can be reset with ``nitropy nk3 secrets reset``.
20 |
21 | OpenPGP
22 | -------
23 |
24 | The OpenPGP Card can be reset with GnuPG: ``gpg --card-edit``, then ``admin`` and ``factory-reset``.
25 |
26 | PIV Smartcard
27 | -------------
28 |
29 | The PIV smartcard can be reset using the following command:
30 |
31 | ::
32 |
33 | opensc-tool -s 00:A4:04:00:0B:A000000308000010000100 -s 00:20:00:80:08:FFFFFFFFFFFFFFFF -s 00:20:00:80:08:FFFFFFFFFFFFFFFF -s 00:20:00:80:08:FFFFFFFFFFFFFFFF -s 00:FB:00:00
34 |
35 |
36 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/nitrokey3/usbguard.rst:
--------------------------------------------------------------------------------
1 | USBGuard
2 | ========
3 |
4 | Using usbguard is pretty essential to protect against common attacks like malicious devices, rubber duckies, OMG cables or the “governmental 3 letter agency equivalents”.
5 |
6 | Especially thunderbolt (which can be blocked globally, see `this config as to how `__ can grant attackers access to your RAM, which means encryption keys and more.
7 |
8 | 1. Install USBGuard
9 |
10 | Debian/Ubuntu or Linux mint:
11 |
12 | ``sudo apt install usbguard usbutils udisks2 usbguard-notifier``
13 |
14 | Fedora:
15 |
16 | ``sudo dnf install -y usbguard usbguard-notifier usbguard-selinux``
17 |
18 | 2. Set it up
19 |
20 | Make sure to have your keyboard and mouse plugged in.
21 |
22 | These commands will permanently allow all currently connected devices:
23 |
24 | .. code-block:: bash
25 |
26 | pkexec sh -c '
27 | mkdir -p /var/log/usbguard
28 | mkdir -p /etc/usbguard
29 | chmod 755 /etc/usbguard
30 | usbguard generate-policy > /etc/usbguard/rules.conf
31 | systemctl enable --now usbguard.service
32 | usbguard add-user $1
33 | ' -- $ACTIVE_USERNAME
34 | systemctl enable --user --now usbguard-notifier.service
35 |
36 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/passkey/index.rst:
--------------------------------------------------------------------------------
1 | Nitrokey Passkey
2 | ================
3 |
4 | .. contents:: :local:
5 |
6 | The Nitrokey Passkey is the successor to the Nitrokey FIDO2. It is build on top of the technologies
7 | and framework used within the Nitrokey 3. Find the latest `release notes`_ on GitHub.
8 |
9 | Please see the :doc:`FIDO2 <../fido2/index>` pages for more FIDO2 related documentation.
10 |
11 | Currently there is only one firmware version, so no firmware update is necessary.
12 |
13 | .. _release notes: https://github.com/Nitrokey/nitrokey-passkey-firmware/releases
14 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/pro/factory-reset.rst:
--------------------------------------------------------------------------------
1 | Factory Reset
2 | =============
3 |
4 | .. contents:: :local:
5 |
6 | There are two types of factory resets for Nitrokey Pro devices:
7 |
8 | - a factory reset of the OpenPGP smart card, for example using ``gpg
9 | --card-edit``, followed by ``admin`` and finally: ``factory-reset``
10 | - a factory reset of the entire Nitrokey device using the Nitrokey App.
11 |
12 | Also, it is possible to generate a new AES key that is used to encrypt the
13 | Password Safe without performing a factory reset.
14 |
15 | .. note::
16 |
17 | The Nitrokey App always generates a new AES key after performing a factory
18 | reset.
19 |
20 | The following table describes the differences between these three operations:
21 |
22 | =========================== ===================== ====================== ================
23 | Property OpenPGP factory reset Nitrokey factory reset Generate AES key
24 | =========================== ===================== ====================== ================
25 | Requires admin PIN no yes yes
26 | Destroys OpenPGP keys yes yes no
27 | Destroys Password Safe yes [1]_ yes yes [1]_
28 | Destroys One-Time Passwords no yes no
29 | =========================== ===================== ====================== ================
30 |
31 | .. [1] Clears the encryption key without overwriting the encrypted data.
32 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/pro/index.rst:
--------------------------------------------------------------------------------
1 | Nitrokey Pro 2
2 | ==============
3 |
4 | .. contents:: :local:
5 |
6 |
7 | First check the:
8 |
9 | .. toctree::
10 | :maxdepth: 1
11 | :glob:
12 |
13 | Getting Started
14 | Frequently Asked Questions
15 |
16 | and the product guides:
17 |
18 | .. toctree::
19 | :maxdepth: 1
20 |
21 | Update
22 | Factory Reset
23 |
24 | or check out the features:
25 |
26 | * `U2F <../features/u2f/index.html>`_
27 | * `TOTP <../features/totp/index.html>`_
28 | * `OpenPGP Card <../features/openpgp-card/index.html>`_
29 | * `Automatic Screen Lock (Linux) <../features/misc/automatic-screen-lock/index.html>`_
30 | * `ECC <../features/misc/ecc/index.html>`_
31 |
32 |
33 |
--------------------------------------------------------------------------------
/source/components/nitrokeys/start/index.rst:
--------------------------------------------------------------------------------
1 | Nitrokey Start
2 | ==============
3 |
4 | .. contents:: :local:
5 |
6 | First check the:
7 |
8 | .. toctree::
9 | :maxdepth: 1
10 | :glob:
11 |
12 | Getting Started
13 | Frequently Asked Questions
14 |
15 | and the product guides:
16 |
17 | .. toctree::
18 | :maxdepth: 1
19 |
20 | Multiple Identities
21 | Setting KDF-DO
22 | Factory Reset
23 | Firmware Update
24 |
25 | or check out the features:
26 |
27 | * `OpenPGP Card <../features/openpgp-card/index.html>`_
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/factory-reset/factory-reset-menu-item.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/factory-reset/factory-reset-menu-item.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/1.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/10.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/10.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/11.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/11.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/12.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/12.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/13.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/13.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/2.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/3.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/4.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/5.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/6.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/7.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/8.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update-manually/9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update-manually/9.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update/enable-firmware-update.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update/enable-firmware-update.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/firmware-update/nitrokey-update-tool.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/firmware-update/nitrokey-update-tool.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/images/getting-started/Windows10-Systemtray.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrokeys/storage/images/getting-started/Windows10-Systemtray.png
--------------------------------------------------------------------------------
/source/components/nitrokeys/storage/index.rst:
--------------------------------------------------------------------------------
1 | Nitrokey Storage 2
2 | ==================
3 |
4 | .. contents:: :local:
5 |
6 | First check the:
7 |
8 | .. toctree::
9 | :maxdepth: 1
10 | :glob:
11 |
12 | Getting Started
13 | Frequently Asked Questions
14 |
15 | and the product guides:
16 |
17 | .. toctree::
18 | :maxdepth: 2
19 |
20 | Firmware-Update
21 | Manual Firmware-Update
22 | Factory Reset
23 |
24 | or check out the features:
25 |
26 | * `U2F <../features/u2f/index.html>`_
27 | * `TOTP <../features/totp/index.html>`_
28 | * `OpenPGP Card <../features/openpgp-card/index.html>`_
29 | * `Encrypted Mobile Storage <../features/encrypted-storage/index.html>`_
30 | * `Hidden Storage <../features/hidden-storage/index.html>`_
31 | * `Automatic Screen Lock (Linux) <../features/misc/automatic-screen-lock/index.html>`_
32 | * `ECC <../features/misc/ecc/index.html>`_
--------------------------------------------------------------------------------
/source/components/nitrokeys/u2f/index.rst:
--------------------------------------------------------------------------------
1 | Nitrokey U2F
2 | ============
3 |
4 | .. contents:: :local:
5 |
6 | Check out the features:
7 |
8 | * `U2F <../features/u2f/index.html>`_
9 |
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/change-pins.rst:
--------------------------------------------------------------------------------
1 | .. include:: ../nitrokeys/features/openpgp-card/change-pins.rst
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/content/shared-index-content2.rst:
--------------------------------------------------------------------------------
1 | Behavior After a System Update
2 | ------------------------------
3 |
4 | The NitroPad and NitroPC firmware checks certain system files for changes. If your
5 | operating system has updated important components, you will be warned
6 | the next time you boot the NitroPad or NitroPC. This could look like this, for
7 | example:
8 |
9 | .. figure:: ../images/NitroPad-error-mismatch.jpeg
10 | :alt: img4
11 |
12 | That’s why it’s important to restart your NitroPad or your NitroPC under controlled
13 | conditions after a system update. Only when the new status has been
14 | confirmed can you leave the device unattended again. Otherwise, you will
15 | not be able to distinguish a possible attack from a system update.
16 | Detailed instructions for a system update can be `found
17 | here <../heads/system-update.html>`_.
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/heads/index.rst:
--------------------------------------------------------------------------------
1 | Heads
2 | =====
3 |
4 | .. contents:: :local:
5 |
6 | .. toctree::
7 | :maxdepth: 1
8 | :glob:
9 |
10 | Default Boot
11 | Factory Reset
12 | Factory Reset Heads 2.0
13 | Firmware Update
14 | Firmware Update v1.4+
15 | System Update
16 |
17 |
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/NitroPad-boot-options.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/NitroPad-boot-options.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/NitroPad-boot-process-bad.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/NitroPad-boot-process-bad.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/NitroPad-boot-process_0.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/NitroPad-boot-process_0.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/NitroPad-confirm-boot-details.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/NitroPad-confirm-boot-details.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/NitroPad-error-mismatch.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/NitroPad-error-mismatch.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/Schraube.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/Schraube.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/SchraubenmarkierungT430.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/SchraubenmarkierungT430.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/SchraubenmarkierungX230.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/SchraubenmarkierungX230.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/V54_sealed.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/V54_sealed.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/boot-menu.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/boot-menu.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/1.png
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/2.png
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/3.png
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/4.png
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/change-disk-encryption-passphrase/5.png
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/default-boot/1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/default-boot/1.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/default-boot/2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/default-boot/2.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/default-boot/3.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/default-boot/3.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/default-boot/4.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/default-boot/4.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/admin-pin.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/admin-pin.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/confirm-integrity.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/confirm-integrity.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/confirm.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/confirm.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/default-sec.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/default-sec.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/options.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/options.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/otp-sec1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/otp-sec1.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/otp-sec2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/otp-sec2.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/reboot.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/reboot.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/reset.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/reset.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/start-menu.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/start-menu.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/totp.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/totp.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset-heads2/tpm.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset-heads2/tpm.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/1.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/10.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/10.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/11.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/11.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/2.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/3.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/3.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/4.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/4.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/5.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/5.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/6.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/6.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/7.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/7.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/8.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/8.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/factory-reset/9.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/factory-reset/9.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/firmware-update/1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/firmware-update/1.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/firmware-update/2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/firmware-update/2.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/firmware-update/3.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/firmware-update/3.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/firmware-update/4.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/firmware-update/4.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/firmware-update/5.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/firmware-update/5.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/firmware-update/6.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/firmware-update/6.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/firmware-update/7.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/firmware-update/7.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/firmware-update/8.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/firmware-update/8.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/firmware-update/9.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/firmware-update/9.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/network-settings/settings_0.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/network-settings/settings_0.png
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/network-settings/settings_1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/network-settings/settings_1.png
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/network-settings/settings_2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/network-settings/settings_2.png
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/ns50_sealed.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/ns50_sealed.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/nv41_sealed.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/nv41_sealed.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/operating-system-update/NitroPad-boot-entry-error.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/operating-system-update/NitroPad-boot-entry-error.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/operating-system-update/NitroPad-confirm-boot-details.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/operating-system-update/NitroPad-confirm-boot-details.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/operating-system-update/NitroPad-update-checksum.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/operating-system-update/NitroPad-update-checksum.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/options.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/options.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/system-update/1.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/system-update/1.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/system-update/2.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/system-update/2.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/system-update/3.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/system-update/3.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/system-update/4.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/system-update/4.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/system-update/5.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/system-update/5.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/images/system-update/6.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/images/system-update/6.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/index.rst:
--------------------------------------------------------------------------------
1 | NitroPad, NitroPC
2 | =================
3 |
4 | .. contents:: :local:
5 |
6 | Gettings started and choose your operating system:
7 |
8 | .. toctree::
9 | :maxdepth: 1
10 | :glob:
11 |
12 | Ubuntu
13 | QubesOS
14 |
15 | General topics:
16 |
17 | .. toctree::
18 | :maxdepth: 1
19 | :glob:
20 |
21 | Heads
22 | Frequently Asked Questions
23 | Operating System Reinstallation
24 | Verify Sealed Hardware
25 | Change User and Admin PIN
26 | Troubleshooting
27 |
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/qubes/images/QubesDiskPassword.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/qubes/images/QubesDiskPassword.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-five.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-five.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-four.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-four.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-one.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-one.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-three.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-three.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-two.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/qubes/images/user-password-reset/step-two.jpg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/qubes/network-settings.rst:
--------------------------------------------------------------------------------
1 | Enable Network Settings, e.g. Wifi
2 | ==================================
3 |
4 | To be able to use Wifi, Bluetooth and other functionalities, "Settings" must be activated in "sys-net".
5 |
6 |
7 | 1. Click on the top left Qubes Icon and select Qubes:Settings under sys-net.
8 |
9 | .. figure:: ../images/network-settings/settings_0.png
10 | :alt: img1
11 |
12 | 2. Go to Applications, select "Settings" and click ">" to move it to the right side.
13 | 3. Click "Apply" and after wards "Ok".
14 | 4. Now you should have "Settings" visible under sys-net.
15 |
16 | .. Note::
17 |
18 | If it won't open Settings after clicking on it, please follow the instructions below.
19 |
20 | Fix sys-net Settings
21 | ~~~~~~~~~~~~~~~~~~~~
22 |
23 | 1. Go to the sys-net Terminal.
24 | 2. Open the bashrc-file with ``sudo vim ~/.bashrc``.
25 |
26 | .. figure:: ../images/network-settings/settings_1.png
27 | :alt: img2
28 |
29 | 3. Press "i" to enable the editing and add ``export XDG_CURRENT_DESKTOP=GNOME`` to the file.
30 |
31 | .. figure:: ../images/network-settings/settings_2.png
32 | :alt: img3
33 |
34 | 4. Save the changes with ``:wq``.
35 | 5. Restart your NitroPad.
36 | 6. Now Settings should be visible.
37 |
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/qubes/user-password-reset.rst:
--------------------------------------------------------------------------------
1 | User Password Reset
2 | ===================
3 |
4 | 1. Follow the next five steps to boot from the installation media
5 |
6 | .. figure:: ./images/user-password-reset/step-one.jpg
7 | :alt: Step 1
8 |
9 | .. figure:: ./images/user-password-reset/step-two.jpg
10 | :alt: Step 2
11 |
12 | .. figure:: ./images/user-password-reset/step-three.jpg
13 | :alt: Step 3
14 |
15 | .. figure:: ./images/user-password-reset/step-four.jpg
16 | :alt: Step 4
17 |
18 | .. figure:: ./images/user-password-reset/step-five.jpg
19 | :alt: Step 5
20 |
21 | 2. In the rescue shell, type: `cryptsetup open /dev/sda3 qubes` or `cryptsetup open /dev/nvme0n1p3 qubes` to unlock the encrypted root drive
22 |
23 | 3. Mount the root drive `mount /dev/mapper/qubes_dom0-root /mnt`
24 |
25 | 4. Change root to it `chroot /mnt`
26 |
27 | 5. Change the password `passwd user` (where "user" is your Qubes login)
28 | 6. Type in a new password and confirm
29 | 7. Type `exit` to exit the chroot
30 | 8. Type `reboot` and then boot as usal without the installation medium
31 |
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/ubuntu/change-disk-encryption-passphrase.rst:
--------------------------------------------------------------------------------
1 | Change Disk Encryption Passphrase
2 | =================================
3 |
4 | 1. To change the passphrase for disk encryption, first click on
5 | “Activities” in the upper left corner and enter “disk” in the search
6 | bar. Then select the “Disks” program that appears in the middle of
7 | the screen.
8 |
9 | .. figure:: ../images/change-disk-encryption-passphrase/1.png
10 | :alt: img1
11 |
12 |
13 |
14 | 2. Select the field that says “Luks”. Afterwards it should have an
15 | orange background.
16 |
17 | .. figure:: ../images/change-disk-encryption-passphrase/2.png
18 | :alt: img2
19 |
20 |
21 |
22 | 3. Left click on the gears and select “Change Passphrase” from the
23 | context menu.
24 |
25 | .. figure:: ../images/change-disk-encryption-passphrase/3.png
26 | :alt: img3
27 |
28 |
29 |
30 | 4. Enter "12345678" this was changed on the 10.04.2024 so if it's not working try the old default: "PleaseChangeMe" as the current passphrase
31 | and select a secure new one.
32 |
33 | .. figure:: ../images/change-disk-encryption-passphrase/4.png
34 | :alt: img4
35 |
36 |
37 |
38 | 5. Enter the your account password.
39 |
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/ubuntu/images/NitroPad-boot-options.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/ubuntu/images/NitroPad-boot-options.jpeg
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/ubuntu/images/UbuntuDiskPassword.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitropad-nitropc/ubuntu/images/UbuntuDiskPassword.png
--------------------------------------------------------------------------------
/source/components/nitropad-nitropc/ubuntu/nitrokey-app.rst:
--------------------------------------------------------------------------------
1 | Nitrokey App Installation
2 | =========================
3 |
4 | The Nitrokey App is included in Ubuntu's repositories since Ubuntu 18.04 (codename 'bionic') on. You can just install it via Software Center or by typing the following in a terminal:
5 |
6 | ::
7 |
8 | $ sudo apt update
9 |
10 | ::
11 |
12 | $ sudo apt install nitrokey-app
13 |
14 | Unfortunately, the App versions in the official Ubuntu repositories are often not up-to-date.
15 |
16 | More recent App versions
17 | ------------------------
18 |
19 | To get the most recent Nitrokey App you can add a separate repository which is maintained by Nitrokey.
20 |
21 | Please execute the following in a terminal to add the repository and install the Nitrokey App:
22 |
23 | .. hint::
24 |
25 | The PPA is not necessary for Ubuntu 22.04 and later. The previous versions of Ubuntu could still use it to update the app.
26 |
27 | ::
28 |
29 | $ sudo add-apt-repository ppa:nitrokey/nitrokey
30 |
31 | ::
32 |
33 | $ sudo apt install nitrokey-app
34 |
35 |
36 | Alternatively, you can use the snap package. Please see `here `__ for more information.
37 |
--------------------------------------------------------------------------------
/source/components/nitrophone/background-images.rst:
--------------------------------------------------------------------------------
1 | Background Images
2 | *****************
3 |
4 | You can use these nice background images:
5 |
6 | .. figure:: https://www.nitrokey.com/files/nitrophone/backgrounds/bg_logo_1.jpg
7 | :width: 200px
8 | :alt: Background image 1
9 |
10 | .. figure:: https://www.nitrokey.com/files/nitrophone/backgrounds/bg_logo_2.jpg
11 | :width: 200px
12 | :alt: Background image 2
13 |
14 | .. figure:: https://www.nitrokey.com/files/nitrophone/backgrounds/bg_logo_3.jpg
15 | :width: 200px
16 | :alt: Background image 3
17 |
--------------------------------------------------------------------------------
/source/components/nitrophone/headwind-mdm/index.rst:
--------------------------------------------------------------------------------
1 | Headwind MDM (HMDM)
2 | ************************
3 |
4 | Headwind MDM (HMDM) is a mobile device management (MDM) solution to manage NitroPhones and NitroTablets from a central interface.
5 | The software consists of a central interface (web panel) on a server and an app on every managed Nitrophone.
6 |
7 | .. contents:: :local:
8 |
9 | .. toctree::
10 | :maxdepth: 1
11 | :glob:
12 |
13 | Server Installation
14 | App Installation
15 |
16 |
--------------------------------------------------------------------------------
/source/components/nitrophone/images/boot-screen.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrophone/images/boot-screen.jpg
--------------------------------------------------------------------------------
/source/components/nitrophone/index.rst:
--------------------------------------------------------------------------------
1 | NitroPhone, NitroTablet
2 | ************************
3 |
4 | .. contents:: :local:
5 |
6 | Getting Started
7 | ###############
8 |
9 | By default you have a secure smartphone, already pre-installed with all the most necessary apps.
10 |
11 | 1. Set up a six-digit PIN to protect the phone. In cooperation with the security chip, this will ensure high security while maintaining good usability.
12 |
13 | 2. For extra hardening (optional): Go to Settings -> System -> Developer Options and disable the "OEM unlocking" setting. Afterwards disable the "Developer Options".
14 |
15 | 3. Please familiarize yourself with `using your GrapheneOS `__.
16 |
17 | For more details, see the following pages:
18 |
19 | .. toctree::
20 | :maxdepth: 1
21 | :glob:
22 |
23 | Apps
24 | Background Images
25 | Frequently Asked Questions
26 | Headwind MDM (HMDM)
27 |
28 |
--------------------------------------------------------------------------------
/source/components/nitrowall/backup-restore.rst:
--------------------------------------------------------------------------------
1 | Backup & Restore
2 | ================
3 |
4 | Before making any adjustments to the NitroWall configuration, you have the option of backing up the configuration and restoring it if necessary. How to do this is described in the following instructions:
5 |
6 | 1. Go to System -> Configuration -> Backups
7 | 2. In this menu you can perform the desired operations. You can restore specific areas of the configuration by selecting them via "Restore area".
8 | 3. If you can no longer access the web interface, it is also possible to perform the recovery via the command line interface. To do this, connect the NitroWall to a monitor and start it. After logging in, select item 13 "Restore a backup" and enter the number associated with the backup for the restore.
9 |
10 | .. figure:: ./images/backup-restore.png
11 | :alt: backup and restore
12 |
13 | .. figure:: ./images/cli-restore.jpg
14 | :alt: cli restore
15 |
--------------------------------------------------------------------------------
/source/components/nitrowall/dhcp.rst:
--------------------------------------------------------------------------------
1 | Using NitroWall as combined DHCP-Client/DHCP-Server
2 | ===================================================
3 |
4 | .. figure:: ./images/network.png
5 | :alt: Network with DHCP
6 |
7 | .. warning:: Note the correct mapping of interfaces to physical ports: Interfaces → Assignments
8 |
9 | 1. In "System → Wizard → Configure WAN Interface" set the value for IPv4 Configuration Type to DHCP
10 | 2. Follow this guide to configure the LAN interface for DHCP:
11 |
12 | https://docs.opnsense.org/manual/dhcp.html#using-dhcpv4
13 |
14 |
15 |
--------------------------------------------------------------------------------
/source/components/nitrowall/hardware.rst:
--------------------------------------------------------------------------------
1 | Hardware Compatibility
2 | ======================
3 |
4 | Whether a certain hardware can be operated under OPNSense or not depends on whether the corresponding driver is available. Since OPNSense is derived from FreeBSD, all drivers from FreeBSD are also available in OPNSense. A list of supported hardware can be found at:
5 |
6 | https://www.freebsd.org/releases/13.0R/hardware/
7 |
--------------------------------------------------------------------------------
/source/components/nitrowall/ids-ips.rst:
--------------------------------------------------------------------------------
1 | How to set up IDS/IPS with Suricata
2 | ===================================
3 |
4 | OPNSense uses Suricata to provide an IPS/IDS Service.
5 | Suricata is already installed and running after initial configuration.
6 |
7 | You find the administration, monitoring and logging settings via "Services -> Intrusion Detection".
8 |
9 | More information on how to configure IDS/IPS are available on:
10 |
11 | https://docs.opnsense.org/manual/ips.html
12 |
--------------------------------------------------------------------------------
/source/components/nitrowall/images/750_1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/750_1.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/750_2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/750_2.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/750_3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/750_3.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/750_4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/750_4.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/750_5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/750_5.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/750_6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/750_6.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/750_install_finish.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/750_install_finish.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/750_update.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/750_update.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/backup-restore.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/backup-restore.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/cli-restore.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/cli-restore.jpg
--------------------------------------------------------------------------------
/source/components/nitrowall/images/dashboard.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/dashboard.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/network.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/network.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/nitrowall-num-one.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/nitrowall-num-one.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/nitrowall-num-three.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/nitrowall-num-three.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/nitrowall-num-two.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/nitrowall-num-two.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/nitrowall_back.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/nitrowall_back.jpg
--------------------------------------------------------------------------------
/source/components/nitrowall/images/nitrowall_front.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/nitrowall_front.jpg
--------------------------------------------------------------------------------
/source/components/nitrowall/images/ntp-one.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/ntp-one.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/ntp-two.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/ntp-two.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/openwrt_installnw1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/openwrt_installnw1.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/openwrt_installnw2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/openwrt_installnw2.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/openwrt_installnw3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/openwrt_installnw3.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/openwrt_upgrade1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/openwrt_upgrade1.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/openwrt_upgrade2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/openwrt_upgrade2.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/openwrt_upgrade4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/openwrt_upgrade4.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/openwrt_upgrade5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/openwrt_upgrade5.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/reload.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/reload.png
--------------------------------------------------------------------------------
/source/components/nitrowall/images/seal.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/nitrowall/images/seal.png
--------------------------------------------------------------------------------
/source/components/nitrowall/lan-bridge.rst:
--------------------------------------------------------------------------------
1 | How to set up a LAN Bridge
2 | ==========================
3 |
4 | Details on how to set up a LAN bridge you can find on:
5 |
6 | https://docs.opnsense.org/manual/how-tos/lan_bridge.html
7 |
--------------------------------------------------------------------------------
/source/components/nitrowall/ntp.rst:
--------------------------------------------------------------------------------
1 | How to Fix NTP
2 | ==============
3 |
4 | By default, the NitroWall arrives at your site with a pre-configured NTPd server. The firewall blocks all access that does not occur via a LAN interface. If you have large deviations in the system time, you can fix them as follows:
5 |
6 | 1. Set the time to match your time zone via the cmdline interface (reboot required) using `date`
7 | 2. Switch to the OPNsense GUI again
8 | 3. Go to Menu → Services → Network Time → General
9 | 4. Set "Interfaces" from "All (recommended)" to "LAN" (Or WAN if you are connected via WAN interface)
10 | 5. Restart the service e.g. by the restart button in the top-right corner
11 |
12 |
13 |
14 | .. figure:: ./images/ntp-one.png
15 | :alt: Set Interface to LAN
16 |
17 | .. figure:: ./images/ntp-two.png
18 | :alt: NTP restart
19 |
--------------------------------------------------------------------------------
/source/components/nitrowall/nw750/factory-reset.rst:
--------------------------------------------------------------------------------
1 | Factory Reset
2 | =============
3 |
4 | .. contents:: :local:
5 |
6 | 1. Make sure the NW750 is connected to a power source or has at least 50% batterie left.
7 | 2. Press and hold the reset button (next to the microSD card slot) for 10 seconds.
8 | 3. This will trigger a reboot which takes ca. 3 minutes.
9 | 4. In order to be able to change your device's IMEI, `reinstall blue-merle `_.
10 |
--------------------------------------------------------------------------------
/source/components/nitrowall/nw750/faq.rst:
--------------------------------------------------------------------------------
1 | NitroWall NW750 FAQ
2 | ===================
3 |
4 | .. faq:: Does the NitroWall NW750 support eSIM?
5 |
6 | Yes, but when using an eSIM it's not possible to use blue-merle to change the eUICCID.
7 | Thus for privacy reasons we don't recommend using an eSIM.
8 |
9 |
--------------------------------------------------------------------------------
/source/components/nitrowall/nw750/firmware-update.rst:
--------------------------------------------------------------------------------
1 | Firmware Update
2 | ===============
3 | .. contents:: :local:
4 |
5 | For the general firmware update follow `this guide `_ . Afterwards we need to reinstall blue-merle:
6 |
7 | 1. Make sure the NW750 has a working Internet connection
8 | 2. Connect with the WiFi and login to the alternativ OpenWrt at https://192.168.8.1/cgi-bin/luci/ using username root and the same password used for the other web interface
9 |
10 | .. image:: /components/nitrowall/images/750_1.png
11 |
12 | 3. Go to "System" -> Software
13 |
14 | .. image:: /components/nitrowall/images/750_2.png
15 |
16 | 4. Click "update list". This can take a while but if it fails it means you have no Internet connection.
17 |
18 | .. image:: /components/nitrowall/images/750_3.png
19 |
20 | .. image:: /components/nitrowall/images/750_4.png
21 |
22 | .. image:: /components/nitrowall/images/750_5.png
23 |
24 | 5. click "upload packackge" and upload `blue-merle `_
25 |
26 | .. image:: /components/nitrowall/images/750_6.png
27 |
28 | 6. Click "install"
29 |
30 | .. image:: /components/nitrowall/images/750_update.png
31 |
32 | .. image:: /components/nitrowall/images/750_install_finish.png
33 |
34 | Your firmware has been successfully updated.
35 |
--------------------------------------------------------------------------------
/source/components/nitrowall/nw750/imei-change.rst:
--------------------------------------------------------------------------------
1 | Changing IMEI
2 | =============
3 |
4 | To be able to change the IMEI of your device, the software `blue merle `_ is pre-installed.
5 |
6 | .. note:: After performing a factory reset, you need to `reinstall `_ blue-merle.
7 |
8 | .. contents:: :local:
9 |
10 | There a different ways to change the IMEI. The simplest is to use the toogle on the side of the NW750:
11 |
12 | 1. Switch the hardware toggle.
13 | 2. Follow the instructions on the display, which will prompt you to replace the SIM card eventually.
14 | 3. After replacing the SIM card, flip the toggle again. This changes the IMEI and powers off your device.
15 | 4. You should change your geographical location before booting again.
16 |
17 | For more details see `this documentation `_.
18 |
19 | .. note:: Occasionally, commands executed on the device may take longer than expected. This can result in the display switching off (standby) for a few seconds before displaying the expected final message (e.g. instructions to replace the SIM card). Wait for the final message to appear before pulling the switch again. If no message is displayed after a minute, the script might have exited or you might have missed the message. In this case, pull the switch to continue / restart the process.
20 |
--------------------------------------------------------------------------------
/source/components/nitrowall/nw750/index.rst:
--------------------------------------------------------------------------------
1 | NitroWall NW750
2 | ===============
3 |
4 | Getting Started
5 | ---------------
6 |
7 | .. contents:: :local:
8 |
9 | 1. Connect to the Wifi network **GL-E750-XXX** with password: **goodlife**.
10 | 2. Open the webinterface at http://192.168.8.1
11 | 3. For more help see `this documentation `_
12 |
13 | .. toctree::
14 | :hidden:
15 | :maxdepth: 1
16 | :glob:
17 |
18 | factory-reset.rst
19 | imei-change.rst
20 | firmware-update.rst
21 | Frequently Asked Questions
22 |
23 |
--------------------------------------------------------------------------------
/source/components/nitrowall/sealed-hardware.rst:
--------------------------------------------------------------------------------
1 | Verify Sealed Hardware
2 | ======================
3 |
4 | Your NitroWall has been delivered in a sealed packaging and with sealed screws.
5 | We will send you a picture of your NitroWall before shipping. Please
6 | compare the image to your packaged NitroWall. If you notice any changes,
7 | please contact us to arrange further action.
8 |
9 |
10 | .. figure:: ./images/nitrowall-num-one.png
11 | :alt: sealing number one
12 |
13 | .. figure:: ./images/nitrowall-num-two.png
14 | :alt: sealing number two
15 |
16 | .. figure:: ./images/nitrowall-num-three.png
17 | :alt: sealing number three
18 |
--------------------------------------------------------------------------------
/source/components/shared-faqs/hyperlinks.rst.inc:
--------------------------------------------------------------------------------
1 |
2 |
3 | .. _WebAuthn.io: https://webauthn.io/
4 | .. _webautn.bin.coffee: https://webauthn.bin.coffee/
5 | .. _chrome://settings/securityKeys: chrome://settings/securityKeys
6 |
7 | .. _nfc.fail: https://nfc.fail/
8 |
9 | ..
10 | _Links for TRNG questions in Pro/Storage FAQs
11 | .. _scdrand: http://www.incenp.org/dvlpt/scdrand.html
12 | .. _This script: https://lists.gt.net/gnupg/users/80681#80681
13 | .. _created a systemd file: https://support.nitrokey.com/t/scdrand-systemd-service-and-gentoo-ebuild/1164
14 | .. _ebuild for Gentoo: https://github.com/comio/comio-overlay/tree/master/app-crypt/scdtools
15 |
16 | .. _BSI TR-03116: https://www.bsi.bund.de/DE/Themen/Unternehmen-und-Organisationen/Standards-und-Zertifizierung/Technische-Richtlinien/TR-nach-Thema-sortiert/tr03116/TR-03116_node.html
17 |
18 | .. _disabling Enforce Attestation: https://learn.microsoft.com/en-us/azure/active-directory/authentication/howto-authentication-passwordless-security-key#fido-security-key-optional-settings
19 |
--------------------------------------------------------------------------------
/source/components/shared-faqs/nitrokeys.rst.inc:
--------------------------------------------------------------------------------
1 | .. faq:: Which Operating Systems are supported?
2 |
3 | Windows, Linux and macOS.
4 |
5 | .. faq:: What can I use the Nitrokey for?
6 |
7 | See the `overview`_ of supported use cases.
8 |
9 | .. _overview: https://www.nitrokey.com/products/nitrokeys
10 |
11 |
--------------------------------------------------------------------------------
/source/components/software/index.rst:
--------------------------------------------------------------------------------
1 | Software
2 | ========
3 |
4 | .. toctree::
5 | :maxdepth: 1
6 | :titlesonly:
7 |
8 | nk-app2/index
9 | nitropy/index
10 | nitrokey-sdk-py/index
11 |
--------------------------------------------------------------------------------
/source/components/software/nitropy/all-platforms/index.rst:
--------------------------------------------------------------------------------
1 | nitropy Documentation For All Platforms
2 | =======================================
3 |
4 | .. toctree::
5 | :maxdepth: 1
6 |
7 | installation
8 | test
9 |
--------------------------------------------------------------------------------
/source/components/software/nitropy/index.rst:
--------------------------------------------------------------------------------
1 | nitropy
2 | =======
3 |
4 | **nitropy** is a command-line interface for the Nitrokey FIDO2, Nitrokey Start, Nitrokey 3, Nitrokey Passkey and NetHSM.
5 |
6 | .. toctree::
7 | :maxdepth: 2
8 |
9 | All Platforms
10 | Windows
11 | Linux
12 |
--------------------------------------------------------------------------------
/source/components/software/nitropy/linux/index.rst:
--------------------------------------------------------------------------------
1 | nitropy Documentation For Linux
2 | ===============================
3 |
4 | .. toctree::
5 | :maxdepth: 1
6 |
7 | udev
8 |
--------------------------------------------------------------------------------
/source/components/software/nitropy/linux/udev.rst:
--------------------------------------------------------------------------------
1 | Setting up The udev Rules
2 | =========================
3 |
4 | To be able to access your devices without root privileges, nitropy requires the
5 | Nitrokey udev rules. If they are not shipped with your distribution, you can
6 | install the rules manually::
7 |
8 | wget https://raw.githubusercontent.com/Nitrokey/nitrokey-udev-rules/main/41-nitrokey.rules
9 | sudo mv 41-nitrokey.rules /etc/udev/rules.d/
10 |
11 | The legacy rules are also shipped with `libnitrokey `__.
12 |
13 |
14 | You most likely want to change the owner and the permissions of this file::
15 |
16 | sudo chown root:root /etc/udev/rules.d/41-nitrokey.rules
17 | sudo chmod 644 /etc/udev/rules.d/41-nitrokey.rules
18 |
19 | After installing the rules, you need to reload them::
20 |
21 | sudo udevadm control --reload-rules && sudo udevadm trigger
22 |
23 | If you still cannot access your device, try again after rebooting your system.
24 | If you encouter issues, look at this `github comment `__
25 | for some debugging hints.
26 |
27 |
--------------------------------------------------------------------------------
/source/components/software/nitropy/windows/index.rst:
--------------------------------------------------------------------------------
1 | nitropy Documentation For Windows
2 | =================================
3 |
4 | .. toctree::
5 | :maxdepth: 1
6 |
7 | installation
8 |
--------------------------------------------------------------------------------
/source/components/software/nitropy/windows/windowswarning/keep-anyway.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/software/nitropy/windows/windowswarning/keep-anyway.png
--------------------------------------------------------------------------------
/source/components/software/nitropy/windows/windowswarning/threedotsmore.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/components/software/nitropy/windows/windowswarning/threedotsmore.png
--------------------------------------------------------------------------------
/source/components/software/nk-app2/index.rst:
--------------------------------------------------------------------------------
1 | Nitrokey App 2
2 | ==============
3 | Nitrokey App 2 is the graphical application for Nitrokey 3 devices. For Nitrokey Pro and Nitrokey Storage, use `Nitrokey App 1 `__ instead.
4 |
5 | Installation
6 | ------------
7 | Download it for `Linux `__ , `Windows `__ or `macOS `__ (pipenv only).
8 |
9 |
10 | Supported Features
11 | ------------------
12 |
13 | - Updating the firmware
14 | - One-Time Passwords (OTP)
15 | - Password Storage
16 |
17 | Planned Features
18 | ----------------
19 |
20 | - PIN management
21 | - macOS support
22 |
23 | .. toctree::
24 | :maxdepth: 1
25 | :glob:
26 | :hidden:
27 |
28 | *
29 |
30 |
--------------------------------------------------------------------------------
/source/components/software/nk-app2/installation-linux.rst:
--------------------------------------------------------------------------------
1 | Linux Install
2 | =============
3 |
4 | Flathub / Flatpak
5 | -----------------
6 |
7 | The preferred installation method for Linux is through `Flathub `_:
8 |
9 | 1. `Setup `_ flathub / flatpak
10 | 2. Execute ``flatpak install flathub com.nitrokey.nitrokey-app2`` to install (or use the native Flathub integration of your Operating System i.e., "Software" on Ubuntu systems)
11 | 3. :doc:`Set up the udev rules for nitropy <../nitropy/linux/udev>`
12 | 4. Start Nitrokey App2 using either ``flatpak run com.nitrokey.nitrokey-app2`` or use the created entry in your start-menu
13 |
14 |
15 | .. note::
16 | Currently updating a Nitrokey 3 Mini is not supported through the flatpak package. This will be
17 | fixed in one of the next releases.
18 |
19 |
20 | Manual Installation
21 | -------------------
22 |
23 | 1. `Download `__ the binary for Linux Nitrokey App 2
24 | 2. Extract the archive and set the binary as executable
25 | 3. :doc:`Set up the udev rules for nitropy <../nitropy/linux/udev>`
26 | 4. Execute the binary
27 |
--------------------------------------------------------------------------------
/source/components/software/nk-app2/installation-mac.rst:
--------------------------------------------------------------------------------
1 | macOS Install
2 | =============
3 |
4 | Installing the Nitrokey App 2 via Pipenv
5 | ----------------------------------------
6 |
7 | This is the simplest way for now to install the Nitrokey App 2 on macOS. Further methods are being worked on.
8 |
9 | 1. `Install `__ pipenv if it is not already installed.
10 |
11 | 2. Create a work directory:
12 |
13 | .. code-block::
14 |
15 | mkdir nitrokeyapp
16 |
17 | 3. Enter the directory:
18 |
19 | .. code-block::
20 |
21 | cd nitrokeyapp
22 |
23 | 4. Install the app via pipenv:
24 |
25 | .. code-block::
26 |
27 | pipenv install nitrokeyapp
28 |
29 | The app can be updated the following way:
30 |
31 |
32 |
33 | Updating
34 | --------
35 |
36 | 1. Enter the work directory:
37 |
38 | .. code-block::
39 |
40 | cd nitrokeyapp
41 |
42 | 2. Update the app:
43 |
44 | .. code-block::
45 |
46 | pipenv update
47 |
48 |
49 | Starting
50 | --------
51 |
52 | To run the application:
53 |
54 | 1. Enter the work directory:
55 |
56 | .. code-block::
57 |
58 | cd nitrokeyapp
59 |
60 | 2. Update the app:
61 |
62 | .. code-block::
63 |
64 | pipenv run nitrokeyapp
65 |
--------------------------------------------------------------------------------
/source/components/software/nk-app2/passwords.rst:
--------------------------------------------------------------------------------
1 | Passwords
2 | =========
3 |
4 | .. note::
5 | You can store up to 50 passwords.
6 |
7 | Password entries may consist of:
8 |
9 | * Login
10 | * Password
11 | * Comment (for e.g. a website reference)
12 | * OTP (HOTP or TOTP)
13 |
14 | All fields are optional and can be edited and added at any time using the "Edit" button.
15 |
16 | For a list of websites supporting OTP have a look at `dongleauth.com `__.
17 |
18 | Usage
19 | -----
20 |
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.
22 |
23 | You can choose to create a protected entry by checking the "Protect with PIN" box when adding a new entry.
24 |
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.
26 |
--------------------------------------------------------------------------------
/source/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/favicon.ico
--------------------------------------------------------------------------------
/source/images/qubes/ChangeDiskPasswordQubes.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/images/qubes/ChangeDiskPasswordQubes.png
--------------------------------------------------------------------------------
/source/images/qubes/install-nitrokey-app-images/Settings-fedora.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/images/qubes/install-nitrokey-app-images/Settings-fedora.png
--------------------------------------------------------------------------------
/source/images/qubes/install-nitrokey-app-images/Settings-sys-usb.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/images/qubes/install-nitrokey-app-images/Settings-sys-usb.png
--------------------------------------------------------------------------------
/source/images/qubes/install-nitrokey-app-images/Settings-sys-usb_2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/images/qubes/install-nitrokey-app-images/Settings-sys-usb_2.png
--------------------------------------------------------------------------------
/source/images/qubes/install-nitrokey-app-images/Settings-sys-usb_3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/images/qubes/install-nitrokey-app-images/Settings-sys-usb_3.png
--------------------------------------------------------------------------------
/source/images/qubes/install-nitrokey-app-images/fedora-terminal.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/images/qubes/install-nitrokey-app-images/fedora-terminal.png
--------------------------------------------------------------------------------
/source/images/qubes/install-nitrokey-app-images/sys-usb-nitrokey-app.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/images/qubes/install-nitrokey-app-images/sys-usb-nitrokey-app.png
--------------------------------------------------------------------------------
/source/images/qubes/install-nitrokey-app-images/sys-usb-terminal.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/images/qubes/install-nitrokey-app-images/sys-usb-terminal.png
--------------------------------------------------------------------------------
/source/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Nitrokey/nitrokey-documentation/b5579768ab346d81d36ec514c851c50998a2b8e0/source/logo.png
--------------------------------------------------------------------------------