Files
ImmunityDebugger/1.73/Documentation/Ref/Libs.libhook.Hook-class.html
2013-03-25 21:58:56 -04:00

347 lines
14 KiB
HTML
Executable File

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Libs.libhook.Hook</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Immunity Debugger API Reference</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package&nbsp;Libs ::
<a href="Libs.libhook-module.html">Module&nbsp;libhook</a> ::
Class&nbsp;Hook
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="Libs.libhook.Hook-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Hook</h1><p class="nomargin-top"><span class="codelink"><a href="Libs.libhook-pysrc.html#Hook">source&nbsp;code</a></span></p>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="Libs.libhook.AccessViolationHook-class.html">AccessViolationHook</a></li><li>, <a href="Libs.libhook.AllExceptHook-class.html">AllExceptHook</a></li><li>, <a href="Libs.libhook.BpHook-class.html">BpHook</a></li><li>, <a href="Libs.libhook.CreateProcessHook-class.html">CreateProcessHook</a></li><li>, <a href="Libs.libhook.CreateThreadHook-class.html">CreateThreadHook</a></li><li>, <a href="Libs.libhook.ExitProcessHook-class.html">ExitProcessHook</a></li><li>, <a href="Libs.libhook.ExitThreadHook-class.html">ExitThreadHook</a></li><li>, <a href="Libs.libhook.LoadDLLHook-class.html">LoadDLLHook</a></li><li>, <a href="Libs.libhook.LogBpHook-class.html">LogBpHook</a></li><li>, <a href="Libs.libhook.PostAnalysisHook-class.html">PostAnalysisHook</a></li><li>, <a href="Libs.libhook.PreBpHook-class.html">PreBpHook</a></li><li>, <a href="Libs.libhook.RunUntilAV-class.html">RunUntilAV</a></li><li>, <a href="Libs.libhook.UnloadDLLHook-class.html">UnloadDLLHook</a></li> </ul>
</dd></dl>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libhook-pysrc.html#Hook.__init__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="enable"></a><span class="summary-sig-name">enable</span>(<span class="summary-sig-arg">self</span>)</span><br />
Enable hook execution</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libhook-pysrc.html#Hook.enable">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="disable"></a><span class="summary-sig-name">disable</span>(<span class="summary-sig-arg">self</span>)</span><br />
Disable hook execution</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libhook-pysrc.html#Hook.disable">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="UnHook"></a><span class="summary-sig-name">UnHook</span>(<span class="summary-sig-arg">self</span>)</span><br />
Remove the hook</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libhook-pysrc.html#Hook.UnHook">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libhook.Hook-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">description</span>,
<span class="summary-sig-arg">address</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">force</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">mode</span>=<span class="summary-sig-default">0</span>)</span><br />
Add hook to Immunity Debugger hook database</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libhook-pysrc.html#Hook.add">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_run"></a><span class="summary-sig-name">_run</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">regs</span>)</span><br />
regs is the actual cpu context, be sure of using this values and not
the ones from imm.getRegs() at hook time</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libhook-pysrc.html#Hook._run">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_runTimeout"></a><span class="summary-sig-name">_runTimeout</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">regs</span>)</span><br />
regs is the actual cpu context, be sure of using this values and not
the ones from imm.getRegs() at hook time</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libhook-pysrc.html#Hook._runTimeout">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="run"></a><span class="summary-sig-name">run</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">regs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libhook-pysrc.html#Hook.run">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="runTimeout"></a><span class="summary-sig-name">runTimeout</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">regs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libhook-pysrc.html#Hook.runTimeout">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="add"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">description</span>,
<span class="sig-arg">address</span>=<span class="sig-default">0</span>,
<span class="sig-arg">force</span>=<span class="sig-default">0</span>,
<span class="sig-arg">timeout</span>=<span class="sig-default">0</span>,
<span class="sig-arg">mode</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libhook-pysrc.html#Hook.add">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Add hook to Immunity Debugger hook database</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>type</code></strong> - Type of hook</li>
<li><strong class="pname"><code>desc</code></strong> - Descriptive string</li>
<li><strong class="pname"><code>force</code></strong> - Force hook adding</li>
<li><strong class="pname"><code>timeout</code></strong> - time to live in memory</li>
<li><strong class="pname"><code>mode</code></strong> - thread mode of ttl execution</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Immunity Debugger API Reference</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Thu Sep 11 14:06:34 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>