blob: f550b0667fbbcdf64a27680dc735e8fe31454e64 [file] [log] [blame] [edit]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: src/apps/http/altcp_proxyconnect.c 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectrow">
<td id="projectalign">
<div id="projectname">lwIP<span id="projectnumber">&#160;2.1.3</span>
</div>
<div id="projectbrief">Lightweight IP stack</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('altcp__proxyconnect_8c.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">altcp_proxyconnect.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="altcp__proxyconnect_8h.html">lwip/apps/altcp_proxyconnect.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="altcp_8h.html">lwip/altcp.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="altcp__priv_8h.html">lwip/priv/altcp_priv.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="altcp__tcp_8h.html">lwip/altcp_tcp.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="altcp__tls_8h.html">lwip/altcp_tls.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="mem_8h.html">lwip/mem.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="init_8h.html">lwip/init.h</a>&quot;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a344227f22aa1b58f7ed737a2d4f4636f" id="r_a344227f22aa1b58f7ed737a2d4f4636f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a344227f22aa1b58f7ed737a2d4f4636f">ALTCP_PROXYCONNECT_CLIENT_AGENT</a>&#160;&#160;&#160;&quot;lwIP/&quot; LWIP_VERSION_STRING &quot; (http://savannah.nongnu.org/projects/lwip)&quot;</td></tr>
<tr class="separator:a344227f22aa1b58f7ed737a2d4f4636f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a389937c9441d4e3f67412603b3d1d236" id="r_a389937c9441d4e3f67412603b3d1d236"><td class="memItemLeft" align="right" valign="top">struct altcp_pcb *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a389937c9441d4e3f67412603b3d1d236">altcp_proxyconnect_new</a> (struct altcp_proxyconnect_config *config, struct altcp_pcb *inner_pcb)</td></tr>
<tr class="separator:a389937c9441d4e3f67412603b3d1d236"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0072ee857af8a28b555f14c0f2c9183" id="r_ab0072ee857af8a28b555f14c0f2c9183"><td class="memItemLeft" align="right" valign="top">struct altcp_pcb *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab0072ee857af8a28b555f14c0f2c9183">altcp_proxyconnect_new_tcp</a> (struct altcp_proxyconnect_config *config, u8_t ip_type)</td></tr>
<tr class="separator:ab0072ee857af8a28b555f14c0f2c9183"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a371cd4386fcbc5f0a0ff6e2fa0408e68" id="r_a371cd4386fcbc5f0a0ff6e2fa0408e68"><td class="memItemLeft" align="right" valign="top">struct altcp_pcb *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a371cd4386fcbc5f0a0ff6e2fa0408e68">altcp_proxyconnect_alloc</a> (void *arg, u8_t ip_type)</td></tr>
<tr class="separator:a371cd4386fcbc5f0a0ff6e2fa0408e68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa807e0476719f0ec41b2344d4a0df2f4" id="r_aa807e0476719f0ec41b2344d4a0df2f4"><td class="memItemLeft" align="right" valign="top">struct altcp_pcb *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa807e0476719f0ec41b2344d4a0df2f4">altcp_proxyconnect_tls_alloc</a> (void *arg, u8_t ip_type)</td></tr>
<tr class="separator:aa807e0476719f0ec41b2344d4a0df2f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Application layered TCP connection API that executes a proxy-connect.</p>
<p>This file provides a starting layer that executes a proxy-connect e.g. to set up TLS connections through a http proxy. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a344227f22aa1b58f7ed737a2d4f4636f" name="a344227f22aa1b58f7ed737a2d4f4636f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a344227f22aa1b58f7ed737a2d4f4636f">&#9670;&#160;</a></span>ALTCP_PROXYCONNECT_CLIENT_AGENT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ALTCP_PROXYCONNECT_CLIENT_AGENT&#160;&#160;&#160;&quot;lwIP/&quot; LWIP_VERSION_STRING &quot; (http://savannah.nongnu.org/projects/lwip)&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>This string is passed in the HTTP header as "User-Agent: " </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a371cd4386fcbc5f0a0ff6e2fa0408e68" name="a371cd4386fcbc5f0a0ff6e2fa0408e68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a371cd4386fcbc5f0a0ff6e2fa0408e68">&#9670;&#160;</a></span>altcp_proxyconnect_alloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct altcp_pcb * altcp_proxyconnect_alloc </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>arg</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8_t</td> <td class="paramname"><span class="paramname"><em>ip_type</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocator function to allocate a proxy connect altcp pcb connecting directly via tcp to the proxy.</p>
<p>The returned pcb is a chain: altcp_proxyconnect - altcp_tcp - tcp pcb</p>
<p>This function is meant for use with <a class="el" href="group__altcp.html#ga6b0fc20cce40364aa821c07dc34cb908">altcp_new</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>struct altcp_proxyconnect_config that contains the proxy settings </td></tr>
<tr><td class="paramname">ip_type</td><td>IP type of the connection (<a class="el" href="group__ipaddr.html#gaf2142f0dfdcc938e2db16aa745ed585c">lwip_ip_addr_type</a>) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a389937c9441d4e3f67412603b3d1d236" name="a389937c9441d4e3f67412603b3d1d236"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a389937c9441d4e3f67412603b3d1d236">&#9670;&#160;</a></span>altcp_proxyconnect_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct altcp_pcb * altcp_proxyconnect_new </td>
<td>(</td>
<td class="paramtype">struct altcp_proxyconnect_config *</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct altcp_pcb *</td> <td class="paramname"><span class="paramname"><em>inner_pcb</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a new altcp layer connecting through a proxy. This function gets the inner pcb passed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>struct altcp_proxyconnect_config that contains the proxy settings </td></tr>
<tr><td class="paramname">inner_pcb</td><td>pcb that makes the connection to the proxy (i.e. tcp pcb) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab0072ee857af8a28b555f14c0f2c9183" name="ab0072ee857af8a28b555f14c0f2c9183"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0072ee857af8a28b555f14c0f2c9183">&#9670;&#160;</a></span>altcp_proxyconnect_new_tcp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct altcp_pcb * altcp_proxyconnect_new_tcp </td>
<td>(</td>
<td class="paramtype">struct altcp_proxyconnect_config *</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8_t</td> <td class="paramname"><span class="paramname"><em>ip_type</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a new altcp layer connecting through a proxy. This function allocates the inner pcb as tcp pcb, resulting in a direct tcp connection to the proxy.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>struct altcp_proxyconnect_config that contains the proxy settings </td></tr>
<tr><td class="paramname">ip_type</td><td>IP type of the connection (<a class="el" href="group__ipaddr.html#gaf2142f0dfdcc938e2db16aa745ed585c">lwip_ip_addr_type</a>) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa807e0476719f0ec41b2344d4a0df2f4" name="aa807e0476719f0ec41b2344d4a0df2f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa807e0476719f0ec41b2344d4a0df2f4">&#9670;&#160;</a></span>altcp_proxyconnect_tls_alloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct altcp_pcb * altcp_proxyconnect_tls_alloc </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>arg</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8_t</td> <td class="paramname"><span class="paramname"><em>ip_type</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocator function to allocate a TLS connection through a proxy.</p>
<p>The returned pcb is a chain: altcp_tls - altcp_proxyconnect - altcp_tcp - tcp pcb</p>
<p>This function is meant for use with <a class="el" href="group__altcp.html#ga6b0fc20cce40364aa821c07dc34cb908">altcp_new</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>struct altcp_proxyconnect_tls_config that contains the proxy settings and tls settings </td></tr>
<tr><td class="paramname">ip_type</td><td>IP type of the connection (<a class="el" href="group__ipaddr.html#gaf2142f0dfdcc938e2db16aa745ed585c">lwip_ip_addr_type</a>) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_53adf0b982dc8545998aae3f283a5a58.html">apps</a></li><li class="navelem"><a class="el" href="dir_34adf996f92d0eef72c45a7167a966e6.html">http</a></li><li class="navelem"><a class="el" href="altcp__proxyconnect_8c.html">altcp_proxyconnect.c</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>