Skip to content

Improve base64 comment, remove legacy go support #338

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

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

wxiaoguang
Copy link
Contributor

Found some easy fixes when reading the code.

  1. the comment in base64.go: it works correctly as the Golang's UnmarshalJSON mechanism
  2. remove protocol/webauthncose/ed25519_go112.go, Golang 1.12 is too old and it seems no test covers it now

Copy link

coderabbitai bot commented Nov 26, 2024

Walkthrough

This pull request includes modifications to the UnmarshalJSON method in the protocol/base64.go file, clarifying the trimming of leading and trailing double quotes from input data. Additionally, it removes the build constraint from the protocol/webauthncose/ed25519.go file, allowing it to be built with versions of Go earlier than 1.13. The file protocol/webauthncose/ed25519_go112.go has been deleted, which contained functionality related to Ed25519 public key encoding for Go versions prior to 1.13.

Changes

File Change Summary
protocol/base64.go Modified UnmarshalJSON method to clarify trimming of leading and trailing double quotes.
protocol/webauthncose/ed25519.go Removed build constraint //go:build go1.13, allowing for earlier Go versions.
protocol/webauthncose/ed25519_go112.go Deleted file containing Ed25519 public key encoding functionality, including related types and functions.

Possibly related PRs

  • refactor(webauthncose): to make it more readable and usable. #323: The changes in the verifyAndroidKeyFormat function in protocol/attestation_androidkey.go involve modifications to the handling of signature algorithms, which may relate to the overall structure and logic of the UnmarshalJSON method in the main PR, as both involve clarifying and refining code logic.

Suggested reviewers

  • james-d-elliott

🐇 In the code we trim and refine,
Quotes and logic intertwine.
Ed25519, now set free,
For all Go versions, come see!
With each change, we hop along,
Crafting code where we belong! 🐇


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 77b369a and a9aea93.

📒 Files selected for processing (3)
  • protocol/base64.go (1 hunks)
  • protocol/webauthncose/ed25519.go (0 hunks)
  • protocol/webauthncose/ed25519_go112.go (0 hunks)
💤 Files with no reviewable changes (2)
  • protocol/webauthncose/ed25519.go
  • protocol/webauthncose/ed25519_go112.go
🔇 Additional comments (1)
protocol/base64.go (1)

25-26: LGTM! The comment accurately reflects the implementation's behavior

The updated comment correctly describes that the code trims quotes from the JSON value, which is the expected behavior for implementing json.Unmarshaler. This is correct because:

  1. JSON strings are always wrapped in double quotes
  2. The raw JSON data needs to be stripped of these quotes before base64 decoding
  3. This implementation properly handles the JSON string format while maintaining compatibility with Go's JSON unmarshaling mechanism

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

@wxiaoguang wxiaoguang changed the title Improve base64 comme,t remove legacy go support Improve base64 commet, remove legacy go support Nov 26, 2024
@wxiaoguang wxiaoguang changed the title Improve base64 commet, remove legacy go support Improve base64 comment, remove legacy go support Nov 26, 2024
Copy link
Member

@james-d-elliott james-d-elliott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Also yeah as we're a security-focused library we only support versions of go that are officially supported by the go team.

@james-d-elliott james-d-elliott merged commit 0cd5289 into go-webauthn:master Nov 26, 2024
3 of 4 checks passed
@wxiaoguang wxiaoguang deleted the fix-simple branch November 26, 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.

2 participants