Refactor and improve documentation, add examples
This commit is contained in:
67
examples/02-filesystem/README.md
Normal file
67
examples/02-filesystem/README.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Filesystem Sandbox Demo
|
||||
|
||||
This demo shows how fence controls filesystem access with `allowWrite`, `denyWrite`, and `denyRead`.
|
||||
|
||||
## What it demonstrates
|
||||
|
||||
| Operation | Without Fence | With Fence |
|
||||
|-----------|---------------|------------|
|
||||
| Write to `./output/` | ✓ | ✓ (in allowWrite) |
|
||||
| Write to `./` | ✓ | ✗ (not in allowWrite) |
|
||||
| Write to `.env` | ✓ | ✗ (in denyWrite) |
|
||||
| Write to `*.key` | ✓ | ✗ (in denyWrite) |
|
||||
| Read `./demo.py` | ✓ | ✓ (allowed by default) |
|
||||
| Read `/etc/shadow` | ✗ | ✗ (in denyRead) |
|
||||
| Read `/etc/passwd` | ✓ | ✗ (in denyRead) |
|
||||
|
||||
## Run the demo
|
||||
|
||||
### Without fence (all writes succeed)
|
||||
|
||||
```bash
|
||||
python demo.py
|
||||
```
|
||||
|
||||
### With fence (unauthorized operations blocked)
|
||||
|
||||
```bash
|
||||
fence --settings fence.json python demo.py
|
||||
```
|
||||
|
||||
## Fence config
|
||||
|
||||
```json
|
||||
{
|
||||
"filesystem": {
|
||||
"allowWrite": ["./output"],
|
||||
"denyWrite": [".env", "*.key"],
|
||||
"denyRead": ["/etc/shadow", "/etc/passwd"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### How it works
|
||||
|
||||
1. **allowWrite** - Only paths listed here are writable. Everything else is read-only.
|
||||
|
||||
2. **denyWrite** - These paths are blocked even if they'd otherwise be allowed. Useful for protecting secrets.
|
||||
|
||||
3. **denyRead** - Block reads from sensitive system files.
|
||||
|
||||
## Key settings
|
||||
|
||||
| Setting | Default | Purpose |
|
||||
|---------|---------|---------|
|
||||
| `allowWrite` | `[]` (nothing) | Directories where writes are allowed |
|
||||
| `denyWrite` | `[]` | Paths to block writes (overrides allowWrite) |
|
||||
| `denyRead` | `[]` | Paths to block reads |
|
||||
|
||||
## Protected paths
|
||||
|
||||
Fence also automatically protects certain paths regardless of config:
|
||||
|
||||
- Shell configs: `.bashrc`, `.zshrc`, `.profile`
|
||||
- Git hooks: `.git/hooks/*`
|
||||
- Git config: `.gitconfig`
|
||||
|
||||
See [ARCHITECTURE.md](../../ARCHITECTURE.md) for the full list.
|
||||
Reference in New Issue
Block a user