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

Fix decoding failure from large doxm.sct value and improve error messages #499

Merged
merged 2 commits into from
Sep 27, 2024

Conversation

lubo-svk
Copy link
Collaborator

@lubo-svk lubo-svk commented Sep 27, 2024

The default value of doxm.sct set by iotivity-lite can be larger than uint8 which leads to a failed decoding of Doxm resource.
I have found out that this default doxm config set by IoTivity-Lite https://github.com/iotivity/iotivity-lite/blob/master/security/oc_doxm.c#L231 could result in the sct=457. As the sct is in the scheme uint8 the decoding fails.

I have also extended the error message as it can save a lot of time in future by providing what exactly went wrong.

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling in the decoding process, providing more context on failures for better debugging.
  • New Features

    • Expanded the range of values for CredentialType by changing its data type from uint8 to uint16.

… uint8 which leads to a failed decoding of Doxm resource.
Copy link

coderabbitai bot commented Sep 27, 2024

Walkthrough

The changes include modifications to the error handling in the Decode method of the VNDOCFCBORCodec struct, enhancing the error message to include the original error context. Additionally, the CredentialType type definition has been updated from uint8 to uint16, allowing for a broader range of values. These changes improve debugging capabilities and expand the representation of credential types.

Changes

Files Change Summary
pkg/codec/ocf/codec.go Enhanced error handling in Decode method to include original error context.
schema/credential/credential.go Changed CredentialType from uint8 to uint16, allowing for a larger range of values.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant VNDOCFCBORCodec
    participant Decoder

    Client->>VNDOCFCBORCodec: Call Decode()
    VNDOCFCBORCodec->>Decoder: Attempt to decode
    Decoder-->>VNDOCFCBORCodec: Return error
    VNDOCFCBORCodec-->>Client: Return enhanced error message
Loading

🐇 "In the code where errors may dwell,
A message now tells the tale so well.
With types that grow, like carrots in rows,
Our changes bring clarity, as everyone knows!"
🌱


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5c3cfb7 and c9cf159.

📒 Files selected for processing (1)
  • schema/credential/credential.go (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • schema/credential/credential.go

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.

Copy link

sonarcloud bot commented Sep 27, 2024

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.78%. Comparing base (cc07b73) to head (c9cf159).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #499   +/-   ##
=======================================
  Coverage   76.78%   76.78%           
=======================================
  Files         122      122           
  Lines        7236     7236           
=======================================
  Hits         5556     5556           
  Misses       1090     1090           
  Partials      590      590           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jkralik jkralik changed the title The default value of doxm.sct set by iotivity-lite can be larger than… Fix decoding failure from large doxm.sct value and improve error messages Sep 27, 2024
@jkralik jkralik merged commit 4187ed3 into main Sep 27, 2024
15 checks passed
@jkralik jkralik deleted the bugfix/invalid_doxm_sct_decoding branch September 27, 2024 11:01
lubo-svk added a commit that referenced this pull request Oct 3, 2024
… 255 (#499)

* The default value of doxm.sct set by iotivity-lite can be larger than uint8 which leads to a failed decoding of Doxm resource.
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.

3 participants