[PR #6064] [MERGED] [client] Use unique temp file and clean up on failure when writing ssh config #28972

Open
opened 2026-08-05 08:07:13 -04:00 by saavagebueno · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/netbirdio/netbird/pull/6064
Author: @lixmal
Created: 5/4/2026
Status: Merged
Merged: 5/11/2026
Merged by: @lixmal

Base: mainHead: ssh-config-tmp-cleanup


📝 Commits (3)

  • 9db7bec Use unique temp file and clean up on failure when writing ssh config
  • 6e22e8a Register temp file cleanup before close in ssh config writer
  • ad87655 Merge branch 'main' into ssh-config-tmp-cleanup

📊 Changes

1 file changed (+18 additions, -5 deletions)

View changed files

📝 client/ssh/config/manager.go (+18 -5)

📄 Description

Describe your changes

Follow-up to #5867. Use a unique temp filename and clean up on failure when writing the ssh client config.

  • Use os.CreateTemp for a unique temp filename so concurrent writes do not collide on a fixed .tmp path
  • Remove the temp file via defer if the write or rename fails, instead of leaving a stale .tmp behind
  • Wrap the write error with the temp path that actually failed

Stack

Checklist

  • Is it a bug fix
  • Is a typo/documentation fix
  • Is a feature enhancement
  • It is a refactor
  • Created tests that fail without the change (if possible)

By submitting this pull request, you confirm that you have read and agree to the terms of the Contributor License Agreement.

Documentation

Select exactly one:

  • I added/updated documentation for this change
  • Documentation is not needed for this change (explain why)

Internal robustness fix, no user-facing behavior change.

Docs PR URL (required if "docs added" is checked)

Paste the PR link from https://github.com/netbirdio/docs here:

https://github.com/netbirdio/docs/pull/__

Summary by CodeRabbit

  • Bug Fixes
    • Uses unique temporary files during SSH config updates to avoid conflicts.
    • Atomically replaces the active SSH config to reduce risk of corruption or data loss during updates.
    • Improves error handling and reporting for failures during the write-and-replace process.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbirdio/netbird/pull/6064 **Author:** [@lixmal](https://github.com/lixmal) **Created:** 5/4/2026 **Status:** ✅ Merged **Merged:** 5/11/2026 **Merged by:** [@lixmal](https://github.com/lixmal) **Base:** `main` ← **Head:** `ssh-config-tmp-cleanup` --- ### 📝 Commits (3) - [`9db7bec`](https://github.com/netbirdio/netbird/commit/9db7bec233c3b336495452904ad7f30e6642727a) Use unique temp file and clean up on failure when writing ssh config - [`6e22e8a`](https://github.com/netbirdio/netbird/commit/6e22e8a6fb4ca762a882cdb530359fb370d3177a) Register temp file cleanup before close in ssh config writer - [`ad87655`](https://github.com/netbirdio/netbird/commit/ad8765568b537547295fbdb0f5b99f1a8b5653f1) Merge branch 'main' into ssh-config-tmp-cleanup ### 📊 Changes **1 file changed** (+18 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `client/ssh/config/manager.go` (+18 -5) </details> ### 📄 Description ## Describe your changes Follow-up to #5867. Use a unique temp filename and clean up on failure when writing the ssh client config. - Use `os.CreateTemp` for a unique temp filename so concurrent writes do not collide on a fixed `.tmp` path - Remove the temp file via `defer` if the write or rename fails, instead of leaving a stale `.tmp` behind - Wrap the write error with the temp path that actually failed ## Issue ticket number and link ## Stack <!-- branch-stack --> ### Checklist - [x] Is it a bug fix - [ ] Is a typo/documentation fix - [ ] Is a feature enhancement - [ ] It is a refactor - [ ] Created tests that fail without the change (if possible) > By submitting this pull request, you confirm that you have read and agree to the terms of the [Contributor License Agreement](https://github.com/netbirdio/netbird/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT.md). ## Documentation Select exactly one: - [ ] I added/updated documentation for this change - [x] Documentation is **not needed** for this change (explain why) Internal robustness fix, no user-facing behavior change. ### Docs PR URL (required if "docs added" is checked) Paste the PR link from https://github.com/netbirdio/docs here: https://github.com/netbirdio/docs/pull/__ <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Bug Fixes** * Uses unique temporary files during SSH config updates to avoid conflicts. * Atomically replaces the active SSH config to reduce risk of corruption or data loss during updates. * Improves error handling and reporting for failures during the write-and-replace process. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
saavagebueno added the pull-request label 2026-08-05 08:07:13 -04:00
Sign in to join this conversation.
No Label pull-request
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: DYNR/netbird#28972