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.

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

Replace uses of os.Create with os2.Create within backup/restore workflows #17648

Merged
merged 10 commits into from
Jan 30, 2025

Conversation

mattrobenolt
Copy link
Contributor

@mattrobenolt mattrobenolt commented Jan 29, 2025

This abstracts this ever so slightly into a new os2.Create to replace usages of os.Create across packages.

I didn't want to address every single use of os.Create within this PR, but ideally we'd review other uses and swap them to use this version.

This prevents files from being created and written with world read/write privileges. I strongly don't think any of these cases, that behavior was intentional, rather implicit due to using os.Create which internally uses 0666 permissions.

Note

I think that this should be backported to all supported releases (back to v19 today) since it improves the product's security posture.

Related Issue(s)

Fixes #17647

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

…lows

This abstracts this ever so slightly into a new `os2.Create` to replace
usages of `os.Create` across packages.

I didn't want to address every single use of `os.Create` within this PR,
but ideally we'd review other uses and swap them to use this version.

This prevents files from being created and written with world read/write
privileges. I strongly don't think any of these cases, that behavior was
intentional, rather implicit due to using `os.Create` which internally
uses 0666 permissions.

Fixes vitessio#17647

Signed-off-by: Matt Robenolt <[email protected]>
Copy link
Contributor

vitess-bot bot commented Jan 29, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jan 29, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Jan 29, 2025
@mattlord mattlord added Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 Backport to: release-21.0 Needs to be backport to release-21.0 labels Jan 29, 2025
Copy link

codecov bot commented Jan 29, 2025

Codecov Report

Attention: Patch coverage is 65.00000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 67.75%. Comparing base (9c6c380) to head (ad753a6).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/mysqlctl/mysqld.go 0.00% 5 Missing ⚠️
go/os2/file.go 75.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17648      +/-   ##
==========================================
- Coverage   67.76%   67.75%   -0.01%     
==========================================
  Files        1586     1587       +1     
  Lines      255763   255772       +9     
==========================================
- Hits       173315   173310       -5     
- Misses      82448    82462      +14     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mattrobenolt and others added 3 commits January 29, 2025 13:27
This constricts from an os.ModePerm, which is 0777 down to 0770,
similarly just dropping the world bits.

Signed-off-by: Matt Robenolt <[email protected]>
This also provides sensible defaults without needing to utilize explicit
file permissions.

Signed-off-by: Matt Robenolt <[email protected]>
@mattlord mattlord removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels Jan 29, 2025
mattlord and others added 3 commits January 29, 2025 17:17
Signed-off-by: Matt Lord <[email protected]>
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @mattrobenolt ! ❤️

@frouioui frouioui added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Backup and Restore and removed Type: Enhancement Logical improvement (somewhere between a bug and feature) labels Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 Backport to: release-21.0 Needs to be backport to release-21.0 Component: Backup and Restore Type: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: Files restored from a backup are world read/writable
3 participants