Compare commits

...

7 Commits

Author SHA1 Message Date
718c9c93e6
fix: tolerate newer versions 2021-07-24 14:31:20 +02:00
3a6dd90ec4
expose needs_pin 2020-10-18 20:10:54 +02:00
f5d52ee8b5
parse error codes at compile time 2020-09-05 23:14:54 +02:00
e6166f7cbd
bump version 2020-04-26 18:48:37 +02:00
d6b20d0ba4
provide username 2020-04-24 18:52:55 +02:00
857c3cd955
handle map keys in text form 2020-04-24 18:46:05 +02:00
80c175077f
fix timeout = None causing an instant timeout err 2020-04-05 22:42:29 +02:00
8 changed files with 152 additions and 79 deletions

View File

@ -1,7 +1,7 @@
[package] [package]
name = "ctap_hmac" name = "ctap_hmac"
description = "A Rust implementation of the FIDO2 CTAP protocol, including the HMAC extension" description = "A Rust implementation of the FIDO2 CTAP protocol, including the HMAC extension"
version = "0.4.0" version = "0.4.5"
license = "Apache-2.0/MIT" license = "Apache-2.0/MIT"
homepage = "https://github.com/shimunn/ctap" homepage = "https://github.com/shimunn/ctap"
repository = "https://github.com/shimunn/ctap" repository = "https://github.com/shimunn/ctap"
@ -20,12 +20,16 @@ cbor-codec = "0.7"
ring = "0.13" ring = "0.13"
untrusted = "0.6" untrusted = "0.6"
rust-crypto = "0.2" rust-crypto = "0.2"
csv-core = "0.1.6"
derive_builder = "0.9.0" derive_builder = "0.9.0"
crossbeam = { version = "0.7.3", optional = true } crossbeam = { version = "0.7.3", optional = true }
[dev-dependencies] [dev-dependencies]
crossbeam = "0.7.3" crossbeam = "0.7.3"
hex = "0.4.0" hex = "0.4.0"
[build-dependencies]
csv = "1.1.3"
serde = "1.0.106"
serde_derive = "1.0.106"
[features] [features]
request_multiple = ["crossbeam"] request_multiple = ["crossbeam"]

41
build.rs Normal file
View File

@ -0,0 +1,41 @@
use csv::{Reader, StringRecord};
use serde_derive::Deserialize;
use std::env;
use std::fs::File;
use std::io::{Result, Write};
use std::iter::FromIterator;
use std::string::String;
fn main() {
parse_error_codes().expect("Failed to parse error codes")
}
fn parse_error_codes() -> Result<()> {
println!("cargo:rerun-if-changed=ctap_error_codes.csv");
let mut out_file = File::create(format!(
"{}/ctap_error_codes.rs",
env::var("OUT_DIR").unwrap()
))?;
out_file.write_all(b"static CTAP_ERROR_CODES: &[(usize, &str, &str)] = &[")?;
let mut rdr = Reader::from_path("ctap_error_codes.csv")?;
rdr.set_headers(StringRecord::from_iter(&["code", "name", "desc"]));
#[derive(Debug, Deserialize)]
struct ErrorCode {
code: String,
name: String,
desc: String,
}
for result in rdr.deserialize() {
let record: ErrorCode = result.unwrap();
out_file.write_all(
format!(
"({}, \"{}\", \"{}\"),\n",
i64::from_str_radix(&record.code[2..], 16).unwrap(),
record.name,
record.desc
)
.as_bytes(),
)?;
}
out_file.write_all(b"];")
}

View File

@ -24,6 +24,7 @@ fn main() -> ctap::FidoResult<()> {
FidoDevice::new(&h).and_then(|mut dev| { FidoDevice::new(&h).and_then(|mut dev| {
FidoCredentialRequestBuilder::default() FidoCredentialRequestBuilder::default()
.rp_id(RP_ID) .rp_id(RP_ID)
.user_name("test")
.build() .build()
.unwrap() .unwrap()
.make_credential(&mut dev) .make_credential(&mut dev)

View File

@ -7,6 +7,7 @@
use cbor_codec::value; use cbor_codec::value;
use cbor_codec::value::Value; use cbor_codec::value::Value;
use cbor_codec::{Config, Decoder, Encoder, GenericDecoder, GenericEncoder}; use cbor_codec::{Config, Decoder, Encoder, GenericDecoder, GenericEncoder};
use cbor::skip::Skip;
use byteorder::{BigEndian, ByteOrder, ReadBytesExt, WriteBytesExt}; use byteorder::{BigEndian, ByteOrder, ReadBytesExt, WriteBytesExt};
use failure::ResultExt; use failure::ResultExt;
@ -38,7 +39,7 @@ impl<'a> Request<'a> {
} }
} }
pub fn decode<R: ReadBytesExt>(&self, reader: R) -> FidoResult<Response> { pub fn decode<R: ReadBytesExt + Skip>(&self, reader: R) -> FidoResult<Response> {
Ok(match self { Ok(match self {
Request::MakeCredential(_) => { Request::MakeCredential(_) => {
Response::MakeCredential(MakeCredentialResponse::decode(reader)?) Response::MakeCredential(MakeCredentialResponse::decode(reader)?)
@ -277,7 +278,7 @@ pub struct GetInfoResponse {
} }
impl GetInfoResponse { impl GetInfoResponse {
pub fn decode<R: ReadBytesExt>(mut reader: R) -> FidoResult<Self> { pub fn decode<R: ReadBytesExt + Skip>(mut reader: R) -> FidoResult<Self> {
let status = reader.read_u8().context(FidoErrorKind::CborDecode)?; let status = reader.read_u8().context(FidoErrorKind::CborDecode)?;
if status != 0 { if status != 0 {
Err(FidoErrorKind::CborError(CborErrorCode::from(status)))? Err(FidoErrorKind::CborError(CborErrorCode::from(status)))?
@ -304,7 +305,7 @@ impl GetInfoResponse {
response.pin_protocols.push(decoder.u8()?); response.pin_protocols.push(decoder.u8()?);
} }
} }
_ => continue, _ => decoder.skip()?,
} }
} }
Ok(response) Ok(response)
@ -597,14 +598,45 @@ impl CoseKey {
let mut cose_key = CoseKey::default(); let mut cose_key = CoseKey::default();
cose_key.algorithm = -7; cose_key.algorithm = -7;
for _ in 0..items { for _ in 0..items {
match generic.borrow_mut().i16()? { match generic.value()? {
0x01 => cose_key.key_type = generic.borrow_mut().u16()?, Value::Text(value::Text::Text(text)) => match &text[..] {
0x02 => cose_key.algorithm = generic.borrow_mut().i32()?, "type" => {
key if key < 0 => { cose_key.key_type = match generic.value()? {
cose_key.parameters.insert(key, generic.value()?); Value::Text(value::Text::Text(type_)) if &type_ == "public-key" => 0u16,
Value::U16(i) => i,
Value::U8(i) => i.into(),
_ => {
continue;
}
}
}
"alg" => cose_key.algorithm = generic.borrow_mut().i32()?,
_ => continue,
},
val @ Value::I8(_)
| val @ Value::I16(_)
| val @ Value::U16(_)
| val @ Value::U8(_) => {
let int_val = match val {
Value::I8(i) => i as i32,
Value::I16(i) => i as i32,
Value::U8(i) => i as i32,
Value::U16(i) => i as i32,
_ => unreachable!(),
};
match int_val {
0x01 => cose_key.key_type = generic.borrow_mut().u16()?,
0x02 => cose_key.algorithm = generic.borrow_mut().i32()?,
key if key < 0 => {
cose_key.parameters.insert(key as i16, generic.value()?);
}
unknown => {
(unknown, generic.value()?); // skip unknown parameter
}
}
} }
_ => { unknown => {
generic.value()?; // skip unknown parameter (unknown, generic.value()?); // skip unknown parameter
} }
} }
} }

View File

@ -5,8 +5,8 @@
// http://opensource.org/licenses/MIT>, at your option. This file may not be // http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms. // copied, modified, or distributed except according to those terms.
use cbor_codec::{DecodeError, EncodeError}; use cbor_codec::{DecodeError, EncodeError};
use csv_core::{ReadFieldResult, Reader};
use failure::_core::fmt::{Error, Formatter}; use failure::_core::fmt::{Error, Formatter};
use failure::_core::option::Option;
use failure::{Backtrace, Context, Fail}; use failure::{Backtrace, Context, Fail};
use std::fmt; use std::fmt;
use std::fmt::Display; use std::fmt::Display;
@ -19,6 +19,32 @@ pub struct FidoError(Context<FidoErrorKind>);
#[derive(Debug, Copy, Clone, Fail, Eq, PartialEq)] #[derive(Debug, Copy, Clone, Fail, Eq, PartialEq)]
pub struct CborErrorCode(u8); pub struct CborErrorCode(u8);
// generated using build.rs
include!(concat!(env!("OUT_DIR"), "/ctap_error_codes.rs"));
impl CborErrorCode {
fn detail(&self) -> Option<(u8, &'static str, &'static str)> {
for (code, name, desc) in CTAP_ERROR_CODES {
if *code == self.0 as usize {
return Some((self.0, name, desc));
}
}
None
}
pub fn name(&self) -> Option<&'static str> {
self.detail().map(|(_, name, _)| name)
}
pub fn description(&self) -> Option<&'static str> {
self.detail().map(|(_, _, desc)| desc)
}
pub fn code(&self) -> u8 {
self.0
}
}
#[derive(Copy, Clone, Eq, PartialEq, Debug, Fail)] #[derive(Copy, Clone, Eq, PartialEq, Debug, Fail)]
pub enum FidoErrorKind { pub enum FidoErrorKind {
#[fail(display = "Read/write error with device.")] #[fail(display = "Read/write error with device.")]
@ -116,58 +142,24 @@ impl From<u8> for CborErrorCode {
impl Display for CborErrorCode { impl Display for CborErrorCode {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> { fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
let messages = include_str!("ctap_error_codes.csv"); if let Some((code, _name, desc)) = self.detail() {
let mut rdr = Reader::new();
let mut bytes = messages.as_bytes();
let mut col: usize = 0;
let mut row: usize = 0;
let mut correct_row: bool = false;
let mut field = [0u8; 1024];
let mut name: Option<String> = None;
let mut desc: Option<String> = None;
loop {
let (result, nin, read) = rdr.read_field(&bytes, &mut field);
bytes = &bytes[nin..];
match result {
ReadFieldResult::InputEmpty => {}
ReadFieldResult::OutputFull => panic!("field too large"),
ReadFieldResult::Field { record_end } => {
let text = String::from_utf8(field[..read].iter().cloned().collect()).unwrap();
if row > 0 {
match col {
0 if i64::from_str_radix(&text[2..], 16)
.expect("malformed ctap_error_codes.csv")
== self.0 as i64 =>
{
correct_row = true
}
1 | 2 if correct_row => {
if let Some(_) = name {
desc = Some(text);
break;
} else {
name = Some(text);
}
}
_ => (),
}
}
col += 1;
if record_end {
col = 0;
row += 1;
}
}
ReadFieldResult::End => break,
}
}
if let Some((code, _name, desc)) =
name.and_then(|name| desc.map(|desc| (self.0, name, desc)))
{
write!(f, "CborError: 0x{:x?}: {}", code, desc)?; write!(f, "CborError: 0x{:x?}: {}", code, desc)?;
} else { } else {
write!(f, "CborError: 0x{:x?}", self.0)?; write!(f, "CborError: 0x{:x?}: unknown", self.code())?;
} }
Ok(()) Ok(())
} }
} }
#[cfg(test)]
mod test {
use super::*;
#[test]
fn cbor_error_code() {
assert_eq!(
CborErrorCode(0x33).to_string(),
"CborError: 0x33: PIN authentication, pinAuth, verification failed."
)
}
}

View File

@ -287,14 +287,14 @@ impl FidoDevice {
cbor::Response::GetInfo(resp) => resp, cbor::Response::GetInfo(resp) => resp,
_ => Err(FidoErrorKind::CborDecode)?, _ => Err(FidoErrorKind::CborDecode)?,
}; };
if !response.versions.iter().any(|ver| ver == "FIDO_2_0") { if !response.versions.iter().any(|ver| ["FIDO_2_0", "FIDO_2_1_PRE"].contains(&ver.as_str())) {
Err(FidoErrorKind::DeviceUnsupported)? Err(FidoErrorKind::DeviceUnsupported)?
} }
// Require pin protocol version 1, only if pin-protocol is supported at all // Require pin protocol version 1, only if pin-protocol is supported at all
if !response if !response
.pin_protocols .pin_protocols
.iter() .iter()
.fold(true, |supported, ver| *ver == 1 && supported) .any(|ver| *ver == 1) && response.pin_protocols.len() > 0
{ {
Err(FidoErrorKind::DeviceUnsupported)? Err(FidoErrorKind::DeviceUnsupported)?
} }
@ -325,6 +325,11 @@ impl FidoDevice {
} }
} }
/// True if this authenticator requires a PIN
pub fn needs_pin(&self) -> bool {
self.needs_pin
}
/// Unlock the device with the provided PIN. Internally this will generate /// Unlock the device with the provided PIN. Internally this will generate
/// an ECDH keypair, send the encrypted PIN to the device and store the PIN /// an ECDH keypair, send the encrypted PIN to the device and store the PIN
/// token that the device generates on every power cycle. The PIN itself is /// token that the device generates on every power cycle. The PIN itself is

View File

@ -33,25 +33,23 @@ pub fn request_multiple_devices<
let interval = Duration::from_millis(10); let interval = Duration::from_millis(10);
let mut received = 0usize; let mut received = 0usize;
let res = loop { let res = loop {
if timeout.map(|t| t < slept).unwrap_or(true) { match timeout {
break if let Some(cause) = err { Some(t) if t < slept => {
cause break if let Some(cause) = err {
} else { cause
Err(FidoErrorKind::Timeout.into()) } else {
}; Err(FidoErrorKind::Timeout.into())
} };
if received == handles.len() { }
break err.unwrap(); _ => (),
} }
if timeout.map(|t| t < slept).unwrap_or(true) {}
if let Ok(msg) = rx.recv_timeout(interval) { if let Ok(msg) = rx.recv_timeout(interval) {
received += 1; received += 1;
match msg { match msg {
e @ Err(_) => { e @ Err(_) if received == handles.len() => break e,
err = Some(e); e @ Err(_) => err = Some(e),
} res @ Ok(_) => break res,
res @ Ok(_) => {
break res;
}
} }
} else { } else {
slept += interval; slept += interval;