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(logic)!: remove unsafe prolog predicates from registry #710

Merged
merged 1 commit into from
Jul 26, 2024

Conversation

amimart
Copy link
Member

@amimart amimart commented Jul 26, 2024

Closes #624
Closes #617
Closes #336

Purpose

This PR aims to make the logic module prolog vm finally safe, by removing unsafe predicates from the registry. By doing so they cannot be added even through a governance proposal.

The idea is to expose through the registry only safe to use predicates.

Details

Since the recent changes in the VM I was honestly quite disappointed to discover only 2 unsafe predicates 😅. AFAIS previously suspected predicates have all been fixed by the improved VM.

Here are the removed predicates:

  • halt/1: Make a node to halt, if used in the context of a transaction the network is stopped;
  • set_prolog_flag/2: This one doesn't seem really unsafe to me regarding the flags we are able to change, but the intent of changing the VM's behaviour (e.g. enable debug mode) is not desirable to me;

Let me know if you have any other potentially unsafe predicates in mind.

Summary by CodeRabbit

  • New Features

    • Updated the interpreter's registry for enhanced functionality by removing specific commands, streamlining the available options for users.
  • Bug Fixes

    • Addressed potential runtime errors by removing access to deprecated functions, improving overall stability of the interpreter.

Copy link
Contributor

coderabbitai bot commented Jul 26, 2024

Walkthrough

The recent changes in the codebase involve the removal of two Prolog predicates, "set_prolog_flag/2" and "halt/1", from the interpreter's registry. This adjustment is part of an effort to enhance security and streamline functionality, addressing concerns about potential misuse that could lead to operational disruptions in the blockchain environment.

Changes

Files Change Summary
x/logic/interpreter/registry.go Removed entries for {"set_prolog_flag/2", engine.SetPrologFlag} and {"halt/1", engine.Halt}.

Assessment against linked issues

Objective Addressed Explanation
Remove halt/1 to prevent potential DOS risks (✅ #624)
Address security concerns linked to halt/1 and non-deterministic predicates (✅ #617, #336)

Poem

🐇 In the garden where logic blooms bright,
Two predicates vanished, making things right.
No more halting, just smooth, steady flow,
Our blockchain hops high, with each leap we grow!
A safer path now, with each line we write,
A dance of the code, under moon's gentle light. 🌙


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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@amimart amimart self-assigned this Jul 26, 2024
Copy link

codecov bot commented Jul 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #710   +/-   ##
=======================================
  Coverage   54.42%   54.42%           
=======================================
  Files          73       73           
  Lines        2901     2901           
=======================================
  Hits         1579     1579           
  Misses       1228     1228           
  Partials       94       94           

@amimart amimart marked this pull request as ready for review July 26, 2024 10:29
@amimart amimart requested review from bdeneux and ccamel July 26, 2024 10:29
Copy link
Contributor

@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 details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6f266e9 and 293da10.

Files selected for processing (1)
  • x/logic/interpreter/registry.go (1 hunks)
Additional comments not posted (3)
x/logic/interpreter/registry.go (3)

Line range hint 89-139:
Verify the Register function.

Ensure that the removal of set_prolog_flag/2 and halt/1 does not affect the functionality of the Register function.

Verification successful

Verification successful.

The removal of set_prolog_flag/2 and halt/1 does not affect the functionality of the Register function as these predicates are not used within it.

  • set_prolog_flag/2 was not found in the codebase.
  • halt/1 was only found in test files, indicating it does not impact the Register function.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the removal of `set_prolog_flag/2` and `halt/1` does not affect the functionality of the `Register` function.

# Test: Search for `set_prolog_flag/2` in the `Register` function. Expect: No occurrences.
rg --type python -A 5 $'set_prolog_flag/2'

# Test: Search for `halt/1` in the `Register` function. Expect: No occurrences.
rg --type python -A 5 $'halt/1'

Length of output: 134


Script:

#!/bin/bash
# Description: Verify that the removal of `set_prolog_flag/2` and `halt/1` does not affect the functionality of the `Register` function.

# Test: Search for `set_prolog_flag/2` in the Go files. Expect: No occurrences.
rg --type go -A 5 $'set_prolog_flag/2'

# Test: Search for `halt/1` in the Go files. Expect: No occurrences.
rg --type go -A 5 $'halt/1'

Length of output: 1021


Line range hint 80-85:
Verify the RegistryNames variable.

Ensure that the removal of set_prolog_flag/2 and halt/1 is reflected in the RegistryNames variable.

Verification successful

Verification successful: set_prolog_flag/2 and halt/1 are not present in the RegistryNames variable.

The predicates set_prolog_flag/2 and halt/1 have been successfully removed from the RegistryNames variable in the x/logic/interpreter/registry.go file.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that `set_prolog_flag/2` and `halt/1` are not present in the `RegistryNames` variable.

# Test: Search for `set_prolog_flag/2` in the `RegistryNames` variable. Expect: No occurrences.
rg --type python -A 5 $'set_prolog_flag/2'

# Test: Search for `halt/1` in the `RegistryNames` variable. Expect: No occurrences.
rg --type python -A 5 $'halt/1'

Length of output: 134


Script:

#!/bin/bash
# Description: Verify that `set_prolog_flag/2` and `halt/1` are not present in the `RegistryNames` variable.

# Test: Search for `set_prolog_flag/2` in the `RegistryNames` variable. Expect: No occurrences.
rg --type go -A 5 $'set_prolog_flag/2'

# Test: Search for `halt/1` in the `RegistryNames` variable. Expect: No occurrences.
rg --type go -A 5 $'halt/1'

Length of output: 1021


Script:

#!/bin/bash
# Description: Verify that `set_prolog_flag/2` and `halt/1` are not present in the `RegistryNames` variable in the registry.go file.

# Test: Search for `set_prolog_flag/2` in the `RegistryNames` variable within the registry.go file. Expect: No occurrences.
rg --type go -A 5 $'set_prolog_flag/2' x/logic/interpreter/registry.go

# Test: Search for `halt/1` in the `RegistryNames` variable within the registry.go file. Expect: No occurrences.
rg --type go -A 5 $'halt/1' x/logic/interpreter/registry.go

Length of output: 128


Line range hint 13-13:
Verify the removal of set_prolog_flag/2 and halt/1.

Ensure that the removal of these predicates aligns with the objectives of the PR and does not introduce any issues. Verify that these predicates are not used elsewhere in the codebase.

Copy link
Contributor

@bdeneux bdeneux left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@amimart amimart merged commit 963f560 into main Jul 26, 2024
20 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
3 participants