cmd/geth, internal/flags: print envvar config source and bad names #28119
Conversation
This file contains 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
holiman
reviewed
Sep 15, 2023
| if err := debug.Setup(ctx); err != nil { | ||
| return err | ||
| } | ||
| flags.CheckEnvVars(ctx, app.Flags, "GETH") |
There was a problem hiding this comment.
Suggested change
| flags.CheckEnvVars(ctx, app.Flags, "GETH") | |
| flags.CheckEnvVars(ctx, app.Flags, "GETH_") |
maybe?
There was a problem hiding this comment.
Unsure. I deliberately left it as GETH only so that if you forget the underscore or use a minus or something it still gets caught. That said, it's mostly a heuristic for now.
holiman
reviewed
Sep 15, 2023
| if ctx.Count(flag) > 0 { | ||
| log.Info("Config environment variable found", "envvar", key, "shadowedby", "--"+flag) | ||
| } else { | ||
| log.Info("Config environment variable found", "envvar", key) |
There was a problem hiding this comment.
In some cases. cmd line params are sensitive (password for remote influxdb databases, password for --unlock), but this will echo them in logs, right?
Might not be the best idea -- so far, we've been kind rightfully lax about asking people for their logs, because we know they contain nothing interesting.
Ah wait, it's only the key, not the value? If so it's all good!
There was a problem hiding this comment.
Yes, only key for the exact reason.
devopsbo3
pushed a commit
to HorizenOfficial/go-ethereum
that referenced
this pull request
Nov 10, 2023
devopsbo3
added a commit
to HorizenOfficial/go-ethereum
that referenced
this pull request
Nov 10, 2023
…names (ethereum#28119)" This reverts commit c59e4a4.
devopsbo3
added a commit
to HorizenOfficial/go-ethereum
that referenced
this pull request
Nov 10, 2023
…names (ethereum#28119)" This reverts commit c59e4a4.
This pull request was closed.
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.
One catch with env vars is that they might silently change Geth's behavior, in both directions:
Both cases would be quite tricky to debug. Further it would be a PITA for us to debug user issues when they don't share their env list, and sharing them may not be best security practice.
This PR tries to solve all 3 issues, by listing all the consumed env vars, as well as all the env vars that "seem" like GETH ones, but that are not consumed in the end.
TL;DR: