agentignore 0.4.1

FUSE filesystem that hides files matching .agentignore rules from processes - control what agents can see while building apps
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# AgentIgnore — Policy-Filtered Filesystem for AI Agents

## Overview

AgentIgnore is a Linux userspace filesystem implemented using FUSE.

The filesystem exposes a filtered virtual view of a real directory tree. Files and directories matching rules in a `.agentignore` file are completely hidden from processes interacting with the mounted filesystem.

The primary use case is constraining autonomous AI/LLM agents that have shell access.

The filesystem must make hidden files appear non-existent:

* hidden files must not appear in `ls`
* hidden files must not appear in `find`
* hidden files must not appear in glob expansion
* direct access attempts must return `ENOENT`
* hidden files must not be reachable via symlink traversal
* hidden files must not be discoverable through filesystem metadata

The filesystem should behave as a transparent passthrough filesystem for allowed paths.

---

# Goals

## Primary Goals

* Hide files/directories from AI agents
* Preserve normal filesystem semantics for visible files
* Avoid copying files
* Allow real writes to visible files
* Dynamically evaluate policy rules
* Support gitignore-style patterns
* Prevent path traversal and symlink escapes
* Behave like a normal POSIX filesystem

## Non-Goals

* Full VM/container isolation
* Kernel-level MAC implementation
* Cryptographic protection
* Defense against privileged users
* Antivirus or malware detection

---

# High-Level Architecture

```text
Real filesystem
AgentIgnore (FUSE passthrough filesystem)
Mounted filtered view
LLM agent / shell tools
```

Example:

```text
/project
    .env
    secrets/
    src/
    README.md
```

`.agentignore`:

```text
.env
secrets/
```

Mounted view:

```text
/mnt/agent
    src/
    README.md
```

The hidden files must appear not to exist.

---

# Technology Stack

## Recommended Language

Rust

## Recommended Libraries

### FUSE

* `fuser` 0.17

### Pattern Matching

One of:

* `ignore`
* `globset`
* custom gitignore-compatible matcher

### Logging

* `tracing`

---

# Filesystem Model

AgentIgnore is a passthrough filesystem.

The backing filesystem remains authoritative.

AgentIgnore only:

* mediates visibility
* enforces policy
* filters filesystem operations

No file contents are copied.

All modifications to visible files affect the real filesystem.

---

# Mount Semantics

Example:

```bash
agentignore mount /real/project /mnt/agent
```

Where:

* `/real/project` is the backing root
* `/mnt/agent` is the filtered mountpoint

The mounted filesystem exposes only allowed paths.

---

# Policy File

## Filename

`.agentignore`

## Scope

Applies recursively from mount root.

## Syntax

Gitignore-compatible syntax.

Supported:

* comments
* globs
* recursive patterns
* directory rules
* negation rules

Examples:

```text
# secrets
.env
*.pem
*.key

# hidden directories
secrets/
node_modules/

# recursive
**/*.tfstate

# negate
!important.env
```

---

# Core Security Semantics

## Hidden Paths

Hidden paths must behave as though they do not exist.

Operations against hidden paths must return:

```text
ENOENT
```

NOT:

* `EPERM`
* `EACCESS`
* permission denied

This prevents discoverability.

---

# Filesystem Operations

The following FUSE operations must enforce policy.

---

## readdir

Purpose:

* controls directory listing visibility

Requirements:

* hidden entries must not appear
* filtered before returning results

Affects:

* `ls`
* `find`
* shell completion
* globbing

---

## lookup

Purpose:

* resolves path components

Requirements:

* hidden paths return `ENOENT`

Prevents:

* guessed-path access

---

## getattr

Purpose:

* stat metadata requests

Requirements:

* hidden paths return `ENOENT`

Prevents:

* existence probing

---

## open

Purpose:

* final access enforcement

Requirements:

* hidden files cannot be opened

---

## readlink

Purpose:

* symlink resolution

Requirements:

* symlink targets must be canonicalized
* symlinks escaping into hidden paths must fail

Critical security requirement.

---

## rename

Purpose:

* moving files

Requirements:

* prevent rename-based bypasses

Example attack:

```bash
mv .env allowed.txt
```

Policy must still apply.

---

## link / symlink

Purpose:

* prevent alternate references to hidden files

Requirements:

* hidden inodes cannot become visible via linking

---

## create

Purpose:

* creating new files

Requirements:

* newly created files must immediately participate in policy evaluation

---

# Path Resolution Rules

All paths must be:

1. normalized
2. canonicalized
3. evaluated relative to mount root

Must prevent:

* `..` traversal
* symlink escapes
* bind mount escapes

---

# Policy Engine

## Evaluation Order

1. canonicalize path
2. convert to mount-relative path
3. evaluate against `.agentignore`
4. determine visibility

## Internal Semantics

Prefer allow/deny decision caching.

## Caching

Optional:

* inode cache
* pattern cache
* directory cache

Must support invalidation when:

* `.agentignore` changes
* filesystem changes

---

# Symlink Security

Critical requirement.

The filesystem must prevent:

```text
visible/link -> /real/project/.env
```

Implementation requirements:

* resolve symlink target
* canonicalize final target
* re-run policy evaluation

Hidden targets must fail.

---

# Hard Link Security

Potential attack:

```bash
ln hidden visible
```

Requirements:

* hidden inode must remain inaccessible
* link operations must enforce policy

---

# Error Semantics

Hidden files:

* return `ENOENT`

Invalid permissions:

* return standard POSIX permission errors

Filesystem errors:

* pass through normally

---

# Performance Requirements

## Target Characteristics

* low overhead passthrough
* scalable directory traversal
* minimal metadata amplification

## Optimization Targets

* path cache
* ignore matcher cache
* lazy canonicalization
* batched directory filtering

---

# Logging

Optional structured logging.

Possible events:

* denied access
* hidden path access attempts
* symlink violations
* rename violations

Example:

```text
DENY open /project/.env
DENY symlink escape /project/link
```

---

# Future Features

## Read-only Rules

Example:

```text
readonly:docs/**
```

Behavior:

* readable
* not writable

---

## Virtual Files

Inject synthetic files into mounted view.

Example:

* `/AGENT.md`
* `/POLICY.txt`

---

## Redacted Files

Example:

```text
redact:.env
```

Behavior:

* visible
* contents filtered/redacted

---

## Overlay Mode

Optional writable overlay layer:

* visible writes isolated from backing FS

Similar to overlayfs.

---

## Network Policy

Optional companion sandbox:

* seccomp
* namespace isolation
* network restrictions

---

# Recommended Runtime Architecture

Recommended deployment:

```text
real filesystem
AgentIgnore mount
bubblewrap sandbox
LLM agent
```

Bubblewrap provides:

* PID isolation
* mount namespace isolation
* proc isolation
* optional network isolation

AgentIgnore provides:

* filesystem visibility policy

Together they provide strong containment.

---

# CLI Specification

## Mount

```bash
agentignore mount <source> <mountpoint>
```

Example:

```bash
agentignore mount ~/project /mnt/agent
```

---

## Unmount

```bash
agentignore unmount <mountpoint>
```

---

## Validate Policy

```bash
agentignore check
```

Outputs:

* parsed rules
* invalid patterns
* conflicts

---

## Explain Decision

```bash
agentignore explain path/to/file
```

Outputs:

* visible/hidden
* matched rule
* canonical path

Example:

```text
HIDDEN
matched rule: *.pem
canonical path: /project/secrets/key.pem
```

---

# Testing Requirements

## Must Test

### Visibility

* hidden files absent from `ls`
* hidden files absent from `find`

### Direct Access

* hidden files return `ENOENT`

### Symlink Escapes

* blocked

### Rename Attacks

* blocked

### Hard Links

* blocked

### Nested Ignore Rules

* correctly evaluated

### Concurrent Access

* thread-safe behavior

### Large Trees

* acceptable traversal performance

---

# Example Session

## Real Filesystem

```text
/project
    .env
    src/main.rs
    secrets/api.key
```

`.agentignore`:

```text
.env
secrets/
```

Mount:

```bash
agentignore mount /project /mnt/agent
```

Inside mount:

```bash
cd /mnt/agent

ls
```

Output:

```text
src
```

Attempt:

```bash
cat .env
```

Result:

```text
No such file or directory
```

---

# Design Philosophy

The filesystem should implement:

> capability-filtered filesystem visibility for autonomous agents

The policy boundary must exist at the filesystem layer, not:

* prompt layer
* shell wrapper layer
* application layer

The agent must genuinely perceive hidden files as non-existent.