feat: webauthn level 3

[james-d-elliott]

Summary by CodeRabbit

• New Features

  • Introduced a new function for handling credential type hints during login.
  • Added multiple new functions to enhance WebAuthn registration options, such as handling credential parameters, exclusions, and authenticator selections.

• Refactor

  • Updated type handling across various functions for consistency and improved type safety in JWT and certificate processing.
  • Removed outdated login options related to conveyance preferences and attestation formats, replacing them with more relevant functionalities.

• Bug Fixes

  • Enhanced the handling of resident key requirements in registration options to improve reliability.

• Documentation

  • Updated internal documentation to reflect changes in function signatures and type definitions.

[coderabbitai]

Walkthrough

The recent modifications across various Go files primarily involve transitioning from interface{} to any to enhance type handling in JWT and certificate processing. This change is complemented by the introduction of new functions and the removal of some, aiming to refine the functionality around WebAuthn's login and registration processes. These adjustments ensure more robust and type-safe code operations.

Changes

Files	Change Summary
metadata/metadata.go, protocol/attestation.go, webauthn/.../webauthncose.go	Updated type usage from interface{} to any for better type handling.
protocol/attestation.go	Updated AttestationObject and various attestation format verification functions.
webauthn/login.go, webauthn/registration.go	Introduced new functions and options for handling WebAuthn login and registration processes more effectively.

🐰✨
A hop, a skip, a code deploy,
From interface{} to any, oh boy!
Type-safety here, better handling there,
WebAuthn tweaks with utmost care.
Celebrate the changes, large and small,
In the world of code, we hop tall! 🌟🐾

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0c97761 and 6722d0e.

Files selected for processing (29)

• metadata/metadata.go (2 hunks)
• protocol/assertion.go (1 hunks)
• protocol/assertion_test.go (3 hunks)
• protocol/attestation.go (1 hunks)
• protocol/attestation_androidkey.go (3 hunks)
• protocol/attestation_androidkey_test.go (1 hunks)
• protocol/attestation_apple.go (1 hunks)
• protocol/attestation_apple_test.go (2 hunks)
• protocol/attestation_packed.go (4 hunks)
• protocol/attestation_packed_test.go (1 hunks)
• protocol/attestation_safetynet.go (4 hunks)
• protocol/attestation_safetynet_test.go (2 hunks)
• protocol/attestation_test.go (1 hunks)
• protocol/attestation_tpm.go (2 hunks)
• protocol/attestation_tpm_test.go (8 hunks)
• protocol/attestation_u2f.go (2 hunks)
• protocol/attestation_u2f_test.go (2 hunks)
• protocol/authenticator.go (3 hunks)
• protocol/challenge_test.go (1 hunks)
• protocol/client.go (1 hunks)
• protocol/credential.go (2 hunks)
• protocol/credential_test.go (1 hunks)
• protocol/entities.go (1 hunks)
• protocol/extensions.go (1 hunks)
• protocol/options.go (5 hunks)
• protocol/webauthncbor/webauthncbor.go (2 hunks)
• protocol/webauthncose/webauthncose.go (2 hunks)
• webauthn/login.go (2 hunks)
• webauthn/registration.go (5 hunks)

Files not reviewed due to errors (2)

• protocol/attestation.go (no review received)
• protocol/attestation_packed_test.go (no review received)

Files skipped from review due to trivial changes (1)

• protocol/attestation_androidkey.go

Additional comments not posted (35)

protocol/extensions.go (1)

8-8: Change from interface{} to any enhances type clarity and maintainability.

Ensure that all components interacting with AuthenticationExtensionsClientOutputs are compatible with this change.

protocol/webauthncbor/webauthncbor.go (1)

21-21: Change from interface{} to any is consistent with PR objectives to improve type handling.

protocol/attestation_u2f_test.go (1)

23-23: Change to use []any aligns with PR objectives. However, verify the usage of want1 in tests, as it appears to be unused.

protocol/attestation_apple_test.go (1)

23-23: Change to use []any aligns with PR objectives. However, verify the usage of want1 in tests, as it appears to be unused.

protocol/attestation_apple.go (1)

34-34: Comprehensive handling of Apple attestation format with detailed error checks and clear step-by-step processing.

protocol/attestation_u2f.go (1)

19-19: Comprehensive handling of U2F attestation format with detailed error checks and clear step-by-step processing.

protocol/attestation_safetynet.go (4)

27-27: The use of any for ApkCertificateDigestSha256 is consistent with the PR's objective to enhance type handling by replacing interface{} with any.

---

43-43: Ensure that the verifySafetyNetFormat function is thoroughly tested, especially since it handles critical security checks and has been modified to use any type.

---

76-76: The JWT parsing logic here is crucial. Ensure that the type assertions and handling of any types are robust to prevent runtime panics.

---

111-111: The certificate chain parsing and verification are critical. It's important to ensure that the new any type usage does not introduce any regressions or type mismatches during runtime.

protocol/assertion.go (1)

164-164: The use of any for handling the parsed public key in ParseCredentialRequestResponseBody aligns with the PR's objective to enhance type handling.

protocol/attestation_androidkey_test.go (1)

25-25: The use of any in test cases for expected results is consistent with the changes in the main implementation of verifyAndroidKeyFormat.

protocol/client.go (1)

23-23: The addition of TopOrigin and CrossOrigin fields to CollectedClientData enhances the robustness of origin verification in client data.

protocol/assertion_test.go (1)

50-50: The use of any for ClientExtensionResults in test cases aligns with the changes in the main implementation of ParseCredentialRequestResponse.

webauthn/registration.go (7)

32-32: Consider using a type switch or type assertion for entityUserID to ensure type safety.

This would help in maintaining robustness especially when dealing with type conversions in a dynamic language like Go.

---

96-100: LGTM! The function WithCredentialParameters correctly modifies the credential parameters.

---

103-107: LGTM! The function WithExclusions correctly modifies the credential exclusion list.

---

118-128: LGTM! The function WithResidentKeyRequirement correctly sets the resident key requirements based on the provided requirement.

---

132-138: LGTM! The function WithPublicKeyCredentialHints correctly adjusts the hints for credential types.

---

141-143: LGTM! The function WithConveyancePreference correctly adjusts the conveyance preference.

---

149-152: LGTM! The function WithAttestationFormats correctly adjusts the attestation formats.

protocol/attestation_packed.go (3)

37-37: The function signature correctly uses []any for type consistency as intended in the PR.

---

75-75: The function signature correctly uses []any for the x5c parameter, aligning with the PR's type consistency goal.

---

206-206: The function correctly handles self attestation with detailed error handling and robust verification processes.

protocol/attestation_safetynet_test.go (1)

24-24: The test function correctly uses []any for the expected result type, aligning with the PR's type consistency goal.

protocol/attestation_test.go (2)

23-23: The test function is structured appropriately for attestation verification, with robust setup and error handling.

---

29-29: The test function correctly handles the packed attestation verification process, with detailed setup and robust error handling.

protocol/options.go (4)

20-34: Added new fields Hints and AttestationFormats to PublicKeyCredentialCreationOptions.

Ensure that these new fields are properly documented and integrated into the system, considering their impact on existing functionalities.

---

49-49: Added Hints field to PublicKeyCredentialRequestOptions.

This addition aligns with the PR's objective to enhance type consistency and handling. Confirm that this field is utilized appropriately in the system.

---

188-223: Updated and expanded the AttestationFormat enumeration.

This change supports a wider range of attestation formats, potentially improving the system's flexibility and compliance with WebAuthn Level 3 standards.

---

225-252: Introduced PublicKeyCredentialHints enumeration.

This addition likely enhances the system's ability to provide more tailored authentication experiences based on the hint provided. Ensure compatibility with older user agents as mentioned in the comments.

protocol/attestation_tpm_test.go (4)

Line range hint 86-126: The added test cases enhance the robustness of the attestation verification process by covering various error scenarios.

---

336-336: The dynamic construction of test cases based on key type and the subsequent verification logic are correctly implemented.

---

377-377: The test cases for verifying error handling in the 'certInfo' field are well-implemented and improve the test coverage.

---

Line range hint 491-561: The test cases for handling errors in the 'x5c' field are correctly implemented, enhancing the verification process's reliability.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 5

Out of diff range and nitpick comments (11)

protocol/webauthncbor/webauthncbor.go (1)

21-21: TODO comment suggests further investigation is needed. Consider creating a task or issue to track this.

protocol/credential.go (4)

34-34: Consider adding a comment for PublicKeyCredential to explain its purpose and usage.

---

42-42: Consider adding a comment for ParsedPublicKeyCredential to explain its purpose and usage.

---

50-50: Consider adding a comment for CredentialCreationResponse to explain its purpose and usage.

---

62-62: Consider adding a comment for ParsedCredentialCreationData to explain its purpose and usage.

protocol/attestation_tpm.go (1)

22-22: Consider adding a comment for verifyTPMFormat to explain its purpose and usage.

webauthn/login.go (1)

118-123: Consider adding a comment for WithAssertionPublicKeyCredentialHints to explain its purpose and usage.

protocol/webauthncose/webauthncose.go (1)

345-345: Consider adding a comment for VerifySignature to explain its purpose and usage.

protocol/authenticator.go (1)

138-141: Add documentation for the SmartCard AuthenticatorTransport.

It's good practice to include a brief description for each constant, especially for public APIs. This helps developers understand the context and usage of the constants without needing to refer to external documentation.

protocol/attestation_tpm_test.go (1)

34-34: Consider adding a comment explaining the hardcoded attestation type "attca" for clarity.

metadata/metadata.go (1)

Line range hint 551-603: Consider refining the error handling in unmarshalMDSBLOB.

The function unmarshalMDSBLOB parses JWT tokens and handles certificate chains. However, the error handling could be improved. Specifically, the function should handle the case where the JWT token is malformed or the certificate chain is invalid more gracefully. Consider adding more specific error messages and handling potential nil pointer dereferences that could occur if the JWT token does not contain expected headers.