aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2020-01-06 11:12:50 +0000
committerRobin Krahl <robin.krahl@ireas.org>2020-01-06 12:14:34 +0100
commite0baabd1046087a9f545d9ef65539c23eb91e85f (patch)
tree6bad8c311f67d2b58001f15c099d05b860b5a188
parentd7f34844b529a955d94ab36237374256688445f1 (diff)
downloadnitrokey-rs-e0baabd1046087a9f545d9ef65539c23eb91e85f.tar.gz
nitrokey-rs-e0baabd1046087a9f545d9ef65539c23eb91e85f.tar.bz2
Update the list of unsupported functions
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.
-rw-r--r--CHANGELOG.md8
-rw-r--r--README.md13
-rw-r--r--TODO.md8
3 files changed, 20 insertions, 9 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d4451bc..71d2377 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,6 +3,14 @@ Copyright (C) 2019-2020 Robin Krahl <robin.krahl@ireas.org>
SPDX-License-Identifier: CC0-1.0
-->
+# Unreleased
+- List these libnitrokey functions as unsupported:
+ - `NK_change_firmware_password_pro`
+ - `NK_connect_with_ID`
+ - `NK_enable_firmware_update_pro`
+ - `NK_list_devices_by_cpuID`
+ - `NK_send_startup`
+
# v0.4.0 (2020-01-02)
- Remove the `test-pro` and `test-storage` features.
- Implement `Display` for `Version`.
diff --git a/README.md b/README.md
index 12a9f6d..d62e38e 100644
--- a/README.md
+++ b/README.md
@@ -26,13 +26,20 @@ available but still under development.
The following functions provided by `libnitrokey` are deliberately not
supported by `nitrokey-rs`:
+- `NK_connect_with_ID`, `NK_list_devices_by_cpuID`. These functions can be
+ replaced by calls to `NK_connect_with_path` and `NK_list_devices`, which
+ also have a cleaner API.
+- `NK_enable_firmware_update_pro`, `NK_change_firmware_password_pro`. These
+ functions execute commands that are not yet supported by the Nitrokey Pro
+ firmware.
- `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_is_AES_supported`. This function is no longer needed for Nitrokey
+ devices with a recent firmware version.
+- `NK_send_startup`. Currently, this function is redundant to `NK_get_time`.
- `NK_set_unencrypted_volume_rorw_pin_type_user`,
`NK_set_unencrypted_read_only`, `NK_set_unencrypted_read_write`. These
- methods are only relevant for older firmware versions (pre-v0.51). As the
+ functions 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.
- `NK_totp_get_time`, `NK_status`. These functions are deprecated.
diff --git a/TODO.md b/TODO.md
index 54525ef..8adea87 100644
--- a/TODO.md
+++ b/TODO.md
@@ -4,18 +4,13 @@ SPDX-License-Identifier: CC0-1.0
-->
- Add support for the currently unsupported commands:
- - `NK_send_startup`
- `NK_fill_SD_card_with_random_data`
- `NK_get_SD_usage_data`
- `NK_get_progress_bar_value`
- - `NK_list_devices_by_cpuID`
- - `NK_connect_with_ID`
- - `NK_get_status`
+ - `NK_get_status` -- waiting for [libnitrokey issue 166][]
- `NK_list_devices`
- `NK_free_device_info`
- `NK_connect_with_path`
- - `NK_enable_firmware_update_pro`
- - `NK_change_firmware_password_pro`
- Clear passwords from memory.
- Lock password safe in `PasswordSafe::drop()` (see [nitrokey-storage-firmware
issue 65][]).
@@ -23,4 +18,5 @@ SPDX-License-Identifier: CC0-1.0
- Check timing in Storage tests.
- Consider restructuring `device::StorageStatus`.
+[libnitrokey issue 166]: https://github.com/Nitrokey/libnitrokey/issues/166
[nitrokey-storage-firmware issue 65]: https://github.com/Nitrokey/nitrokey-storage-firmware/issues/65