Adapt nfc transport to API changes

Author: mikma

libwebauthn/src/transport/nfc/channel.rs

@@ -5,16 +5,18 @@ use async_trait::async_trait;
 use std::fmt;
 use std::fmt::{Debug, Display, Formatter};
 use std::time::Duration;
-use tokio::sync::mpsc;
+use tokio::sync::broadcast;
+use tokio::sync::mpsc::{self, Sender};
 #[allow(unused_imports)]
 use tracing::{Level, debug, instrument, trace, warn};
 
-use crate::UxUpdate;
+use crate::webauthn::error::Error;
+use crate::UvUpdate;
 use crate::proto::ctap1::apdu::{ApduRequest, ApduResponse};
 use crate::proto::ctap2::cbor::{CborRequest, CborResponse};
 use crate::transport::channel::{AuthTokenData, Channel, ChannelStatus, Ctap2AuthTokenStore};
 use crate::transport::device::SupportedProtocols;
-use crate::transport::error::{Error, TransportError};
+use crate::transport::error::TransportError;
 
 use super::commands::{command_ctap_msg, command_get_response};
 
@@ -23,6 +25,8 @@ const SELECT_P2: u8 = 0x00;
 const APDU_FIDO: &[u8; 8] = b"\xa0\x00\x00\x06\x47\x2f\x00\x01";
 const SW1_MORE_DATA: u8 = 0x61;
 
+pub type CancelNfcOperation = ();
+
 #[derive(thiserror::Error)]
 pub enum NfcError {
     /// APDU error returned by the card.
@@ -68,15 +72,27 @@ pub trait HandlerInCtx<Ctx> {
 
 pub trait NfcBackend<Ctx>: HandlerInCtx<Ctx> + Display {}
 
+#[derive(Debug, Clone)]
+pub struct NfcChannelHandle {
+    tx: Sender<CancelNfcOperation>,
+}
+
+impl NfcChannelHandle {
+    pub async fn cancel_ongoing_operation(&self) {
+        let _ = self.tx.send(()).await;
+    }
+}
+
 pub struct NfcChannel<Ctx>
 where
     Ctx: Copy + Sync,
 {
     delegate: Box<dyn NfcBackend<Ctx> + Send + Sync>,
     auth_token_data: Option<AuthTokenData>,
-    tx: mpsc::Sender<UxUpdate>,
+    ux_update_sender: broadcast::Sender<UvUpdate>,
+    handle: NfcChannelHandle,
     ctx: Ctx,
-    apdu_response: Option<ApduResponse>,
+    _apdu_response: Option<ApduResponse>,
     cbor_response: Option<CborResponse>,
     supported: SupportedProtocols,
     status: ChannelStatus,
@@ -98,14 +114,17 @@ where
     pub fn new(
         delegate: Box<dyn NfcBackend<Ctx> + Send + Sync>,
         ctx: Ctx,
-        tx: mpsc::Sender<UxUpdate>,
     ) -> Self {
+        let (ux_update_sender, _) = broadcast::channel(16);
+        let (handle_tx, _handle_rx) = mpsc::channel(1);
+        let handle = NfcChannelHandle { tx: handle_tx };
         NfcChannel {
             delegate,
             auth_token_data: None,
-            tx,
+            ux_update_sender,
+            handle,
             ctx,
-            apdu_response: None,
+            _apdu_response: None,
             cbor_response: None,
             supported: SupportedProtocols {
                 fido2: false,
@@ -115,6 +134,10 @@ where
         }
     }
 
+    pub fn get_handle(&self) -> NfcChannelHandle {
+        self.handle.clone()
+    }
+
     #[instrument(skip_all)]
     pub async fn wink(&mut self, _timeout: Duration) -> Result<bool, Error> {
         warn!("WINK capability is not supported");
@@ -192,6 +215,8 @@ impl<'a, Ctx> Channel for NfcChannel<Ctx>
 where
     Ctx: Copy + Send + Sync + fmt::Debug + Display,
 {
+    type UxUpdate = UvUpdate;
+
     async fn supported_protocols(&self) -> Result<SupportedProtocols, Error> {
         Ok(self.supported)
     }
@@ -205,7 +230,7 @@ where
     }
 
     #[instrument(level = Level::DEBUG, skip_all)]
-    async fn apdu_send(&self, request: &ApduRequest, _timeout: Duration) -> Result<(), Error> {
+    async fn apdu_send(&self, _request: &ApduRequest, _timeout: Duration) -> Result<(), Error> {
         todo!("apdu_send")
     }
 
@@ -272,8 +297,8 @@ where
             .ok_or(Error::Transport(TransportError::InvalidFraming))
     }
 
-    fn get_state_sender(&self) -> &mpsc::Sender<UxUpdate> {
-        &self.tx
+    fn get_ux_update_sender(&self) -> &broadcast::Sender<UvUpdate> {
+        &self.ux_update_sender
     }
 }
 

libwebauthn/src/transport/nfc/commands.rs

@@ -46,7 +46,7 @@ pub fn command_get_response(p1: u8, p2: u8, le: u8) -> GetResponseCommand {
 
 const CLA_HAS_MORE: u8 = 0x10;
 const INS_CTAP_MSG: u8 = 0x10;
-const CTAP_P1_SUPP_GET_RESP: u8 = 0x80;
+const _CTAP_P1_SUPP_GET_RESP: u8 = 0x80;
 const CTAP_P2: u8 = 0x00;
 
 /// `CTAP MSG` (0x10) command.

libwebauthn/src/transport/nfc/device.rs

@@ -1,12 +1,10 @@
 use async_trait::async_trait;
 use std::fmt;
-use tokio::sync::mpsc;
 #[allow(unused_imports)]
 use tracing::{debug, info, instrument, trace};
 
-use crate::UxUpdate;
+use crate::webauthn::error::Error;
 use crate::transport::device::Device;
-use crate::transport::error::Error;
 
 use super::channel::NfcChannel;
 #[cfg(feature = "libnfc")]
@@ -62,9 +60,9 @@ impl NfcDevice {
 
     fn channel_sync<'d>(
         &'d self,
-    ) -> Result<(NfcChannel<Context>, mpsc::Receiver<UxUpdate>), Error> {
+    ) -> Result<NfcChannel<Context>, Error> {
         trace!("nfc channel {:?}", self);
-        let (mut channel, recv): (NfcChannel<Context>, mpsc::Receiver<UxUpdate>) = match &self.info
+        let mut channel: NfcChannel<Context> = match &self.info
         {
             #[cfg(feature = "libnfc")]
             DeviceInfo::LibNfc(info) => info.channel(),
@@ -74,15 +72,15 @@ impl NfcDevice {
 
         channel.select_fido2()?;
 
-        Ok((channel, recv))
+        Ok(channel)
     }
 }
 
 #[async_trait]
 impl<'d> Device<'d, Nfc, NfcChannel<Context>> for NfcDevice {
     async fn channel(
         &'d mut self,
-    ) -> Result<(NfcChannel<Context>, mpsc::Receiver<UxUpdate>), Error> {
+    ) -> Result<NfcChannel<Context>, Error> {
         self.channel_sync()
     }
 }
@@ -95,7 +93,7 @@ where
     where
         Ctx: fmt::Debug + fmt::Display + Copy + Send + Sync,
     {
-        let (mut chan, _send) = device.channel_sync()?;
+        let mut chan = device.channel_sync()?;
         let _ = chan.select_fido2()?;
         Ok(true)
     }

libwebauthn/src/transport/nfc/libnfc/mod.rs

@@ -1,8 +1,8 @@
 use super::Context;
 use super::channel::{HandlerInCtx, NfcBackend, NfcChannel};
 use super::device::NfcDevice;
-use crate::UxUpdate;
-use crate::transport::error::{Error, TransportError};
+use crate::webauthn::error::Error;
+use crate::transport::error::TransportError;
 use apdu::core::HandleError;
 use apdu_core;
 use std::fmt;
@@ -11,7 +11,6 @@ use std::io::Write;
 use std::sync::{Arc, Mutex};
 use std::thread;
 use std::time::Duration;
-use tokio::sync::mpsc;
 #[allow(unused_imports)]
 use tracing::{debug, info, instrument, trace};
 
@@ -70,8 +69,7 @@ impl Info {
         }
     }
 
-    pub fn channel(&self) -> Result<(NfcChannel<Context>, mpsc::Receiver<UxUpdate>), Error> {
-        let (send, recv) = mpsc::channel(1);
+    pub fn channel(&self) -> Result<NfcChannel<Context>, Error> {
         let context = nfc1::Context::new().map_err(|e| map_error(e))?;
 
         let mut chan = Channel::new(self, context);
@@ -89,8 +87,8 @@ impl Info {
         debug!("Selected: {:?}", target);
 
         let ctx = Context {};
-        let channel = NfcChannel::new(Box::new(chan), ctx, send);
-        Ok((channel, recv))
+        let channel = NfcChannel::new(Box::new(chan), ctx);
+        Ok(channel)
     }
 }
 

libwebauthn/src/transport/nfc/pcsc/mod.rs

@@ -1,16 +1,15 @@
 use super::Context;
 use super::channel::{HandlerInCtx, NfcBackend, NfcChannel};
 use super::device::NfcDevice;
-use crate::UxUpdate;
-use crate::transport::error::{Error, TransportError};
+use crate::webauthn::error::Error;
+use crate::transport::error::TransportError;
 use apdu::core::HandleError;
 use pcsc;
 use std::ffi::{CStr, CString};
 use std::fmt;
 use std::fmt::Debug;
 use std::ops::Deref;
 use std::sync::{Arc, Mutex};
-use tokio::sync::mpsc;
 #[allow(unused_imports)]
 use tracing::{debug, info, instrument, trace};
 
@@ -92,14 +91,13 @@ impl Info {
         }
     }
 
-    pub fn channel(&self) -> Result<(NfcChannel<Context>, mpsc::Receiver<UxUpdate>), Error> {
-        let (send, recv) = mpsc::channel(1);
+    pub fn channel(&self) -> Result<NfcChannel<Context>, Error> {
         let context = pcsc::Context::establish(pcsc::Scope::User)?;
         let chan = Channel::new(self, context)?;
 
         let ctx = Context {};
-        let channel = NfcChannel::new(Box::new(chan), ctx, send);
-        Ok((channel, recv))
+        let channel = NfcChannel::new(Box::new(chan), ctx);
+        Ok(channel)
     }
 }