Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: remove deprecated values #233

Merged
merged 1 commit into from
Apr 27, 2024
Merged

Conversation

james-d-elliott
Copy link
Member

@james-d-elliott james-d-elliott commented Apr 27, 2024

This removes all deprecated fields and functions from the library.

BREAKING CHANGE: the following fields and backwards compatible elements have been removed; Icon field from the CredentialEntity struct, WebAuthnIcon function from the User interface, RPIcon/RPOrigin/Timeout fields from the Config struct, Transports field from the CredentialCreationResponse (new field has existed in the AuthenticatorAttestationResponse struct for quite some time which matches the spec).

Summary by CodeRabbit

  • New Features
    • Enhanced security and data integrity in authentication processes by adding new credential and authentication response fields.
  • Refactor
    • Improved struct organization by reordering fields and removing deprecated ones to streamline data handling.
  • Bug Fixes
    • Removed outdated and unsupported fields and methods related to icons in credential entities, ensuring compliance with current standards.
  • Documentation
    • Updated test cases to reflect changes in credential handling and removed deprecated scenarios.

This removes all deprecated fields and functions from the library.

BREAKING CHANGE: the following fields and backwards compatible elements have been removed; Icon field from the CredentialEntity struct, WebAuthnIcon function from the User interface, RPIcon/RPOrigin/Timeout fields from the Config struct, Transports field from the CredentialCreationResponse (new field has existed in the AuthenticatorAttestationResponse struct for quite some time which matches the spec).
@james-d-elliott james-d-elliott requested a review from a team as a code owner April 27, 2024 07:05
Copy link

coderabbitai bot commented Apr 27, 2024

Walkthrough

The recent updates focus on enhancing the structure of various WebAuthn-related entities and responses, involving the addition of new fields related to public key credentials and authenticator data, while removing outdated fields such as Transports and Icon. This streamlines the handling of credential and attestation responses, aligning with current standards and simplifying the configuration and user interface components in the WebAuthn process.

Changes

File Path Change Summary
protocol/.../assertion.go Added fields related to public key credentials and authenticator data.
protocol/.../attestation.go Added new fields for detailed attestation response; moved Transports up.
protocol/.../credential.go Removed deprecated Transports field.
protocol/.../credential_test.go Removed test cases for deprecated transports.
protocol/.../entities.go Removed Icon from CredentialEntity; added ID to RelyingPartyEntity.
webauthn/.../registration.go Removed Icon field assignments in BeginRegistration.
webauthn/types.go Removed several fields and methods related to configuration and user interface.

🐰✨
In the fields of code, where the data hops around,
Changes come swift, without much sound.
No more icons, transports take flight,
Streamlined and sleek, through day and night.
Celebrate, dear friends, with a code so bright!
🌟🐇


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 482cf89 and d4fe6d0.
Files selected for processing (7)
  • protocol/assertion.go (2 hunks)
  • protocol/attestation.go (2 hunks)
  • protocol/credential.go (2 hunks)
  • protocol/credential_test.go (1 hunks)
  • protocol/entities.go (2 hunks)
  • webauthn/registration.go (1 hunks)
  • webauthn/types.go (4 hunks)
Files skipped from review due to trivial changes (3)
  • protocol/credential.go
  • protocol/credential_test.go
  • webauthn/registration.go
Additional comments not posted (7)
protocol/entities.go (2)

Line range hint 1-13: Removal of the Icon field aligns with the PR objectives to streamline the library by removing deprecated elements.


25-25: Addition of the ID field to RelyingPartyEntity enhances the ability to uniquely identify Relying Party entities, which is crucial for secure operations.

protocol/assertion.go (3)

18-18: Addition of PublicKeyCredential to CredentialAssertionResponse aligns with the PR objectives to enhance data handling and compliance with current standards.


26-26: Addition of ParsedPublicKeyCredential to ParsedCredentialAssertionData supports enhanced data handling by allowing for the parsing of public key credential data.


35-35: Addition of AuthenticatorData as URLEncodedBase64 to AuthenticatorAssertionResponse enhances the security and standardization of authenticator data handling.

webauthn/types.go (1)

Line range hint 1-1: Confirmed the removal of RPIcon, RPOrigin, and Timeout from the Config struct, and the WebAuthnIcon() method from the User interface, as per the PR objectives.

protocol/attestation.go (1)

25-32: Repositioning of the Transports field and addition of AuthenticatorData, PublicKey, and PublicKeyAlgorithm to AuthenticatorAttestationResponse enhance the struct's functionality and compliance with current standards.


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
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.

@james-d-elliott james-d-elliott merged commit f63fbc1 into master Apr 27, 2024
3 checks passed
@james-d-elliott james-d-elliott deleted the feat-remove-deprecations branch April 27, 2024 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant