aboutsummaryrefslogtreecommitdiff
path: root/src/lib/sandbox/lib_sandbox.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/sandbox/lib_sandbox.dox')
-rw-r--r--src/lib/sandbox/lib_sandbox.dox17
1 files changed, 15 insertions, 2 deletions
diff --git a/src/lib/sandbox/lib_sandbox.dox b/src/lib/sandbox/lib_sandbox.dox
index eb42d97589..48eddac685 100644
--- a/src/lib/sandbox/lib_sandbox.dox
+++ b/src/lib/sandbox/lib_sandbox.dox
@@ -1,4 +1,17 @@
/**
-@dir lib/sandbox
-@brief lib/sandbox
+@dir /lib/sandbox
+@brief lib/sandbox: Linux seccomp2-based sandbox.
+
+This module uses Linux's seccomp2 facility via the
+[`libseccomp` library](https://github.com/seccomp/libseccomp), to restrict
+the set of system calls that Tor is allowed to invoke while it is running.
+
+Because there are many libc versions that invoke different system calls, and
+because handling strings is quite complex, this module is more complex and
+less portable than it needs to be.
+
+A better architecture would put the responsibility for invoking tricky system
+calls (like open()) in another, less restricted process, and give that
+process responsibility for enforcing our sandbox rules.
+
**/