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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
use std::{collections::BTreeMap, fmt::Debug, mem::size_of};
#[cfg(feature = "ctap2-management")]
use crate::util::check_pin;
use crate::{
authenticator_hashed::AuthenticatorBackendHashedClientData,
ctap2::{commands::*, pin_uv::*, Ctap21Authenticator},
error::{CtapError, WebauthnCError},
transport::Token,
ui::UiCallback,
SHA256Hash,
};
use base64urlsafedata::Base64UrlSafeData;
use futures::executor::block_on;
use webauthn_rs_proto::{
AuthenticationExtensionsClientOutputs, AuthenticatorAssertionResponseRaw,
AuthenticatorAttestationResponseRaw, PubKeyCredParams, PublicKeyCredential,
RegisterPublicKeyCredential, RegistrationExtensionsClientOutputs, RelyingParty, User,
UserVerificationPolicy,
};
use super::internal::CtapAuthenticatorVersion;
#[derive(Debug, Clone)]
pub(super) enum AuthToken {
/// No authentication token to be supplied
None,
/// `pinUvAuthProtocol`, `pinUvAuthToken`
ProtocolToken(u32, Vec<u8>),
/// Send request with `uv = true`
UvTrue,
}
impl AuthToken {
pub fn into_pin_uv_params(self) -> (Option<u32>, Option<Vec<u8>>) {
match self {
Self::ProtocolToken(p, t) => (Some(p), Some(t)),
_ => (None, None),
}
}
}
#[derive(Debug)]
pub(super) enum AuthSession {
None,
/// `iface`, `pinToken`
InterfaceToken(PinUvPlatformInterface, Vec<u8>),
UvTrue,
}
/// CTAP 2.0 protocol implementation.
#[derive(Debug)]
pub struct Ctap20Authenticator<'a, T: Token, U: UiCallback> {
pub(super) info: GetInfoResponse,
pub(super) token: T,
pub(super) ui_callback: &'a U,
}
impl<'a, T: Token, U: UiCallback> CtapAuthenticatorVersion<'a, T, U>
for Ctap20Authenticator<'a, T, U>
{
const VERSION: &'static str = "FIDO_2_0";
fn new_with_info(info: GetInfoResponse, token: T, ui_callback: &'a U) -> Self {
Self {
info,
token,
ui_callback,
}
}
}
impl<'a, T: Token, U: UiCallback> Ctap20Authenticator<'a, T, U> {
/// Gets cached information about the authenticator.
///
/// This does not transmit to the token.
pub fn get_info(&self) -> &GetInfoResponse {
&self.info
}
#[cfg(any(all(doc, not(doctest)), feature = "ctap2-management"))]
/// Perform a factory reset of the token, deleting all data.
pub async fn factory_reset(&mut self) -> Result<(), WebauthnCError> {
let ui_callback = self.ui_callback;
self.token
.transmit(ResetRequest {}, ui_callback)
.await
.map(|_| ())
}
#[cfg(any(all(doc, not(doctest)), feature = "ctap2-management"))]
/// Refreshes the cached [GetInfoResponse].
///
/// This needs to be called (internally) after sending a command which
/// could invalidate its content.
pub(super) async fn refresh_info(&mut self) -> Result<(), WebauthnCError> {
let ui_callback = self.ui_callback;
self.info = self.token.transmit(GetInfoRequest {}, ui_callback).await?;
Ok(())
}
#[cfg(any(all(doc, not(doctest)), feature = "ctap2-management"))]
/// Checks whether a provided PIN follows the rules defined by the
/// authenticator. This does not share the PIN with the authenticator.
pub fn validate_pin(&self, pin: &str) -> Result<String, WebauthnCError> {
check_pin(pin, self.info.get_min_pin_length())
}
#[cfg(any(all(doc, not(doctest)), feature = "ctap2-management"))]
/// Sets a PIN on a device which does not already have one.
///
/// To change a PIN, use [`change_pin()`][Self::change_pin].
pub async fn set_new_pin(&mut self, pin: &str) -> Result<(), WebauthnCError> {
let ui_callback = self.ui_callback;
let pin = self.validate_pin(pin)?;
let mut padded_pin: [u8; 64] = [0; 64];
padded_pin[..pin.len()].copy_from_slice(pin.as_bytes());
let iface = PinUvPlatformInterface::select_protocol(self.info.pin_protocols.as_ref())?;
let p = iface.get_key_agreement_cmd();
let ret = self.token.transmit(p, ui_callback).await?;
let key_agreement = ret.key_agreement.ok_or(WebauthnCError::Internal)?;
trace!(?key_agreement);
// The platform calls encapsulate with the public key that the authenticator
// returned in order to generate the platform key-agreement key and the shared secret.
let shared_secret = iface.encapsulate(key_agreement)?;
trace!(?shared_secret);
let set_pin = iface.set_pin_cmd(padded_pin, shared_secret.as_slice())?;
let ret = self.token.transmit(set_pin, ui_callback).await?;
trace!(?ret);
// Setting a PIN invalidates info.
self.refresh_info().await?;
Ok(())
}
#[cfg(any(all(doc, not(doctest)), feature = "ctap2-management"))]
/// Changes a PIN on a device.
///
/// To set a PIN for the first time, use [`set_new_pin()`][Self::set_new_pin].
pub async fn change_pin(&mut self, old_pin: &str, new_pin: &str) -> Result<(), WebauthnCError> {
let ui_callback = self.ui_callback;
// TODO: we actually really only need this in normal form C
let old_pin = self.validate_pin(old_pin)?;
let new_pin = self.validate_pin(new_pin)?;
let mut padded_pin: [u8; 64] = [0; 64];
padded_pin[..new_pin.len()].copy_from_slice(new_pin.as_bytes());
let iface = PinUvPlatformInterface::select_protocol(self.info.pin_protocols.as_ref())?;
let p = iface.get_key_agreement_cmd();
let ret = self.token.transmit(p, ui_callback).await?;
let key_agreement = ret.key_agreement.ok_or(WebauthnCError::Internal)?;
let shared_secret = iface.encapsulate(key_agreement)?;
let change_pin = iface.change_pin_cmd(&old_pin, padded_pin, &shared_secret)?;
let ret = self.token.transmit(change_pin, ui_callback).await?;
trace!(?ret);
// Changing a PIN invalidates forcePinChange option.
self.refresh_info().await?;
Ok(())
}
/// Gets a PIN/UV auth token, if required.
///
/// This automatically selects an appropriate verification mode.
///
/// ## Arguments
///
/// * `client_data_hash`: the SHA256 hash of the client data JSON.
///
/// * `permissions`: a bitmask of permissions to request. If this argument
/// is not set, the library will always use
/// [legacy `getPinToken` authentication][getPinToken].
///
/// * `rp_id`: the Relying Party to associate with the request (permissions
/// RP ID).
///
/// This argument is required if requesting [`GET_ASSERTION`][] and/or
/// [`MAKE_CREDENTIAL`][] `permissions`, and is optional if requesting
/// [`CREDENTIAL_MANAGEMENT`][] `permissions`.
///
/// This argument must not be set if `permissions` is empty.
///
/// * `user_verification_policy`: how to verify the user.
///
/// ## Returns
///
/// * `Option<u32>`: the `pin_uv_auth_protocol`
/// * `Option<Vec<u8>>`: the `pin_uv_auth_param`
/// * `Ok((None, None))` if PIN and/or UV auth is not required.
/// * `Err(UserVerificationRequired)` if user verification was required, but
/// was not available.
/// * `Err` for errors from the token.
///
/// ## Permissions and CTAP versions
///
/// The `permissions` and `rp_id` arguments are **only** enforced when the
/// authenticator sets the `pinUvAuthToken` option, which is a
/// [mandatory feature][] in CTAP 2.1 and later.
///
/// This **will not be enforced** for CTAP 2.0 and 2.1-PRE authenticators,
/// and automatically fall back to
/// [legacy `getPinToken` authentication][getPinToken].
///
/// While this API follows CTAP 2.1 semantics, these are only weakly
/// enforced, making it important to test your application with CTAP 2.0,
/// 2.1-PRE and 2.1 authenticators.
///
/// ## References
///
/// * [Operations to Obtain a `pinUvAuthToken`][gettingPinUvAuthToken]
///
/// [getPinToken]: https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#getPinToken
/// [gettingPinUvAuthToken]: https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#gettingPinUvAuthToken
/// [mandatory feature]: https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#mandatory-features
/// [`CREDENTIAL_MANAGEMENT`]: Permissions::CREDENTIAL_MANAGEMENT
/// [`GET_ASSERTION`]: Permissions::GET_ASSERTION
/// [`MAKE_CREDENTIAL`]: Permissions::MAKE_CREDENTIAL
pub(super) async fn get_pin_uv_auth_token(
&mut self,
client_data_hash: &[u8],
permissions: Permissions,
rp_id: Option<String>,
user_verification_policy: UserVerificationPolicy,
) -> Result<AuthToken, WebauthnCError> {
let session = self
.get_pin_uv_auth_session(permissions, rp_id, user_verification_policy)
.await?;
Ok(match session {
AuthSession::InterfaceToken(iface, pin_token) => {
let pin_uv_auth_param =
iface.authenticate(pin_token.as_slice(), client_data_hash)?;
AuthToken::ProtocolToken(iface.get_pin_uv_protocol(), pin_uv_auth_param)
}
AuthSession::None => AuthToken::None,
AuthSession::UvTrue => AuthToken::UvTrue,
})
}
pub(super) async fn get_pin_uv_auth_session(
&mut self,
permissions: Permissions,
rp_id: Option<String>,
user_verification_policy: UserVerificationPolicy,
) -> Result<AuthSession, WebauthnCError> {
#[derive(Debug)]
enum PlannedOperation {
UvAuthTokenUsingUvWithPermissions,
UvAuthTokenUsingPinWithPermissions,
Token,
}
if permissions.intersects(Permissions::MAKE_CREDENTIAL | Permissions::GET_ASSERTION)
&& rp_id.is_none()
{
error!("rp_id is required for MakeCredential and GetAssertion requests");
return Err(WebauthnCError::Internal);
}
if rp_id.is_some() && permissions.is_empty() {
error!("rp_id specified with no permissions");
return Err(WebauthnCError::Internal);
}
trace!("Authenticator options: {:?}", self.info.options);
let ui_callback = self.ui_callback;
let client_pin = self.info.get_option("clientPin").unwrap_or_default();
let mut always_uv = self.info.get_option("alwaysUv").unwrap_or_default();
let make_cred_uv_not_required = self.info.make_cred_uv_not_required();
let pin_uv_auth_token = self.info.get_option("pinUvAuthToken").unwrap_or_default();
let uv = self.info.get_option("uv").unwrap_or_default();
// requesting the acfg permission when invoking
// getPinUvAuthTokenUsingUvWithPermissions is supported.
let uv_acfg = self.info.get_option("uvAcfg").unwrap_or_default();
// requesting the be permission when invoking
// getPinUvAuthTokenUsingUvWithPermissions is supported.
let uv_bio_enroll = self.info.get_option("uvBioEnroll").unwrap_or_default();
// TODO: noMcGaPermissionsWithClientPin means those can only run with biometric auth
// TODO: rp_options.uv_required == true > makeCredUvNotRqd == true
// TODO: discoverable credentials should bypass makeCredUvNotRqd == true
// Allow toggleAlwaysUv to bypass alwaysUv if no user verification is
// configured, to allow for initial configuration.
// https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#authenticatorConfig
if permissions == Permissions::AUTHENTICATOR_CONFIGURATION
&& user_verification_policy == UserVerificationPolicy::Discouraged_DO_NOT_USE
&& !client_pin
&& !uv
&& always_uv
{
trace!(
"Pretending alwaysUv = false to allow for initial configuration of toggleAlwaysUv"
);
always_uv = false;
}
let requires_pin = (permissions.intersects(Permissions::BIO_ENROLLMENT) && !uv_bio_enroll)
|| (permissions.intersects(Permissions::AUTHENTICATOR_CONFIGURATION) && !uv_acfg)
|| permissions.intersects(Permissions::CREDENTIAL_MANAGEMENT);
trace!("Permissions: {permissions:?}, uvBioEnroll: {uv_bio_enroll:?}, uvAcfg: {uv_acfg:?}, requiresPin: {requires_pin:?}");
// https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#sctn-makeCred-platf-actions
// 1. If the authenticator is protected by some form of user
// verification, or the Relying Party prefers enforcing user
// verification (e.g., by setting
// options.authenticatorSelection.userVerification to "required", or
// "preferred" in the WebAuthn API):
trace!("uvPolicy: {user_verification_policy:?}, clientPin: {client_pin:?}, pinUvAuthToken: {pin_uv_auth_token:?}, uv: {uv:?}, alwaysUv: {always_uv:?}, makeCredUvNotRequired: {make_cred_uv_not_required:?}");
if user_verification_policy == UserVerificationPolicy::Required
|| user_verification_policy == UserVerificationPolicy::Preferred
|| client_pin
|| uv
// https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#sctn-feature-descriptions-alwaysUv
|| always_uv
// TODO: Implement makeCredUvNotReqd when this supports discoverable creds
{
// Skip step 1 (we don't already have a parameter)
// 2. Otherwise, the platform examines various option IDs in the
// authenticatorGetInfo response to determine its course of action:
let planned_operation = if uv && !requires_pin {
// 1. If the uv option ID is present and set to true:
if pin_uv_auth_token {
// If the pinUvAuthToken option ID is present and true then
// plan to use getPinUvAuthTokenUsingUvWithPermissions to
// obtain a pinUvAuthToken, and let it be the selected
// operation. Go to Step 1.1.2.3.
PlannedOperation::UvAuthTokenUsingUvWithPermissions
} else {
trace!("pinUvAuthToken not supported, planning to use uv=true");
return Ok(AuthSession::UvTrue);
}
} else {
// 2. Else (implying the uv option ID is present and set to
// false or absent):
if pin_uv_auth_token {
// 1. If the pinUvAuthToken option ID is present and true:
// To continue, ensure the clientPin option ID is present
// and true. Plan to use
// getPinUvAuthTokenUsingPinWithPermissions to obtain a
// pinUvAuthToken, and let it be the selected operation. Go
// to Step 1.1.2.3.
if !client_pin {
error!(
"Client PIN not set, and user verification is preferred or required"
);
return Err(WebauthnCError::UserVerificationRequired);
}
PlannedOperation::UvAuthTokenUsingPinWithPermissions
} else {
// 2. Else (implying the pinUvAuthToken option ID is absent):
// To continue, ensure the clientPin option ID is present
// and true. Plan to use getPinToken to obtain a
// pinUvAuthToken, and let it be the selected operation.
if !client_pin {
error!(
"Client PIN not set, and user verification is preferred or required"
);
return Err(WebauthnCError::UserVerificationRequired);
}
PlannedOperation::Token
}
};
trace!(?planned_operation);
// Step 1.1.2.3: In preparation for obtaining pinUvAuthToken, the
// platform:
let iface = PinUvPlatformInterface::select_protocol(self.info.pin_protocols.as_ref())?;
// 1. Obtains a shared secret
// 6.5.5.4: Obtaining the shared secret
let p = iface.get_key_agreement_cmd();
let ret = self.token.transmit(p, ui_callback).await?;
let key_agreement = ret.key_agreement.ok_or(WebauthnCError::Internal)?;
trace!(?key_agreement);
// The platform calls encapsulate with the public key that the authenticator
// returned in order to generate the platform key-agreement key and the shared secret.
let shared_secret = iface.encapsulate(key_agreement)?;
trace!(?shared_secret);
// Then the platform obtains a pinUvAuthToken from the
// authenticator, with the mc (and likely also with the ga)
// permission (see "pre-flight", mentioned above), using the
// selected operation. If successful, the platform creates the
// pinUvAuthParam parameter by calling authenticate(pinUvAuthToken,
// clientDataHash), and goes to Step 1.1.1.
let p = match planned_operation {
PlannedOperation::UvAuthTokenUsingUvWithPermissions => {
// 6.5.5.7.3. Getting pinUvAuthToken using getPinUvAuthTokenUsingUvWithPermissions (built-in user verification methods)
iface.get_pin_uv_auth_token_using_uv_with_permissions_cmd(permissions, rp_id)
}
PlannedOperation::UvAuthTokenUsingPinWithPermissions => {
// 6.5.5.7.2. Getting pinUvAuthToken using getPinUvAuthTokenUsingPinWithPermissions (ClientPIN)
let pin = self.request_pin(iface.get_pin_uv_protocol()).await?;
iface.get_pin_uv_auth_token_using_pin_with_permissions_cmd(
&pin,
shared_secret.as_slice(),
permissions,
rp_id,
)?
}
PlannedOperation::Token => {
// 6.5.5.7.1. Getting pinUvAuthToken using getPinToken (superseded)
let pin = self.request_pin(iface.get_pin_uv_protocol()).await?;
iface.get_pin_token_cmd(&pin, shared_secret.as_slice())?
}
};
let ret = self.token.transmit(p, ui_callback).await?;
trace!(?ret);
let pin_token = ret
.pin_uv_auth_token
.ok_or(WebauthnCError::MissingRequiredField)?;
// Decrypt the pin_token
let pin_token = iface.decrypt(shared_secret.as_slice(), pin_token.as_slice())?;
trace!(?pin_token);
Ok(AuthSession::InterfaceToken(iface, pin_token))
} else {
// Otherwise, implying the authenticator is not presently protected
// by some form of user verification, or the Relying Party wants to
// create a non-discoverable credential and not require user
// verification (e.g., by setting
// options.authenticatorSelection.userVerification to "discouraged"
// in the WebAuthn API), the platform invokes the
// authenticatorMakeCredential operation using the marshalled input
// parameters along with the "uv" option key set to false and
// terminate these steps.
trace!("User verification disabled");
Ok(AuthSession::None)
}
}
async fn request_pin(&mut self, pin_uv_protocol: u32) -> Result<String, WebauthnCError> {
let p = ClientPinRequest {
pin_uv_protocol: Some(pin_uv_protocol),
sub_command: ClientPinSubCommand::GetPinRetries,
..Default::default()
};
let ui_callback = self.ui_callback;
let ret = self.token.transmit(p, ui_callback).await?;
trace!(?ret);
// TODO: handle lockouts
ui_callback.request_pin().ok_or(WebauthnCError::Cancelled)
}
/// Prompt for user presence on an authenticator.
///
/// On CTAP 2.1 authenticators, this sends a [SelectionRequest].
///
/// On CTAP 2.0 and 2.1-PRE authenticators (where there is no
/// [SelectionRequest]), this performs a [MakeCredentialRequest] with
/// *invalid* PIN/UV auth parameters, using the process described in CTAP
/// 2.1 [§ 6.1.2 authenticatorMakeCredential Algorithm][0] step 1.
///
/// While this *shouldn't* result in an authenticator lock-out (according to
/// the spec), it has been observed that some authenticators will decrement
/// their `pinAttempts` counter.
///
/// ## References
///
/// * CTAP 2.1 [§6.1.2 authenticatorMakeCredential Algorithm][0], step 1.
///
/// [0]: https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#sctn-makeCred-authnr-alg
pub async fn selection(&mut self) -> Result<(), WebauthnCError> {
if !self.token.has_button() {
// The token doesn't have a button on a transport level (ie: NFC),
// so immediately mark this as the "selected" token.
return Ok(());
}
if self
.info
.versions
.contains(Ctap21Authenticator::<'a, T, U>::VERSION)
{
let ui_callback = self.ui_callback;
return self
.token
.transmit(SelectionRequest {}, ui_callback)
.await
.map(|_| ());
}
let mc = MakeCredentialRequest {
client_data_hash: vec![0; size_of::<SHA256Hash>()],
rp: RelyingParty {
id: "SELECTION".to_string(),
name: "SELECTION".to_string(),
},
user: User {
id: Base64UrlSafeData(vec![0]),
name: "SELECTION".to_string(),
display_name: "SELECTION".to_string(),
},
pub_key_cred_params: vec![
PubKeyCredParams {
type_: "public-key".to_owned(),
alg: -7,
},
PubKeyCredParams {
type_: "public-key".to_owned(),
alg: -257,
},
PubKeyCredParams {
type_: "public-key".to_owned(),
alg: -37,
},
],
exclude_list: vec![],
options: None,
pin_uv_auth_param: Some(vec![]),
pin_uv_auth_proto: None,
enterprise_attest: None,
};
let ret = self.token.transmit(mc, self.ui_callback).await;
if let Err(WebauthnCError::Ctap(e)) = ret {
if e == CtapError::Ctap2PinAuthInvalid || e == CtapError::Ctap2PinNotSet {
// User pressed the button
return Ok(());
}
if e == CtapError::Ctap2MissingParameter {
// Token2 seems to fall through to step 2 of the algorithm, but
// it still means the button was pressed.
return Ok(());
}
error!("unexpected error from authenticator: {e:?}");
return Err(WebauthnCError::Ctap(e));
} else {
// Some other error
ret?;
}
error!("got unexpected OK response from authenticator");
Err(WebauthnCError::Internal)
}
}
impl<'a, T: Token, U: UiCallback> AuthenticatorBackendHashedClientData
for Ctap20Authenticator<'a, T, U>
{
fn perform_register(
&mut self,
client_data_hash: Vec<u8>,
options: webauthn_rs_proto::PublicKeyCredentialCreationOptions,
_timeout_ms: u32,
) -> Result<webauthn_rs_proto::RegisterPublicKeyCredential, crate::prelude::WebauthnCError>
{
let authenticator_selection = options.authenticator_selection.unwrap_or_default();
let auth_token = block_on(self.get_pin_uv_auth_token(
client_data_hash.as_slice(),
Permissions::MAKE_CREDENTIAL,
Some(options.rp.id.clone()),
authenticator_selection.user_verification,
))?;
let req_options = if let AuthToken::UvTrue = auth_token {
// No pin_uv_auth_param, but verification is configured, so use it
Some(BTreeMap::from([("uv".to_owned(), true)]))
} else {
None
};
let (pin_uv_auth_proto, pin_uv_auth_param) = auth_token.into_pin_uv_params();
let mc = MakeCredentialRequest {
client_data_hash,
rp: options.rp,
user: options.user,
pub_key_cred_params: options.pub_key_cred_params,
exclude_list: options.exclude_credentials.unwrap_or_default(),
options: req_options,
pin_uv_auth_param,
pin_uv_auth_proto,
enterprise_attest: None,
};
let ret = block_on(self.token.transmit(mc, self.ui_callback))?;
trace!(?ret);
// The obvious thing to do here would be to pass the raw authenticator
// data back, but it seems like everything expects a Map<String, Value>
// here, rather than a Map<u32, Value>... so we need to re-serialize
// that data!
//
// Alternatively, it may be possible to do this "more cheaply" by
// remapping the keys of the map.
let raw = serde_cbor_2::to_vec(&ret).map_err(|e| {
error!("MakeCredentialResponse re-serialization: {:?}", e);
WebauthnCError::Cbor
})?;
// HACK: parsing out the real ID is complicated, and other parts of the
// library will do it for us, so we'll put in empty data here.
let cred_id = vec![];
let id = String::new();
let type_ = ret.fmt.ok_or(WebauthnCError::InvalidAlgorithm)?;
Ok(RegisterPublicKeyCredential {
id,
raw_id: Base64UrlSafeData(cred_id),
type_,
extensions: RegistrationExtensionsClientOutputs::default(), // TODO
response: AuthenticatorAttestationResponseRaw {
attestation_object: Base64UrlSafeData(raw),
client_data_json: Base64UrlSafeData(vec![]),
// All transports the token supports, as opposed to the
// transport which was actually used.
transports: self.info.get_transports(),
},
})
}
fn perform_auth(
&mut self,
client_data_hash: Vec<u8>,
options: webauthn_rs_proto::PublicKeyCredentialRequestOptions,
_timeout_ms: u32,
) -> Result<webauthn_rs_proto::PublicKeyCredential, crate::prelude::WebauthnCError> {
trace!("trying to authenticate...");
let auth_token = block_on(self.get_pin_uv_auth_token(
client_data_hash.as_slice(),
Permissions::GET_ASSERTION,
Some(options.rp_id.clone()),
options.user_verification,
))?;
let req_options = if let AuthToken::UvTrue = auth_token {
// No pin_uv_auth_param, but verification is configured, so use it
Some(BTreeMap::from([("uv".to_owned(), true)]))
} else {
None
};
let (pin_uv_auth_proto, pin_uv_auth_param) = auth_token.into_pin_uv_params();
let ga = GetAssertionRequest {
rp_id: options.rp_id,
client_data_hash,
allow_list: options.allow_credentials,
options: req_options,
pin_uv_auth_param,
pin_uv_auth_proto,
};
trace!(?ga);
let ret = block_on(self.token.transmit(ga, self.ui_callback))?;
trace!(?ret);
let raw_id = ret
.credential
.as_ref()
.map(|c| c.id.to_owned())
.ok_or(WebauthnCError::Cbor)?;
let id = raw_id.to_string();
let type_ = ret
.credential
.map(|c| c.type_)
.ok_or(WebauthnCError::Cbor)?;
let signature = Base64UrlSafeData(ret.signature.ok_or(WebauthnCError::Cbor)?);
let authenticator_data = Base64UrlSafeData(ret.auth_data.ok_or(WebauthnCError::Cbor)?);
Ok(PublicKeyCredential {
id,
raw_id,
response: AuthenticatorAssertionResponseRaw {
authenticator_data,
client_data_json: Base64UrlSafeData(vec![]),
signature,
// TODO
user_handle: None,
},
// TODO
extensions: AuthenticationExtensionsClientOutputs::default(),
type_,
})
}
}
#[cfg(test)]
mod tests {
// TODO
}