Gecko [ v99win.today ]

Name	Size	Permission
2to3.html	63.71 KB	-rw-r--r--
__builtin__.html	11.79 KB	-rw-r--r--
__future__.html	15.58 KB	-rw-r--r--
__main__.html	8.33 KB	-rw-r--r--
_winreg.html	73.99 KB	-rw-r--r--
abc.html	26.82 KB	-rw-r--r--
aepack.html	15.47 KB	-rw-r--r--
aetools.html	18.79 KB	-rw-r--r--
aetypes.html	27.08 KB	-rw-r--r--
aifc.html	29.59 KB	-rw-r--r--
al.html	22.13 KB	-rw-r--r--
allos.html	35.48 KB	-rw-r--r--
anydbm.html	19.31 KB	-rw-r--r--
archiving.html	10.64 KB	-rw-r--r--
argparse.html	269.59 KB	-rw-r--r--
array.html	35.35 KB	-rw-r--r--
ast.html	42.42 KB	-rw-r--r--
asynchat.html	35.84 KB	-rw-r--r--
asyncore.html	43.22 KB	-rw-r--r--
atexit.html	19.23 KB	-rw-r--r--
audioop.html	41.32 KB	-rw-r--r--
autogil.html	9.77 KB	-rw-r--r--
base64.html	24.8 KB	-rw-r--r--
basehttpserver.html	40.6 KB	-rw-r--r--
bastion.html	13.02 KB	-rw-r--r--
bdb.html	50.06 KB	-rw-r--r--
binascii.html	26.64 KB	-rw-r--r--
binhex.html	12.66 KB	-rw-r--r--
bisect.html	28.52 KB	-rw-r--r--
bsddb.html	32.02 KB	-rw-r--r--
bz2.html	31.92 KB	-rw-r--r--
calendar.html	50.16 KB	-rw-r--r--
carbon.html	54.14 KB	-rw-r--r--
cd.html	35.24 KB	-rw-r--r--
cgi.html	58.4 KB	-rw-r--r--
cgihttpserver.html	15.12 KB	-rw-r--r--
cgitb.html	13.5 KB	-rw-r--r--
chunk.html	17.41 KB	-rw-r--r--
cmath.html	32.41 KB	-rw-r--r--
cmd.html	32.69 KB	-rw-r--r--
code.html	28.92 KB	-rw-r--r--
codecs.html	125.92 KB	-rw-r--r--
codeop.html	16.42 KB	-rw-r--r--
collections.html	150.36 KB	-rw-r--r--
colorpicker.html	9.02 KB	-rw-r--r--
colorsys.html	14.38 KB	-rw-r--r--
commands.html	16.63 KB	-rw-r--r--
compileall.html	21.18 KB	-rw-r--r--
compiler.html	78.14 KB	-rw-r--r--
configparser.html	73.92 KB	-rw-r--r--
constants.html	14.68 KB	-rw-r--r--
contextlib.html	22.91 KB	-rw-r--r--
cookie.html	45.38 KB	-rw-r--r--
cookielib.html	102.78 KB	-rw-r--r--
copy.html	14.21 KB	-rw-r--r--
copy_reg.html	15.82 KB	-rw-r--r--
crypt.html	11.62 KB	-rw-r--r--
crypto.html	8.35 KB	-rw-r--r--
csv.html	82.79 KB	-rw-r--r--
ctypes.html	280.57 KB	-rw-r--r--
curses.ascii.html	28.97 KB	-rw-r--r--
curses.html	200.94 KB	-rw-r--r--
curses.panel.html	18.43 KB	-rw-r--r--
custominterp.html	8.59 KB	-rw-r--r--
datatypes.html	18.84 KB	-rw-r--r--
datetime.html	261.02 KB	-rw-r--r--
dbhash.html	18.4 KB	-rw-r--r--
dbm.html	14.75 KB	-rw-r--r--
debug.html	11.28 KB	-rw-r--r--
decimal.html	239.14 KB	-rw-r--r--
development.html	15.27 KB	-rw-r--r--
difflib.html	96.93 KB	-rw-r--r--
dircache.html	13.66 KB	-rw-r--r--
dis.html	96.52 KB	-rw-r--r--
distribution.html	8.27 KB	-rw-r--r--
distutils.html	10.97 KB	-rw-r--r--
dl.html	19.27 KB	-rw-r--r--
doctest.html	193.18 KB	-rw-r--r--
docxmlrpcserver.html	20.02 KB	-rw-r--r--
dumbdbm.html	16.74 KB	-rw-r--r--
dummy_thread.html	11.04 KB	-rw-r--r--
dummy_threading.html	9.96 KB	-rw-r--r--
easydialogs.html	38.83 KB	-rw-r--r--
email-examples.html	47.2 KB	-rw-r--r--
email.charset.html	32.45 KB	-rw-r--r--
email.encoders.html	14.09 KB	-rw-r--r--
email.errors.html	19.2 KB	-rw-r--r--
email.generator.html	24.78 KB	-rw-r--r--
email.header.html	31.12 KB	-rw-r--r--
email.html	55.3 KB	-rw-r--r--
email.iterators.html	14.22 KB	-rw-r--r--
email.message.html	74.91 KB	-rw-r--r--
email.mime.html	34.51 KB	-rw-r--r--
email.parser.html	37.09 KB	-rw-r--r--
email.utils.html	30.04 KB	-rw-r--r--
ensurepip.html	20.21 KB	-rw-r--r--
errno.html	52.31 KB	-rw-r--r--
exceptions.html	73.4 KB	-rw-r--r--
fcntl.html	27.85 KB	-rw-r--r--
filecmp.html	26.49 KB	-rw-r--r--
fileformats.html	10.21 KB	-rw-r--r--
fileinput.html	29.36 KB	-rw-r--r--
filesys.html	11.55 KB	-rw-r--r--
fl.html	71.58 KB	-rw-r--r--
fm.html	15 KB	-rw-r--r--
fnmatch.html	17.78 KB	-rw-r--r--
formatter.html	43.91 KB	-rw-r--r--
fpectl.html	17.84 KB	-rw-r--r--
fpformat.html	12.65 KB	-rw-r--r--
fractions.html	27.17 KB	-rw-r--r--
framework.html	44.24 KB	-rw-r--r--
frameworks.html	8.11 KB	-rw-r--r--
ftplib.html	56.56 KB	-rw-r--r--
functions.html	216.84 KB	-rw-r--r--
functools.html	31.06 KB	-rw-r--r--
future_builtins.html	15.9 KB	-rw-r--r--
gc.html	30.74 KB	-rw-r--r--
gdbm.html	19.35 KB	-rw-r--r--
gensuitemodule.html	14.54 KB	-rw-r--r--
getopt.html	26.56 KB	-rw-r--r--
getpass.html	12.5 KB	-rw-r--r--
gettext.html	91.32 KB	-rw-r--r--
gl.html	26.71 KB	-rw-r--r--
glob.html	15.42 KB	-rw-r--r--
grp.html	12.33 KB	-rw-r--r--
gzip.html	21.95 KB	-rw-r--r--
hashlib.html	27.4 KB	-rw-r--r--
heapq.html	36.72 KB	-rw-r--r--
hmac.html	15.97 KB	-rw-r--r--
hotshot.html	22.69 KB	-rw-r--r--
htmllib.html	29.9 KB	-rw-r--r--
htmlparser.html	45.11 KB	-rw-r--r--
httplib.html	78.55 KB	-rw-r--r--
i18n.html	10.61 KB	-rw-r--r--
ic.html	22.03 KB	-rw-r--r--
idle.html	45.74 KB	-rw-r--r--
imageop.html	20.94 KB	-rw-r--r--
imaplib.html	69.9 KB	-rw-r--r--
imgfile.html	14.91 KB	-rw-r--r--
imghdr.html	13.43 KB	-rw-r--r--
imp.html	41.48 KB	-rw-r--r--
importlib.html	10.27 KB	-rw-r--r--
imputil.html	36.11 KB	-rw-r--r--
index.html	82.54 KB	-rw-r--r--
inspect.html	64.31 KB	-rw-r--r--
internet.html	26.77 KB	-rw-r--r--
intro.html	9.76 KB	-rw-r--r--
io.html	122.3 KB	-rw-r--r--
ipc.html	17.18 KB	-rw-r--r--
itertools.html	129.91 KB	-rw-r--r--
jpeg.html	15.36 KB	-rw-r--r--
json.html	79.09 KB	-rw-r--r--
keyword.html	9.27 KB	-rw-r--r--
language.html	12.35 KB	-rw-r--r--
linecache.html	12.7 KB	-rw-r--r--
locale.html	68.54 KB	-rw-r--r--
logging.config.html	82.23 KB	-rw-r--r--
logging.handlers.html	91.96 KB	-rw-r--r--
logging.html	123.15 KB	-rw-r--r--
mac.html	24.49 KB	-rw-r--r--
macos.html	18.51 KB	-rw-r--r--
macosa.html	14.55 KB	-rw-r--r--
macostools.html	19.67 KB	-rw-r--r--
macpath.html	9.19 KB	-rw-r--r--
mailbox.html	185.53 KB	-rw-r--r--
mailcap.html	15.3 KB	-rw-r--r--
markup.html	20.37 KB	-rw-r--r--
marshal.html	19.88 KB	-rw-r--r--
math.html	50.52 KB	-rw-r--r--
md5.html	16.65 KB	-rw-r--r--
mhlib.html	30.04 KB	-rw-r--r--
mimetools.html	23.84 KB	-rw-r--r--
mimetypes.html	35.82 KB	-rw-r--r--
mimewriter.html	18.19 KB	-rw-r--r--
mimify.html	16.96 KB	-rw-r--r--
miniaeframe.html	14.5 KB	-rw-r--r--
misc.html	7.77 KB	-rw-r--r--
mm.html	10.19 KB	-rw-r--r--
mmap.html	33.52 KB	-rw-r--r--
modulefinder.html	19.85 KB	-rw-r--r--
modules.html	9.68 KB	-rw-r--r--
msilib.html	72.78 KB	-rw-r--r--
msvcrt.html	24.1 KB	-rw-r--r--
multifile.html	28.82 KB	-rw-r--r--
multiprocessing.html	423.97 KB	-rw-r--r--
mutex.html	13.56 KB	-rw-r--r--
netdata.html	19.28 KB	-rw-r--r--
netrc.html	15.51 KB	-rw-r--r--
new.html	16.1 KB	-rw-r--r--
nis.html	13.19 KB	-rw-r--r--
nntplib.html	51.08 KB	-rw-r--r--
numbers.html	40.91 KB	-rw-r--r--
numeric.html	14.85 KB	-rw-r--r--
operator.html	118.32 KB	-rw-r--r--
optparse.html	251.08 KB	-rw-r--r--
os.html	270.49 KB	-rw-r--r--
os.path.html	48.87 KB	-rw-r--r--
ossaudiodev.html	49.79 KB	-rw-r--r--
othergui.html	9.98 KB	-rw-r--r--
parser.html	44.52 KB	-rw-r--r--
pdb.html	41.44 KB	-rw-r--r--
persistence.html	16.25 KB	-rw-r--r--
pickle.html	107.94 KB	-rw-r--r--
pickletools.html	13.21 KB	-rw-r--r--
pipes.html	21.85 KB	-rw-r--r--
pkgutil.html	30.59 KB	-rw-r--r--
platform.html	40.14 KB	-rw-r--r--
plistlib.html	20.96 KB	-rw-r--r--
popen2.html	30.13 KB	-rw-r--r--
poplib.html	27.93 KB	-rw-r--r--
posix.html	17.27 KB	-rw-r--r--
posixfile.html	23.68 KB	-rw-r--r--
pprint.html	36.42 KB	-rw-r--r--
profile.html	76.65 KB	-rw-r--r--
pty.html	11.42 KB	-rw-r--r--
pwd.html	13.53 KB	-rw-r--r--
py_compile.html	13.33 KB	-rw-r--r--
pyclbr.html	18.14 KB	-rw-r--r--
pydoc.html	14.33 KB	-rw-r--r--
pyexpat.html	93.28 KB	-rw-r--r--
python.html	13.53 KB	-rw-r--r--
queue.html	29.64 KB	-rw-r--r--
quopri.html	14.5 KB	-rw-r--r--
random.html	47.78 KB	-rw-r--r--
re.html	163.11 KB	-rw-r--r--
readline.html	41.2 KB	-rw-r--r--
repr.html	24.57 KB	-rw-r--r--
resource.html	30.86 KB	-rw-r--r--
restricted.html	12.69 KB	-rw-r--r--
rexec.html	43.59 KB	-rw-r--r--
rfc822.html	51.25 KB	-rw-r--r--
rlcompleter.html	15.29 KB	-rw-r--r--
robotparser.html	15.01 KB	-rw-r--r--
runpy.html	23.55 KB	-rw-r--r--
sched.html	21.76 KB	-rw-r--r--
scrolledtext.html	10.67 KB	-rw-r--r--
select.html	50.17 KB	-rw-r--r--
sets.html	39.92 KB	-rw-r--r--
sgi.html	11.09 KB	-rw-r--r--
sgmllib.html	38.77 KB	-rw-r--r--
sha.html	14.55 KB	-rw-r--r--
shelve.html	32.93 KB	-rw-r--r--
shlex.html	38.43 KB	-rw-r--r--
shutil.html	49.49 KB	-rw-r--r--
signal.html	36.52 KB	-rw-r--r--
simplehttpserver.html	21.57 KB	-rw-r--r--
simplexmlrpcserver.html	40.41 KB	-rw-r--r--
site.html	29 KB	-rw-r--r--
smtpd.html	15.64 KB	-rw-r--r--
smtplib.html	51.86 KB	-rw-r--r--
sndhdr.html	12.05 KB	-rw-r--r--
socket.html	126.94 KB	-rw-r--r--
socketserver.html	81.38 KB	-rw-r--r--
someos.html	17.09 KB	-rw-r--r--
spwd.html	12.25 KB	-rw-r--r--
sqlite3.html	154.12 KB	-rw-r--r--
ssl.html	214.5 KB	-rw-r--r--
stat.html	41.11 KB	-rw-r--r--
statvfs.html	13.24 KB	-rw-r--r--
stdtypes.html	309.83 KB	-rw-r--r--
string.html	129.58 KB	-rw-r--r--
stringio.html	21.1 KB	-rw-r--r--
stringprep.html	21.4 KB	-rw-r--r--
strings.html	16.42 KB	-rw-r--r--
struct.html	47.68 KB	-rw-r--r--
subprocess.html	117 KB	-rw-r--r--
sun.html	7.83 KB	-rw-r--r--
sunau.html	35.43 KB	-rw-r--r--
sunaudio.html	21.05 KB	-rw-r--r--
symbol.html	9.06 KB	-rw-r--r--
symtable.html	29.03 KB	-rw-r--r--
sys.html	118.12 KB	-rw-r--r--
sysconfig.html	28.8 KB	-rw-r--r--
syslog.html	21.29 KB	-rw-r--r--
tabnanny.html	12.78 KB	-rw-r--r--
tarfile.html	99.54 KB	-rw-r--r--
telnetlib.html	30.46 KB	-rw-r--r--
tempfile.html	35.02 KB	-rw-r--r--
termios.html	19.22 KB	-rw-r--r--
test.html	61.42 KB	-rw-r--r--
textwrap.html	32.28 KB	-rw-r--r--
thread.html	22.67 KB	-rw-r--r--
threading.html	92.04 KB	-rw-r--r--
time.html	65.55 KB	-rw-r--r--
timeit.html	44.38 KB	-rw-r--r--
tix.html	56.73 KB	-rw-r--r--
tk.html	26.76 KB	-rw-r--r--
tkinter.html	86.67 KB	-rw-r--r--
token.html	27.31 KB	-rw-r--r--
tokenize.html	21.69 KB	-rw-r--r--
trace.html	33.91 KB	-rw-r--r--
traceback.html	44.22 KB	-rw-r--r--
ttk.html	123.83 KB	-rw-r--r--
tty.html	10.95 KB	-rw-r--r--
turtle.html	246.17 KB	-rw-r--r--
types.html	33.66 KB	-rw-r--r--
undoc.html	25.54 KB	-rw-r--r--
unicodedata.html	22.64 KB	-rw-r--r--
unittest.html	246.75 KB	-rw-r--r--
unix.html	11.9 KB	-rw-r--r--
urllib.html	71.61 KB	-rw-r--r--
urllib2.html	128.77 KB	-rw-r--r--
urlparse.html	49.04 KB	-rw-r--r--
user.html	13.41 KB	-rw-r--r--
userdict.html	32.96 KB	-rw-r--r--
uu.html	13.25 KB	-rw-r--r--
uuid.html	33.55 KB	-rw-r--r--
warnings.html	51.86 KB	-rw-r--r--
wave.html	29.08 KB	-rw-r--r--
weakref.html	41.14 KB	-rw-r--r--
webbrowser.html	29.53 KB	-rw-r--r--
whichdb.html	10.44 KB	-rw-r--r--
windows.html	10.37 KB	-rw-r--r--
winsound.html	22.56 KB	-rw-r--r--
wsgiref.html	94.38 KB	-rw-r--r--
xdrlib.html	38.05 KB	-rw-r--r--
xml.dom.html	110.39 KB	-rw-r--r--
xml.dom.minidom.html	45.23 KB	-rw-r--r--
xml.dom.pulldom.html	16.32 KB	-rw-r--r--
xml.etree.elementtree.html	124.2 KB	-rw-r--r--
xml.html	18.76 KB	-rw-r--r--
xml.sax.handler.html	47.5 KB	-rw-r--r--
xml.sax.html	26.04 KB	-rw-r--r--
xml.sax.reader.html	51.4 KB	-rw-r--r--
xml.sax.utils.html	18.11 KB	-rw-r--r--
xmlrpclib.html	71.79 KB	-rw-r--r--
zipfile.html	67.26 KB	-rw-r--r--
zipimport.html	24.32 KB	-rw-r--r--
zlib.html	34.41 KB	-rw-r--r--

Code Editor : rexec.html

<!DOCTYPE html>

<title>30.1. rexec — Restricted execution framework &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="30.2. Bastion — Restricting access to objects" href="bastion.html" />
 <link rel="prev" title="30. Restricted Execution" href="restricted.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/rexec.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/rexec.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="bastion.html" title="30.2. Bastion — Restricting access to objects"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="restricted.html" title="30. Restricted Execution"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="restricted.html" accesskey="U">30. Restricted Execution</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">30.1. <code class="xref py py-mod docutils literal notranslate">rexec</code> — Restricted execution framework</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-rexec">
<h1>30.1. <a class="reference internal" href="#module-rexec" title="rexec: Basic restricted execution framework. (deprecated)"><code class="xref py py-mod docutils literal notranslate">rexec</code></a> — Restricted execution framework<a class="headerlink" href="#module-rexec" title="Permalink to this headline">¶</a></h1>
<div class="deprecated">
Deprecated since version 2.6: The <a class="reference internal" href="#module-rexec" title="rexec: Basic restricted execution framework. (deprecated)"><code class="xref py py-mod docutils literal notranslate">rexec</code></a> module has been removed in Python 3.
</div>
<div class="versionchanged">
Changed in version 2.3: Disabled module.
</div>
<div class="admonition warning">
Warning
The documentation has been left in place to help in reading old code that uses
the module.
</div>
This module contains the <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> class, which supports <code class="xref py py-meth docutils literal notranslate">r_eval()</code>,
<code class="xref py py-meth docutils literal notranslate">r_execfile()</code>, <code class="xref py py-meth docutils literal notranslate">r_exec()</code>, and <code class="xref py py-meth docutils literal notranslate">r_import()</code> methods, which are
restricted versions of the standard Python functions <a class="reference internal" href="functions.html#eval" title="eval"><code class="xref py py-meth docutils literal notranslate">eval()</code></a>,
<a class="reference internal" href="functions.html#execfile" title="execfile"><code class="xref py py-meth docutils literal notranslate">execfile()</code></a> and the <a class="reference internal" href="../reference/simple_stmts.html#exec"><code class="xref std std-keyword docutils literal notranslate">exec</code></a> and <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> statements. Code
executed in this restricted environment will only have access to modules and
functions that are deemed safe; you can subclass <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> to add or remove
capabilities as desired.
<div class="admonition warning">
Warning
While the <a class="reference internal" href="#module-rexec" title="rexec: Basic restricted execution framework. (deprecated)"><code class="xref py py-mod docutils literal notranslate">rexec</code></a> module is designed to perform as described below, it does
have a few known vulnerabilities which could be exploited by carefully written
code. Thus it should not be relied upon in situations requiring “production
ready” security. In such situations, execution via sub-processes or very
careful “cleansing” of both code and data to be processed may be necessary.
Alternatively, help in patching known <a class="reference internal" href="#module-rexec" title="rexec: Basic restricted execution framework. (deprecated)"><code class="xref py py-mod docutils literal notranslate">rexec</code></a> vulnerabilities would be
welcomed.
</div>
<div class="admonition note">
Note
The <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> class can prevent code from performing unsafe operations like
reading or writing disk files, or using TCP/IP sockets. However, it does not
protect against code using extremely large amounts of memory or processor time.
</div>
<dl class="py class">
<dt class="sig sig-object py" id="rexec.RExec">
class rexec.RExec([hooks[, verbose]])<a class="headerlink" href="#rexec.RExec" title="Permalink to this definition">¶</a></dt>
<dd>Returns an instance of the <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> class.
hooks is an instance of the <code class="xref py py-class docutils literal notranslate">RHooks</code> class or a subclass of it. If it
is omitted or <code class="docutils literal notranslate">None</code>, the default <code class="xref py py-class docutils literal notranslate">RHooks</code> class is instantiated.
Whenever the <a class="reference internal" href="#module-rexec" title="rexec: Basic restricted execution framework. (deprecated)"><code class="xref py py-mod docutils literal notranslate">rexec</code></a> module searches for a module (even a built-in one) or
reads a module’s code, it doesn’t actually go out to the file system itself.
Rather, it calls methods of an <code class="xref py py-class docutils literal notranslate">RHooks</code> instance that was passed to or
created by its constructor. (Actually, the <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> object doesn’t make
these calls — they are made by a module loader object that’s part of the
<a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> object. This allows another level of flexibility, which can be
useful when changing the mechanics of <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> within the restricted
environment.)
By providing an alternate <code class="xref py py-class docutils literal notranslate">RHooks</code> object, we can control the file system
accesses made to import a module, without changing the actual algorithm that
controls the order in which those accesses are made. For instance, we could
substitute an <code class="xref py py-class docutils literal notranslate">RHooks</code> object that passes all filesystem requests to a
file server elsewhere, via some RPC mechanism such as ILU. Grail’s applet
loader uses this to support importing applets from a URL for a directory.
If verbose is true, additional debugging output may be sent to standard
output.
</dd></dl>

It is important to be aware that code running in a restricted environment can
still call the <a class="reference internal" href="sys.html#sys.exit" title="sys.exit"><code class="xref py py-func docutils literal notranslate">sys.exit()</code></a> function. To disallow restricted code from
exiting the interpreter, always protect calls that cause restricted code to run
with a <a class="reference internal" href="../reference/compound_stmts.html#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a>/<a class="reference internal" href="../reference/compound_stmts.html#except"><code class="xref std std-keyword docutils literal notranslate">except</code></a> statement that catches the
<code class="xref py py-exc docutils literal notranslate">SystemExit</code> exception. Removing the <a class="reference internal" href="sys.html#sys.exit" title="sys.exit"><code class="xref py py-func docutils literal notranslate">sys.exit()</code></a> function from the
restricted environment is not sufficient — the restricted code could still use
<code class="docutils literal notranslate">raise SystemExit</code>. Removing <code class="xref py py-exc docutils literal notranslate">SystemExit</code> is not a reasonable option;
some library code makes use of this and would break were it not available.
<div class="admonition seealso">
See also
<dl class="simple">
<dt><a class="reference external" href="http://grail.sourceforge.net/">Grail Home Page</a></dt><dd>Grail is a Web browser written entirely in Python. It uses the <a class="reference internal" href="#module-rexec" title="rexec: Basic restricted execution framework. (deprecated)"><code class="xref py py-mod docutils literal notranslate">rexec</code></a>
module as a foundation for supporting Python applets, and can be used as an
example usage of this module.
</dd>
</dl>
</div>
<section id="rexec-objects">
<h2>30.1.1. RExec Objects<a class="headerlink" href="#rexec-objects" title="Permalink to this headline">¶</a></h2>
<a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> instances support the following methods:
<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.r_eval">
RExec.r_eval(code)<a class="headerlink" href="#rexec.RExec.r_eval" title="Permalink to this definition">¶</a></dt>
<dd>code must either be a string containing a Python expression, or a compiled
code object, which will be evaluated in the restricted environment’s
<a class="reference internal" href="__main__.html#module-__main__" title="__main__: The environment where the top-level script is run."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> module. The value of the expression or code object will be
returned.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.r_exec">
RExec.r_exec(code)<a class="headerlink" href="#rexec.RExec.r_exec" title="Permalink to this definition">¶</a></dt>
<dd>code must either be a string containing one or more lines of Python code, or a
compiled code object, which will be executed in the restricted environment’s
<a class="reference internal" href="__main__.html#module-__main__" title="__main__: The environment where the top-level script is run."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> module.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.r_execfile">
RExec.r_execfile(filename)<a class="headerlink" href="#rexec.RExec.r_execfile" title="Permalink to this definition">¶</a></dt>
<dd>Execute the Python code contained in the file filename in the restricted
environment’s <a class="reference internal" href="__main__.html#module-__main__" title="__main__: The environment where the top-level script is run."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> module.
</dd></dl>

Methods whose names begin with <code class="docutils literal notranslate">s_</code> are similar to the functions beginning
with <code class="docutils literal notranslate">r_</code>, but the code will be granted access to restricted versions of the
standard I/O streams <code class="docutils literal notranslate">sys.stdin</code>, <code class="docutils literal notranslate">sys.stderr</code>, and <code class="docutils literal notranslate">sys.stdout</code>.
<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.s_eval">
RExec.s_eval(code)<a class="headerlink" href="#rexec.RExec.s_eval" title="Permalink to this definition">¶</a></dt>
<dd>code must be a string containing a Python expression, which will be evaluated
in the restricted environment.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.s_exec">
RExec.s_exec(code)<a class="headerlink" href="#rexec.RExec.s_exec" title="Permalink to this definition">¶</a></dt>
<dd>code must be a string containing one or more lines of Python code, which will
be executed in the restricted environment.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.s_execfile">
RExec.s_execfile(code)<a class="headerlink" href="#rexec.RExec.s_execfile" title="Permalink to this definition">¶</a></dt>
<dd>Execute the Python code contained in the file filename in the restricted
environment.
</dd></dl>

<a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> objects must also support various methods which will be
implicitly called by code executing in the restricted environment. Overriding
these methods in a subclass is used to change the policies enforced by a
restricted environment.
<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.r_import">
RExec.r_import(modulename[, globals[, locals[, fromlist]]])<a class="headerlink" href="#rexec.RExec.r_import" title="Permalink to this definition">¶</a></dt>
<dd>Import the module modulename, raising an <code class="xref py py-exc docutils literal notranslate">ImportError</code> exception if the
module is considered unsafe.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.r_open">
RExec.r_open(filename[, mode[, bufsize]])<a class="headerlink" href="#rexec.RExec.r_open" title="Permalink to this definition">¶</a></dt>
<dd>Method called when <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate">open()</code></a> is called in the restricted environment. The
arguments are identical to those of <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate">open()</code></a>, and a file object (or a class
instance compatible with file objects) should be returned. <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a>’s
default behaviour is allow opening any file for reading, but forbidding any
attempt to write a file. See the example below for an implementation of a less
restrictive <a class="reference internal" href="#rexec.RExec.r_open" title="rexec.RExec.r_open"><code class="xref py py-meth docutils literal notranslate">r_open()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.r_reload">
RExec.r_reload(module)<a class="headerlink" href="#rexec.RExec.r_reload" title="Permalink to this definition">¶</a></dt>
<dd>Reload the module object module, re-parsing and re-initializing it.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.r_unload">
RExec.r_unload(module)<a class="headerlink" href="#rexec.RExec.r_unload" title="Permalink to this definition">¶</a></dt>
<dd>Unload the module object module (remove it from the restricted environment’s
<code class="docutils literal notranslate">sys.modules</code> dictionary).
</dd></dl>

And their equivalents with access to restricted standard I/O streams:
<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.s_import">
RExec.s_import(modulename[, globals[, locals[, fromlist]]])<a class="headerlink" href="#rexec.RExec.s_import" title="Permalink to this definition">¶</a></dt>
<dd>Import the module modulename, raising an <code class="xref py py-exc docutils literal notranslate">ImportError</code> exception if the
module is considered unsafe.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.s_reload">
RExec.s_reload(module)<a class="headerlink" href="#rexec.RExec.s_reload" title="Permalink to this definition">¶</a></dt>
<dd>Reload the module object module, re-parsing and re-initializing it.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="rexec.RExec.s_unload">
RExec.s_unload(module)<a class="headerlink" href="#rexec.RExec.s_unload" title="Permalink to this definition">¶</a></dt>
<dd>Unload the module object module.
</dd></dl>

</section>
<section id="defining-restricted-environments">
<h2>30.1.2. Defining restricted environments<a class="headerlink" href="#defining-restricted-environments" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> class has the following class attributes, which are used by
the <code class="xref py py-meth docutils literal notranslate">__init__()</code> method. Changing them on an existing instance won’t have
any effect; instead, create a subclass of <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> and assign them new
values in the class definition. Instances of the new class will then use those
new values. All these attributes are tuples of strings.
<dl class="py attribute">
<dt class="sig sig-object py" id="rexec.RExec.nok_builtin_names">
RExec.nok_builtin_names<a class="headerlink" href="#rexec.RExec.nok_builtin_names" title="Permalink to this definition">¶</a></dt>
<dd>Contains the names of built-in functions which will not be available to
programs running in the restricted environment. The value for <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> is
<code class="docutils literal notranslate">('open', 'reload', '__import__')</code>. (This gives the exceptions, because by far
the majority of built-in functions are harmless. A subclass that wants to
override this variable should probably start with the value from the base class
and concatenate additional forbidden functions — when new dangerous built-in
functions are added to Python, they will also be added to this module.)
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="rexec.RExec.ok_builtin_modules">
RExec.ok_builtin_modules<a class="headerlink" href="#rexec.RExec.ok_builtin_modules" title="Permalink to this definition">¶</a></dt>
<dd>Contains the names of built-in modules which can be safely imported. The value
for <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> is <code class="docutils literal notranslate">('audioop', 'array', 'binascii', 'cmath', 'errno',
'imageop', 'marshal', 'math', 'md5', 'operator', 'parser', 'regex', 'select',
'sha', '_sre', 'strop', 'struct', 'time')</code>. A similar remark about overriding
this variable applies — use the value from the base class as a starting point.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="rexec.RExec.ok_path">
RExec.ok_path<a class="headerlink" href="#rexec.RExec.ok_path" title="Permalink to this definition">¶</a></dt>
<dd>Contains the directories which will be searched when an <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> is
performed in the restricted environment. The value for <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> is the
same as <code class="docutils literal notranslate">sys.path</code> (at the time the module is loaded) for unrestricted code.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="rexec.RExec.ok_posix_names">
RExec.ok_posix_names<a class="headerlink" href="#rexec.RExec.ok_posix_names" title="Permalink to this definition">¶</a></dt>
<dd>Contains the names of the functions in the <a class="reference internal" href="os.html#module-os" title="os: Miscellaneous operating system interfaces."><code class="xref py py-mod docutils literal notranslate">os</code></a> module which will be
available to programs running in the restricted environment. The value for
<a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> is <code class="docutils literal notranslate">('error', 'fstat', 'listdir', 'lstat', 'readlink', 'stat',
'times', 'uname', 'getpid', 'getppid', 'getcwd', 'getuid', 'getgid', 'geteuid',
'getegid')</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="rexec.RExec.ok_sys_names">
RExec.ok_sys_names<a class="headerlink" href="#rexec.RExec.ok_sys_names" title="Permalink to this definition">¶</a></dt>
<dd>Contains the names of the functions and variables in the <a class="reference internal" href="sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> module which
will be available to programs running in the restricted environment. The value
for <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> is <code class="docutils literal notranslate">('ps1', 'ps2', 'copyright', 'version', 'platform',
'exit', 'maxint')</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="rexec.RExec.ok_file_types">
RExec.ok_file_types<a class="headerlink" href="#rexec.RExec.ok_file_types" title="Permalink to this definition">¶</a></dt>
<dd>Contains the file types from which modules are allowed to be loaded. Each file
type is an integer constant defined in the <a class="reference internal" href="imp.html#module-imp" title="imp: Access the implementation of the import statement."><code class="xref py py-mod docutils literal notranslate">imp</code></a> module. The meaningful
values are <code class="xref py py-const docutils literal notranslate">PY_SOURCE</code>, <code class="xref py py-const docutils literal notranslate">PY_COMPILED</code>, and <code class="xref py py-const docutils literal notranslate">C_EXTENSION</code>.
The value for <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> is <code class="docutils literal notranslate">(C_EXTENSION, PY_SOURCE)</code>. Adding
<code class="xref py py-const docutils literal notranslate">PY_COMPILED</code> in subclasses is not recommended; an attacker could exit
the restricted execution mode by putting a forged byte-compiled file
(<code class="file docutils literal notranslate">.pyc</code>) anywhere in your file system, for example by writing it to
<code class="file docutils literal notranslate">/tmp</code> or uploading it to the <code class="file docutils literal notranslate">/incoming</code> directory of your public
FTP server.
</dd></dl>

</section>
<section id="an-example">
<h2>30.1.3. An example<a class="headerlink" href="#an-example" title="Permalink to this headline">¶</a></h2>
Let us say that we want a slightly more relaxed policy than the standard
<a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> class. For example, if we’re willing to allow files in
<code class="file docutils literal notranslate">/tmp</code> to be written, we can subclass the <a class="reference internal" href="#rexec.RExec" title="rexec.RExec"><code class="xref py py-class docutils literal notranslate">RExec</code></a> class:
<div class="highlight-default notranslate"><div class="highlight"><pre>class TmpWriterRExec(rexec.RExec):
 def r_open(self, file, mode=&#39;r&#39;, buf=-1):
 if mode in (&#39;r&#39;, &#39;rb&#39;):
 pass
 elif mode in (&#39;w&#39;, &#39;wb&#39;, &#39;a&#39;, &#39;ab&#39;):
 # check filename: must begin with /tmp/
 if file[:5]!=&#39;/tmp/&#39;:
 raise IOError(&quot;can&#39;t write outside /tmp&quot;)
 elif (string.find(file, &#39;/../&#39;) &gt;= 0 or
 file[:3] == &#39;../&#39; or file[-3:] == &#39;/..&#39;):
 raise IOError(&quot;&#39;..&#39; in filename forbidden&quot;)
 else: raise IOError(&quot;Illegal open() mode&quot;)
 return open(file, mode, buf)
</pre></div>
</div>
Notice that the above code will occasionally forbid a perfectly valid filename;
for example, code in the restricted environment won’t be able to open a file
called <code class="file docutils literal notranslate">/tmp/foo/../bar</code>. To fix this, the <code class="xref py py-meth docutils literal notranslate">r_open()</code> method would
have to simplify the filename to <code class="file docutils literal notranslate">/tmp/bar</code>, which would require splitting
apart the filename and performing various operations on it. In cases where
security is at stake, it may be preferable to write simple code which is
sometimes overly restrictive, instead of more general code that is also more
complex and may harbor a subtle security hole.
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">30.1. <code class="xref py py-mod docutils literal notranslate">rexec</code> — Restricted execution framework</a><ul>
<li><a class="reference internal" href="#rexec-objects">30.1.1. RExec Objects</a></li>
<li><a class="reference internal" href="#defining-restricted-environments">30.1.2. Defining restricted environments</a></li>
<li><a class="reference internal" href="#an-example">30.1.3. An example</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="restricted.html"
 title="previous chapter">30. Restricted Execution</a>
 <h4>Next topic</h4>
 <a href="bastion.html"
 title="next chapter">30.2. <code class="xref py py-mod docutils literal notranslate">Bastion</code> — Restricting access to objects</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/rexec.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="bastion.html" title="30.2. Bastion — Restricting access to objects"
 >next</a> |</li>
 <li class="right" >
 <a href="restricted.html" title="30. Restricted Execution"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="restricted.html" >30. Restricted Execution</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">30.1. <code class="xref py py-mod docutils literal notranslate">rexec</code> — Restricted execution framework</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : rexec.html