The mueval package

[Tags: bsd3, library, program]

Mueval is a Haskell interpreter. It uses the GHC API to evaluate arbitrary Haskell expressions. Importantly, mueval takes many precautions to defang and avoid "evil" code. It uses resource limits, whitelisted modules, special Show instances for IO, threads, processes, changes of directory, and so on to sandbox the Haskell code.

It is, in short, intended to be a standalone version of Lambdabot's famous evaluation functionality. For examples and explanations, please see the README file.

Mueval is POSIX-only.

[Skip to ReadMe]


Versions0.2, 0.2.1, 0.3, 0.3.1, 0.4, 0.4.5, 0.4.6, 0.5, 0.5.1, 0.6, 0.6.1, 0.6.2, 0.6.3, 0.6.4, 0.7.0, 0.7.1, 0.8, 0.8.1, 0.8.2, 0.9, 0.9.1,,
Change logNone available
Dependenciesbase (>=4 && <4.8), Cabal, containers, directory, extensible-exceptions, filepath, hint (>=0.3.1), mtl (>2), process, show (>=0.3), unix, utf8-string (==0.*) [details]
MaintainerGwern <>
CategoryDevelopment, Language
Home page
Source repositoryhead: darcs get
Executablesmueval, mueval-core
UploadedFri Mar 16 20:29:43 UTC 2012 by GwernBranwen
UpdatedFri Jun 12 09:04:23 UTC 2015 by AdamBergmark to revision 2
DistributionsDebian:, FreeBSD:, LTSHaskell:, NixOS:, Stackage:
Downloads6330 total (121 in last 30 days)
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]




Maintainers' corner

For package maintainers and hackage trustees

Readme for mueval-0.8.2

Mueval grew out of my discontent with Lambdabot: it's really neat to be able to run expressions like this:

07:53 < ivanm> > filter (\ x -> isLetter x || x == '\t') "asdf$#$     dfs"
07:55 < lambdabot>  "asdfdfs"

But Lambdabot is crufty and very difficult to install or run. IMO, we need a replacement or rewrite, but one of the things that make this difficult is that Lambdabot uses hs-plugins to get that sort of evaluation functionality, and hs-plugins is half the problem. We want some sort of standalone executable which provides that functionality. Now, 'ghc -e' is obviously unsuited because there is no sandboxing, so what I've done is basically marry the GHC API (as rendered less sharp-edged by Hint) with a bunch of resource limits and sandboxing (as largely stolen from Lambdabot).

The end result is an adorable little program, which you can use like this:

 bash-3.2$ mueval --expression '1*100+1'
 Expression type: (Num t) => t
 result: "101"

 bash-3.2$ mueval --expression "filter (\`notElem\` ['A'..'Z']) \"abcXsdzWEE\""
 Expression type: [Char]
 result: "\"abcsdz\""

Note that mueval will avoid all the attacks I've been able to test on it:

 bash-3.2$ mueval --expression 'let x = x in x'
 Expression type: t
 result: "mueval: Time limit exceeded

 bash-3.2$ mueval --expression "let foo = readFile \"/etc/passwd\" >>= print in foo"
 Expression type: IO ()
 result: "<IO ()>"

 bash-3.2$ mueval --module System.IO.Unsafe --expression "let foo = unsafePerformIO readFile \"/etc/passwd\" in foo"
 mueval: Unknown or untrusted module supplied! Aborting.

Like Lambdabot, Mueval is capable of loading a file and its definitions. This is useful to get a kind of persistence. Suppose you have a file "L.hs", with a function 'bar = (+1)' in it; then 'mueval --loadfile=L.hs --expression="bar 1"' will evaluate to, as one would expect, '2'.

It's worth noting that definitions and module imports in the loaded *ARE NOT* fully checked like the expression is. The resource limits and timeouts still apply, but little else. So if you are dynamically adding functions and module imports, you *MUST* secure them yourself or accept the loss of security. Currently, all known 'evil' expressions cause Mueval to exit with an error (a non-zero exit code), so my advice is to do something like 'mueval --expression foo && echo "\n" >> L.hs && echo foo >> L.hs'. (That is, only accept new expressions which evaluate successfully.)

Anyway, it's my hope that this will be useful as an example or useful in itself for people endeavoring to fix the Lambdabot situation or just in safely running code period.

You can download Mueval at the usual place: <>. Mueval has a public darcs repository, at <> (in the mueval/ subdirectory). Contributions are of course welcomed.

Mueval depends on a few of the standard libraries, which you should have installed already, and also on the 'Hint' library <>; Hint is particularly essential as it is the very capable wrapper around the GHC API which Mueval uses. (Without Hint, this would've been much more painful to write). All of this is cabalized, so ideally installation will be as simple as:

 sh$ cabal install mueval

However, you can still manually download and unpack the Mueval tarball, and do the usual Cabal dance:

 sh$ runhaskell Setup configure
 sh$ runhaskell Setup build
 sh$ runhaskell Setup install

Mueval uses a number of techniques for security; particularly problematic seem to be the resource limits, as they have to be specified manually & statically in the source code and so will probably be broken somewhere somewhen. For this reason, they are not enabled by default. Experiment with --rlimits for hours of fun!

Mueval also simply cannot do qualified imports. This is due to limitations in the GHC API; see <>. (Remember that CC'ing yourself is an implicit vote for the problem to be fixed!)

With darcs Hint and Mueval, compiling Mueval (or any Hint-using executable) with profiling support seems to lead to runtime crashes.

Finally, under 6.10.1, you must run Mueval with "+RTS -N2 -RTS" as otherwise the watchdog threads will not get run and DoS attacks are possible. (Compare 'mueval -e "let x = x + 1 in x"' against 'mueval -e "let x = x + 1 in x" +RTS -N2 -RTS'.)

So, you've discovered a bug or other infelicity? If you can successfully build & install Mueval, but running it on expressions leads to errors, please send me an email at <>. Include in the email all the output you see if you run the informal test suite:

 sh$ sh

If this script *does not* terminate with a success message, then there's probably something wrong. One of the properties Mueval strives to have is that on every bad expression, it errors out with an exit code of 1, and on every good expression, an exit code of 0.

If you have a patch handy, 'darcs send' is the best way to contribute. As above, should be happy, as should 'cabal check'; even better is if your email is GPG-signed, but that's not as important as passing.