https://github.com/sunfishcode/open-ambient

Open files and directories with constant paths
https://github.com/sunfishcode/open-ambient

Last synced: 27 days ago
JSON representation

Open files and directories with constant paths

• Host: GitHub
• URL: https://github.com/sunfishcode/open-ambient
• Owner: sunfishcode
• License: other
• Created: 2021-07-13T23:32:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-11T05:46:46.000Z (10 months ago)
• Last Synced: 2024-10-06T02:15:52.876Z (about 1 month ago)
• Language: Rust
• Homepage:
• Size: 37.1 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  
open-ambient


  


    Open files and directories with constant paths

  


  


    

    

    

  



One of the uses for [ambient-authority] is to mark places in the code which

may be opening files or other resources in ways that may be influenced by

untrusted inputs. Paths or other identifiers which are constant and known

at compile time are safe. This crate provides macros for use with [cap-std]

which open files and directories in a way that requires the paths to be

constant and in a way that allows them to be ignored in a clippy scan for

use of dynamic ambient authority.

To use, it add `#![deny(clippy::disallowed_method)]` to your code and copy

[the clippy.toml file], as described [here], for example:

```rust

#![deny(clippy::disallowed_method)]

use open_ambient::open_ambient_file;

fn main() {

    let fine = open_ambient_file!("Cargo.toml").unwrap();

    // ... do stuff with `fine`

    drop(fine);

    let risky = std::fs::File::open("Cargo.toml").unwrap();

    // ... do stuff with `risky`

    drop(risky);

}

```

And run clippy configured with [these instructions]. The above code

gets just one error:

```

error: use of a disallowed method `std::fs::File::open`

  --> test.rs:10:19

   |

10 |     let risky = std::fs::File::open("Cargo.toml").unwrap();

   |                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

   |

```

The `open_ambient_file!` line does not get an error, while the

`std::fs::File::open` line does.

[ambient-authority]: https://crates.io/crates/ambient-authority

[cap-std]: https://crates.io/crates/cap-std

[here]: https://github.com/sunfishcode/ambient-authority/blob/main/clippy.toml#L5

[these instructions]: https://github.com/sunfishcode/ambient-authority/blob/main/clippy.toml#L18

[the clippy.toml file]: https://github.com/sunfishcode/ambient-authority/blob/main/clippy.toml