#ifndef STICK10_COMMANDS_H #define STICK10_COMMANDS_H #include #include #include "inttypes.h" #include "command.h" namespace nitrokey { namespace proto { /* * Stick10 protocol definition */ namespace stick10 { class GetSlotName : public Command { public: // reachable as a typedef in Transaction struct CommandPayload { uint8_t slot_number; bool isValid() const { return !(slot_number & 0xF0); } } __packed; struct ResponsePayload { uint8_t slot_name[15]; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class EraseSlot : Command { public: struct CommandPayload { uint8_t slot_number; bool isValid() const { return !(slot_number & 0xF0); } } __packed; typedef Transaction CommandTransaction; }; class SetTime : Command { public: struct CommandPayload { uint8_t reset; // 0 - get time, 1 - set time uint64_t time; // posix time bool isValid() const { return reset && reset != 1; } } __packed; typedef Transaction CommandTransaction; }; // TODO duplicate TOTP class WriteToHOTPSlot : Command { public: struct CommandPayload { uint8_t slot_number; uint8_t slot_name[15]; uint8_t slot_secret[20]; uint8_t slot_config; uint8_t slot_token_id[13]; uint8_t slot_counter[8]; bool isValid() const { return !(slot_number & 0xF0); } } __packed; typedef Transaction CommandTransaction; }; class WriteToTOTPSlot : Command { public: struct CommandPayload { uint8_t slot_number; uint8_t slot_name[15]; uint8_t slot_secret[20]; uint8_t slot_config; uint8_t slot_token_id[13]; uint16_t slot_interval; bool isValid() const { return !(slot_number & 0xF0); } } __packed; typedef Transaction CommandTransaction; }; class GetCode : Command { public: struct CommandPayload { uint8_t slot_number; uint64_t challenge; uint64_t last_totp_time; uint8_t last_interval; bool isValid() const { return !(slot_number & 0xF0); } } __packed; struct ResponsePayload { uint8_t code[18]; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class GetHOTP : Command { public: struct CommandPayload { uint8_t slot_number; bool isValid() const { return !(slot_number & 0xF0); } } __packed; typedef Transaction CommandTransaction; }; class ReadSlot : Command { public: struct CommandPayload { uint8_t slot_number; bool isValid() const { return !(slot_number & 0xF0); } std::string dissect() const { std::stringstream ss; ss << "slot_number:\t" << (int)(slot_number) << std::endl; return ss.str(); } } __packed; struct ResponsePayload { uint8_t slot_name[15]; uint8_t config; uint8_t token_id[13]; uint64_t counter; bool isValid() const { return true; } std::string dissect() const { std::stringstream ss; ss << "slot_name:\t" << slot_name << std::endl; ss << "config:\t" << config << std::endl; ss << "token_id:\t" << token_id << std::endl; ss << "counter:\t" << counter << std::endl; return ss.str(); } } __packed; typedef Transaction CommandTransaction; }; class GetStatus : Command { public: struct ResponsePayload { uint16_t firmware_version; uint8_t card_serial[4]; uint8_t general_config[3]; uint8_t otp_password_config[2]; bool isValid() const { return true; } std::string dissect() const { std::stringstream ss; ss << "firmware_version:\t" << firmware_version << std::endl; ss << "card_serial:\t" << ::nitrokey::misc::hexdump((const char *)(card_serial), sizeof card_serial); ss << "general_config:\t" << ::nitrokey::misc::hexdump((const char *)(general_config), sizeof general_config); ss << "otp_password_config:\t" << ::nitrokey::misc::hexdump((const char *)(otp_password_config), sizeof otp_password_config); return ss.str(); } } __packed; typedef Transaction CommandTransaction; }; class GetPasswordRetryCount : Command { public: struct ResponsePayload { uint8_t password_retry_count; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class GetUserPasswordRetryCount : Command { public: struct ResponsePayload { uint8_t password_retry_count; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class GetPasswordSafeSlotStatus : Command { public: struct ResponsePayload { uint8_t password_safe_status[PWS_SLOT_COUNT]; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class GetPasswordSafeSlotName : Command { public: struct CommandPayload { uint8_t slot_number; bool isValid() const { return !(slot_number & 0xF0); } } __packed; struct ResponsePayload { uint8_t slot_name[PWS_SLOTNAME_LENGTH]; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class GetPasswordSafeSlotPassword : Command { public: struct CommandPayload { uint8_t slot_number; bool isValid() const { return !(slot_number & 0xF0); } } __packed; struct ResponsePayload { uint8_t slot_password[PWS_PASSWORD_LENGTH]; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class GetPasswordSafeSlotLogin : Command { public: struct CommandPayload { uint8_t slot_number; bool isValid() const { return !(slot_number & 0xF0); } } __packed; struct ResponsePayload { uint8_t slot_login[PWS_LOGINNAME_LENGTH]; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class SetPasswordSafeSlotData : Command { public: struct CommandPayload { uint8_t slot_number; uint8_t slot_name[PWS_SLOTNAME_LENGTH]; uint8_t slot_password[PWS_PASSWORD_LENGTH]; bool isValid() const { return !(slot_number & 0xF0); } } __packed; typedef Transaction CommandTransaction; }; class SetPasswordSafeSlotData2 : Command { public: struct CommandPayload { uint8_t slot_number; uint8_t slot_name[PWS_SLOTNAME_LENGTH]; bool isValid() const { return !(slot_number & 0xF0); } } __packed; typedef Transaction CommandTransaction; }; class ErasePasswordSafeSlot : Command { public: struct CommandPayload { uint8_t slot_number; bool isValid() const { return !(slot_number & 0xF0); } } __packed; typedef Transaction CommandTransaction; }; class EnablePasswordSafe : Command { public: struct CommandPayload { uint8_t password[30]; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class PasswordSafeInitKey : Command { public: typedef Transaction CommandTransaction; }; // TODO naming screwed up, see above class PasswordSafeSendSlotViaHID : Command { public: struct CommandPayload { uint8_t slot_number; uint8_t slot_kind; bool isValid() const { return !(slot_number & 0xF0); } } __packed; typedef Transaction CommandTransaction; }; // TODO "Device::passwordSafeSendSlotDataViaHID" class WriteGeneralConfig : Command { public: struct CommandPayload { uint8_t config[5]; } __packed; typedef Transaction CommandTransaction; }; class FirstAuthenticate : Command { public: struct CommandPayload { uint8_t card_password[25]; uint8_t temporary_password[25]; bool isValid() const { return true; } std::string dissect() const { std::stringstream ss; ss << "card_password:\t" << card_password << std::endl; ss << "temporary_password:\t" << temporary_password << std::endl; return ss.str(); } } __packed; typedef Transaction CommandTransaction; }; class UserAuthenticate : Command { public: struct CommandPayload { uint8_t card_password[25]; uint8_t temporary_password[25]; bool isValid() const { return true; } } __packed; typedef Transaction CommandTransaction; }; class Authorize : Command { public: struct CommandPayload { uint8_t crc[4]; uint8_t password[25]; } __packed; typedef Transaction CommandTransaction; }; class UserAuthorize : Command { public: struct CommandPayload { uint8_t crc[4]; uint8_t password[25]; } __packed; typedef Transaction CommandTransaction; }; class UnlockUserPassword : Command { public: struct CommandPayload { uint8_t admin_password[20]; // TODO } __packed; // TODO could we get the stick to return the retry count? typedef Transaction CommandTransaction; }; class ChangeUserPin : Command { public: struct CommandPayload { uint8_t old_pin[25]; uint8_t new_pin[25]; } __packed; typedef Transaction CommandTransaction; }; // TODO why is it needed? class IsAESSupported : Command { public: struct CommandPayload { uint8_t password[20]; } __packed; typedef Transaction CommandTransaction; }; class ChangeAdminPin : Command { public: struct CommandPayload { uint8_t old_pin[25]; uint8_t new_pin[25]; } __packed; typedef Transaction CommandTransaction; }; class LockDevice : Command { public: typedef Transaction CommandTransaction; }; class FactoryReset : Command { public: struct CommandPayload { uint8_t password[20]; } __packed; typedef Transaction CommandTransaction; }; class BuildAESKey : Command { public: struct CommandPayload { uint8_t password[20]; } __packed; typedef Transaction CommandTransaction; }; } } } #endif