mirror of
https://github.com/mCaptcha/mCaptcha.git
synced 2026-02-12 02:25:41 +00:00
712 lines
34 KiB
HTML
712 lines
34 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `db/db-core/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../db_core/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
|
||
<span id="2">2</span>
|
||
<span id="3">3</span>
|
||
<span id="4">4</span>
|
||
<span id="5">5</span>
|
||
<span id="6">6</span>
|
||
<span id="7">7</span>
|
||
<span id="8">8</span>
|
||
<span id="9">9</span>
|
||
<span id="10">10</span>
|
||
<span id="11">11</span>
|
||
<span id="12">12</span>
|
||
<span id="13">13</span>
|
||
<span id="14">14</span>
|
||
<span id="15">15</span>
|
||
<span id="16">16</span>
|
||
<span id="17">17</span>
|
||
<span id="18">18</span>
|
||
<span id="19">19</span>
|
||
<span id="20">20</span>
|
||
<span id="21">21</span>
|
||
<span id="22">22</span>
|
||
<span id="23">23</span>
|
||
<span id="24">24</span>
|
||
<span id="25">25</span>
|
||
<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>
|
||
<span id="55">55</span>
|
||
<span id="56">56</span>
|
||
<span id="57">57</span>
|
||
<span id="58">58</span>
|
||
<span id="59">59</span>
|
||
<span id="60">60</span>
|
||
<span id="61">61</span>
|
||
<span id="62">62</span>
|
||
<span id="63">63</span>
|
||
<span id="64">64</span>
|
||
<span id="65">65</span>
|
||
<span id="66">66</span>
|
||
<span id="67">67</span>
|
||
<span id="68">68</span>
|
||
<span id="69">69</span>
|
||
<span id="70">70</span>
|
||
<span id="71">71</span>
|
||
<span id="72">72</span>
|
||
<span id="73">73</span>
|
||
<span id="74">74</span>
|
||
<span id="75">75</span>
|
||
<span id="76">76</span>
|
||
<span id="77">77</span>
|
||
<span id="78">78</span>
|
||
<span id="79">79</span>
|
||
<span id="80">80</span>
|
||
<span id="81">81</span>
|
||
<span id="82">82</span>
|
||
<span id="83">83</span>
|
||
<span id="84">84</span>
|
||
<span id="85">85</span>
|
||
<span id="86">86</span>
|
||
<span id="87">87</span>
|
||
<span id="88">88</span>
|
||
<span id="89">89</span>
|
||
<span id="90">90</span>
|
||
<span id="91">91</span>
|
||
<span id="92">92</span>
|
||
<span id="93">93</span>
|
||
<span id="94">94</span>
|
||
<span id="95">95</span>
|
||
<span id="96">96</span>
|
||
<span id="97">97</span>
|
||
<span id="98">98</span>
|
||
<span id="99">99</span>
|
||
<span id="100">100</span>
|
||
<span id="101">101</span>
|
||
<span id="102">102</span>
|
||
<span id="103">103</span>
|
||
<span id="104">104</span>
|
||
<span id="105">105</span>
|
||
<span id="106">106</span>
|
||
<span id="107">107</span>
|
||
<span id="108">108</span>
|
||
<span id="109">109</span>
|
||
<span id="110">110</span>
|
||
<span id="111">111</span>
|
||
<span id="112">112</span>
|
||
<span id="113">113</span>
|
||
<span id="114">114</span>
|
||
<span id="115">115</span>
|
||
<span id="116">116</span>
|
||
<span id="117">117</span>
|
||
<span id="118">118</span>
|
||
<span id="119">119</span>
|
||
<span id="120">120</span>
|
||
<span id="121">121</span>
|
||
<span id="122">122</span>
|
||
<span id="123">123</span>
|
||
<span id="124">124</span>
|
||
<span id="125">125</span>
|
||
<span id="126">126</span>
|
||
<span id="127">127</span>
|
||
<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>
|
||
<span id="139">139</span>
|
||
<span id="140">140</span>
|
||
<span id="141">141</span>
|
||
<span id="142">142</span>
|
||
<span id="143">143</span>
|
||
<span id="144">144</span>
|
||
<span id="145">145</span>
|
||
<span id="146">146</span>
|
||
<span id="147">147</span>
|
||
<span id="148">148</span>
|
||
<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>
|
||
<span id="157">157</span>
|
||
<span id="158">158</span>
|
||
<span id="159">159</span>
|
||
<span id="160">160</span>
|
||
<span id="161">161</span>
|
||
<span id="162">162</span>
|
||
<span id="163">163</span>
|
||
<span id="164">164</span>
|
||
<span id="165">165</span>
|
||
<span id="166">166</span>
|
||
<span id="167">167</span>
|
||
<span id="168">168</span>
|
||
<span id="169">169</span>
|
||
<span id="170">170</span>
|
||
<span id="171">171</span>
|
||
<span id="172">172</span>
|
||
<span id="173">173</span>
|
||
<span id="174">174</span>
|
||
<span id="175">175</span>
|
||
<span id="176">176</span>
|
||
<span id="177">177</span>
|
||
<span id="178">178</span>
|
||
<span id="179">179</span>
|
||
<span id="180">180</span>
|
||
<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>
|
||
<span id="188">188</span>
|
||
<span id="189">189</span>
|
||
<span id="190">190</span>
|
||
<span id="191">191</span>
|
||
<span id="192">192</span>
|
||
<span id="193">193</span>
|
||
<span id="194">194</span>
|
||
<span id="195">195</span>
|
||
<span id="196">196</span>
|
||
<span id="197">197</span>
|
||
<span id="198">198</span>
|
||
<span id="199">199</span>
|
||
<span id="200">200</span>
|
||
<span id="201">201</span>
|
||
<span id="202">202</span>
|
||
<span id="203">203</span>
|
||
<span id="204">204</span>
|
||
<span id="205">205</span>
|
||
<span id="206">206</span>
|
||
<span id="207">207</span>
|
||
<span id="208">208</span>
|
||
<span id="209">209</span>
|
||
<span id="210">210</span>
|
||
<span id="211">211</span>
|
||
<span id="212">212</span>
|
||
<span id="213">213</span>
|
||
<span id="214">214</span>
|
||
<span id="215">215</span>
|
||
<span id="216">216</span>
|
||
<span id="217">217</span>
|
||
<span id="218">218</span>
|
||
<span id="219">219</span>
|
||
<span id="220">220</span>
|
||
<span id="221">221</span>
|
||
<span id="222">222</span>
|
||
<span id="223">223</span>
|
||
<span id="224">224</span>
|
||
<span id="225">225</span>
|
||
<span id="226">226</span>
|
||
<span id="227">227</span>
|
||
<span id="228">228</span>
|
||
<span id="229">229</span>
|
||
<span id="230">230</span>
|
||
<span id="231">231</span>
|
||
<span id="232">232</span>
|
||
<span id="233">233</span>
|
||
<span id="234">234</span>
|
||
<span id="235">235</span>
|
||
<span id="236">236</span>
|
||
<span id="237">237</span>
|
||
<span id="238">238</span>
|
||
<span id="239">239</span>
|
||
<span id="240">240</span>
|
||
<span id="241">241</span>
|
||
<span id="242">242</span>
|
||
<span id="243">243</span>
|
||
<span id="244">244</span>
|
||
<span id="245">245</span>
|
||
<span id="246">246</span>
|
||
<span id="247">247</span>
|
||
<span id="248">248</span>
|
||
<span id="249">249</span>
|
||
<span id="250">250</span>
|
||
<span id="251">251</span>
|
||
<span id="252">252</span>
|
||
<span id="253">253</span>
|
||
<span id="254">254</span>
|
||
<span id="255">255</span>
|
||
<span id="256">256</span>
|
||
<span id="257">257</span>
|
||
<span id="258">258</span>
|
||
<span id="259">259</span>
|
||
<span id="260">260</span>
|
||
<span id="261">261</span>
|
||
<span id="262">262</span>
|
||
<span id="263">263</span>
|
||
<span id="264">264</span>
|
||
<span id="265">265</span>
|
||
<span id="266">266</span>
|
||
<span id="267">267</span>
|
||
<span id="268">268</span>
|
||
<span id="269">269</span>
|
||
<span id="270">270</span>
|
||
<span id="271">271</span>
|
||
<span id="272">272</span>
|
||
<span id="273">273</span>
|
||
<span id="274">274</span>
|
||
<span id="275">275</span>
|
||
<span id="276">276</span>
|
||
<span id="277">277</span>
|
||
<span id="278">278</span>
|
||
<span id="279">279</span>
|
||
<span id="280">280</span>
|
||
<span id="281">281</span>
|
||
<span id="282">282</span>
|
||
<span id="283">283</span>
|
||
<span id="284">284</span>
|
||
<span id="285">285</span>
|
||
<span id="286">286</span>
|
||
<span id="287">287</span>
|
||
<span id="288">288</span>
|
||
<span id="289">289</span>
|
||
<span id="290">290</span>
|
||
<span id="291">291</span>
|
||
<span id="292">292</span>
|
||
<span id="293">293</span>
|
||
<span id="294">294</span>
|
||
<span id="295">295</span>
|
||
<span id="296">296</span>
|
||
<span id="297">297</span>
|
||
<span id="298">298</span>
|
||
<span id="299">299</span>
|
||
<span id="300">300</span>
|
||
<span id="301">301</span>
|
||
<span id="302">302</span>
|
||
<span id="303">303</span>
|
||
<span id="304">304</span>
|
||
<span id="305">305</span>
|
||
<span id="306">306</span>
|
||
<span id="307">307</span>
|
||
<span id="308">308</span>
|
||
<span id="309">309</span>
|
||
<span id="310">310</span>
|
||
<span id="311">311</span>
|
||
<span id="312">312</span>
|
||
<span id="313">313</span>
|
||
<span id="314">314</span>
|
||
<span id="315">315</span>
|
||
<span id="316">316</span>
|
||
<span id="317">317</span>
|
||
<span id="318">318</span>
|
||
<span id="319">319</span>
|
||
<span id="320">320</span>
|
||
<span id="321">321</span>
|
||
<span id="322">322</span>
|
||
<span id="323">323</span>
|
||
<span id="324">324</span>
|
||
<span id="325">325</span>
|
||
<span id="326">326</span>
|
||
<span id="327">327</span>
|
||
<span id="328">328</span>
|
||
<span id="329">329</span>
|
||
<span id="330">330</span>
|
||
<span id="331">331</span>
|
||
<span id="332">332</span>
|
||
<span id="333">333</span>
|
||
<span id="334">334</span>
|
||
<span id="335">335</span>
|
||
<span id="336">336</span>
|
||
<span id="337">337</span>
|
||
<span id="338">338</span>
|
||
<span id="339">339</span>
|
||
<span id="340">340</span>
|
||
<span id="341">341</span>
|
||
<span id="342">342</span>
|
||
<span id="343">343</span>
|
||
<span id="344">344</span>
|
||
<span id="345">345</span>
|
||
<span id="346">346</span>
|
||
<span id="347">347</span>
|
||
<span id="348">348</span>
|
||
<span id="349">349</span>
|
||
<span id="350">350</span>
|
||
<span id="351">351</span>
|
||
<span id="352">352</span>
|
||
<span id="353">353</span>
|
||
<span id="354">354</span>
|
||
<span id="355">355</span>
|
||
</pre><pre class="rust"><code><span class="comment">/*
|
||
* Copyright (C) 2022 Aravinth Manivannan <realaravinth@batsense.net>
|
||
*
|
||
* This program is free software: you can redistribute it and/or modify
|
||
* it under the terms of the GNU Affero General Public License as
|
||
* published by the Free Software Foundation, either version 3 of the
|
||
* License, or (at your option) any later version.
|
||
*
|
||
* This program is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
* GNU Affero General Public License for more details.
|
||
*
|
||
* You should have received a copy of the GNU Affero General Public License
|
||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
*/
|
||
|
||
</span><span class="attribute">#![warn(missing_docs)]
|
||
</span><span class="doccomment">//! # `mCaptcha` database operations
|
||
//!
|
||
//! Traits and datastructures used in mCaptcha to interact with database.
|
||
//!
|
||
//! To use an unsupported database with mCaptcha, traits present within this crate should be
|
||
//! implemented.
|
||
//!
|
||
//!
|
||
//! ## Organisation
|
||
//!
|
||
//! Database functionality is divided across various modules:
|
||
//!
|
||
//! - [errors](crate::auth): error data structures used in this crate
|
||
//! - [ops](crate::ops): meta operations like connection pool creation, migrations and getting
|
||
//! connection from pool
|
||
</span><span class="kw">use </span>serde::{Deserialize, Serialize};
|
||
|
||
<span class="kw">pub use </span>libmcaptcha::defense::Level;
|
||
|
||
<span class="kw">pub mod </span>errors;
|
||
<span class="kw">pub mod </span>ops;
|
||
<span class="attribute">#[cfg(feature = <span class="string">"test"</span>)]
|
||
</span><span class="kw">pub mod </span>tests;
|
||
|
||
<span class="kw">use </span>dev::<span class="kw-2">*</span>;
|
||
<span class="kw">pub use </span>ops::GetConnection;
|
||
|
||
<span class="kw">pub mod </span>prelude {
|
||
<span class="doccomment">//! useful imports for users working with a supported database
|
||
|
||
</span><span class="kw">pub use </span><span class="kw">super</span>::errors::<span class="kw-2">*</span>;
|
||
<span class="kw">pub use </span><span class="kw">super</span>::ops::<span class="kw-2">*</span>;
|
||
<span class="kw">pub use super</span>::<span class="kw-2">*</span>;
|
||
}
|
||
|
||
<span class="kw">pub mod </span>dev {
|
||
<span class="doccomment">//! useful imports for supporting a new database
|
||
</span><span class="kw">pub use </span><span class="kw">super</span>::prelude::<span class="kw-2">*</span>;
|
||
<span class="kw">pub use </span>async_trait::async_trait;
|
||
}
|
||
|
||
<span class="attribute">#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
|
||
</span><span class="doccomment">/// Data required to register a new user
|
||
</span><span class="kw">pub struct </span>Register<<span class="lifetime">'a</span>> {
|
||
<span class="doccomment">/// username of new user
|
||
</span><span class="kw">pub </span>username: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="doccomment">/// secret of new user
|
||
</span><span class="kw">pub </span>secret: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="doccomment">/// hashed password of new use
|
||
</span><span class="kw">pub </span>hash: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="doccomment">/// Optionally, email of new use
|
||
</span><span class="kw">pub </span>email: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str>,
|
||
}
|
||
|
||
<span class="attribute">#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
|
||
</span><span class="doccomment">/// data required to update them email of a user
|
||
</span><span class="kw">pub struct </span>UpdateEmail<<span class="lifetime">'a</span>> {
|
||
<span class="doccomment">/// username of the user
|
||
</span><span class="kw">pub </span>username: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="doccomment">/// new email address of the user
|
||
</span><span class="kw">pub </span>new_email: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
}
|
||
|
||
<span class="attribute">#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
|
||
</span><span class="doccomment">/// types of credentials used as identifiers during login
|
||
</span><span class="kw">pub enum </span>Login<<span class="lifetime">'a</span>> {
|
||
<span class="doccomment">/// username as login
|
||
</span>Username(<span class="kw-2">&</span><span class="lifetime">'a </span>str),
|
||
<span class="doccomment">/// email as login
|
||
</span>Email(<span class="kw-2">&</span><span class="lifetime">'a </span>str),
|
||
}
|
||
|
||
<span class="attribute">#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
|
||
</span><span class="doccomment">/// type encapsulating username and hashed password of a user
|
||
</span><span class="kw">pub struct </span>NameHash {
|
||
<span class="doccomment">/// username
|
||
</span><span class="kw">pub </span>username: String,
|
||
<span class="doccomment">/// hashed password
|
||
</span><span class="kw">pub </span>hash: String,
|
||
}
|
||
|
||
<span class="attribute">#[async_trait]
|
||
</span><span class="doccomment">/// mCaptcha's database requirements. To implement support for $Database, kindly implement this
|
||
/// trait.
|
||
</span><span class="kw">pub trait </span>MCDatabase: std::marker::Send + std::marker::Sync + CloneSPDatabase {
|
||
<span class="doccomment">/// ping DB
|
||
</span><span class="kw">async fn </span>ping(<span class="kw-2">&</span><span class="self">self</span>) -> bool;
|
||
|
||
<span class="doccomment">/// register a new user
|
||
</span><span class="kw">async fn </span>register(<span class="kw-2">&</span><span class="self">self</span>, p: <span class="kw-2">&</span>Register) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// delete a user
|
||
</span><span class="kw">async fn </span>delete_user(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// check if username exists
|
||
</span><span class="kw">async fn </span>username_exists(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str) -> DBResult<bool>;
|
||
|
||
<span class="doccomment">/// get user email
|
||
</span><span class="kw">async fn </span>get_email(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str) -> DBResult<<span class="prelude-ty">Option</span><String>>;
|
||
|
||
<span class="doccomment">/// check if email exists
|
||
</span><span class="kw">async fn </span>email_exists(<span class="kw-2">&</span><span class="self">self</span>, email: <span class="kw-2">&</span>str) -> DBResult<bool>;
|
||
|
||
<span class="doccomment">/// update a user's email
|
||
</span><span class="kw">async fn </span>update_email(<span class="kw-2">&</span><span class="self">self</span>, p: <span class="kw-2">&</span>UpdateEmail) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// get a user's password
|
||
</span><span class="kw">async fn </span>get_password(<span class="kw-2">&</span><span class="self">self</span>, l: <span class="kw-2">&</span>Login) -> DBResult<NameHash>;
|
||
|
||
<span class="doccomment">/// update user's password
|
||
</span><span class="kw">async fn </span>update_password(<span class="kw-2">&</span><span class="self">self</span>, p: <span class="kw-2">&</span>NameHash) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// update username
|
||
</span><span class="kw">async fn </span>update_username(<span class="kw-2">&</span><span class="self">self</span>, current: <span class="kw-2">&</span>str, new: <span class="kw-2">&</span>str) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// get a user's secret
|
||
</span><span class="kw">async fn </span>get_secret(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str) -> DBResult<Secret>;
|
||
|
||
<span class="doccomment">/// get a user's secret from a captcha key
|
||
</span><span class="kw">async fn </span>get_secret_from_captcha(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>str) -> DBResult<Secret>;
|
||
|
||
<span class="doccomment">/// update a user's secret
|
||
</span><span class="kw">async fn </span>update_secret(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str, secret: <span class="kw-2">&</span>str) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// create new captcha
|
||
</span><span class="kw">async fn </span>create_captcha(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str, p: <span class="kw-2">&</span>CreateCaptcha) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// Get captcha config
|
||
</span><span class="kw">async fn </span>get_captcha_config(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str, key: <span class="kw-2">&</span>str) -> DBResult<Captcha>;
|
||
|
||
<span class="doccomment">/// Get all captchas belonging to user
|
||
</span><span class="kw">async fn </span>get_all_user_captchas(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str) -> DBResult<Vec<Captcha>>;
|
||
|
||
<span class="doccomment">/// update captcha metadata; doesn't change captcha key
|
||
</span><span class="kw">async fn </span>update_captcha_metadata(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="kw-2">&</span>str,
|
||
p: <span class="kw-2">&</span>CreateCaptcha,
|
||
) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// update captcha key; doesn't change metadata
|
||
</span><span class="kw">async fn </span>update_captcha_key(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="kw-2">&</span>str,
|
||
old_key: <span class="kw-2">&</span>str,
|
||
new_key: <span class="kw-2">&</span>str,
|
||
) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// Add levels to captcha
|
||
</span><span class="kw">async fn </span>add_captcha_levels(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="kw-2">&</span>str,
|
||
captcha_key: <span class="kw-2">&</span>str,
|
||
levels: <span class="kw-2">&</span>[Level],
|
||
) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// check if captcha exists
|
||
</span><span class="kw">async fn </span>captcha_exists(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>,
|
||
captcha_key: <span class="kw-2">&</span>str,
|
||
) -> DBResult<bool>;
|
||
|
||
<span class="doccomment">/// Delete all levels of a captcha
|
||
</span><span class="kw">async fn </span>delete_captcha_levels(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="kw-2">&</span>str,
|
||
captcha_key: <span class="kw-2">&</span>str,
|
||
) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// Delete captcha
|
||
</span><span class="kw">async fn </span>delete_captcha(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str, captcha_key: <span class="kw-2">&</span>str) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// Get captcha levels
|
||
</span><span class="kw">async fn </span>get_captcha_levels(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>,
|
||
captcha_key: <span class="kw-2">&</span>str,
|
||
) -> DBResult<Vec<Level>>;
|
||
|
||
<span class="doccomment">/// Get captcha's cooldown period
|
||
</span><span class="kw">async fn </span>get_captcha_cooldown(<span class="kw-2">&</span><span class="self">self</span>, captcha_key: <span class="kw-2">&</span>str) -> DBResult<i32>;
|
||
|
||
<span class="doccomment">/// Add traffic configuration
|
||
</span><span class="kw">async fn </span>add_traffic_pattern(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="kw-2">&</span>str,
|
||
captcha_key: <span class="kw-2">&</span>str,
|
||
pattern: <span class="kw-2">&</span>TrafficPattern,
|
||
) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// Get traffic configuration
|
||
</span><span class="kw">async fn </span>get_traffic_pattern(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="kw-2">&</span>str,
|
||
captcha_key: <span class="kw-2">&</span>str,
|
||
) -> DBResult<TrafficPattern>;
|
||
|
||
<span class="doccomment">/// Delete traffic configuration
|
||
</span><span class="kw">async fn </span>delete_traffic_pattern(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="kw-2">&</span>str,
|
||
captcha_key: <span class="kw-2">&</span>str,
|
||
) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// create new notification
|
||
</span><span class="kw">async fn </span>create_notification(<span class="kw-2">&</span><span class="self">self</span>, p: <span class="kw-2">&</span>AddNotification) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// get all unread notifications
|
||
</span><span class="kw">async fn </span>get_all_unread_notifications(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
username: <span class="kw-2">&</span>str,
|
||
) -> DBResult<Vec<Notification>>;
|
||
|
||
<span class="doccomment">/// mark a notification read
|
||
</span><span class="kw">async fn </span>mark_notification_read(<span class="kw-2">&</span><span class="self">self</span>, username: <span class="kw-2">&</span>str, id: i32) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// record PoWConfig fetches
|
||
</span><span class="kw">async fn </span>record_fetch(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>str) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// record PoWConfig solves
|
||
</span><span class="kw">async fn </span>record_solve(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>str) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// record PoWConfig confirms
|
||
</span><span class="kw">async fn </span>record_confirm(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>str) -> DBResult<()>;
|
||
|
||
<span class="doccomment">/// fetch PoWConfig fetches
|
||
</span><span class="kw">async fn </span>fetch_config_fetched(<span class="kw-2">&</span><span class="self">self</span>, user: <span class="kw-2">&</span>str, key: <span class="kw-2">&</span>str) -> DBResult<Vec<i64>>;
|
||
|
||
<span class="doccomment">/// fetch PoWConfig solves
|
||
</span><span class="kw">async fn </span>fetch_solve(<span class="kw-2">&</span><span class="self">self</span>, user: <span class="kw-2">&</span>str, key: <span class="kw-2">&</span>str) -> DBResult<Vec<i64>>;
|
||
|
||
<span class="doccomment">/// fetch PoWConfig confirms
|
||
</span><span class="kw">async fn </span>fetch_confirm(<span class="kw-2">&</span><span class="self">self</span>, user: <span class="kw-2">&</span>str, key: <span class="kw-2">&</span>str) -> DBResult<Vec<i64>>;
|
||
}
|
||
|
||
<span class="attribute">#[derive(Debug, Clone, Default, Deserialize, Serialize, PartialEq)]
|
||
</span><span class="doccomment">/// Captcha statistics with time recorded in UNIX epoch formats
|
||
</span><span class="kw">pub struct </span>StatsUnixTimestamp {
|
||
<span class="doccomment">/// times at which the configuration were fetched
|
||
</span><span class="kw">pub </span>config_fetches: Vec<i64>,
|
||
<span class="doccomment">/// times at which the PoW was solved
|
||
</span><span class="kw">pub </span>solves: Vec<i64>,
|
||
<span class="doccomment">/// times at which the PoW token was verified
|
||
</span><span class="kw">pub </span>confirms: Vec<i64>,
|
||
}
|
||
|
||
<span class="attribute">#[derive(Debug, Clone, Default, Deserialize, Serialize, PartialEq)]
|
||
</span><span class="doccomment">/// Represents notification
|
||
</span><span class="kw">pub struct </span>Notification {
|
||
<span class="doccomment">/// receiver name of the notification
|
||
</span><span class="kw">pub </span>name: <span class="prelude-ty">Option</span><String>,
|
||
<span class="doccomment">/// heading of the notification
|
||
</span><span class="kw">pub </span>heading: <span class="prelude-ty">Option</span><String>,
|
||
<span class="doccomment">/// message of the notification
|
||
</span><span class="kw">pub </span>message: <span class="prelude-ty">Option</span><String>,
|
||
<span class="doccomment">/// when notification was received
|
||
</span><span class="kw">pub </span>received: <span class="prelude-ty">Option</span><i64>,
|
||
<span class="doccomment">/// db assigned ID of the notification
|
||
</span><span class="kw">pub </span>id: <span class="prelude-ty">Option</span><i32>,
|
||
}
|
||
|
||
<span class="attribute">#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
|
||
</span><span class="doccomment">/// Data required to add notification
|
||
</span><span class="kw">pub struct </span>AddNotification<<span class="lifetime">'a</span>> {
|
||
<span class="doccomment">/// who is the notification addressed to?
|
||
</span><span class="kw">pub </span>to: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="doccomment">/// notification sender
|
||
</span><span class="kw">pub </span>from: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="doccomment">/// heading of the notification
|
||
</span><span class="kw">pub </span>heading: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="doccomment">/// message of the notification
|
||
</span><span class="kw">pub </span>message: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
}
|
||
|
||
<span class="attribute">#[derive(Default, PartialEq, Serialize, Deserialize, Clone, Debug)]
|
||
</span><span class="doccomment">/// User's traffic pattern; used in generating a captcha configuration
|
||
</span><span class="kw">pub struct </span>TrafficPattern {
|
||
<span class="doccomment">/// average traffic of user's website
|
||
</span><span class="kw">pub </span>avg_traffic: u32,
|
||
<span class="doccomment">/// the peak traffic that the user's website can handle
|
||
</span><span class="kw">pub </span>peak_sustainable_traffic: u32,
|
||
<span class="doccomment">/// traffic that bought the user's website down; optional
|
||
</span><span class="kw">pub </span>broke_my_site_traffic: <span class="prelude-ty">Option</span><u32>,
|
||
}
|
||
|
||
<span class="attribute">#[derive(Clone, Debug, Default, PartialEq, Deserialize, Serialize)]
|
||
</span><span class="doccomment">/// data required to create new captcha
|
||
</span><span class="kw">pub struct </span>CreateCaptcha<<span class="lifetime">'a</span>> {
|
||
<span class="doccomment">/// cool down duration
|
||
</span><span class="kw">pub </span>duration: i32,
|
||
<span class="doccomment">/// description of the captcha
|
||
</span><span class="kw">pub </span>description: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="doccomment">/// secret key of the captcha
|
||
</span><span class="kw">pub </span>key: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
}
|
||
|
||
<span class="attribute">#[derive(Clone, Debug, Default, PartialEq, Deserialize, Serialize)]
|
||
</span><span class="doccomment">/// Data representing a captcha
|
||
</span><span class="kw">pub struct </span>Captcha {
|
||
<span class="doccomment">/// Database assigned ID
|
||
</span><span class="kw">pub </span>config_id: i32,
|
||
<span class="doccomment">/// cool down duration
|
||
</span><span class="kw">pub </span>duration: i32,
|
||
<span class="doccomment">/// description of the captcha
|
||
</span><span class="kw">pub </span>description: String,
|
||
<span class="doccomment">/// secret key of the captcha
|
||
</span><span class="kw">pub </span>key: String,
|
||
}
|
||
|
||
<span class="attribute">#[derive(Clone, Debug, Deserialize, PartialEq, Default, Serialize)]
|
||
</span><span class="doccomment">/// datastructure representing a user's secret
|
||
</span><span class="kw">pub struct </span>Secret {
|
||
<span class="doccomment">/// user's secret
|
||
</span><span class="kw">pub </span>secret: String,
|
||
}
|
||
|
||
<span class="doccomment">/// Trait to clone MCDatabase
|
||
</span><span class="kw">pub trait </span>CloneSPDatabase {
|
||
<span class="doccomment">/// clone DB
|
||
</span><span class="kw">fn </span>clone_db(<span class="kw-2">&</span><span class="self">self</span>) -> Box<<span class="kw">dyn </span>MCDatabase>;
|
||
}
|
||
|
||
<span class="kw">impl</span><T> CloneSPDatabase <span class="kw">for </span>T
|
||
<span class="kw">where
|
||
</span>T: MCDatabase + Clone + <span class="lifetime">'static</span>,
|
||
{
|
||
<span class="kw">fn </span>clone_db(<span class="kw-2">&</span><span class="self">self</span>) -> Box<<span class="kw">dyn </span>MCDatabase> {
|
||
Box::new(<span class="self">self</span>.clone())
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl </span>Clone <span class="kw">for </span>Box<<span class="kw">dyn </span>MCDatabase> {
|
||
<span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{
|
||
(<span class="kw-2">**</span><span class="self">self</span>).clone_db()
|
||
}
|
||
}
|
||
</code></pre></div>
|
||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="db_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0 (69f9c33d7 2022-12-12)" ></div></body></html> |