aboutsummaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAge
* Fix link to examples in READMERobin Krahl2020-01-14
| | | | | | | docs.rs seems to support only versioned links to source files. This patch replaces the link to docs.rs with a link to git.ireas.org to avoid having to update the link with every release. (Note that the last release already contained a link to the wrong version.)
* Update readme: usage, features, system libnitrokeyRobin Krahl2020-01-14
| | | | | | | | | This patch updates the readme with: - more usage information, especially a pointer to the examples and to nitrocli, - information about the supported features (= everything), - information on how to use the system libnitrokey instead of building it from source.
* Add the fill_sd_card function to StorageRobin Krahl2020-01-14
| | | | | | | | This patch adds support for libnitrokey’s NK_fill_SD_card_with_random_data function. It is executed by the fill_sd_card function of the Storage struct. We also add a new test case that is set to ignore because it takes between 30 and 60 minutes to run.
* Update the list of unsupported functionsRobin Krahl2020-01-06
| | | | | | | After some more research, I decided not to implement some of the methods provided by libnitrokey. This patch adds them to the list of unsupported functions in the readme, and removes them from the list of unimplemented functions in the todo list.
* Update and correct the readme fileRobin Krahl2019-12-27
| | | | | This patch updates the readme regarding the support by Nitrokey UG and fixes an editing error in the test section.
* Document Minium Supported Rust Version in readme fileRobin Krahl2019-12-27
| | | | | | The version 1.34.2 is picked arbitrarily as it is the Rust version in Debian buster and nitrocli is known to work with it. Earlier versions might work too, but they might break with any future release.
* Change license for configuration and documentation to CC0-1.0Robin Krahl2019-12-27
|
* Comply with version 3.0 of the REUSE specificationRobin Krahl2019-12-27
| | | | | | To comply with the new version 3.0 of the REUSE specification, we have to add a copyright header to the .gitignore file and move the LICENSE file to LICENSES/MIT.txt.
* Update list of new and unsupported functionsRobin Krahl2019-07-08
| | | | | | | | | | | | | | | This patch updates the list of unsupported functions in the README and the TODO and the list of functions changed in the libnitrokey 3.5 release: - List all `*_as_string` functions as unsupported. - List deprecated functions as unsupported. - List `NK_read_HOTP_slot` as unsupported until an equivalent function for TOTP exists. - Ignore the changes to `NK_get_progress_bar_value` as the function is not yet used by `nitrokey-rs`. - Add the new functions from version 3.5 to the list of missing functions.
* Add set_encrypted_volume_mode method to StorageRobin Krahl2019-01-31
| | | | | | | | | | Previously, we considered this command as unsupported as it only was available with firmware version 0.49. But as discussed in nitrocli issue 80 [0], it will probably be re-enabled in future firmware versions. Therefore this patch adds the set_encrypted_volume_mode to Storage. [0] https://github.com/d-e-s-o/nitrocli/issues/80
* Add tolerance for timing issues to the TOTP testsRobin Krahl2019-01-25
| | | | | | The TOTP test with the timestamp 59 often fails as the Nitrokey’s clock ticks between setting the time and generating the TOTP code. This patch also allows the TOTP code for timestamp 60 for this test case.
* Add license and copyright informationRobin Krahl2019-01-23
| | | | | | | This patch adds license and copyright information to all files to make nitrokey-rs compliant with the REUSE practices [0]. [0] https://reuse.software/practices/2.0/
* Document that NK_is_AES_supported is unsupportedRobin Krahl2019-01-16
| | | | | | NK_is_AES_supported is not needed for newer firmware versions of the Pro and Storage, see this discussion for more information: https://github.com/Nitrokey/libnitrokey/issues/142
* Document unsupported outdated functionsRobin Krahl2019-01-12
| | | | | | | | | | We do not support old firmware versions on the Nitrokey Storage, so we document that these outdated functions are not supported: - NK_set_unencrypted_volume_rorw_pin_type_user - NK_set_unencrypted_read_only - NK_set_unencrypted_read_write - NK_set_encrypted_read_only - NK_set_encrypted_read_write
* Update readme and todo for NK_get_device_modelRobin Krahl2019-01-11
|
* Update README after test refactoringRobin Krahl2019-01-05
|
* Remove the Cargo.toml extract from READMERobin Krahl2018-12-30
| | | | | The Cargo.toml extract in the README does not provide any real value, but it adds maintenance effort. Therefore it is removed in this patch.
* Remove test-no-device featureRobin Krahl2018-12-16
| | | | | | | Currently, the test-no-device feature is used for tests that expect no Nitrokey to be connected. Yet test-no-device is equivalent to not test-pro and not test-storage. Therefore, this patch removes the test-no-device feature.
* Release v0.2.1v0.2.1Robin Krahl2018-12-10
|
* Update READMERobin Krahl2018-12-10
|
* Release v0.2.0v0.2.0Robin Krahl2018-12-10
|
* Update readme for Nitrokey StorageRobin Krahl2018-06-06
|
* Update test documentation in the readmeRobin Krahl2018-05-31
|
* Group tests by tested functionalityRobin Krahl2018-05-28
|
* Remove get_major_firmware_version reference in readmeRobin Krahl2018-05-21
| | | | | | The problem with get_major_firmware_version is fixed as we now use libnitrokey v3.3. Therefore the corresponding section in the readme can be removed.
* Release v0.1.1v0.1.1Robin Krahl2018-05-21
|
* Update nitrokey-sys dependency to v3.3.0Robin Krahl2018-05-21
| | | | | | | Now libnitrokey v3.3 is compiled from source, fixing the problems with older libnitrokey versions (freeing strings, firmware version getter). Also, bindgen is no longer a build dependency. This makes the build process a lot faster.
* Initial commitRobin Krahl2018-05-19
generated by cgit v1.2.3 (git 2.46.0) at 2024-11-21 22:18:13 +0000