feat: Add option to disable error reasons in STUN responses #1695
Conversation
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
This commit introduces a new configuration option, `no-error-reason`. When enabled, the TURN server will send STUN error responses with an empty reason phrase. This can be useful in environments where minimizing response size is critical, at the cost of slightly harder debugging. Changes include: - Added `no_error_reason` to the `turn_params_t` struct. - Modified `mainrelay.c` to parse the `--no-error-reason` command-line option and corresponding configuration file setting. - Updated `ns_turn_server.c` to check this flag and conditionally omit the reason phrase when constructing error responses. - Added the new option to the example `turnserver.conf` file. - Conceptually outlined test cases for this new functionality.
This commit changes the server's default behavior to omit STUN error reason phrases in responses. A new option, `--send-error-reason` (and corresponding config file setting `send-error-reason`), is introduced to enable the inclusion of these reason phrases if desired. This change aims to reduce response size by default, while still allowing you to enable more verbose error messages for debugging. Changes include: - Renamed `no_error_reason` to `send_error_reason` in `turn_params_t`. - Default for `send_error_reason` is now `false` (reasons omitted). - Command-line option changed to `--send-error-reason` to enable reasons. - Updated `mainrelay.c` for new option name, logic, and usage string. - Updated all `turnserver.conf` files (`examples/etc/turnserver.conf`, `docker/coturn/turnserver.conf`) to reflect the new option and default. - Adjusted conceptual test cases for the new default behavior. - Partially updated `ns_turn_server.c` to use the new `send_error_reason` flag. Due to some limitations I encountered, a full update to `ns_turn_server.c` could not be reliably completed and will require your manual review and completion to ensure all error generation sites correctly adhere to the `send_error_reason` flag (sending reasons only when it's true).
This commit implements the `send_error_reason` option. When
`send_error_reason` is set to `false`, the TURN server will now send an
empty reason phrase ("") in STUN error responses. If `send_error_reason`
is `true` (the default behavior), the original error reason phrase will
be sent.
This change affects how error conditions are communicated to clients,
allowing for configurations where detailed error reasons are suppressed.
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
|
Still some work pending, i´ll try to remove the reason completely instead of leaving it empty. I saw that in Cloudflare implementation so it looks safe. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This commit introduces a new configuration option,
send-error-reason. When enabled, the TURN server will send STUN error responses with an reason phrase. By default it wont send the error reason so it is a change in the default behaviour.Changes include:
send_error_reasonto theturn_params_tstruct.mainrelay.cto parse the--no-error-reasoncommand-line option and corresponding configuration file setting.ns_turn_server.cto check this flag and conditionally omit the reason phrase when constructing error responses.turnserver.conffile.