This repository has been archived on 2024-10-30. You can view files and clone it, but cannot push or open issues or pull requests.
esp-firewall/doxygen/html/_storage_8cpp_source.html

197 lines
20 KiB
HTML
Raw Permalink Normal View History

2022-07-30 11:46:19 +02:00
<!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/Storage.cpp 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="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">&#160;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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Storage.cpp</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">#include &quot;Storage.hpp&quot;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">namespace </span>fw</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span>{</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> Storage::Storage()</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="preprocessor">#ifdef ESP8266</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> this-&gt;max_rules = 15;</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> this-&gt;eeprom_amount_of_rules = 0;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> this-&gt;eeprom_rules_head = 1;</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> this-&gt;eeprom_size = this-&gt;max_rules * <span class="keyword">sizeof</span>(firewall_rule_t) + eeprom_rules_head;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> EEPROM.begin(this-&gt;eeprom_size);</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> }</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> Storage::~Storage()</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> }</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifdef ESP8266</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> uint16_t Storage::eeprom_rule_position(uint8_t key)</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordflow">return</span> eeprom_rules_head + (key - 1) * <span class="keyword">sizeof</span>(firewall_rule_t);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> }</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> uint8_t Storage::retrieve_amount_of_rules()</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#ifdef ESP8266</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> uint8_t amount_of_rules = EEPROM.read(this-&gt;eeprom_amount_of_rules);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">if</span> (amount_of_rules &gt; this-&gt;max_rules)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> this-&gt;memory.begin(<span class="stringliteral">&quot;settings&quot;</span>, <span class="keyword">true</span>);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">const</span> uint8_t amount_of_rules = memory.getUChar(<span class="stringliteral">&quot;amount_of_rules&quot;</span>, 0);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> this-&gt;memory.end();</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">return</span> amount_of_rules;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span> Storage::store_amount_of_rules(<span class="keyword">const</span> uint8_t new_amount)</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><span class="preprocessor">#ifdef ESP8266</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> EEPROM.put(this-&gt;eeprom_amount_of_rules, new_amount);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> EEPROM.commit();</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> this-&gt;memory.begin(<span class="stringliteral">&quot;settings&quot;</span>, <span class="keyword">false</span>);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> this-&gt;memory.putUChar(<span class="stringliteral">&quot;amount_of_rules&quot;</span>, new_amount);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> this-&gt;memory.end();</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> }</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> firewall_rule_t *Storage::retrieve_firewall_rule(<span class="keyword">const</span> uint8_t key)</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> {</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> firewall_rule_t *rule_ptr = (firewall_rule_t *)malloc(<span class="keyword">sizeof</span>(firewall_rule_t));</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> rule_ptr-&gt;key = key;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#ifdef ESP8266</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> uint16_t eeprom_position = eeprom_rule_position(key);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> EEPROM.get(eeprom_position, rule_ptr-&gt;ip);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> EEPROM.get(eeprom_position += <span class="keyword">sizeof</span>(rule_ptr-&gt;ip), rule_ptr-&gt;port_from);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> EEPROM.get(eeprom_position += <span class="keyword">sizeof</span>(rule_ptr-&gt;port_from), rule_ptr-&gt;port_to);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> EEPROM.get(eeprom_position += <span class="keyword">sizeof</span>(rule_ptr-&gt;port_to), rule_ptr-&gt;protocol);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> EEPROM.get(eeprom_position += <span class="keyword">sizeof</span>(rule_ptr-&gt;protocol), rule_ptr-&gt;target);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">char</span> rulename[10]; <span class="comment">// fwRule99\n</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> sprintf(rulename, <span class="stringliteral">&quot;fwRule%i&quot;</span>, key);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> this-&gt;memory.begin(rulename, <span class="keyword">true</span>);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> strncpy(rule_ptr-&gt;ip, this-&gt;memory.getString(firewall_fields[IP], <span class="stringliteral">&quot;0.0.0.0&quot;</span>).c_str(), <span class="keyword">sizeof</span>(rule_ptr-&gt;ip));</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> rule_ptr-&gt;port_from = this-&gt;memory.getUShort(firewall_fields[PORT_FROM], 0);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> rule_ptr-&gt;port_to = this-&gt;memory.getUShort(firewall_fields[PORT_TO], 0);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> rule_ptr-&gt;protocol = <span class="keyword">static_cast&lt;</span>firewall_protocol_t<span class="keyword">&gt;</span>(this-&gt;memory.getUChar(firewall_fields[PROTOCOL], PROTOCOL_ALL));</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> rule_ptr-&gt;target = <span class="keyword">static_cast&lt;</span>firewall_target_t<span class="keyword">&gt;</span>(this-&gt;memory.getUChar(firewall_fields[TARGET], TARGET_ACCEPT));</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> this-&gt;memory.end();</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">return</span> rule_ptr;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> }</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">void</span> Storage::store_all_firewall_rules(firewall_rule_t *rule_head)</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> {</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> firewall_rule_t *temp = rule_head;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">while</span> (temp != NULL)</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> store_firewall_rule(temp);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> temp = temp-&gt;next;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> }</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> }</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">void</span> Storage::store_firewall_rule(firewall_rule_t *rule_ptr)</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> {</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor">#ifdef ESP8266</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> uint16_t eeprom_position = eeprom_rule_position(rule_ptr-&gt;key);</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> EEPROM.put(eeprom_position, rule_ptr-&gt;ip);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> EEPROM.put(eeprom_position += <span class="keyword">sizeof</span>(rule_ptr-&gt;ip), rule_ptr-&gt;port_from);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> EEPROM.put(eeprom_position += <span class="keyword">sizeof</span>(rule_ptr-&gt;port_from), rule_ptr-&gt;port_to);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> EEPROM.put(eeprom_position += <span class="keyword">sizeof</span>(rule_ptr-&gt;port_to), rule_ptr-&gt;protocol);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> EEPROM.put(eeprom_position += <span class="keyword">sizeof</span>(rule_ptr-&gt;protocol), rule_ptr-&gt;target);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> EEPROM.commit();</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">char</span> rulename[10]; <span class="comment">// fwRule99\n</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> sprintf(rulename, <span class="stringliteral">&quot;fwRule%i&quot;</span>, rule_ptr-&gt;key);</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> this-&gt;memory.begin(rulename, <span class="keyword">false</span>);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> this-&gt;memory.putString(firewall_fields[IP], rule_ptr-&gt;ip);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> this-&gt;memory.putUShort(firewall_fields[PORT_FROM], rule_ptr-&gt;port_from);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> this-&gt;memory.putUShort(firewall_fields[PORT_TO], rule_ptr-&gt;port_to);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> this-&gt;memory.putUChar(firewall_fields[PROTOCOL], rule_ptr-&gt;protocol);</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> this-&gt;memory.putUChar(firewall_fields[TARGET], rule_ptr-&gt;target);</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> this-&gt;memory.end();</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> }</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span>}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>