Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

rustatian
Copy link
Member

Reason for This PR

closes: https://github.com/orgs/roadrunner-server/discussions/2205

Description of Changes

  1. Propagate TLS info via middleware for the PHP worker if TLS session is used via header.
  2. Header name RR_TLS_INFO.

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the MIT license.

PR Checklist

[Author TODO: Meet these criteria.]
[Reviewer TODO: Verify that these criteria are met. Request changes if not]

  • All commits in this PR are signed (git commit -s).
  • The reason for this PR is clearly provided (issue no. or explanation).
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian rustatian requested a review from Copilot July 26, 2025 19:31
@rustatian rustatian self-assigned this Jul 26, 2025
@rustatian rustatian marked this pull request as draft July 26, 2025 19:31
Copy link

coderabbitai bot commented Jul 26, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/2205-nist-compatible

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

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

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds TLS information propagation to PHP workers by implementing a new TLS middleware that extracts TLS connection details and passes them via the RR_TLS_INFO header. The middleware extracts comprehensive TLS information including version, cipher suite, certificates, and verification chains when a TLS connection is established.

Key changes:

  • Added new TLS middleware that extracts and serializes TLS connection information
  • Integrated the middleware into HTTP and HTTP3 server handlers
  • Updated dependency checksums to reflect new package versions

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
middleware/tls_info.go New middleware that extracts TLS connection details and adds them to request headers
init.go Integration of TLS middleware into HTTP and HTTP3 server request handling chains
go.work.sum Updated dependency checksums for various cloud and library packages


tlsinfo, err := json.Marshal(info)
if err != nil {
log.Warn("failed to parse TLS info", zap.Error(err))
Copy link

Copilot AI Jul 26, 2025

Choose a reason for hiding this comment

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

The error message 'failed to parse TLS info' is misleading. JSON marshaling is being performed, not parsing. Consider changing to 'failed to marshal TLS info' for accuracy.

Suggested change
log.Warn("failed to parse TLS info", zap.Error(err))
log.Warn("failed to marshal TLS info", zap.Error(err))

Copilot uses AI. Check for mistakes.


tlsinfo, err := json.Marshal(info)
if err != nil {
log.Warn("failed to parse TLS info", zap.Error(err))
Copy link

Copilot AI Jul 26, 2025

Choose a reason for hiding this comment

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

When JSON marshaling fails, the middleware continues execution without setting the TLS info header. This could lead to inconsistent behavior where some requests have TLS info and others don't during partial failures. Consider either returning early or setting a default/error indicator in the header.

Suggested change
log.Warn("failed to parse TLS info", zap.Error(err))
log.Warn("failed to parse TLS info", zap.Error(err))
r.Header.Add("RR_TLS_INFO", "error")
} else {
r.Header.Add("RR_TLS_INFO", string(tlsinfo))

Copilot uses AI. Check for mistakes.


r.Header.Add("RR_TLS_INFO", string(tlsinfo))
next.ServeHTTP(w, r)
r.Header.Del("RR_TLS_INFO")
Copy link

Copilot AI Jul 26, 2025

Choose a reason for hiding this comment

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

The header is deleted after calling next.ServeHTTP(), but if an error occurs during request processing, the header will still be deleted. Consider using defer to ensure cleanup happens regardless of how the request processing completes.

Copilot uses AI. Check for mistakes.

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.

1 participant