library-mirrors/sandbox.lua
1
0
Fork 0
mirror of https://github.com/kikito/lua-sandbox.git synced 2024-12-18 03:04:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
kikito 2013-09-13 13:56:53 +02:00
parent 549e31e7cd
commit 57224ac89d
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -10,8 +10,7 @@ Usage
local sandbox = require 'sandbox' local sandbox = require 'sandbox'
`sf = sandbox(f, options)` and `sf = sandbox.protect(f, options)` #### `sf = sandbox(f, options)` and `sf = sandbox.protect(f, options)`
-----------------------------------------------------------------
Those two are synonyms. They return a sandboxed version of `f`. Those two are synonyms. They return a sandboxed version of `f`.
@ -33,7 +32,7 @@ Only safe modules and operations can be accessed from a sandboxed function. See
f1() -- ok f1() -- ok
f2() -- error: os.execute not found f2() -- error: os.execute not found
### `options.quota (default 500000)` ##### `options.quota`
It is not possible to exhaust the machine with infinite loops; the following will throw an error after invoking 500000 instructions: It is not possible to exhaust the machine with infinite loops; the following will throw an error after invoking 500000 instructions:
@ -43,7 +42,7 @@ The amount of instructions executed can be tweaked via the `quota` option (defau
sandbox.run('while true do end', {quota=10000}) -- throw error after 10000 instructions sandbox.run('while true do end', {quota=10000}) -- throw error after 10000 instructions
### `options.env (default {})` ##### `options.env`
Use the `env` option to add additional variables to the environment Use the `env` option to add additional variables to the environment
@ -57,8 +56,7 @@ The sandboxed code can also modify the sandboxed function. Make sure to securize
assert(env.amount = 2) assert(env.amount = 2)
`result = sandbox.run(f, options, ...)` #### `result = sandbox.run(f, options, ...)`
---------------------------------------
`sandbox.run` sanboxes a function and executes it. `f` can be either a string or a function `sandbox.run` sanboxes a function and executes it. `f` can be either a string or a function