Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SUPERCILEX/forkfs
ForkFS allows you to sandbox a process's changes to your file system.
https://github.com/SUPERCILEX/forkfs
cli files isolation rust sandboxing
Last synced: 5 days ago
JSON representation
ForkFS allows you to sandbox a process's changes to your file system.
- Host: GitHub
- URL: https://github.com/SUPERCILEX/forkfs
- Owner: SUPERCILEX
- License: apache-2.0
- Created: 2021-09-08T18:48:43.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-04T20:33:41.000Z (3 months ago)
- Last Synced: 2024-10-23T13:41:31.304Z (18 days ago)
- Topics: cli, files, isolation, rust, sandboxing
- Language: Rust
- Homepage: https://crates.io/crates/forkfs
- Size: 149 KB
- Stars: 71
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ForkFS
ForkFS allows you to sandbox a process's changes to your file system.
You can think of it as a lightweight container: programs still have access to your real system
(and can therefore jump out of the sandbox), but their disk changes are re-routed to special
directories without changing the real file system.
A brief technical overview of the project is available at https://alexsaveau.dev/blog/forkfs.
## Installation
> Note: ForkFS is Linux-only.
### Use prebuilt binaries
Binaries for a number of platforms are available on the
[release page](https://github.com/SUPERCILEX/forkfs/releases/latest).
### Build from source
```console,ignore
$ cargo +nightly install forkfs
```
> To install cargo, follow
> [these instructions](https://doc.rust-lang.org/cargo/getting-started/installation.html).
## Usage
Run a command in the sandbox:
```sh
$ forkfs run --
```
All file system changes the command makes will only exist within the sandbox and will not modify
your real file system.
You can also start a bash shell wherein any command you execute has its file operations sandboxed:
```sh
$ forkfs run bash
```
More details:
```console
$ forkfs --help
A sandboxing file system emulator
You can think of ForkFS as a lightweight container: programs still have access to your real system
(and can therefore jump out of the sandbox), but their disk changes are re-routed to special
directories without changing the real file system. Under the hood, ForkFS is implemented as a
wrapper around OverlayFS.
Warning: we make no security claims. Do NOT use this tool with potentially malicious software.
PS: you might also be interested in Firejail: .
Usage: forkfs
Commands:
run Run commands inside the sandbox
sessions Manage sessions
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (use `-h` for a summary)
-V, --version
Print version
$ forkfs sessions --help
Manage sessions
Each session has its own separate view of the file system that is persistent. That is, individual
command invocations build upon each other.
Actives sessions are those that are mounted, while inactive sessions remember the changes that were
made within them, but are not ready to be used.
Note: weird things may happen if the real file system changes after establishing a session. You may
want to delete all sessions to restore clean behavior in such cases.
Usage: forkfs sessions
Commands:
list List sessions
stop Unmount active sessions
delete Delete sessions
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (use `-h` for a summary)
```