summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin Krahl <me@robin-krahl.de>2018-05-18 09:50:09 +0200
committerSzczepan Zalega <szczepan@nitrokey.com>2018-05-19 17:19:27 +0200
commitecd0a6993d90bad030a568c88f804c9f8eaa6315 (patch)
treeed6dbc13e837351e4df6de5b0b2408c1c400f508
parentd0155ee65bd26a21190f655a53c01b2f08d84427 (diff)
downloadlibnitrokey-ecd0a6993d90bad030a568c88f804c9f8eaa6315.tar.gz
libnitrokey-ecd0a6993d90bad030a568c88f804c9f8eaa6315.tar.bz2
Mark NK_get_totp_code arguments as unused
According to the GetTOTP class in stick10_commands_0.8.h and after firmware inspection, the challenge, last_totp_time and last_interval arguments for the get_TOTP_code method are unused. This patch adds this information to the doc comment for NK_get_totp_code and NK_get_totp_code_PIN.
-rw-r--r--NK_C_API.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/NK_C_API.h b/NK_C_API.h
index 222e5e1..5985c0b 100644
--- a/NK_C_API.h
+++ b/NK_C_API.h
@@ -265,9 +265,9 @@ extern "C" {
/**
* Get TOTP code from the device
* @param slot_number TOTP slot number, slot_number<15
- * @param challenge TOTP challenge
- * @param last_totp_time last time
- * @param last_interval last interval
+ * @param challenge TOTP challenge -- unused
+ * @param last_totp_time last time -- unused
+ * @param last_interval last interval --unused
* @return TOTP code
*/
NK_C_API char * NK_get_totp_code(uint8_t slot_number, uint64_t challenge, uint64_t last_totp_time,
@@ -276,9 +276,9 @@ extern "C" {
/**
* Get TOTP code from the device (PIN protected)
* @param slot_number TOTP slot number, slot_number<15
- * @param challenge TOTP challenge
- * @param last_totp_time last time
- * @param last_interval last interval
+ * @param challenge TOTP challenge -- unused
+ * @param last_totp_time last time -- unused
+ * @param last_interval last interval -- unused
* @param user_temporary_password char[25] user temporary password if PIN protected OTP codes are enabled,
* otherwise should be set to empty string - ''
* @return TOTP code