diff options
| author | Robin Krahl <me@robin-krahl.de> | 2018-05-25 12:15:08 +0200 | 
|---|---|---|
| committer | Robin Krahl <me@robin-krahl.de> | 2018-05-25 12:15:08 +0200 | 
| commit | 98917cffc50e7934105e874abd4a4b6ed72edc21 (patch) | |
| tree | ad6bc14cf0eb0e366b371800f65d43190cf00917 | |
| parent | f6e09cc2fb4541a15a57415439b575d7bf44b07f (diff) | |
| download | libnitrokey-98917cffc50e7934105e874abd4a4b6ed72edc21.tar.gz libnitrokey-98917cffc50e7934105e874abd4a4b6ed72edc21.tar.bz2  | |
Add getter for Storage status to C API
The C++ API currently provides the Storage status in
NitrokeyManager::get_status_storage().  The C API only provides a string
version of this data (NK_get_status_storage_as_string).  This patch adds
a struct to the C API that can store the storage status and a function
that can retrieve it.
The interpretation of the fields of the internal struct is based on the
following code in the Nitrokey Storage firmware:
    - src/HighLevelFunctions/FlashStorage.h, lines 73 to 90 (struct
      definition with comments)
    - src/OTP/report_protocol.c, lines 241 to 376 (debug output of the
      data)
| -rw-r--r-- | NK_C_API.cc | 34 | ||||
| -rw-r--r-- | NK_C_API.h | 82 | 
2 files changed, 116 insertions, 0 deletions
diff --git a/NK_C_API.cc b/NK_C_API.cc index 41c38aa..f6a6153 100644 --- a/NK_C_API.cc +++ b/NK_C_API.cc @@ -26,6 +26,7 @@  #include <cstring>  #include "libnitrokey/LibraryException.h"  #include "libnitrokey/cxx_semantics.h" +#include "libnitrokey/stick20_commands.h"  #ifdef _MSC_VER  #ifdef _WIN32 @@ -580,6 +581,39 @@ extern "C" {  		});  	} +	NK_C_API int NK_get_status_storage(NK_storage_status* out) { +		if (out == nullptr) { +			return -1; +		} +		auto m = NitrokeyManager::instance(); +		auto result = get_with_status([&]() { +			return m->get_status_storage(); +		}, proto::stick20::DeviceConfigurationResponsePacket::ResponsePayload()); +		auto error_code = std::get<0>(result); +		if (error_code != 0) { +			return error_code; +		} + +		auto status = std::get<1>(result); +		out->unencrypted_volume_read_only = status.ReadWriteFlagUncryptedVolume_u8 != 0; +		out->unencrypted_volume_active = status.VolumeActiceFlag_st.unencrypted; +		out->encrypted_volume_read_only = status.ReadWriteFlagCryptedVolume_u8 != 0; +		out->encrypted_volume_active = status.VolumeActiceFlag_st.encrypted; +		out->hidden_volume_read_only = status.ReadWriteFlagHiddenVolume_u8 != 0; +		out->hidden_volume_active = status.VolumeActiceFlag_st.hidden; +		out->firmware_version_major = status.versionInfo.major; +		out->firmware_version_minor = status.versionInfo.minor; +		out->firmware_locked = status.FirmwareLocked_u8 != 0; +		out->serial_number_sd_card = status.ActiveSD_CardID_u32; +		out->serial_number_smart_card = status.ActiveSmartCardID_u32; +		out->user_retry_count = status.UserPwRetryCount; +		out->admin_retry_count = status.AdminPwRetryCount; +		out->new_sd_card_found = status.NewSDCardFound_st.NewCard; +		out->filled_with_random = (status.SDFillWithRandomChars_u8 & 0x01) != 0; +		out->stick_initialized = status.StickKeysNotInitiated == 0; +		return 0; +	} +  	NK_C_API char* NK_get_SD_usage_data_as_string() {  		auto m = NitrokeyManager::instance();  		return get_with_string_result([&]() { @@ -52,6 +52,77 @@ extern "C" {          };  	/** +	 * Stores the status of a Storage device. +	 */ +        struct NK_storage_status { +		/** +		 * Indicates whether the unencrypted volume is read-only. +		 */ +		bool unencrypted_volume_read_only; +		/** +		 * Indicates whether the unencrypted volume is active. +		 */ +		bool unencrypted_volume_active; +		/** +		 * Indicates whether the encrypted volume is read-only. +		 */ +		bool encrypted_volume_read_only; +		/** +		 * Indicates whether the encrypted volume is active. +		 */ +		bool encrypted_volume_active; +		/** +		 * Indicates whether the hidden volume is read-only. +		 */ +		bool hidden_volume_read_only; +		/** +		 * Indicates whether the hidden volume is active. +		 */ +		bool hidden_volume_active; +		/** +		 * The major firmware version, e. g. 0 in v0.40. +		 */ +		uint8_t firmware_version_major; +		/** +		 * The minor firmware version, e. g. 40 in v0.40. +		 */ +		uint8_t firmware_version_minor; +		/** +		 * Indicates whether the firmware is locked. +		 */ +		bool firmware_locked; +		/** +		 * The serial number of the SD card in the Storage stick. +		 */ +		uint32_t serial_number_sd_card; +		/** +		 * The serial number of the smart card in the Storage stick. +		 */ +		uint32_t serial_number_smart_card; +		/** +		 * The number of remaining login attempts for the user PIN. +		 */ +		uint8_t user_retry_count; +		/** +		 * The number of remaining login attempts for the admin PIN. +		 */ +		uint8_t admin_retry_count; +		/** +		 * Indicates whether a new SD card was found. +		 */ +		bool new_sd_card_found; +		/** +		 * Indicates whether the SD card is filled with random characters. +		 */ +		bool filled_with_random; +		/** +		 * Indicates whether the stick has been initialized by generating +		 * the AES keys. +		 */ +		bool stick_initialized; +        }; + +	/**  	 * Set debug level of messages written on stderr  	 * @param state state=True - most messages, state=False - only errors level  	 */ @@ -587,6 +658,17 @@ extern "C" {  	NK_C_API char* NK_get_status_storage_as_string();  	/** +	 * Get the Storage stick status and return the command processing +	 * error code.  If the code is zero, i. e. the command was successful, +	 * the storage status is written to the output pointer's target. +	 * The output pointer must not be null. +	 * +	 * @param out the output pointer for the storage status +	 * @return command processing error code +	 */ +	NK_C_API int NK_get_status_storage(NK_storage_status* out); + +	/**  	 * Get SD card usage attributes as string.  	 * Usable during hidden volumes creation.  	 * Storage only  | 
