diff options
authorRobin Krahl <robin.krahl@ireas.org>2019-07-08 21:13:11 +0000
committerRobin Krahl <robin.krahl@ireas.org>2019-07-08 23:19:02 +0200
commit445e920986db276d0c5c39709aa76dd290773e8f (patch)
parent34f7022ce078dc132734873a3efdefe3d6d4399a (diff)
Update list of new and unsupported functions
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.
2 files changed, 6 insertions, 15 deletions
diff --git a/README.md b/README.md
index 8c596eb..a29ac6f 100644
--- a/README.md
+++ b/README.md
@@ -28,13 +28,6 @@ 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_get_time`. This method is useless as it will always cause a timestamp
- error on the device (see [pull request #114][] for `libnitrokey` for details).
-- `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_get_status_storage`.
- `NK_is_AES_supported`. This method is no longer needed for Nitrokey devices
with a recent firmware version.
- `NK_set_unencrypted_volume_rorw_pin_type_user`,
@@ -42,6 +35,11 @@ supported by `nitrokey-rs`:
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.
+- `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.
## Tests
@@ -82,7 +80,6 @@ under the [LGPL-3.0][].
[`libnitrokey`]: https://github.com/nitrokey/libnitrokey
[`nitrokey-test`]: https://github.com/d-e-s-o/nitrokey-test
[nitrokey-rs-dev@ireas.org]: mailto:nitrokey-rs-dev@ireas.org
-[pull request #114]: https://github.com/Nitrokey/libnitrokey/pull/114
[MIT license]: https://opensource.org/licenses/MIT
[LGPL-3.0]: https://opensource.org/licenses/lgpl-3.0.html
[reuse]: https://reuse.software/practices/2.0/
diff --git a/TODO.md b/TODO.md
index d7c8874..efa66d3 100644
--- a/TODO.md
+++ b/TODO.md
@@ -6,22 +6,16 @@ SPDX-License-Identifier: MIT
- Add support for the currently unsupported commands:
- `NK_send_startup`
- `NK_fill_SD_card_with_random_data`
- - `NK_get_SD_usage_data_as_string`
+ - `NK_get_SD_usage_data`
- `NK_get_progress_bar_value`
- `NK_list_devices_by_cpuID`
- `NK_connect_with_ID`
-- Evaluate the changes in libnitrokey 3.5:
- - `NK_get_SD_usage_data`
- `NK_get_status`
- - `NK_get_status_as_string`
- `NK_list_devices`
- `NK_free_device_info`
- `NK_connect_with_path`
- `NK_enable_firmware_update_pro`
- `NK_change_firmware_password_pro`
- - `NK_read_HOTP_slot`
- - `NK_status` (deprecated)
- - `NK_get_progress_bar_value` (return value)
- Clear passwords from memory.
- Lock password safe in `PasswordSafe::drop()` (see [nitrokey-storage-firmware
issue 65][]).