WIP: fixing documentation in CI (#392)

* Move `DEFAULT_AUTHENTICATOR_TIMEOUT` into `webauthn-rs`. This fixes a documentation build breakage caused by #385, and shifts default timeouts into our recommended interface. * Add PhantomData to stubs with type parameters, to fix a build issue on nightly * fix softtoken * Fix softpasskey * Update timeouts per Webauthn-3 recommendation, and add verbiage
kanidm · Nov 24, 2023 · fd5648d · fd5648d
1 parent a0cb1e8
commit fd5648d
Show file tree

Hide file tree

Showing 9 changed files with 109 additions and 57 deletions.
diff --git a/compat_tester/webauthn-rs-demo/src/actors.rs b/compat_tester/webauthn-rs-demo/src/actors.rs
@@ -6,7 +6,7 @@ use webauthn_rs_core::proto::{
 };
 use webauthn_rs_core::proto::{AuthenticationState, RegistrationState};
 
-use webauthn_rs::{prelude::Uuid, Webauthn, WebauthnBuilder};
+use webauthn_rs::{prelude::Uuid, Webauthn, WebauthnBuilder, DEFAULT_AUTHENTICATOR_TIMEOUT};
 use webauthn_rs_core::WebauthnCore;
 use webauthn_rs_demo_shared::*;
 
@@ -61,7 +61,7 @@ impl WebauthnActor {
             &rp_name,
             &rp_id,
             vec![rp_origin.to_owned()],
-            None,
+            DEFAULT_AUTHENTICATOR_TIMEOUT,
             None,
             None,
         );

diff --git a/fido-key-manager/src/main.rs b/fido-key-manager/src/main.rs
@@ -13,6 +13,7 @@ use std::time::Duration;
 use tokio_stream::StreamExt;
 #[cfg(feature = "solokey")]
 use webauthn_authenticator_rs::ctap2::SoloKeyAuthenticator;
+#[cfg(feature = "solokey")]
 use webauthn_authenticator_rs::prelude::WebauthnCError;
 use webauthn_authenticator_rs::{
     ctap2::{

diff --git a/webauthn-authenticator-rs/examples/authenticate.rs b/webauthn-authenticator-rs/examples/authenticate.rs
@@ -237,7 +237,7 @@ async fn main() {
         "https://localhost:8080/auth",
         "localhost",
         vec![url::Url::parse("https://localhost:8080").unwrap()],
-        Some(Duration::from_millis(1)),
+        Duration::from_secs(60),
         None,
         None,
     );

diff --git a/webauthn-authenticator-rs/src/softpasskey.rs b/webauthn-authenticator-rs/src/softpasskey.rs
@@ -523,19 +523,22 @@ impl U2FToken for SoftPasskey {
 mod tests {
     use super::SoftPasskey;
     use crate::prelude::{Url, WebauthnAuthenticator};
+    use std::time::Duration;
     use webauthn_rs_core::WebauthnCore as Webauthn;
     use webauthn_rs_proto::{
         AttestationConveyancePreference, COSEAlgorithm, UserVerificationPolicy,
     };
 
+    const AUTHENTICATOR_TIMEOUT: Duration = Duration::from_secs(60);
+
     #[test]
     fn webauthn_authenticator_wan_softpasskey_self_attest() {
         let _ = tracing_subscriber::fmt::try_init();
         let wan = Webauthn::new_unsafe_experts_only(
             "https://localhost:8080/auth",
             "localhost",
             vec![url::Url::parse("https://localhost:8080").unwrap()],
-            None,
+            AUTHENTICATOR_TIMEOUT,
             None,
             None,
         );

diff --git a/webauthn-authenticator-rs/src/softtoken.rs b/webauthn-authenticator-rs/src/softtoken.rs
@@ -852,7 +852,7 @@ impl AuthenticatorBackendHashedClientData for SoftTokenFile {
 mod tests {
     use super::*;
     use openssl::{hash::MessageDigest, rand::rand_bytes, sign::Verifier, x509::X509};
-    use std::collections::BTreeSet;
+    use std::{collections::BTreeSet, time::Duration};
     use tempfile::tempfile;
     use webauthn_rs_core::{
         proto::{AttestationCa, AttestationCaList, COSEKey},
@@ -876,14 +876,16 @@ mod tests {
         softtoken::SoftToken,
     };
 
+    const AUTHENTICATOR_TIMEOUT: Duration = Duration::from_secs(60);
+
     #[test]
     fn webauthn_authenticator_wan_softtoken_direct_attest() {
         let _ = tracing_subscriber::fmt::try_init();
         let wan = Webauthn::new_unsafe_experts_only(
             "https://localhost:8080/auth",
             "localhost",
             vec![url::Url::parse("https://localhost:8080").unwrap()],
-            None,
+            AUTHENTICATOR_TIMEOUT,
             None,
             None,
         );
@@ -962,7 +964,7 @@ mod tests {
             "https://localhost:8080/auth",
             "localhost",
             vec![url::Url::parse("https://localhost:8080").unwrap()],
-            None,
+            AUTHENTICATOR_TIMEOUT,
             None,
             None,
         );

diff --git a/webauthn-authenticator-rs/src/stubs.rs b/webauthn-authenticator-rs/src/stubs.rs
@@ -54,15 +54,21 @@ pub mod tokio {
     }
     pub mod sync {
         pub mod mpsc {
-            pub struct Sender<T> {}
-            pub struct Receiver<T> {}
+            pub struct Sender<T> {
+                _phantom: std::marker::PhantomData<T>,
+            }
+            pub struct Receiver<T> {
+                _phantom: std::marker::PhantomData<T>,
+            }
         }
     }
     pub mod time {
         pub async fn sleep(_: std::time::Duration) {}
     }
     pub mod task {
-        pub struct JoinHandle<T> {}
+        pub struct JoinHandle<T> {
+            _phantom: std::marker::PhantomData<T>,
+        }
         pub fn spawn<A, B>(future: A) -> JoinHandle<B> {}
         pub fn spawn_blocking() {}
     }
@@ -71,7 +77,9 @@ pub mod tokio {
 #[cfg(not(feature = "ctap2"))]
 pub mod tokio_stream {
     pub mod wrappers {
-        pub struct ReceiverStream<T> {}
+        pub struct ReceiverStream<T> {
+            _phantom: std::marker::PhantomData<T>,
+        }
     }
 }
 
@@ -85,8 +93,12 @@ pub mod tokio_tungstenite {
             }
         }
     }
-    pub struct MaybeTlsStream<T> {}
-    pub struct WebSocketStream<T> {}
+    pub struct MaybeTlsStream<T> {
+        _phantom: std::marker::PhantomData<T>,
+    }
+    pub struct WebSocketStream<T> {
+        _phantom: std::marker::PhantomData<T>,
+    }
 }
 
 #[cfg(not(any(feature = "bluetooth", feature = "cable")))]
@@ -120,9 +132,13 @@ pub mod openssl {
         pub struct BigNumContext {}
     }
     pub mod ec {
-        pub struct EcKey<T> {}
+        pub struct EcKey<T> {
+            _phantom: std::marker::PhantomData<T>,
+        }
         pub struct EcGroup {}
-        pub struct EcKeyRef<T> {}
+        pub struct EcKeyRef<T> {
+            _phantom: std::marker::PhantomData<T>,
+        }
         pub struct EcPoint {}
         pub struct EcPointRef {}
         pub enum PointConversionForm {}
@@ -132,8 +148,12 @@ pub mod openssl {
     }
     pub mod pkey {
         pub struct Id {}
-        pub struct PKey<T> {}
-        pub struct PKeyRef<T> {}
+        pub struct PKey<T> {
+            _phantom: std::marker::PhantomData<T>,
+        }
+        pub struct PKeyRef<T> {
+            _phantom: std::marker::PhantomData<T>,
+        }
         pub struct Private {}
         pub struct Public {}
     }

diff --git a/webauthn-rs-core/src/constants.rs b/webauthn-rs-core/src/constants.rs
@@ -1,5 +1,2 @@
-use std::time::Duration;
-
 // Can this ever change?
 pub const CHALLENGE_SIZE_BYTES: usize = 32;
-pub const DEFAULT_AUTHENTICATOR_TIMEOUT: Duration = Duration::from_millis(60000);