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
use nitrokey_sys;
use std::ffi::CString;
use util::{get_command_result, get_cstring, result_from_string, CommandError};
/// Modes for one-time password generation.
#[derive(Debug, PartialEq)]
pub enum OtpMode {
/// Generate one-time passwords with six digits.
SixDigits,
/// Generate one-time passwords with eight digits.
EightDigits,
}
/// Provides methods to configure and erase OTP slots on a Nitrokey device.
pub trait ConfigureOtp {
/// Configure an HOTP slot with the given data and set the HOTP counter to the given value
/// (default 0).
///
/// # Errors
///
/// - [`InvalidSlot`][] if there is no slot with the given number
/// - [`InvalidString`][] if the provided token ID contains a null byte
/// - [`NoName`][] if the provided name is empty
///
/// # Example
///
/// ```no_run
/// use nitrokey::{Authenticate, ConfigureOtp, OtpMode, OtpSlotData};
/// # use nitrokey::CommandError;
///
/// # fn try_main() -> Result<(), (CommandError)> {
/// let device = nitrokey::connect()?;
/// let slot_data = OtpSlotData::new(1, "test", "01234567890123456689", OtpMode::SixDigits);
/// match device.authenticate_admin("12345678") {
/// Ok(admin) => {
/// match admin.write_hotp_slot(slot_data, 0) {
/// Ok(()) => println!("Successfully wrote slot."),
/// Err(err) => println!("Could not write slot: {}", err),
/// }
/// },
/// Err((_, err)) => println!("Could not authenticate as admin: {}", err),
/// }
/// # Ok(())
/// # }
/// ```
///
/// [`InvalidSlot`]: enum.CommandError.html#variant.InvalidSlot
/// [`InvalidString`]: enum.CommandError.html#variant.InvalidString
/// [`NoName`]: enum.CommandError.html#variant.NoName
fn write_hotp_slot(&self, data: OtpSlotData, counter: u64) -> Result<(), CommandError>;
/// Configure a TOTP slot with the given data and set the TOTP time window to the given value
/// (default 30).
///
/// # Errors
///
/// - [`InvalidSlot`][] if there is no slot with the given number
/// - [`InvalidString`][] if the provided token ID contains a null byte
/// - [`NoName`][] if the provided name is empty
///
/// # Example
///
/// ```no_run
/// use nitrokey::{Authenticate, ConfigureOtp, OtpMode, OtpSlotData};
/// # use nitrokey::CommandError;
///
/// # fn try_main() -> Result<(), (CommandError)> {
/// let device = nitrokey::connect()?;
/// let slot_data = OtpSlotData::new(1, "test", "01234567890123456689", OtpMode::EightDigits);
/// match device.authenticate_admin("12345678") {
/// Ok(admin) => {
/// match admin.write_totp_slot(slot_data, 30) {
/// Ok(()) => println!("Successfully wrote slot."),
/// Err(err) => println!("Could not write slot: {}", err),
/// }
/// },
/// Err((_, err)) => println!("Could not authenticate as admin: {}", err),
/// }
/// # Ok(())
/// # }
/// ```
///
/// [`InvalidSlot`]: enum.CommandError.html#variant.InvalidSlot
/// [`InvalidString`]: enum.CommandError.html#variant.InvalidString
/// [`NoName`]: enum.CommandError.html#variant.NoName
fn write_totp_slot(&self, data: OtpSlotData, time_window: u16) -> Result<(), CommandError>;
/// Erases an HOTP slot.
///
/// # Errors
///
/// - [`InvalidSlot`][] if there is no slot with the given number
///
/// # Example
///
/// ```no_run
/// use nitrokey::{Authenticate, ConfigureOtp};
/// # use nitrokey::CommandError;
///
/// # fn try_main() -> Result<(), (CommandError)> {
/// let device = nitrokey::connect()?;
/// match device.authenticate_admin("12345678") {
/// Ok(admin) => {
/// match admin.erase_hotp_slot(1) {
/// Ok(()) => println!("Successfully erased slot."),
/// Err(err) => println!("Could not erase slot: {}", err),
/// }
/// },
/// Err((_, err)) => println!("Could not authenticate as admin: {}", err),
/// }
/// # Ok(())
/// # }
/// ```
///
/// [`InvalidSlot`]: enum.CommandError.html#variant.InvalidSlot
fn erase_hotp_slot(&self, slot: u8) -> Result<(), CommandError>;
/// Erases a TOTP slot.
///
/// # Errors
///
/// - [`InvalidSlot`][] if there is no slot with the given number
///
/// # Example
///
/// ```no_run
/// use nitrokey::{Authenticate, ConfigureOtp};
/// # use nitrokey::CommandError;
///
/// # fn try_main() -> Result<(), (CommandError)> {
/// let device = nitrokey::connect()?;
/// match device.authenticate_admin("12345678") {
/// Ok(admin) => {
/// match admin.erase_totp_slot(1) {
/// Ok(()) => println!("Successfully erased slot."),
/// Err(err) => println!("Could not erase slot: {}", err),
/// }
/// },
/// Err((_, err)) => println!("Could not authenticate as admin: {}", err),
/// }
/// # Ok(())
/// # }
/// ```
///
/// [`InvalidSlot`]: enum.CommandError.html#variant.InvalidSlot
fn erase_totp_slot(&self, slot: u8) -> Result<(), CommandError>;
}
/// Provides methods to generate OTP codes and to query OTP slots on a Nitrokey
/// device.
pub trait GenerateOtp {
/// 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`]: #method.get_totp_code
/// [`Timestamp`]: enum.CommandError.html#variant.Timestamp
fn set_time(&self, time: u64) -> Result<(), CommandError> {
unsafe { get_command_result(nitrokey_sys::NK_totp_set_time(time)) }
}
/// Returns the name of the given HOTP slot.
///
/// # Errors
///
/// - [`InvalidSlot`][] if there is no slot with the given number
/// - [`SlotNotProgrammed`][] if the given slot is not configured
///
/// # Example
///
/// ```no_run
/// use nitrokey::{CommandError, GenerateOtp};
///
/// # fn try_main() -> Result<(), CommandError> {
/// let device = nitrokey::connect()?;
/// match device.get_hotp_slot_name(1) {
/// Ok(name) => println!("HOTP slot 1: {}", name),
/// Err(CommandError::SlotNotProgrammed) => println!("HOTP slot 1 not programmed"),
/// Err(err) => println!("Could not get slot name: {}", err),
/// };
/// # Ok(())
/// # }
/// ```
///
/// [`InvalidSlot`]: enum.CommandError.html#variant.InvalidSlot
/// [`SlotNotProgrammed`]: enum.CommandError.html#variant.SlotNotProgrammed
fn get_hotp_slot_name(&self, slot: u8) -> Result<String, CommandError> {
unsafe { result_from_string(nitrokey_sys::NK_get_hotp_slot_name(slot)) }
}
/// Returns the name of the given TOTP slot.
///
/// # Errors
///
/// - [`InvalidSlot`][] if there is no slot with the given number
/// - [`SlotNotProgrammed`][] if the given slot is not configured
///
/// # Example
///
/// ```no_run
/// use nitrokey::{CommandError, GenerateOtp};
///
/// # fn try_main() -> Result<(), CommandError> {
/// let device = nitrokey::connect()?;
/// match device.get_totp_slot_name(1) {
/// Ok(name) => println!("TOTP slot 1: {}", name),
/// Err(CommandError::SlotNotProgrammed) => println!("TOTP slot 1 not programmed"),
/// Err(err) => println!("Could not get slot name: {}", err),
/// };
/// # Ok(())
/// # }
/// ```
///
/// [`InvalidSlot`]: enum.CommandError.html#variant.InvalidSlot
/// [`SlotNotProgrammed`]: enum.CommandError.html#variant.SlotNotProgrammed
fn get_totp_slot_name(&self, slot: u8) -> Result<String, CommandError> {
unsafe { result_from_string(nitrokey_sys::NK_get_totp_slot_name(slot)) }
}
/// Generates an HOTP code on the given slot. This operation may require user authorization,
/// depending on the device configuration (see [`get_config`][]).
///
/// # Errors
///
/// - [`InvalidSlot`][] if there is no slot with the given number
/// - [`NotAuthorized`][] if OTP generation requires user authentication
/// - [`SlotNotProgrammed`][] if the given slot is not configured
///
/// # Example
///
/// ```no_run
/// use nitrokey::GenerateOtp;
/// # use nitrokey::CommandError;
///
/// # fn try_main() -> Result<(), CommandError> {
/// let device = nitrokey::connect()?;
/// let code = device.get_hotp_code(1)?;
/// println!("Generated HOTP code on slot 1: {}", code);
/// # Ok(())
/// # }
/// ```
///
/// [`get_config`]: trait.Device.html#method.get_config
/// [`InvalidSlot`]: enum.CommandError.html#variant.InvalidSlot
/// [`NotAuthorized`]: enum.CommandError.html#variant.NotAuthorized
/// [`SlotNotProgrammed`]: enum.CommandError.html#variant.SlotNotProgrammed
fn get_hotp_code(&self, slot: u8) -> Result<String, CommandError> {
unsafe {
return result_from_string(nitrokey_sys::NK_get_hotp_code(slot));
}
}
/// Generates a TOTP code on the given slot. This operation may 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
///
/// - [`InvalidSlot`][] if there is no slot with the given number
/// - [`NotAuthorized`][] if OTP generation requires user authentication
/// - [`SlotNotProgrammed`][] if the given slot is not configured
///
/// # Example
///
/// ```ignore
/// extern crate chrono;
///
/// use nitrokey::GenerateOtp;
/// # 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);
/// let code = device.get_totp_code(1)?;
/// println!("Generated TOTP code on slot 1: {}", code);
/// }
/// # Ok(())
/// # }
/// ```
///
/// [`set_time`]: #method.set_time
/// [`get_config`]: trait.Device.html#method.get_config
/// [`InvalidSlot`]: enum.CommandError.html#variant.InvalidSlot
/// [`NotAuthorized`]: enum.CommandError.html#variant.NotAuthorized
/// [`SlotNotProgrammed`]: enum.CommandError.html#variant.SlotNotProgrammed
fn get_totp_code(&self, slot: u8) -> Result<String, CommandError> {
unsafe {
return result_from_string(nitrokey_sys::NK_get_totp_code(slot, 0, 0, 0));
}
}
}
/// The configuration for an OTP slot.
#[derive(Debug)]
pub struct OtpSlotData {
/// The number of the slot – must be less than three for HOTP and less than 15 for TOTP.
pub number: u8,
/// The name of the slot – must not be empty.
pub name: String,
/// The secret for the slot.
pub secret: String,
/// The OTP generation mode.
pub mode: OtpMode,
/// If true, press the enter key after sending an OTP code using double-pressed
/// numlock, capslock or scrolllock.
pub use_enter: bool,
/// Set the token ID, see [OATH Token Identifier Specification][tokspec], section “Class A”.
///
/// [tokspec]: https://openauthentication.org/token-specs/
pub token_id: Option<String>,
}
#[derive(Debug)]
pub struct RawOtpSlotData {
pub number: u8,
pub name: CString,
pub secret: CString,
pub mode: OtpMode,
pub use_enter: bool,
pub use_token_id: bool,
pub token_id: CString,
}
impl OtpSlotData {
/// Constructs a new instance of this struct.
pub fn new<S: Into<String>, T: Into<String>>(
number: u8,
name: S,
secret: T,
mode: OtpMode,
) -> OtpSlotData {
OtpSlotData {
number,
name: name.into(),
secret: secret.into(),
mode,
use_enter: false,
token_id: None,
}
}
/// Enables pressing the enter key after sending an OTP code using double-pressed numlock,
/// capslock or scrollock.
pub fn use_enter(mut self) -> OtpSlotData {
self.use_enter = true;
self
}
/// Sets the token ID, see [OATH Token Identifier Specification][tokspec], section “Class A”.
///
/// [tokspec]: https://openauthentication.org/token-specs/
pub fn token_id<S: Into<String>>(mut self, id: S) -> OtpSlotData {
self.token_id = Some(id.into());
self
}
}
impl RawOtpSlotData {
pub fn new(data: OtpSlotData) -> Result<RawOtpSlotData, CommandError> {
let name = get_cstring(data.name)?;
let secret = get_cstring(data.secret)?;
let use_token_id = data.token_id.is_some();
let token_id = get_cstring(data.token_id.unwrap_or_else(String::new))?;
Ok(RawOtpSlotData {
number: data.number,
name,
secret,
mode: data.mode,
use_enter: data.use_enter,
use_token_id,
token_id,
})
}
}