summaryrefslogtreecommitdiff
path: root/lib/supple.lua
diff options
context:
space:
mode:
Diffstat (limited to 'lib/supple.lua')
-rw-r--r--lib/supple.lua10
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/supple.lua b/lib/supple.lua
index 513d3ac..f24df24 100644
--- a/lib/supple.lua
+++ b/lib/supple.lua
@@ -7,6 +7,16 @@
-- For licence terms, see COPYING
--
+--- Sandbox, for Untrusted Procedure Partitioning in Lua, Engine.
+--
+-- Supple is a mechanism for partitioning untrusted Lua code into a separate
+-- process wherein it is run sandboxed from the environment in an attempt to
+-- reduce the attack surface to a level at which administrators will be
+-- prepared to run arbitrary code from untrusted (or even expected-malicious)
+-- third parties.
+--
+-- * To see how to use supple, start at `supple.host.run`.
+
local capi = require 'supple.capi'
local request = require 'supple.request'
local objects = require 'supple.objects'