Skip to content

Commit 8dbe91e

Browse files
committed
Deploying to doxygen from @ d4bafe4 🚀
1 parent 34212d7 commit 8dbe91e

14 files changed

+421
-537
lines changed

_http_line_reader_8h_source.html

Lines changed: 8 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -149,75 +149,15 @@
149149
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> }</div>
150150
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> str[result - 1] = 0;</div>
151151
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">if</span> (is_buffer_overflow) {</div>
152-
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// SAFETY FIX: Don&#39;t print potentially corrupted binary data with %s</span></div>
153-
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// Binary garbage can contain terminal escape codes or invalid UTF-8 that crashes Serial.printf()</span></div>
154-
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="comment">//</span></div>
155-
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// This fix prevents ESP32 hard resets when HTTP servers send malformed headers</span></div>
156-
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// Real-world trigger: http://fast.citrus3.com:2020/stream/wtmj-radio</span></div>
157-
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="comment">//</span></div>
158-
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// Strategy:</span></div>
159-
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// 1. Sanitize the actual buffer (prevents parser poisoning downstream)</span></div>
160-
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// 2. Count printable vs binary content</span></div>
161-
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// 3. Use hex dump for binary garbage (safer than string masking)</span></div>
162-
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// 4. Limit output to 256 bytes (prevents log spam)</span></div>
163-
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
164-
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">int</span> printable = 0;</div>
165-
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">int</span> non_printable = 0;</div>
166-
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">int</span> actual_len = 0;</div>
167-
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
168-
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// First pass: count and find actual length</span></div>
169-
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; len &amp;&amp; str[i] != 0; i++) {</div>
170-
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> actual_len = i + 1;</div>
171-
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordflow">if</span> (str[i] &gt;= 32 &amp;&amp; str[i] &lt;= 126) {</div>
172-
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> printable++;</div>
173-
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (str[i] != <span class="charliteral">&#39;\r&#39;</span> &amp;&amp; str[i] != <span class="charliteral">&#39;\n&#39;</span> &amp;&amp; str[i] != <span class="charliteral">&#39;\t&#39;</span>) {</div>
174-
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> non_printable++;</div>
175-
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="comment">// CRITICAL: Sanitize the actual buffer to prevent parser poisoning</span></div>
176-
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// Replace binary garbage with space to avoid confusing HTTP header parser</span></div>
177-
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> str[i] = <span class="charliteral">&#39; &#39;</span>;</div>
178-
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> }</div>
179-
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> }</div>
180-
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
181-
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="comment">// Limit logging output to 256 bytes to prevent excessive serial spam</span></div>
182-
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">int</span> log_len = (actual_len &gt; 256) ? 256 : actual_len;</div>
183-
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
184-
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="comment">// If mostly binary garbage (&gt;50% non-printable), use hex dump for safety</span></div>
185-
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keywordflow">if</span> (non_printable &gt; printable) {</div>
186-
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> LOGE(<span class="stringliteral">&quot;Line cut off: [%d bytes, %d binary chars - showing hex dump of first %d bytes]&quot;</span>,</div>
187-
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> actual_len, non_printable, (log_len &gt; 32 ? 32 : log_len));</div>
188-
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
189-
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="comment">// Hex dump (safer than string output - never misinterpreted)</span></div>
190-
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// Show first 32 bytes maximum</span></div>
191-
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordtype">int</span> hex_len = (log_len &gt; 32) ? 32 : log_len;</div>
192-
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; hex_len; i += 16) {</div>
193-
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">char</span> hex_line[64];</div>
194-
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keywordtype">int</span> line_len = (hex_len - i &gt; 16) ? 16 : (hex_len - i);</div>
195-
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordtype">int</span> pos = 0;</div>
196-
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; line_len; j++) {</div>
197-
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> pos += snprintf(hex_line + pos, <span class="keyword">sizeof</span>(hex_line) - pos, <span class="stringliteral">&quot;%02X &quot;</span>, (uint8_t)str[i + j]);</div>
198-
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> }</div>
199-
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> LOGE(<span class="stringliteral">&quot; %04X: %s&quot;</span>, i, hex_line);</div>
200-
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> }</div>
201-
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> } <span class="keywordflow">else</span> {</div>
202-
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="comment">// Mostly printable - safe to log as string (already sanitized in-place above)</span></div>
203-
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <span class="comment">// Truncate to 256 bytes for logging</span></div>
204-
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keywordflow">if</span> (log_len &lt; actual_len) {</div>
205-
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="keywordtype">char</span> saved = str[log_len];</div>
206-
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> str[log_len] = 0;</div>
207-
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> LOGE(<span class="stringliteral">&quot;Line cut off: %s... [%d more bytes]&quot;</span>, str, actual_len - log_len);</div>
208-
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> str[log_len] = saved;</div>
209-
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> } <span class="keywordflow">else</span> {</div>
210-
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> LOGE(<span class="stringliteral">&quot;Line cut off: %s&quot;</span>, str);</div>
211-
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> }</div>
212-
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> }</div>
213-
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> }</div>
214-
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
215-
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keywordflow">return</span> result;</div>
216-
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> }</div>
217-
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span>};</div>
152+
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> LOGE(<span class="stringliteral">&quot;HttpLineReader %s&quot;</span>, <span class="stringliteral">&quot;readlnInternal-&gt;cut off too long line&quot;</span>);</div>
153+
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> }</div>
154+
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
155+
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">return</span> result;</div>
156+
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> }</div>
157+
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span>};</div>
218158
</div>
219-
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
220-
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span>} <span class="comment">// namespace audio_tools</span></div>
159+
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
160+
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>} <span class="comment">// namespace audio_tools</span></div>
221161
<div class="ttc" id="aclassaudio__tools_1_1_http_line_reader_html"><div class="ttname"><a href="classaudio__tools_1_1_http_line_reader.html">audio_tools::HttpLineReader</a></div><div class="ttdoc">We read a single line. A terminating 0 is added to the string to make it compliant for c string funct...</div><div class="ttdef"><b>Definition</b> HttpLineReader.h:14</div></div>
222162
<div class="ttc" id="aclassaudio__tools_1_1_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_stream.html">audio_tools::Stream</a></div><div class="ttdef"><b>Definition</b> NoArduino.h:142</div></div>
223163
<div class="ttc" id="anamespaceaudio__tools_html"><div class="ttname"><a href="namespaceaudio__tools.html">audio_tools</a></div><div class="ttdoc">Generic Implementation of sound input and output for desktop environments using portaudio.</div><div class="ttdef"><b>Definition</b> AudioCodecsBase.h:10</div></div>

0 commit comments

Comments
 (0)