pub extern "C" fn __wasm_bindgen_generated_gen_pow(
arg0: <u32 as FromWasmAbi>::Abi,
arg1: <String as FromWasmAbi>::Abi
) -> <String as ReturnWasmAbi>::Abi
pub fn gen_pow(difficulty_factor: u32, secret: String) -> String
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.
+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.
+mCaptcha workflow in the frontend is simple.
+| __wasm_bindgen_generated_gen_pow | |
| gen_pow |
| "+""+(item.is_alias===true?(""+item.alias+" - see "):"")+item.displayPath+""+name+" | "+""+""+item.desc+" |
"+code.outerHTML+" |
fn:) to \
+ restrict the search to a given item kind.","Accepted kinds are: fn, mod, struct, \
+ enum, trait, type, macro, \
+ and const.","Search functions by type signature (e.g., vec -> usize or \
+ * -> vec)","Search multiple things at once by splitting your query with comma (e.g., \
+ str,u8 or String,struct:Vec,test)","You can look for items with an exact name by putting double quotes around \
+ your request: \"string\"","Look for items inside another one by searching for a path: vec::Vec",].map(x=>""+x+"
").join("");var div_infos=document.createElement("div");addClass(div_infos,"infos");div_infos.innerHTML="1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +
+//! 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. +//! +//! 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. +//! +//! ## Workflow: +//! mCaptcha workflow in the frontend is simple. +//! 1. Call service to get a proof of work(PoW) configuration +//! 2. Call into mCaptcha to get PoW +//! 3. Send PoW to your service + +use wasm_bindgen::prelude::*; + +// When the `wee_alloc` feature is enabled, use `wee_alloc` as the global +// allocator. +#[cfg(feature = "wee_alloc")] +#[global_allocator] +static ALLOC: wee_alloc::WeeAlloc = wee_alloc::WeeAlloc::INIT; + +use pow_sha256::PoW; + +#[wasm_bindgen] +pub fn gen_pow(difficulty_factor: u32, secret: String) -> String { + let difficulty = u128::max_value() - u128::max_value() / difficulty_factor as u128; + let a = PoW::prove_work(&secret.as_bytes().to_vec(), difficulty).unwrap(); + let payload = serde_json::to_string(&a).unwrap(); + payload +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn it_works() { + let payload = gen_pow(500, "MFsqLMZId629Dh2hrtux2Qdn3gBzCaSt".into()); + assert_eq!("{\"nonce\":312,\"result\":\"340175381422106372296624206295814425082\",\"_spook\":null}", &payload ); + + let payload = gen_pow(1_000, "MFsqLMZId629Dh2hrtux2Qdn3gBzCaSt".into()); + assert_eq!("{\"nonce\":312,\"result\":\"340175381422106372296624206295814425082\",\"_spook\":null}", &payload); + + let payload = gen_pow(2_000, "MFsqLMZId629Dh2hrtux2Qdn3gBzCaSt".into()); + assert_eq!(&payload, "{\"nonce\":312,\"result\":\"340175381422106372296624206295814425082\",\"_spook\":null}"); + + let payload = gen_pow(100_000, "MFsqLMZId629Dh2hrtux2Qdn3gBzCaSt".into()); + assert_eq!(&payload, "{\"nonce\":59930,\"result\":\"340281433562218714678373578791487113813\",\"_spook\":null}"); + + let payload = gen_pow(1_000_000, "MFsqLMZId629Dh2hrtux2Qdn3gBzCaSt".into()); + + assert_eq!(&payload,"{\"nonce\":1902451,\"result\":\"340282308726676882310449308394036800665\",\"_spook\":null}"); + } +} +
In-memory cache implementation that uses HashMap
+| HashCache | cache datastructure implementing Save + |
cache datastructure implementing Save
+impl Actor for HashCache[src]type Context = Context<Self>Actor execution context type
+pub fn started(&mut self, ctx: &mut Self::Context)pub fn stopping(&mut self, ctx: &mut Self::Context) -> Runningpub fn stopped(&mut self, ctx: &mut Self::Context)pub fn start(self) -> Addr<Self> where
Self: Actor<Context = Context<Self>>, pub fn start_default() -> Addr<Self> where
Self: Actor<Context = Context<Self>> + Default, pub fn start_in_arbiter<F>(arb: &Arbiter, f: F) -> Addr<Self> where
Self: Actor<Context = Context<Self>>,
F: FnOnce(&mut Context<Self>) -> Self + Send + 'static, pub fn create<F>(f: F) -> Addr<Self> where
Self: Actor<Context = Context<Self>>,
F: FnOnce(&mut Context<Self>) -> Self, impl Clone for HashCache[src]impl Default for HashCache[src]impl Handler<Cache> for HashCache[src]cache a PoWConfig
+type Result = MessageResult<Cache>The type of value that this handler will return. Read more
+fn handle(&mut self, msg: Cache, ctx: &mut Self::Context) -> Self::Result[src]impl Handler<DeleteString> for HashCache[src]Delte a PoWConfig
+type Result = MessageResult<DeleteString>The type of value that this handler will return. Read more
+fn handle(
&mut self,
msg: DeleteString,
_ctx: &mut Self::Context
) -> Self::Result[src]impl Handler<Retrive> for HashCache[src]Retrive PoW difficulty_factor for a PoW string
+type Result = MessageResult<Retrive>The type of value that this handler will return. Read more
+fn handle(&mut self, msg: Retrive, _ctx: &mut Self::Context) -> Self::Result[src]impl Save for HashCache[src]impl RefUnwindSafe for HashCache[src]impl Send for HashCache[src]impl Sync for HashCache[src]impl Unpin for HashCache[src]impl UnwindSafe for HashCache[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> Vmessage datatypes to interact with MCaptcha actor +Cache is used to save proofof work details and nonces to prevent replay attacks +and rainbow/dictionary attacks
+pub use hashcache::HashCache; |
| hashcache | In-memory cache implementation that uses HashMap + |
| messages | Messages that can be sent to cache data structures implementing Save + |
| Save | Describes actor handler trait impls that are required by a cache implementation + |
Messages that can be sent to cache data structures implementing Save
+| Cache | Message to cache PoW difficulty factor and string + |
| CacheBuilder | Builder for |
| DeleteString | Message to delete cached PoW difficulty factor and string +when they expire + |
| Retrive | Message to retrive the the difficulty factor for the specified +string from the cache + |
Message to cache PoW difficulty factor and string
+string: Stringdifficulty_factor: u32duration: u64impl Cache[src]pub fn new(p: &PoWConfig, v: &VisitorResult) -> Self[src]impl Handler<Cache> for HashCache[src]cache a PoWConfig
+type Result = MessageResult<Cache>The type of value that this handler will return. Read more
+fn handle(&mut self, msg: Cache, ctx: &mut Self::Context) -> Self::Result[src]impl Message for Cache[src]type Result = CaptchaResult<()>The type of value that this message will resolved with if it is +successful. Read more
+impl RefUnwindSafe for Cache[src]impl Send for Cache[src]impl Sync for Cache[src]impl Unpin for Cache[src]impl UnwindSafe for Cache[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VBuilder for Cache.
impl CacheBuilder[src]pub fn string(&mut self, value: String) -> &mut Self[src]pub fn difficulty_factor(&mut self, value: u32) -> &mut Self[src]pub fn duration(&mut self, value: u64) -> &mut Self[src]pub fn build(&self) -> Result<Cache, String>[src]impl Clone for CacheBuilder[src]fn clone(&self) -> CacheBuilder[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Default for CacheBuilder[src]fn default() -> CacheBuilder[src]impl RefUnwindSafe for CacheBuilder[src]impl Send for CacheBuilder[src]impl Sync for CacheBuilder[src]impl Unpin for CacheBuilder[src]impl UnwindSafe for CacheBuilder[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VMessage to delete cached PoW difficulty factor and string +when they expire
+impl Handler<DeleteString> for HashCache[src]Delte a PoWConfig
+type Result = MessageResult<DeleteString>The type of value that this handler will return. Read more
+fn handle(
&mut self,
msg: DeleteString,
_ctx: &mut Self::Context
) -> Self::Result[src]impl Message for DeleteString[src]type Result = CaptchaResult<()>The type of value that this message will resolved with if it is +successful. Read more
+impl RefUnwindSafe for DeleteString[src]impl Send for DeleteString[src]impl Sync for DeleteString[src]impl Unpin for DeleteString[src]impl UnwindSafe for DeleteString[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VMessage to retrive the the difficulty factor for the specified +string from the cache
+impl Handler<Retrive> for HashCache[src]Retrive PoW difficulty_factor for a PoW string
+type Result = MessageResult<Retrive>The type of value that this handler will return. Read more
+fn handle(&mut self, msg: Retrive, _ctx: &mut Self::Context) -> Self::Result[src]impl Message for Retrive[src]type Result = CaptchaResult<Option<u32>>The type of value that this message will resolved with if it is +successful. Read more
+impl RefUnwindSafe for Retrive[src]impl Send for Retrive[src]impl Sync for Retrive[src]impl Unpin for Retrive[src]impl UnwindSafe for Retrive[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VDescribes actor handler trait impls that are required by a cache implementation
+Defense datatypes
+ ++use m_captcha::{LevelBuilder, DefenseBuilder}; +DefenseBuilder::default() + .add_level( + LevelBuilder::default() + .visitor_threshold(50) + .difficulty_factor(50) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(500) + .difficulty_factor(500) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .build() + .unwrap();
| Defense | struct describes all the different Levels at which an mCaptcha system operates + |
| DefenseBuilder | Builder struct for Defense + |
| Level | Level struct that describes threshold-difficulty factor mapping + |
| LevelBuilder | Bulder struct for Level to describe threshold-difficulty factor mapping + |
struct describes all the different Levels at which an mCaptcha system operates
+impl Defense[src]pub fn get_difficulty(&self) -> u32[src]! Difficulty is calculated as:
+! rust ! let difficulty = u128::max_value() - u128::max_value() / difficulty_factor; !
+! The higher the difficulty_factor, the higher the difficulty.
+Get difficulty factor of current level of defense
pub fn tighten_up(&mut self)[src]tighten up defense. Increases defense level by a factor of one. +When defense is at max level, calling this method will have no effect
+pub fn loosen_up(&mut self)[src]Loosen up defense. Decreases defense level by a factor of one. +When defense is at the lowest level, calling this method will have no effect.
+pub fn max_defense(&mut self)[src]Set defense to maximum level
+pub fn min_defense(&mut self)[src]Set defense to minimum level
+pub fn visitor_threshold(&self) -> u32[src]Get current level's visitor threshold
+impl Clone for Defense[src]impl Debug for Defense[src]impl PartialEq<Defense> for Defense[src]impl StructuralPartialEq for Defense[src]impl RefUnwindSafe for Defense[src]impl Send for Defense[src]impl Sync for Defense[src]impl Unpin for Defense[src]impl UnwindSafe for Defense[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VBuilder struct for Defense
+impl DefenseBuilder[src]pub fn add_level(&mut self, level: Level) -> CaptchaResult<&mut Self>[src]add a level to Defense
+pub fn build(&mut self) -> CaptchaResult<Defense>[src]Build Defense
+impl Clone for DefenseBuilder[src]fn clone(&self) -> DefenseBuilder[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Debug for DefenseBuilder[src]impl Default for DefenseBuilder[src]impl PartialEq<DefenseBuilder> for DefenseBuilder[src]fn eq(&self, other: &DefenseBuilder) -> bool[src]fn ne(&self, other: &DefenseBuilder) -> bool[src]impl StructuralPartialEq for DefenseBuilder[src]impl RefUnwindSafe for DefenseBuilder[src]impl Send for DefenseBuilder[src]impl Sync for DefenseBuilder[src]impl Unpin for DefenseBuilder[src]impl UnwindSafe for DefenseBuilder[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VLevel struct that describes threshold-difficulty factor mapping
+impl Clone for Level[src]impl Copy for Level[src]impl Debug for Level[src]impl PartialEq<Level> for Level[src]impl StructuralPartialEq for Level[src]impl RefUnwindSafe for Level[src]impl Send for Level[src]impl Sync for Level[src]impl Unpin for Level[src]impl UnwindSafe for Level[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VBulder struct for Level to describe threshold-difficulty factor mapping
+impl LevelBuilder[src]pub fn visitor_threshold(&mut self, visitor_threshold: u32) -> &mut Self[src]set visitor count for level
+pub fn difficulty_factor(
&mut self,
difficulty_factor: u32
) -> CaptchaResult<&mut Self>[src]set difficulty factor for level. difficulty_factor can't be zero because +Difficulty is calculated as:
+ ++let difficulty_factor = 500; +let difficulty = u128::max_value() - u128::max_value() / difficulty_factor;
the higher the difficulty_factor, the higher the difficulty.
pub fn build(&mut self) -> CaptchaResult<Level>[src]build Level struct
+impl Clone for LevelBuilder[src]fn clone(&self) -> LevelBuilder[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Copy for LevelBuilder[src]impl Debug for LevelBuilder[src]impl Default for LevelBuilder[src]impl PartialEq<LevelBuilder> for LevelBuilder[src]fn eq(&self, other: &LevelBuilder) -> bool[src]fn ne(&self, other: &LevelBuilder) -> bool[src]impl StructuralPartialEq for LevelBuilder[src]impl RefUnwindSafe for LevelBuilder[src]impl Send for LevelBuilder[src]impl Sync for LevelBuilder[src]impl Unpin for LevelBuilder[src]impl UnwindSafe for LevelBuilder[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VError datatype
+When configuring m_captcha, DefenseBuilder
+must be passed atleast one LevelConfig if not this error will arise
Visitor count must be a whole number(zero and above). +When configuring m_captcha, LevelBuilder. +difficulty_factor must be set to greater than zero.
+Difficulty factor must be set
+Visitor threshold must be set
+Visitor count must be Unique
+Difficulty factor should increase with level
+Difficulty factor should increase with level
+Happens when submitted work doesn't satisfy the required +difficulty factor
+Happens when submitted work is computed over string that +isn't in cache
+impl Clone for CaptchaError[src]fn clone(&self) -> CaptchaError[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Debug for CaptchaError[src]impl Display for CaptchaError[src]impl Error for CaptchaError[src]pub fn source(&self) -> Option<&(dyn Error + 'static)>1.30.0[src]pub fn backtrace(&self) -> Option<&Backtrace>[src]pub fn description(&self) -> &str1.0.0[src]pub fn cause(&self) -> Option<&dyn Error>1.0.0[src]impl PartialEq<CaptchaError> for CaptchaError[src]fn eq(&self, other: &CaptchaError) -> bool[src]#[must_use]pub fn ne(&self, other: &Rhs) -> bool1.0.0[src]impl StructuralPartialEq for CaptchaError[src]impl RefUnwindSafe for CaptchaError[src]impl Send for CaptchaError[src]impl Sync for CaptchaError[src]impl Unpin for CaptchaError[src]impl UnwindSafe for CaptchaError[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T> ToString for T where
T: Display + ?Sized, [src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VErrors and Result module
+| CaptchaError | Error datatype + |
| CaptchaResult | Result datatype for m_captcha + |
type CaptchaResult<V> = Result<V, CaptchaError>;
Result datatype for m_captcha
+mCaptcha is a proof of work based Denaial-of-Service attack protection system. +This is is a server library that you can embed in your services to protect your +servers.
+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.
+In mCaptcha, defense is adjusted in discrete levels that depend on the +ammount of traffic that a service is experiencing. So users of this library are +requested to benchmark their target machines before configuring their mCaptcha +component.
++use m_captcha::{ + cache::HashCache, + master::{AddSiteBuilder, Master}, + pow::{ConfigBuilder, Work}, + system::SystemBuilder, + DefenseBuilder, LevelBuilder, MCaptchaBuilder, +}; +// traits from actix needs to be in scope for starting actor +use actix::prelude::*; + +#[actix_rt::main] +async fn main() -> std::io::Result<()> { + // start cahce actor + // cache is used to store PoW requirements that are sent to clients + // This way, it can be verified that the client computed work over a config + // that _we_ sent. Offers protection against rainbow tables powered dictionary attacks + let cache = HashCache::default().start(); + + // create PoW config with unique salt. Salt has to be safely guarded. + // salts protect us from replay attacks + let pow = ConfigBuilder::default() + .salt("myrandomsaltisnotlongenoug".into()) + .build() + .unwrap(); + + // start master actor. Master actor is responsible for managing MCaptcha actors + // each mCaptcha system should have only one master + let master = Master::new().start(); + + // Create system. System encapsulates master and cache and provides useful abstraction + // each mCaptcha system should have only one system + let system = SystemBuilder::default() + .master(master) + .cache(cache) + .pow(pow.clone()) + .build() + .unwrap(); + + // configure defense. This is a per site configuration. A site can have several levels + // of defenses configured + let defense = DefenseBuilder::default() + // add as many defense as you see fit + .add_level( + LevelBuilder::default() + // visitor_threshold is the threshold/limit at which + // mCaptcha will adjust difficulty defense + // it is advisable to set small values for the first + // defense visitor_threshold and difficulty_factor + // as this will be the work that clients will be + // computing when there's no load + .visitor_threshold(50) + .difficulty_factor(500) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(5000) + .difficulty_factor(50000) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .build() + .unwrap(); + + // create and start MCaptcha actor that uses the above defense configuration + // This is what manages the difficulty factor of sites that an mCaptcha protects + let mcaptcha = MCaptchaBuilder::default() + .defense(defense) + // leaky bucket algorithm's emission interval + .duration(30) + // .cache(cache) + .build() + .unwrap() + .start(); + + // unique value identifying an MCaptcha actor + let mcaptcha_name = "batsense.net"; + + // add MCaptcha to Master + let msg = AddSiteBuilder::default() + .id(mcaptcha_name.into()) + .addr(mcaptcha.clone()) + .build() + .unwrap(); + system.master.send(msg).await.unwrap(); + + // Get PoW config. Should be called everytime there's a visitor for a + // managed site(here mcaptcha_name) + let work_req = system.get_pow(mcaptcha_name.into()).await.unwrap(); + + // the following computation should be done on the client but for the purpose + // of this illustration, we are going to do it on the server it self + let work = pow + .prove_work(&work_req.string, work_req.difficulty_factor) + .unwrap(); + + // the payload that the client sends to the server + let payload = Work { + string: work_req.string, + result: work.result, + nonce: work.nonce, + }; + + // Server evaluates client's work. Returns true if everything + // checksout and Err() if something fishy is happening + let res = system.verify_pow(payload.clone()).await.unwrap(); + assert!(res); + + Ok(()) +}
pub use crate::cache::hashcache::HashCache; |
pub use defense::Defense; |
pub use defense::DefenseBuilder; |
pub use defense::LevelBuilder; |
pub use mcaptcha::MCaptcha; |
pub use mcaptcha::MCaptchaBuilder; |
| cache | message datatypes to interact with MCaptcha actor +Cache is used to save proofof work details and nonces to prevent replay attacks +and rainbow/dictionary attacks + |
| defense | Defense datatypes + |
| errors | Errors and Result module + |
| master | + |
| mcaptcha | MCaptcha actor module that manages defense levels + |
| pow | PoW datatypes used in client-server interaction + |
| system | module describing mCaptcha system + |
| AddSite | + |
| AddSiteBuilder | Builder for |
| GetSite | Message to get an MCaptcha actor from master + |
| Master | This Actor manages the MCaptcha actors. +A service can have several MCaptcha actors with +varying Defense configurations +so a "master" actor is needed to manage them all + |
id: Stringaddr: Addr<MCaptcha>impl Handler<AddSite> for Master[src]type Result = ()The type of value that this handler will return. Read more
+fn handle(&mut self, m: AddSite, _ctx: &mut Self::Context) -> Self::Result[src]impl Message for AddSite[src]impl !RefUnwindSafe for AddSite[src]impl Send for AddSite[src]impl Sync for AddSite[src]impl Unpin for AddSite[src]impl !UnwindSafe for AddSite[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VBuilder for AddSite.
impl AddSiteBuilder[src]pub fn id(&mut self, value: String) -> &mut Self[src]pub fn addr(&mut self, value: Addr<MCaptcha>) -> &mut Self[src]pub fn build(&self) -> Result<AddSite, String>[src]impl Clone for AddSiteBuilder[src]fn clone(&self) -> AddSiteBuilder[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Default for AddSiteBuilder[src]fn default() -> AddSiteBuilder[src]impl !RefUnwindSafe for AddSiteBuilder[src]impl Send for AddSiteBuilder[src]impl Sync for AddSiteBuilder[src]impl Unpin for AddSiteBuilder[src]impl !UnwindSafe for AddSiteBuilder[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VMessage to get an MCaptcha actor from master
+impl Handler<GetSite> for Master[src]type Result = MessageResult<GetSite>The type of value that this handler will return. Read more
+fn handle(&mut self, m: GetSite, _ctx: &mut Self::Context) -> Self::Result[src]impl Message for GetSite[src]impl RefUnwindSafe for GetSite[src]impl Send for GetSite[src]impl Sync for GetSite[src]impl Unpin for GetSite[src]impl UnwindSafe for GetSite[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VThis Actor manages the MCaptcha actors. +A service can have several MCaptcha actors with +varying Defense configurations +so a "master" actor is needed to manage them all
+impl Master[src]pub fn add_site(&mut self, details: AddSite)[src]pub fn new() -> Self[src]create new master
+pub fn get_site<'a, 'b>(&'a self, id: &'b str) -> Option<&'a Addr<MCaptcha>>[src]impl Actor for Master[src]type Context = Context<Self>Actor execution context type
+pub fn started(&mut self, ctx: &mut Self::Context)pub fn stopping(&mut self, ctx: &mut Self::Context) -> Runningpub fn stopped(&mut self, ctx: &mut Self::Context)pub fn start(self) -> Addr<Self> where
Self: Actor<Context = Context<Self>>, pub fn start_default() -> Addr<Self> where
Self: Actor<Context = Context<Self>> + Default, pub fn start_in_arbiter<F>(arb: &Arbiter, f: F) -> Addr<Self> where
Self: Actor<Context = Context<Self>>,
F: FnOnce(&mut Context<Self>) -> Self + Send + 'static, pub fn create<F>(f: F) -> Addr<Self> where
Self: Actor<Context = Context<Self>>,
F: FnOnce(&mut Context<Self>) -> Self, impl Clone for Master[src]impl Handler<AddSite> for Master[src]type Result = ()The type of value that this handler will return. Read more
+fn handle(&mut self, m: AddSite, _ctx: &mut Self::Context) -> Self::Result[src]impl Handler<GetSite> for Master[src]impl !RefUnwindSafe for Master[src]impl Send for Master[src]impl Sync for Master[src]impl Unpin for Master[src]impl !UnwindSafe for Master[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VMCaptcha actor module that manages defense levels
++use m_captcha::{mcaptcha::Visitor, MCaptchaBuilder, cache::HashCache, LevelBuilder, DefenseBuilder}; +// traits from actix needs to be in scope for starting actor +use actix::prelude::*; + +#[actix_rt::main] +async fn main() -> std::io::Result<()> { + // configure defense + let defense = DefenseBuilder::default() + // add as many levels as you see fit + .add_level( + LevelBuilder::default() + // visitor_threshold is the threshold/limit at which + // mCaptcha will adjust difficulty levels + // it is advisable to set small values for the first + // levels visitor_threshold and difficulty_factor + // as this will be the work that clients will be + // computing when there's no load + .visitor_threshold(50) + .difficulty_factor(500) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(5000) + .difficulty_factor(50000) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .build() + .unwrap(); + + // create and start MCaptcha actor + //let cache = HashCache::default().start(); + let mcaptcha = MCaptchaBuilder::default() + .defense(defense) + // leaky bucket algorithm's emission interval + .duration(30) + .build() + .unwrap() + .start(); + + // increment count when user visits protected routes + mcaptcha.send(Visitor).await.unwrap(); + + Ok(()) +}
| MCaptcha | This struct represents the mCaptcha state and is used +to configure leaky-bucket lifetime and manage defense + |
| MCaptchaBuilder | Builder for |
| Visitor | Message to increment the visitor count +returns difficulty factor and lifetime + |
| VisitorResult | Struct representing the return datatime of +Visitor message. Contains MCaptcha lifetime +and difficulty factor + |
This struct represents the mCaptcha state and is used +to configure leaky-bucket lifetime and manage defense
+impl MCaptcha[src]pub fn add_visitor(&mut self)[src]incerment visiotr count by one
+pub fn decrement_visiotr(&mut self)[src]deccerment visiotr count by one
+pub fn get_difficulty(&self) -> u32[src]get current difficulty factor
+pub fn get_duration(&self) -> u64[src]get MCaptcha's lifetime
+impl Actor for MCaptcha[src]type Context = Context<Self>Actor execution context type
+pub fn started(&mut self, ctx: &mut Self::Context)pub fn stopping(&mut self, ctx: &mut Self::Context) -> Runningpub fn stopped(&mut self, ctx: &mut Self::Context)pub fn start(self) -> Addr<Self> where
Self: Actor<Context = Context<Self>>, pub fn start_default() -> Addr<Self> where
Self: Actor<Context = Context<Self>> + Default, pub fn start_in_arbiter<F>(arb: &Arbiter, f: F) -> Addr<Self> where
Self: Actor<Context = Context<Self>>,
F: FnOnce(&mut Context<Self>) -> Self + Send + 'static, pub fn create<F>(f: F) -> Addr<Self> where
Self: Actor<Context = Context<Self>>,
F: FnOnce(&mut Context<Self>) -> Self, impl Clone for MCaptcha[src]impl Debug for MCaptcha[src]impl Handler<Visitor> for MCaptcha[src]impl RefUnwindSafe for MCaptcha[src]impl Send for MCaptcha[src]impl Sync for MCaptcha[src]impl Unpin for MCaptcha[src]impl UnwindSafe for MCaptcha[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VBuilder for MCaptcha.
impl MCaptchaBuilder[src]pub fn defense(&mut self, value: Defense) -> &mut Self[src]pub fn duration(&mut self, value: u64) -> &mut Self[src]pub fn build(&self) -> Result<MCaptcha, String>[src]impl Clone for MCaptchaBuilder[src]fn clone(&self) -> MCaptchaBuilder[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Default for MCaptchaBuilder[src]fn default() -> MCaptchaBuilder[src]impl RefUnwindSafe for MCaptchaBuilder[src]impl Send for MCaptchaBuilder[src]impl Sync for MCaptchaBuilder[src]impl Unpin for MCaptchaBuilder[src]impl UnwindSafe for MCaptchaBuilder[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VMessage to increment the visitor count +returns difficulty factor and lifetime
+impl Handler<Visitor> for MCaptcha[src]type Result = MessageResult<Visitor>The type of value that this handler will return. Read more
+fn handle(&mut self, _: Visitor, ctx: &mut Self::Context) -> Self::Result[src]impl Message for Visitor[src]type Result = VisitorResultThe type of value that this message will resolved with if it is +successful. Read more
+impl RefUnwindSafe for Visitor[src]impl Send for Visitor[src]impl Sync for Visitor[src]impl Unpin for Visitor[src]impl UnwindSafe for Visitor[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VStruct representing the return datatime of +Visitor message. Contains MCaptcha lifetime +and difficulty factor
+duration: u64difficulty_factor: u32impl RefUnwindSafe for VisitorResult[src]impl Send for VisitorResult[src]impl Sync for VisitorResult[src]impl Unpin for VisitorResult[src]impl UnwindSafe for VisitorResult[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VPoW datatypes used in client-server interaction
+| ConfigBuilder | Builder for |
| PoWConfig | PoW requirement datatype that is be sent to clients for generating PoW + |
| Work | PoW datatype that clients send to server + |
Builder for Config.
impl ConfigBuilderpub fn salt(&mut self, value: String) -> &mut ConfigBuilderpub fn build(&self) -> Result<Config, String>impl Clone for ConfigBuilderpub fn clone(&self) -> ConfigBuilderpub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Default for ConfigBuilderpub fn default() -> ConfigBuilderimpl RefUnwindSafe for ConfigBuilder[src]impl Send for ConfigBuilder[src]impl Sync for ConfigBuilder[src]impl Unpin for ConfigBuilder[src]impl UnwindSafe for ConfigBuilder[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VPoW requirement datatype that is be sent to clients for generating PoW
+string: Stringdifficulty_factor: u32impl PoWConfig[src]impl RefUnwindSafe for PoWConfig[src]impl Send for PoWConfig[src]impl Sync for PoWConfig[src]impl Unpin for PoWConfig[src]impl UnwindSafe for PoWConfig[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VPoW datatype that clients send to server
+string: Stringresult: Stringnonce: u64impl Clone for Work[src]impl Debug for Work[src]impl From<Work> for PoW<String>[src]impl Serialize for Work[src]impl RefUnwindSafe for Work[src]impl Send for Work[src]impl Sync for Work[src]impl Unpin for Work[src]impl UnwindSafe for Work[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> Vmodule describing mCaptcha system
+| System | struct describing various bits of data required for an mCaptcha system + |
| SystemBuilder | Builder for |
struct describing various bits of data required for an mCaptcha system
+master: Addr<Master>impl<T> System<T> where
T: Save,
<T as Actor>::Context: ToEnvelope<T, Cache> + ToEnvelope<T, Retrive>, [src]pub async fn get_pow(&self, id: String) -> Option<PoWConfig>[src]utility function to get difficulty factor of site id and cache it
pub async fn verify_pow(&self, work: Work) -> CaptchaResult<bool>[src]utility function to verify Work
+impl<T> !RefUnwindSafe for System<T>[src]impl<T> Send for System<T>[src]impl<T> Sync for System<T>[src]impl<T> Unpin for System<T>[src]impl<T> !UnwindSafe for System<T>[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> VBuilder for System.
impl<T: Save + Clone> SystemBuilder<T>[src]pub fn master(&mut self, value: Addr<Master>) -> &mut Self[src]pub fn cache(&mut self, value: Addr<T>) -> &mut Self[src]pub fn pow(&mut self, value: Config) -> &mut Self[src]pub fn build(&self) -> Result<System<T>, String>[src]impl<T: Clone + Save> Clone for SystemBuilder<T>[src]fn clone(&self) -> SystemBuilder<T>[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl<T: Default + Save> Default for SystemBuilder<T>[src]fn default() -> SystemBuilder<T>[src]impl<T> !RefUnwindSafe for SystemBuilder<T>[src]impl<T> Send for SystemBuilder<T>[src]impl<T> Sync for SystemBuilder<T>[src]impl<T> Unpin for SystemBuilder<T>[src]impl<T> !UnwindSafe for SystemBuilder<T>[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>, pub fn vzip(self) -> V| "+""+(item.is_alias===true?(""+item.alias+" - see "):"")+item.displayPath+""+name+" | "+""+""+item.desc+" |
"+code.outerHTML+" |
fn:) to \
+ restrict the search to a given item kind.","Accepted kinds are: fn, mod, struct, \
+ enum, trait, type, macro, \
+ and const.","Search functions by type signature (e.g., vec -> usize or \
+ * -> vec)","Search multiple things at once by splitting your query with comma (e.g., \
+ str,u8 or String,struct:Vec,test)","You can look for items with an exact name by putting double quotes around \
+ your request: \"string\"","Look for items inside another one by searching for a path: vec::Vec",].map(x=>""+x+"
").join("");var div_infos=document.createElement("div");addClass(div_infos,"infos");div_infos.innerHTML="AddSite.",null,null],[11,"id","","",7,[[["string",3]]]],[11,"addr","","",7,[[["addr",3],["mcaptcha",3]]]],[11,"build","","Builds a new AddSite.",7,[[],[["result",4],["string",3],["addsite",3]]]],[0,"mcaptcha","m_captcha","MCaptcha actor module that manages defense levels",null,null],[3,"MCaptcha","m_captcha::mcaptcha","This struct represents the mCaptcha state and is used to …",null,null],[3,"MCaptchaBuilder","","Builder for MCaptcha.",null,null],[11,"defense","","",8,[[["defense",3]]]],[11,"duration","","",8,[[]]],[11,"build","","Builds a new MCaptcha.",8,[[],[["string",3],["result",4],["mcaptcha",3]]]],[11,"add_visitor","","incerment visiotr count by one",9,[[]]],[11,"decrement_visiotr","","deccerment visiotr count by one",9,[[]]],[11,"get_difficulty","","get current difficulty factor",9,[[]]],[11,"get_duration","","get [MCaptcha]\'s lifetime",9,[[]]],[3,"Visitor","","Message to increment the visitor count returns difficulty …",null,null],[3,"VisitorResult","","Struct representing the return datatime of [Visitor] …",null,null],[12,"duration","","",10,null],[12,"difficulty_factor","","",10,null],[0,"cache","m_captcha","message datatypes to interact with [MCaptcha] actor Cache …",null,null],[0,"hashcache","m_captcha::cache","In-memory cache implementation that uses [HashMap]",null,null],[3,"HashCache","m_captcha::cache::hashcache","cache datastructure implementing [Save]",null,null],[0,"messages","m_captcha::cache","Messages that can be sent to cache data structures …",null,null],[3,"Cache","m_captcha::cache::messages","Message to cache PoW difficulty factor and string",null,null],[12,"string","","",11,null],[12,"difficulty_factor","","",11,null],[12,"duration","","",11,null],[3,"CacheBuilder","","Builder for Cache.",null,null],[11,"string","","",12,[[["string",3]]]],[11,"difficulty_factor","","",12,[[]]],[11,"duration","","",12,[[]]],[11,"build","","Builds a new Cache.",12,[[],[["result",4],["cache",3],["string",3]]]],[11,"new","","",11,[[["powconfig",3],["visitorresult",3]]]],[3,"Retrive","","Message to retrive the the difficulty factor for the …",null,null],[12,"0","","",13,null],[3,"DeleteString","","Message to delete cached PoW difficulty factor and string …",null,null],[12,"0","","",14,null],[8,"Save","m_captcha::cache","Describes actor handler trait impls that are required by …",null,null],[0,"pow","m_captcha","PoW datatypes used in client-server interaction",null,null],[3,"ConfigBuilder","m_captcha::pow","Builder for Config.",null,null],[3,"PoWConfig","","PoW requirement datatype that is be sent to clients for …",null,null],[12,"string","","",15,null],[12,"difficulty_factor","","",15,null],[11,"new","","create new instance of [PoWConfig]",15,[[]]],[3,"Work","","PoW datatype that clients send to server",null,null],[12,"string","","",16,null],[12,"result","","",16,null],[12,"nonce","","",16,null],[0,"system","m_captcha","module describing mCaptcha system",null,null],[3,"System","m_captcha::system","struct describing various bits of data required for an …",null,null],[12,"master","","",17,null],[3,"SystemBuilder","","Builder for System.",null,null],[11,"master","","",18,[[["addr",3],["master",3]]]],[11,"cache","","",18,[[["addr",3]]]],[11,"pow","","",18,[[["config",3]]]],[11,"build","","Builds a new System.",18,[[],[["system",3],["string",3],["result",4]]]],[11,"get_pow","","utility function to get difficulty factor of site id and …",17,[[["string",3]]]],[11,"verify_pow","","utility function to verify [Work]",17,[[["work",3]]]],[11,"from","m_captcha::defense","",19,[[]]],[11,"into","","",19,[[]]],[11,"to_owned","","",19,[[]]],[11,"clone_into","","",19,[[]]],[11,"borrow","","",19,[[]]],[11,"borrow_mut","","",19,[[]]],[11,"try_from","","",19,[[],["result",4]]],[11,"try_into","","",19,[[],["result",4]]],[11,"type_id","","",19,[[],["typeid",3]]],[11,"vzip","","",19,[[]]],[11,"from","","",0,[[]]],[11,"into","","",0,[[]]],[11,"to_owned","","",0,[[]]],[11,"clone_into","","",0,[[]]],[11,"borrow","","",0,[[]]],[11,"borrow_mut","","",0,[[]]],[11,"try_from","","",0,[[],["result",4]]],[11,"try_into","","",0,[[],["result",4]]],[11,"type_id","","",0,[[],["typeid",3]]],[11,"vzip","","",0,[[]]],[11,"from","","",2,[[]]],[11,"into","","",2,[[]]],[11,"to_owned","","",2,[[]]],[11,"clone_into","","",2,[[]]],[11,"borrow","","",2,[[]]],[11,"borrow_mut","","",2,[[]]],[11,"try_from","","",2,[[],["result",4]]],[11,"try_into","","",2,[[],["result",4]]],[11,"type_id","","",2,[[],["typeid",3]]],[11,"vzip","","",2,[[]]],[11,"from","","",1,[[]]],[11,"into","","",1,[[]]],[11,"to_owned","","",1,[[]]],[11,"clone_into","","",1,[[]]],[11,"borrow","","",1,[[]]],[11,"borrow_mut","","",1,[[]]],[11,"try_from","","",1,[[],["result",4]]],[11,"try_into","","",1,[[],["result",4]]],[11,"type_id","","",1,[[],["typeid",3]]],[11,"vzip","","",1,[[]]],[11,"from","m_captcha::errors","",3,[[]]],[11,"into","","",3,[[]]],[11,"to_owned","","",3,[[]]],[11,"clone_into","","",3,[[]]],[11,"to_string","","",3,[[],["string",3]]],[11,"borrow","","",3,[[]]],[11,"borrow_mut","","",3,[[]]],[11,"try_from","","",3,[[],["result",4]]],[11,"try_into","","",3,[[],["result",4]]],[11,"type_id","","",3,[[],["typeid",3]]],[11,"vzip","","",3,[[]]],[11,"from","m_captcha::master","",4,[[]]],[11,"into","","",4,[[]]],[11,"to_owned","","",4,[[]]],[11,"clone_into","","",4,[[]]],[11,"borrow","","",4,[[]]],[11,"borrow_mut","","",4,[[]]],[11,"try_from","","",4,[[],["result",4]]],[11,"try_into","","",4,[[],["result",4]]],[11,"type_id","","",4,[[],["typeid",3]]],[11,"vzip","","",4,[[]]],[11,"from","","",5,[[]]],[11,"into","","",5,[[]]],[11,"borrow","","",5,[[]]],[11,"borrow_mut","","",5,[[]]],[11,"try_from","","",5,[[],["result",4]]],[11,"try_into","","",5,[[],["result",4]]],[11,"type_id","","",5,[[],["typeid",3]]],[11,"vzip","","",5,[[]]],[11,"from","","",6,[[]]],[11,"into","","",6,[[]]],[11,"borrow","","",6,[[]]],[11,"borrow_mut","","",6,[[]]],[11,"try_from","","",6,[[],["result",4]]],[11,"try_into","","",6,[[],["result",4]]],[11,"type_id","","",6,[[],["typeid",3]]],[11,"vzip","","",6,[[]]],[11,"from","","",7,[[]]],[11,"into","","",7,[[]]],[11,"to_owned","","",7,[[]]],[11,"clone_into","","",7,[[]]],[11,"borrow","","",7,[[]]],[11,"borrow_mut","","",7,[[]]],[11,"try_from","","",7,[[],["result",4]]],[11,"try_into","","",7,[[],["result",4]]],[11,"type_id","","",7,[[],["typeid",3]]],[11,"vzip","","",7,[[]]],[11,"from","m_captcha::mcaptcha","",9,[[]]],[11,"into","","",9,[[]]],[11,"to_owned","","",9,[[]]],[11,"clone_into","","",9,[[]]],[11,"borrow","","",9,[[]]],[11,"borrow_mut","","",9,[[]]],[11,"try_from","","",9,[[],["result",4]]],[11,"try_into","","",9,[[],["result",4]]],[11,"type_id","","",9,[[],["typeid",3]]],[11,"vzip","","",9,[[]]],[11,"from","","",8,[[]]],[11,"into","","",8,[[]]],[11,"to_owned","","",8,[[]]],[11,"clone_into","","",8,[[]]],[11,"borrow","","",8,[[]]],[11,"borrow_mut","","",8,[[]]],[11,"try_from","","",8,[[],["result",4]]],[11,"try_into","","",8,[[],["result",4]]],[11,"type_id","","",8,[[],["typeid",3]]],[11,"vzip","","",8,[[]]],[11,"from","","",20,[[]]],[11,"into","","",20,[[]]],[11,"borrow","","",20,[[]]],[11,"borrow_mut","","",20,[[]]],[11,"try_from","","",20,[[],["result",4]]],[11,"try_into","","",20,[[],["result",4]]],[11,"type_id","","",20,[[],["typeid",3]]],[11,"vzip","","",20,[[]]],[11,"from","","",10,[[]]],[11,"into","","",10,[[]]],[11,"borrow","","",10,[[]]],[11,"borrow_mut","","",10,[[]]],[11,"try_from","","",10,[[],["result",4]]],[11,"try_into","","",10,[[],["result",4]]],[11,"type_id","","",10,[[],["typeid",3]]],[11,"vzip","","",10,[[]]],[11,"from","m_captcha::cache::hashcache","",21,[[]]],[11,"into","","",21,[[]]],[11,"to_owned","","",21,[[]]],[11,"clone_into","","",21,[[]]],[11,"borrow","","",21,[[]]],[11,"borrow_mut","","",21,[[]]],[11,"try_from","","",21,[[],["result",4]]],[11,"try_into","","",21,[[],["result",4]]],[11,"type_id","","",21,[[],["typeid",3]]],[11,"vzip","","",21,[[]]],[11,"from","m_captcha::cache::messages","",11,[[]]],[11,"into","","",11,[[]]],[11,"borrow","","",11,[[]]],[11,"borrow_mut","","",11,[[]]],[11,"try_from","","",11,[[],["result",4]]],[11,"try_into","","",11,[[],["result",4]]],[11,"type_id","","",11,[[],["typeid",3]]],[11,"vzip","","",11,[[]]],[11,"from","","",12,[[]]],[11,"into","","",12,[[]]],[11,"to_owned","","",12,[[]]],[11,"clone_into","","",12,[[]]],[11,"borrow","","",12,[[]]],[11,"borrow_mut","","",12,[[]]],[11,"try_from","","",12,[[],["result",4]]],[11,"try_into","","",12,[[],["result",4]]],[11,"type_id","","",12,[[],["typeid",3]]],[11,"vzip","","",12,[[]]],[11,"from","","",13,[[]]],[11,"into","","",13,[[]]],[11,"borrow","","",13,[[]]],[11,"borrow_mut","","",13,[[]]],[11,"try_from","","",13,[[],["result",4]]],[11,"try_into","","",13,[[],["result",4]]],[11,"type_id","","",13,[[],["typeid",3]]],[11,"vzip","","",13,[[]]],[11,"from","","",14,[[]]],[11,"into","","",14,[[]]],[11,"borrow","","",14,[[]]],[11,"borrow_mut","","",14,[[]]],[11,"try_from","","",14,[[],["result",4]]],[11,"try_into","","",14,[[],["result",4]]],[11,"type_id","","",14,[[],["typeid",3]]],[11,"vzip","","",14,[[]]],[11,"from","m_captcha::pow","",22,[[]]],[11,"into","","",22,[[]]],[11,"to_owned","","",22,[[]]],[11,"clone_into","","",22,[[]]],[11,"borrow","","",22,[[]]],[11,"borrow_mut","","",22,[[]]],[11,"try_from","","",22,[[],["result",4]]],[11,"try_into","","",22,[[],["result",4]]],[11,"type_id","","",22,[[],["typeid",3]]],[11,"vzip","","",22,[[]]],[11,"from","","",15,[[]]],[11,"into","","",15,[[]]],[11,"to_owned","","",15,[[]]],[11,"clone_into","","",15,[[]]],[11,"borrow","","",15,[[]]],[11,"borrow_mut","","",15,[[]]],[11,"try_from","","",15,[[],["result",4]]],[11,"try_into","","",15,[[],["result",4]]],[11,"type_id","","",15,[[],["typeid",3]]],[11,"vzip","","",15,[[]]],[11,"from","","",16,[[]]],[11,"into","","",16,[[]]],[11,"to_owned","","",16,[[]]],[11,"clone_into","","",16,[[]]],[11,"borrow","","",16,[[]]],[11,"borrow_mut","","",16,[[]]],[11,"try_from","","",16,[[],["result",4]]],[11,"try_into","","",16,[[],["result",4]]],[11,"type_id","","",16,[[],["typeid",3]]],[11,"vzip","","",16,[[]]],[11,"from","m_captcha::system","",17,[[]]],[11,"into","","",17,[[]]],[11,"to_owned","","",17,[[]]],[11,"clone_into","","",17,[[]]],[11,"borrow","","",17,[[]]],[11,"borrow_mut","","",17,[[]]],[11,"try_from","","",17,[[],["result",4]]],[11,"try_into","","",17,[[],["result",4]]],[11,"type_id","","",17,[[],["typeid",3]]],[11,"vzip","","",17,[[]]],[11,"from","","",18,[[]]],[11,"into","","",18,[[]]],[11,"to_owned","","",18,[[]]],[11,"clone_into","","",18,[[]]],[11,"borrow","","",18,[[]]],[11,"borrow_mut","","",18,[[]]],[11,"try_from","","",18,[[],["result",4]]],[11,"try_into","","",18,[[],["result",4]]],[11,"type_id","","",18,[[],["typeid",3]]],[11,"vzip","","",18,[[]]],[11,"default","m_captcha::pow","",22,[[],["configbuilder",3]]],[11,"clone","","",22,[[],["configbuilder",3]]],[11,"clone","m_captcha::defense","",19,[[],["level",3]]],[11,"clone","","",0,[[],["levelbuilder",3]]],[11,"clone","","",2,[[],["defense",3]]],[11,"clone","","",1,[[],["defensebuilder",3]]],[11,"clone","m_captcha::errors","",3,[[],["captchaerror",4]]],[11,"clone","m_captcha::master","",4,[[],["master",3]]],[11,"clone","","",7,[[],["addsitebuilder",3]]],[11,"clone","m_captcha::mcaptcha","",9,[[],["mcaptcha",3]]],[11,"clone","","",8,[[],["mcaptchabuilder",3]]],[11,"clone","m_captcha::cache::hashcache","",21,[[],["hashcache",3]]],[11,"clone","m_captcha::cache::messages","",12,[[],["cachebuilder",3]]],[11,"clone","m_captcha::pow","",15,[[],["powconfig",3]]],[11,"clone","","",16,[[],["work",3]]],[11,"clone","m_captcha::system","",17,[[],["system",3]]],[11,"clone","","",18,[[],["systembuilder",3]]],[11,"default","m_captcha::defense","",0,[[]]],[11,"default","","",1,[[]]],[11,"default","m_captcha::master","",7,[[],["addsitebuilder",3]]],[11,"default","m_captcha::mcaptcha","",8,[[],["mcaptchabuilder",3]]],[11,"default","m_captcha::cache::hashcache","",21,[[],["hashcache",3]]],[11,"default","m_captcha::cache::messages","",12,[[],["cachebuilder",3]]],[11,"default","m_captcha::system","",18,[[],["systembuilder",3]]],[11,"eq","m_captcha::defense","",19,[[["level",3]]]],[11,"ne","","",19,[[["level",3]]]],[11,"eq","","",0,[[["levelbuilder",3]]]],[11,"ne","","",0,[[["levelbuilder",3]]]],[11,"eq","","",2,[[["defense",3]]]],[11,"ne","","",2,[[["defense",3]]]],[11,"eq","","",1,[[["defensebuilder",3]]]],[11,"ne","","",1,[[["defensebuilder",3]]]],[11,"eq","m_captcha::errors","",3,[[["captchaerror",4]]]],[11,"fmt","m_captcha::defense","",19,[[["formatter",3]],["result",6]]],[11,"fmt","","",0,[[["formatter",3]],["result",6]]],[11,"fmt","","",2,[[["formatter",3]],["result",6]]],[11,"fmt","","",1,[[["formatter",3]],["result",6]]],[11,"fmt","m_captcha::errors","",3,[[["formatter",3]],["result",6]]],[11,"fmt","m_captcha::mcaptcha","",9,[[["formatter",3]],["result",6]]],[11,"fmt","m_captcha::pow","",15,[[["formatter",3]],["result",6]]],[11,"fmt","","",16,[[["formatter",3]],["result",6]]],[11,"fmt","m_captcha::errors","",3,[[["formatter",3]],["result",6]]],[11,"handle","m_captcha::master","",4,[[["getsite",3]]]],[11,"handle","","",4,[[["addsite",3]]]],[11,"handle","m_captcha::mcaptcha","",9,[[["visitor",3]]]],[11,"handle","m_captcha::cache::hashcache","",21,[[["cache",3]]]],[11,"handle","","",21,[[["deletestring",3]]]],[11,"handle","","",21,[[["retrive",3]]]],[11,"serialize","m_captcha::pow","",15,[[],["result",4]]],[11,"serialize","","",16,[[],["result",4]]],[11,"salt","","",22,[[["string",3]],["configbuilder",3]]],[11,"build","","Builds a new Config.",22,[[],[["result",4],["config",3],["string",3]]]]],"p":[[3,"LevelBuilder"],[3,"DefenseBuilder"],[3,"Defense"],[4,"CaptchaError"],[3,"Master"],[3,"GetSite"],[3,"AddSite"],[3,"AddSiteBuilder"],[3,"MCaptchaBuilder"],[3,"MCaptcha"],[3,"VisitorResult"],[3,"Cache"],[3,"CacheBuilder"],[3,"Retrive"],[3,"DeleteString"],[3,"PoWConfig"],[3,"Work"],[3,"System"],[3,"SystemBuilder"],[3,"Level"],[3,"Visitor"],[3,"HashCache"],[3,"ConfigBuilder"]]}\
+}');
+addSearchOptions(searchIndex);initSearch(searchIndex);
\ No newline at end of file
diff --git a/static/api-docs/m_captcha/0.1.0/settings.css b/static/api-docs/m_captcha/0.1.0/settings.css
new file mode 100644
index 0000000..6709865
--- /dev/null
+++ b/static/api-docs/m_captcha/0.1.0/settings.css
@@ -0,0 +1 @@
+.setting-line{padding:5px;position:relative;}.setting-line>div{display:inline-block;vertical-align:top;font-size:17px;padding-top:2px;}.setting-line>.title{font-size:19px;width:100%;max-width:none;border-bottom:1px solid;}.toggle{position:relative;display:inline-block;width:45px;height:27px;margin-right:20px;}.toggle input{opacity:0;position:absolute;}.select-wrapper{float:right;position:relative;height:27px;min-width:25%;}.select-wrapper select{appearance:none;-moz-appearance:none;-webkit-appearance:none;background:none;border:2px solid #ccc;padding-right:28px;width:100%;}.select-wrapper img{pointer-events:none;position:absolute;right:0;bottom:0;background:#ccc;height:100%;width:28px;padding:0px 4px;}.select-wrapper select option{color:initial;}.slider{position:absolute;cursor:pointer;top:0;left:0;right:0;bottom:0;background-color:#ccc;-webkit-transition:.3s;transition:.3s;}.slider:before{position:absolute;content:"";height:19px;width:19px;left:4px;bottom:4px;background-color:white;-webkit-transition:.3s;transition:.3s;}input:checked+.slider{background-color:#2196F3;}input:focus+.slider{box-shadow:0 0 0 2px #0a84ff,0 0 0 6px rgba(10,132,255,0.3);}input:checked+.slider:before{-webkit-transform:translateX(19px);-ms-transform:translateX(19px);transform:translateX(19px);}.setting-line>.sub-settings{padding-left:42px;width:100%;display:block;}
\ No newline at end of file
diff --git a/static/api-docs/m_captcha/0.1.0/settings.html b/static/api-docs/m_captcha/0.1.0/settings.html
new file mode 100644
index 0000000..1762d2c
--- /dev/null
+++ b/static/api-docs/m_captcha/0.1.0/settings.html
@@ -0,0 +1,6 @@
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ +//! In-memory cache implementation that uses [HashMap] +use std::collections::HashMap; + +use actix::prelude::*; + +use super::messages::*; +use super::Save; +use crate::errors::*; + +#[derive(Clone, Default)] +/// cache datastructure implementing [Save] +pub struct HashCache(HashMap<String, u32>); + +impl HashCache { + // save [PoWConfig] to cache + fn save(&mut self, config: Cache) -> CaptchaResult<()> { + self.0.insert(config.string, config.difficulty_factor); + Ok(()) + } + + // retrive [PoWConfig] from cache. Deletes config post retrival + fn retrive(&mut self, string: String) -> CaptchaResult<Option<u32>> { + if let Some(difficulty_factor) = self.remove(&string) { + Ok(Some(difficulty_factor.to_owned())) + } else { + Ok(None) + } + } + + // delete [PoWConfig] from cache + fn remove(&mut self, string: &str) -> Option<u32> { + self.0.remove(string) + } +} + +impl Save for HashCache {} + +impl Actor for HashCache { + type Context = Context<Self>; +} + +/// cache a PoWConfig +impl Handler<Cache> for HashCache { + type Result = MessageResult<Cache>; + fn handle(&mut self, msg: Cache, ctx: &mut Self::Context) -> Self::Result { + use actix::clock::delay_for; + use std::time::Duration; + + let addr = ctx.address(); + let del_msg = DeleteString(msg.string.clone()); + + let duration: Duration = Duration::new(msg.duration.clone(), 0); + let wait_for = async move { + delay_for(duration).await; + addr.send(del_msg).await.unwrap().unwrap(); + } + .into_actor(self); + ctx.spawn(wait_for); + + MessageResult(self.save(msg)) + } +} + +/// Delte a PoWConfig +impl Handler<DeleteString> for HashCache { + type Result = MessageResult<DeleteString>; + fn handle(&mut self, msg: DeleteString, _ctx: &mut Self::Context) -> Self::Result { + self.remove(&msg.0); + MessageResult(Ok(())) + } +} + +/// Retrive PoW difficulty_factor for a PoW string +impl Handler<Retrive> for HashCache { + type Result = MessageResult<Retrive>; + fn handle(&mut self, msg: Retrive, _ctx: &mut Self::Context) -> Self::Result { + MessageResult(self.retrive(msg.0)) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::mcaptcha::VisitorResult; + use crate::pow::PoWConfig; + + async fn sleep(time: u64) { + use actix::clock::delay_for; + use std::time::Duration; + + let duration: Duration = Duration::new(time, 0); + delay_for(duration).await; + } + + #[actix_rt::test] + async fn hashcache_works() { + const DIFFICULTY_FACTOR: u32 = 54; + const DURATION: u64 = 5; + let addr = HashCache::default().start(); + let pow: PoWConfig = PoWConfig::new(DIFFICULTY_FACTOR); + let visitor_result = VisitorResult { + difficulty_factor: DIFFICULTY_FACTOR, + duration: DURATION, + }; + let string = pow.string.clone(); + let msg = Cache::new(&pow, &visitor_result); + + addr.send(msg).await.unwrap().unwrap(); + + let cache_difficulty_factor = addr.send(Retrive(string.clone())).await.unwrap().unwrap(); + assert_eq!(DIFFICULTY_FACTOR, cache_difficulty_factor.unwrap()); + + sleep(DURATION + DURATION).await; + + let expired_string = addr.send(Retrive(string)).await.unwrap().unwrap(); + assert_eq!(None, expired_string); + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ +//! Cache is used to save proofof work details and nonces to prevent replay attacks +//! and rainbow/dictionary attacks +pub use hashcache::HashCache; +use messages::*; + +pub mod hashcache; + +/// Describes actor handler trait impls that are required by a cache implementation +pub trait Save: + actix::Actor + actix::Handler<Retrive> + actix::Handler<Cache> + actix::Handler<DeleteString> +{ +} +pub mod messages { + //! Messages that can be sent to cache data structures implementing [Save][super::Save] + use actix::dev::*; + use derive_builder::Builder; + + use crate::errors::*; + use crate::mcaptcha::VisitorResult; + use crate::pow::PoWConfig; + + /// Message to cache PoW difficulty factor and string + #[derive(Message, Builder)] + #[rtype(result = "CaptchaResult<()>")] + pub struct Cache { + pub string: String, + pub difficulty_factor: u32, + pub duration: u64, + } + + impl Cache { + pub fn new(p: &PoWConfig, v: &VisitorResult) -> Self { + CacheBuilder::default() + .string(p.string.clone()) + .difficulty_factor(v.difficulty_factor) + .duration(v.duration) + .build() + .unwrap() + } + } + + /// Message to retrive the the difficulty factor for the specified + /// string from the cache + #[derive(Message)] + #[rtype(result = "CaptchaResult<Option<u32>>")] + pub struct Retrive(pub String); + + /// Message to delete cached PoW difficulty factor and string + /// when they expire + #[derive(Message)] + #[rtype(result = "CaptchaResult<()>")] + pub struct DeleteString(pub String); +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287 +288 +289 +290 +291 +292 +293 +294 +295 +296 +297 +298 +299 +300 +301 +302 +303 +304 +305 +306 +307 +308 +309 +310 +311 +312 +313 +314 +315 +316 +317 +318 +319 +320 +321 +322 +323 +324 +325 +326 +327 +328 +329 +330 +331 +332 +333 +334 +335 +336 +337 +338 +339 +340 +341 +342 +343 +344 +345 +346 +347 +348 +349 +350 +351 +352 +353 +354 +355 +356 +357 +358 +359 +360 +361 +362 +363 +364 +365 +366 +367 +368 +369 +370 +371 +372 +373 +374 +375 +376 +377 +378 +379 +380 +381 +382 +383 +384 +385 +386 +387 +388 +389 +390 +391 +392 +393 +394 +395 +396 +397 +398 +399 +400 +401 +402 +403 +404 +405 +406 +407 +408 +409 +410 +411 +412 +413 +414 +415 +416 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ + +//! Defense datatypes +//! ```rust +//! use m_captcha::{LevelBuilder, DefenseBuilder}; +//! DefenseBuilder::default() +//! .add_level( +//! LevelBuilder::default() +//! .visitor_threshold(50) +//! .difficulty_factor(50) +//! .unwrap() +//! .build() +//! .unwrap(), +//! ) +//! .unwrap() +//! .add_level( +//! LevelBuilder::default() +//! .visitor_threshold(500) +//! .difficulty_factor(500) +//! .unwrap() +//! .build() +//! .unwrap(), +//! ) +//! .unwrap() +//! .build() +//! .unwrap(); +//! ``` + +use crate::errors::*; + +/// Level struct that describes threshold-difficulty factor mapping +#[derive(Debug, Copy, Clone, PartialEq)] +pub struct Level { + visitor_threshold: u32, + difficulty_factor: u32, +} + +/// Bulder struct for [Level] to describe threshold-difficulty factor mapping +#[derive(Debug, Copy, Clone, PartialEq)] +pub struct LevelBuilder { + visitor_threshold: Option<u32>, + difficulty_factor: Option<u32>, +} + +impl Default for LevelBuilder { + fn default() -> Self { + LevelBuilder { + visitor_threshold: None, + difficulty_factor: None, + } + } +} + +impl LevelBuilder { + /// set visitor count for level + pub fn visitor_threshold(&mut self, visitor_threshold: u32) -> &mut Self { + self.visitor_threshold = Some(visitor_threshold); + self + } + + /// set difficulty factor for level. difficulty_factor can't be zero because + /// Difficulty is calculated as: + /// ```no_run + /// let difficulty_factor = 500; + /// let difficulty = u128::max_value() - u128::max_value() / difficulty_factor; + /// ``` + /// the higher the `difficulty_factor`, the higher the difficulty. + pub fn difficulty_factor(&mut self, difficulty_factor: u32) -> CaptchaResult<&mut Self> { + if difficulty_factor > 0 { + self.difficulty_factor = Some(difficulty_factor); + Ok(self) + } else { + Err(CaptchaError::DifficultyFactorZero) + } + } + + /// build Level struct + pub fn build(&mut self) -> CaptchaResult<Level> { + if self.visitor_threshold.is_none() { + Err(CaptchaError::SetVisitorThreshold) + } else if self.difficulty_factor.is_none() { + Err(CaptchaError::SetDifficultyFactor) + } else { + Ok(Level { + difficulty_factor: self.difficulty_factor.unwrap(), + visitor_threshold: self.visitor_threshold.unwrap(), + }) + } + } +} + +/// struct describes all the different [Level]s at which an mCaptcha system operates +#[derive(Debug, Clone, PartialEq)] +pub struct Defense { + levels: Vec<Level>, + // index of current visitor threshold + current_visitor_threshold: usize, +} + +/// Builder struct for [Defense] +#[derive(Debug, Clone, PartialEq)] +pub struct DefenseBuilder { + levels: Vec<Level>, +} + +impl Default for DefenseBuilder { + fn default() -> Self { + DefenseBuilder { levels: vec![] } + } +} + +impl DefenseBuilder { + /// add a level to [Defense] + pub fn add_level(&mut self, level: Level) -> CaptchaResult<&mut Self> { + for i in self.levels.iter() { + if i.visitor_threshold == level.visitor_threshold { + return Err(CaptchaError::DuplicateVisitorCount); + } + } + self.levels.push(level); + Ok(self) + } + + /// Build [Defense] + pub fn build(&mut self) -> CaptchaResult<Defense> { + if !self.levels.is_empty() { + // sort levels to arrange in ascending order + self.levels.sort_by_key(|a| a.visitor_threshold); + + for level in self.levels.iter() { + if level.difficulty_factor == 0 { + return Err(CaptchaError::DifficultyFactorZero); + } + } + + // as visitor count increases, difficulty_factor too should increse + // if it decreses, an error must be thrown + for i in 0..self.levels.len() - 1 { + if self.levels[i].difficulty_factor > self.levels[i + 1].difficulty_factor { + return Err(CaptchaError::DecreaseingDifficultyFactor); + } + } + + Ok(Defense { + levels: self.levels.to_owned(), + current_visitor_threshold: 0, + }) + } else { + Err(CaptchaError::LevelEmpty) + } + } +} + +impl Defense { + ///! Difficulty is calculated as: + ///! ```rust + ///! let difficulty = u128::max_value() - u128::max_value() / difficulty_factor; + ///! ``` + ///! The higher the `difficulty_factor`, the higher the difficulty. + + /// Get difficulty factor of current level of defense + pub fn get_difficulty(&self) -> u32 { + self.levels[self.current_visitor_threshold].difficulty_factor + } + + /// tighten up defense. Increases defense level by a factor of one. + /// When defense is at max level, calling this method will have no effect + pub fn tighten_up(&mut self) { + if self.current_visitor_threshold != self.levels.len() - 1 { + self.current_visitor_threshold += 1; + } + } + /// Loosen up defense. Decreases defense level by a factor of one. + /// When defense is at the lowest level, calling this method will have no effect. + pub fn loosen_up(&mut self) { + if self.current_visitor_threshold != 0 { + self.current_visitor_threshold -= 1; + } + } + + /// Set defense to maximum level + pub fn max_defense(&mut self) { + self.current_visitor_threshold = self.levels.len() - 1; + } + + /// Set defense to minimum level + pub fn min_defense(&mut self) { + self.current_visitor_threshold = 0; + } + + /// Get current level's visitor threshold + pub fn visitor_threshold(&self) -> u32 { + self.levels[self.current_visitor_threshold].visitor_threshold + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn level_builder_works() { + let level = LevelBuilder::default() + .difficulty_factor(1) + .unwrap() + .visitor_threshold(0) + .build() + .unwrap(); + + assert_eq!(level.visitor_threshold, 0); + assert_eq!(level.difficulty_factor, 1); + + assert_eq!( + LevelBuilder::default().difficulty_factor(0), + Err(CaptchaError::DifficultyFactorZero) + ); + + assert_eq!( + LevelBuilder::default() + .difficulty_factor(1) + .unwrap() + .build(), + Err(CaptchaError::SetVisitorThreshold) + ); + assert_eq!( + LevelBuilder::default().visitor_threshold(10).build(), + Err(CaptchaError::SetDifficultyFactor) + ); + } + + #[test] + fn defense_builder_duplicate_visitor_threshold() { + let mut defense_builder = DefenseBuilder::default(); + let err = defense_builder + .add_level( + LevelBuilder::default() + .visitor_threshold(50) + .difficulty_factor(50) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(50) + .difficulty_factor(50) + .unwrap() + .build() + .unwrap(), + ); + assert_eq!(err, Err(CaptchaError::DuplicateVisitorCount)); + } + + #[test] + fn defense_builder_decreasing_difficulty_factor() { + let mut defense_builder = DefenseBuilder::default(); + let err = defense_builder + .add_level( + LevelBuilder::default() + .visitor_threshold(50) + .difficulty_factor(50) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(500) + .difficulty_factor(10) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .build(); + assert_eq!(err, Err(CaptchaError::DecreaseingDifficultyFactor)); + } + + fn get_defense() -> Defense { + DefenseBuilder::default() + .add_level( + LevelBuilder::default() + .visitor_threshold(50) + .difficulty_factor(50) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(500) + .difficulty_factor(5000) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(5000) + .difficulty_factor(50000) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(50000) + .difficulty_factor(500000) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(500000) + .difficulty_factor(5000000) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .build() + .unwrap() + } + #[test] + fn defense_builder_works() { + let defense = get_defense(); + + assert_eq!(defense.levels[0].difficulty_factor, 50); + assert_eq!(defense.levels[1].difficulty_factor, 5000); + assert_eq!(defense.levels[2].difficulty_factor, 50_000); + assert_eq!(defense.levels[3].difficulty_factor, 500_000); + assert_eq!(defense.levels[4].difficulty_factor, 5_000_000); + } + + #[test] + fn tighten_up_works() { + let mut defense = get_defense(); + + assert_eq!(defense.get_difficulty(), 50); + + defense.tighten_up(); + assert_eq!(defense.get_difficulty(), 5_000); + + defense.tighten_up(); + assert_eq!(defense.get_difficulty(), 50_000); + + defense.tighten_up(); + assert_eq!(defense.get_difficulty(), 500_000); + + defense.tighten_up(); + assert_eq!(defense.get_difficulty(), 5_000_000); + + defense.tighten_up(); + assert_eq!(defense.get_difficulty(), 5_000_000); + } + + #[test] + fn max_defense_works() { + let mut defense = get_defense(); + defense.max_defense(); + assert_eq!(defense.get_difficulty(), 5_000_000); + } + + #[test] + fn minimum_defense_works() { + let mut defense = get_defense(); + defense.min_defense(); + assert_eq!(defense.get_difficulty(), 50); + } + + #[test] + fn loosen_up_works() { + let mut defense = get_defense(); + defense.max_defense(); + + assert_eq!(defense.get_difficulty(), 5_000_000); + + defense.loosen_up(); + assert_eq!(defense.get_difficulty(), 500_000); + + defense.loosen_up(); + assert_eq!(defense.get_difficulty(), 50_000); + + defense.loosen_up(); + assert_eq!(defense.get_difficulty(), 5_000); + + defense.loosen_up(); + assert_eq!(defense.get_difficulty(), 50); + + defense.loosen_up(); + assert_eq!(defense.get_difficulty(), 50); + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ + +//! Errors and Result module +use derive_more::{Display, Error}; + +/// Error datatype +#[derive(Debug, PartialEq, Display, Clone, Error)] +#[cfg(not(tarpaulin_include))] +pub enum CaptchaError { + /// When configuring m_captcha, [DefenseBuilder][crate::defense::DefenseBuilder] + /// must be passed atleast one `LevelConfig` if not this error will arise + #[display(fmt = "LevelBuilder should have atleaset one level configured")] + LevelEmpty, + + /// Visitor count must be a whole number(zero and above). + /// When configuring m_captcha, [LevelBuilder][crate::defense::LevelBuilder]. + /// difficulty_factor must be set to greater than zero. + #[display(fmt = "difficulty factor must be greater than zero")] + DifficultyFactorZero, + + /// Difficulty factor must be set + #[display(fmt = "Set difficulty factor")] + SetDifficultyFactor, + + /// Visitor threshold must be set + #[display(fmt = "Set visitor threshold")] + SetVisitorThreshold, + + /// Visitor count must be Unique + #[display(fmt = "Duplicate visitor count")] + DuplicateVisitorCount, + + /// Difficulty factor should increase with level + #[display(fmt = "Difficulty factor should increase with level")] + DecreaseingDifficultyFactor, + + /// Difficulty factor should increase with level + #[display(fmt = "Actor mailbox error")] + MailboxError, + + /// Happens when submitted work doesn't satisfy the required + /// difficulty factor + #[display(fmt = "Insuffiencient Difficulty")] + InsuffiencientDifficulty, + + /// Happens when submitted work is computed over string that + /// isn't in cache + #[display(fmt = "String now found")] + StringNotFound, +} + +/// [Result] datatype for m_captcha +pub type CaptchaResult<V> = std::result::Result<V, CaptchaError>; +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ +//! mCaptcha is a proof of work based Denaial-of-Service attack protection system. +//! This is is a server library that you can embed in your services to protect your +//! servers. +//! +//! 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. +//! +//! In mCaptcha, defense is adjusted in discrete levels that depend on the +//! ammount of traffic that a service is experiencing. So users of this library are +//! requested to benchmark their target machines before configuring their mCaptcha +//! component. +//! +//! ## Terminology: +//! - Difficulty(Factor): Minimum ammount of work that a client must do to make a valid +//! request. +//! - [Defense]: A datatype that various visitor-difficulty mappigns +//! - [Visitor][crate::mcaptcha::Visitor]: Smallest unit of traffic, usually a single request. The more you have, the busier +//! your service is. Determines mCaptcha defense defense +//! - Visitor threshold: The threshold at which [MCaptcha] will adjust defense defense +//! - [Cache][crate::cache] : A datatype that implements [Save][crate::cache::Save]. Used to store +//! PoW requirements to defend against replay attacks and dictionary attacks. +//! - [Master][crate::master::Master]: A datatype that manages [MCaptcha][crate::mcaptcha::MCaptcha] actors. Works like a DNS for [Visitor][crate::mcaptcha::Visitor] messages. +//! - [System][crate::system::System]: mCaptcha system that manages cache, master and provides +//! useful abstractions. An mCaptcha system/instance can have only a single +//! [System][crate::system::System] +//! +//! ## Example: +//! +//! ```rust +//! use m_captcha::{ +//! cache::HashCache, +//! master::{AddSiteBuilder, Master}, +//! pow::{ConfigBuilder, Work}, +//! system::SystemBuilder, +//! DefenseBuilder, LevelBuilder, MCaptchaBuilder, +//! }; +//! // traits from actix needs to be in scope for starting actor +//! use actix::prelude::*; +//! +//! #[actix_rt::main] +//! async fn main() -> std::io::Result<()> { +//! // start cahce actor +//! // cache is used to store PoW requirements that are sent to clients +//! // This way, it can be verified that the client computed work over a config +//! // that _we_ sent. Offers protection against rainbow tables powered dictionary attacks +//! let cache = HashCache::default().start(); +//! +//! // create PoW config with unique salt. Salt has to be safely guarded. +//! // salts protect us from replay attacks +//! let pow = ConfigBuilder::default() +//! .salt("myrandomsaltisnotlongenoug".into()) +//! .build() +//! .unwrap(); +//! +//! // start master actor. Master actor is responsible for managing MCaptcha actors +//! // each mCaptcha system should have only one master +//! let master = Master::new().start(); +//! +//! // Create system. System encapsulates master and cache and provides useful abstraction +//! // each mCaptcha system should have only one system +//! let system = SystemBuilder::default() +//! .master(master) +//! .cache(cache) +//! .pow(pow.clone()) +//! .build() +//! .unwrap(); +//! +//! // configure defense. This is a per site configuration. A site can have several levels +//! // of defenses configured +//! let defense = DefenseBuilder::default() +//! // add as many defense as you see fit +//! .add_level( +//! LevelBuilder::default() +//! // visitor_threshold is the threshold/limit at which +//! // mCaptcha will adjust difficulty defense +//! // it is advisable to set small values for the first +//! // defense visitor_threshold and difficulty_factor +//! // as this will be the work that clients will be +//! // computing when there's no load +//! .visitor_threshold(50) +//! .difficulty_factor(500) +//! .unwrap() +//! .build() +//! .unwrap(), +//! ) +//! .unwrap() +//! .add_level( +//! LevelBuilder::default() +//! .visitor_threshold(5000) +//! .difficulty_factor(50000) +//! .unwrap() +//! .build() +//! .unwrap(), +//! ) +//! .unwrap() +//! .build() +//! .unwrap(); +//! +//! // create and start MCaptcha actor that uses the above defense configuration +//! // This is what manages the difficulty factor of sites that an mCaptcha protects +//! let mcaptcha = MCaptchaBuilder::default() +//! .defense(defense) +//! // leaky bucket algorithm's emission interval +//! .duration(30) +//! // .cache(cache) +//! .build() +//! .unwrap() +//! .start(); +//! +//! // unique value identifying an MCaptcha actor +//! let mcaptcha_name = "batsense.net"; +//! +//! // add MCaptcha to Master +//! let msg = AddSiteBuilder::default() +//! .id(mcaptcha_name.into()) +//! .addr(mcaptcha.clone()) +//! .build() +//! .unwrap(); +//! system.master.send(msg).await.unwrap(); +//! +//! // Get PoW config. Should be called everytime there's a visitor for a +//! // managed site(here mcaptcha_name) +//! let work_req = system.get_pow(mcaptcha_name.into()).await.unwrap(); +//! +//! // the following computation should be done on the client but for the purpose +//! // of this illustration, we are going to do it on the server it self +//! let work = pow +//! .prove_work(&work_req.string, work_req.difficulty_factor) +//! .unwrap(); +//! +//! // the payload that the client sends to the server +//! let payload = Work { +//! string: work_req.string, +//! result: work.result, +//! nonce: work.nonce, +//! }; +//! +//! // Server evaluates client's work. Returns true if everything +//! // checksout and Err() if something fishy is happening +//! let res = system.verify_pow(payload.clone()).await.unwrap(); +//! assert!(res); +//! +//! Ok(()) +//! } +//! ``` + +pub mod defense; +pub mod errors; +pub mod master; +pub mod mcaptcha; + +/// message datatypes to interact with [MCaptcha] actor +pub mod cache; +pub mod pow; +pub mod system; +mod utils; + +pub use crate::cache::hashcache::HashCache; + +pub use defense::{Defense, DefenseBuilder, LevelBuilder}; +pub use mcaptcha::{MCaptcha, MCaptchaBuilder}; +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ +//! [Master] actor module that manages [MCaptcha] actors +use std::collections::BTreeMap; + +use actix::dev::*; +use derive_builder::Builder; + +use crate::mcaptcha::MCaptcha; + +/// This Actor manages the [MCaptcha] actors. +/// A service can have several [MCaptcha] actors with +/// varying [Defense][crate::defense::Defense] configurations +/// so a "master" actor is needed to manage them all +#[derive(Clone)] +pub struct Master { + sites: BTreeMap<String, Addr<MCaptcha>>, +} + +impl Master { + /// add [MCaptcha] actor to [Master] + pub fn add_site(&mut self, details: AddSite) { + self.sites.insert(details.id, details.addr.to_owned()); + } + + /// create new master + pub fn new() -> Self { + Master { + sites: BTreeMap::new(), + } + } + + /// get [MCaptcha] actor from [Master] + pub fn get_site<'a, 'b>(&'a self, id: &'b str) -> Option<&'a Addr<MCaptcha>> { + self.sites.get(id) + } +} + +impl Actor for Master { + type Context = Context<Self>; +} + +/// Message to get an [MCaptcha] actor from master +#[derive(Message)] +#[rtype(result = "Option<Addr<MCaptcha>>")] +pub struct GetSite(pub String); + +impl Handler<GetSite> for Master { + type Result = MessageResult<GetSite>; + + fn handle(&mut self, m: GetSite, _ctx: &mut Self::Context) -> Self::Result { + let addr = self.get_site(&m.0); + if addr.is_none() { + return MessageResult(None); + } else { + return MessageResult(Some(addr.unwrap().clone())); + } + } +} + +/// Message to add an [MCaptcha] actor to [Master] +#[derive(Message, Builder)] +#[rtype(result = "()")] +pub struct AddSite { + pub id: String, + pub addr: Addr<MCaptcha>, +} + +impl Handler<AddSite> for Master { + type Result = (); + + fn handle(&mut self, m: AddSite, _ctx: &mut Self::Context) -> Self::Result { + self.add_site(m); + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::mcaptcha::tests::*; + + #[actix_rt::test] + async fn master_actor_works() { + let addr = Master::new().start(); + + let id = "yo"; + let mcaptcha = get_counter().start(); + let msg = AddSiteBuilder::default() + .id(id.into()) + .addr(mcaptcha.clone()) + .build() + .unwrap(); + addr.send(msg).await.unwrap(); + + let mcaptcha_addr = addr.send(GetSite(id.into())).await.unwrap(); + assert_eq!(mcaptcha_addr, Some(mcaptcha)); + + let addr_doesnt_exist = addr.send(GetSite("a".into())).await.unwrap(); + assert!(addr_doesnt_exist.is_none()); + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ +//! MCaptcha actor module that manages defense levels +//! +//! ## Usage: +//! ```rust +//! use m_captcha::{mcaptcha::Visitor, MCaptchaBuilder, cache::HashCache, LevelBuilder, DefenseBuilder}; +//! // traits from actix needs to be in scope for starting actor +//! use actix::prelude::*; +//! +//! #[actix_rt::main] +//! async fn main() -> std::io::Result<()> { +//! // configure defense +//! let defense = DefenseBuilder::default() +//! // add as many levels as you see fit +//! .add_level( +//! LevelBuilder::default() +//! // visitor_threshold is the threshold/limit at which +//! // mCaptcha will adjust difficulty levels +//! // it is advisable to set small values for the first +//! // levels visitor_threshold and difficulty_factor +//! // as this will be the work that clients will be +//! // computing when there's no load +//! .visitor_threshold(50) +//! .difficulty_factor(500) +//! .unwrap() +//! .build() +//! .unwrap(), +//! ) +//! .unwrap() +//! .add_level( +//! LevelBuilder::default() +//! .visitor_threshold(5000) +//! .difficulty_factor(50000) +//! .unwrap() +//! .build() +//! .unwrap(), +//! ) +//! .unwrap() +//! .build() +//! .unwrap(); +//! +//! // create and start MCaptcha actor +//! //let cache = HashCache::default().start(); +//! let mcaptcha = MCaptchaBuilder::default() +//! .defense(defense) +//! // leaky bucket algorithm's emission interval +//! .duration(30) +//! .build() +//! .unwrap() +//! .start(); +//! +//! // increment count when user visits protected routes +//! mcaptcha.send(Visitor).await.unwrap(); +//! +//! Ok(()) +//! } +//! ``` + +use std::time::Duration; + +use actix::dev::*; +use derive_builder::Builder; + +use crate::defense::Defense; + +/// This struct represents the mCaptcha state and is used +/// to configure leaky-bucket lifetime and manage defense +#[derive(Clone, Debug, Builder)] +pub struct MCaptcha { + #[builder(default = "0", setter(skip))] + visitor_threshold: u32, + defense: Defense, + duration: u64, +} + +impl MCaptcha { + /// incerment visiotr count by one + pub fn add_visitor(&mut self) { + self.visitor_threshold += 1; + if self.visitor_threshold > self.defense.visitor_threshold() { + self.defense.tighten_up(); + } else { + self.defense.loosen_up(); + } + } + + /// deccerment visiotr count by one + pub fn decrement_visiotr(&mut self) { + if self.visitor_threshold > 0 { + self.visitor_threshold -= 1; + } + } + + /// get current difficulty factor + pub fn get_difficulty(&self) -> u32 { + self.defense.get_difficulty() + } + + /// get [MCaptcha]'s lifetime + pub fn get_duration(&self) -> u64 { + self.duration + } +} +impl Actor for MCaptcha { + type Context = Context<Self>; +} + +/// Message to decrement the visitor count +#[derive(Message)] +#[rtype(result = "()")] +struct DeleteVisitor; + +impl Handler<DeleteVisitor> for MCaptcha { + type Result = (); + fn handle(&mut self, _msg: DeleteVisitor, _ctx: &mut Self::Context) -> Self::Result { + self.decrement_visiotr(); + } +} + +/// Message to increment the visitor count +/// returns difficulty factor and lifetime +#[derive(Message)] +#[rtype(result = "VisitorResult")] +pub struct Visitor; + +/// Struct representing the return datatime of +/// [Visitor] message. Contains MCaptcha lifetime +/// and difficulty factor +pub struct VisitorResult { + pub duration: u64, + pub difficulty_factor: u32, +} + +impl VisitorResult { + fn new(m: &MCaptcha) -> Self { + VisitorResult { + duration: m.get_duration(), + difficulty_factor: m.get_difficulty(), + } + } +} + +impl Handler<Visitor> for MCaptcha { + type Result = MessageResult<Visitor>; + + fn handle(&mut self, _: Visitor, ctx: &mut Self::Context) -> Self::Result { + use actix::clock::delay_for; + + let addr = ctx.address(); + + let duration: Duration = Duration::new(self.duration.clone(), 0); + let wait_for = async move { + delay_for(duration).await; + addr.send(DeleteVisitor).await.unwrap(); + } + .into_actor(self); + ctx.spawn(wait_for); + + self.add_visitor(); + MessageResult(VisitorResult::new(&self)) + } +} + +#[cfg(test)] +pub mod tests { + use super::*; + use crate::defense::*; + + // constants for testing + // (visitor count, level) + pub const LEVEL_1: (u32, u32) = (50, 50); + pub const LEVEL_2: (u32, u32) = (500, 500); + pub const DURATION: u64 = 10; + + type MyActor = Addr<MCaptcha>; + + pub fn get_defense() -> Defense { + DefenseBuilder::default() + .add_level( + LevelBuilder::default() + .visitor_threshold(LEVEL_1.0) + .difficulty_factor(LEVEL_1.1) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .add_level( + LevelBuilder::default() + .visitor_threshold(LEVEL_2.0) + .difficulty_factor(LEVEL_2.1) + .unwrap() + .build() + .unwrap(), + ) + .unwrap() + .build() + .unwrap() + } + + async fn race(addr: Addr<MCaptcha>, count: (u32, u32)) { + for _ in 0..count.0 as usize - 1 { + let _ = addr.send(Visitor).await.unwrap(); + } + } + + pub fn get_counter() -> MCaptcha { + MCaptchaBuilder::default() + .defense(get_defense()) + .duration(DURATION) + .build() + .unwrap() + } + + #[actix_rt::test] + async fn counter_defense_tightenup_works() { + let addr: MyActor = get_counter().start(); + + let mut mcaptcha = addr.send(Visitor).await.unwrap(); + assert_eq!(mcaptcha.difficulty_factor, LEVEL_1.0); + + race(addr.clone(), LEVEL_2).await; + mcaptcha = addr.send(Visitor).await.unwrap(); + assert_eq!(mcaptcha.difficulty_factor, LEVEL_2.1); + } + + #[actix_rt::test] + async fn counter_defense_loosenup_works() { + use actix::clock::delay_for; + let addr: MyActor = get_counter().start(); + + race(addr.clone(), LEVEL_2).await; + race(addr.clone(), LEVEL_2).await; + let mut mcaptcha = addr.send(Visitor).await.unwrap(); + assert_eq!(mcaptcha.difficulty_factor, LEVEL_2.1); + + let duration = Duration::new(DURATION, 0); + delay_for(duration).await; + + mcaptcha = addr.send(Visitor).await.unwrap(); + assert_eq!(mcaptcha.difficulty_factor, LEVEL_1.1); + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ + +//! PoW datatypes used in client-server interaction +use pow_sha256::PoW; +use serde::Serialize; + +pub use pow_sha256::ConfigBuilder; + +/// PoW requirement datatype that is be sent to clients for generating PoW +#[derive(Clone, Serialize, Debug)] +pub struct PoWConfig { + pub string: String, + pub difficulty_factor: u32, +} +impl PoWConfig { + /// create new instance of [PoWConfig] + pub fn new(m: u32) -> Self { + use crate::utils::get_random; + + PoWConfig { + string: get_random(32), + difficulty_factor: m, + } + } +} + +/// PoW datatype that clients send to server +#[derive(Clone, Serialize, Debug)] +pub struct Work { + pub string: String, + pub result: String, + pub nonce: u64, +} + +impl From<Work> for PoW<String> { + fn from(w: Work) -> Self { + use pow_sha256::PoWBuilder; + PoWBuilder::default() + .result(w.result) + .nonce(w.nonce) + .build() + .unwrap() + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ +//! module describing mCaptcha system +use actix::dev::*; +use derive_builder::Builder; +use pow_sha256::{Config, PoW}; + +use crate::cache::messages; +use crate::cache::Save; +use crate::errors::*; +use crate::master::Master; +use crate::pow::*; + +/// struct describing various bits of data required for an mCaptcha system +#[derive(Clone, Builder)] +pub struct System<T: Save> { + pub master: Addr<Master>, + cache: Addr<T>, + pow: Config, +} + +impl<T> System<T> +where + T: Save, + <T as actix::Actor>::Context: ToEnvelope<T, messages::Cache> + ToEnvelope<T, messages::Retrive>, +{ + /// utility function to get difficulty factor of site `id` and cache it + pub async fn get_pow(&self, id: String) -> Option<PoWConfig> { + use crate::cache::messages::Cache; + use crate::master::GetSite; + use crate::mcaptcha::Visitor; + + let site_addr = self.master.send(GetSite(id)).await.unwrap(); + if site_addr.is_none() { + return None; + } + let mcaptcha = site_addr.unwrap().send(Visitor).await.unwrap(); + let pow_config = PoWConfig::new(mcaptcha.difficulty_factor); + + let cache_msg = Cache::new(&pow_config, &mcaptcha); + self.cache.send(cache_msg).await.unwrap().unwrap(); + Some(pow_config) + } + + /// utility function to verify [Work] + pub async fn verify_pow(&self, work: Work) -> CaptchaResult<bool> { + use crate::cache::messages::Retrive; + + let string = work.string.clone(); + let msg = Retrive(string.clone()); + let pow: PoW<String> = work.into(); + + let difficulty = self.cache.send(msg).await.unwrap()?; + match difficulty { + Some(difficulty) => { + if self.pow.is_sufficient_difficulty(&pow, difficulty) { + Ok(self.pow.is_valid_proof(&pow, &string)) + } else { + Err(CaptchaError::InsuffiencientDifficulty) + } + } + None => Err(CaptchaError::StringNotFound), + } + } +} + +#[cfg(test)] +mod tests { + + use pow_sha256::ConfigBuilder; + + use super::System; + use super::*; + use crate::cache::HashCache; + use crate::master::*; + use crate::mcaptcha::tests::*; + + const MCAPTCHA_NAME: &str = "batsense.net"; + + async fn boostrap_system() -> System<HashCache> { + let master = Master::new().start(); + let mcaptcha = get_counter().start(); + let pow = get_config(); + + let cache = HashCache::default().start(); + let msg = AddSiteBuilder::default() + .id(MCAPTCHA_NAME.into()) + .addr(mcaptcha.clone()) + .build() + .unwrap(); + + master.send(msg).await.unwrap(); + + SystemBuilder::default() + .master(master) + .cache(cache) + .pow(pow) + .build() + .unwrap() + } + + fn get_config() -> Config { + ConfigBuilder::default() + .salt("myrandomsaltisnotlongenoug".into()) + .build() + .unwrap() + } + + #[actix_rt::test] + async fn get_pow_works() { + let actors = boostrap_system().await; + let pow = actors.get_pow(MCAPTCHA_NAME.into()).await.unwrap(); + assert_eq!(pow.difficulty_factor, LEVEL_1.0); + } + + #[actix_rt::test] + async fn verify_pow_works() { + let actors = boostrap_system().await; + let work_req = actors.get_pow(MCAPTCHA_NAME.into()).await.unwrap(); + let config = get_config(); + + let work = config + .prove_work(&work_req.string, work_req.difficulty_factor) + .unwrap(); + let mut payload = Work { + string: work_req.string, + result: work.result, + nonce: work.nonce, + }; + + let res = actors.verify_pow(payload.clone()).await.unwrap(); + assert!(res); + + payload.string = "wrongstring".into(); + let res = actors.verify_pow(payload.clone()).await; + assert_eq!(res, Err(CaptchaError::StringNotFound)); + + let insufficient_work_req = actors.get_pow(MCAPTCHA_NAME.into()).await.unwrap(); + let insufficient_work = config.prove_work(&insufficient_work_req.string, 1).unwrap(); + let insufficient_work_payload = Work { + string: insufficient_work_req.string, + result: insufficient_work.result, + nonce: insufficient_work.nonce, + }; + let res = actors.verify_pow(insufficient_work_payload.clone()).await; + assert_eq!(res, Err(CaptchaError::InsuffiencientDifficulty)); + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +
+/* + * mCaptcha - A proof of work based DoS protection system + * Copyright © 2021 Aravinth Manivannan <realravinth@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 <http://www.gnu.org/licenses/>. + */ + +// utility function to get a randomly generated string +// of size len +pub fn get_random(len: usize) -> String { + use std::iter; + + use rand::{distributions::Alphanumeric, rngs::ThreadRng, thread_rng, Rng}; + + let mut rng: ThreadRng = thread_rng(); + + iter::repeat(()) + .map(|()| rng.sample(Alphanumeric)) + .map(char::from) + .take(len) + .collect::<String>() +} +
| "+""+(item.is_alias===true?(""+item.alias+" - see "):"")+item.displayPath+""+name+" | "+""+""+item.desc+" |
"+code.outerHTML+" |
fn:) to \
+ restrict the search to a given item kind.","Accepted kinds are: fn, mod, struct, \
+ enum, trait, type, macro, \
+ and const.","Search functions by type signature (e.g., vec -> usize or \
+ * -> vec)","Search multiple things at once by splitting your query with comma (e.g., \
+ str,u8 or String,struct:Vec,test)","You can look for items with an exact name by putting double quotes around \
+ your request: \"string\"","Look for items inside another one by searching for a path: vec::Vec",].map(x=>""+x+"
").join("");var div_infos=document.createElement("div");addClass(div_infos,"infos");div_infos.innerHTML="MCaptch's SHA256 based Proof of Work library
++ use pow_sha256::{ConfigBuilder, PoW}; + + fn main() { + let config = ConfigBuilder::default() + .salt("myrandomsaltisnotlongenoug".into()) + .build() + .unwrap(); + + let phrase = "ironmansucks"; + + const DIFFICULTY: u128 = u128::MAX / 32; + + let work = config.prove_work(&phrase, DIFFICULTY).unwrap(); + assert!(config.calculate(&work, &phrase).unwrap() >= DIFFICULTY); + assert!(config.is_valid_proof(&work, &phrase)); + assert!(config.is_sufficient_difficulty(&work, DIFFICULTY)); + }
| Config | Configuration for generting proof of work +Please choose a long, unique value for salt +Resistance to dictionary/rainbow attacks depend on uniqueness +of the salt + |
| ConfigBuilder | Builder for |
| PoW | Proof of Work over concrete type T. T can be any type that implements serde::Serialize. + |
| PoWBuilder | Builder for |
Configuration for generting proof of work +Please choose a long, unique value for salt +Resistance to dictionary/rainbow attacks depend on uniqueness +of the salt
+salt: Stringimpl Config[src]pub fn prove_work<T>(&self, t: &T, difficulty: u128) -> Result<PoW<T>> where
T: Serialize, [src]Create Proof of Work over item of type T.
+Make sure difficulty is not too high. A 64 bit difficulty, +for example, takes a long time on a general purpose processor. +Returns bincode::Error if serialization fails.
+pub fn prove_work_serialized<T>(
&self,
prefix: &[u8],
difficulty: u128
) -> PoW<T> where
T: Serialize, [src]Create Proof of Work on an already serialized item of type T. +The input is assumed to be serialized using network byte order.
+Make sure difficulty is not too high. A 64 bit difficulty, +for example, takes a long time on a general purpose processor.
+pub fn calculate<T>(&self, pow: &PoW<T>, t: &T) -> Result<u128> where
T: Serialize, [src]Calculate the PoW score with the provided input T.
+pub fn calculate_serialized<T>(&self, pow: &PoW<T>, target: &[u8]) -> u128 where
T: Serialize, [src]Calculate the PoW score of an already serialized T and self. +The input is assumed to be serialized using network byte order.
+pub fn is_valid_proof<T>(&self, pow: &PoW<T>, t: &T) -> bool where
T: Serialize, [src]Verifies that the PoW is indeed generated out of the phrase provided.
+pub fn is_sufficient_difficulty<T>(
&self,
pow: &PoW<T>,
target_diff: u128
) -> bool where
T: Serialize, [src]Checks if the PoW result is of sufficient difficulty
+impl Clone for Config[src]impl Debug for Config[src]impl<'de> Deserialize<'de> for Config[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>, [src]impl PartialEq<Config> for Config[src]impl Serialize for Config[src]fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer, [src]impl StructuralPartialEq for Config[src]impl RefUnwindSafe for Config[src]impl Send for Config[src]impl Sync for Config[src]impl Unpin for Config[src]impl UnwindSafe for Config[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>, [src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]Builder for Config.
impl ConfigBuilder[src]pub fn salt(&mut self, value: String) -> &mut Self[src]pub fn build(&self) -> Result<Config, String>[src]impl Clone for ConfigBuilder[src]fn clone(&self) -> ConfigBuilder[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Default for ConfigBuilder[src]fn default() -> ConfigBuilder[src]impl RefUnwindSafe for ConfigBuilder[src]impl Send for ConfigBuilder[src]impl Sync for ConfigBuilder[src]impl Unpin for ConfigBuilder[src]impl UnwindSafe for ConfigBuilder[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]Proof of Work over concrete type T. T can be any type that implements serde::Serialize.
+nonce: u64result: Stringimpl<T: Clone> Clone for PoW<T>[src]impl<T: Debug> Debug for PoW<T>[src]impl<'de, T> Deserialize<'de> for PoW<T>[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>, [src]impl<T: PartialEq> PartialEq<PoW<T>> for PoW<T>[src]impl<T> Serialize for PoW<T>[src]fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer, [src]impl<T> StructuralPartialEq for PoW<T>[src]impl<T> RefUnwindSafe for PoW<T> where
T: RefUnwindSafe, [src]impl<T> Send for PoW<T> where
T: Send, [src]impl<T> Sync for PoW<T> where
T: Sync, [src]impl<T> Unpin for PoW<T> where
T: Unpin, [src]impl<T> UnwindSafe for PoW<T> where
T: UnwindSafe, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>, [src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]Builder for PoW.
impl<T: Clone> PoWBuilder<T>[src]pub fn nonce(&mut self, value: u64) -> &mut Self[src]pub fn result(&mut self, value: String) -> &mut Self[src]pub fn build(&self) -> Result<PoW<T>, String>[src]impl<T: Clone> Clone for PoWBuilder<T>[src]fn clone(&self) -> PoWBuilder<T>[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl<T: Default> Default for PoWBuilder<T>[src]fn default() -> PoWBuilder<T>[src]impl<T> RefUnwindSafe for PoWBuilder<T> where
T: RefUnwindSafe, [src]impl<T> Send for PoWBuilder<T> where
T: Send, [src]impl<T> Sync for PoWBuilder<T> where
T: Sync, [src]impl<T> Unpin for PoWBuilder<T> where
T: Unpin, [src]impl<T> UnwindSafe for PoWBuilder<T> where
T: UnwindSafe, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]PoW.",null,null],[11,"nonce","","",1,[[]]],[11,"result","","",1,[[["string",3]]]],[11,"build","","Builds a new PoW.",1,[[],[["string",3],["result",4],["pow",3]]]],[3,"Config","","Configuration for generting proof of work Please choose a …",null,null],[12,"salt","","",2,null],[3,"ConfigBuilder","","Builder for Config.",null,null],[11,"salt","","",3,[[["string",3]]]],[11,"build","","Builds a new Config.",3,[[],[["result",4],["config",3],["string",3]]]],[11,"prove_work","","Create Proof of Work over item of type T.",2,[[],[["result",6],["pow",3]]]],[11,"prove_work_serialized","","Create Proof of Work on an already serialized item of …",2,[[],["pow",3]]],[11,"calculate","","Calculate the PoW score with the provided input T.",2,[[["pow",3]],["result",6]]],[11,"calculate_serialized","","Calculate the PoW score of an already serialized T and …",2,[[["pow",3]]]],[11,"is_valid_proof","","Verifies that the PoW is indeed generated out of the …",2,[[["pow",3]]]],[11,"is_sufficient_difficulty","","Checks if the PoW result is of sufficient difficulty",2,[[["pow",3]]]],[11,"from","","",0,[[]]],[11,"into","","",0,[[]]],[11,"to_owned","","",0,[[]]],[11,"clone_into","","",0,[[]]],[11,"borrow","","",0,[[]]],[11,"borrow_mut","","",0,[[]]],[11,"try_from","","",0,[[],["result",4]]],[11,"try_into","","",0,[[],["result",4]]],[11,"type_id","","",0,[[],["typeid",3]]],[11,"from","","",1,[[]]],[11,"into","","",1,[[]]],[11,"to_owned","","",1,[[]]],[11,"clone_into","","",1,[[]]],[11,"borrow","","",1,[[]]],[11,"borrow_mut","","",1,[[]]],[11,"try_from","","",1,[[],["result",4]]],[11,"try_into","","",1,[[],["result",4]]],[11,"type_id","","",1,[[],["typeid",3]]],[11,"from","","",2,[[]]],[11,"into","","",2,[[]]],[11,"to_owned","","",2,[[]]],[11,"clone_into","","",2,[[]]],[11,"borrow","","",2,[[]]],[11,"borrow_mut","","",2,[[]]],[11,"try_from","","",2,[[],["result",4]]],[11,"try_into","","",2,[[],["result",4]]],[11,"type_id","","",2,[[],["typeid",3]]],[11,"from","","",3,[[]]],[11,"into","","",3,[[]]],[11,"to_owned","","",3,[[]]],[11,"clone_into","","",3,[[]]],[11,"borrow","","",3,[[]]],[11,"borrow_mut","","",3,[[]]],[11,"try_from","","",3,[[],["result",4]]],[11,"try_into","","",3,[[],["result",4]]],[11,"type_id","","",3,[[],["typeid",3]]],[11,"clone","","",1,[[],["powbuilder",3]]],[11,"clone","","",0,[[],["pow",3]]],[11,"clone","","",3,[[],["configbuilder",3]]],[11,"clone","","",2,[[],["config",3]]],[11,"default","","",1,[[],["powbuilder",3]]],[11,"default","","",3,[[],["configbuilder",3]]],[11,"eq","","",0,[[["pow",3]]]],[11,"ne","","",0,[[["pow",3]]]],[11,"eq","","",2,[[["config",3]]]],[11,"ne","","",2,[[["config",3]]]],[11,"fmt","","",0,[[["formatter",3]],["result",6]]],[11,"fmt","","",2,[[["formatter",3]],["result",6]]],[11,"serialize","","",0,[[],["result",4]]],[11,"serialize","","",2,[[],["result",4]]],[11,"deserialize","","",0,[[],["result",4]]],[11,"deserialize","","",2,[[],["result",4]]]],"p":[[3,"PoW"],[3,"PoWBuilder"],[3,"Config"],[3,"ConfigBuilder"]]}\
+}');
+addSearchOptions(searchIndex);initSearch(searchIndex);
\ No newline at end of file
diff --git a/static/api-docs/pow_sha256/0.1.0/settings.css b/static/api-docs/pow_sha256/0.1.0/settings.css
new file mode 100644
index 0000000..6709865
--- /dev/null
+++ b/static/api-docs/pow_sha256/0.1.0/settings.css
@@ -0,0 +1 @@
+.setting-line{padding:5px;position:relative;}.setting-line>div{display:inline-block;vertical-align:top;font-size:17px;padding-top:2px;}.setting-line>.title{font-size:19px;width:100%;max-width:none;border-bottom:1px solid;}.toggle{position:relative;display:inline-block;width:45px;height:27px;margin-right:20px;}.toggle input{opacity:0;position:absolute;}.select-wrapper{float:right;position:relative;height:27px;min-width:25%;}.select-wrapper select{appearance:none;-moz-appearance:none;-webkit-appearance:none;background:none;border:2px solid #ccc;padding-right:28px;width:100%;}.select-wrapper img{pointer-events:none;position:absolute;right:0;bottom:0;background:#ccc;height:100%;width:28px;padding:0px 4px;}.select-wrapper select option{color:initial;}.slider{position:absolute;cursor:pointer;top:0;left:0;right:0;bottom:0;background-color:#ccc;-webkit-transition:.3s;transition:.3s;}.slider:before{position:absolute;content:"";height:19px;width:19px;left:4px;bottom:4px;background-color:white;-webkit-transition:.3s;transition:.3s;}input:checked+.slider{background-color:#2196F3;}input:focus+.slider{box-shadow:0 0 0 2px #0a84ff,0 0 0 6px rgba(10,132,255,0.3);}input:checked+.slider:before{-webkit-transform:translateX(19px);-ms-transform:translateX(19px);transform:translateX(19px);}.setting-line>.sub-settings{padding-left:42px;width:100%;display:block;}
\ No newline at end of file
diff --git a/static/api-docs/pow_sha256/0.1.0/settings.html b/static/api-docs/pow_sha256/0.1.0/settings.html
new file mode 100644
index 0000000..334fa30
--- /dev/null
+++ b/static/api-docs/pow_sha256/0.1.0/settings.html
@@ -0,0 +1,6 @@
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +
+//! MCaptch's SHA256 based Proof of Work library +//! +//! # Example: +//! ```rust +//! use pow_sha256::{ConfigBuilder, PoW}; +//! +//! fn main() { +//! let config = ConfigBuilder::default() +//! .salt("myrandomsaltisnotlongenoug".into()) +//! .build() +//! .unwrap(); +//! +//! let phrase = "ironmansucks"; +//! +//! const DIFFICULTY: u128 = u128::MAX / 32; +//! +//! let work = config.prove_work(&phrase, DIFFICULTY).unwrap(); +//! assert!(config.calculate(&work, &phrase).unwrap() >= DIFFICULTY); +//! assert!(config.is_valid_proof(&work, &phrase)); +//! assert!(config.is_sufficient_difficulty(&work, DIFFICULTY)); +//! } +//! ``` + +use std::marker::PhantomData; + +use derive_builder::Builder; +use serde::{Deserialize, Serialize}; +use sha2::{Digest, Sha256}; + +/// Proof of Work over concrete type T. T can be any type that implements serde::Serialize. +#[derive(Serialize, Builder, Deserialize, PartialEq, Clone, Debug)] +pub struct PoW<T> { + pub nonce: u64, + pub result: String, + #[builder(default = "PhantomData", setter(skip))] + _spook: PhantomData<T>, +} + +/// Configuration for generting proof of work +/// Please choose a long, unique value for salt +/// Resistance to dictionary/rainbow attacks depend on uniqueness +/// of the salt +#[derive(Serialize, Deserialize, Builder, PartialEq, Clone, Debug)] +pub struct Config { + pub salt: String, +} + +impl Config { + /// Create Proof of Work over item of type T. + /// + /// Make sure difficulty is not too high. A 64 bit difficulty, + /// for example, takes a long time on a general purpose processor. + /// Returns bincode::Error if serialization fails. + pub fn prove_work<T>(&self, t: &T, difficulty: u128) -> bincode::Result<PoW<T>> + where + T: Serialize, + { + bincode::serialize(t).map(|v| self.prove_work_serialized(&v, difficulty)) + } + + /// Create Proof of Work on an already serialized item of type T. + /// The input is assumed to be serialized using network byte order. + /// + /// Make sure difficulty is not too high. A 64 bit difficulty, + /// for example, takes a long time on a general purpose processor. + pub fn prove_work_serialized<T>(&self, prefix: &[u8], difficulty: u128) -> PoW<T> + where + T: Serialize, + { + let prefix_sha = Sha256::new().chain(&self.salt).chain(prefix); + let mut n = 0; + let mut result = 0; + while result < difficulty { + n += 1; + result = score(prefix_sha.clone(), n); + } + PoW { + nonce: n, + result: result.to_string(), + _spook: PhantomData, + } + } + + /// Calculate the PoW score with the provided input T. + pub fn calculate<T>(&self, pow: &PoW<T>, t: &T) -> bincode::Result<u128> + where + T: Serialize, + { + bincode::serialize(t).map(|v| self.calculate_serialized(pow, &v)) + } + + /// Calculate the PoW score of an already serialized T and self. + /// The input is assumed to be serialized using network byte order. + pub fn calculate_serialized<T>(&self, pow: &PoW<T>, target: &[u8]) -> u128 + where + T: Serialize, + { + score(Sha256::new().chain(&self.salt).chain(target), pow.nonce) + } + + /// Verifies that the PoW is indeed generated out of the phrase provided. + pub fn is_valid_proof<T>(&self, pow: &PoW<T>, t: &T) -> bool + where + T: Serialize, + { + match self.calculate(pow, t) { + Ok(res) => { + return if pow.result == res.to_string() { + true + } else { + false + } + } + Err(_) => return false, + } + } + + /// Checks if the PoW result is of sufficient difficulty + pub fn is_sufficient_difficulty<T>(&self, pow: &PoW<T>, target_diff: u128) -> bool + where + T: Serialize, + { + match pow.result.parse::<u128>() { + Ok(res) => return res >= target_diff, + Err(_) => return false, + } + } +} + +fn score(prefix_sha: Sha256, nonce: u64) -> u128 { + first_bytes_as_u128( + prefix_sha + .chain(&nonce.to_be_bytes()) // to_be_bytes() converts to network endian + .finalize() + .as_slice(), + ) +} + +/// # Panics +/// +/// panics if inp.len() < 16 +fn first_bytes_as_u128(inp: &[u8]) -> u128 { + bincode::deserialize(&inp).unwrap() +} + +#[cfg(test)] +mod test { + use super::*; + + const DIFFICULTY: u128 = 0xff000000000000000000000000000000; + + fn get_config() -> Config { + ConfigBuilder::default() + .salt( + "79ziepia7vhjgviiwjhnend3ofjqocsi2winc4ptqhmkvcajihywxcizewvckg9h6gs4j83v9".into(), + ) + .build() + .unwrap() + } + + #[test] + fn base_functionality() { + // Let's prove we did work targeting a phrase. + let phrase = b"Ex nihilo nihil fit.".to_vec(); + let config = get_config(); + let pw = config.prove_work(&phrase, DIFFICULTY).unwrap(); + assert!(config.calculate(&pw, &phrase).unwrap() >= DIFFICULTY); + assert!(config.is_valid_proof(&pw, &phrase)); + assert!(config.is_sufficient_difficulty(&pw, DIFFICULTY)); + } + + #[test] + fn double_pow() { + let phrase = "Ex nihilo nihil fit.".to_owned(); + let config = get_config(); + + let pw = config.prove_work(&phrase, DIFFICULTY).unwrap(); + let pwpw = config.prove_work(&pw, DIFFICULTY).unwrap(); + + assert!(config.calculate(&pw, &phrase).unwrap() >= DIFFICULTY); + assert!(config.is_valid_proof(&pw, &phrase)); + assert!(config.is_sufficient_difficulty(&pw, DIFFICULTY)); + + assert!(config.calculate(&pwpw, &pw).unwrap() >= DIFFICULTY); + assert!(config.is_valid_proof(&pwpw, &pw)); + assert!(config.is_sufficient_difficulty(&pwpw, DIFFICULTY)); + } + + #[test] + fn is_not_valid_proof() { + let phrase = "Ex nihilo nihil fit.".to_owned(); + let phrase2 = "Omne quod movetur ab alio movetur.".to_owned(); + + let config = get_config(); + let pw = config.prove_work(&phrase, DIFFICULTY).unwrap(); + + let pw2 = config.prove_work(&phrase2, DIFFICULTY).unwrap(); + + assert!(!config.is_valid_proof(&pw, &phrase2)); + assert!(!config.is_valid_proof(&pw2, &phrase)); + } + + #[test] + fn serialization_test() { + let target: u8 = 1; + let config = get_config(); + let pw = config.prove_work(&target, DIFFICULTY).unwrap(); + + let message: (u8, PoW<u8>) = (target, pw); + let message_ser = bincode::serialize(&message).unwrap(); + let recieved_message: (u8, PoW<u8>) = bincode::deserialize(&message_ser).unwrap(); + assert_eq!(recieved_message, message); + assert!(config.is_sufficient_difficulty(&message.1, DIFFICULTY)); + assert!(config.is_valid_proof(&message.1, &target)); + } +} +
| "+""+(item.is_alias===true?(""+item.alias+" - see "):"")+item.displayPath+""+name+" | "+""+""+item.desc+" |
"+code.outerHTML+" |
fn:) to \
+ restrict the search to a given item kind.","Accepted kinds are: fn, mod, struct, \
+ enum, trait, type, macro, \
+ and const.","Search functions by type signature (e.g., vec -> usize or \
+ * -> vec)","Search multiple things at once by splitting your query with comma (e.g., \
+ str,u8 or String,struct:Vec,test)","You can look for items with an exact name by putting double quotes around \
+ your request: \"string\"","Look for items inside another one by searching for a path: vec::Vec",].map(x=>""+x+"
").join("");var div_infos=document.createElement("div");addClass(div_infos,"infos");div_infos.innerHTML="MCaptch's SHA256 based Proof of Work library
++ use pow_sha256::{ConfigBuilder, PoW}; + + fn main() { + let config = ConfigBuilder::default() + .salt("myrandomsaltisnotlongenoug".into()) + .build() + .unwrap(); + + let phrase = "ironmansucks"; + + const DIFFICULTY: u32 = 1000; + + let work = config.prove_work(&phrase, DIFFICULTY).unwrap(); + assert!(config.is_valid_proof(&work, &phrase)); + assert!(config.is_sufficient_difficulty(&work, DIFFICULTY)); + }
| Config | Configuration for generting proof of work +Please choose a long, unique value for salt +Resistance to dictionary/rainbow attacks depend on uniqueness +of the salt + |
| ConfigBuilder | Builder for |
| PoW | Proof of Work over concrete type T. T can be any type that implements serde::Serialize. + |
| PoWBuilder | Builder for |
Configuration for generting proof of work +Please choose a long, unique value for salt +Resistance to dictionary/rainbow attacks depend on uniqueness +of the salt
+salt: Stringimpl Config[src]pub fn prove_work<T>(&self, t: &T, difficulty: u32) -> Result<PoW<T>> where
T: Serialize, [src]Create Proof of Work over item of type T.
+Make sure difficulty is not too high. A 64 bit difficulty, +for example, takes a long time on a general purpose processor. +Returns bincode::Error if serialization fails.
+pub fn prove_work_serialized<T>(&self, prefix: &[u8], difficulty: u32) -> PoW<T> where
T: Serialize, [src]Create Proof of Work on an already serialized item of type T. +The input is assumed to be serialized using network byte order.
+Make sure difficulty is not too high. A 64 bit difficulty, +for example, takes a long time on a general purpose processor.
+pub fn calculate<T>(&self, pow: &PoW<T>, t: &T) -> Result<u128> where
T: Serialize, [src]Calculate the PoW score with the provided input T.
+pub fn calculate_serialized<T>(&self, pow: &PoW<T>, target: &[u8]) -> u128 where
T: Serialize, [src]Calculate the PoW score of an already serialized T and self. +The input is assumed to be serialized using network byte order.
+pub fn is_valid_proof<T>(&self, pow: &PoW<T>, t: &T) -> bool where
T: Serialize, [src]Verifies that the PoW is indeed generated out of the phrase provided.
+pub fn is_sufficient_difficulty<T>(
&self,
pow: &PoW<T>,
target_diff: u32
) -> bool where
T: Serialize, [src]Checks if the PoW result is of sufficient difficulty
+impl Clone for Config[src]impl Debug for Config[src]impl<'de> Deserialize<'de> for Config[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>, [src]impl PartialEq<Config> for Config[src]impl Serialize for Config[src]fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer, [src]impl StructuralPartialEq for Config[src]impl RefUnwindSafe for Config[src]impl Send for Config[src]impl Sync for Config[src]impl Unpin for Config[src]impl UnwindSafe for Config[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>, [src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]Builder for Config.
impl ConfigBuilder[src]pub fn salt(&mut self, value: String) -> &mut Self[src]pub fn build(&self) -> Result<Config, String>[src]impl Clone for ConfigBuilder[src]fn clone(&self) -> ConfigBuilder[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Default for ConfigBuilder[src]fn default() -> ConfigBuilder[src]impl RefUnwindSafe for ConfigBuilder[src]impl Send for ConfigBuilder[src]impl Sync for ConfigBuilder[src]impl Unpin for ConfigBuilder[src]impl UnwindSafe for ConfigBuilder[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]Proof of Work over concrete type T. T can be any type that implements serde::Serialize.
+nonce: u64result: Stringimpl<T: Clone> Clone for PoW<T>[src]impl<T: Debug> Debug for PoW<T>[src]impl<'de, T> Deserialize<'de> for PoW<T>[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>, [src]impl<T: PartialEq> PartialEq<PoW<T>> for PoW<T>[src]impl<T> Serialize for PoW<T>[src]fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer, [src]impl<T> StructuralPartialEq for PoW<T>[src]impl<T> RefUnwindSafe for PoW<T> where
T: RefUnwindSafe, [src]impl<T> Send for PoW<T> where
T: Send, [src]impl<T> Sync for PoW<T> where
T: Sync, [src]impl<T> Unpin for PoW<T> where
T: Unpin, [src]impl<T> UnwindSafe for PoW<T> where
T: UnwindSafe, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>, [src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]Builder for PoW.
impl<T: Clone> PoWBuilder<T>[src]pub fn nonce(&mut self, value: u64) -> &mut Self[src]pub fn result(&mut self, value: String) -> &mut Self[src]pub fn build(&self) -> Result<PoW<T>, String>[src]impl<T: Clone> Clone for PoWBuilder<T>[src]fn clone(&self) -> PoWBuilder<T>[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl<T: Default> Default for PoWBuilder<T>[src]fn default() -> PoWBuilder<T>[src]impl<T> RefUnwindSafe for PoWBuilder<T> where
T: RefUnwindSafe, [src]impl<T> Send for PoWBuilder<T> where
T: Send, [src]impl<T> Sync for PoWBuilder<T> where
T: Sync, [src]impl<T> Unpin for PoWBuilder<T> where
T: Unpin, [src]impl<T> UnwindSafe for PoWBuilder<T> where
T: UnwindSafe, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]PoW.",null,null],[11,"nonce","","",1,[[]]],[11,"result","","",1,[[["string",3]]]],[11,"build","","Builds a new PoW.",1,[[],[["pow",3],["string",3],["result",4]]]],[3,"Config","","Configuration for generting proof of work Please choose a …",null,null],[12,"salt","","",2,null],[3,"ConfigBuilder","","Builder for Config.",null,null],[11,"salt","","",3,[[["string",3]]]],[11,"build","","Builds a new Config.",3,[[],[["result",4],["string",3],["config",3]]]],[11,"prove_work","","Create Proof of Work over item of type T.",2,[[],[["result",6],["pow",3]]]],[11,"prove_work_serialized","","Create Proof of Work on an already serialized item of …",2,[[],["pow",3]]],[11,"calculate","","Calculate the PoW score with the provided input T.",2,[[["pow",3]],["result",6]]],[11,"calculate_serialized","","Calculate the PoW score of an already serialized T and …",2,[[["pow",3]]]],[11,"is_valid_proof","","Verifies that the PoW is indeed generated out of the …",2,[[["pow",3]]]],[11,"is_sufficient_difficulty","","Checks if the PoW result is of sufficient difficulty",2,[[["pow",3]]]],[11,"from","","",0,[[]]],[11,"into","","",0,[[]]],[11,"to_owned","","",0,[[]]],[11,"clone_into","","",0,[[]]],[11,"borrow","","",0,[[]]],[11,"borrow_mut","","",0,[[]]],[11,"try_from","","",0,[[],["result",4]]],[11,"try_into","","",0,[[],["result",4]]],[11,"type_id","","",0,[[],["typeid",3]]],[11,"from","","",1,[[]]],[11,"into","","",1,[[]]],[11,"to_owned","","",1,[[]]],[11,"clone_into","","",1,[[]]],[11,"borrow","","",1,[[]]],[11,"borrow_mut","","",1,[[]]],[11,"try_from","","",1,[[],["result",4]]],[11,"try_into","","",1,[[],["result",4]]],[11,"type_id","","",1,[[],["typeid",3]]],[11,"from","","",2,[[]]],[11,"into","","",2,[[]]],[11,"to_owned","","",2,[[]]],[11,"clone_into","","",2,[[]]],[11,"borrow","","",2,[[]]],[11,"borrow_mut","","",2,[[]]],[11,"try_from","","",2,[[],["result",4]]],[11,"try_into","","",2,[[],["result",4]]],[11,"type_id","","",2,[[],["typeid",3]]],[11,"from","","",3,[[]]],[11,"into","","",3,[[]]],[11,"to_owned","","",3,[[]]],[11,"clone_into","","",3,[[]]],[11,"borrow","","",3,[[]]],[11,"borrow_mut","","",3,[[]]],[11,"try_from","","",3,[[],["result",4]]],[11,"try_into","","",3,[[],["result",4]]],[11,"type_id","","",3,[[],["typeid",3]]],[11,"clone","","",1,[[],["powbuilder",3]]],[11,"clone","","",0,[[],["pow",3]]],[11,"clone","","",3,[[],["configbuilder",3]]],[11,"clone","","",2,[[],["config",3]]],[11,"default","","",1,[[],["powbuilder",3]]],[11,"default","","",3,[[],["configbuilder",3]]],[11,"eq","","",0,[[["pow",3]]]],[11,"ne","","",0,[[["pow",3]]]],[11,"eq","","",2,[[["config",3]]]],[11,"ne","","",2,[[["config",3]]]],[11,"fmt","","",0,[[["formatter",3]],["result",6]]],[11,"fmt","","",2,[[["formatter",3]],["result",6]]],[11,"serialize","","",0,[[],["result",4]]],[11,"serialize","","",2,[[],["result",4]]],[11,"deserialize","","",0,[[],["result",4]]],[11,"deserialize","","",2,[[],["result",4]]]],"p":[[3,"PoW"],[3,"PoWBuilder"],[3,"Config"],[3,"ConfigBuilder"]]}\
+}');
+addSearchOptions(searchIndex);initSearch(searchIndex);
\ No newline at end of file
diff --git a/static/api-docs/pow_sha256/0.2.0/settings.css b/static/api-docs/pow_sha256/0.2.0/settings.css
new file mode 100644
index 0000000..6709865
--- /dev/null
+++ b/static/api-docs/pow_sha256/0.2.0/settings.css
@@ -0,0 +1 @@
+.setting-line{padding:5px;position:relative;}.setting-line>div{display:inline-block;vertical-align:top;font-size:17px;padding-top:2px;}.setting-line>.title{font-size:19px;width:100%;max-width:none;border-bottom:1px solid;}.toggle{position:relative;display:inline-block;width:45px;height:27px;margin-right:20px;}.toggle input{opacity:0;position:absolute;}.select-wrapper{float:right;position:relative;height:27px;min-width:25%;}.select-wrapper select{appearance:none;-moz-appearance:none;-webkit-appearance:none;background:none;border:2px solid #ccc;padding-right:28px;width:100%;}.select-wrapper img{pointer-events:none;position:absolute;right:0;bottom:0;background:#ccc;height:100%;width:28px;padding:0px 4px;}.select-wrapper select option{color:initial;}.slider{position:absolute;cursor:pointer;top:0;left:0;right:0;bottom:0;background-color:#ccc;-webkit-transition:.3s;transition:.3s;}.slider:before{position:absolute;content:"";height:19px;width:19px;left:4px;bottom:4px;background-color:white;-webkit-transition:.3s;transition:.3s;}input:checked+.slider{background-color:#2196F3;}input:focus+.slider{box-shadow:0 0 0 2px #0a84ff,0 0 0 6px rgba(10,132,255,0.3);}input:checked+.slider:before{-webkit-transform:translateX(19px);-ms-transform:translateX(19px);transform:translateX(19px);}.setting-line>.sub-settings{padding-left:42px;width:100%;display:block;}
\ No newline at end of file
diff --git a/static/api-docs/pow_sha256/0.2.0/settings.html b/static/api-docs/pow_sha256/0.2.0/settings.html
new file mode 100644
index 0000000..334fa30
--- /dev/null
+++ b/static/api-docs/pow_sha256/0.2.0/settings.html
@@ -0,0 +1,6 @@
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +
+//! MCaptch's SHA256 based Proof of Work library +//! +//! # Example: +//! ```rust +//! use pow_sha256::{ConfigBuilder, PoW}; +//! +//! fn main() { +//! let config = ConfigBuilder::default() +//! .salt("myrandomsaltisnotlongenoug".into()) +//! .build() +//! .unwrap(); +//! +//! let phrase = "ironmansucks"; +//! +//! const DIFFICULTY: u32 = 1000; +//! +//! let work = config.prove_work(&phrase, DIFFICULTY).unwrap(); +//! assert!(config.is_valid_proof(&work, &phrase)); +//! assert!(config.is_sufficient_difficulty(&work, DIFFICULTY)); +//! } +//! ``` + +use std::marker::PhantomData; + +use derive_builder::Builder; +use serde::{Deserialize, Serialize}; +use sha2::{Digest, Sha256}; + +/// Proof of Work over concrete type T. T can be any type that implements serde::Serialize. +#[derive(Serialize, Builder, Deserialize, PartialEq, Clone, Debug)] +pub struct PoW<T> { + pub nonce: u64, + pub result: String, + #[builder(default = "PhantomData", setter(skip))] + _spook: PhantomData<T>, +} + +/// Configuration for generting proof of work +/// Please choose a long, unique value for salt +/// Resistance to dictionary/rainbow attacks depend on uniqueness +/// of the salt +#[derive(Serialize, Deserialize, Builder, PartialEq, Clone, Debug)] +pub struct Config { + pub salt: String, +} + +impl Config { + /// Create Proof of Work over item of type T. + /// + /// Make sure difficulty is not too high. A 64 bit difficulty, + /// for example, takes a long time on a general purpose processor. + /// Returns bincode::Error if serialization fails. + pub fn prove_work<T>(&self, t: &T, difficulty: u32) -> bincode::Result<PoW<T>> + where + T: Serialize, + { + bincode::serialize(t).map(|v| self.prove_work_serialized(&v, difficulty)) + } + + /// Create Proof of Work on an already serialized item of type T. + /// The input is assumed to be serialized using network byte order. + /// + /// Make sure difficulty is not too high. A 64 bit difficulty, + /// for example, takes a long time on a general purpose processor. + pub fn prove_work_serialized<T>(&self, prefix: &[u8], difficulty: u32) -> PoW<T> + where + T: Serialize, + { + let prefix_sha = Sha256::new().chain(&self.salt).chain(prefix); + let mut n = 0; + let mut result = 0; + while result < get_difficulty(difficulty) { + n += 1; + result = score(prefix_sha.clone(), n); + } + PoW { + nonce: n, + result: result.to_string(), + _spook: PhantomData, + } + } + + /// Calculate the PoW score with the provided input T. + pub fn calculate<T>(&self, pow: &PoW<T>, t: &T) -> bincode::Result<u128> + where + T: Serialize, + { + bincode::serialize(t).map(|v| self.calculate_serialized(pow, &v)) + } + + /// Calculate the PoW score of an already serialized T and self. + /// The input is assumed to be serialized using network byte order. + pub fn calculate_serialized<T>(&self, pow: &PoW<T>, target: &[u8]) -> u128 + where + T: Serialize, + { + score(Sha256::new().chain(&self.salt).chain(target), pow.nonce) + } + + /// Verifies that the PoW is indeed generated out of the phrase provided. + pub fn is_valid_proof<T>(&self, pow: &PoW<T>, t: &T) -> bool + where + T: Serialize, + { + match self.calculate(pow, t) { + Ok(res) => { + return if pow.result == res.to_string() { + true + } else { + false + } + } + Err(_) => return false, + } + } + + /// Checks if the PoW result is of sufficient difficulty + pub fn is_sufficient_difficulty<T>(&self, pow: &PoW<T>, target_diff: u32) -> bool + where + T: Serialize, + { + match pow.result.parse::<u128>() { + Ok(res) => return res >= get_difficulty(target_diff), + Err(_) => return false, + } + } +} + +fn score(prefix_sha: Sha256, nonce: u64) -> u128 { + first_bytes_as_u128( + prefix_sha + .chain(&nonce.to_be_bytes()) // to_be_bytes() converts to network endian + .finalize() + .as_slice(), + ) +} + +/// # Panics +/// +/// panics if inp.len() < 16 +fn first_bytes_as_u128(inp: &[u8]) -> u128 { + bincode::deserialize(&inp).unwrap() +} + +// utility function to get u128 difficulty factor from u32 +// javacript isn't capable of represnting u128 so +fn get_difficulty(difficulty_factor: u32) -> u128 { + u128::max_value() - u128::max_value() / difficulty_factor as u128 +} + +#[cfg(test)] +mod test { + use super::*; + + const DIFFICULTY: u32 = 1000; + + fn get_config() -> Config { + ConfigBuilder::default() + .salt( + "79ziepia7vhjgviiwjhnend3ofjqocsi2winc4ptqhmkvcajihywxcizewvckg9h6gs4j83v9".into(), + ) + .build() + .unwrap() + } + + #[test] + fn base_functionality() { + // Let's prove we did work targeting a phrase. + let phrase = b"Ex nihilo nihil fit.".to_vec(); + let config = get_config(); + let pw = config.prove_work(&phrase, DIFFICULTY).unwrap(); + assert!(config.calculate(&pw, &phrase).unwrap() >= get_difficulty(DIFFICULTY)); + assert!(config.is_valid_proof(&pw, &phrase)); + assert!(config.is_sufficient_difficulty(&pw, DIFFICULTY)); + } + + #[test] + fn double_pow() { + let phrase = "Ex nihilo nihil fit.".to_owned(); + let config = get_config(); + + let pw = config.prove_work(&phrase, DIFFICULTY).unwrap(); + let pwpw = config.prove_work(&pw, DIFFICULTY).unwrap(); + + assert!(config.calculate(&pw, &phrase).unwrap() >= get_difficulty(DIFFICULTY)); + assert!(config.is_valid_proof(&pw, &phrase)); + assert!(config.is_sufficient_difficulty(&pw, DIFFICULTY)); + + assert!(config.calculate(&pwpw, &pw).unwrap() >= get_difficulty(DIFFICULTY)); + assert!(config.is_valid_proof(&pwpw, &pw)); + assert!(config.is_sufficient_difficulty(&pwpw, DIFFICULTY)); + } + + #[test] + fn is_not_valid_proof() { + let phrase = "Ex nihilo nihil fit.".to_owned(); + let phrase2 = "Omne quod movetur ab alio movetur.".to_owned(); + + let config = get_config(); + let pw = config.prove_work(&phrase, DIFFICULTY).unwrap(); + + let pw2 = config.prove_work(&phrase2, DIFFICULTY).unwrap(); + + assert!(!config.is_valid_proof(&pw, &phrase2)); + assert!(!config.is_valid_proof(&pw2, &phrase)); + } + + #[test] + fn serialization_test() { + let target: u8 = 1; + let config = get_config(); + let pw = config.prove_work(&target, DIFFICULTY).unwrap(); + + let message: (u8, PoW<u8>) = (target, pw); + let message_ser = bincode::serialize(&message).unwrap(); + let recieved_message: (u8, PoW<u8>) = bincode::deserialize(&message_ser).unwrap(); + assert_eq!(recieved_message, message); + assert!(config.is_sufficient_difficulty(&message.1, DIFFICULTY)); + assert!(config.is_valid_proof(&message.1, &target)); + } +} +