Copyright (C) 2019 Robin Krahl <email@example.com>
A libnitrokey wrapper for Rust providing access to Nitrokey devices.
The required [`libnitrokey`] version is built from source. The host system
must provide `libhidapi-libusb0` (Linux) or `libhidapi` (non-Linux) in the
default library search path. Depending on your system, you might also have to
install the [Nitrokey udev rules].
Currently, this crate provides access to the common features of the Nitrokey
Pro and the Nitrokey Storage: general configuration, OTP generation and the
password safe. Basic support for the secure storage on the Nitrokey Storage is
available but still under development.
### Unsupported Functions
The following functions provided by `libnitrokey` are deliberately not
supported by `nitrokey-rs`:
- `NK_get_device_model`. We know which model we connected to, so we can
provide this information without calling `libnitrokey`.
- `NK_is_AES_supported`. This method is no longer needed for Nitrokey devices
with a recent firmware version.
`NK_set_unencrypted_read_only`, `NK_set_unencrypted_read_write`. These
methods are only relevant for older firmware versions (pre-v0.51). As the
Nitrokey Storage firmware can be updated easily, we do not support these
- `NK_totp_get_time`, `NK_status`. These functions are deprecated.
- `NK_read_HOTP_slot`. This function is only available for HOTP slots, not for
TOTP. We will support it once both types are supported by `libnitrokey`.
- All `*_as_string` functions that return string representations of data
returned by other functions.
This crate has tests for different scenarios: Some tests require that no
Nitrokey device is connected, others require a Nitrokey Storage or a Nitrokey
Pro. We use the [`nitrokey-test`] crate to select the test cases. You can
just run `cargo test` to auto-detect connected Nitrokey devices and to run the
appropriate tests. If you want to manually select the tests, set the
`NITROKEY_TEST_GROUP` environment variable to `nodev` (no device connected),
`pro` (Nitrokey Pro connected) or `storage` (Nitrokey Storage connected).
Note that the tests assume that the device’s passwords are the factory defaults
(admin PIN `12345678`, user PIN `123456`, update password `12345678`) and that
an AES key has been built. Some tests will overwrite the data stored on the
Nitrokey device or perform a factory reset. Never execute the tests if you
unless yout want to destroy all data on all connected Nitrokey devices!
Thanks to Nitrokey UG for providing a Nitrokey Storage to support the
development of this crate. Thanks to Daniel Mueller for contributions to
`nitrokey-rs` and for the `nitrokey-test` crate.
For bug reports, patches, feature requests or other messages, please send a
mail to [firstname.lastname@example.org].
This project is licensed under the [MIT License]. `libnitrokey` is licensed
under the [LGPL-3.0].
`nitrokey-rs` complies with [version 2.0 of the REUSE practices][reuse].
[Nitrokey udev rules]: https://www.nitrokey.com/documentation/frequently-asked-questions-faq#openpgp-card-not-available
[MIT license]: https://opensource.org/licenses/MIT