/usr/include/libnitrokey/NK_C_API.h is in libnitrokey-dev 3.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 | /*
* Copyright (c) 2015-2018 Nitrokey UG
*
* This file is part of libnitrokey.
*
* libnitrokey is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* libnitrokey is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with libnitrokey. If not, see <http://www.gnu.org/licenses/>.
*
* SPDX-License-Identifier: LGPL-3.0
*/
#ifndef LIBNITROKEY_NK_C_API_H
#define LIBNITROKEY_NK_C_API_H
#include <stdint.h>
#ifdef _MSC_VER
#define NK_C_API __declspec(dllexport)
#else
#define NK_C_API
#endif
#ifdef __cplusplus
extern "C" {
#endif
/**
* Set debug level of messages written on stderr
* @param state state=True - most messages, state=False - only errors level
*/
NK_C_API void NK_set_debug(bool state);
/**
* Set debug level of messages written on stderr
* @param level (int) 0-lowest verbosity, 5-highest verbosity
*/
NK_C_API void NK_set_debug_level(const int level);
/**
* Connect to device of given model. Currently library can be connected only to one device at once.
* @param device_model char 'S': Nitrokey Storage, 'P': Nitrokey Pro
* @return 1 if connected, 0 if wrong model or cannot connect
*/
NK_C_API int NK_login(const char *device_model);
/**
* Connect to first available device, starting checking from Pro 1st to Storage 2nd.
* @return 1 if connected, 0 if wrong model or cannot connect
*/
NK_C_API int NK_login_auto();
/**
* Disconnect from the device.
* @return command processing error code
*/
NK_C_API int NK_logout();
/**
* Return the debug status string. Debug purposes.
* @return command processing error code
*/
NK_C_API const char * NK_status();
/**
* Return the device's serial number string in hex.
* @return string device's serial number in hex
*/
NK_C_API const char * NK_device_serial_number();
/**
* Get last command processing status. Useful for commands which returns the results of their own and could not return
* an error code.
* @return previous command processing error code
*/
NK_C_API uint8_t NK_get_last_command_status();
/**
* Lock device - cancel any user device unlocking.
* @return command processing error code
*/
NK_C_API int NK_lock_device();
/**
* Authenticates the user on USER privilages with user_password and sets user's temporary password on device to user_temporary_password.
* @param user_password char[25](Pro) current user password
* @param user_temporary_password char[25](Pro) user temporary password to be set on device for further communication (authentication command)
* @return command processing error code
*/
NK_C_API int NK_user_authenticate(const char* user_password, const char* user_temporary_password);
/**
* Authenticates the user on ADMIN privilages with admin_password and sets user's temporary password on device to admin_temporary_password.
* @param admin_password char[25](Pro) current administrator PIN
* @param admin_temporary_password char[25](Pro) admin temporary password to be set on device for further communication (authentication command)
* @return command processing error code
*/
NK_C_API int NK_first_authenticate(const char* admin_password, const char* admin_temporary_password);
/**
* Execute a factory reset.
* @param admin_password char[20](Pro) current administrator PIN
* @return command processing error code
*/
NK_C_API int NK_factory_reset(const char* admin_password);
/**
* Generates AES key on the device
* @param admin_password char[20](Pro) current administrator PIN
* @return command processing error code
*/
NK_C_API int NK_build_aes_key(const char* admin_password);
/**
* Unlock user PIN locked after 3 incorrect codes tries.
* @param admin_password char[20](Pro) current administrator PIN
* @return command processing error code
*/
NK_C_API int NK_unlock_user_password(const char *admin_password, const char *new_user_password);
/**
* Write general config to the device
* @param numlock set value in range [0-1] to send HOTP code from slot 'numlock' after double pressing numlock
* or outside the range to disable this function
* @param capslock similar to numlock but with capslock
* @param scrolllock similar to numlock but with scrolllock
* @param enable_user_password set True to enable OTP PIN protection (request PIN each OTP code request)
* @param delete_user_password set True to disable OTP PIN protection (request PIN each OTP code request)
* @param admin_temporary_password current admin temporary password
* @return command processing error code
*/
NK_C_API int NK_write_config(uint8_t numlock, uint8_t capslock, uint8_t scrolllock,
bool enable_user_password, bool delete_user_password, const char *admin_temporary_password);
/**
* Get currently set config - status of function Numlock/Capslock/Scrollock OTP sending and is enabled PIN protected OTP
* @see NK_write_config
* @return uint8_t general_config[5]:
* uint8_t numlock;
uint8_t capslock;
uint8_t scrolllock;
uint8_t enable_user_password;
uint8_t delete_user_password;
*/
NK_C_API uint8_t* NK_read_config();
//OTP
/**
* Get name of given TOTP slot
* @param slot_number TOTP slot number, slot_number<15
* @return char[20](Pro) the name of the slot
*/
NK_C_API const char * NK_get_totp_slot_name(uint8_t slot_number);
/**
*
* @param slot_number HOTP slot number, slot_number<3
* @return char[20](Pro) the name of the slot
*/
NK_C_API const char * NK_get_hotp_slot_name(uint8_t slot_number);
/**
* Erase HOTP slot data from the device
* @param slot_number HOTP slot number, slot_number<3
* @param temporary_password admin temporary password
* @return command processing error code
*/
NK_C_API int NK_erase_hotp_slot(uint8_t slot_number, const char *temporary_password);
/**
* Erase TOTP slot data from the device
* @param slot_number TOTP slot number, slot_number<15
* @param temporary_password admin temporary password
* @return command processing error code
*/
NK_C_API int NK_erase_totp_slot(uint8_t slot_number, const char *temporary_password);
/**
* 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[20](Pro) 160-bit secret
* @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
* @param use_tokenID @see token_ID
* @param token_ID @see https://openauthentication.org/token-specs/, 'Class A' section
* @param temporary_password char[25](Pro) admin temporary password
* @return command processing error code
*/
NK_C_API int NK_write_hotp_slot(uint8_t slot_number, const char *slot_name, const char *secret, uint64_t hotp_counter,
bool use_8_digits, bool use_enter, bool use_tokenID, const char *token_ID,
const char *temporary_password);
/**
* 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[20](Pro) 160-bit secret
* @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
* @param use_tokenID @see token_ID
* @param token_ID @see https://openauthentication.org/token-specs/, 'Class A' section
* @param temporary_password char[20](Pro) admin temporary password
* @return command processing error code
*/
NK_C_API int NK_write_totp_slot(uint8_t slot_number, const char *slot_name, const char *secret, uint16_t time_window,
bool use_8_digits, bool use_enter, bool use_tokenID, const char *token_ID,
const char *temporary_password);
/**
* Get HOTP code from the device
* @param slot_number HOTP slot number, slot_number<3
* @return HOTP code
*/
NK_C_API const char * NK_get_hotp_code(uint8_t slot_number);
/**
* Get HOTP code from the device (PIN protected)
* @param slot_number HOTP slot number, slot_number<3
* @param user_temporary_password char[25](Pro) user temporary password if PIN protected OTP codes are enabled,
* otherwise should be set to empty string - ''
* @return HOTP code
*/
NK_C_API const char * NK_get_hotp_code_PIN(uint8_t slot_number, const char *user_temporary_password);
/**
* 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
* @return TOTP code
*/
NK_C_API const char * NK_get_totp_code(uint8_t slot_number, uint64_t challenge, uint64_t last_totp_time,
uint8_t last_interval);
/**
* 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 user_temporary_password char[25](Pro) user temporary password if PIN protected OTP codes are enabled,
* otherwise should be set to empty string - ''
* @return TOTP code
*/
NK_C_API const char * NK_get_totp_code_PIN(uint8_t slot_number, uint64_t challenge,
uint64_t last_totp_time, uint8_t last_interval,
const char *user_temporary_password);
/**
* Set time on the device (for TOTP requests)
* @param time seconds in unix epoch (from 01.01.1970)
* @return command processing error code
*/
NK_C_API int NK_totp_set_time(uint64_t time);
NK_C_API int NK_totp_get_time();
//passwords
/**
* Change administrator PIN
* @param current_PIN char[25](Pro) current PIN
* @param new_PIN char[25](Pro) new PIN
* @return command processing error code
*/
NK_C_API int NK_change_admin_PIN(const char *current_PIN, const char *new_PIN);
/**
* Change user PIN
* @param current_PIN char[25](Pro) current PIN
* @param new_PIN char[25](Pro) new PIN
* @return command processing error code
*/
NK_C_API int NK_change_user_PIN(const char *current_PIN, const char *new_PIN);
/**
* Get retry count of user PIN
* @return user PIN retry count
*/
NK_C_API uint8_t NK_get_user_retry_count();
/**
* Get retry count of admin PIN
* @return admin PIN retry count
*/
NK_C_API uint8_t NK_get_admin_retry_count();
//password safe
/**
* Enable password safe access
* @param user_pin char[30](Pro) current user PIN
* @return command processing error code
*/
NK_C_API int NK_enable_password_safe(const char *user_pin);
/**
* Get password safe slots' status
* @return uint8_t[16] slot statuses - each byte represents one slot with 0 (not programmed) and 1 (programmed)
*/
NK_C_API uint8_t * NK_get_password_safe_slot_status();
/**
* Get password safe slot name
* @param slot_number password safe slot number, slot_number<16
* @return slot name
*/
NK_C_API const char *NK_get_password_safe_slot_name(uint8_t slot_number);
/**
* Get password safe slot login
* @param slot_number password safe slot number, slot_number<16
* @return login from the PWS slot
*/
NK_C_API const char *NK_get_password_safe_slot_login(uint8_t slot_number);
/**
* Get the password safe slot password
* @param slot_number password safe slot number, slot_number<16
* @return password from the PWS slot
*/
NK_C_API const char *NK_get_password_safe_slot_password(uint8_t slot_number);
/**
* Write password safe data to the slot
* @param slot_number password safe slot number, slot_number<16
* @param slot_name char[11](Pro) name of the slot
* @param slot_login char[32](Pro) login string
* @param slot_password char[20](Pro) password string
* @return command processing error code
*/
NK_C_API int NK_write_password_safe_slot(uint8_t slot_number, const char *slot_name,
const char *slot_login, const char *slot_password);
/**
* Erase the password safe slot from the device
* @param slot_number password safe slot number, slot_number<16
* @return command processing error code
*/
NK_C_API int NK_erase_password_safe_slot(uint8_t slot_number);
/**
* Check whether AES is supported by the device
* @return 0 for no and 1 for yes
*/
NK_C_API int NK_is_AES_supported(const char *user_password);
/**
* Get device's major firmware version
* @return 7,8 for Pro and major for Storage
*/
NK_C_API int NK_get_major_firmware_version();
/**
* This command is typically run to initiate
* communication with the device (altough not required).
* It sets time on device and returns its current status
* - a combination of set_time and get_status_storage commands
* Storage only
* @param seconds_from_epoch date and time expressed in seconds
*/
NK_C_API int NK_send_startup(uint64_t seconds_from_epoch);
/**
* Unlock encrypted volume.
* Storage only
* @param user_pin user pin 20 characters
* @return command processing error code
*/
NK_C_API int NK_unlock_encrypted_volume(const char* user_pin);
/**
* Locks encrypted volume
* @return command processing error code
*/
NK_C_API int NK_lock_encrypted_volume();
/**
* Unlock hidden volume and lock encrypted volume.
* Requires encrypted volume to be unlocked.
* Storage only
* @param hidden_volume_password 20 characters
* @return command processing error code
*/
NK_C_API int NK_unlock_hidden_volume(const char* hidden_volume_password);
/**
* Locks hidden volume
* @return command processing error code
*/
NK_C_API int NK_lock_hidden_volume();
/**
* Create hidden volume.
* Requires encrypted volume to be unlocked.
* Storage only
* @param slot_nr slot number in range 0-3
* @param start_percent volume begin expressed in percent of total available storage, int in range 0-99
* @param end_percent volume end expressed in percent of total available storage, int in range 1-100
* @param hidden_volume_password 20 characters
* @return command processing error code
*/
NK_C_API int NK_create_hidden_volume(uint8_t slot_nr, uint8_t start_percent, uint8_t end_percent,
const char *hidden_volume_password);
/**
* Make unencrypted volume read-only.
* Device hides unencrypted volume for a second therefore make sure
* buffers are flushed before running.
* Storage only
* @param user_pin 20 characters
* @return command processing error code
*/
NK_C_API int NK_set_unencrypted_read_only(const char* user_pin);
/**
* Make unencrypted volume read-write.
* Device hides unencrypted volume for a second therefore make sure
* buffers are flushed before running.
* Storage only
* @param user_pin 20 characters
* @return command processing error code
*/
NK_C_API int NK_set_unencrypted_read_write(const char* user_pin);
/**
* Exports device's firmware to unencrypted volume.
* Storage only
* @param admin_pin 20 characters
* @return command processing error code
*/
NK_C_API int NK_export_firmware(const char* admin_pin);
/**
* Clear new SD card notification. It is set after factory reset.
* Storage only
* @param admin_pin 20 characters
* @return command processing error code
*/
NK_C_API int NK_clear_new_sd_card_warning(const char* admin_pin);
/**
* Fill SD card with random data.
* Should be done on first stick initialization after creating keys.
* Storage only
* @param admin_pin 20 characters
* @return command processing error code
*/
NK_C_API int NK_fill_SD_card_with_random_data(const char* admin_pin);
/**
* Change update password.
* Update password is used for entering update mode, where firmware
* could be uploaded using dfu-programmer or other means.
* Storage only
* @param current_update_password 20 characters
* @param new_update_password 20 characters
* @return command processing error code
*/
NK_C_API int NK_change_update_password(const char* current_update_password,
const char* new_update_password);
/**
* Get Storage stick status as string.
* Storage only
* @return string with devices attributes
*/
NK_C_API const char* NK_get_status_storage_as_string();
/**
* Get SD card usage attributes as string.
* Usable during hidden volumes creation.
* Storage only
* @return string with SD card usage attributes
*/
NK_C_API const char* NK_get_SD_usage_data_as_string();
/**
* Get progress value of current long operation.
* Storage only
* @return int in range 0-100 or -1 if device is not busy
*/
NK_C_API int NK_get_progress_bar_value();
#ifdef __cplusplus
}
#endif
#endif //LIBNITROKEY_NK_C_API_H
|