mirror of
https://github.com/mCaptcha/mCaptcha.git
synced 2025-06-22 14:12:32 +00:00
53 lines
8.7 KiB
HTML
53 lines
8.7 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="mCaptcha is a proof of work based Denaial-of-Service attack protection system. This is is a WASM library that you can embed in your frontend code to protect your service."><meta name="keywords" content="rust, rustlang, rust-lang, mcaptcha_browser"><title>mcaptcha_browser - Rust</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 mod crate"><!--[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><h2 class="location">Crate mcaptcha_browser</h2><div class="block version"><p>Version 0.1.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all mcaptcha_browser's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="mcaptcha_browser" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></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"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">mcaptcha_browser</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/mcaptcha_browser/lib.rs.html#11-151" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>mCaptcha is a proof of work based Denaial-of-Service attack protection system.
|
||
This is is a WASM library that you can embed in your frontend code to protect your
|
||
service.</p>
|
||
<p>A commercial managed solution is in the works but I’d much rather prefer
|
||
folks host their own instances as it will make the more decentralized and free.</p>
|
||
<h2 id="workflow" class="section-header"><a href="#workflow">Workflow:</a></h2>
|
||
<p>mCaptcha workflow in the frontend is simple.</p>
|
||
<ol>
|
||
<li>Call service to get a proof of work(PoW) configuration</li>
|
||
<li>Call into mCaptcha to get PoW</li>
|
||
<li>Send PoW to mCaptcha service</li>
|
||
<li>If proof is valid, the service will return a token to the client</li>
|
||
<li>Submit token to your backend along with your app data(if any)</li>
|
||
<li>In backend, validate client’s token with mCaptcha service</li>
|
||
</ol>
|
||
<h2 id="example" class="section-header"><a href="#example">Example:</a></h2>
|
||
<p>generate proof-of-work</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">mcaptcha_browser</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">use</span> <span class="ident">pow_sha256</span>::<span class="kw-2">*</span>;
|
||
|
||
|
||
<span class="comment">// salt using which PoW should be computed</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="comment">// one-time phrase over which PoW should be computed</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="comment">// and the difficulty factor</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="comment">// currently gen_pow() returns a JSON formated string to better communicate</span>
|
||
<span class="comment">// with JavaScript. See [PoW<T>][pow_sha256::PoW] for schema</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>
|
||
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.Work.html" title="mcaptcha_browser::Work struct">Work</a></td><td class="docblock-short"></td></tr></table><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
|
||
<table><tr class="module-item"><td><a class="fn" href="fn.__wasm_bindgen_generated_gen_pow.html" title="mcaptcha_browser::__wasm_bindgen_generated_gen_pow fn">__wasm_bindgen_generated_gen_pow</a></td><td class="docblock-short"><p>generate proof-of-work</p>
|
||
</td></tr><tr class="module-item"><td><a class="fn" href="fn.gen_pow.html" title="mcaptcha_browser::gen_pow fn">gen_pow</a></td><td class="docblock-short"><p>generate proof-of-work</p>
|
||
</td></tr></table></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></body></html> |