13 unstable releases (3 breaking)
✓ Uses Rust 2018 edition
|0.4.0-alpha.1||Feb 2, 2019|
|0.4.0-alpha.0||Jan 27, 2019|
|0.3.4||Jan 20, 2019|
|0.2.3||Dec 31, 2018|
|0.1.1||May 20, 2018|
#3 in #otp
122 downloads per month
Used in 2 crates
A libnitrokey wrapper for Rust providing access to Nitrokey devices.
libnitrokey version is built from source. The host system
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.
The following functions provided by
libnitrokey are deliberately not
NK_get_device_model. We know which model we connected to, so we can provide this information without calling
NK_get_time. This method is useless as it will always cause a timestamp error on the device (see pull request #114 for
NK_get_status. This method only provides a string representation of data that can be accessed by other methods (firmware version, serial number, configuration).
NK_get_status_storage_as_string. This method only provides an incomplete string representation of the data returned by
NK_is_AES_supported. This method is no longer needed for Nitrokey devices with a recent firmware version.
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 outdated versions.
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
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
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
For bug reports, patches, feature requests or other messages, please send a mail to firstname.lastname@example.org.
nitrokey-rs complies with version 2.0 of the REUSE practices.