diff options
| author | Szczepan Zalega <szczepan@nitrokey.com> | 2018-04-19 12:32:44 +0200 |
|---|---|---|
| committer | Szczepan Zalega <szczepan@nitrokey.com> | 2018-04-19 13:18:46 +0200 |
| commit | 5d4d15fd8c83d84c25dd9675eedcecaa52dd9e96 (patch) | |
| tree | 8f16b40a50ebb9f5f7a16551287935a40c9e64bd /NK_C_API.h | |
| parent | 961c30f7172228bbee84eefa6aaeb24f0c1a35e6 (diff) | |
| download | libnitrokey-5d4d15fd8c83d84c25dd9675eedcecaa52dd9e96.tar.gz libnitrokey-5d4d15fd8c83d84c25dd9675eedcecaa52dd9e96.tar.bz2 | |
C API docs - mention 320-bits secret for Pro v0.8
Same for C-string requirements for fields and sizes
Signed-off-by: Szczepan Zalega <szczepan@nitrokey.com>
Diffstat (limited to 'NK_C_API.h')
| -rw-r--r-- | NK_C_API.h | 14 |
1 files changed, 8 insertions, 6 deletions
@@ -210,9 +210,10 @@ extern "C" { /** * Write HOTP slot data to the device - * @param slot_number HOTP slot number, slot_number<3 - * @param slot_name char[15](Pro) desired slot name - * @param secret char[40](Pro) 160-bit secret as a hex string + * @param slot_number HOTP slot number, slot_number<3, 0-numbered + * @param slot_name char[15] desired slot name. C string (requires ending '\0'; 16 bytes). + * @param secret char[40] 160-bit or 320-bit (currently Pro v0.8 only) secret as a hex string. C string (requires ending '\0'; 41 bytes). + * See NitrokeyManager::is_320_OTP_secret_supported. * @param hotp_counter uint32_t starting value of HOTP counter * @param use_8_digits should returned codes be 6 (false) or 8 digits (true) * @param use_enter press ENTER key after sending OTP code using double-pressed scroll/num/capslock @@ -227,9 +228,10 @@ extern "C" { /** * Write TOTP slot data to the device - * @param slot_number TOTP slot number, slot_number<15 - * @param slot_name char[15](Pro) desired slot name - * @param secret char[40](Pro) 160-bit secret as a hex string + * @param slot_number TOTP slot number, slot_number<15, 0-numbered + * @param slot_name char[15] desired slot name. C string (requires ending '\0'; 16 bytes). + * @param secret char[40] 160-bit or 320-bit (currently Pro v0.8 only) secret as a hex string. C string (requires ending '\0'; 41 bytes). + * See NitrokeyManager::is_320_OTP_secret_supported. * @param time_window uint16_t time window for this TOTP * @param use_8_digits should returned codes be 6 (false) or 8 digits (true) * @param use_enter press ENTER key after sending OTP code using double-pressed scroll/num/capslock |