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
|
/*
* 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_STICK10_COMMANDS_0_8_H
#define LIBNITROKEY_STICK10_COMMANDS_0_8_H
#include <bitset>
#include <iomanip>
#include <string>
#include <sstream>
#include <cstdint>
#include "command.h"
#include "device_proto.h"
#include "stick10_commands.h"
#pragma pack (push,1)
namespace nitrokey {
namespace proto {
/*
* Stick10 protocol definition
*/
namespace stick10_08 {
using stick10::FirstAuthenticate;
using stick10::UserAuthenticate;
using stick10::SetTime;
using stick10::GetStatus;
using stick10::BuildAESKey;
using stick10::ChangeAdminPin;
using stick10::ChangeUserPin;
using stick10::EnablePasswordSafe;
using stick10::ErasePasswordSafeSlot;
using stick10::FactoryReset;
using stick10::GetPasswordRetryCount;
using stick10::GetUserPasswordRetryCount;
using stick10::GetPasswordSafeSlotLogin;
using stick10::GetPasswordSafeSlotName;
using stick10::GetPasswordSafeSlotPassword;
using stick10::GetPasswordSafeSlotStatus;
using stick10::GetSlotName;
using stick10::IsAESSupported;
using stick10::LockDevice;
using stick10::PasswordSafeInitKey;
using stick10::PasswordSafeSendSlotViaHID;
using stick10::SetPasswordSafeSlotData;
using stick10::SetPasswordSafeSlotData2;
using stick10::UnlockUserPassword;
using stick10::ReadSlot;
class EraseSlot : Command<CommandID::ERASE_SLOT> {
public:
struct CommandPayload {
uint8_t slot_number;
uint8_t temporary_admin_password[25];
bool isValid() const { return !(slot_number & 0xF0); }
std::string dissect() const {
std::stringstream ss;
ss << "slot_number:\t" << (int)(slot_number) << std::endl;
hexdump_to_ss(temporary_admin_password);
return ss.str();
}
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class SendOTPData : Command<CommandID::SEND_OTP_DATA> {
//admin auth
public:
struct CommandPayload {
uint8_t temporary_admin_password[25];
uint8_t type; //S-secret, N-name
uint8_t id; //multiple reports for values longer than 30 bytes
uint8_t data[30]; //data, does not need null termination
bool isValid() const { return true; }
void setTypeName(){
type = 'N';
}
void setTypeSecret(){
type = 'S';
}
std::string dissect() const {
std::stringstream ss;
hexdump_to_ss(temporary_admin_password);
ss << "type:\t" << type << std::endl;
ss << "id:\t" << (int)id << std::endl;
#ifdef LOG_VOLATILE_DATA
ss << "data:" << std::endl
<< ::nitrokey::misc::hexdump((const uint8_t *) (&data), sizeof data);
#else
ss << " Volatile data not logged" << std::endl;
#endif
return ss.str();
}
} __packed;
struct ResponsePayload {
union {
uint8_t data[40];
} __packed;
bool isValid() const { return true; }
std::string dissect() const {
std::stringstream ss;
#ifdef LOG_VOLATILE_DATA
ss << "data:" << std::endl
<< ::nitrokey::misc::hexdump((const uint8_t *) (&data), sizeof data);
#else
ss << " Volatile data not logged" << std::endl;
#endif
return ss.str();
}
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct ResponsePayload>
CommandTransaction;
};
class WriteToOTPSlot : Command<CommandID::WRITE_TO_SLOT> {
//admin auth
public:
struct CommandPayload {
uint8_t temporary_admin_password[25];
uint8_t slot_number;
union {
uint64_t slot_counter_or_interval;
uint8_t slot_counter_s[8];
} __packed;
union {
uint8_t _slot_config;
struct {
bool use_8_digits : 1;
bool use_enter : 1;
bool use_tokenID : 1;
};
};
union {
uint8_t slot_token_id[13]; /** OATH Token Identifier */
struct { /** @see https://openauthentication.org/token-specs/ */
uint8_t omp[2];
uint8_t tt[2];
uint8_t mui[8];
uint8_t keyboard_layout; //disabled feature in nitroapp as of 20160805
} slot_token_fields;
};
bool isValid() const { return true; }
std::string dissect() const {
std::stringstream ss;
hexdump_to_ss(temporary_admin_password);
ss << "slot_config:\t" << std::bitset<8>((int) _slot_config) << std::endl;
ss << "\tuse_8_digits(0):\t" << use_8_digits << std::endl;
ss << "\tuse_enter(1):\t" << use_enter << std::endl;
ss << "\tuse_tokenID(2):\t" << use_tokenID << std::endl;
ss << "slot_number:\t" << (int) (slot_number) << std::endl;
ss << "slot_counter_or_interval:\t[" << (int) slot_counter_or_interval << "]\t"
<< ::nitrokey::misc::hexdump((const uint8_t *) (&slot_counter_or_interval), sizeof slot_counter_or_interval, false);
ss << "slot_token_id:\t";
for (auto i : slot_token_id)
ss << std::hex << std::setw(2) << std::setfill('0') << (int) i << " ";
ss << std::endl;
return ss.str();
}
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class GetHOTP : Command<CommandID::GET_CODE> {
public:
struct CommandPayload {
uint8_t slot_number;
struct {
uint64_t challenge; //@unused
uint64_t last_totp_time; //@unused
uint8_t last_interval; //@unused
} __packed _unused;
uint8_t temporary_user_password[25];
bool isValid() const { return (slot_number & 0xF0); }
std::string dissect() const {
std::stringstream ss;
hexdump_to_ss(temporary_user_password);
ss << "slot_number:\t" << (int)(slot_number) << std::endl;
return ss.str();
}
} __packed;
struct ResponsePayload {
union {
uint8_t whole_response[18]; //14 bytes reserved for config, but used only 1
struct {
uint32_t code;
union{
uint8_t _slot_config;
struct{
bool use_8_digits : 1;
bool use_enter : 1;
bool use_tokenID : 1;
};
};
} __packed;
} __packed;
bool isValid() const { return true; }
std::string dissect() const {
std::stringstream ss;
ss << "code:\t" << (code) << std::endl;
ss << "slot_config:\t" << std::bitset<8>((int)_slot_config) << std::endl;
ss << "\tuse_8_digits(0):\t" << use_8_digits << std::endl;
ss << "\tuse_enter(1):\t" << use_enter << std::endl;
ss << "\tuse_tokenID(2):\t" << use_tokenID << std::endl;
return ss.str();
}
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct ResponsePayload>
CommandTransaction;
};
class GetTOTP : Command<CommandID::GET_CODE> {
//user auth
public:
struct CommandPayload {
uint8_t slot_number;
uint64_t challenge; //@unused
uint64_t last_totp_time; //@unused
uint8_t last_interval; //@unused
uint8_t temporary_user_password[25];
bool isValid() const { return !(slot_number & 0xF0); }
std::string dissect() const {
std::stringstream ss;
hexdump_to_ss(temporary_user_password);
ss << "slot_number:\t" << (int)(slot_number) << std::endl;
ss << "challenge:\t" << (challenge) << std::endl;
ss << "last_totp_time:\t" << (last_totp_time) << std::endl;
ss << "last_interval:\t" << (int)(last_interval) << std::endl;
return ss.str();
}
} __packed;
struct ResponsePayload {
union {
uint8_t whole_response[18]; //14 bytes reserved for config, but used only 1
struct {
uint32_t code;
union{
uint8_t _slot_config;
struct{
bool use_8_digits : 1;
bool use_enter : 1;
bool use_tokenID : 1;
};
};
} __packed ;
} __packed ;
bool isValid() const { return true; }
std::string dissect() const {
std::stringstream ss;
ss << "code:\t" << (code) << std::endl;
ss << "slot_config:\t" << std::bitset<8>((int)_slot_config) << std::endl;
ss << "\tuse_8_digits(0):\t" << use_8_digits << std::endl;
ss << "\tuse_enter(1):\t" << use_enter << std::endl;
ss << "\tuse_tokenID(2):\t" << use_tokenID << std::endl;
return ss.str();
}
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct ResponsePayload>
CommandTransaction;
};
class WriteGeneralConfig : Command<CommandID::WRITE_CONFIG> {
//admin auth
public:
struct CommandPayload {
union{
uint8_t config[5];
struct{
uint8_t numlock; /** 0-1: HOTP slot number from which the code will be get on double press, other value - function disabled */
uint8_t capslock; /** same as numlock */
uint8_t scrolllock; /** same as numlock */
uint8_t enable_user_password;
uint8_t delete_user_password;
};
};
uint8_t temporary_admin_password[25];
static constexpr uint8_t special_HOTP_slots = 3;
bool isValid() const { return numlock < special_HOTP_slots && capslock < special_HOTP_slots
&& scrolllock < special_HOTP_slots && enable_user_password < 2; }
std::string dissect() const {
std::stringstream ss;
ss << "numlock:\t" << (int)numlock << std::endl;
ss << "capslock:\t" << (int)capslock << std::endl;
ss << "scrolllock:\t" << (int)scrolllock << std::endl;
ss << "enable_user_password:\t" << (bool) enable_user_password << std::endl;
ss << "delete_user_password:\t" << (bool) delete_user_password << std::endl;
return ss.str();
}
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
}
}
}
#pragma pack (pop)
#endif //LIBNITROKEY_STICK10_COMMANDS_0_8_H
|
