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

Document surprising and dangerous fs::Permissions behaviour on Unix #101644

Merged
merged 1 commit into from
Oct 24, 2022

Conversation

Timmmm
Copy link
Contributor

@Timmmm Timmmm commented Sep 10, 2022

This documents the very surprising behaviour that set_readonly(false) will make a file world writable on Unix. I would go so far as to say that this function should be deprecated on Unix, or maybe even entirely. But documenting the bad behaviour is a good first step.

Fixes #74895

@rustbot rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Sep 10, 2022
@rustbot
Copy link
Collaborator

rustbot commented Sep 10, 2022

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 10, 2022
@JohnTitor
Copy link
Member

r? @JohnTitor

I'll review this later today.

library/std/src/fs.rs Outdated Show resolved Hide resolved
library/std/src/fs.rs Outdated Show resolved Hide resolved
library/std/src/fs.rs Outdated Show resolved Hide resolved
@JohnTitor
Copy link
Member

Ping me once you include #101599 :)

library/std/src/fs.rs Outdated Show resolved Hide resolved
@Timmmm
Copy link
Contributor Author

Timmmm commented Sep 17, 2022

Thanks for the really great feedback everyone! I'll try to update it this weekend.

@Timmmm
Copy link
Contributor Author

Timmmm commented Sep 17, 2022

Updated; hopefully that resolves everything.

@rust-log-analyzer

This comment has been minimized.

library/std/src/fs.rs Outdated Show resolved Hide resolved
Copy link
Member

@JohnTitor JohnTitor left a comment

Choose a reason for hiding this comment

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

Overall LGTM with nits 👍

library/std/src/fs.rs Outdated Show resolved Hide resolved
library/std/src/fs.rs Outdated Show resolved Hide resolved
@JohnTitor
Copy link
Member

Could you also squash commits into one?

This documents the very surprising behaviour that `set_readonly(false)` will make a file *world writable* on Unix. I would go so far as to say that this function should be deprecated on Unix, or maybe even entirely. But documenting the bad behaviour is a good first step.
@thomcc
Copy link
Member

thomcc commented Oct 23, 2022

This looks fine to me. I would like to see a proposal to improve the semantics here, but as mentioned, for now documenting is good enough.

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Oct 23, 2022

📌 Commit 908bdea has been approved by thomcc

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 23, 2022
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 24, 2022
Rollup of 11 pull requests

Successful merges:

 - rust-lang#100462 (Clarify `array::from_fn` documentation)
 - rust-lang#101644 (Document surprising and dangerous fs::Permissions behaviour on Unix)
 - rust-lang#103005 (kmc-solid: Handle errors returned by `SOLID_FS_ReadDir`)
 - rust-lang#103140 (Add diagnostic for calling a function with the same name with unresolved Macro)
 - rust-lang#103254 (rustdoc: do not filter out cross-crate `Self: Sized` bounds)
 - rust-lang#103347 (bootstrap: also create rustc-src component in sysroot)
 - rust-lang#103402 (Fix wrapped valid-range handling in ty_find_init_error)
 - rust-lang#103414 (Pretty print lifetimes captured by RPIT)
 - rust-lang#103424 (rustdoc: remove no-op CSS `.code-header { border-bottom: none }`)
 - rust-lang#103434 (Use functions for jump-to-def-background rustdoc GUI test)
 - rust-lang#103447 (`MaybeUninit`: use `assume_init_drop()` in the partially initialized array example)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 214fa9f into rust-lang:master Oct 24, 2022
@rustbot rustbot added this to the 1.66.0 milestone Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Permissions::readonly() doesn't behave as expected with files
9 participants