aboutsummaryrefslogtreecommitdiff
path: root/src/tests/pro.rs
blob: feadcbc8f45285e40694f1a759defd2fded6fe72 (plain)
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
use std::ffi::CStr;
use std::marker::Sized;
use {set_debug, AdminAuthenticatedDevice, CommandError, CommandStatus, Config, Device, Model,
     OtpMode, OtpSlotData, UnauthenticatedDevice};

static ADMIN_PASSWORD: &str = "12345678";
static ADMIN_NEW_PASSWORD: &str = "1234567890";
static USER_PASSWORD: &str = "123456";
static USER_NEW_PASSWORD: &str = "abcdefghij";

// test suite according to RFC 4226, Appendix D
static HOTP_SECRET: &str = "3132333435363738393031323334353637383930";
static HOTP_CODES: &[&str] = &[
    "755224", "287082", "359152", "969429", "338314", "254676", "287922", "162583", "399871",
    "520489",
];

// test suite according to RFC 6238, Appendix B
static TOTP_SECRET: &str = "3132333435363738393031323334353637383930";
static TOTP_CODES: &[(u64, &str)] = &[
    (59, "94287082"),
    (1111111109, "07081804"),
    (1111111111, "14050471"),
    (1234567890, "89005924"),
    (2000000000, "69279037"),
    (20000000000, "65353130"),
];

fn get_test_device() -> UnauthenticatedDevice {
    set_debug(false);
    ::connect_model(Model::Pro).expect("Could not connect to the Nitrokey Pro.")
}

fn get_admin_test_device() -> AdminAuthenticatedDevice {
    get_test_device().authenticate_admin(ADMIN_PASSWORD).expect("Could not login as admin.")
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn connect() {
    set_debug(false);
    assert!(::connect().is_ok());
    assert!(::connect_model(Model::Pro).is_ok());
    assert!(::connect_model(Model::Storage).is_err());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn disconnect() {
    set_debug(false);
    ::connect().unwrap();
    unsafe {
        let ptr = ::nitrokey_sys::NK_device_serial_number();
        assert!(!ptr.is_null());
        let cstr = CStr::from_ptr(ptr);
        assert_eq!(cstr.to_string_lossy(), "");
    }
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn get_serial_number() {
    let device = get_test_device();
    let result = device.get_serial_number();
    assert!(result.is_ok());
    let serial_number = result.unwrap();
    assert!(serial_number.is_ascii());
    assert!(serial_number.chars().all(|c| c.is_ascii_hexdigit()));
}

fn configure_hotp(admin: &AdminAuthenticatedDevice) {
    let slot_data = OtpSlotData::new(1, "test-hotp", HOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Success, admin.write_hotp_slot(slot_data, 0));
}

fn check_hotp_codes<T: Device>(device: &T)
where
    T: Sized,
{
    for code in HOTP_CODES {
        let result = device.get_hotp_code(1);
        assert_eq!(code, &result.unwrap());
    }
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn hotp() {
    let admin = get_admin_test_device();
    let config = Config::new(None, None, None, false);
    assert_eq!(CommandStatus::Success, admin.write_config(config));

    configure_hotp(&admin);
    check_hotp_codes(&admin);

    configure_hotp(&admin);
    check_hotp_codes(&admin.device());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn hotp_pin() {
    let admin = get_admin_test_device();
    let config = Config::new(None, None, None, true);
    assert_eq!(CommandStatus::Success, admin.write_config(config));

    configure_hotp(&admin);
    let user = admin.device().authenticate_user(USER_PASSWORD).unwrap();
    check_hotp_codes(&user);

    assert!(user.device().get_hotp_code(1).is_err());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn hotp_slot_name() {
    let admin = get_admin_test_device();
    let slot_data = OtpSlotData::new(1, "test-hotp", HOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Success, admin.write_hotp_slot(slot_data, 0));

    let device = admin.device();
    let result = device.get_hotp_slot_name(1);
    assert_eq!("test-hotp", result.unwrap());
    let result = device.get_hotp_slot_name(4);
    assert_eq!(CommandError::InvalidSlot, result.unwrap_err());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn hotp_error() {
    let admin = get_admin_test_device();
    let slot_data = OtpSlotData::new(1, "", HOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Error(CommandError::NoName), admin.write_hotp_slot(slot_data, 0));
    let slot_data = OtpSlotData::new(4, "test", HOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Error(CommandError::InvalidSlot), admin.write_hotp_slot(slot_data, 0));
    let code = admin.get_hotp_code(4);
    assert_eq!(CommandError::InvalidSlot, code.unwrap_err());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn hotp_erase() {
    let admin = get_admin_test_device();
    let config = Config::new(None, None, None, false);
    assert_eq!(CommandStatus::Success, admin.write_config(config));
    let slot_data = OtpSlotData::new(1, "test1", HOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Success, admin.write_hotp_slot(slot_data, 0));
    let slot_data = OtpSlotData::new(2, "test2", HOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Success, admin.write_hotp_slot(slot_data, 0));

    assert_eq!(CommandStatus::Success, admin.erase_hotp_slot(1));

    let device = admin.device();
    let result = device.get_hotp_slot_name(1);
    assert_eq!(CommandError::SlotNotProgrammed, result.unwrap_err());
    let result = device.get_hotp_code(1);
    assert_eq!(CommandError::SlotNotProgrammed, result.unwrap_err());

    assert_eq!("test2", device.get_hotp_slot_name(2).unwrap());
}

fn configure_totp(admin: &AdminAuthenticatedDevice) {
    let slot_data = OtpSlotData::new(1, "test-totp", TOTP_SECRET, OtpMode::EightDigits);
    assert_eq!(CommandStatus::Success, admin.write_totp_slot(slot_data, 30));
}

fn check_totp_codes<T: Device>(device: &T)
where
    T: Sized,
{
    for (i, &(time, code)) in TOTP_CODES.iter().enumerate() {
        assert_eq!(CommandStatus::Success, device.set_time(time));
        let result = device.get_totp_code(1);
        assert!(result.is_ok());
        let result_code = result.unwrap();
        assert_eq!(
            code, result_code,
            "TOTP code {} should be {} but is {}",
            i, code, result_code
        );
    }
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn totp() {
    // TODO: this test may fail due to bad timing --> find solution
    let admin = get_admin_test_device();
    let config = Config::new(None, None, None, false);
    assert_eq!(CommandStatus::Success, admin.write_config(config));

    configure_totp(&admin);
    check_totp_codes(&admin);

    configure_totp(&admin);
    check_totp_codes(&admin.device());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn totp_pin() {
    // TODO: this test may fail due to bad timing --> find solution
    let admin = get_admin_test_device();
    let config = Config::new(None, None, None, true);
    assert_eq!(CommandStatus::Success, admin.write_config(config));

    configure_totp(&admin);
    let user = admin.device().authenticate_user(USER_PASSWORD).unwrap();
    check_totp_codes(&user);

    assert!(user.device().get_totp_code(1).is_err());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn totp_slot_name() {
    let admin = get_admin_test_device();
    let slot_data = OtpSlotData::new(1, "test-totp", TOTP_SECRET, OtpMode::EightDigits);
    assert_eq!(CommandStatus::Success, admin.write_totp_slot(slot_data, 0));

    let device = admin.device();
    let result = device.get_totp_slot_name(1);
    assert!(result.is_ok());
    assert_eq!("test-totp", result.unwrap());
    let result = device.get_totp_slot_name(16);
    assert_eq!(CommandError::InvalidSlot, result.unwrap_err());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn totp_error() {
    let admin = get_admin_test_device();
    let slot_data = OtpSlotData::new(1, "", HOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Error(CommandError::NoName), admin.write_hotp_slot(slot_data, 0));
    let slot_data = OtpSlotData::new(4, "test", HOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Error(CommandError::InvalidSlot), admin.write_hotp_slot(slot_data, 0));
    let code = admin.get_hotp_code(4);
    assert_eq!(CommandError::InvalidSlot, code.unwrap_err());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn totp_erase() {
    let admin = get_admin_test_device();
    let config = Config::new(None, None, None, false);
    assert_eq!(CommandStatus::Success, admin.write_config(config));
    let slot_data = OtpSlotData::new(1, "test1", TOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Success, admin.write_totp_slot(slot_data, 0));
    let slot_data = OtpSlotData::new(2, "test2", TOTP_SECRET, OtpMode::SixDigits);
    assert_eq!(CommandStatus::Success, admin.write_totp_slot(slot_data, 0));

    assert_eq!(CommandStatus::Success, admin.erase_totp_slot(1));

    let device = admin.device();
    let result = device.get_totp_slot_name(1);
    assert_eq!(CommandError::SlotNotProgrammed, result.unwrap_err());
    let result = device.get_totp_code(1);
    assert_eq!(CommandError::SlotNotProgrammed, result.unwrap_err());

    assert_eq!("test2", device.get_totp_slot_name(2).unwrap());
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn get_firmware_version() {
    let device = get_test_device();
    assert_eq!(0, device.get_major_firmware_version());
    let minor = device.get_minor_firmware_version();
    assert!(minor == 7 || minor == 8);
}

fn admin_retry(device: UnauthenticatedDevice, suffix: &str, count: u8) -> UnauthenticatedDevice {
    let result = device.authenticate_admin(&(ADMIN_PASSWORD.to_owned() + suffix));
    let device = match result {
        Ok(admin) => admin.device(),
        Err((device, _)) => device,
    };
    assert_eq!(count, device.get_admin_retry_count());
    return device;
}

fn user_retry(device: UnauthenticatedDevice, suffix: &str, count: u8) -> UnauthenticatedDevice {
    let result = device.authenticate_user(&(USER_PASSWORD.to_owned() + suffix));
    let device = match result {
        Ok(admin) => admin.device(),
        Err((device, _)) => device,
    };
    assert_eq!(count, device.get_user_retry_count());
    return device;
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn get_retry_count() {
    let device = get_test_device();

    let device = admin_retry(device, "", 3);
    let device = admin_retry(device, "123", 2);
    let device = admin_retry(device, "456", 1);
    let device = admin_retry(device, "", 3);

    let device = user_retry(device, "", 3);
    let device = user_retry(device, "123", 2);
    let device = user_retry(device, "456", 1);
    user_retry(device, "", 3);
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn read_write_config() {
    let admin = get_admin_test_device();
    let config = Config::new(None, None, None, true);
    assert_eq!(CommandStatus::Success, admin.write_config(config));
    let get_config = admin.get_config().unwrap();
    assert_eq!(config, get_config);

    let config = Config::new(None, Some(9), None, true);
    assert_eq!(
        CommandStatus::Error(CommandError::InvalidSlot),
        admin.write_config(config)
    );

    let config = Config::new(Some(1), None, Some(0), false);
    assert_eq!(CommandStatus::Success, admin.write_config(config));
    let get_config = admin.get_config().unwrap();
    assert_eq!(config, get_config);

    let config = Config::new(None, None, None, false);
    assert_eq!(CommandStatus::Success, admin.write_config(config));
    let get_config = admin.get_config().unwrap();
    assert_eq!(config, get_config);
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn change_user_pin() {
    let device = get_test_device();
    let device = device.authenticate_user(USER_PASSWORD).unwrap().device();
    let device = device.authenticate_user(USER_NEW_PASSWORD).unwrap_err().0;

    let result = device.change_user_pin(USER_PASSWORD, USER_NEW_PASSWORD);
    assert_eq!(CommandStatus::Success, result);

    let device = device.authenticate_user(USER_PASSWORD).unwrap_err().0;
    let device = device.authenticate_user(USER_NEW_PASSWORD).unwrap().device();

    let result = device.change_user_pin(USER_PASSWORD, USER_PASSWORD);
    assert_eq!(CommandStatus::Error(CommandError::WrongPassword), result);

    let result = device.change_user_pin(USER_NEW_PASSWORD, USER_PASSWORD);
    assert_eq!(CommandStatus::Success, result);

    let device = device.authenticate_user(USER_PASSWORD).unwrap().device();
    device.authenticate_user(USER_NEW_PASSWORD).unwrap_err();
}

#[test]
#[cfg_attr(not(feature = "test-pro"), ignore)]
fn change_admin_pin() {
    let device = get_test_device();
    let device = device.authenticate_admin(ADMIN_PASSWORD).unwrap().device();
    let device = device.authenticate_admin(ADMIN_NEW_PASSWORD).unwrap_err().0;

    let result = device.change_admin_pin(ADMIN_PASSWORD, ADMIN_NEW_PASSWORD);
    assert_eq!(CommandStatus::Success, result);

    let device = device.authenticate_admin(ADMIN_PASSWORD).unwrap_err().0;
    let device = device.authenticate_admin(ADMIN_NEW_PASSWORD).unwrap().device();

    let result = device.change_admin_pin(ADMIN_PASSWORD, ADMIN_PASSWORD);
    assert_eq!(CommandStatus::Error(CommandError::WrongPassword), result);

    let result = device.change_admin_pin(ADMIN_NEW_PASSWORD, ADMIN_PASSWORD);
    assert_eq!(CommandStatus::Success, result);

    let device = device.authenticate_admin(ADMIN_PASSWORD).unwrap().device();
    device.authenticate_admin(ADMIN_NEW_PASSWORD).unwrap_err();
}