diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e37b263e..85b009bf 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -19,3 +19,5 @@ jobs: run: cargo install --locked cargo-docs-rs - name: Build docs the way docs.rs does run: cargo +nightly docs-rs -p libwebauthn + - name: Build pxp docs the way docs.rs does + run: cargo +nightly docs-rs -p pxp diff --git a/.github/workflows/rust-latest.yml b/.github/workflows/rust-latest.yml index 527e208c..d587d886 100644 --- a/.github/workflows/rust-latest.yml +++ b/.github/workflows/rust-latest.yml @@ -43,7 +43,7 @@ jobs: run: cargo test -p libwebauthn --lib --features nfc-backend-pcsc --verbose env: LIBWEBAUTHN_PSL_SYSTEM_TEST: "1" - - name: Verify libwebauthn publishes cleanly - run: cargo publish --dry-run -p libwebauthn - - name: Verify libwebauthn pxp publishes cleanly + - name: Verify pxp publishes cleanly run: cargo publish --dry-run -p pxp + - name: Verify libwebauthn publishes cleanly + run: cargo publish --dry-run -p pxp -p libwebauthn diff --git a/Cargo.lock b/Cargo.lock index bf6fa98e..e7948bab 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2816,7 +2816,6 @@ dependencies = [ "serde_repr", "sha2 0.10.9", "snow", - "test-log", "thiserror 2.0.18", "tokio", "tokio-tungstenite", diff --git a/pxp/Cargo.toml b/pxp/Cargo.toml index 256ceb77..88fe24b4 100644 --- a/pxp/Cargo.toml +++ b/pxp/Cargo.toml @@ -10,7 +10,7 @@ authors = [ edition = "2021" rust-version = "1.88" license = "LGPL-2.1-or-later" -readme = "../README.md" +readme = "README.md" homepage = "https://github.com/linux-credentials" repository = "https://github.com/linux-credentials/libwebauthn" @@ -47,6 +47,3 @@ tracing = "0.1.29" tungstenite = { version = "0.26.2" } url = "2.5" uuid = { version = "1.5.0", features = ["serde", "v4"] } - -[dev-dependencies] -test-log = { version = "0.2" } diff --git a/pxp/README.md b/pxp/README.md index c782bd7b..e9853f3d 100644 --- a/pxp/README.md +++ b/pxp/README.md @@ -2,17 +2,17 @@ A Linux-native implementation of the [FIDO2 Proximity Exchange Protocol (PXP) spec][pxp-spec], fully written in Rust. -PXP, formerly the FIDO2 hybrid transport, allows a FIDO2 client and authenticator to communicate over a Bluetooth or Websocket tunnel after initiation via via QR code scan or NFC and establishing physical proximity over BLE. +PXP, formerly the CTAP hybrid transport, allows a FIDO2 client and authenticator to communicate over a Bluetooth or WebSocket tunnel after initiation via QR code scan or NFC and establishing physical proximity over BLE. ## Features - Initiation - 🟢 QR code - 🟢 State-assisted - - 🟠 NFC + - 🟠 NFC (planned) - Data channel - 🟢 BLE - - 🟢 Websockets + - 🟢 WebSockets ## Minimum Supported Rust Version (MSRV)