Fix CHISEL_KEY environment variable ignored when --keyfile not set#571
Merged
Conversation
Owner
|
@copilot read the README and try to reproduce this issue |
Co-authored-by: jpillora <633843+jpillora@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Cannot use CHISEL_KEY environment variable if
Fix CHISEL_KEY environment variable ignored when --keyfile not set
Sep 11, 2025
--keyfile is not set
jpillora
approved these changes
Sep 11, 2025
Contributor
Author
I have reproduced the issue described in #570. Here are the test results: Issue ReproductionBefore the fix (original buggy code): $ CHISEL_KEY=foo ./chisel_buggy server --port 8083
2025/09/11 12:18:29 server: Fingerprint 9hd1/z4WHGEkF469ifkz1xmvjOZsX1/xpl8i+FlXNoo=
$ CHISEL_KEY=foo ./chisel_buggy server --port 8084
2025/09/11 12:18:47 server: Fingerprint BuVJctE7MLTWdpz1dpiKz9lENb34aVWGp4Dn+M35Ua8= # Different!The fingerprints are different, confirming that After the fix (current code): $ CHISEL_KEY=foo ./chisel server --port 8081
2025/09/11 12:17:13 server: Fingerprint HP0ROQhzJtI11mppkeKVFTWPbahaAgAlsSmBUB6JYEU=
$ CHISEL_KEY=foo ./chisel server --port 8082
2025/09/11 12:17:30 server: Fingerprint HP0ROQhzJtI11mppkeKVFTWPbahaAgAlsSmBUB6JYEU= # Same!The fingerprints are now consistent, verifying the fix works correctly. Root CauseThe issue was in the if config.KeyFile == "" {
config.KeyFile = settings.Env("KEY_FILE")
} else if config.KeySeed == "" { // This prevented CHISEL_KEY from being checked
config.KeySeed = settings.Env("KEY")
}SolutionChanged to independent if config.KeyFile == "" {
config.KeyFile = settings.Env("KEY_FILE")
}
if config.KeySeed == "" {
config.KeySeed = settings.Env("KEY")
}All existing e2e tests pass, and the new tests verify the fix prevents regression. |
This was referenced Sep 11, 2025
samartha-pm
pushed a commit
to OutSystems/chisel
that referenced
this pull request
Sep 15, 2025
…pillora#571) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jpillora <633843+jpillora@users.noreply.github.com> Signed-off-by: samartha.pm <samartha.pm@outsystems.com>
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
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.
The
CHISEL_KEYenvironment variable was being ignored when the--keyfileflag was not provided, causing the server to generate random keys on each startup instead of using the consistent key from the environment variable.Problem
The issue was in the conditional logic in
main.golines 238-242:With this logic:
--keyfileis not set, check forCHISEL_KEY_FILEenvironment variableCHISEL_KEY_FILEis also empty, then check forCHISEL_KEYThis meant
CHISEL_KEYwas never checked when--keyfilewasn't provided.Reproduction
Before the fix:
Solution
Changed the
else ifto a separateifstatement, making the environment variable checks independent:Verification
After the fix:
The fix preserves all existing behavior:
CHISEL_KEY_FILEstill takes precedence overCHISEL_KEYwhen both are set--keyfileflag still works as expected--keyflag still works (with deprecation warning)Added comprehensive tests to prevent regression of this issue.
Fixes #570.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.