forked from bot/tmp2
87 lines
3.1 KiB
Rust
87 lines
3.1 KiB
Rust
/*
|
|
* 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,
|
|
|
|
/// captcha cooldown duration must be greater than 0
|
|
#[display(fmt = "difficulty factor must be greater than zero")]
|
|
CaptchaDurationZero,
|
|
|
|
/// 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,
|
|
|
|
/// Happens when submitted work is computed over configuration intended for
|
|
/// a different mCAptcha sitekey
|
|
#[display(fmt = "PoW computed over configuration not intended for target sitekey")]
|
|
MCaptchaKeyValidationFail,
|
|
|
|
/// Submitted PoW is invalid
|
|
#[display(fmt = "Invalid PoW")]
|
|
InvalidPoW,
|
|
|
|
/// Used in builder structs when a value is not set
|
|
#[display(fmt = "Please set value: {}", _0)]
|
|
PleaseSetValue(#[error(not(source))] String),
|
|
}
|
|
|
|
/// [Result] datatype for m_captcha
|
|
pub type CaptchaResult<V> = std::result::Result<V, CaptchaError>;
|