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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
|
#ifndef STICK10_COMMANDS_H
#define STICK10_COMMANDS_H
#include <string>
#include <sstream>
#include "inttypes.h"
#include "command.h"
namespace nitrokey {
namespace proto {
/*
* Stick10 protocol definition
*/
namespace stick10 {
class GetSlotName : public Command<CommandID::READ_SLOT_NAME> {
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<command_id(), struct CommandPayload,
struct ResponsePayload> CommandTransaction;
};
class EraseSlot : Command<CommandID::ERASE_SLOT> {
public:
struct CommandPayload {
uint8_t slot_number;
bool isValid() const { return !(slot_number & 0xF0); }
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class SetTime : Command<CommandID::SET_TIME> {
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<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
// TODO duplicate TOTP
class WriteToHOTPSlot : Command<CommandID::WRITE_TO_SLOT> {
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<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class WriteToTOTPSlot : Command<CommandID::WRITE_TO_SLOT> {
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<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class GetCode : Command<CommandID::GET_CODE> {
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<command_id(), struct CommandPayload,
struct ResponsePayload> CommandTransaction;
};
class GetHOTP : Command<CommandID::GET_CODE> {
public:
struct CommandPayload {
uint8_t slot_number;
bool isValid() const { return !(slot_number & 0xF0); }
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class ReadSlot : Command<CommandID::READ_SLOT> {
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<command_id(), struct CommandPayload,
struct ResponsePayload> CommandTransaction;
};
class GetStatus : Command<CommandID::GET_STATUS> {
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<command_id(), struct EmptyPayload, struct ResponsePayload>
CommandTransaction;
};
class GetPasswordRetryCount : Command<CommandID::GET_PASSWORD_RETRY_COUNT> {
public:
struct ResponsePayload {
uint8_t password_retry_count;
bool isValid() const { return true; }
std::string dissect() const {
std::stringstream ss;
ss << " password_retry_count\t" << password_retry_count<< std::endl;
return ss.str(); }
} __packed;
typedef Transaction<command_id(), struct EmptyPayload, struct ResponsePayload>
CommandTransaction;
};
class GetUserPasswordRetryCount
: Command<CommandID::GET_USER_PASSWORD_RETRY_COUNT> {
public:
struct ResponsePayload {
uint8_t password_retry_count;
bool isValid() const { return true; }
std::string dissect() const {
std::stringstream ss;
ss << " password_retry_count\t" << password_retry_count<< std::endl;
return ss.str(); }
} __packed;
typedef Transaction<command_id(), struct EmptyPayload, struct ResponsePayload>
CommandTransaction;
};
class GetPasswordSafeSlotStatus : Command<CommandID::GET_PW_SAFE_SLOT_STATUS> {
public:
struct ResponsePayload {
uint8_t password_safe_status[PWS_SLOT_COUNT];
bool isValid() const { return true; }
} __packed;
typedef Transaction<command_id(), struct EmptyPayload, struct ResponsePayload>
CommandTransaction;
};
class GetPasswordSafeSlotName : Command<CommandID::GET_PW_SAFE_SLOT_NAME> {
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" << slot_number << std::endl;
return ss.str(); }
} __packed;
struct ResponsePayload {
uint8_t slot_name[PWS_SLOTNAME_LENGTH];
bool isValid() const { return true; }
std::string dissect() const {
std::stringstream ss;
ss << " slot_name\t" << slot_name << std::endl;
return ss.str(); }
} __packed;
typedef Transaction<command_id(), struct CommandPayload,
struct ResponsePayload> CommandTransaction;
};
class GetPasswordSafeSlotPassword
: Command<CommandID::GET_PW_SAFE_SLOT_PASSWORD> {
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" << slot_number<< std::endl;
return ss.str(); }
} __packed;
struct ResponsePayload {
uint8_t slot_password[PWS_PASSWORD_LENGTH];
bool isValid() const { return true; }
std::string dissect() const {
std::stringstream ss;
ss << " slot_password\t" << slot_password << std::endl;
return ss.str(); }
} __packed;
typedef Transaction<command_id(), struct CommandPayload,
struct ResponsePayload> CommandTransaction;
};
class GetPasswordSafeSlotLogin
: Command<CommandID::GET_PW_SAFE_SLOT_LOGINNAME> {
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" << slot_number<< std::endl;
return ss.str(); }
} __packed;
struct ResponsePayload {
uint8_t slot_login[PWS_LOGINNAME_LENGTH];
bool isValid() const { return true; }
std::string dissect() const {
std::stringstream ss;
ss << " slot_login\t" << slot_login<< std::endl;
return ss.str(); }
} __packed;
typedef Transaction<command_id(), struct CommandPayload,
struct ResponsePayload> CommandTransaction;
};
class SetPasswordSafeSlotData : Command<CommandID::SET_PW_SAFE_SLOT_DATA_1> {
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<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class SetPasswordSafeSlotData2 : Command<CommandID::SET_PW_SAFE_SLOT_DATA_2> {
public:
struct CommandPayload {
uint8_t slot_number;
uint8_t slot_name[PWS_SLOTNAME_LENGTH];
bool isValid() const { return !(slot_number & 0xF0); }
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class ErasePasswordSafeSlot : Command<CommandID::PW_SAFE_ERASE_SLOT> {
public:
struct CommandPayload {
uint8_t slot_number;
bool isValid() const { return !(slot_number & 0xF0); }
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class EnablePasswordSafe : Command<CommandID::PW_SAFE_ENABLE> {
public:
struct CommandPayload {
uint8_t password[30];
bool isValid() const { return true; }
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class PasswordSafeInitKey : Command<CommandID::PW_SAFE_INIT_KEY> {
public:
typedef Transaction<command_id(), struct EmptyPayload, struct EmptyPayload>
CommandTransaction;
};
// TODO naming screwed up, see above
class PasswordSafeSendSlotViaHID : Command<CommandID::PW_SAFE_SEND_DATA> {
public:
struct CommandPayload {
uint8_t slot_number;
uint8_t slot_kind;
bool isValid() const { return !(slot_number & 0xF0); }
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
// TODO "Device::passwordSafeSendSlotDataViaHID"
class WriteGeneralConfig : Command<CommandID::WRITE_CONFIG> {
public:
struct CommandPayload {
uint8_t config[5];
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class FirstAuthenticate : Command<CommandID::FIRST_AUTHENTICATE> {
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<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class UserAuthenticate : Command<CommandID::USER_AUTHENTICATE> {
public:
struct CommandPayload {
uint8_t card_password[25];
uint8_t temporary_password[25];
bool isValid() const { return true; }
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class Authorize : Command<CommandID::AUTHORIZE> {
public:
struct CommandPayload {
uint8_t crc[4];
uint8_t password[25];
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class UserAuthorize : Command<CommandID::USER_AUTHORIZE> {
public:
struct CommandPayload {
uint8_t crc[4];
uint8_t password[25];
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class UnlockUserPassword : Command<CommandID::UNLOCK_USER_PASSWORD> {
public:
struct CommandPayload {
uint8_t admin_password[20]; // TODO
} __packed;
// TODO could we get the stick to return the retry count?
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class ChangeUserPin : Command<CommandID::CHANGE_USER_PIN> {
public:
struct CommandPayload {
uint8_t old_pin[25];
uint8_t new_pin[25];
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
// TODO why is it needed?
class IsAESSupported : Command<CommandID::DETECT_SC_AES> {
public:
struct CommandPayload {
uint8_t password[20];
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class ChangeAdminPin : Command<CommandID::CHANGE_ADMIN_PIN> {
public:
struct CommandPayload {
uint8_t old_pin[25];
uint8_t new_pin[25];
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class LockDevice : Command<CommandID::LOCK_DEVICE> {
public:
typedef Transaction<command_id(), struct EmptyPayload, struct EmptyPayload>
CommandTransaction;
};
class FactoryReset : Command<CommandID::FACTORY_RESET> {
public:
struct CommandPayload {
uint8_t password[20];
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
class BuildAESKey : Command<CommandID::NEW_AES_KEY> {
public:
struct CommandPayload {
uint8_t password[20];
} __packed;
typedef Transaction<command_id(), struct CommandPayload, struct EmptyPayload>
CommandTransaction;
};
}
}
}
#endif
|
