Files
mCaptcha/src/mcaptcha/data.rs.html
2022-12-16 09:48:47 +00:00

510 lines
23 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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 `src/data.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>data.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="../../mcaptcha/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>
</pre><pre class="rust"><code><span class="comment">/*
* Copyright (C) 2022 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
*
* 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 &lt;https://www.gnu.org/licenses/&gt;.
*/
</span><span class="doccomment">//! App data: redis cache, database connections, etc.
</span><span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>std::thread;
<span class="kw">use </span>actix::prelude::<span class="kw-2">*</span>;
<span class="kw">use </span>argon2_creds::{Config, ConfigBuilder, PasswordPolicy};
<span class="kw">use </span>lettre::transport::smtp::authentication::Mechanism;
<span class="kw">use </span>lettre::{
transport::smtp::authentication::Credentials, AsyncSmtpTransport, Tokio1Executor,
};
<span class="kw">use </span>libmcaptcha::cache::hashcache::HashCache;
<span class="kw">use </span>libmcaptcha::cache::redis::RedisCache;
<span class="kw">use </span>libmcaptcha::master::redis::master::Master <span class="kw">as </span>RedisMaster;
<span class="kw">use </span>libmcaptcha::redis::RedisConfig;
<span class="kw">use </span>libmcaptcha::{
cache::messages::VerifyCaptchaResult,
cache::Save,
errors::CaptchaResult,
master::messages::{AddSite, RemoveCaptcha, Rename},
master::{embedded::master::Master <span class="kw">as </span>EmbeddedMaster, Master <span class="kw">as </span>MasterTrait},
pow::ConfigBuilder <span class="kw">as </span>PoWConfigBuilder,
pow::PoWConfig,
pow::Work,
system::{System, SystemBuilder},
};
<span class="kw">use </span><span class="kw">crate</span>::db::{<span class="self">self</span>, BoxDB};
<span class="kw">use </span><span class="kw">crate</span>::errors::ServiceResult;
<span class="kw">use </span><span class="kw">crate</span>::settings::Settings;
<span class="kw">use </span><span class="kw">crate</span>::stats::{Dummy, Real, Stats};
<span class="macro">macro_rules! </span>enum_system_actor {
(<span class="macro-nonterminal">$name</span>:ident, <span class="macro-nonterminal">$</span><span class="kw">type</span>:<span class="macro-nonterminal">ident</span>) =&gt; {
<span class="kw">pub async fn </span><span class="macro-nonterminal">$name</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, msg: <span class="macro-nonterminal">$</span><span class="kw">type</span>) -&gt; <span class="macro-nonterminal">ServiceResult</span>&lt;()&gt; {
<span class="kw">match </span><span class="self">self </span>{
<span class="self">Self</span>::Embedded(val) =&gt; val.master.send(msg).<span class="kw">await</span><span class="question-mark">?</span>.<span class="kw">await</span><span class="question-mark">??</span>,
<span class="self">Self</span>::Redis(val) =&gt; val.master.send(msg).<span class="kw">await</span><span class="question-mark">?</span>.<span class="kw">await</span><span class="question-mark">??</span>,
};
<span class="prelude-val">Ok</span>(())
}
};
}
<span class="macro">macro_rules! </span>enum_system_wrapper {
(<span class="macro-nonterminal">$name</span>:ident, <span class="macro-nonterminal">$</span><span class="kw">type</span>:<span class="macro-nonterminal">ty</span>, <span class="macro-nonterminal">$return_type</span>:ty) =&gt; {
<span class="kw">pub async fn </span><span class="macro-nonterminal">$name</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, msg: <span class="macro-nonterminal">$</span><span class="kw">type</span>) -&gt; <span class="macro-nonterminal">$return_type </span>{
<span class="kw">match </span><span class="self">self </span>{
<span class="self">Self</span>::Embedded(val) =&gt; val.<span class="macro-nonterminal">$name</span>(msg).<span class="kw">await</span>,
<span class="self">Self</span>::Redis(val) =&gt; val.<span class="macro-nonterminal">$name</span>(msg).<span class="kw">await</span>,
}
}
};
}
<span class="doccomment">/// Represents mCaptcha cache and master system.
/// When Redis is configured, [SystemGroup::Redis] is used and
/// in its absence, [SystemGroup::Embedded] is used
</span><span class="kw">pub enum </span>SystemGroup {
Embedded(System&lt;HashCache, EmbeddedMaster&gt;),
Redis(System&lt;RedisCache, RedisMaster&gt;),
}
<span class="attribute">#[allow(unused_doc_comments)]
</span><span class="kw">impl </span>SystemGroup {
<span class="comment">// TODO find a way to document these methods
// utility function to get difficulty factor of site `id` and cache it
</span><span class="macro">enum_system_wrapper!</span>(get_pow, String, CaptchaResult&lt;<span class="prelude-ty">Option</span>&lt;PoWConfig&gt;&gt;);
<span class="comment">// utility function to verify [Work]
</span><span class="kw">pub async fn </span>verify_pow(<span class="kw-2">&amp;</span><span class="self">self</span>, msg: Work, ip: String) -&gt; CaptchaResult&lt;String&gt; {
<span class="kw">match </span><span class="self">self </span>{
<span class="self">Self</span>::Embedded(val) =&gt; val.verify_pow(msg, ip).<span class="kw">await</span>,
<span class="self">Self</span>::Redis(val) =&gt; val.verify_pow(msg, ip).<span class="kw">await</span>,
}
}
<span class="comment">// utility function to validate verification tokens
</span><span class="macro">enum_system_wrapper!</span>(
validate_verification_tokens,
VerifyCaptchaResult,
CaptchaResult&lt;bool&gt;
);
<span class="comment">// utility function to AddSite
</span><span class="macro">enum_system_actor!</span>(add_site, AddSite);
<span class="comment">// utility function to rename captcha
</span><span class="macro">enum_system_actor!</span>(rename, Rename);
<span class="comment">// utility function to remove captcha
</span><span class="macro">enum_system_actor!</span>(remove, RemoveCaptcha);
<span class="kw">fn </span>new_system&lt;A: Save, B: MasterTrait&gt;(
s: <span class="kw-2">&amp;</span>Settings,
m: Addr&lt;B&gt;,
c: Addr&lt;A&gt;,
) -&gt; System&lt;A, B&gt; {
<span class="kw">let </span>pow = PoWConfigBuilder::default()
.salt(s.captcha.salt.clone())
.build()
.unwrap();
<span class="kw">let </span>runners = <span class="kw">if let </span><span class="prelude-val">Some</span>(runners) = s.captcha.runners {
runners
} <span class="kw">else </span>{
num_cpus::get_physical()
};
SystemBuilder::default()
.pow(pow)
.cache(c)
.master(m)
.runners(runners)
.queue_length(s.captcha.queue_length)
.build()
}
<span class="comment">// read settings, if Redis is configured then produce a Redis mCaptcha cache
// based SystemGroup
</span><span class="kw">async fn </span>new(s: <span class="kw-2">&amp;</span>Settings) -&gt; <span class="self">Self </span>{
<span class="kw">match </span><span class="kw-2">&amp;</span>s.redis {
<span class="prelude-val">Some</span>(val) =&gt; {
<span class="kw">let </span>master = RedisMaster::new(RedisConfig::Single(val.url.clone()))
.<span class="kw">await
</span>.unwrap()
.start();
<span class="kw">let </span>cache = RedisCache::new(RedisConfig::Single(val.url.clone()))
.<span class="kw">await
</span>.unwrap()
.start();
<span class="kw">let </span>captcha = <span class="self">Self</span>::new_system(s, master, cache);
SystemGroup::Redis(captcha)
}
<span class="prelude-val">None </span>=&gt; {
<span class="kw">let </span>master = EmbeddedMaster::new(s.captcha.gc).start();
<span class="kw">let </span>cache = HashCache::default().start();
<span class="kw">let </span>captcha = <span class="self">Self</span>::new_system(s, master, cache);
SystemGroup::Embedded(captcha)
}
}
}
}
<span class="doccomment">/// App data
</span><span class="kw">pub struct </span>Data {
<span class="doccomment">/// database ops defined by db crates
</span><span class="kw">pub </span>db: BoxDB,
<span class="doccomment">/// credential management configuration
</span><span class="kw">pub </span>creds: Config,
<span class="doccomment">/// mCaptcha system: Redis cache, etc.
</span><span class="kw">pub </span>captcha: SystemGroup,
<span class="doccomment">/// email client
</span><span class="kw">pub </span>mailer: <span class="prelude-ty">Option</span>&lt;Mailer&gt;,
<span class="doccomment">/// app settings
</span><span class="kw">pub </span>settings: Settings,
<span class="doccomment">/// stats recorder
</span><span class="kw">pub </span>stats: Box&lt;<span class="kw">dyn </span>Stats&gt;,
}
<span class="kw">impl </span>Data {
<span class="kw">pub fn </span>get_creds() -&gt; Config {
ConfigBuilder::default()
.username_case_mapped(<span class="bool-val">true</span>)
.profanity(<span class="bool-val">true</span>)
.blacklist(<span class="bool-val">true</span>)
.password_policy(PasswordPolicy::default())
.build()
.unwrap()
}
<span class="attribute">#[cfg(not(tarpaulin_include))]
</span><span class="doccomment">/// create new instance of app data
</span><span class="kw">pub async fn </span>new(s: <span class="kw-2">&amp;</span>Settings) -&gt; Arc&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>creds = <span class="self">Self</span>::get_creds();
<span class="kw">let </span>c = creds.clone();
<span class="attribute">#[allow(unused_variables)]
</span><span class="kw">let </span>init = thread::spawn(<span class="kw">move </span>|| {
<span class="macro">log::info!</span>(<span class="string">&quot;Initializing credential manager&quot;</span>);
c.init();
<span class="macro">log::info!</span>(<span class="string">&quot;Initialized credential manager&quot;</span>);
});
<span class="kw">let </span>db = <span class="kw">match </span>s.database.database_type {
<span class="kw">crate</span>::settings::DBType::Maria =&gt; db::maria::get_data(<span class="prelude-val">Some</span>(s.clone())).<span class="kw">await</span>,
<span class="kw">crate</span>::settings::DBType::Postgres =&gt; db::pg::get_data(<span class="prelude-val">Some</span>(s.clone())).<span class="kw">await</span>,
};
<span class="kw">let </span>stats: Box&lt;<span class="kw">dyn </span>Stats&gt; = <span class="kw">if </span>s.captcha.enable_stats {
Box::new(Real::default())
} <span class="kw">else </span>{
Box::new(Dummy::default())
};
<span class="kw">let </span>data = Data {
creds,
db,
captcha: SystemGroup::new(s).<span class="kw">await</span>,
mailer: <span class="self">Self</span>::get_mailer(s),
settings: s.clone(),
stats,
};
<span class="attribute">#[cfg(not(debug_assertions))]
</span>init.join().unwrap();
Arc::new(data)
}
<span class="kw">fn </span>get_mailer(s: <span class="kw-2">&amp;</span>Settings) -&gt; <span class="prelude-ty">Option</span>&lt;Mailer&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(smtp) = s.smtp.as_ref() {
<span class="kw">let </span>creds =
Credentials::new(smtp.username.to_string(), smtp.password.to_string()); <span class="comment">// &quot;smtp_username&quot;.to_string(), &quot;smtp_password&quot;.to_string());
</span><span class="kw">let </span>mailer: Mailer =
AsyncSmtpTransport::&lt;Tokio1Executor&gt;::builder_dangerous(<span class="kw-2">&amp;</span>smtp.url)
.port(smtp.port)
.credentials(creds)
.authentication(<span class="macro">vec!</span>[
Mechanism::Login,
Mechanism::Xoauth2,
Mechanism::Plain,
])
.build();
<span class="comment">// let mailer: Mailer = AsyncSmtpTransport::&lt;Tokio1Executor&gt;::relay(&amp;smtp.url) //&quot;smtp.gmail.com&quot;)
// .unwrap()
// .credentials(creds)
// .build();
</span><span class="prelude-val">Some</span>(mailer)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
}
<span class="doccomment">/// Mailer data type AsyncSmtpTransport&lt;Tokio1Executor&gt;
</span><span class="kw">pub type </span>Mailer = AsyncSmtpTransport&lt;Tokio1Executor&gt;;
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mcaptcha" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0 (69f9c33d7 2022-12-12)" ></div></body></html>