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
/*
* 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>
+ actix::Handler<messages::RemoveCaptcha>
+ actix::Handler<messages::SetInternalData>
+ actix::Handler<messages::GetInternalData>
{
}
#[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::collections::HashMap;
// use std::sync::mpsc::Receiver;
use actix::dev::*;
use derive_builder::Builder;
use serde::{Deserialize, Serialize};
use tokio::sync::oneshot::Receiver;
use crate::errors::CaptchaResult;
use crate::mcaptcha::MCaptcha;
/// Message to add visitor to an [MCaptcha] actor
#[derive(Message, Clone, Debug, Deserialize, Serialize)]
#[rtype(result = "Receiver<CaptchaResult<Option<super::AddVisitorResult>>>")]
pub struct AddVisitor(pub String);
/// Message to add an [Counter] actor to [Master]
#[derive(Message, Builder, Clone, Debug, Deserialize, Serialize)]
#[rtype(result = "Receiver<CaptchaResult<()>>")]
pub struct AddSite {
pub id: String,
pub mcaptcha: MCaptcha,
}
/// Message to rename an MCaptcha actor
#[derive(Message, Builder, Clone, Debug, Deserialize, Serialize)]
#[rtype(result = "Receiver<CaptchaResult<()>>")]
pub struct Rename {
pub name: String,
pub rename_to: String,
}
/// Message to delete [Counter] actor
#[derive(Message, Clone, Debug, Deserialize, Serialize)]
#[rtype(result = "Receiver<CaptchaResult<()>>")]
pub struct RemoveCaptcha(pub String);
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct InternalData {
pub name: String,
pub mcaptcha: MCaptcha,
}
/// Gets internal Captcha data
#[derive(Message)]
#[rtype(result = "Receiver<CaptchaResult<HashMap<String, MCaptcha>>>")]
pub struct GetInternalData;
/// Sets internal Captcha data
#[derive(Message)]
#[rtype(result = "Receiver<CaptchaResult<()>>")]
pub struct SetInternalData {
pub mcaptcha: HashMap<String, MCaptcha>,
}
}