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
|
// args.rs
// Copyright (C) 2020 The Nitrocli Developers
// SPDX-License-Identifier: GPL-3.0-or-later
use std::convert;
use std::ffi;
/// Provides access to a Nitrokey device
#[derive(Debug, structopt::StructOpt)]
#[structopt(name = "nitrocli")]
pub struct Args {
/// Increases the log level (can be supplied multiple times)
#[structopt(short, long, global = true, parse(from_occurrences))]
pub verbose: u8,
/// Selects the device model to connect to
#[structopt(short, long, global = true, possible_values = &DeviceModel::all_str())]
pub model: Option<DeviceModel>,
/// Sets the serial number of the device to connect to. Can be set
/// multiple times to allow multiple serial numbers
// TODO: Add short options (avoid collisions).
#[structopt(
long = "serial-number",
global = true,
multiple = true,
number_of_values = 1
)]
pub serial_numbers: Vec<nitrokey::SerialNumber>,
/// Sets the USB path of the device to connect to
#[structopt(long, global = true)]
pub usb_path: Option<String>,
/// Disables the cache for all secrets.
#[structopt(long, global = true)]
pub no_cache: bool,
#[structopt(subcommand)]
pub cmd: Command,
}
Enum! {
/// The available Nitrokey models.
DeviceModel, [
Librem => "librem",
Pro => "pro",
Storage => "storage",
]
}
impl From<DeviceModel> for nitrokey::Model {
fn from(model: DeviceModel) -> nitrokey::Model {
match model {
DeviceModel::Librem => nitrokey::Model::Librem,
DeviceModel::Pro => nitrokey::Model::Pro,
DeviceModel::Storage => nitrokey::Model::Storage,
}
}
}
impl convert::TryFrom<nitrokey::Model> for DeviceModel {
type Error = anyhow::Error;
fn try_from(model: nitrokey::Model) -> Result<DeviceModel, anyhow::Error> {
match model {
nitrokey::Model::Librem => Ok(DeviceModel::Librem),
nitrokey::Model::Pro => Ok(DeviceModel::Pro),
nitrokey::Model::Storage => Ok(DeviceModel::Storage),
_ => Err(anyhow::anyhow!("Unsupported device model: {}", model)),
}
}
}
impl<'de> serde::Deserialize<'de> for DeviceModel {
fn deserialize<D>(deserializer: D) -> Result<DeviceModel, D::Error>
where
D: serde::Deserializer<'de>,
{
use serde::de::Error as _;
use std::str::FromStr as _;
let s = String::deserialize(deserializer)?;
DeviceModel::from_str(&s).map_err(D::Error::custom)
}
}
Command! {
/// A top-level command for nitrocli.
Command, [
/// Reads or writes the device configuration
Config(ConfigArgs) => |ctx, args: ConfigArgs| args.subcmd.execute(ctx),
/// Interacts with the device's encrypted volume
Encrypted(EncryptedArgs) => |ctx, args: EncryptedArgs| args.subcmd.execute(ctx),
/// Fills the SD card with random data
Fill(FillArgs) => |ctx, args: FillArgs| crate::commands::fill(ctx, args.attach),
/// Interacts with the device's hidden volume
Hidden(HiddenArgs) => |ctx, args: HiddenArgs| args.subcmd.execute(ctx),
/// Lists the attached Nitrokey devices
List(ListArgs) => |ctx, args: ListArgs| crate::commands::list(ctx, args.no_connect),
/// Locks the connected Nitrokey device
Lock => crate::commands::lock,
/// Accesses one-time passwords
Otp(OtpArgs) => |ctx, args: OtpArgs| args.subcmd.execute(ctx),
/// Manages the Nitrokey PINs
Pin(PinArgs) => |ctx, args: PinArgs| args.subcmd.execute(ctx),
/// Accesses the password safe
Pws(PwsArgs) => |ctx, args: PwsArgs| args.subcmd.execute(ctx),
/// Performs a factory reset
Reset => crate::commands::reset,
/// Prints the status of the connected Nitrokey device
Status => crate::commands::status,
/// Interacts with the device's unencrypted volume
Unencrypted(UnencryptedArgs) => |ctx, args: UnencryptedArgs| args.subcmd.execute(ctx),
/// An extension and its arguments.
#[structopt(external_subcommand)]
Extension(Vec<ffi::OsString>) => crate::commands::extension,
]
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct ConfigArgs {
#[structopt(subcommand)]
subcmd: ConfigCommand,
}
Command! {ConfigCommand, [
/// Prints the Nitrokey configuration
Get => crate::commands::config_get,
/// Changes the Nitrokey configuration
Set(ConfigSetArgs) => crate::commands::config_set,
]}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct ConfigSetArgs {
/// Sets the Num Lock option to the given HOTP slot
#[structopt(short = "n", long)]
pub num_lock: Option<u8>,
/// Unsets the Num Lock option
#[structopt(short = "N", long, conflicts_with("num-lock"))]
pub no_num_lock: bool,
/// Sets the Cap Lock option to the given HOTP slot
#[structopt(short = "c", long)]
pub caps_lock: Option<u8>,
/// Unsets the Caps Lock option
#[structopt(short = "C", long, conflicts_with("caps-lock"))]
pub no_caps_lock: bool,
/// Sets the Scroll Lock option to the given HOTP slot
#[structopt(short = "s", long)]
pub scroll_lock: Option<u8>,
/// Unsets the Scroll Lock option
#[structopt(short = "S", long, conflicts_with("scroll-lock"))]
pub no_scroll_lock: bool,
/// Requires the user PIN to generate one-time passwords
#[structopt(short = "o", long)]
pub otp_pin: bool,
/// Allows one-time password generation without PIN
#[structopt(short = "O", long, conflicts_with("otp-pin"))]
pub no_otp_pin: bool,
}
#[derive(Clone, Copy, Debug)]
pub enum ConfigOption<T> {
Enable(T),
Disable,
Ignore,
}
impl<T> ConfigOption<T> {
pub fn try_from(disable: bool, value: Option<T>, name: &'static str) -> anyhow::Result<Self> {
if disable {
anyhow::ensure!(
value.is_none(),
"--{name} and --no-{name} are mutually exclusive",
name = name
);
Ok(ConfigOption::Disable)
} else {
match value {
Some(value) => Ok(ConfigOption::Enable(value)),
None => Ok(ConfigOption::Ignore),
}
}
}
pub fn or(self, default: Option<T>) -> Option<T> {
match self {
ConfigOption::Enable(value) => Some(value),
ConfigOption::Disable => None,
ConfigOption::Ignore => default,
}
}
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct EncryptedArgs {
#[structopt(subcommand)]
subcmd: EncryptedCommand,
}
Command! {EncryptedCommand, [
/// Closes the encrypted volume on a Nitrokey Storage
Close => crate::commands::encrypted_close,
/// Opens the encrypted volume on a Nitrokey Storage
Open => crate::commands::encrypted_open,
]}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct FillArgs {
/// Checks if a fill operation is already running and show its progress instead of starting a new
/// operation.
#[structopt(short, long)]
attach: bool,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct HiddenArgs {
#[structopt(subcommand)]
subcmd: HiddenCommand,
}
Command! {HiddenCommand, [
/// Closes the hidden volume on a Nitrokey Storage
Close => crate::commands::hidden_close,
/// Creates a hidden volume on a Nitrokey Storage
Create(HiddenCreateArgs) => |ctx, args: HiddenCreateArgs| {
crate::commands::hidden_create(ctx, args.slot, args.start, args.end)
},
/// Opens the hidden volume on a Nitrokey Storage
Open => crate::commands::hidden_open,
]}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct HiddenCreateArgs {
/// The hidden volume slot to use
pub slot: u8,
/// The start location of the hidden volume as a percentage of the encrypted volume's size (0-99)
pub start: u8,
/// The end location of the hidden volume as a percentage of the encrypted volume's size (1-100)
pub end: u8,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct ListArgs {
/// Only print the information that is available without connecting to a device
#[structopt(short, long)]
pub no_connect: bool,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct OtpArgs {
#[structopt(subcommand)]
subcmd: OtpCommand,
}
Command! {OtpCommand, [
/// Clears a one-time password slot
Clear(OtpClearArgs) => |ctx, args: OtpClearArgs| {
crate::commands::otp_clear(ctx, args.slot, args.algorithm)
},
/// Generates a one-time password
Get(OtpGetArgs) => |ctx, args: OtpGetArgs| {
crate::commands::otp_get(ctx, args.slot, args.algorithm, args.time)
},
/// Configures a one-time password slot
Set(OtpSetArgs) => crate::commands::otp_set,
/// Prints the status of the one-time password slots
Status(OtpStatusArgs) => |ctx, args: OtpStatusArgs| crate::commands::otp_status(ctx, args.all),
]}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct OtpClearArgs {
/// The OTP algorithm to use
#[structopt(short, long, default_value = OtpAlgorithm::Totp.as_ref(),
possible_values = &OtpAlgorithm::all_str())]
pub algorithm: OtpAlgorithm,
/// The OTP slot to clear
pub slot: u8,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct OtpGetArgs {
/// The OTP algorithm to use
#[structopt(short, long, default_value = OtpAlgorithm::Totp.as_ref(),
possible_values = &OtpAlgorithm::all_str())]
pub algorithm: OtpAlgorithm,
/// The time to use for TOTP generation (Unix timestamp) [default: system time]
#[structopt(short, long)]
pub time: Option<u64>,
/// The OTP slot to use
pub slot: u8,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct OtpSetArgs {
/// The OTP algorithm to use
#[structopt(short, long, default_value = OtpAlgorithm::Totp.as_ref(),
possible_values = &OtpAlgorithm::all_str())]
pub algorithm: OtpAlgorithm,
/// The number of digits to use for the one-time password
#[structopt(short, long, default_value = OtpMode::SixDigits.as_ref(),
possible_values = &OtpMode::all_str())]
pub digits: OtpMode,
/// The counter value for HOTP
#[structopt(short, long, default_value = "0")]
pub counter: u64,
/// The time window for TOTP
#[structopt(short, long, default_value = "30")]
pub time_window: u16,
/// The format of the secret
#[structopt(short, long, default_value = OtpSecretFormat::Base32.as_ref(),
possible_values = &OtpSecretFormat::all_str())]
pub format: OtpSecretFormat,
/// The OTP slot to use
pub slot: u8,
/// The name of the slot
pub name: String,
/// The secret to store on the slot as a hexadecimal string (or in the format set with the
/// --format option)
pub secret: String,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct OtpStatusArgs {
/// Shows slots that are not programmed
#[structopt(short, long)]
pub all: bool,
}
Enum! {OtpAlgorithm, [
Hotp => "hotp",
Totp => "totp",
]}
Enum! {OtpMode, [
SixDigits => "6",
EightDigits => "8",
]}
impl From<OtpMode> for nitrokey::OtpMode {
fn from(mode: OtpMode) -> Self {
match mode {
OtpMode::SixDigits => nitrokey::OtpMode::SixDigits,
OtpMode::EightDigits => nitrokey::OtpMode::EightDigits,
}
}
}
Enum! {OtpSecretFormat, [
Ascii => "ascii",
Base32 => "base32",
Hex => "hex",
]}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct PinArgs {
#[structopt(subcommand)]
subcmd: PinCommand,
}
Command! {PinCommand, [
/// Clears the cached PINs
Clear => crate::commands::pin_clear,
/// Changes a PIN
Set(PinSetArgs) => |ctx, args: PinSetArgs| crate::commands::pin_set(ctx, args.pintype),
/// Unblocks and resets the user PIN
Unblock => crate::commands::pin_unblock,
]}
Enum! {
/// PIN type requested from pinentry.
///
/// The available PIN types correspond to the PIN types used by the
/// Nitrokey devices: user and admin.
PinType, [
Admin => "admin",
User => "user",
]
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct PinSetArgs {
/// The PIN type to change
#[structopt(name = "type", possible_values = &PinType::all_str())]
pub pintype: PinType,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct PwsArgs {
#[structopt(subcommand)]
subcmd: PwsCommand,
}
Command! {PwsCommand, [
/// Clears a password safe slot
Clear(PwsClearArgs) => |ctx, args: PwsClearArgs| crate::commands::pws_clear(ctx, args.slot),
/// Reads a password safe slot
Get(PwsGetArgs) => |ctx, args: PwsGetArgs| {
crate::commands::pws_get(ctx, args.slot, args.name, args.login, args.password, args.quiet)
},
/// Writes a password safe slot
Set(PwsSetArgs) => |ctx, args: PwsSetArgs| {
crate::commands::pws_set(ctx, args.slot, &args.name, &args.login, &args.password)
},
/// Prints the status of the password safe slots
Status(PwsStatusArgs) => |ctx, args: PwsStatusArgs| crate::commands::pws_status(ctx, args.all),
]}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct PwsClearArgs {
/// The PWS slot to clear
pub slot: u8,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct PwsGetArgs {
/// Shows the name stored on the slot
#[structopt(short, long)]
pub name: bool,
/// Shows the login stored on the slot
#[structopt(short, long)]
pub login: bool,
/// Shows the password stored on the slot
#[structopt(short, long)]
pub password: bool,
/// Prints the stored data without description
#[structopt(short, long)]
pub quiet: bool,
/// The PWS slot to read
pub slot: u8,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct PwsSetArgs {
/// The PWS slot to write
pub slot: u8,
/// The name to store on the slot
pub name: String,
/// The login to store on the slot
pub login: String,
/// The password to store on the slot
pub password: String,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct PwsStatusArgs {
/// Shows slots that are not programmed
#[structopt(short, long)]
pub all: bool,
}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct UnencryptedArgs {
#[structopt(subcommand)]
subcmd: UnencryptedCommand,
}
Command! {UnencryptedCommand, [
/// Changes the configuration of the unencrypted volume on a Nitrokey Storage
Set(UnencryptedSetArgs) => |ctx, args: UnencryptedSetArgs| {
crate::commands::unencrypted_set(ctx, args.mode)
},
]}
#[derive(Debug, PartialEq, structopt::StructOpt)]
pub struct UnencryptedSetArgs {
/// The mode to change to
#[structopt(name = "type", possible_values = &UnencryptedVolumeMode::all_str())]
pub mode: UnencryptedVolumeMode,
}
Enum! {UnencryptedVolumeMode, [
ReadWrite => "read-write",
ReadOnly => "read-only",
]}
|