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

set headers for fuzzing request #5988

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Conversation

dogancanbakir
Copy link
Member

@dogancanbakir dogancanbakir commented Jan 15, 2025

Proposed changes

Closes #5983

Checklist

  • Pull request is created against the dev branch
  • All checks passed (lint, unit/integration/regression tests etc.) with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Summary by CodeRabbit

  • New Features
    • Enhanced HTTP request header management with a new method for adding headers to requests.

@dogancanbakir dogancanbakir self-assigned this Jan 15, 2025
@auto-assign auto-assign bot requested a review from dwisiswant0 January 15, 2025 10:45
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces a new method addHeadersToRequest in the Request struct within the HTTP protocol fuzzing implementation. This method centralizes the logic for adding headers to HTTP requests during fuzzing operations. It is designed to be called in two scenarios: when a full HTTP request is provided and when only a URL is available. The change aims to improve code reusability and clarity in header management during fuzzing processes.

Changes

File Change Summary
pkg/protocols/http/request_fuzz.go Added addHeadersToRequest method to Request struct to centralize header addition logic

Assessment against linked issues

Objective Addressed Explanation
Set custom headers in DAST fuzzing templates [#5983]

Poem

🐰 Hop, hop, headers now in place,
A fuzzy dance with coding grace!
Request headers, neat and tight,
Nuclei's magic takes its flight!
Code refactored with rabbit's might! 🚀

Finishing Touches

  • 📝 Generate Docstrings (Beta)

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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
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: 1

🧹 Nitpick comments (1)
pkg/protocols/http/request_fuzz.go (1)

Line range hint 65-121: Consider enhancing header management architecture

While the centralization of header management is a good step, consider these architectural improvements:

  1. Create a dedicated header management component that can:
    • Implement different header merging strategies
    • Enforce security policies
    • Provide audit logging
  2. Add configuration options for header handling behavior
  3. Consider implementing header policies through middleware

This would make the header management more flexible and secure while maintaining the current simplicity.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e4a0b8e and 2e371fb.

📒 Files selected for processing (1)
  • pkg/protocols/http/request_fuzz.go (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Tests (windows-latest)
🔇 Additional comments (2)
pkg/protocols/http/request_fuzz.go (2)

98-98: LGTM!

The placement of header addition after User-Agent setup and before request execution is correct.


65-65: Consider header merging strategy

The current implementation overwrites any existing headers in the base request. Consider if certain headers from the original request should be preserved or merged instead of being overwritten.

Let's verify the impact on security-critical headers:

Comment on lines +117 to +121
func (request *Request) addHeadersToRequest(baseRequest *retryablehttp.Request) {
for k, v := range request.Headers {
baseRequest.Header.Set(k, v)
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add header validation and security controls

The current implementation could benefit from additional security controls:

  1. Validate header names and values to prevent header injection
  2. Consider protecting security-critical headers (e.g., Authorization, Cookie)
  3. Add logging for security-sensitive header modifications

Here's a suggested implementation:

 func (request *Request) addHeadersToRequest(baseRequest *retryablehttp.Request) {
+    // List of headers that require special handling
+    sensitiveHeaders := map[string]bool{
+        "Authorization": true,
+        "Cookie":       true,
+        "Origin":       true,
+    }
+
     for k, v := range request.Headers {
+        // Basic validation
+        if k == "" || strings.Contains(k, "\n") || strings.Contains(v, "\n") {
+            continue
+        }
+
+        // Log modifications to sensitive headers
+        if sensitiveHeaders[k] {
+            gologger.Debug().Msgf("Modifying sensitive header: %s", k)
+        }
+
         baseRequest.Header.Set(k, v)
     }
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
func (request *Request) addHeadersToRequest(baseRequest *retryablehttp.Request) {
for k, v := range request.Headers {
baseRequest.Header.Set(k, v)
}
}
func (request *Request) addHeadersToRequest(baseRequest *retryablehttp.Request) {
// List of headers that require special handling
sensitiveHeaders := map[string]bool{
"Authorization": true,
"Cookie": true,
"Origin": true,
}
for k, v := range request.Headers {
// Basic validation
if k == "" || strings.Contains(k, "\n") || strings.Contains(v, "\n") {
continue
}
// Log modifications to sensitive headers
if sensitiveHeaders[k] {
gologger.Debug().Msgf("Modifying sensitive header: %s", k)
}
baseRequest.Header.Set(k, v)
}
}

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.

[BUG] Nuclei can't set headers in DAST fuzzing templates
2 participants