mirror of
https://github.com/mCaptcha/mCaptcha.git
synced 2026-02-11 18:15:39 +00:00
307 lines
19 KiB
HTML
307 lines
19 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 `browser/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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"><div class="sidebar-menu" role="button">☰</div><a href='../../mcaptcha_browser/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><pre class="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>
|
||
</pre><pre class="rust">
|
||
<span class="comment">/*
|
||
* mCaptcha is a PoW based DoS protection software.
|
||
* This is the frontend web component of the mCaptcha system
|
||
* Copyright © 2021 Aravinth Manivnanan <realaravinth@batsense.net>.
|
||
*
|
||
* Use of this source code is governed by Apache 2.0 or MIT license.
|
||
* You shoud have received a copy of MIT and Apache 2.0 along with
|
||
* this program. If not, see <https://spdx.org/licenses/MIT.html> for
|
||
* MIT or <http://www.apache.org/licenses/LICENSE-2.0> for Apache.
|
||
*/</span>
|
||
<span class="doccomment">//! mCaptcha is a proof of work based Denaial-of-Service attack protection system.</span>
|
||
<span class="doccomment">//! This is is a WASM library that you can embed in your frontend code to protect your</span>
|
||
<span class="doccomment">//! service.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! A commercial managed solution is in the works but I'd much rather prefer</span>
|
||
<span class="doccomment">//! folks host their own instances as it will make the more decentralized and free.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ## Workflow:</span>
|
||
<span class="doccomment">//! mCaptcha workflow in the frontend is simple.</span>
|
||
<span class="doccomment">//! 1. Call service to get a proof of work(PoW) configuration</span>
|
||
<span class="doccomment">//! 2. Call into mCaptcha to get PoW</span>
|
||
<span class="doccomment">//! 3. Send PoW to mCaptcha service</span>
|
||
<span class="doccomment">//! 4. If proof is valid, the service will return a token to the client</span>
|
||
<span class="doccomment">//! 5. Submit token to your backend along with your app data(if any)</span>
|
||
<span class="doccomment">//! 6. In backend, validate client's token with mCaptcha service</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ## Example:</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! generate proof-of-work</span>
|
||
<span class="doccomment">//! ```rust</span>
|
||
<span class="doccomment">//! use mcaptcha_browser::*;</span>
|
||
<span class="doccomment">//! use pow_sha256::*;</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! // salt using which PoW should be computed</span>
|
||
<span class="doccomment">//! const SALT: &str = "yrandomsaltisnotlongenoug";</span>
|
||
<span class="doccomment">//! // one-time phrase over which PoW should be computed</span>
|
||
<span class="doccomment">//! const PHRASE: &str = "ironmansucks";</span>
|
||
<span class="doccomment">//! // and the difficulty factor</span>
|
||
<span class="doccomment">//! const DIFFICULTY: u32 = 1000;</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! // currently gen_pow() returns a JSON formated string to better communicate</span>
|
||
<span class="doccomment">//! // with JavaScript. See [PoW<T>][pow_sha256::PoW] for schema</span>
|
||
<span class="doccomment">//! let serialised_work = gen_pow(SALT.into(), PHRASE.into(), DIFFICULTY);</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! let work: Work = serde_json::from_str(&serialised_work).unwrap();</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! let work = PoWBuilder::default()</span>
|
||
<span class="doccomment">//! .result(work.result)</span>
|
||
<span class="doccomment">//! .nonce(work.nonce)</span>
|
||
<span class="doccomment">//! .build()</span>
|
||
<span class="doccomment">//! .unwrap();</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! let config = ConfigBuilder::default().salt(SALT.into()).build().unwrap();</span>
|
||
<span class="doccomment">//! assert!(config.is_valid_proof(&work, &PHRASE.to_string()));</span>
|
||
<span class="doccomment">//! assert!(config.is_sufficient_difficulty(&work, DIFFICULTY));</span>
|
||
<span class="doccomment">//! ```</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="ident">wasm_bindgen::prelude</span>::<span class="kw-2">*</span>;
|
||
|
||
<span class="comment">// When the `wee_alloc` feature is enabled, use `wee_alloc` as the global</span>
|
||
<span class="comment">// allocator.</span>
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"wee_alloc"</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">global_allocator</span>]</span>
|
||
<span class="kw">static</span> <span class="ident">ALLOC</span>: <span class="ident">wee_alloc::WeeAlloc</span> <span class="op">=</span> <span class="ident">wee_alloc::WeeAlloc::INIT</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">pow_sha256</span>::{<span class="ident">ConfigBuilder</span>, <span class="ident">PoW</span>};
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Work</span> {
|
||
<span class="kw">pub</span> <span class="ident">result</span>: <span class="ident">String</span>,
|
||
<span class="kw">pub</span> <span class="ident">nonce</span>: <span class="ident">u64</span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">PoW</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span> <span class="kw">for</span> <span class="ident">Work</span> {
|
||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">p</span>: <span class="ident">PoW</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
|
||
<span class="ident">Work</span> {
|
||
<span class="ident">result</span>: <span class="ident">p</span>.<span class="ident">result</span>,
|
||
<span class="ident">nonce</span>: <span class="ident">p</span>.<span class="ident">nonce</span>,
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// generate proof-of-work</span>
|
||
<span class="doccomment">/// ```rust</span>
|
||
<span class="doccomment">/// fn main() {</span>
|
||
<span class="doccomment">/// use mcaptcha_browser::*;</span>
|
||
<span class="doccomment">/// use pow_sha256::*;</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// // salt using which PoW should be computed</span>
|
||
<span class="doccomment">/// const SALT: &str = "yrandomsaltisnotlongenoug";</span>
|
||
<span class="doccomment">/// // one-time phrase over which PoW should be computed</span>
|
||
<span class="doccomment">/// const PHRASE: &str = "ironmansucks";</span>
|
||
<span class="doccomment">/// // and the difficulty factor</span>
|
||
<span class="doccomment">/// const DIFFICULTY: u32 = 1000;</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// // currently gen_pow() returns a JSON formated string to better communicate</span>
|
||
<span class="doccomment">/// // with JavaScript. See [PoW<T>][pow_sha256::PoW] for schema</span>
|
||
<span class="doccomment">/// let serialised_work = gen_pow(SALT.into(), PHRASE.into(), DIFFICULTY);</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// let work: Work = serde_json::from_str(&serialised_work).unwrap();</span>
|
||
<span class="doccomment">/// </span>
|
||
<span class="doccomment">/// let work = PoWBuilder::default()</span>
|
||
<span class="doccomment">/// .result(work.result)</span>
|
||
<span class="doccomment">/// .nonce(work.nonce)</span>
|
||
<span class="doccomment">/// .build()</span>
|
||
<span class="doccomment">/// .unwrap();</span>
|
||
<span class="doccomment">/// </span>
|
||
<span class="doccomment">/// let config = ConfigBuilder::default().salt(SALT.into()).build().unwrap();</span>
|
||
<span class="doccomment">/// assert!(config.is_valid_proof(&work, &PHRASE.to_string()));</span>
|
||
<span class="doccomment">/// assert!(config.is_sufficient_difficulty(&work, DIFFICULTY));</span>
|
||
<span class="doccomment">/// }</span>
|
||
<span class="doccomment">/// ```</span>
|
||
<span class="attribute">#[<span class="ident">wasm_bindgen</span>]</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">gen_pow</span>(<span class="ident">salt</span>: <span class="ident">String</span>, <span class="ident">phrase</span>: <span class="ident">String</span>, <span class="ident">difficulty_factor</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">ConfigBuilder::default</span>().<span class="ident">salt</span>(<span class="ident">salt</span>).<span class="ident">build</span>().<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">work</span> <span class="op">=</span> <span class="ident">config</span>.<span class="ident">prove_work</span>(<span class="kw-2">&</span><span class="ident">phrase</span>, <span class="ident">difficulty_factor</span>).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">work</span>: <span class="ident">Work</span> <span class="op">=</span> <span class="ident">work</span>.<span class="ident">into</span>();
|
||
|
||
<span class="ident">serde_json::to_string</span>(<span class="kw-2">&</span><span class="ident">work</span>).<span class="ident">unwrap</span>()
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">use</span> <span class="ident">pow_sha256::PoWBuilder</span>;
|
||
|
||
<span class="kw">const</span> <span class="ident">SALT</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"yrandomsaltisnotlongenoug"</span>;
|
||
<span class="kw">const</span> <span class="ident">PHRASE</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"ironmansucks"</span>;
|
||
<span class="kw">const</span> <span class="ident">DIFFICULTY</span>: <span class="ident">u32</span> <span class="op">=</span> <span class="number">1000</span>;
|
||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||
<span class="kw">fn</span> <span class="ident">it_works</span>() {
|
||
<span class="kw">let</span> <span class="ident">serialised_work</span> <span class="op">=</span> <span class="ident">gen_pow</span>(<span class="ident">SALT</span>.<span class="ident">into</span>(), <span class="ident">PHRASE</span>.<span class="ident">into</span>(), <span class="ident">DIFFICULTY</span>);
|
||
<span class="kw">let</span> <span class="ident">work</span>: <span class="ident">Work</span> <span class="op">=</span> <span class="ident">serde_json::from_str</span>(<span class="kw-2">&</span><span class="ident">serialised_work</span>).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">work</span> <span class="op">=</span> <span class="ident">PoWBuilder::default</span>()
|
||
.<span class="ident">result</span>(<span class="ident">work</span>.<span class="ident">result</span>)
|
||
.<span class="ident">nonce</span>(<span class="ident">work</span>.<span class="ident">nonce</span>)
|
||
.<span class="ident">build</span>()
|
||
.<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">ConfigBuilder::default</span>().<span class="ident">salt</span>(<span class="ident">SALT</span>.<span class="ident">into</span>()).<span class="ident">build</span>().<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">config</span>.<span class="ident">is_valid_proof</span>(<span class="kw-2">&</span><span class="ident">work</span>, <span class="kw-2">&</span><span class="ident">PHRASE</span>.<span class="ident">to_string</span>()));
|
||
<span class="macro">assert!</span>(<span class="ident">config</span>.<span class="ident">is_sufficient_difficulty</span>(<span class="kw-2">&</span><span class="ident">work</span>, <span class="ident">DIFFICULTY</span>));
|
||
}
|
||
}
|
||
</pre></div>
|
||
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mcaptcha_browser" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html> |