mirror of
https://github.com/mCaptcha/mCaptcha.git
synced 2026-02-11 10:05:41 +00:00
196 lines
12 KiB
HTML
196 lines
12 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 `src/api/v1/pow/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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="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"><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/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 width="18" height="18" alt="Pick another theme!" src="../../../../../brush.svg"></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 width="18" height="18" alt="Change settings" src="../../../../../wheel.svg"></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>
|
||
</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="kw">use</span> <span class="ident">actix_web::web</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">get_config</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">verify_pow</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">verify_token</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">super</span>::mcaptcha::get::I32Levels</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">&</span><span class="kw-2">mut</span> <span class="ident">web::ServiceConfig</span>) {
|
||
<span class="kw">let</span> <span class="ident">cors</span> <span class="op">=</span> <span class="ident">actix_cors::Cors::default</span>()
|
||
.<span class="ident">allow_any_origin</span>()
|
||
.<span class="ident">allowed_methods</span>(<span class="macro">vec!</span>[<span class="string">"POST"</span>, <span class="string">"GET"</span>])
|
||
.<span class="ident">allow_any_header</span>()
|
||
.<span class="ident">max_age</span>(<span class="number">3600</span>)
|
||
.<span class="ident">send_wildcard</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">routes</span> <span class="op">=</span> <span class="ident"><span class="kw">crate</span>::V1_API_ROUTES</span>.<span class="ident">pow</span>;
|
||
<span class="ident">cfg</span>.<span class="ident">service</span>(
|
||
<span class="ident">web::scope</span>(<span class="ident">routes</span>.<span class="ident">scope</span>)
|
||
.<span class="ident">wrap</span>(<span class="ident">cors</span>)
|
||
.<span class="ident">service</span>(<span class="ident">verify_pow::verify_pow</span>)
|
||
.<span class="ident">service</span>(<span class="ident">get_config::get_config</span>)
|
||
.<span class="ident">service</span>(<span class="ident">verify_token::validate_captcha_token</span>),
|
||
);
|
||
}
|
||
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">routes</span> {
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PoW</span> {
|
||
<span class="kw">pub</span> <span class="ident">get_config</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
|
||
<span class="kw">pub</span> <span class="ident">verify_pow</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
|
||
<span class="kw">pub</span> <span class="ident">validate_captcha_token</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
|
||
<span class="kw">pub</span> <span class="ident">scope</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
|
||
}
|
||
|
||
<span class="macro">macro_rules!</span> <span class="ident">rm_scope</span> {
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>) => {
|
||
<span class="doccomment">/// remove scope for $name route</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||
<span class="self">self</span>.<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>
|
||
<span class="comment">//.strip_prefix(&self.scope[..self.scope.len() - 1])</span>
|
||
.<span class="ident">strip_prefix</span>(<span class="self">self</span>.<span class="ident">scope</span>)
|
||
.<span class="ident">unwrap</span>()
|
||
}
|
||
};
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">PoW</span> {
|
||
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="self">Self</span> {
|
||
<span class="comment">// date: 2021-11-29 16:31</span>
|
||
<span class="comment">// commit: 6eb75d7</span>
|
||
<span class="comment">// route 404s when scope contained trailing slash</span>
|
||
<span class="comment">//let scope = "/api/v1/pow/";</span>
|
||
<span class="kw">let</span> <span class="ident">scope</span> <span class="op">=</span> <span class="string">"/api/v1/pow"</span>;
|
||
<span class="ident">PoW</span> {
|
||
<span class="ident">get_config</span>: <span class="string">"/api/v1/pow/config"</span>,
|
||
<span class="ident">verify_pow</span>: <span class="string">"/api/v1/pow/verify"</span>,
|
||
<span class="ident">validate_captcha_token</span>: <span class="string">"/api/v1/pow/siteverify"</span>,
|
||
<span class="ident">scope</span>,
|
||
}
|
||
}
|
||
|
||
<span class="macro">rm_scope!</span>(<span class="ident">get_config</span>);
|
||
<span class="macro">rm_scope!</span>(<span class="ident">verify_pow</span>);
|
||
<span class="macro">rm_scope!</span>(<span class="ident">validate_captcha_token</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="ident"><span class="kw">super</span>::routes::PoW</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||
<span class="kw">fn</span> <span class="ident">scope_pow_works</span>() {
|
||
<span class="kw">let</span> <span class="ident">pow</span> <span class="op">=</span> <span class="ident">PoW::new</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">pow</span>.<span class="ident">get_config</span>(), <span class="string">"/config"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">pow</span>.<span class="ident">verify_pow</span>(), <span class="string">"/verify"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">pow</span>.<span class="ident">validate_captcha_token</span>(), <span class="string">"/siteverify"</span>);
|
||
}
|
||
}
|
||
</code></pre></div>
|
||
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="mcaptcha" 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> |