Deploying to gh-pages from @ 527724ecda 🚀

2026-02-12 02:25:41 +00:00 · 2021-05-09 14:09:55 +00:00
parent aa1fc299f5
commit f437f72db4
30 changed files with 171 additions and 47 deletions
--- a/src/guard/api/v1/mcaptcha/stats.rs.html
+++ b/src/guard/api/v1/mcaptcha/stats.rs.html
@@ -29,6 +29,32 @@
 <span id="26">26</span>
 <span id="27">27</span>
 <span id="28">28</span>
+<span id="29">29</span>
+<span id="30">30</span>
+<span id="31">31</span>
+<span id="32">32</span>
+<span id="33">33</span>
+<span id="34">34</span>
+<span id="35">35</span>
+<span id="36">36</span>
+<span id="37">37</span>
+<span id="38">38</span>
+<span id="39">39</span>
+<span id="40">40</span>
+<span id="41">41</span>
+<span id="42">42</span>
+<span id="43">43</span>
+<span id="44">44</span>
+<span id="45">45</span>
+<span id="46">46</span>
+<span id="47">47</span>
+<span id="48">48</span>
+<span id="49">49</span>
+<span id="50">50</span>
+<span id="51">51</span>
+<span id="52">52</span>
+<span id="53">53</span>
+<span id="54">54</span>
 </pre><div class="example-wrap"><pre class="rust ">
 <span class="comment">/*
 * Copyright (C) 2021  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
@@ -49,7 +75,9 @@

 <span class="kw">use</span> <span class="ident">sqlx</span>::<span class="ident">PgPool</span>;

-<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">fetched</span>(<span class="ident">key</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">db</span>: <span class="kw-2">&amp;</span><span class="ident">PgPool</span>) {
+<span class="doccomment">/// record PoWConfig fetches</span>
+<span class="attribute">#[<span class="ident">inline</span>]</span>
+<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">record_fetch</span>(<span class="ident">key</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">db</span>: <span class="kw-2">&amp;</span><span class="ident">PgPool</span>) {
    <span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">sqlx</span>::<span class="macro">query</span><span class="macro">!</span>(
        <span class="string">&quot;INSERT INTO mcaptcha_pow_fetched_stats 
        (config_id) VALUES ((SELECT config_id FROM mcaptcha_config WHERE key = $1))&quot;</span>,
@@ -58,6 +86,30 @@
    .<span class="ident">execute</span>(<span class="ident">db</span>)
    .<span class="kw">await</span>;
 }
+
+<span class="doccomment">/// record PoWConfig solves</span>
+<span class="attribute">#[<span class="ident">inline</span>]</span>
+<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">record_solve</span>(<span class="ident">key</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">db</span>: <span class="kw-2">&amp;</span><span class="ident">PgPool</span>) {
+    <span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">sqlx</span>::<span class="macro">query</span><span class="macro">!</span>(
+        <span class="string">&quot;INSERT INTO mcaptcha_pow_solved_stats 
+        (config_id) VALUES ((SELECT config_id FROM mcaptcha_config WHERE key = $1))&quot;</span>,
+        <span class="kw-2">&amp;</span><span class="ident">key</span>,
+    )
+    .<span class="ident">execute</span>(<span class="ident">db</span>)
+    .<span class="kw">await</span>;
+}
+
+<span class="doccomment">/// record PoWConfig confirms</span>
+<span class="attribute">#[<span class="ident">inline</span>]</span>
+<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">record_confirm</span>(<span class="ident">key</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">db</span>: <span class="kw-2">&amp;</span><span class="ident">PgPool</span>) {
+    <span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">sqlx</span>::<span class="macro">query</span><span class="macro">!</span>(
+        <span class="string">&quot;INSERT INTO mcaptcha_pow_confirmed_stats 
+        (config_id) VALUES ((SELECT config_id FROM mcaptcha_config WHERE key = $1))&quot;</span>,
+        <span class="kw-2">&amp;</span><span class="ident">key</span>,
+    )
+    .<span class="ident">execute</span>(<span class="ident">db</span>)
+    .<span class="kw">await</span>;
+}
 </pre></div>
 </section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="guard"></div>
    <script src="../../../../../main.js"></script><script src="../../../../../source-script.js"></script><script src="../../../../../source-files.js"></script><script defer src="../../../../../search-index.js"></script></body></html>
--- a/src/guard/api/v1/pow/get_config.rs.html
+++ b/src/guard/api/v1/pow/get_config.rs.html
@@ -184,6 +184,10 @@
 <span id="181">181</span>
 <span id="182">182</span>
 <span id="183">183</span>
+<span id="184">184</span>
+<span id="185">185</span>
+<span id="186">186</span>
+<span id="187">187</span>
 </pre><div class="example-wrap"><pre class="rust ">
 <span class="comment">/*
 * Copyright (C) 2021  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
@@ -207,9 +211,9 @@
 <span class="kw">use</span> <span class="ident">m_captcha</span>::{<span class="ident">defense</span>::<span class="ident">LevelBuilder</span>, <span class="ident">master</span>::<span class="ident">AddSiteBuilder</span>, <span class="ident">DefenseBuilder</span>, <span class="ident">MCaptchaBuilder</span>};
 <span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};

+<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">record_fetch</span>;
 <span class="kw">use</span> <span class="kw">super</span>::<span class="ident">GetDurationResp</span>;
 <span class="kw">use</span> <span class="kw">super</span>::<span class="ident">I32Levels</span>;
-<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">api</span>::<span class="ident">v1</span>::<span class="ident">mcaptcha</span>::<span class="ident">stats</span>::<span class="ident">fetched</span>;
 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">errors</span>::<span class="kw-2">*</span>;
 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">Data</span>;

@@ -226,6 +230,7 @@

 <span class="comment">// API keys are mcaptcha actor names</span>

+<span class="doccomment">/// get PoW configuration for an mcaptcha key</span>
 <span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_config</span>(
    <span class="ident">payload</span>: <span class="ident">web</span>::<span class="ident">Json</span><span class="op">&lt;</span><span class="ident">GetConfigPayload</span><span class="op">&gt;</span>,
    <span class="ident">data</span>: <span class="ident">web</span>::<span class="ident">Data</span><span class="op">&lt;</span><span class="ident">Data</span><span class="op">&gt;</span>,
@@ -255,7 +260,7 @@
                        .<span class="ident">expect</span>(<span class="string">&quot;mcaptcha should be initialized and ready to go&quot;</span>);
                    <span class="comment">// background it. would require data::Data to be static</span>
                    <span class="comment">// to satidfy lifetime</span>
-                    <span class="ident">fetched</span>(<span class="kw-2">&amp;</span><span class="ident">payload</span>.<span class="ident">key</span>, <span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">db</span>).<span class="kw">await</span>;
+                    <span class="ident">record_fetch</span>(<span class="kw-2">&amp;</span><span class="ident">payload</span>.<span class="ident">key</span>, <span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">db</span>).<span class="kw">await</span>;
                    <span class="prelude-val">Ok</span>(<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">json</span>(<span class="ident">config</span>))
                }
            }
@@ -265,7 +270,10 @@
        <span class="prelude-val">None</span> <span class="op">=</span><span class="op">&gt;</span> <span class="prelude-val">Err</span>(<span class="ident">ServiceError</span>::<span class="ident">TokenNotFound</span>),
    }
 }
-
+<span class="doccomment">/// Call this when [MCaptcha][m_captcha::MCaptcha] is not in master.</span>
+<span class="doccomment">///</span>
+<span class="doccomment">/// This fn gets mcaptcha config from database, builds [Defense][m_captcha::Defense],</span>
+<span class="doccomment">/// creates [MCaptcha][m_captcha::MCaptcha] and adds it to [Master][m_captcha::Defense]</span>
 <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">init_mcaptcha</span>(<span class="ident">data</span>: <span class="kw-2">&amp;</span><span class="ident">Data</span>, <span class="ident">key</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">ServiceResult</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
    <span class="comment">// get levels</span>
    <span class="kw">let</span> <span class="ident">levels_fut</span> <span class="op">=</span> <span class="ident">sqlx</span>::<span class="macro">query_as</span><span class="macro">!</span>(
--- a/src/guard/api/v1/pow/mod.rs.html
+++ b/src/guard/api/v1/pow/mod.rs.html
@@ -71,6 +71,7 @@
 <span id="68">68</span>
 <span id="69">69</span>
 <span id="70">70</span>
+<span id="71">71</span>
 </pre><div class="example-wrap"><pre class="rust ">
 <span class="comment">/*
 * Copyright (C) 2021  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
@@ -98,6 +99,7 @@

 <span class="kw">pub</span> <span class="kw">use</span> <span class="kw">super</span>::<span class="ident">mcaptcha</span>::<span class="ident">duration</span>::<span class="ident">GetDurationResp</span>;
 <span class="kw">pub</span> <span class="kw">use</span> <span class="kw">super</span>::<span class="ident">mcaptcha</span>::<span class="ident">levels</span>::<span class="ident">I32Levels</span>;
+<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">api</span>::<span class="ident">v1</span>::<span class="ident">mcaptcha</span>::<span class="ident">stats</span>::<span class="kw-2">*</span>;

 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">services</span>(<span class="ident">cfg</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">web</span>::<span class="ident">ServiceConfig</span>) {
    <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">define_resource</span>;
--- a/src/guard/api/v1/pow/verify_pow.rs.html
+++ b/src/guard/api/v1/pow/verify_pow.rs.html
@@ -131,6 +131,14 @@
 <span id="128">128</span>
 <span id="129">129</span>
 <span id="130">130</span>
+<span id="131">131</span>
+<span id="132">132</span>
+<span id="133">133</span>
+<span id="134">134</span>
+<span id="135">135</span>
+<span id="136">136</span>
+<span id="137">137</span>
+<span id="138">138</span>
 </pre><div class="example-wrap"><pre class="rust ">
 <span class="comment">/*
 * Copyright (C) 2021  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
@@ -148,26 +156,34 @@
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
 */</span>
+<span class="doccomment">//! PoW Verification module</span>

 <span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</span>, <span class="ident">HttpResponse</span>, <span class="ident">Responder</span>};
 <span class="kw">use</span> <span class="ident">m_captcha</span>::<span class="ident">pow</span>::<span class="ident">Work</span>;
 <span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};

+<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">record_solve</span>;
 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">errors</span>::<span class="kw-2">*</span>;
 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">Data</span>;

 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">Deserialize</span>, <span class="ident">Serialize</span>)]</span>
+<span class="doccomment">/// validation token that clients receive as proof for submiting</span>
+<span class="doccomment">/// valid PoW</span>
 <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ValidationToken</span> {
    <span class="kw">pub</span> <span class="ident">token</span>: <span class="ident">String</span>,
 }

 <span class="comment">// API keys are mcaptcha actor names</span>

+<span class="doccomment">/// route handler that verifies PoW and issues a solution token</span>
+<span class="doccomment">/// if verification is successful</span>
 <span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">verify_pow</span>(
    <span class="ident">payload</span>: <span class="ident">web</span>::<span class="ident">Json</span><span class="op">&lt;</span><span class="ident">Work</span><span class="op">&gt;</span>,
    <span class="ident">data</span>: <span class="ident">web</span>::<span class="ident">Data</span><span class="op">&lt;</span><span class="ident">Data</span><span class="op">&gt;</span>,
 ) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">ServiceResult</span><span class="op">&lt;</span><span class="kw">impl</span> <span class="ident">Responder</span><span class="op">&gt;</span> {
+    <span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">payload</span>.<span class="ident">key</span>.<span class="ident">clone</span>();
    <span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">data</span>.<span class="ident">captcha</span>.<span class="ident">verify_pow</span>(<span class="ident">payload</span>.<span class="ident">into_inner</span>()).<span class="kw">await</span><span class="question-mark">?</span>;
+    <span class="ident">record_solve</span>(<span class="kw-2">&amp;</span><span class="ident">key</span>, <span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">db</span>).<span class="kw">await</span>;
    <span class="kw">let</span> <span class="ident">payload</span> <span class="op">=</span> <span class="ident">ValidationToken</span> { <span class="ident">token</span>: <span class="ident">res</span> };
    <span class="prelude-val">Ok</span>(<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">json</span>(<span class="ident">payload</span>))
 }
--- a/src/guard/api/v1/pow/verify_token.rs.html
+++ b/src/guard/api/v1/pow/verify_token.rs.html
@@ -152,6 +152,11 @@
 <span id="149">149</span>
 <span id="150">150</span>
 <span id="151">151</span>
+<span id="152">152</span>
+<span id="153">153</span>
+<span id="154">154</span>
+<span id="155">155</span>
+<span id="156">156</span>
 </pre><div class="example-wrap"><pre class="rust ">
 <span class="comment">/*
 * Copyright (C) 2021  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
@@ -169,11 +174,13 @@
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
 */</span>
+<span class="doccomment">//! PoW success token module</span>

 <span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</span>, <span class="ident">HttpResponse</span>, <span class="ident">Responder</span>};
 <span class="kw">use</span> <span class="ident">m_captcha</span>::<span class="ident">cache</span>::<span class="ident">messages</span>::<span class="ident">VerifyCaptchaResult</span>;
 <span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};

+<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">record_confirm</span>;
 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">errors</span>::<span class="kw-2">*</span>;
 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">Data</span>;

@@ -184,16 +191,19 @@

 <span class="comment">// API keys are mcaptcha actor names</span>

+<span class="doccomment">/// route hander that validates a PoW solution token</span>
 <span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">validate_captcha_token</span>(
    <span class="ident">payload</span>: <span class="ident">web</span>::<span class="ident">Json</span><span class="op">&lt;</span><span class="ident">VerifyCaptchaResult</span><span class="op">&gt;</span>,
    <span class="ident">data</span>: <span class="ident">web</span>::<span class="ident">Data</span><span class="op">&lt;</span><span class="ident">Data</span><span class="op">&gt;</span>,
 ) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">ServiceResult</span><span class="op">&lt;</span><span class="kw">impl</span> <span class="ident">Responder</span><span class="op">&gt;</span> {
+    <span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">payload</span>.<span class="ident">key</span>.<span class="ident">clone</span>();
    <span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">data</span>
        .<span class="ident">captcha</span>
        .<span class="ident">validate_verification_tokens</span>(<span class="ident">payload</span>.<span class="ident">into_inner</span>())
        .<span class="kw">await</span><span class="question-mark">?</span>;
    <span class="kw">let</span> <span class="ident">payload</span> <span class="op">=</span> <span class="ident">CaptchaValidateResp</span> { <span class="ident">valid</span>: <span class="ident">res</span> };
-    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="kw-2">&amp;</span><span class="ident">payload</span>);
+    <span class="ident">record_confirm</span>(<span class="kw-2">&amp;</span><span class="ident">key</span>, <span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">db</span>).<span class="kw">await</span>;
+    <span class="comment">//println!(&quot;{:?}&quot;, &amp;payload);</span>
    <span class="prelude-val">Ok</span>(<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">json</span>(<span class="ident">payload</span>))
 }