EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Lib / rexec.py

"""Restricted execution facilities.\r
\r
The class RExec exports methods r_exec(), r_eval(), r_execfile(), and\r
r_import(), which correspond roughly to the built-in operations\r
exec, eval(), execfile() and import, but executing the code in an\r
environment that only exposes those built-in operations that are\r
deemed safe.  To this end, a modest collection of 'fake' modules is\r
created which mimics the standard modules by the same names.  It is a\r
policy decision which built-in modules and operations are made\r
available; this module provides a reasonable default, but derived\r
classes can change the policies e.g. by overriding or extending class\r
variables like ok_builtin_modules or methods like make_sys().\r
\r
XXX To do:\r
- r_open should allow writing tmp dir\r
- r_exec etc. with explicit globals/locals? (Use rexec("exec ... in ...")?)\r
\r
"""\r
from warnings import warnpy3k\r
warnpy3k("the rexec module has been removed in Python 3.0", stacklevel=2)\r
del warnpy3k\r
\r
\r
import sys\r
import __builtin__\r
import os\r
import ihooks\r
import imp\r
\r
__all__ = ["RExec"]\r
\r
class FileBase:\r
\r
    ok_file_methods = ('fileno', 'flush', 'isatty', 'read', 'readline',\r
            'readlines', 'seek', 'tell', 'write', 'writelines', 'xreadlines',\r
            '__iter__')\r
\r
\r
class FileWrapper(FileBase):\r
\r
    # XXX This is just like a Bastion -- should use that!\r
\r
    def __init__(self, f):\r
        for m in self.ok_file_methods:\r
            if not hasattr(self, m) and hasattr(f, m):\r
                setattr(self, m, getattr(f, m))\r
\r
    def close(self):\r
        self.flush()\r
\r
\r
TEMPLATE = """\r
def %s(self, *args):\r
        return getattr(self.mod, self.name).%s(*args)\r
"""\r
\r
class FileDelegate(FileBase):\r
\r
    def __init__(self, mod, name):\r
        self.mod = mod\r
        self.name = name\r
\r
    for m in FileBase.ok_file_methods + ('close',):\r
        exec TEMPLATE % (m, m)\r
\r
\r
class RHooks(ihooks.Hooks):\r
\r
    def __init__(self, *args):\r
        # Hacks to support both old and new interfaces:\r
        # old interface was RHooks(rexec[, verbose])\r
        # new interface is RHooks([verbose])\r
        verbose = 0\r
        rexec = None\r
        if args and type(args[-1]) == type(0):\r
            verbose = args[-1]\r
            args = args[:-1]\r
        if args and hasattr(args[0], '__class__'):\r
            rexec = args[0]\r
            args = args[1:]\r
        if args:\r
            raise TypeError, "too many arguments"\r
        ihooks.Hooks.__init__(self, verbose)\r
        self.rexec = rexec\r
\r
    def set_rexec(self, rexec):\r
        # Called by RExec instance to complete initialization\r
        self.rexec = rexec\r
\r
    def get_suffixes(self):\r
        return self.rexec.get_suffixes()\r
\r
    def is_builtin(self, name):\r
        return self.rexec.is_builtin(name)\r
\r
    def init_builtin(self, name):\r
        m = __import__(name)\r
        return self.rexec.copy_except(m, ())\r
\r
    def init_frozen(self, name): raise SystemError, "don't use this"\r
    def load_source(self, *args): raise SystemError, "don't use this"\r
    def load_compiled(self, *args): raise SystemError, "don't use this"\r
    def load_package(self, *args): raise SystemError, "don't use this"\r
\r
    def load_dynamic(self, name, filename, file):\r
        return self.rexec.load_dynamic(name, filename, file)\r
\r
    def add_module(self, name):\r
        return self.rexec.add_module(name)\r
\r
    def modules_dict(self):\r
        return self.rexec.modules\r
\r
    def default_path(self):\r
        return self.rexec.modules['sys'].path\r
\r
\r
# XXX Backwards compatibility\r
RModuleLoader = ihooks.FancyModuleLoader\r
RModuleImporter = ihooks.ModuleImporter\r
\r
\r
class RExec(ihooks._Verbose):\r
    """Basic restricted execution framework.\r
\r
    Code executed in this restricted environment will only have access to\r
    modules and functions that are deemed safe; you can subclass RExec to\r
    add or remove capabilities as desired.\r
\r
    The RExec class can prevent code from performing unsafe operations like\r
    reading or writing disk files, or using TCP/IP sockets.  However, it does\r
    not protect against code using extremely large amounts of memory or\r
    processor time.\r
\r
    """\r
\r
    ok_path = tuple(sys.path)           # That's a policy decision\r
\r
    ok_builtin_modules = ('audioop', 'array', 'binascii',\r
                          'cmath', 'errno', 'imageop',\r
                          'marshal', 'math', 'md5', 'operator',\r
                          'parser', 'select',\r
                          'sha', '_sre', 'strop', 'struct', 'time',\r
                          '_weakref')\r
\r
    ok_posix_names = ('error', 'fstat', 'listdir', 'lstat', 'readlink',\r
                      'stat', 'times', 'uname', 'getpid', 'getppid',\r
                      'getcwd', 'getuid', 'getgid', 'geteuid', 'getegid')\r
\r
    ok_sys_names = ('byteorder', 'copyright', 'exit', 'getdefaultencoding',\r
                    'getrefcount', 'hexversion', 'maxint', 'maxunicode',\r
                    'platform', 'ps1', 'ps2', 'version', 'version_info')\r
\r
    nok_builtin_names = ('open', 'file', 'reload', '__import__')\r
\r
    ok_file_types = (imp.C_EXTENSION, imp.PY_SOURCE)\r
\r
    def __init__(self, hooks = None, verbose = 0):\r
        """Returns an instance of the RExec class.\r
\r
        The hooks parameter is an instance of the RHooks class or a subclass\r
        of it.  If it is omitted or None, the default RHooks class is\r
        instantiated.\r
\r
        Whenever the RExec module searches for a module (even a built-in one)\r
        or reads a module's code, it doesn't actually go out to the file\r
        system itself.  Rather, it calls methods of an RHooks instance that\r
        was passed to or created by its constructor.  (Actually, the RExec\r
        object doesn't make these calls --- they are made by a module loader\r
        object that's part of the RExec object.  This allows another level of\r
        flexibility, which can be useful when changing the mechanics of\r
        import within the restricted environment.)\r
\r
        By providing an alternate RHooks object, we can control the file\r
        system accesses made to import a module, without changing the\r
        actual algorithm that controls the order in which those accesses are\r
        made.  For instance, we could substitute an RHooks object that\r
        passes all filesystem requests to a file server elsewhere, via some\r
        RPC mechanism such as ILU.  Grail's applet loader uses this to support\r
        importing applets from a URL for a directory.\r
\r
        If the verbose parameter is true, additional debugging output may be\r
        sent to standard output.\r
\r
        """\r
\r
        raise RuntimeError, "This code is not secure in Python 2.2 and later"\r
\r
        ihooks._Verbose.__init__(self, verbose)\r
        # XXX There's a circular reference here:\r
        self.hooks = hooks or RHooks(verbose)\r
        self.hooks.set_rexec(self)\r
        self.modules = {}\r
        self.ok_dynamic_modules = self.ok_builtin_modules\r
        list = []\r
        for mname in self.ok_builtin_modules:\r
            if mname in sys.builtin_module_names:\r
                list.append(mname)\r
        self.ok_builtin_modules = tuple(list)\r
        self.set_trusted_path()\r
        self.make_builtin()\r
        self.make_initial_modules()\r
        # make_sys must be last because it adds the already created\r
        # modules to its builtin_module_names\r
        self.make_sys()\r
        self.loader = RModuleLoader(self.hooks, verbose)\r
        self.importer = RModuleImporter(self.loader, verbose)\r
\r
    def set_trusted_path(self):\r
        # Set the path from which dynamic modules may be loaded.\r
        # Those dynamic modules must also occur in ok_builtin_modules\r
        self.trusted_path = filter(os.path.isabs, sys.path)\r
\r
    def load_dynamic(self, name, filename, file):\r
        if name not in self.ok_dynamic_modules:\r
            raise ImportError, "untrusted dynamic module: %s" % name\r
        if name in sys.modules:\r
            src = sys.modules[name]\r
        else:\r
            src = imp.load_dynamic(name, filename, file)\r
        dst = self.copy_except(src, [])\r
        return dst\r
\r
    def make_initial_modules(self):\r
        self.make_main()\r
        self.make_osname()\r
\r
    # Helpers for RHooks\r
\r
    def get_suffixes(self):\r
        return [item   # (suff, mode, type)\r
                for item in imp.get_suffixes()\r
                if item[2] in self.ok_file_types]\r
\r
    def is_builtin(self, mname):\r
        return mname in self.ok_builtin_modules\r
\r
    # The make_* methods create specific built-in modules\r
\r
    def make_builtin(self):\r
        m = self.copy_except(__builtin__, self.nok_builtin_names)\r
        m.__import__ = self.r_import\r
        m.reload = self.r_reload\r
        m.open = m.file = self.r_open\r
\r
    def make_main(self):\r
        self.add_module('__main__')\r
\r
    def make_osname(self):\r
        osname = os.name\r
        src = __import__(osname)\r
        dst = self.copy_only(src, self.ok_posix_names)\r
        dst.environ = e = {}\r
        for key, value in os.environ.items():\r
            e[key] = value\r
\r
    def make_sys(self):\r
        m = self.copy_only(sys, self.ok_sys_names)\r
        m.modules = self.modules\r
        m.argv = ['RESTRICTED']\r
        m.path = map(None, self.ok_path)\r
        m.exc_info = self.r_exc_info\r
        m = self.modules['sys']\r
        l = self.modules.keys() + list(self.ok_builtin_modules)\r
        l.sort()\r
        m.builtin_module_names = tuple(l)\r
\r
    # The copy_* methods copy existing modules with some changes\r
\r
    def copy_except(self, src, exceptions):\r
        dst = self.copy_none(src)\r
        for name in dir(src):\r
            setattr(dst, name, getattr(src, name))\r
        for name in exceptions:\r
            try:\r
                delattr(dst, name)\r
            except AttributeError:\r
                pass\r
        return dst\r
\r
    def copy_only(self, src, names):\r
        dst = self.copy_none(src)\r
        for name in names:\r
            try:\r
                value = getattr(src, name)\r
            except AttributeError:\r
                continue\r
            setattr(dst, name, value)\r
        return dst\r
\r
    def copy_none(self, src):\r
        m = self.add_module(src.__name__)\r
        m.__doc__ = src.__doc__\r
        return m\r
\r
    # Add a module -- return an existing module or create one\r
\r
    def add_module(self, mname):\r
        m = self.modules.get(mname)\r
        if m is None:\r
            self.modules[mname] = m = self.hooks.new_module(mname)\r
        m.__builtins__ = self.modules['__builtin__']\r
        return m\r
\r
    # The r* methods are public interfaces\r
\r
    def r_exec(self, code):\r
        """Execute code within a restricted environment.\r
\r
        The code parameter must either be a string containing one or more\r
        lines of Python code, or a compiled code object, which will be\r
        executed in the restricted environment's __main__ module.\r
\r
        """\r
        m = self.add_module('__main__')\r
        exec code in m.__dict__\r
\r
    def r_eval(self, code):\r
        """Evaluate code within a restricted environment.\r
\r
        The code parameter must either be a string containing a Python\r
        expression, or a compiled code object, which will be evaluated in\r
        the restricted environment's __main__ module.  The value of the\r
        expression or code object will be returned.\r
\r
        """\r
        m = self.add_module('__main__')\r
        return eval(code, m.__dict__)\r
\r
    def r_execfile(self, file):\r
        """Execute the Python code in the file in the restricted\r
        environment's __main__ module.\r
\r
        """\r
        m = self.add_module('__main__')\r
        execfile(file, m.__dict__)\r
\r
    def r_import(self, mname, globals={}, locals={}, fromlist=[]):\r
        """Import a module, raising an ImportError exception if the module\r
        is considered unsafe.\r
\r
        This method is implicitly called by code executing in the\r
        restricted environment.  Overriding this method in a subclass is\r
        used to change the policies enforced by a restricted environment.\r
\r
        """\r
        return self.importer.import_module(mname, globals, locals, fromlist)\r
\r
    def r_reload(self, m):\r
        """Reload the module object, re-parsing and re-initializing it.\r
\r
        This method is implicitly called by code executing in the\r
        restricted environment.  Overriding this method in a subclass is\r
        used to change the policies enforced by a restricted environment.\r
\r
        """\r
        return self.importer.reload(m)\r
\r
    def r_unload(self, m):\r
        """Unload the module.\r
\r
        Removes it from the restricted environment's sys.modules dictionary.\r
\r
        This method is implicitly called by code executing in the\r
        restricted environment.  Overriding this method in a subclass is\r
        used to change the policies enforced by a restricted environment.\r
\r
        """\r
        return self.importer.unload(m)\r
\r
    # The s_* methods are similar but also swap std{in,out,err}\r
\r
    def make_delegate_files(self):\r
        s = self.modules['sys']\r
        self.delegate_stdin = FileDelegate(s, 'stdin')\r
        self.delegate_stdout = FileDelegate(s, 'stdout')\r
        self.delegate_stderr = FileDelegate(s, 'stderr')\r
        self.restricted_stdin = FileWrapper(sys.stdin)\r
        self.restricted_stdout = FileWrapper(sys.stdout)\r
        self.restricted_stderr = FileWrapper(sys.stderr)\r
\r
    def set_files(self):\r
        if not hasattr(self, 'save_stdin'):\r
            self.save_files()\r
        if not hasattr(self, 'delegate_stdin'):\r
            self.make_delegate_files()\r
        s = self.modules['sys']\r
        s.stdin = self.restricted_stdin\r
        s.stdout = self.restricted_stdout\r
        s.stderr = self.restricted_stderr\r
        sys.stdin = self.delegate_stdin\r
        sys.stdout = self.delegate_stdout\r
        sys.stderr = self.delegate_stderr\r
\r
    def reset_files(self):\r
        self.restore_files()\r
        s = self.modules['sys']\r
        self.restricted_stdin = s.stdin\r
        self.restricted_stdout = s.stdout\r
        self.restricted_stderr = s.stderr\r
\r
\r
    def save_files(self):\r
        self.save_stdin = sys.stdin\r
        self.save_stdout = sys.stdout\r
        self.save_stderr = sys.stderr\r
\r
    def restore_files(self):\r
        sys.stdin = self.save_stdin\r
        sys.stdout = self.save_stdout\r
        sys.stderr = self.save_stderr\r
\r
    def s_apply(self, func, args=(), kw={}):\r
        self.save_files()\r
        try:\r
            self.set_files()\r
            r = func(*args, **kw)\r
        finally:\r
            self.restore_files()\r
        return r\r
\r
    def s_exec(self, *args):\r
        """Execute code within a restricted environment.\r
\r
        Similar to the r_exec() method, but the code will be granted access\r
        to restricted versions of the standard I/O streams sys.stdin,\r
        sys.stderr, and sys.stdout.\r
\r
        The code parameter must either be a string containing one or more\r
        lines of Python code, or a compiled code object, which will be\r
        executed in the restricted environment's __main__ module.\r
\r
        """\r
        return self.s_apply(self.r_exec, args)\r
\r
    def s_eval(self, *args):\r
        """Evaluate code within a restricted environment.\r
\r
        Similar to the r_eval() method, but the code will be granted access\r
        to restricted versions of the standard I/O streams sys.stdin,\r
        sys.stderr, and sys.stdout.\r
\r
        The code parameter must either be a string containing a Python\r
        expression, or a compiled code object, which will be evaluated in\r
        the restricted environment's __main__ module.  The value of the\r
        expression or code object will be returned.\r
\r
        """\r
        return self.s_apply(self.r_eval, args)\r
\r
    def s_execfile(self, *args):\r
        """Execute the Python code in the file in the restricted\r
        environment's __main__ module.\r
\r
        Similar to the r_execfile() method, but the code will be granted\r
        access to restricted versions of the standard I/O streams sys.stdin,\r
        sys.stderr, and sys.stdout.\r
\r
        """\r
        return self.s_apply(self.r_execfile, args)\r
\r
    def s_import(self, *args):\r
        """Import a module, raising an ImportError exception if the module\r
        is considered unsafe.\r
\r
        This method is implicitly called by code executing in the\r
        restricted environment.  Overriding this method in a subclass is\r
        used to change the policies enforced by a restricted environment.\r
\r
        Similar to the r_import() method, but has access to restricted\r
        versions of the standard I/O streams sys.stdin, sys.stderr, and\r
        sys.stdout.\r
\r
        """\r
        return self.s_apply(self.r_import, args)\r
\r
    def s_reload(self, *args):\r
        """Reload the module object, re-parsing and re-initializing it.\r
\r
        This method is implicitly called by code executing in the\r
        restricted environment.  Overriding this method in a subclass is\r
        used to change the policies enforced by a restricted environment.\r
\r
        Similar to the r_reload() method, but has access to restricted\r
        versions of the standard I/O streams sys.stdin, sys.stderr, and\r
        sys.stdout.\r
\r
        """\r
        return self.s_apply(self.r_reload, args)\r
\r
    def s_unload(self, *args):\r
        """Unload the module.\r
\r
        Removes it from the restricted environment's sys.modules dictionary.\r
\r
        This method is implicitly called by code executing in the\r
        restricted environment.  Overriding this method in a subclass is\r
        used to change the policies enforced by a restricted environment.\r
\r
        Similar to the r_unload() method, but has access to restricted\r
        versions of the standard I/O streams sys.stdin, sys.stderr, and\r
        sys.stdout.\r
\r
        """\r
        return self.s_apply(self.r_unload, args)\r
\r
    # Restricted open(...)\r
\r
    def r_open(self, file, mode='r', buf=-1):\r
        """Method called when open() is called in the restricted environment.\r
\r
        The arguments are identical to those of the open() function, and a\r
        file object (or a class instance compatible with file objects)\r
        should be returned.  RExec's default behaviour is allow opening\r
        any file for reading, but forbidding any attempt to write a file.\r
\r
        This method is implicitly called by code executing in the\r
        restricted environment.  Overriding this method in a subclass is\r
        used to change the policies enforced by a restricted environment.\r
\r
        """\r
        mode = str(mode)\r
        if mode not in ('r', 'rb'):\r
            raise IOError, "can't open files for writing in restricted mode"\r
        return open(file, mode, buf)\r
\r
    # Restricted version of sys.exc_info()\r
\r
    def r_exc_info(self):\r
        ty, va, tr = sys.exc_info()\r
        tr = None\r
        return ty, va, tr\r
\r
\r
def test():\r
    import getopt, traceback\r
    opts, args = getopt.getopt(sys.argv[1:], 'vt:')\r
    verbose = 0\r
    trusted = []\r
    for o, a in opts:\r
        if o == '-v':\r
            verbose = verbose+1\r
        if o == '-t':\r
            trusted.append(a)\r
    r = RExec(verbose=verbose)\r
    if trusted:\r
        r.ok_builtin_modules = r.ok_builtin_modules + tuple(trusted)\r
    if args:\r
        r.modules['sys'].argv = args\r
        r.modules['sys'].path.insert(0, os.path.dirname(args[0]))\r
    else:\r
        r.modules['sys'].path.insert(0, "")\r
    fp = sys.stdin\r
    if args and args[0] != '-':\r
        try:\r
            fp = open(args[0])\r
        except IOError, msg:\r
            print "%s: can't open file %r" % (sys.argv[0], args[0])\r
            return 1\r
    if fp.isatty():\r
        try:\r
            import readline\r
        except ImportError:\r
            pass\r
        import code\r
        class RestrictedConsole(code.InteractiveConsole):\r
            def runcode(self, co):\r
                self.locals['__builtins__'] = r.modules['__builtin__']\r
                r.s_apply(code.InteractiveConsole.runcode, (self, co))\r
        try:\r
            RestrictedConsole(r.modules['__main__'].__dict__).interact()\r
        except SystemExit, n:\r
            return n\r
    else:\r
        text = fp.read()\r
        fp.close()\r
        c = compile(text, fp.name, 'exec')\r
        try:\r
            r.s_exec(c)\r
        except SystemExit, n:\r
            return n\r
        except:\r
            traceback.print_exc()\r
            return 1\r
\r
\r
if __name__ == '__main__':\r
    sys.exit(test())\r