198 lines
17 KiB
HTML
198 lines
17 KiB
HTML
<!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">
|
|
<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.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ESP32/ESP8266 Firewall: src/Utils.hpp Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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">ESP32/ESP8266 Firewall<span id="projectnumber"> 1.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">a software firewall for ESP23 or ESP8266</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('_utils_8hpp_source.html',''); initResizable(); });
|
|
/* @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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">Utils.hpp</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef UTILS_HPP</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define UTILS_HPP</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include "Arduino.h"</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include "WString.h"</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span>fw</div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>{</div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t IPV4ADDRESS_LENGTH = 16;</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t CREDENTIALS_LENGTH = 32;</div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t firewall_fields_amount = 6;</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">const</span> <span class="keywordtype">char</span> firewall_fields[firewall_fields_amount][10] = {<span class="stringliteral">"key"</span>, <span class="stringliteral">"ip"</span>, <span class="stringliteral">"port_from"</span>, <span class="stringliteral">"port_to"</span>, <span class="stringliteral">"protocol"</span>, <span class="stringliteral">"target"</span>};</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> firewall_targets : uint8_t</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> {</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> TARGET_DROP = 1,</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> TARGET_ACCEPT = 2,</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> } firewall_target_t;</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> firewall_protocols : uint8_t</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> {</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> PROTOCOL_TCP = 6,</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> PROTOCOL_UDP = 17,</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> PROTOCOL_ALL = 255,</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> } firewall_protocol_t;</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> ok : uint8_t</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> {</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> SUCCESS = 0,</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> ERROR = 1,</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> NO_ACTION = 2,</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> } ok_t;</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> auth : uint8_t</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> AUTHENTICATED = 0,</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> DENIED = 1,</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> } auth_t;</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structfirewall__rule__t.html"> 50</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>firewall_rules</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> {</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> uint8_t key;</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">char</span> ip[IPV4ADDRESS_LENGTH];</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> uint16_t port_from;</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> uint16_t port_to;</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> firewall_protocol_t protocol;</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> firewall_target_t target;</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">struct </span>firewall_rules *next;</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> } <a class="code hl_struct" href="structfirewall__rule__t.html">firewall_rule_t</a>;</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="structmy__packet__t.html"> 63</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>my_packet</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> {</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">char</span> ip[IPV4ADDRESS_LENGTH];</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> firewall_protocol_t protocol;</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> uint16_t port;</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> } <a class="code hl_struct" href="structmy__packet__t.html">my_packet_t</a>;</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> firewall_fields : uint8_t</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> {</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> KEY,</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> IP,</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> PORT_FROM,</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> PORT_TO,</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> PROTOCOL,</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> TARGET,</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> } firewall_fields_t;</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="structcredential__t.html"> 84</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>credentials</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> {</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">char</span> password[CREDENTIALS_LENGTH];</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">char</span> username[CREDENTIALS_LENGTH];</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> } <a class="code hl_struct" href="structcredential__t.html">credential_t</a>;</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="structapi__endpoint__t.html"> 92</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>api_endpoints</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> {</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">char</span> uri[60];</div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">char</span> method[7];</div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">char</span> description[30];</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">struct </span>api_endpoints *next;</div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> } <a class="code hl_struct" href="structapi__endpoint__t.html">api_endpoint_t</a>;</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> String protocol_to_string(firewall_protocol_t &protocol);</div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> firewall_protocol_t string_to_protocol(String &protocol);</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> String target_to_string(firewall_target_t &target);</div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> firewall_target_t string_to_target(String &target);</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">void</span> endless_loop();</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keywordtype">bool</span> is_in_range(<span class="keyword">const</span> uint16_t number, <span class="keyword">const</span> uint16_t lower, <span class="keyword">const</span> uint16_t upper);</div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span>}</div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> </div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="astructapi__endpoint__t_html"><div class="ttname"><a href="structapi__endpoint__t.html">api_endpoint_t</a></div><div class="ttdef"><b>Definition:</b> Utils.hpp:93</div></div>
|
|
<div class="ttc" id="astructcredential__t_html"><div class="ttname"><a href="structcredential__t.html">credential_t</a></div><div class="ttdef"><b>Definition:</b> Utils.hpp:85</div></div>
|
|
<div class="ttc" id="astructfirewall__rule__t_html"><div class="ttname"><a href="structfirewall__rule__t.html">firewall_rule_t</a></div><div class="ttdef"><b>Definition:</b> Utils.hpp:51</div></div>
|
|
<div class="ttc" id="astructmy__packet__t_html"><div class="ttname"><a href="structmy__packet__t.html">my_packet_t</a></div><div class="ttdef"><b>Definition:</b> Utils.hpp:64</div></div>
|
|
</div><!-- fragment --></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"><b>Utils.hpp</b></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.9.4 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|