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
|
// main.rs
// *************************************************************************
// * Copyright (C) 2017 Daniel Mueller (deso@posteo.net) *
// * *
// * This program is free software: you can redistribute it and/or modify *
// * it under the terms of the GNU General Public License as published by *
// * the Free Software Foundation, either version 3 of the License, or *
// * (at your option) any later version. *
// * *
// * This program is distributed in the hope that it will be useful, *
// * but WITHOUT ANY WARRANTY; without even the implied warranty of *
// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
// * GNU General Public License for more details. *
// * *
// * You should have received a copy of the GNU General Public License *
// * along with this program. If not, see <http://www.gnu.org/licenses/>. *
// *************************************************************************
#![deny(missing_docs)]
//! Nitrocli is a program providing a command line interface to certain
//! commands of the Nitrokey Storage device.
extern crate hid as libhid;
mod crc32;
mod error;
mod nitrokey;
mod pinentry;
use error::Error;
use std::process;
use std::result;
use std::thread;
use std::time;
type Result<T> = result::Result<T, Error>;
type NitroFunc = Fn(&mut libhid::Handle) -> Result<()>;
const SEND_RECV_DELAY_MS: u64 = 200;
/// Send a HID feature report to the device represented by the given handle.
fn send<P>(handle: &mut libhid::Handle, report: &nitrokey::Report<P>) -> Result<()>
where P: AsRef<[u8]>,
{
handle.feature().send_to(0, report.as_ref())?;
return Ok(());
}
/// Receive a HID feature report from the device represented by the given handle.
fn receive<P>(handle: &mut libhid::Handle) -> Result<nitrokey::Report<P>>
where P: AsRef<[u8]> + Default,
{
let mut report = nitrokey::Report::<P>::new();
handle.feature().get_from(0, report.as_mut())?;
return Ok(report);
}
/// Find and open the nitrokey device and execute a function on it.
fn nitrokey_do(function: &NitroFunc) -> Result<()> {
let hid = libhid::init()?;
// The Manager::find method is plain stupid as it still returns an
// iterable. Using it does not help in more concise error handling.
for device in hid.devices() {
if device.vendor_id() == nitrokey::VID && device.product_id() == nitrokey::PID {
return function(&mut device.open()?);
}
}
return Err(Error::Error("Nitrokey device not found".to_string()));
}
/// Open the encrypted volume on the nitrokey.
fn open() -> Result<()> {
return nitrokey_do(&|handle| {
let passphrase = pinentry::inquire_passphrase()?;
let payload = nitrokey::EnableEncryptedVolumeCommand::new(&passphrase);
let report = nitrokey::Report::from(payload);
send(handle, &report)?;
// We need to give the stick some time to handle the command. If we
// don't, we might just receive stale data from before.
thread::sleep(time::Duration::from_millis(SEND_RECV_DELAY_MS));
receive::<nitrokey::EmptyPayload>(handle)?;
return Ok(());
});
}
/// Close the previously opened encrypted volume.
fn close() -> Result<()> {
return nitrokey_do(&|handle| {
let payload = nitrokey::DisableEncryptedVolumeCommand::new();
let report = nitrokey::Report::from(payload);
send(handle, &report)?;
return Ok(());
});
}
// A macro for generating a match of the different supported commands.
// Each supplied command is converted into a string and matched against.
macro_rules! commands {
( $str:expr, [ $( $command:expr), *] ) => {
match &*$str.to_string() {
$(
stringify!($command) => {
if let Err(err) = $command() {
println!("{}", err);
return 1
}
return 0
},
)*
x => {
println!("Invalid command: {}", x);
println!("Available commands: {}", stringify!( $($command)* ));
return 1
},
}
}
}
fn run() -> i32 {
let argv: Vec<String> = std::env::args().collect();
if argv.len() != 2 {
println!("Usage: {} <command>", argv[0]);
return 1;
}
commands!(&argv[1], [open, close]);
}
fn main() {
process::exit(run());
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn wrong_crc() {
nitrokey_do(&|handle| {
let payload = nitrokey::DeviceStatusCommand::new();
let mut report = nitrokey::Report::from(payload);
// We want to verify that we get the correct result (i.e., a
// report of the CRC mismatch) repeatedly.
for _ in 0..10 {
report.crc += 1;
send(handle, &report).unwrap();
thread::sleep(time::Duration::from_millis(SEND_RECV_DELAY_MS));
let new_report = receive::<nitrokey::EmptyPayload>(handle).unwrap();
assert!(new_report.is_valid());
let response: &nitrokey::Response<nitrokey::DeviceStatusResponse> = new_report.data
.as_ref();
assert_eq!(response.command, nitrokey::Command::GetDeviceStatus);
assert_eq!(response.command_crc, report.crc);
assert_eq!(response.command_status, nitrokey::CommandStatus::WrongCrc);
}
return Ok(());
})
.unwrap();
}
#[test]
fn device_status() {
nitrokey_do(&|handle| {
let payload = nitrokey::DeviceStatusCommand::new();
let report = nitrokey::Report::from(payload);
send(handle, &report).unwrap();
thread::sleep(time::Duration::from_millis(SEND_RECV_DELAY_MS));
let new_report = receive::<nitrokey::EmptyPayload>(handle).unwrap();
assert!(new_report.is_valid());
let response: &nitrokey::Response<nitrokey::DeviceStatusResponse> = new_report.data.as_ref();
assert!(response.device_status == nitrokey::StorageStatus::Idle ||
response.device_status == nitrokey::StorageStatus::Okay);
assert_eq!(response.data.magic, nitrokey::MAGIC_NUMBER_STICK20_CONFIG);
return Ok(());
})
.unwrap();
}
}
|
