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(torii): offchain messages signature validation on first set #2390

Merged

Conversation

edisontim
Copy link
Contributor

@edisontim edisontim commented Sep 6, 2024

Description

When an offchain message is sent to Torii and in the case the entity isn't present in the DB yet, the signature of the message isn't checked.
This assumes that the signature is valid for that address which might not be the case if someone is using an account address that doesn't match the private key he used to sign the message.

It could present some risks in some cases: in haiku we use a private key linked to an address when sending prompts to Torii. The keys of these offchain messages change for every prompt so their signature will never be checked. In that case, anyone could send any message that would be interpreted by our frontend as a prompt signed by us and display it to the user.

Related issue

N/A

Summary by CodeRabbit

  • New Features

    • Improved handling of entity identities within the Relay implementation, enhancing robustness and error management.
    • Introduced a new method for extracting and validating identities from message types.
  • Bug Fixes

    • Enhanced error logging for identity parsing failures, ensuring better visibility into issues.

Copy link

coderabbitai bot commented Sep 6, 2024

Walkthrough

Ohayo, sensei! The changes involve a restructuring of the identity handling logic within the Relay implementation. The code now verifies the presence and validity of entity_identity more rigorously. It introduces a new function to extract and validate identity from message types, enhancing error handling. Additionally, a modification to the calldata vector has been made, indicating a potential update in the data structure for message management.

Changes

Files Change Summary
crates/torii/libp2p/src/server/mod.rs Improved handling of entity_identity with structured checks and a new function get_identity_from_ty. Added Felt::from(data.signature.len()) to calldata.

Sequence Diagram(s)

sequenceDiagram
    participant Relay
    participant Message
    participant Identity

    Relay->>Message: Check entity_identity
    alt entity_identity is Some(identity)
        Relay->>Identity: Parse identity
        alt Parsing successful
            Relay->>Relay: Set entity
        else Parsing failed
            Relay->>Relay: Log warning
        end
    else entity_identity is None
        Relay->>Message: Retrieve identity from ty
        Relay->>Identity: Validate identity
        alt Validation successful
            Relay->>Relay: Set entity
        else Validation failed
            Relay->>Relay: Return error
        end
    end
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 47dc53f and bf5de60.

Files selected for processing (1)
  • crates/torii/libp2p/src/server/mod.rs (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • crates/torii/libp2p/src/server/mod.rs

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

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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

crates/torii/libp2p/src/server/mod.rs Show resolved Hide resolved
crates/torii/libp2p/src/server/mod.rs Outdated Show resolved Hide resolved
@edisontim edisontim changed the title fix: Offchain messages verification on first set fix: Offchain messages signature validation on first set Sep 6, 2024
Copy link
Collaborator

@glihm glihm left a comment

Choose a reason for hiding this comment

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

@edisontim thanks a lot for tackling that man, as we've discussed, it was a potential security issue.

Some comments with few changes, and let's merge. :)

crates/torii/libp2p/src/server/mod.rs Outdated Show resolved Hide resolved
crates/torii/libp2p/src/server/mod.rs Outdated Show resolved Hide resolved
@glihm glihm changed the title fix: Offchain messages signature validation on first set fix(torii): offchain messages signature validation on first set Sep 6, 2024
Copy link

codecov bot commented Sep 6, 2024

Codecov Report

Attention: Patch coverage is 62.06897% with 11 lines in your changes missing coverage. Please review.

Project coverage is 68.37%. Comparing base (c7ffa0b) to head (bf5de60).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
crates/torii/libp2p/src/server/mod.rs 62.06% 11 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2390      +/-   ##
==========================================
+ Coverage   68.30%   68.37%   +0.07%     
==========================================
  Files         357      357              
  Lines       47181    47188       +7     
==========================================
+ Hits        32225    32267      +42     
+ Misses      14956    14921      -35     

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

Copy link
Collaborator

@glihm glihm left a comment

Choose a reason for hiding this comment

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

Thanks for the update @edisontim!

@glihm glihm merged commit dd4cd5f into dojoengine:main Sep 6, 2024
14 of 15 checks passed
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