forked from realaravinth/tmp
97 lines
2.9 KiB
Rust
97 lines
2.9 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/>.
|
|
*/
|
|
//! [Master] actor module that manages [MCaptcha] actors
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::mcaptcha::*;
|
|
|
|
#[cfg(feature = "full")]
|
|
pub mod embedded;
|
|
#[cfg(feature = "full")]
|
|
pub mod redis;
|
|
|
|
#[cfg(feature = "full")]
|
|
/// Describes actor handler trait impls that are required by a cache implementation
|
|
pub trait Master:
|
|
actix::Actor
|
|
+ actix::Handler<messages::AddVisitor>
|
|
+ actix::Handler<messages::AddSite>
|
|
+ actix::Handler<messages::Rename>
|
|
{
|
|
}
|
|
|
|
#[derive(Serialize, Deserialize)]
|
|
/// [mCaptcha Redis module](https://github.com/mCaptcha/cache) uses this datatype for CAPTCHA
|
|
/// registration
|
|
pub struct CreateMCaptcha {
|
|
pub levels: Vec<crate::defense::Level>,
|
|
pub duration: u64,
|
|
}
|
|
|
|
/// Struct representing the return datatime of
|
|
/// [AddVisitor] message. Contains MCaptcha lifetime
|
|
/// and difficulty factor
|
|
#[derive(Debug, Clone, Deserialize, Serialize)]
|
|
pub struct AddVisitorResult {
|
|
pub duration: u64,
|
|
pub difficulty_factor: u32,
|
|
}
|
|
|
|
impl AddVisitorResult {
|
|
/// create new [AddVisitorResult] from [MCaptcha]
|
|
pub fn new(m: &MCaptcha) -> Self {
|
|
AddVisitorResult {
|
|
duration: m.get_duration(),
|
|
difficulty_factor: m.get_difficulty(),
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "full")]
|
|
pub mod messages {
|
|
//! Messages that a [super::Master] should respond to
|
|
// use std::sync::mpsc::Receiver;
|
|
|
|
use actix::dev::*;
|
|
use derive_builder::Builder;
|
|
use tokio::sync::oneshot::Receiver;
|
|
|
|
use crate::errors::CaptchaResult;
|
|
use crate::mcaptcha::MCaptcha;
|
|
|
|
/// Message to add visitor to an [MCaptcha] actor
|
|
#[derive(Message, Clone)]
|
|
#[rtype(result = "Receiver<CaptchaResult<Option<super::AddVisitorResult>>>")]
|
|
pub struct AddVisitor(pub String);
|
|
|
|
/// Message to add an [Counter] actor to [Master]
|
|
#[derive(Message, Builder)]
|
|
#[rtype(result = "Receiver<CaptchaResult<()>>")]
|
|
pub struct AddSite {
|
|
pub id: String,
|
|
pub mcaptcha: MCaptcha,
|
|
}
|
|
|
|
#[derive(Message, Builder)]
|
|
#[rtype(result = "Receiver<CaptchaResult<()>>")]
|
|
pub struct Rename {
|
|
pub name: String,
|
|
pub rename_to: String,
|
|
}
|
|
}
|