summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/auth.rs183
-rw-r--r--src/device.rs42
-rw-r--r--src/lib.rs4
-rw-r--r--src/otp.rs16
-rw-r--r--src/pws.rs24
5 files changed, 182 insertions, 87 deletions
diff --git a/src/auth.rs b/src/auth.rs
index 573fed3..f9f50fa 100644
--- a/src/auth.rs
+++ b/src/auth.rs
@@ -42,10 +42,16 @@ pub trait Authenticate {
/// fn perform_other_task(device: &DeviceWrapper) {}
///
/// # fn try_main() -> Result<(), Error> {
- /// let mut device = nitrokey::connect()?;
- /// match device.authenticate_user("123456") {
- /// Ok(user) => perform_user_task(&user),
- /// Err(err) => eprintln!("Could not authenticate as user: {}", err),
+ /// let device = nitrokey::connect()?;
+ /// let device = match device.authenticate_user("123456") {
+ /// Ok(user) => {
+ /// perform_user_task(&user);
+ /// user.device()
+ /// },
+ /// Err((device, err)) => {
+ /// eprintln!("Could not authenticate as user: {}", err);
+ /// device
+ /// },
/// };
/// perform_other_task(&device);
/// # Ok(())
@@ -55,9 +61,9 @@ pub trait Authenticate {
/// [`InvalidString`]: enum.LibraryError.html#variant.InvalidString
/// [`RngError`]: enum.CommandError.html#variant.RngError
/// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword
- fn authenticate_user(&mut self, password: &str) -> Result<User<'_, Self>, Error>
+ fn authenticate_user(self, password: &str) -> Result<User<Self>, (Self, Error)>
where
- Self: Device + std::marker::Sized;
+ Self: Device + Sized;
/// Performs admin authentication. This method consumes the device. If successful, an
/// authenticated device is returned. Otherwise, the current unauthenticated device and the
@@ -82,10 +88,16 @@ pub trait Authenticate {
/// fn perform_other_task(device: &DeviceWrapper) {}
///
/// # fn try_main() -> Result<(), Error> {
- /// let mut device = nitrokey::connect()?;
- /// match device.authenticate_admin("123456") {
- /// Ok(admin) => perform_admin_task(&admin),
- /// Err(err) => eprintln!("Could not authenticate as admin: {}", err),
+ /// let device = nitrokey::connect()?;
+ /// let device = match device.authenticate_admin("123456") {
+ /// Ok(admin) => {
+ /// perform_admin_task(&admin);
+ /// admin.device()
+ /// },
+ /// Err((device, err)) => {
+ /// eprintln!("Could not authenticate as admin: {}", err);
+ /// device
+ /// },
/// };
/// perform_other_task(&device);
/// # Ok(())
@@ -95,13 +107,13 @@ pub trait Authenticate {
/// [`InvalidString`]: enum.LibraryError.html#variant.InvalidString
/// [`RngError`]: enum.CommandError.html#variant.RngError
/// [`WrongPassword`]: enum.CommandError.html#variant.WrongPassword
- fn authenticate_admin(&mut self, password: &str) -> Result<Admin<'_, Self>, Error>
+ fn authenticate_admin(self, password: &str) -> Result<Admin<Self>, (Self, Error)>
where
- Self: Device + std::marker::Sized;
+ Self: Device + Sized;
}
-trait AuthenticatedDevice<'a, T> {
- fn new(device: &'a mut T, temp_password: Vec<u8>) -> Self;
+trait AuthenticatedDevice<T> {
+ fn new(device: T, temp_password: Vec<u8>) -> Self;
fn temp_password_ptr(&self) -> *const c_char;
}
@@ -116,8 +128,8 @@ trait AuthenticatedDevice<'a, T> {
/// [`authenticate_admin`]: trait.Authenticate.html#method.authenticate_admin
/// [`device`]: #method.device
#[derive(Debug)]
-pub struct User<'a, T: Device> {
- device: &'a mut T,
+pub struct User<T: Device> {
+ device: T,
temp_password: Vec<u8>,
}
@@ -131,42 +143,89 @@ pub struct User<'a, T: Device> {
/// [`authenticate_admin`]: trait.Authenticate.html#method.authenticate_admin
/// [`device`]: #method.device
#[derive(Debug)]
-pub struct Admin<'a, T: Device> {
- device: &'a mut T,
+pub struct Admin<T: Device> {
+ device: T,
temp_password: Vec<u8>,
}
-fn authenticate<'a, D, A, T>(device: &'a mut D, password: &str, callback: T) -> Result<A, Error>
+fn authenticate<D, A, T>(device: D, password: &str, callback: T) -> Result<A, (D, Error)>
where
D: Device,
- A: AuthenticatedDevice<'a, D>,
+ A: AuthenticatedDevice<D>,
T: Fn(*const c_char, *const c_char) -> c_int,
{
- let temp_password = generate_password(TEMPORARY_PASSWORD_LENGTH)?;
- let password = get_cstring(password)?;
+ let temp_password = match generate_password(TEMPORARY_PASSWORD_LENGTH) {
+ Ok(temp_password) => temp_password,
+ Err(err) => return Err((device, err)),
+ };
+ let password = match get_cstring(password) {
+ Ok(password) => password,
+ Err(err) => return Err((device, err)),
+ };
let password_ptr = password.as_ptr();
let temp_password_ptr = temp_password.as_ptr() as *const c_char;
match callback(password_ptr, temp_password_ptr) {
0 => Ok(A::new(device, temp_password)),
- rv => Err(Error::from(rv)),
+ rv => Err((device, Error::from(rv))),
}
}
-impl<'a, T: Device> ops::Deref for User<'a, T> {
+fn authenticate_user_wrapper<T, C>(
+ device: T,
+ constructor: C,
+ password: &str,
+) -> Result<User<DeviceWrapper>, (DeviceWrapper, Error)>
+where
+ T: Device,
+ C: Fn(T) -> DeviceWrapper,
+{
+ let result = device.authenticate_user(password);
+ match result {
+ Ok(user) => Ok(User::new(constructor(user.device), user.temp_password)),
+ Err((device, err)) => Err((constructor(device), err)),
+ }
+}
+
+fn authenticate_admin_wrapper<T, C>(
+ device: T,
+ constructor: C,
+ password: &str,
+) -> Result<Admin<DeviceWrapper>, (DeviceWrapper, Error)>
+where
+ T: Device,
+ C: Fn(T) -> DeviceWrapper,
+{
+ let result = device.authenticate_admin(password);
+ match result {
+ Ok(user) => Ok(Admin::new(constructor(user.device), user.temp_password)),
+ Err((device, err)) => Err((constructor(device), err)),
+ }
+}
+
+impl<T: Device> User<T> {
+ /// 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) -> T {
+ self.device
+ }
+}
+
+impl<T: Device> ops::Deref for User<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
- self.device
+ &self.device
}
}
-impl<'a, T: Device> ops::DerefMut for User<'a, T> {
+impl<T: Device> ops::DerefMut for User<T> {
fn deref_mut(&mut self) -> &mut T {
- self.device
+ &mut self.device
}
}
-impl<'a, T: Device> GenerateOtp for User<'a, T> {
+impl<T: Device> GenerateOtp for User<T> {
fn get_hotp_code(&mut self, slot: u8) -> Result<String, Error> {
result_from_string(unsafe {
nitrokey_sys::NK_get_hotp_code_PIN(slot, self.temp_password_ptr())
@@ -180,8 +239,8 @@ impl<'a, T: Device> GenerateOtp for User<'a, T> {
}
}
-impl<'a, T: Device> AuthenticatedDevice<'a, T> for User<'a, T> {
- fn new(device: &'a mut T, temp_password: Vec<u8>) -> Self {
+impl<T: Device> AuthenticatedDevice<T> for User<T> {
+ fn new(device: T, temp_password: Vec<u8>) -> Self {
User {
device,
temp_password,
@@ -193,21 +252,28 @@ impl<'a, T: Device> AuthenticatedDevice<'a, T> for User<'a, T> {
}
}
-impl<'a, T: Device> ops::Deref for Admin<'a, T> {
+impl<T: Device> ops::Deref for Admin<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
- self.device
+ &self.device
}
}
-impl<'a, T: Device> ops::DerefMut for Admin<'a, T> {
+impl<T: Device> ops::DerefMut for Admin<T> {
fn deref_mut(&mut self) -> &mut T {
- self.device
+ &mut self.device
}
}
-impl<'a, T: Device> Admin<'a, T> {
+impl<T: Device> Admin<T> {
+ /// 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) -> T {
+ self.device
+ }
+
/// Writes the given configuration to the Nitrokey device.
///
/// # Errors
@@ -221,11 +287,14 @@ impl<'a, T: Device> Admin<'a, T> {
/// # use nitrokey::Error;
///
/// # fn try_main() -> Result<(), Error> {
- /// let mut device = nitrokey::connect()?;
+ /// let device = nitrokey::connect()?;
/// let config = Config::new(None, None, None, false);
/// match device.authenticate_admin("12345678") {
- /// Ok(mut admin) => admin.write_config(config)?,
- /// Err(err) => eprintln!("Could not authenticate as admin: {}", err),
+ /// Ok(mut admin) => {
+ /// admin.write_config(config);
+ /// ()
+ /// },
+ /// Err((_, err)) => eprintln!("Could not authenticate as admin: {}", err),
/// };
/// # Ok(())
/// # }
@@ -247,7 +316,7 @@ impl<'a, T: Device> Admin<'a, T> {
}
}
-impl<'a, T: Device> ConfigureOtp for Admin<'a, T> {
+impl<T: Device> ConfigureOtp for Admin<T> {
fn write_hotp_slot(&mut self, data: OtpSlotData, counter: u64) -> Result<(), Error> {
let raw_data = RawOtpSlotData::new(data)?;
get_command_result(unsafe {
@@ -295,8 +364,8 @@ impl<'a, T: Device> ConfigureOtp for Admin<'a, T> {
}
}
-impl<'a, T: Device> AuthenticatedDevice<'a, T> for Admin<'a, T> {
- fn new(device: &'a mut T, temp_password: Vec<u8>) -> Self {
+impl<T: Device> AuthenticatedDevice<T> for Admin<T> {
+ fn new(device: T, temp_password: Vec<u8>) -> Self {
Admin {
device,
temp_password,
@@ -309,27 +378,35 @@ impl<'a, T: Device> AuthenticatedDevice<'a, T> for Admin<'a, T> {
}
impl Authenticate for DeviceWrapper {
- fn authenticate_user(&mut self, password: &str) -> Result<User<'_, Self>, Error> {
- authenticate(self, password, |password_ptr, temp_password_ptr| unsafe {
- nitrokey_sys::NK_user_authenticate(password_ptr, temp_password_ptr)
- })
+ fn authenticate_user(self, password: &str) -> Result<User<Self>, (Self, Error)> {
+ match self {
+ DeviceWrapper::Storage(storage) => {
+ authenticate_user_wrapper(storage, DeviceWrapper::Storage, password)
+ }
+ DeviceWrapper::Pro(pro) => authenticate_user_wrapper(pro, DeviceWrapper::Pro, password),
+ }
}
- fn authenticate_admin(&mut self, password: &str) -> Result<Admin<'_, Self>, Error> {
- authenticate(self, password, |password_ptr, temp_password_ptr| unsafe {
- nitrokey_sys::NK_user_authenticate(password_ptr, temp_password_ptr)
- })
+ fn authenticate_admin(self, password: &str) -> Result<Admin<Self>, (Self, Error)> {
+ match self {
+ DeviceWrapper::Storage(storage) => {
+ authenticate_admin_wrapper(storage, DeviceWrapper::Storage, password)
+ }
+ DeviceWrapper::Pro(pro) => {
+ authenticate_admin_wrapper(pro, DeviceWrapper::Pro, password)
+ }
+ }
}
}
impl Authenticate for Pro {
- fn authenticate_user(&mut self, password: &str) -> Result<User<'_, Self>, Error> {
+ fn authenticate_user(self, password: &str) -> Result<User<Self>, (Self, Error)> {
authenticate(self, password, |password_ptr, temp_password_ptr| unsafe {
nitrokey_sys::NK_user_authenticate(password_ptr, temp_password_ptr)
})
}
- fn authenticate_admin(&mut self, password: &str) -> Result<Admin<'_, Self>, Error> {
+ fn authenticate_admin(self, password: &str) -> Result<Admin<Self>, (Self, Error)> {
authenticate(self, password, |password_ptr, temp_password_ptr| unsafe {
nitrokey_sys::NK_first_authenticate(password_ptr, temp_password_ptr)
})
@@ -337,13 +414,13 @@ impl Authenticate for Pro {
}
impl Authenticate for Storage {
- fn authenticate_user(&mut self, password: &str) -> Result<User<'_, Self>, Error> {
+ fn authenticate_user(self, password: &str) -> Result<User<Self>, (Self, Error)> {
authenticate(self, password, |password_ptr, temp_password_ptr| unsafe {
nitrokey_sys::NK_user_authenticate(password_ptr, temp_password_ptr)
})
}
- fn authenticate_admin(&mut self, password: &str) -> Result<Admin<'_, Self>, Error> {
+ fn authenticate_admin(self, password: &str) -> Result<Admin<Self>, (Self, Error)> {
authenticate(self, password, |password_ptr, temp_password_ptr| unsafe {
nitrokey_sys::NK_first_authenticate(password_ptr, temp_password_ptr)
})
diff --git a/src/device.rs b/src/device.rs
index a0df30e..f6492cd 100644
--- a/src/device.rs
+++ b/src/device.rs
@@ -71,10 +71,16 @@ impl fmt::Display for VolumeMode {
/// fn perform_other_task(device: &DeviceWrapper) {}
///
/// # fn try_main() -> Result<(), Error> {
-/// let mut device = nitrokey::connect()?;
-/// match device.authenticate_user("123456") {
-/// Ok(user) => perform_user_task(&user),
-/// Err(err) => eprintln!("Could not authenticate as user: {}", err),
+/// let device = nitrokey::connect()?;
+/// let device = match device.authenticate_user("123456") {
+/// Ok(user) => {
+/// perform_user_task(&user);
+/// user.device()
+/// },
+/// Err((device, err)) => {
+/// eprintln!("Could not authenticate as user: {}", err);
+/// device
+/// },
/// };
/// perform_other_task(&device);
/// # Ok(())
@@ -129,10 +135,16 @@ pub enum DeviceWrapper {
/// fn perform_other_task(device: &Pro) {}
///
/// # fn try_main() -> Result<(), Error> {
-/// let mut device = nitrokey::Pro::connect()?;
-/// match device.authenticate_user("123456") {
-/// Ok(user) => perform_user_task(&user),
-/// Err(err) => eprintln!("Could not authenticate as user: {}", err),
+/// let device = nitrokey::Pro::connect()?;
+/// let device = match device.authenticate_user("123456") {
+/// Ok(user) => {
+/// perform_user_task(&user);
+/// user.device()
+/// },
+/// Err((device, err)) => {
+/// eprintln!("Could not authenticate as user: {}", err);
+/// device
+/// },
/// };
/// perform_other_task(&device);
/// # Ok(())
@@ -169,10 +181,16 @@ pub struct Pro {
/// fn perform_other_task(device: &Storage) {}
///
/// # fn try_main() -> Result<(), Error> {
-/// let mut device = nitrokey::Storage::connect()?;
-/// match device.authenticate_user("123456") {
-/// Ok(user) => perform_user_task(&user),
-/// Err(err) => eprintln!("Could not authenticate as user: {}", err),
+/// let device = nitrokey::Storage::connect()?;
+/// let device = match device.authenticate_user("123456") {
+/// Ok(user) => {
+/// perform_user_task(&user);
+/// user.device()
+/// },
+/// Err((device, err)) => {
+/// eprintln!("Could not authenticate as user: {}", err);
+/// device
+/// },
/// };
/// perform_other_task(&device);
/// # Ok(())
diff --git a/src/lib.rs b/src/lib.rs
index d7a8c5e..c35829c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -44,7 +44,7 @@
//! # use nitrokey::Error;
//!
//! # fn try_main() -> Result<(), Error> {
-//! let mut device = nitrokey::connect()?;
+//! let device = nitrokey::connect()?;
//! let slot_data = OtpSlotData::new(1, "test", "01234567890123456689", OtpMode::SixDigits);
//! match device.authenticate_admin("12345678") {
//! Ok(mut admin) => {
@@ -53,7 +53,7 @@
//! Err(err) => eprintln!("Could not write slot: {}", err),
//! }
//! },
-//! Err(err) => eprintln!("Could not authenticate as admin: {}", err),
+//! Err((_, err)) => eprintln!("Could not authenticate as admin: {}", err),
//! }
//! # Ok(())
//! # }
diff --git a/src/otp.rs b/src/otp.rs
index a8dd20b..ee142c7 100644
--- a/src/otp.rs
+++ b/src/otp.rs
@@ -35,7 +35,7 @@ pub trait ConfigureOtp {
/// # use nitrokey::Error;
///
/// # fn try_main() -> Result<(), Error> {
- /// let mut device = nitrokey::connect()?;
+ /// let device = nitrokey::connect()?;
/// let slot_data = OtpSlotData::new(1, "test", "01234567890123456689", OtpMode::SixDigits);
/// match device.authenticate_admin("12345678") {
/// Ok(mut admin) => {
@@ -44,7 +44,7 @@ pub trait ConfigureOtp {
/// Err(err) => eprintln!("Could not write slot: {}", err),
/// }
/// },
- /// Err(err) => eprintln!("Could not authenticate as admin: {}", err),
+ /// Err((_, err)) => eprintln!("Could not authenticate as admin: {}", err),
/// }
/// # Ok(())
/// # }
@@ -71,7 +71,7 @@ pub trait ConfigureOtp {
/// # use nitrokey::Error;
///
/// # fn try_main() -> Result<(), Error> {
- /// let mut device = nitrokey::connect()?;
+ /// let device = nitrokey::connect()?;
/// let slot_data = OtpSlotData::new(1, "test", "01234567890123456689", OtpMode::EightDigits);
/// match device.authenticate_admin("12345678") {
/// Ok(mut admin) => {
@@ -80,7 +80,7 @@ pub trait ConfigureOtp {
/// Err(err) => eprintln!("Could not write slot: {}", err),
/// }
/// },
- /// Err(err) => eprintln!("Could not authenticate as admin: {}", err),
+ /// Err((_, err)) => eprintln!("Could not authenticate as admin: {}", err),
/// }
/// # Ok(())
/// # }
@@ -104,7 +104,7 @@ pub trait ConfigureOtp {
/// # use nitrokey::Error;
///
/// # fn try_main() -> Result<(), Error> {
- /// let mut device = nitrokey::connect()?;
+ /// let device = nitrokey::connect()?;
/// match device.authenticate_admin("12345678") {
/// Ok(mut admin) => {
/// match admin.erase_hotp_slot(1) {
@@ -112,7 +112,7 @@ pub trait ConfigureOtp {
/// Err(err) => eprintln!("Could not erase slot: {}", err),
/// }
/// },
- /// Err(err) => eprintln!("Could not authenticate as admin: {}", err),
+ /// Err((_, err)) => eprintln!("Could not authenticate as admin: {}", err),
/// }
/// # Ok(())
/// # }
@@ -134,7 +134,7 @@ pub trait ConfigureOtp {
/// # use nitrokey::Error;
///
/// # fn try_main() -> Result<(), Error> {
- /// let mut device = nitrokey::connect()?;
+ /// let device = nitrokey::connect()?;
/// match device.authenticate_admin("12345678") {
/// Ok(mut admin) => {
/// match admin.erase_totp_slot(1) {
@@ -142,7 +142,7 @@ pub trait ConfigureOtp {
/// Err(err) => eprintln!("Could not erase slot: {}", err),
/// }
/// },
- /// Err(err) => eprintln!("Could not authenticate as admin: {}", err),
+ /// Err((_, err)) => eprintln!("Could not authenticate as admin: {}", err),
/// }
/// # Ok(())
/// # }
diff --git a/src/pws.rs b/src/pws.rs
index a5b9d33..371de6e 100644
--- a/src/pws.rs
+++ b/src/pws.rs
@@ -18,7 +18,8 @@ pub const SLOT_COUNT: u8 = 16;
/// The password safe stores a tuple consisting of a name, a login and a password on a slot. The
/// number of available slots is [`SLOT_COUNT`][]. The slots are addressed starting with zero. To
/// retrieve a password safe from a Nitrokey device, use the [`get_password_safe`][] method from
-/// the [`GetPasswordSafe`][] trait.
+/// the [`GetPasswordSafe`][] trait. Note that the device must live at least as long as the
+/// password safe.
///
/// Once the password safe has been unlocked, it can be accessed without a password. Therefore it
/// is mandatory to call [`lock`][] on the corresponding device after the password store is used.
@@ -57,17 +58,21 @@ pub const SLOT_COUNT: u8 = 16;
/// [`GetPasswordSafe`]: trait.GetPasswordSafe.html
#[derive(Debug)]
pub struct PasswordSafe<'a> {
- device: &'a mut dyn Device,
+ _device: &'a dyn Device,
}
/// Provides access to a [`PasswordSafe`][].
///
+/// The device that implements this trait must always live at least as long as a password safe
+/// retrieved from it.
+///
/// [`PasswordSafe`]: struct.PasswordSafe.html
pub trait GetPasswordSafe {
/// Enables and returns the password safe.
///
- /// It is mandatory to lock the underlying device using [`lock`][] after the password safe has
- /// been used. Otherwise, other applications can access the password store without
+ /// The underlying device must always live at least as long as a password safe retrieved from
+ /// it. It is mandatory to lock the underlying device using [`lock`][] after the password safe
+ /// has been used. Otherwise, other applications can access the password store without
/// authentication.
///
/// If this method returns an `AesDecryptionFailed` (Nitrokey Pro) or `Unknown` (Nitrokey
@@ -116,17 +121,12 @@ pub trait GetPasswordSafe {
}
fn get_password_safe<'a>(
- device: &'a mut dyn Device,
+ device: &'a dyn Device,
user_pin: &str,
) -> Result<PasswordSafe<'a>, Error> {
let user_pin_string = get_cstring(user_pin)?;
- let result = get_command_result(unsafe {
- nitrokey_sys::NK_enable_password_safe(user_pin_string.as_ptr())
- });
- match result {
- Ok(()) => Ok(PasswordSafe { device }),
- Err(err) => Err(err),
- }
+ get_command_result(unsafe { nitrokey_sys::NK_enable_password_safe(user_pin_string.as_ptr()) })
+ .map(|_| PasswordSafe { _device: device })
}
fn get_pws_result(s: String) -> Result<String, Error> {
generated by cgit v1.2.3 (git 2.46.0) at 2024-11-24 07:20:30 +0000