Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Document Resource options that potentially leak secrets #2727

Merged
merged 2 commits into from Mar 28, 2022
Merged

Document Resource options that potentially leak secrets #2727

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3aba7d
Document Resource options that potentially leak secrets
MrAlias Mar 25, 2022
1eded63
Merge branch 'main' into doc-process-resource-secret-leak
MrAlias Mar 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 15 additions & 2 deletions sdk/resource/config.go
View file
Open in desktop
Expand Up @@ -110,7 +110,16 @@ func WithOSDescription() Option {
}

// WithProcess adds all the Process attributes to the configured Resource.
// See individual WithProcess* functions to configure specific attributes.
//
// Warning! This option will include process command line arguments. If these
// contain sensitive information it will be included in the exported resource.
//
// This option is equivalent to calling WithProcessPID,
// WithProcessExecutableName, WithProcessExecutablePath,
// WithProcessCommandArgs, WithProcessOwner, WithProcessRuntimeName,
// WithProcessRuntimeVersion, and WithProcessRuntimeDescription. See each
// option function for information about what resource attributes each
// includes.
func WithProcess() Option {
return WithDetectors(
processPIDDetector{},
Expand Down Expand Up @@ -143,7 +152,11 @@ func WithProcessExecutablePath() Option {
}

// WithProcessCommandArgs adds an attribute with all the command arguments (including
// the command/executable itself) as received by the process the configured Resource.
// the command/executable itself) as received by the process to the configured
// Resource.
//
// Warning! This option will include process command line arguments. If these
// contain sensitive information it will be included in the exported resource.
func WithProcessCommandArgs() Option {
return WithDetectors(processCommandArgsDetector{})
}
Expand Down