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

feat:[PLG-598] Burp Suite Plugin #2277

Merged
merged 2 commits into from
Jun 25, 2024
Merged

Conversation

akashpaladin
Copy link
Collaborator

@akashpaladin akashpaladin commented Jun 23, 2024

PLG-598

Description

Please include a summary of the changes and the related issues. Please also include relevant motivation and context. List
any dependencies that are required for this change.

Problem

Solution

Fixes # (issue if any)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Chore (no code changes)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also
list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • My code follows the style guidelines of this project
  • My commit message/PR follows the contribution guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Other Information:

List any documentation updates that are needed for the Wiki

Summary by CodeRabbit

  • New Features
    • Added support for the "burpsuite" plugin in the configuration settings.

Copy link

coderabbitai bot commented Jun 23, 2024

Warning

Rate limit exceeded

@akashpaladin has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 7 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 88f7540 and e8cc6ce.

Walkthrough

The recent changes involve updating a SQL query in the DB.sql file to include "burpsuite" as an additional plugin in the plugins.in.v1 configuration key. This update ensures that the new plugin is included in the existing list and is correctly updated if the key already exists in the database.

Changes

File Path Change Summary
installer/resources/pacbot_app/files/DB.sql Updated INSERT INTO pac_config_properties query to include "burpsuite" in the plugins.in.v1 configuration key with ON DUPLICATE KEY UPDATE logic.

Poem

In the garden of code, a change did bloom,
Now "burpsuite" joins the plugin room.
A tweak, a nudge, data flows anew,
Configs updated, the system grew.
Let's celebrate with hops of joy,
For every update, a better deploy! 🌸🐇


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

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 01060f4 and b1339f3.

Files selected for processing (1)
  • installer/resources/pacbot_app/files/DB.sql (1 hunks)
Additional comments not posted (2)
installer/resources/pacbot_app/files/DB.sql (2)

3125-3125: SQL Statement for Plugin Configuration Updated Correctly

The SQL statement has been correctly updated to include the "burpsuite" plugin in the configuration. This change aligns with the PR's objectives and follows the correct SQL syntax.


3125-3125: Incomplete SQL Statement

The SQL statement for cf_Target is incomplete and does not show any modifications. There is no action required unless the entire statement is provided.

Copy link
Collaborator

@santhosh-challa santhosh-challa left a comment

Choose a reason for hiding this comment

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

@akashpaladin @arunpaladin @plyubich Should we move this to EE instead?

plyubich
plyubich previously approved these changes Jun 24, 2024
@akashpaladin
Copy link
Collaborator Author

@akashpaladin @arunpaladin @plyubich Should we move this to EE instead?

@santhosh-challa We cannot move it completely and we need to keep Plugins that are available to CE here, can we do it in separate ticket?

arunpaladin
arunpaladin previously approved these changes Jun 25, 2024
arunpaladin
arunpaladin previously approved these changes Jun 25, 2024
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 details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b1339f3 and a6fc1b1.

Files selected for processing (1)
  • installer/resources/pacbot_app/files/DB.sql (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • installer/resources/pacbot_app/files/DB.sql

arunpaladin
arunpaladin previously approved these changes Jun 25, 2024
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 details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a6fc1b1 and 88f7540.

Files selected for processing (1)
  • installer/resources/pacbot_app/files/DB.sql (1 hunks)
Additional comments not posted (2)
installer/resources/pacbot_app/files/DB.sql (2)

Line range hint 1-2: Review the use of INSERT IGNORE.

Using INSERT IGNORE is generally safe for non-critical data, but it could mask problems such as duplicate keys or other integrity issues. Ensure that this behavior is acceptable for the pac_v2_ui_options table.


Line range hint 4-4: Validate JSON string in SQL statement.

The SQL statement includes a JSON string in the targetConfig field. It's crucial to ensure this JSON is correctly formatted to prevent runtime errors.

Verification successful

The provided JSON string in the targetConfig field is correctly formatted. The next step is to ensure the overall consistency and correctness of the SQL statement and its alignment with the schema of the cf_Target table. Let's review the SQL statement structure and verify the schema of the cf_Target table.


The partial SQL insert statement for the cf_Target table is available, but we still need the complete schema definition to ensure consistency and correctness.


The command to extract the schema definition of the cf_Target table did not produce any output. Let's broaden the search to locate the cf_Target table definition.


The SQL insert statement for the cf_Target table is correctly structured and consistent with the table schema. The JSON string in the targetConfig field is correctly formatted as well.

  • SQL Insert Statement: The fields in the SQL insert statement (targetName, targetDesc, category, dataSourceName, targetConfig, status, userId, endpoint, createdDate, modifiedDate, domain, displayName) are consistent with the schema definition of the cf_Target table.

  • JSON String: The JSON string provided in the targetConfig field is correctly formatted.

Thus, no issues are found with the SQL statement.


Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Validate JSON format in the `targetConfig` field.

# Test: Extract JSON string and validate its format. Expect: No errors.
echo '{"key":"id","id":"id","name":"name"}' | jq .

Length of output: 102



Script:

#!/bin/bash
# Description: Extract and review the SQL statement related to `cf_Target` and the schema of the `cf_Target` table.

# Extract the SQL statement from the specified lines.
sed -n '3120,3125p' installer/resources/pacbot_app/files/DB.sql

# Extract the schema definition of the `cf_Target` table.
sed -n '/CREATE TABLE cf_Target/,/);/p' installer/resources/pacbot_app/files/DB.sql

Length of output: 822



Script:

#!/bin/bash
# Description: Extract and review the complete schema definition of the `cf_Target` table.

# Extract the schema definition of the `cf_Target` table.
sed -n '/CREATE TABLE `cf_Target`/,/);/p' installer/resources/pacbot_app/files/DB.sql

Length of output: 87



Script:

#!/bin/bash
# Description: Broadly search for the schema definition of the `cf_Target` table.

# Use ripgrep to search for the `cf_Target` table definition in the SQL file.
rg 'CREATE TABLE.*cf_Target' -A 20 installer/resources/pacbot_app/files/DB.sql

Length of output: 915

Copy link

sonarcloud bot commented Jun 25, 2024

@akashpaladin akashpaladin merged commit 324a84c into master Jun 25, 2024
59 checks passed
@akashpaladin akashpaladin deleted the feat/plg-598-burpsuite-plugin branch June 25, 2024 11:48
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

4 participants