Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

websocketserver: Allow the user to bind to a specific address #1279

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

Open
silasary wants to merge 2 commits into obsproject:master
base: master
Choose a base branch
Loading
from silasary:bind-addr

Conversation

@silasary
Copy link

@silasary silasary commented Jan 22, 2025

Description

This PR adds a config variable and command line argument for binding the websocket server to a specific address, rather than blindly listening on all interfaces.
This PR does not currently add a GUI element to configure this.

By default, OBS will continue listening on all addresses, this just adds the option to reduce the exposure for users who want or need it (changing the default appears to be the main reason 1cd12c1 was reverted).

I have chosen to allow binding of a specific address instead of a "localhost only" flag, as it's more flexible for users with multiple network adaptors.

No UI changes just yet, because I'm not sure how to best expose it in a UI, and feel like the users who want/need it are probably comfortable with hand-editing the config or using the CLI argument.

Motivation and Context

I am trying to use OSB websockets in an environment where listening on all addresses is a problem. This allows me to bind OBS to only one network adaptor.
This PR also addresses the security concerns of #907, allowing the user to bind to 127.0.0.1 or ::1.

How Has This Been Tested?

Modified config file, tried connecting to the socket from local machine and remote machine.
Reset config file, then repeated test with command line argument.
Also conducted test without any config changes to ensure default was still 0.0.0.0

Tested OS(s):
Windows 10, Windows 11

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New request/event (non-breaking)

Checklist:

  • I have read the Contributing Guidelines.
  • All commit messages are properly formatted and commits squashed where appropriate.
  • My code is not on master or a release/* branch.
  • The code has been tested.
  • I have included updates to all appropriate documentation.

drt24 reacted with thumbs up emoji
@silasary silasary changed the title (削除) Allow the user to bind websocket server to a specific address (削除ここまで) (追記) websocketserver: Allow the user to bind to a specific address (追記ここまで) Jan 22, 2025
Copy link
Member

Giving this a bump, as it has unresolved comments still. Looks like the feedback was acknowledged, but the requested changes have not been made yet.

Copy link
Author

Thanks for the bump 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@RytoEX RytoEX RytoEX left review comments

@tt2468 tt2468 tt2468 requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /