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
use libusb;
use std::{
fmt::{self, Debug},
process::exit,
slice::Iter,
str::FromStr,
time::Duration,
vec::IntoIter,
};
use super::{UsbConnection, UsbTimeout};
use super::{
YUBICO_VENDOR_ID, YUBIHSM2_BULK_IN_ENDPOINT, YUBIHSM2_INTERFACE_NUM, YUBIHSM2_PRODUCT_ID,
};
use crate::command::MAX_MSG_SIZE;
use crate::connector::{
ConnectionError,
ConnectionErrorKind::{DeviceBusyError, UsbError},
};
use crate::serial_number::SerialNumber;
lazy_static! {
static ref GLOBAL_USB_CONTEXT: libusb::Context = libusb::Context::new().unwrap_or_else(|e| {
eprintln!("*** ERROR: yubihsm-rs USB context init failed: {}", e);
exit(1);
});
}
pub struct Devices(Vec<Device>);
impl Devices {
pub fn serial_numbers() -> Result<Vec<SerialNumber>, ConnectionError> {
let devices = Self::detect(UsbTimeout::default())?;
let serials: Vec<_> = devices.iter().map(|a| a.serial_number).collect();
Ok(serials)
}
pub fn open(
serial_number: Option<SerialNumber>,
timeout: UsbTimeout,
) -> Result<UsbConnection, ConnectionError> {
let mut devices = Self::detect(timeout)?;
if let Some(sn) = serial_number {
while let Some(device) = devices.0.pop() {
if device.serial_number == sn {
return device.open(timeout);
}
}
fail!(
UsbError,
"no YubiHSM2 found with serial number: {:?}",
serial_number
)
} else {
match devices.0.len() {
1 => devices.0.remove(0).open(timeout),
0 => fail!(UsbError, "no YubiHSM2 devices detected"),
_ => fail!(
UsbError,
"expected a single YubiHSM2 device to be connected, found {}: {}",
devices.0.len(),
devices
.0
.iter()
.map(|d| d.serial_number.as_str().to_owned())
.collect::<Vec<_>>()
.join(", ")
),
}
}
}
pub fn detect(timeout: UsbTimeout) -> Result<Self, ConnectionError> {
let device_list = GLOBAL_USB_CONTEXT.devices()?;
let mut devices = vec![];
debug!("USB: enumerating devices...");
for device in device_list.iter() {
let desc = device.device_descriptor()?;
if desc.vendor_id() != YUBICO_VENDOR_ID || desc.product_id() != YUBIHSM2_PRODUCT_ID {
continue;
}
usb_debug!(device, "found YubiHSM device");
let mut handle = device
.open()
.map_err(|e| usb_err!(device, "error opening device: {}", e))?;
handle.reset().map_err(|error| match error {
libusb::Error::NoDevice => err!(
DeviceBusyError,
"USB(bus={},addr={}): couldn't reset device (already in use or disconnected)",
device.bus_number(),
device.address()
),
other => usb_err!(device, "error resetting device: {}", other),
})?;
let language = *handle
.read_languages(timeout.duration())?
.first()
.ok_or_else(|| {
usb_err!(
device,
"couldn't read YubiHSM serial number (missing language info)"
)
})?;
let t = timeout.duration();
let manufacturer = handle.read_manufacturer_string(language, &desc, t)?;
let product = handle.read_product_string(language, &desc, t)?;
let serial_number = handle.read_serial_number_string(language, &desc, t)?;
let product_name = format!("{} {}", manufacturer, product);
debug!(
"USB(bus={},addr={}): found {} (serial #{})",
device.bus_number(),
device.address(),
&product_name,
serial_number.as_str(),
);
devices.push(Device::new(
device,
product_name,
SerialNumber::from_str(&serial_number)?,
));
}
if devices.is_empty() {
debug!("no YubiHSM 2 devices found");
}
Ok(Devices(devices))
}
pub fn len(&self) -> usize {
self.0.len()
}
pub fn is_empty(&self) -> bool {
self.0.is_empty()
}
pub fn as_slice(&self) -> &[Device] {
self.0.as_slice()
}
pub fn iter(&self) -> Iter<Device> {
self.0.iter()
}
}
impl IntoIterator for Devices {
type Item = Device;
type IntoIter = IntoIter<Device>;
fn into_iter(self) -> Self::IntoIter {
self.0.into_iter()
}
}
pub struct Device {
pub(super) device: libusb::Device<'static>,
pub product_name: String,
pub serial_number: SerialNumber,
}
impl Device {
pub(super) fn new(
device: libusb::Device<'static>,
product_name: String,
serial_number: SerialNumber,
) -> Self {
Self {
serial_number,
product_name,
device,
}
}
pub fn open(self, timeout: UsbTimeout) -> Result<UsbConnection, ConnectionError> {
let connection = UsbConnection::create(self, timeout)?;
debug!(
"USB(bus={},addr={}): successfully opened {} (serial #{})",
connection.device().bus_number(),
connection.device().address(),
connection.device().product_name.as_str(),
connection.device().serial_number.as_str(),
);
Ok(connection)
}
pub fn bus_number(&self) -> u8 {
self.device.bus_number()
}
pub fn address(&self) -> u8 {
self.device.address()
}
pub(super) fn open_handle(&self) -> Result<libusb::DeviceHandle<'static>, ConnectionError> {
let mut handle = self.device.open()?;
handle.reset()?;
handle.claim_interface(YUBIHSM2_INTERFACE_NUM)?;
flush(&mut handle)?;
Ok(handle)
}
}
impl Debug for Device {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"yubihsm::usb::Device(bus={} addr={} serial=#{})",
self.bus_number(),
self.address(),
self.serial_number,
)
}
}
fn flush(handle: &mut libusb::DeviceHandle) -> Result<(), ConnectionError> {
let mut buffer = [0u8; MAX_MSG_SIZE];
let timeout = Duration::from_millis(1);
match handle.read_bulk(YUBIHSM2_BULK_IN_ENDPOINT, &mut buffer, timeout) {
Ok(_) | Err(libusb::Error::Timeout) => Ok(()),
Err(e) => Err(e.into()),
}
}