Move protocol-specific user presence checking code from Env to CTAP library (#501)

* Common duration type for ctap library independent of TockOS

* Implement Env-specific ctap-hid channels for I/O
Common I/O Status, Error and Result types

* Move common user presence checking code to ctap library

* Move CtapHidChannel and UserPresence traits, with their accompanying
types to separate API mods. Remove Default implementations of methods
in these traits, to keep all implementation details inside of concrete
Env types.

Rename methods in UserPresence trait, for better readability.

Remove duplicate code for finding appropriate HID channel for given
transport.

Rework check_user_presence() function so that there's no more need for
quick_check() method in UserPresence trait. To short-circuit user
presence check, Env implementation may use wait_with_timeout() method.

* Fix button press wait with zero timeout for TockEnv

* Fix formatting

* Remove type for duration, use embedded_time::duration::Milliseconds
directly, for better readability.

Treat any unconfirmed result of user presence check as an error, which
maps more naturally to CTAP spec status codes.

Remove unneeded underscores in trait definition.

Store usb endpoint directly, in TockEnv channels, to avoid unneeded
conversions.

* No need for separate error type for send_keepalive_up_needed()

* Document UserPresence trait and types.

Remove unused parameters in UserPresence trait's methods.

Add conversion function from UserPresence errors to Ctap2 status codes.

Do not check button status when tock user presence wait is called with
zero timeout.

* Make test environment always report success sending data

* Rename CtapHidChannel to HidConnection, rename *_hid_channel ->
*_hid_connection, for clarity. Use "Channel" to refer to the logical
connection from authenticator to one client, and use "Connection" to
refer to physical connection of authenticator to platform, on which
clients run.

Remove channel parameter from user presence API, it's not needed.

* Remove duplicate comments.

Co-authored-by: kaczmarczyck <43844792+kaczmarczyck@users.noreply.github.com>
This commit is contained in:
egor-duda
2022-06-23 17:34:27 +03:00
committed by GitHub
parent e52cafb394
commit 41780e9e33
12 changed files with 406 additions and 206 deletions

View File

@@ -393,7 +393,7 @@ mod test {
fn test_process_allowed() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
storage::toggle_always_uv(&mut env).unwrap();
@@ -410,7 +410,7 @@ mod test {
fn test_process_register() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
let application = [0x0A; 32];
@@ -462,7 +462,7 @@ mod test {
fn test_process_register_bad_message() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
let application = [0x0A; 32];
@@ -484,7 +484,7 @@ mod test {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
ctap_state.u2f_up_state.consume_up(CtapInstant::new(0));
@@ -500,7 +500,7 @@ mod test {
fn test_process_authenticate_check_only() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let sk = PrivateKey::new(env.rng(), SignatureAlgorithm::ES256);
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
@@ -518,7 +518,7 @@ mod test {
fn test_process_authenticate_check_only_wrong_rp() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let sk = PrivateKey::new(env.rng(), SignatureAlgorithm::ES256);
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
@@ -537,7 +537,7 @@ mod test {
fn test_process_authenticate_check_only_wrong_length() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let sk = PrivateKey::new(env.rng(), SignatureAlgorithm::ES256);
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
@@ -575,7 +575,7 @@ mod test {
fn test_process_authenticate_check_only_wrong_cla() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let sk = PrivateKey::new(env.rng(), SignatureAlgorithm::ES256);
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
@@ -595,7 +595,7 @@ mod test {
fn test_process_authenticate_check_only_wrong_ins() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let sk = PrivateKey::new(env.rng(), SignatureAlgorithm::ES256);
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
@@ -615,7 +615,7 @@ mod test {
fn test_process_authenticate_check_only_wrong_flags() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let sk = PrivateKey::new(env.rng(), SignatureAlgorithm::ES256);
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
@@ -643,7 +643,7 @@ mod test {
fn test_process_authenticate_enforce() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let sk = PrivateKey::new(env.rng(), SignatureAlgorithm::ES256);
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
@@ -671,7 +671,7 @@ mod test {
fn test_process_authenticate_dont_enforce() {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let sk = PrivateKey::new(env.rng(), SignatureAlgorithm::ES256);
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
@@ -709,7 +709,7 @@ mod test {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
ctap_state.u2f_up_state.consume_up(CtapInstant::new(0));
@@ -728,7 +728,7 @@ mod test {
let mut env = TestEnv::new();
env.user_presence()
.set(|_| panic!("Unexpected user presence check in CTAP1"));
.set(|| panic!("Unexpected user presence check in CTAP1"));
let mut ctap_state = CtapState::new(&mut env, CtapInstant::new(0));
ctap_state.u2f_up_state.consume_up(CtapInstant::new(0));