soft-fido2 0.17.0

A pure Rust implementation of FIDO2/WebAuthn CTAP 2.0/2.1 protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

#![warn(unused_extern_crates)]
#![cfg_attr(not(feature = "std"), no_std)]

//! # soft-fido2
//!
//! A pure Rust FIDO2/WebAuthn CTAP2 implementation providing virtual authenticator
//! capabilities for testing and development.
//!
//! ## no_std Support
//!
//! This crate supports `no_std` environments. To use without the standard library:
//!
//! ```toml
//! [dependencies]
//! soft-fido2 = { version = "0.4", default-features = false }
//! ```
//!
//! **Note**: Transport layers (USB HID, UHID) require `std` and are not available in `no_std`.
//! The core CTAP protocol and authenticator logic work in `no_std` with `alloc`.
//!
//! ## Architecture
//!
//! - **Authenticator**: Virtual FIDO2 authenticator with callback-based user interaction
//! - **Client**: High-level API for communicating with authenticators (requires `std`)
//! - **Transport**: USB HID and Linux UHID transport layers (requires `std`)
//! - **PIN Protocol**: CTAP2 PIN/UV authentication
//!
//! ## Example (with std)
//!
//! ```no_run
//! # #[cfg(feature = "std")]
//! # fn main() -> Result<(), soft_fido2::Error> {
//! use soft_fido2::{TransportList, Client};
//!
//! let mut list = TransportList::enumerate()?;
//! let mut transport = list.get(0).unwrap();
//! transport.open()?;
//!
//! let info = Client::authenticator_get_info(&mut transport)?;
//! # Ok(())
//! # }
//! # #[cfg(not(feature = "std"))]
//! # fn main() {}
//! ```

extern crate alloc;

// Core modules (no_std compatible)
pub mod authenticator;
pub mod ctap;
pub mod error;
pub mod options;
pub mod request;
pub mod response;
pub mod types;

// Modules that require std
#[cfg(feature = "std")]
pub mod client;
#[cfg(feature = "std")]
pub mod pin;
#[cfg(feature = "std")]
pub mod transport;

#[cfg(all(target_os = "linux", feature = "std"))]
pub mod uhid;

// Re-export main types at root level for convenience
pub use authenticator::{
    Authenticator, AuthenticatorCallbacks, AuthenticatorConfig, AuthenticatorConfigBuilder,
    BuiltInUvState, UpResult, UvResult,
};
pub use ctap::CtapCommand;
pub use error::{Error, Result};
pub use options::AuthenticatorOptions;
pub use request::{
    ClientDataHash, CredentialDescriptor, CredentialManagementRequest, CredentialType,
    DeleteCredentialRequest, EnumerateCredentialsRequest, GetAssertionRequest,
    MakeCredentialRequest, PinUvAuth, PinUvAuthProtocol, UpdateUserRequest,
};
pub use soft_fido2_ctap::StatusCode;

// Re-export key provider types
pub use soft_fido2_ctap::key_provider::{
    CredentialKey, CredentialKeyError, CredentialKeyProvider, CredentialKeyProviderId,
    GeneratedCredentialKey, SoftwareCredentialKeyProvider,
};

// Re-export PIN storage types for persistent PIN state support
pub use soft_fido2_ctap::callbacks::PinStorageCallbacks;
pub use soft_fido2_ctap::types::PinState;

pub use types::{Credential, CredentialBackupState, CredentialRef, Extensions, RelyingParty, User};

// Re-export response types
pub use response::{
    CredentialEnumerationBeginResponse, CredentialEnumerationNextResponse, CredentialInfo,
    CredentialsMetadata, RpEnumerationBeginResponse, RpEnumerationNextResponse, RpInfo,
};

// std-only re-exports
#[cfg(feature = "std")]
pub use client::{Client, compute_rp_id_hash};
#[cfg(feature = "std")]
pub use pin::{PinProtocol, PinUvAuthEncapsulation};
#[cfg(feature = "std")]
pub use transport::{Transport, TransportList};

#[cfg(all(target_os = "linux", feature = "std"))]
pub use uhid::Uhid;