<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>HTP: htp.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">HTP
 <span id="projectnumber">0.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_5edaa2d740570af18be6e40ef0aff597.html">htp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">htp.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <sys/time.h></code><br/>
<code>#include "<a class="el" href="htp__version_8h_source.html">htp_version.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__core_8h_source.html">htp_core.h</a>"</code><br/>
<code>#include "<a class="el" href="bstr_8h_source.html">bstr.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__base64_8h_source.html">htp_base64.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__config_8h_source.html">htp_config.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__connection__parser_8h_source.html">htp_connection_parser.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__decompressors_8h_source.html">htp_decompressors.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__hooks_8h_source.html">htp_hooks.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__list_8h_source.html">htp_list.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__multipart_8h_source.html">htp_multipart.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__table_8h_source.html">htp_table.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__transaction_8h_source.html">htp_transaction.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__urlencoded_8h_source.html">htp_urlencoded.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__utf8__decoder_8h_source.html">htp_utf8_decoder.h</a>"</code><br/>
</div>
<p><a href="htp_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhtp__conn__t.html">htp_conn_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhtp__file__t.html">htp_file_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhtp__file__data__t.html">htp_file_data_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhtp__log__t.html">htp_log_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhtp__header__t.html">htp_header_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhtp__param__t.html">htp_param_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhtp__tx__t.html">htp_tx_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhtp__tx__data__t.html">htp_tx_data_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhtp__uri__t.html">htp_uri_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af834d04e2f2dcf25ed5f8cf49efb626a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="htp_8h.html#af834d04e2f2dcf25ed5f8cf49efb626a">htp_uri_free</a> (<a class="el" href="structhtp__uri__t.html">htp_uri_t</a> *uri)</td></tr>
<tr class="separator:af834d04e2f2dcf25ed5f8cf49efb626a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73866af0ac06ac107436af9f08e2ca7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structhtp__uri__t.html">htp_uri_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="htp_8h.html#a73866af0ac06ac107436af9f08e2ca7d">htp_uri_alloc</a> (void)</td></tr>
<tr class="separator:a73866af0ac06ac107436af9f08e2ca7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3eef4d9c98d7bbfbbcb1ff7c5317f3c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="htp_8h.html#a3eef4d9c98d7bbfbbcb1ff7c5317f3c6">htp_log</a> (<a class="el" href="structhtp__connp__t.html">htp_connp_t</a> *connp, const char *file, int line, enum <a class="el" href="htp__core_8h.html#ae91a6ad07977423dd1ec14a44156d799">htp_log_level_t</a> level, int code, const char *fmt,...)</td></tr>
<tr class="separator:a3eef4d9c98d7bbfbbcb1ff7c5317f3c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a01a96c537538cdefec78b9628b5e93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="htp_8h.html#a2a01a96c537538cdefec78b9628b5e93">htp_urldecode_inplace</a> (<a class="el" href="structhtp__cfg__t.html">htp_cfg_t</a> *cfg, enum <a class="el" href="htp__config_8h.html#afa49656ef495bb1c8d129342681f62e7">htp_decoder_ctx_t</a> ctx, <a class="el" href="bstr_8h.html#ad24e3759c8d17c13ae2f05d9dde4d0b6">bstr</a> *input, uint64_t *flags)</td></tr>
<tr class="separator:a2a01a96c537538cdefec78b9628b5e93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a6849d2b4e2477402760923aae8d527"><td class="memItemLeft" align="right" valign="top"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="htp_8h.html#a6a6849d2b4e2477402760923aae8d527">htp_urldecode_inplace_ex</a> (<a class="el" href="structhtp__cfg__t.html">htp_cfg_t</a> *cfg, enum <a class="el" href="htp__config_8h.html#afa49656ef495bb1c8d129342681f62e7">htp_decoder_ctx_t</a> ctx, <a class="el" href="bstr_8h.html#ad24e3759c8d17c13ae2f05d9dde4d0b6">bstr</a> *input, uint64_t *flags, int *expected_status_code)</td></tr>
<tr class="separator:a6a6849d2b4e2477402760923aae8d527"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafd2659394bb762f2a623bc9b2ee59bd"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="htp_8h.html#aafd2659394bb762f2a623bc9b2ee59bd">htp_get_version</a> (void)</td></tr>
<tr class="separator:aafd2659394bb762f2a623bc9b2ee59bd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Ivan Ristic <a href="#" onclick="location.href='mai'+'lto:'+'iva'+'nr'+'@we'+'bk'+'rea'+'to'+'r.c'+'om'; return false;">ivanr<span style="display: none;">.nosp@m.</span>@web<span style="display: none;">.nosp@m.</span>kreat<span style="display: none;">.nosp@m.</span>or.c<span style="display: none;">.nosp@m.</span>om</a> </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aafd2659394bb762f2a623bc9b2ee59bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* htp_get_version </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the LibHTP version string.</p>
<dl class="section return"><dt>Returns</dt><dd>LibHTP version, for example "LibHTP v0.5.x". </dd></dl>
</div>
</div>
<a class="anchor" id="a3eef4d9c98d7bbfbbcb1ff7c5317f3c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void htp_log </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhtp__connp__t.html">htp_connp_t</a> * </td>
<td class="paramname"><em>connp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="htp__core_8h.html#ae91a6ad07977423dd1ec14a44156d799">htp_log_level_t</a> </td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new log entry and stores it with the connection. The file and line parameters are typically auto-generated using the HTP_LOG_MARK macro.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">connp</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">code</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Records one log message.</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">connp</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">code</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a73866af0ac06ac107436af9f08e2ca7d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structhtp__uri__t.html">htp_uri_t</a>* htp_uri_alloc </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocates and initializes a new <a class="el" href="structhtp__uri__t.html">htp_uri_t</a> structure.</p>
<dl class="section return"><dt>Returns</dt><dd>New structure, or NULL on memory allocation failure. </dd></dl>
</div>
</div>
<a class="anchor" id="af834d04e2f2dcf25ed5f8cf49efb626a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void htp_uri_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhtp__uri__t.html">htp_uri_t</a> * </td>
<td class="paramname"><em>uri</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees all data contained in the uri, and then the uri itself.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uri</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2a01a96c537538cdefec78b9628b5e93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> htp_urldecode_inplace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhtp__cfg__t.html">htp_cfg_t</a> * </td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="htp__config_8h.html#afa49656ef495bb1c8d129342681f62e7">htp_decoder_ctx_t</a> </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="bstr_8h.html#ad24e3759c8d17c13ae2f05d9dde4d0b6">bstr</a> * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t * </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs in-place decoding of the input string, according to the configuration specified by cfg and ctx. On output, various flags (HTP_URLEN_*) might be set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cfg</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">input</td><td></td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">flags</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>HTP_OK on success, HTP_ERROR on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a6a6849d2b4e2477402760923aae8d527"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> htp_urldecode_inplace_ex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhtp__cfg__t.html">htp_cfg_t</a> * </td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="htp__config_8h.html#afa49656ef495bb1c8d129342681f62e7">htp_decoder_ctx_t</a> </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="bstr_8h.html#ad24e3759c8d17c13ae2f05d9dde4d0b6">bstr</a> * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t * </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>expected_status_code</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs in-place decoding of the input string, according to the configuration specified by cfg and ctx. On output, various flags (HTP_URLEN_*) might be set. If something in the input would cause a particular server to respond with an error, the appropriate status code will be set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cfg</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">input</td><td></td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">flags</td><td></td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">expected_status_code</td><td>0 by default, or status code as necessary</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>HTP_OK on success, HTP_ERROR on failure. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
distrib
>
Fedora
>
20
>
x86_64
>
media
>
updates
>
by-pkgid
>
c579c38484b8ffa244858626df1128ca
>
files
>
97
