Skip to content

Customizable Websockets Security #1929

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.

Sign up for GitHub

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

Jump to bottom
Merged
DavidsonGomes merged 2 commits into from
Sep 9, 2025
Merged

Customizable Websockets Security #1929

DavidsonGomes merged 2 commits into from
Sep 9, 2025

Conversation

@moothz
Copy link
Contributor

@moothz moothz commented Sep 9, 2025 •
edited by sourcery-ai bot
Loading

Introduces the ability to specify allowed remote IPs for WebSocket connections via the WEBSOCKET_ALLOWED_HOSTS environment variable.

The variable should contain a comma-separated string of addresses. If not set, the behavior defaults to allowing localhost connections only.

This change further enhances the security measures introduced in #1802.

Summary by Sourcery

Enable customizable security for WebSocket connections by allowing remote IP whitelisting via an environment variable with a fallback to localhost

New Features:

  • Introduce WEBSOCKET_ALLOWED_HOSTS environment variable to whitelist remote IPs for WebSocket connections

Enhancements:

  • Default to localhost addresses when WEBSOCKET_ALLOWED_HOSTS is not set

Documentation:

  • Add WEBSOCKET_ALLOWED_HOSTS to .env.example

@moothz
Customizable Websockets Security
0aa6c96 
Enables the option to specify safe remote addresses using WEBSOCKET_ALLOWED_HOSTS enviroment variables. Defaults to the secure only localhost.
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Sep 9, 2025 •
edited
Loading

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Introduce a WEBSOCKET_ALLOWED_HOSTS environment variable to control which remote IPs can establish WebSocket connections, defaulting to localhost, and update the EIO handshake to use this dynamic list.

File-Level Changes

Change Details Files
Replace hardcoded localhost check with dynamic allowed hosts list
  • Read WEBSOCKET_ALLOWED_HOSTS or use default localhost addresses
  • Split and trim the comma-separated hosts into an array
  • Check if remoteAddress is in the allowed hosts array
  • Use isAllowedHost in the EIO handshake conditional instead of isLocalhost
 src/api/integrations/event/websocket/websocket.controller.ts
Update environment example to include new variable
  • Add WEBSOCKET_ALLOWED_HOSTS entry to .env.example
 .env.example
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Sep 9, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@DavidsonGomes DavidsonGomes changed the base branch from main to develop September 9, 2025 18:36
@DavidsonGomes DavidsonGomes merged commit edbf360 into EvolutionAPI:develop Sep 9, 2025
1 check passed
@micaelmz micaelmz mentioned this pull request Dec 2, 2025
Merged
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@moothz @DavidsonGomes