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
#![warn(
missing_copy_implementations,
missing_debug_implementations,
missing_docs,
non_ascii_idents,
trivial_casts,
unused,
unused_qualifications
)]
#![deny(unsafe_code)]
pub mod error;
mod buffer;
mod hid;
pub use ctaphid_types as types;
pub use hid::{Device as HidDevice, DeviceInfo as HidDeviceInfo};
use std::{convert::TryFrom, fmt, time::Duration};
use ctaphid_types::{
Capabilities, Channel, Command, DeviceVersion, InitResponse, Message, ParseError, VendorCommand,
};
use rand_core::{OsRng, RngCore};
use tap::TapFallible;
use error::{CommandError, Error, RequestError, ResponseError};
pub struct Device<D: HidDevice> {
device: D,
device_info: D::Info,
channel: Channel,
protocol_version: u8,
device_version: DeviceVersion,
capabilities: Capabilities,
buffer: buffer::MessageBuffer,
timeout: Option<Duration>,
}
impl<D: HidDevice> Device<D> {
pub fn new(device: D, device_info: D::Info) -> Result<Self, Error> {
Self::with_options(device, device_info, Default::default())
}
pub fn with_options(device: D, device_info: D::Info, options: Options) -> Result<Self, Error> {
log::info!("Opening CTAPHID device on path {}", device_info.path());
let buffer = buffer::MessageBuffer::new(device_info.packet_size());
let mut device = Self {
device,
device_info,
channel: Channel::BROADCAST,
protocol_version: Default::default(),
device_version: Default::default(),
capabilities: Default::default(),
buffer,
timeout: options.timeout,
};
let response = device.init(options.nonce)?;
device.channel = response.channel;
device.protocol_version = response.protocol_version;
device.device_version = response.device_version;
device.capabilities = response.capabilities;
Ok(device)
}
pub fn ping(&self, data: &[u8]) -> Result<(), Error> {
log::info!(
"{}: Executing ping with data {}",
self.info().path(),
hex::encode(data)
);
let response = self.transaction(Command::Ping, data)?;
if data == response {
Ok(())
} else {
log::warn!(
"{}: Received unexpected response for ping: {}",
self.info().path(),
hex::encode(&response)
);
Err(Error::from(CommandError::InvalidPingData))
}
}
pub fn wink(&self) -> Result<(), Error> {
log::info!("{}: Executing wink", self.info().path());
if !self.capabilities.has_wink() {
log::warn!(
"{}: Wink support not announced in capabilities, aborting",
self.info().path()
);
return Err(CommandError::NotSupported(Command::Wink).into());
}
let response = self.transaction(Command::Wink, &[])?;
if response.is_empty() {
Ok(())
} else {
log::warn!(
"{}: Received unexpected response for wink: {}",
self.info().path(),
hex::encode(&response)
);
Err(ResponseError::UnexpectedResponseData(response).into())
}
}
pub fn ctap1(&self, data: &[u8]) -> Result<Vec<u8>, Error> {
log::info!("{}: Executing msg command", self.info().path());
log::debug!(
"{}: CTAP1 request:\n{}",
self.info().path(),
hex::encode(&data)
);
if !self.capabilities.has_msg() {
log::warn!(
"{}: Message support not announced in capabilities, aborting",
self.info().path()
);
return Err(CommandError::NotSupported(Command::Message).into());
}
self.transaction(Command::Message, data).tap_ok(|data| {
log::debug!(
"{}: CTAP1 response:\n{}",
self.info().path(),
hex::encode(&data)
)
})
}
pub fn ctap2(&self, command: u8, data: &[u8]) -> Result<Vec<u8>, Error> {
log::info!("{}: Executing cbor command", self.info().path());
log::debug!(
"{}: CTAP2 request:\n{}",
self.info().path(),
hex::encode(&data)
);
if !self.capabilities.has_cbor() {
log::warn!(
"{}: Message support not announced in capabilities, aborting",
self.info().path()
);
return Err(CommandError::NotSupported(Command::Cbor).into());
}
let data = &[&[command], data].concat();
let response = self.transaction(Command::Cbor, data)?;
if response.is_empty() {
log::warn!("{}: Received empty cbor response", self.info().path());
Err(ResponseError::PacketParsingFailed(ParseError::NotEnoughData).into())
} else if response[0] != 0 {
log::warn!(
"{}: Received cbor error code {:#x}",
self.info().path(),
response[0]
);
Err(CommandError::CborError(response[0]).into())
} else {
log::debug!(
"{}: CTAP2 response:\n{}",
self.info().path(),
hex::encode(&response[1..])
);
Ok(response[1..].to_owned())
}
}
pub fn lock(&self, duration: Duration) -> Result<(), Error> {
log::info!("{}: Executing lock command", self.info().path());
let mut duration = u8::try_from(duration.as_secs()).unwrap_or(u8::MAX);
if duration > 10 {
duration = 10;
}
let response = self.transaction(Command::Lock, &[duration])?;
if response.is_empty() {
Ok(())
} else {
log::warn!(
"{}: Received unexpected response for lock: {}",
self.info().path(),
hex::encode(&response)
);
Err(ResponseError::UnexpectedResponseData(response).into())
}
}
pub fn vendor_command(&self, command: VendorCommand, data: &[u8]) -> Result<Vec<u8>, Error> {
log::info!(
"{}: Executing vendor command {command:x?}",
self.info().path()
);
self.transaction(Command::Vendor(command), data)
}
fn init(&self, nonce: [u8; 8]) -> Result<InitResponse<Vec<u8>>, Error> {
log::info!(
"{}: Executing init command with nonce {}",
self.info().path(),
hex::encode(&nonce)
);
self.send_message(Command::Init, &nonce)?;
loop {
let response = self.receive_message(Command::Init)?;
let response = InitResponse::try_from(response.as_slice())
.map_err(ResponseError::PacketParsingFailed)?;
if nonce == response.nonce {
log::debug!(
"{}: Received init response\n{response:?}",
self.info().path()
);
return Ok(response);
}
log::warn!(
"{}: Received init response with wrong nonce",
self.info().path()
);
}
}
fn transaction(&self, command: Command, data: &[u8]) -> Result<Vec<u8>, Error> {
self.send_message(command, data)?;
let response = self.receive_message(command)?;
Ok(response)
}
fn send_message(&self, command: Command, data: &[u8]) -> Result<(), RequestError> {
let message = Message {
channel: self.channel,
command,
data,
};
self.buffer
.send_message(&self.device, message)
.tap_err(|err| log::warn!("{}: Failed to send message: {}", self.info().path(), err))
}
fn receive_message(&self, command: Command) -> Result<Vec<u8>, ResponseError> {
self.buffer
.receive_message(&self.device, self.channel, command, self.timeout)
.map(|message| message.data)
.tap_err(|err| log::warn!("{}: Failed to receive message: {}", self.info().path(), err))
}
pub fn info(&self) -> &D::Info {
&self.device_info
}
pub fn protocol_version(&self) -> u8 {
self.protocol_version
}
pub fn device_version(&self) -> DeviceVersion {
self.device_version
}
pub fn capabilities(&self) -> Capabilities {
self.capabilities
}
}
impl<D: HidDevice> fmt::Debug for Device<D> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Device")
.field("device_info", &self.device_info)
.field("channel", &self.channel)
.field("protocol_version", &self.protocol_version)
.field("device_version", &self.device_version)
.field("capabilities", &self.capabilities)
.finish()
}
}
#[derive(Clone, Debug)]
#[non_exhaustive]
#[allow(missing_copy_implementations)]
pub struct Options {
pub nonce: [u8; 8],
pub timeout: Option<Duration>,
}
impl Options {
pub fn new() -> Self {
Self::default()
}
pub fn with_rng(rng: &mut dyn RngCore) -> Self {
let mut nonce = [0; 8];
rng.fill_bytes(&mut nonce);
Self {
nonce,
timeout: Some(Duration::from_secs(1)),
}
}
}
impl Default for Options {
fn default() -> Self {
Self::with_rng(&mut OsRng)
}
}
pub fn is_known_device<D: HidDeviceInfo>(device: &D) -> bool {
matches!(
(device.vendor_id(), device.product_id()),
(0x1209, 0xbeee) |
(0x20a0, 0x42b1) |
(0x20a0, 0x42b2)
)
}