docs: say what debug.allow_public costs (#64 item 3) - #73
Merged
Conversation
allow_public is only for network-isolated deployments. The listener has no authentication: a reachable pprof profile endpoint is an anonymous CPU-pinning DoS, and a heap dump can contain provider API keys, caller audio, and transcripts. Item 3 of streamcoreai#64. Docs only; not a token gate.
Member
|
nice catch! thanx @vsolano9 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Item 3 of #64. Docs only; not a token gate.
What the docs undersold
debug.allow_public = truebinds the pprof listener to a non-loopback address.That listener has no authentication.
docs/configuration.mddescribed this asacknowledging that "profiles expose process data and CPU profiles consume
resources" — true of any Go process, and not the actual cost on a voice server.
On a reachable interface:
/debug/pprof/profile?seconds=3600is an anonymous CPU-pinning DoS.buffers and transcripts.
Change
State that
allow_publicis only for network-isolated deployments, and namethose two costs. The TOML comment in the same file now matches. The bind bullet
still says keep it on loopback over an SSH tunnel; the public mux still never
serves
/debug/pprof/.config.toml.exampleanddocs/configuration.zh-CN.mdare left for their ownitems (10 and 9).
Verification
Docs-only diff (
docs/configuration.md). No Go change. The repo has no testthat asserts this file's wording.