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

DOS - Detector #2402

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

DOS - Detector #2402

wants to merge 14 commits into from

Conversation

vijayarawat19
Copy link

@vijayarawat19 vijayarawat19 commented Apr 6, 2024

Created a new dos vulnerability detector

Summary by CodeRabbit

  • New Features
    • Introduced a new DOSDetector to identify potential Denial of Service (DoS) vulnerabilities in Solidity contracts.
  • Tests
    • Added tests for the new DOSDetector using a Solidity smart contract example.
  • Chores
    • Updated the Python version used in the documentation generation workflow from 3.8 to 3.10.

Copy link

coderabbitai bot commented Apr 6, 2024

Walkthrough

Enhancing security in smart contract development, a new feature introduces the DOSDetector class to detect Denial of Service (DoS) vulnerabilities. This includes a test contract DOSVulnerableContract and an update to Python version 3.10 for documentation generation.

Changes

File Path Summary
slither/detectors/all_detectors.py Added import statement for DOSDetector.
slither/detectors/functions/dos_detector.py Introduced DOSDetector class for detecting DoS vulnerabilities.
tests/e2e/detectors/test_data/.../dos_detect.sol Added DOSVulnerableContract with an infinite loop for DOSDetector testing.
tests/e2e/detectors/test_detectors.py Included a test for DOSDetector using dos_detect.sol.
.github/workflows/docs.yml Updated Python version from 3.8 to 3.10 for documentation generation workflow.

🐇✨
In the realm of code, where the smart contracts play,
A new sentinel arises, to keep the chaos at bay.
With a hop and a skip, the DOSDetector takes the floor,
Searching through loops, where exits are no more.
So here's to the guardians, in bytes and in bits,
Keeping our contracts safe, from infinite pits.
🌟🐾


Recent Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 17cd25c and 09bae2f.
Files selected for processing (1)
  • slither/detectors/functions/dos_detector.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • slither/detectors/functions/dos_detector.py

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.

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: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 13d7d9f and 3a328af.
Files ignored due to path filters (1)
  • tests/e2e/detectors/test_data/dosdetector/0.6.11/dos_detect.sol-0.6.11.zip is excluded by !**/*.zip
Files selected for processing (4)
  • slither/detectors/all_detectors.py (1 hunks)
  • slither/detectors/functions/dos_detector.py (1 hunks)
  • tests/e2e/detectors/test_data/dosdetector/0.6.11/dos_detect.sol (1 hunks)
  • tests/e2e/detectors/test_detectors.py (1 hunks)
Additional comments not posted (5)
tests/e2e/detectors/test_data/dosdetector/0.6.11/dos_detect.sol (1)

1-11: LGTM! This contract correctly implements an infinite loop to demonstrate a potential DoS vulnerability, serving as a valid test case for the DOSDetector.

slither/detectors/functions/dos_detector.py (2)

15-37: Consider adding more detailed comments to the utility functions, especially detect_infinite_calls, to explain the traversal logic and how infinite loops are detected. This will improve code readability and maintainability.


50-80: LGTM! The DOSDetector class is well-implemented, with clear documentation and appropriate metadata. The detection logic is sound, and the use of wiki links for further information is a good practice.

slither/detectors/all_detectors.py (1)

14-14: LGTM! The addition of DOSDetector to the list of detectors is correctly implemented and follows the established pattern for importing detectors.

tests/e2e/detectors/test_detectors.py (1)

75-79: LGTM! The test case for the DOSDetector is correctly added and follows the established conventions for adding new tests. It properly specifies the detector, test file, and Solidity version.

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: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3a328af and 4028c19.
Files selected for processing (2)
  • slither/detectors/all_detectors.py (1 hunks)
  • tests/e2e/detectors/test_detectors.py (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • slither/detectors/all_detectors.py
  • tests/e2e/detectors/test_detectors.py

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: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4028c19 and ad89720.
Files selected for processing (1)
  • slither/detectors/functions/dos_detector.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • slither/detectors/functions/dos_detector.py

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: 6

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ad89720 and b0bda35.
Files selected for processing (1)
  • slither/detectors/functions/dos_detector.py (1 hunks)
Additional comments not posted (3)
slither/detectors/functions/dos_detector.py (3)

11-17: LGTM! Efficient use of recursion for detecting infinite loops.


19-31: LGTM! Proper handling of recursion and loop detection.


46-72: LGTM! The DOSDetector class is well-implemented and integrates effectively with the detection framework.

slither/detectors/functions/dos_detector.py Outdated Show resolved Hide resolved
slither/detectors/functions/dos_detector.py Outdated Show resolved Hide resolved
slither/detectors/functions/dos_detector.py Outdated Show resolved Hide resolved
slither/detectors/functions/dos_detector.py Outdated Show resolved Hide resolved
slither/detectors/functions/dos_detector.py Outdated Show resolved Hide resolved
slither/detectors/functions/dos_detector.py Outdated Show resolved Hide resolved
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: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b0bda35 and 6298cdc.
Files selected for processing (1)
  • .github/workflows/docs.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/docs.yml

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: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6298cdc and e3c1971.
Files selected for processing (1)
  • slither/detectors/functions/dos_detector.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • slither/detectors/functions/dos_detector.py

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.

None yet

1 participant