aboutsummaryrefslogtreecommitdiff
path: root/src/device.rs
blob: ce45a50ecfc0ea8daaf405e082b3f5d0a64e0007 (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
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
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
use config::{Config, RawConfig};
use libc;
use nitrokey_sys;
use std::ffi::CString;
use std::os::raw::c_int;
use otp::{ConfigureOtp, GenerateOtp, OtpMode, OtpSlotData, RawOtpSlotData};
use util::{generate_password, get_last_error, result_from_string, CommandError, CommandStatus};

static TEMPORARY_PASSWORD_LENGTH: usize = 25;

/// Available Nitrokey models.
#[derive(Debug, PartialEq)]
pub enum Model {
    /// The Nitrokey Storage.
    Storage,
    /// The Nitrokey Pro.
    Pro,
}

/// A Nitrokey device without user or admin authentication.
///
/// Use [`connect`][] or [`connect_model`][] to obtain an instance.  If you
/// want to execute a command that requires user or admin authentication,
/// use [`authenticate_admin`][] or [`authenticate_user`][].
///
/// # Examples
///
/// Authentication with error handling:
///
/// ```no_run
/// use nitrokey::{UnauthenticatedDevice, UserAuthenticatedDevice};
/// # use nitrokey::CommandError;
///
/// fn perform_user_task(device: &UserAuthenticatedDevice) {}
/// fn perform_other_task(device: &UnauthenticatedDevice) {}
///
/// # fn try_main() -> Result<(), CommandError> {
/// let device = nitrokey::connect()?;
/// let device = match device.authenticate_user("123456") {
///     Ok(user) => {
///         perform_user_task(&user);
///         user.device()
///     },
///     Err((device, err)) => {
///         println!("Could not authenticate as user: {:?}", err);
///         device
///     },
/// };
/// perform_other_task(&device);
/// #     Ok(())
/// # }
/// ```
///
/// [`authenticate_admin`]: #method.authenticate_admin
/// [`authenticate_user`]: #method.authenticate_user
/// [`connect`]: fn.connect.html
/// [`connect_model`]: fn.connect_model.html
#[derive(Debug)]
pub struct UnauthenticatedDevice {}

/// A Nitrokey device with user authentication.
///
/// To obtain an instance of this struct, use the [`authenticate_user`][]
/// method on an [`UnauthenticatedDevice`][].  To get back to an
/// unauthenticated device, use the [`device`][] method.
///
/// [`authenticate_admin`]: struct.UnauthenticatedDevice#method.authenticate_admin
/// [`device`]: #method.device
/// [`UnauthenticatedDevice`]: struct.UnauthenticatedDevice.html
#[derive(Debug)]
pub struct UserAuthenticatedDevice {
    device: UnauthenticatedDevice,
    temp_password: Vec<u8>,
}

/// A Nitrokey device with admin authentication.
///
/// To obtain an instance of this struct, use the [`authenticate_admin`][]
/// method on an [`UnauthenticatedDevice`][].  To get back to an
/// unauthenticated device, use the [`device`][] method.
///
/// [`authenticate_admin`]: struct.UnauthenticatedDevice#method.authenticate_admin
/// [`device`]: #method.device
/// [`UnauthenticatedDevice`]: struct.UnauthenticatedDevice.html
#[derive(Debug)]
pub struct AdminAuthenticatedDevice {
    device: UnauthenticatedDevice,
    temp_password: Vec<u8>,
}

/// A Nitrokey device.
///
/// This trait provides the commands that can be executed without
/// authentication.
pub trait Device {
    /// Sets the time on the Nitrokey.  This command may set the time to
    /// arbitrary values.  `time` is the number of seconds since January 1st,
    /// 1970 (Unix timestamp).
    ///
    /// The time is used for TOTP generation (see [`get_totp_code`][]).
    ///
    /// # Example
    ///
    /// ```ignore
    /// extern crate chrono;
    ///
    /// use chrono::Utc;
    /// use nitrokey::Device;
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// let time = Utc::now().timestamp();
    /// if time < 0 {
    ///     println!("Timestamps before 1970-01-01 are not supported!");
    /// } else {
    ///     device.set_time(time as u64);
    /// }
    /// #     Ok(())
    /// # }
    /// ```
    ///
    /// # Errors
    ///
    /// - [`Timestamp`][] if the time could not be set
    ///
    /// [`get_totp_code`]: trait.ProvideOtp.html#method.get_totp_code
    /// [`Timestamp`]: enum.CommandError.html#variant.Timestamp
    fn set_time(&self, time: u64) -> CommandStatus {
        unsafe { CommandStatus::from(nitrokey_sys::NK_totp_set_time(time)) }
    }

    /// Returns the serial number of the Nitrokey device.  The serial number
    /// is the string representation of a hex number.
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::Device;
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// match device.get_serial_number() {
    ///     Ok(number) => println!("serial no: {:?}", number),
    ///     Err(err) => println!("Could not get serial number: {:?}", err),
    /// };
    /// #     Ok(())
    /// # }
    /// ```
    fn get_serial_number(&self) -> Result<String, CommandError> {
        unsafe { result_from_string(nitrokey_sys::NK_device_serial_number()) }
    }

    /// Returns the number of remaining authentication attempts for the user.  The
    /// total number of available attempts is three.
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::Device;
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// let count = device.get_user_retry_count();
    /// println!("{} remaining authentication attempts (user)", count);
    /// #     Ok(())
    /// # }
    /// ```
    fn get_user_retry_count(&self) -> u8 {
        unsafe { nitrokey_sys::NK_get_user_retry_count() }
    }

    /// Returns the number of remaining authentication attempts for the admin.  The
    /// total number of available attempts is three.
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::Device;
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// let count = device.get_admin_retry_count();
    /// println!("{} remaining authentication attempts (admin)", count);
    /// #     Ok(())
    /// # }
    /// ```
    fn get_admin_retry_count(&self) -> u8 {
        unsafe { nitrokey_sys::NK_get_admin_retry_count() }
    }

    /// Returns the major part of the firmware version (should be zero).
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::Device;
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// println!(
    ///     "Firmware version: {}.{}",
    ///     device.get_major_firmware_version(),
    ///     device.get_minor_firmware_version(),
    /// );
    /// #     Ok(())
    /// # }
    /// ```
    fn get_major_firmware_version(&self) -> i32 {
        unsafe { nitrokey_sys::NK_get_major_firmware_version() }
    }

    /// Returns the minor part of the firmware version (for example 8 for
    /// version 0.8).
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::Device;
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// println!(
    ///     "Firmware version: {}.{}",
    ///     device.get_major_firmware_version(),
    ///     device.get_minor_firmware_version(),
    /// );
    /// #     Ok(())
    /// # }
    fn get_minor_firmware_version(&self) -> i32 {
        unsafe { nitrokey_sys::NK_get_minor_firmware_version() }
    }

    /// Returns the current configuration of the Nitrokey device.
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::Device;
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// let config = device.get_config()?;
    /// println!("numlock binding:          {:?}", config.numlock);
    /// println!("capslock binding:         {:?}", config.capslock);
    /// println!("scrollock binding:        {:?}", config.scrollock);
    /// println!("require password for OTP: {:?}", config.user_password);
    /// #     Ok(())
    /// # }
    /// ```
    fn get_config(&self) -> Result<Config, CommandError> {
        unsafe {
            let config_ptr = nitrokey_sys::NK_read_config();
            if config_ptr.is_null() {
                return Err(get_last_error());
            }
            let config_array_ptr = config_ptr as *const [u8; 5];
            let raw_config = RawConfig::from(*config_array_ptr);
            libc::free(config_ptr as *mut libc::c_void);
            return Ok(raw_config.into());
        }
    }

    /// Changes the administrator PIN.
    ///
    /// # Errors
    ///
    /// - [`InvalidString`][] if one of the provided passwords contains a null byte
    /// - [`WrongPassword`][] if the current admin password is wrong
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::{CommandStatus, Device};
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// match device.change_admin_pin("12345678", "12345679") {
    ///     CommandStatus::Success => println!("Updated admin PIN."),
    ///     CommandStatus::Error(err) => println!("Failed to update admin PIN: {:?}", err),
    /// };
    /// #     Ok(())
    /// # }
    /// ```
    ///
    /// [`InvalidString`]: enum.CommandError.html#variant.InvalidString
    /// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword
    fn change_admin_pin(&self, current: &str, new: &str) -> CommandStatus {
        let current_string = CString::new(current);
        let new_string = CString::new(new);
        if current_string.is_err() || new_string.is_err() {
            return CommandStatus::Error(CommandError::InvalidString);
        }
        let current_string = current_string.unwrap();
        let new_string = new_string.unwrap();
        unsafe {
            CommandStatus::from(nitrokey_sys::NK_change_admin_PIN(
                current_string.as_ptr(),
                new_string.as_ptr(),
            ))
        }
    }

    /// Changes the user PIN.
    ///
    /// # Errors
    ///
    /// - [`InvalidString`][] if one of the provided passwords contains a null byte
    /// - [`WrongPassword`][] if the current user password is wrong
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::{CommandStatus, Device};
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// match device.change_user_pin("123456", "123457") {
    ///     CommandStatus::Success => println!("Updated admin PIN."),
    ///     CommandStatus::Error(err) => println!("Failed to update admin PIN: {:?}", err),
    /// };
    /// #     Ok(())
    /// # }
    /// ```
    ///
    /// [`InvalidString`]: enum.CommandError.html#variant.InvalidString
    /// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword
    fn change_user_pin(&self, current: &str, new: &str) -> CommandStatus {
        let current_string = CString::new(current);
        let new_string = CString::new(new);
        if current_string.is_err() || new_string.is_err() {
            return CommandStatus::Error(CommandError::InvalidString);
        }
        let current_string = current_string.unwrap();
        let new_string = new_string.unwrap();
        unsafe {
            CommandStatus::from(nitrokey_sys::NK_change_user_PIN(
                current_string.as_ptr(),
                new_string.as_ptr(),
            ))
        }
    }
}

trait AuthenticatedDevice {
    fn new(device: UnauthenticatedDevice, temp_password: Vec<u8>) -> Self;
}

impl UnauthenticatedDevice {
    fn authenticate<D, T>(
        self,
        password: &str,
        callback: T,
    ) -> Result<D, (UnauthenticatedDevice, CommandError)>
    where
        D: AuthenticatedDevice,
        T: Fn(*const i8, *const i8) -> c_int,
    {
        let temp_password = match generate_password(TEMPORARY_PASSWORD_LENGTH) {
            Ok(pw) => pw,
            Err(_) => return Err((self, CommandError::RngError)),
        };
        let password = CString::new(password);
        if password.is_err() {
            return Err((self, CommandError::InvalidString));
        }

        let pw = password.unwrap();
        let password_ptr = pw.as_ptr();
        let temp_password_ptr = temp_password.as_ptr() as *const i8;
        return match callback(password_ptr, temp_password_ptr) {
            0 => Ok(D::new(self, temp_password)),
            rv => Err((self, CommandError::from(rv))),
        };
    }

    /// Performs user authentication.  This method consumes the device.  If
    /// successful, an authenticated device is returned.  Otherwise, the
    /// current unauthenticated device and the error are returned.
    ///
    /// This method generates a random temporary password that is used for all
    /// operations that require user access.
    ///
    /// # Errors
    ///
    /// - [`InvalidString`][] if the provided user password contains a null byte
    /// - [`RngError`][] if the generation of the temporary password failed
    /// - [`WrongPassword`][] if the provided user password is wrong
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::{UnauthenticatedDevice, UserAuthenticatedDevice};
    /// # use nitrokey::CommandError;
    ///
    /// fn perform_user_task(device: &UserAuthenticatedDevice) {}
    /// fn perform_other_task(device: &UnauthenticatedDevice) {}
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// let device = match device.authenticate_user("123456") {
    ///     Ok(user) => {
    ///         perform_user_task(&user);
    ///         user.device()
    ///     },
    ///     Err((device, err)) => {
    ///         println!("Could not authenticate as user: {:?}", err);
    ///         device
    ///     },
    /// };
    /// perform_other_task(&device);
    /// #     Ok(())
    /// # }
    /// ```
    ///
    /// [`InvalidString`]: enum.CommandError.html#variant.InvalidString
    /// [`RngError`]: enum.CommandError.html#variant.RngError
    /// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword
    pub fn authenticate_user(
        self,
        password: &str,
    ) -> Result<UserAuthenticatedDevice, (UnauthenticatedDevice, CommandError)> {
        return self.authenticate(password, |password_ptr, temp_password_ptr| unsafe {
            nitrokey_sys::NK_user_authenticate(password_ptr, temp_password_ptr)
        });
    }

    /// Performs admin authentication.  This method consumes the device.  If
    /// successful, an authenticated device is returned.  Otherwise, the
    /// current unauthenticated device and the error are returned.
    ///
    /// This method generates a random temporary password that is used for all
    /// operations that require admin access.
    ///
    /// # Errors
    ///
    /// - [`InvalidString`][] if the provided admin password contains a null byte
    /// - [`RngError`][] if the generation of the temporary password failed
    /// - [`WrongPassword`][] if the provided admin password is wrong
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::{AdminAuthenticatedDevice, UnauthenticatedDevice};
    /// # use nitrokey::CommandError;
    ///
    /// fn perform_admin_task(device: &AdminAuthenticatedDevice) {}
    /// fn perform_other_task(device: &UnauthenticatedDevice) {}
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// let device = match device.authenticate_admin("123456") {
    ///     Ok(admin) => {
    ///         perform_admin_task(&admin);
    ///         admin.device()
    ///     },
    ///     Err((device, err)) => {
    ///         println!("Could not authenticate as admin: {:?}", err);
    ///         device
    ///     },
    /// };
    /// perform_other_task(&device);
    /// #     Ok(())
    /// # }
    /// ```
    ///
    /// [`InvalidString`]: enum.CommandError.html#variant.InvalidString
    /// [`RngError`]: enum.CommandError.html#variant.RngError
    /// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword
    pub fn authenticate_admin(
        self,
        password: &str,
    ) -> Result<AdminAuthenticatedDevice, (UnauthenticatedDevice, CommandError)> {
        return self.authenticate(password, |password_ptr, temp_password_ptr| unsafe {
            nitrokey_sys::NK_first_authenticate(password_ptr, temp_password_ptr)
        });
    }
}

impl Drop for UnauthenticatedDevice {
    fn drop(&mut self) {
        unsafe {
            nitrokey_sys::NK_logout();
        }
    }
}

impl Device for UnauthenticatedDevice {}

impl GenerateOtp for UnauthenticatedDevice {}

impl UserAuthenticatedDevice {
    /// Forgets the user authentication and returns an unauthenticated
    /// device.  This method consumes the authenticated device.  It does not
    /// perform any actual commands on the Nitrokey.
    pub fn device(self) -> UnauthenticatedDevice {
        self.device
    }
}

impl Device for UserAuthenticatedDevice {}

impl GenerateOtp for UserAuthenticatedDevice {
    /// Generates an HOTP code on the given slot.  This operation may not
    /// require user authorization, depending on the device configuration (see
    /// [`get_config`][]).
    ///
    /// # Errors
    ///
    /// - [`SlotNotProgrammed`][] if the given slot is not configured
    /// - [`WrongSlot`][] if there is no slot with the given number
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::{Device, GenerateOtp};
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// match device.authenticate_user("123456") {
    ///     Ok(user) => {
    ///         let code = user.get_hotp_code(1)?;
    ///         println!("Generated HOTP code on slot 1: {:?}", code);
    ///     },
    ///     Err(err) => println!("Could not authenticate: {:?}", err),
    /// };
    /// #     Ok(())
    /// # }
    /// ```
    ///
    /// [`get_config`]: #method.get_config
    /// [`SlotNotProgrammed`]: enum.CommandError.html#variant.SlotNotProgrammed
    /// [`WrongSlot`]: enum.CommandError.html#variant.WrongSlot
    fn get_hotp_code(&self, slot: u8) -> Result<String, CommandError> {
        unsafe {
            let temp_password_ptr = self.temp_password.as_ptr() as *const i8;
            return result_from_string(nitrokey_sys::NK_get_hotp_code_PIN(slot, temp_password_ptr));
        }
    }

    /// Generates a TOTP code on the given slot.  This operation may not
    /// require user authorization, depending on the device configuration (see
    /// [`get_config`][]).
    ///
    /// To make sure that the Nitrokey’s time is in sync, consider calling
    /// [`set_time`][] before calling this method.
    ///
    /// # Errors
    ///
    /// - [`SlotNotProgrammed`][] if the given slot is not configured
    /// - [`WrongSlot`][] if there is no slot with the given number
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::{Device, GenerateOtp};
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// match device.authenticate_user("123456") {
    ///     Ok(user) => {
    ///         let code = user.get_totp_code(1)?;
    ///         println!("Generated TOTP code on slot 1: {:?}", code);
    ///     },
    ///     Err(err) => println!("Could not authenticate: {:?}", err),
    /// };
    /// #     Ok(())
    /// # }
    /// ```
    ///
    /// [`get_config`]: #method.get_config
    /// [`set_time`]: trait.Device.html#method.set_time
    /// [`SlotNotProgrammed`]: enum.CommandError.html#variant.SlotNotProgrammed
    /// [`WrongSlot`]: enum.CommandError.html#variant.WrongSlot
    fn get_totp_code(&self, slot: u8) -> Result<String, CommandError> {
        unsafe {
            let temp_password_ptr = self.temp_password.as_ptr() as *const i8;
            return result_from_string(nitrokey_sys::NK_get_totp_code_PIN(
                slot,
                0,
                0,
                0,
                temp_password_ptr,
            ));
        }
    }
}

impl AuthenticatedDevice for UserAuthenticatedDevice {
    fn new(device: UnauthenticatedDevice, temp_password: Vec<u8>) -> Self {
        UserAuthenticatedDevice {
            device,
            temp_password,
        }
    }
}

impl AdminAuthenticatedDevice {
    /// Forgets the user authentication and returns an unauthenticated
    /// device.  This method consumes the authenticated device.  It does not
    /// perform any actual commands on the Nitrokey.
    pub fn device(self) -> UnauthenticatedDevice {
        self.device
    }

    /// Writes the given configuration to the Nitrokey device.
    ///
    /// # Errors
    ///
    /// - [`InvalidSlot`][] if the provided numlock, capslock or scrolllock
    ///   slot is larger than two
    ///
    /// # Example
    ///
    /// ```no_run
    /// use nitrokey::Config;
    /// # use nitrokey::CommandError;
    ///
    /// # fn try_main() -> Result<(), CommandError> {
    /// let device = nitrokey::connect()?;
    /// let config = Config::new(None, None, None, false);
    /// match device.authenticate_admin("12345678") {
    ///     Ok(admin) => {
    ///         admin.write_config(config);
    ///         ()
    ///     },
    ///     Err((_, err)) => println!("Could not authenticate as admin: {:?}", err),
    /// };
    /// #     Ok(())
    /// # }
    /// ```
    ///
    /// [`InvalidSlot`]: enum.CommandError.html#variant.InvalidSlot
    pub fn write_config(&self, config: Config) -> CommandStatus {
        let raw_config = match RawConfig::try_from(config) {
            Ok(raw_config) => raw_config,
            Err(err) => return CommandStatus::Error(err),
        };
        unsafe {
            let rv = nitrokey_sys::NK_write_config(
                raw_config.numlock,
                raw_config.capslock,
                raw_config.scrollock,
                raw_config.user_password,
                false,
                self.temp_password.as_ptr() as *const i8,
            );
            return CommandStatus::from(rv);
        }
    }

    fn write_otp_slot<T>(&self, data: OtpSlotData, callback: T) -> CommandStatus
    where
        T: Fn(RawOtpSlotData, *const i8) -> c_int,
    {
        let raw_data = match RawOtpSlotData::new(data) {
            Ok(raw_data) => raw_data,
            Err(err) => return CommandStatus::Error(err),
        };
        let temp_password_ptr = self.temp_password.as_ptr() as *const i8;
        let rv = callback(raw_data, temp_password_ptr);
        return CommandStatus::from(rv);
    }
}

impl Device for AdminAuthenticatedDevice {}

impl ConfigureOtp for AdminAuthenticatedDevice {
    fn write_hotp_slot(&self, data: OtpSlotData, counter: u64) -> CommandStatus {
        return self.write_otp_slot(data, |raw_data: RawOtpSlotData, temp_password_ptr| unsafe {
            nitrokey_sys::NK_write_hotp_slot(
                raw_data.number,
                raw_data.name.as_ptr(),
                raw_data.secret.as_ptr(),
                counter,
                raw_data.mode == OtpMode::EightDigits,
                raw_data.use_enter,
                raw_data.use_token_id,
                raw_data.token_id.as_ptr(),
                temp_password_ptr,
            )
        });
    }

    fn write_totp_slot(&self, data: OtpSlotData, time_window: u16) -> CommandStatus {
        return self.write_otp_slot(data, |raw_data: RawOtpSlotData, temp_password_ptr| unsafe {
            nitrokey_sys::NK_write_totp_slot(
                raw_data.number,
                raw_data.name.as_ptr(),
                raw_data.secret.as_ptr(),
                time_window,
                raw_data.mode == OtpMode::EightDigits,
                raw_data.use_enter,
                raw_data.use_token_id,
                raw_data.token_id.as_ptr(),
                temp_password_ptr,
            )
        });
    }

    fn erase_hotp_slot(&self, slot: u8) -> CommandStatus {
        let temp_password_ptr = self.temp_password.as_ptr() as *const i8;
        unsafe { CommandStatus::from(nitrokey_sys::NK_erase_hotp_slot(slot, temp_password_ptr)) }
    }

    fn erase_totp_slot(&self, slot: u8) -> CommandStatus {
        let temp_password_ptr = self.temp_password.as_ptr() as *const i8;
        unsafe { CommandStatus::from(nitrokey_sys::NK_erase_totp_slot(slot, temp_password_ptr)) }
    }
}

impl GenerateOtp for AdminAuthenticatedDevice {}

impl AuthenticatedDevice for AdminAuthenticatedDevice {
    fn new(device: UnauthenticatedDevice, temp_password: Vec<u8>) -> Self {
        AdminAuthenticatedDevice {
            device,
            temp_password,
        }
    }
}