fix(provisioner): split SSH sessions in createKindConfig #657
+23
−22
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
There was a problem hiding this comment.
Pull request overview
This PR fixes critical SSH session management bugs in the createKindConfig function by addressing two audit findings: SSH session reuse after Run() (HIGH severity) and a local file resource leak (MEDIUM severity). The fix splits a single SSH session into two separate sessions and adds proper cleanup with defer statements.
Changes:
- Split SSH session usage: mkdir operation now uses dedicated session1, file write uses dedicated session2
- Added defer statement to close local file handle, fixing resource leak
- Refactored to use local
kindConfigPathvariable instead of mutating the environment struct
Comment on lines
297
to
319
| if err := session2.Start("cat > " + remoteFilePath); err != nil { | ||
| return fmt.Errorf("failed to start session: %w", err) | ||
| } | ||
|
|
||
| // open local file for reading | ||
| // first check if file path is relative or absolute | ||
| // if relative, then prepend the current working directory | ||
| if !filepath.IsAbs(env.Spec.Kubernetes.KindConfig) { | ||
| // Resolve local file path | ||
| kindConfigPath := env.Spec.Kubernetes.KindConfig | ||
| if !filepath.IsAbs(kindConfigPath) { | ||
| cwd, err := os.Getwd() | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get current working directory: %w", err) | ||
| } | ||
|
|
||
| env.Spec.Kubernetes.KindConfig = filepath.Join(cwd, strings.TrimPrefix(env.Spec.Kubernetes.KindConfig, "./")) | ||
| kindConfigPath = filepath.Join(cwd, strings.TrimPrefix(kindConfigPath, "./")) | ||
| } | ||
|
|
||
| localFile, err := os.Open(env.Spec.Kubernetes.KindConfig) | ||
| localFile, err := os.Open(kindConfigPath) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to open local file %s: %w", env.Spec.Kubernetes.KindConfig, err) | ||
| return fmt.Errorf("failed to open local file %s: %w", kindConfigPath, err) | ||
| } | ||
| defer func() { _ = localFile.Close() }() | ||
|
|
||
| // copy local file to remote file | ||
| if _, err := io.Copy(remoteFile, localFile); err != nil { | ||
| return fmt.Errorf("failed to copy local file %s to remote file %s: %w", env.Spec.Kubernetes.KindConfig, remoteFilePath, err) | ||
| return fmt.Errorf("failed to copy local file %s to remote file %s: %w", kindConfigPath, remoteFilePath, err) | ||
| } |
There was a problem hiding this comment.
If an error occurs after session2.Start() is called (lines 304-319), the function returns without calling session2.Wait() or closing remoteFile properly. This could leave the SSH session in an incomplete state. Consider closing remoteFile and calling session2.Wait() in error paths, similar to how the provision() function handles this (lines 249-258).
Pull Request Test Coverage Report for Build 21979597278Details
💛 - Coveralls |
SSH sessions in x/crypto/ssh are single-use. The old code called session.Run() then tried session.StdinPipe() on the same session, which always failed. Split into two sessions (mkdir + file write), following the pattern used in createKubeAdmConfig. Also close the local file that was previously leaked. Audit findings NVIDIA#2 (HIGH), NVIDIA#12 (MEDIUM). Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
ArangoGutierrez
force-pushed
the
fix/provisioner-kind-config
branch
from
ed1d8b9 to
f362ca8
Compare
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.
Summary
Audit Findings
Changes
pkg/provisioner/provisioner.go: Rewrite createKindConfig with two SSH sessions and proper resource cleanupTest plan
gofmt— no formatting issuesgo build— compilesgo test ./pkg/...— all tests pass