forked from trussed-dev/piv-authenticator
-
Notifications
You must be signed in to change notification settings - Fork 1
/
command_response.rs
629 lines (575 loc) · 18 KB
/
command_response.rs
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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
#![cfg(feature = "virt")]
mod setup;
use std::borrow::Cow;
use aes::Aes256Enc;
use hex_literal::hex;
use serde::Deserialize;
use trussed::types::GenericArray;
// iso7816::Status doesn't support serde
#[derive(Deserialize, Debug, PartialEq, Clone, Copy, Default)]
enum Status {
#[default]
Success,
MoreAvailable(u8),
VerificationFailed,
RemainingRetries(u8),
UnspecifiedNonpersistentExecutionError,
UnspecifiedPersistentExecutionError,
WrongLength,
LogicalChannelNotSupported,
SecureMessagingNotSupported,
CommandChainingNotSupported,
SecurityStatusNotSatisfied,
ConditionsOfUseNotSatisfied,
OperationBlocked,
IncorrectDataParameter,
FunctionNotSupported,
NotFound,
NotEnoughMemory,
IncorrectP1OrP2Parameter,
KeyReferenceNotFound,
InstructionNotSupportedOrInvalid,
ClassNotSupported,
UnspecifiedCheckingError,
}
impl From<iso7816::Status> for Status {
fn from(value: iso7816::Status) -> Self {
let tmp: u16 = value.into();
tmp.try_into().unwrap()
}
}
#[derive(Clone, Copy, Eq, PartialEq, Debug, Deserialize)]
pub enum Algorithm {
Tdes = 0x3,
Rsa1024 = 0x6,
Rsa2048 = 0x7,
Aes128 = 0x8,
Aes192 = 0xA,
Aes256 = 0xC,
P256 = 0x11,
P384 = 0x14,
P521 = 0x15,
// non-standard!
Rsa3072 = 0xE0,
Rsa4096 = 0xE1,
Ed25519 = 0xE2,
X25519 = 0xE3,
Ed448 = 0xE4,
X448 = 0xE5,
// non-standard! picked by Alex, but maybe due for removal
P256Sha1 = 0xF0,
P256Sha256 = 0xF1,
P384Sha1 = 0xF2,
P384Sha256 = 0xF3,
P384Sha384 = 0xF4,
}
impl Algorithm {
pub fn challenge_len(self) -> usize {
match self {
Self::Tdes => 8,
Self::Aes256 => 16,
_ => panic!(),
}
}
pub fn key_len(self) -> usize {
match self {
Self::Tdes => 24,
Self::Aes256 => 32,
_ => panic!(),
}
}
}
fn serialize_len(len: usize) -> heapless::Vec<u8, 3> {
let mut buf = heapless::Vec::new();
if let Ok(len) = u8::try_from(len) {
if len <= 0x7f {
buf.extend_from_slice(&[len]).ok();
} else {
buf.extend_from_slice(&[0x81, len]).ok();
}
} else if let Ok(len) = u16::try_from(len) {
let arr = len.to_be_bytes();
buf.extend_from_slice(&[0x82, arr[0], arr[1]]).ok();
} else {
panic!("Length is too long to be serialized");
}
buf
}
fn tlv(tag: &[u8], data: &[u8]) -> Vec<u8> {
let mut buf = Vec::from(tag);
buf.extend_from_slice(&serialize_len(data.len()));
buf.extend_from_slice(data);
buf
}
fn build_command(cla: u8, ins: u8, p1: u8, p2: u8, data: &[u8], le: u16) -> Vec<u8> {
let mut res = vec![cla, ins, p1, p2];
let lc = data.len();
let extended = if lc == 0 {
false
} else if let Ok(len) = lc.try_into() {
res.push(len);
false
} else {
let len: u16 = lc.try_into().unwrap();
res.push(0);
res.extend_from_slice(&len.to_be_bytes());
true
};
res.extend_from_slice(data);
if le == 0 {
return res;
}
if let Ok(len) = (le - 1).try_into() {
let _: u8 = len;
res.push(len.wrapping_add(1));
} else if extended {
res.extend_from_slice(&le.to_be_bytes());
} else {
res.push(0);
res.extend_from_slice(&le.to_be_bytes());
}
res
}
impl TryFrom<u16> for Status {
type Error = u16;
fn try_from(sw: u16) -> Result<Self, Self::Error> {
Ok(match sw {
0x6300 => Self::VerificationFailed,
sw @ 0x63c0..=0x63cf => Self::RemainingRetries((sw as u8) & 0xf),
0x6400 => Self::UnspecifiedNonpersistentExecutionError,
0x6500 => Self::UnspecifiedPersistentExecutionError,
0x6700 => Self::WrongLength,
0x6881 => Self::LogicalChannelNotSupported,
0x6882 => Self::SecureMessagingNotSupported,
0x6884 => Self::CommandChainingNotSupported,
0x6982 => Self::SecurityStatusNotSatisfied,
0x6985 => Self::ConditionsOfUseNotSatisfied,
0x6983 => Self::OperationBlocked,
0x6a80 => Self::IncorrectDataParameter,
0x6a81 => Self::FunctionNotSupported,
0x6a82 => Self::NotFound,
0x6a84 => Self::NotEnoughMemory,
0x6a86 => Self::IncorrectP1OrP2Parameter,
0x6a88 => Self::KeyReferenceNotFound,
0x6d00 => Self::InstructionNotSupportedOrInvalid,
0x6e00 => Self::ClassNotSupported,
0x6f00 => Self::UnspecifiedCheckingError,
0x9000 => Self::Success,
sw @ 0x6100..=0x61FF => Self::MoreAvailable(sw as u8),
other => return Err(other),
})
}
}
#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
struct IoTest {
name: String,
cmd_resp: Vec<IoCmd>,
#[serde(default)]
uuid_config: UuidConfig,
}
#[derive(Debug, Clone, Deserialize)]
#[serde(deny_unknown_fields)]
enum OutputMatcher {
Len(usize),
// The () at the end are here to workaround a compiler bug. See:
// https://github.com/rust-lang/rust/issues/89940#issuecomment-1282321806
All(
#[serde(default)] Cow<'static, [OutputMatcher]>,
#[serde(default)] (),
),
Any(
#[serde(default)] Cow<'static, [OutputMatcher]>,
#[serde(default)] (),
),
/// HEX data
Data(Cow<'static, str>),
Bytes(Cow<'static, [u8]>),
NonZero,
}
impl Default for OutputMatcher {
fn default() -> Self {
MATCH_EMPTY
}
}
fn parse_hex(data: &str) -> Vec<u8> {
let tmp: String = data.split_whitespace().collect();
hex::decode(tmp).unwrap()
}
impl OutputMatcher {
fn validate(&self, data: &[u8]) -> bool {
match self {
Self::NonZero => data.iter().max() != Some(&0),
Self::Data(expected) => {
println!("Validating output with {expected}");
data == parse_hex(expected)
}
Self::Bytes(expected) => {
println!("Validating output with {expected:02x?}");
data == &**expected
}
Self::Len(len) => data.len() == *len,
Self::All(matchers, _) => matchers.iter().filter(|m| !m.validate(data)).count() == 0,
Self::Any(matchers, _) => matchers.iter().filter(|m| m.validate(data)).count() != 0,
}
}
}
#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
struct ManagementKey {
algorithm: Algorithm,
key: String,
}
fn default_app_pin() -> String {
"313233343536FFFF".into()
}
fn default_puk() -> String {
"3132333435363738".into()
}
#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
enum IoCmd {
IoData {
input: String,
#[serde(default)]
output: OutputMatcher,
#[serde(default)]
expected_status: Status,
},
GetData {
input: String,
#[serde(default)]
output: OutputMatcher,
#[serde(default)]
expected_status: Status,
},
PutData {
input: String,
#[serde(default)]
output: OutputMatcher,
#[serde(default)]
expected_status: Status,
},
VerifyApplicationPin {
#[serde(default = "default_app_pin")]
pin: String,
#[serde(default)]
expected_status: Status,
},
VerifyGlobalPin {
#[serde(default = "default_app_pin")]
pin: String,
#[serde(default)]
expected_status: Status,
},
SetManagementKey {
key: ManagementKey,
#[serde(default)]
expected_status: Status,
},
AuthenticateManagement {
key: ManagementKey,
#[serde(default)]
expected_status_challenge: Status,
#[serde(default)]
expected_status_response: Status,
},
ChangePin {
#[serde(default = "default_app_pin")]
old: String,
new: String,
#[serde(default)]
expected_status: Status,
},
ChangePuk {
#[serde(default = "default_puk")]
old: String,
new: String,
#[serde(default)]
expected_status: Status,
},
Select,
Reset {
#[serde(default)]
expected_status: Status,
},
}
const MATCH_EMPTY: OutputMatcher = OutputMatcher::Len(0);
const MATCH_ANY: OutputMatcher = OutputMatcher::All(Cow::Borrowed(&[]), ());
impl IoCmd {
fn run(&self, card: &mut setup::Piv) {
println!("Running {self:?}");
match self {
Self::IoData {
input,
output,
expected_status,
} => Self::run_iodata(input, output, *expected_status, card),
Self::GetData {
input,
output,
expected_status,
} => Self::run_get_data(input, output, *expected_status, card),
Self::PutData {
input,
output,
expected_status,
} => Self::run_put_data(input, output, *expected_status, card),
Self::VerifyApplicationPin {
pin,
expected_status,
} => Self::run_verify_application_pin(pin, *expected_status, card),
Self::VerifyGlobalPin {
pin,
expected_status,
} => Self::run_verify_global_pin(pin, *expected_status, card),
Self::AuthenticateManagement {
key,
expected_status_challenge,
expected_status_response,
} => Self::run_authenticate_management(
key.algorithm,
&key.key,
*expected_status_challenge,
*expected_status_response,
card,
),
Self::SetManagementKey {
key,
expected_status,
} => Self::run_set_administration_key(key.algorithm, &key.key, *expected_status, card),
Self::ChangePin {
old,
new,
expected_status,
} => Self::run_change_pin(old, new, *expected_status, card),
Self::ChangePuk {
old,
new,
expected_status,
} => Self::run_change_puk(old, new, *expected_status, card),
Self::Select => Self::run_select(card),
Self::Reset { expected_status } => Self::run_reset(*expected_status, card),
}
}
fn run_set_administration_key(
alg: Algorithm,
key: &str,
expected_status: Status,
card: &mut setup::Piv,
) {
let mut key_data = parse_hex(key);
let mut data = vec![alg as u8, 0x9b, key_data.len() as u8];
data.append(&mut key_data);
Self::run_bytes(
&build_command(0x00, 0xff, 0xff, 0xff, &data, 0),
&MATCH_ANY,
expected_status,
card,
);
}
fn run_bytes(
input: &[u8],
output: &OutputMatcher,
expected_status: Status,
card: &mut setup::Piv,
) -> heapless::Vec<u8, 1024> {
println!("Command: {input:x?}");
let mut rep: heapless::Vec<u8, 1024> = heapless::Vec::new();
let cmd: iso7816::Command<{ setup::COMMAND_SIZE }> = iso7816::Command::try_from(input)
.unwrap_or_else(|err| {
panic!("Bad command: {err:?}, for command: {}", hex::encode(input))
});
let status: Status = card
.respond(&cmd, &mut rep)
.err()
.map(Into::into)
.unwrap_or_default();
println!(
"Output({}): {:?}\nStatus: {status:?}",
rep.len(),
hex::encode(&rep)
);
if !output.validate(&rep) {
panic!("Bad output. Expected {output:02x?}");
}
if status != expected_status {
panic!("Bad status. Expected {expected_status:?}, got {status:?}");
}
rep
}
fn run_iodata(
input: &str,
output: &OutputMatcher,
expected_status: Status,
card: &mut setup::Piv,
) {
Self::run_bytes(&parse_hex(input), output, expected_status, card);
}
fn run_get_data(
input: &str,
output: &OutputMatcher,
expected_status: Status,
card: &mut setup::Piv,
) {
Self::run_bytes(
&build_command(0x00, 0xCB, 0x3F, 0xFF, &parse_hex(input), 0),
output,
expected_status,
card,
);
}
fn run_put_data(
input: &str,
output: &OutputMatcher,
expected_status: Status,
card: &mut setup::Piv,
) {
Self::run_bytes(
&build_command(0x00, 0xDB, 0x3F, 0xFF, &parse_hex(input), 0),
output,
expected_status,
card,
);
}
fn run_authenticate_management(
alg: Algorithm,
key: &str,
expected_status_challenge: Status,
expected_status_response: Status,
card: &mut setup::Piv,
) {
use des::{
cipher::{BlockEncrypt, KeyInit},
TdesEde3,
};
let command = build_command(0x00, 0x87, alg as u8, 0x9B, &hex!("7C 02 81 00"), 0);
let mut res = Self::run_bytes(&command, &MATCH_ANY, expected_status_challenge, card);
let key = parse_hex(key);
if expected_status_challenge != Status::Success {
res = heapless::Vec::from_slice(&vec![0; alg.challenge_len() + 6]).unwrap();
}
// Remove header
let challenge = &mut res[4..][..alg.challenge_len()];
match alg {
Algorithm::Tdes => {
let cipher = TdesEde3::new(GenericArray::from_slice(&key));
cipher.encrypt_block(GenericArray::from_mut_slice(challenge));
}
Algorithm::Aes256 => {
let cipher = Aes256Enc::new(GenericArray::from_slice(&key));
cipher.encrypt_block(GenericArray::from_mut_slice(challenge));
}
_ => panic!(),
}
let second_data = tlv(&[0x7C], &tlv(&[0x82], challenge));
let command = build_command(0x00, 0x87, alg as u8, 0x9B, &second_data, 0);
Self::run_bytes(&command, &MATCH_ANY, expected_status_response, card);
}
fn run_verify_application_pin(pin: &str, expected_status: Status, card: &mut setup::Piv) {
Self::run_bytes(
&build_command(0x00, 0x20, 0x00, 0x80, &parse_hex(pin), 0),
&MATCH_EMPTY,
expected_status,
card,
);
}
fn run_verify_global_pin(pin: &str, expected_status: Status, card: &mut setup::Piv) {
Self::run_bytes(
&build_command(0x00, 0x20, 0x00, 0x00, &parse_hex(pin), 0),
&MATCH_EMPTY,
expected_status,
card,
);
}
fn run_select(card: &mut setup::Piv) {
let matcher = OutputMatcher::Bytes(Cow::Borrowed(&hex!(
"
61 66 // Card application property template
4f 06 000010000100 // Application identifier
50 0c 4e6974726f6b657920504956 // Application label = b\"Nitrokey PIV\"
// URL = b\"https://github.com/Nitrokey/piv-authenticator\"
5f50 2d 68747470733a2f2f6769746875622e636f6d2f4e6974726f6b65792f7069762d61757468656e74696361746f72
// Cryptographic Algorithm Identifier Template
ac 15
80 01 03 // TDES - ECB
80 01 0c // AES256 - ECB
80 01 11 // P-256
80 01 e2 // Ed25519
80 01 e3 // X25519
80 01 07 // RSA 2048
06 01 00
// Coexistent Tag Allocation Authority Template
79 07
4f 05 a000000308
"
)));
Self::run_bytes(
&hex!("00 A4 04 00 0C A000000308000010000100 00"),
&matcher,
Status::Success,
card,
);
}
fn run_reset(expected_status: Status, card: &mut setup::Piv) {
Self::run_bytes(&hex!("00 FB 00 00"), &MATCH_EMPTY, expected_status, card);
}
fn run_change_pin(old: &str, new: &str, status: Status, card: &mut setup::Piv) {
let command = parse_hex(&format!("{old}{new}"));
Self::run_bytes(
&build_command(0, 0x24, 0x00, 0x80, &command, 0x00),
&MATCH_EMPTY,
status,
card,
);
}
fn run_change_puk(old: &str, new: &str, status: Status, card: &mut setup::Piv) {
let command = parse_hex(&format!("{old}{new}"));
Self::run_bytes(
&build_command(0, 0x24, 0x00, 0x81, &command, 0x00),
&MATCH_EMPTY,
status,
card,
);
}
}
#[derive(Deserialize, Debug, PartialEq, Clone)]
enum UuidConfig {
None,
WithUuid(String),
WithBoth(String),
}
impl Default for UuidConfig {
fn default() -> Self {
Self::WithBoth("00".repeat(16))
}
}
#[test_log::test]
fn command_response() {
let data = std::fs::read_to_string("tests/command_response.ron").unwrap();
let tests: Vec<IoTest> = ron::from_str(&data).unwrap();
for t in tests {
println!("\n\n===========================================================",);
println!("Running {}", t.name);
if matches!(t.uuid_config, UuidConfig::None | UuidConfig::WithBoth(_)) {
println!("Running {} without uuid", t.name);
setup::piv(setup::WITHOUT_UUID, |card| {
for io in &t.cmd_resp {
io.run(card);
}
});
}
match t.uuid_config {
UuidConfig::WithUuid(uuid) | UuidConfig::WithBoth(uuid) => {
println!("Running {} with uuid {uuid:?}", t.name);
let uuid = (&*parse_hex(&uuid)).try_into().unwrap();
setup::piv(piv_authenticator::Options::new().uuid(Some(uuid)), |card| {
for io in &t.cmd_resp {
io.run(card);
}
});
}
_ => {}
}
}
}