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

/*
 * 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
use serde::{Deserialize, Serialize};

#[cfg(feature = "full")]
pub mod hashcache;
#[cfg(feature = "full")]
pub mod redis;

#[derive(Serialize, Deserialize)]
pub struct AddChallenge {
    pub difficulty: u32,
    pub duration: u64,
    pub challenge: String,
}

/// Describes actor handler trait impls that are required by a cache implementation
#[cfg(feature = "full")]
pub trait Save:
    actix::Actor
    + actix::Handler<messages::RetrivePoW>
    + actix::Handler<messages::CachePoW>
    + actix::Handler<messages::DeletePoW>
    + actix::Handler<messages::CacheResult>
    + actix::Handler<messages::VerifyCaptchaResult>
    + actix::Handler<messages::DeleteCaptchaResult>
{
}

#[cfg(feature = "full")]
pub mod messages {
    //! Messages that can be sent to cache data structures implementing [Save][super::Save]
    use actix::dev::*;
    use derive_builder::Builder;
    use serde::{Deserialize, Serialize};
    use tokio::sync::oneshot::Receiver;

    use crate::errors::*;

    /// Message to cache PoW difficulty factor and string
    #[derive(Message, Serialize, Deserialize, Builder, Clone)]
    #[rtype(result = "Receiver<CaptchaResult<()>>")]
    pub struct CachePoW {
        /// challenge string
        pub string: String,
        /// Difficulty factor of mCaptcha at the time of minting this config
        pub difficulty_factor: u32,
        /// mCaptcha TTL
        pub duration: u64,
        /// Key is mCaptcha name
        pub key: String,
    }

    /// Message to retrive the the difficulty factor for the specified
    /// string from the cache
    #[derive(Message)]
    #[rtype(result = "Receiver<CaptchaResult<Option<CachedPoWConfig>>>")]
    pub struct RetrivePoW(pub VerifyCaptchaResult);

    #[derive(Clone, PartialEq, Debug, Default, Deserialize, Serialize)]
    pub struct CachedPoWConfig {
        /// mCaptcha name
        pub key: String,
        pub difficulty_factor: u32,
        pub duration: u64,
    }

    /// Message to delete cached PoW difficulty factor and string
    /// when they expire
    #[derive(Message)]
    #[rtype(result = "CaptchaResult<()>")]
    pub struct DeletePoW(pub String);

    /// Message to cache captcha result and the captcha key for which
    /// it was generated
    #[derive(Message, Serialize, Deserialize, Builder)]
    #[rtype(result = "Receiver<CaptchaResult<()>>")]
    pub struct CacheResult {
        pub token: String,
        /// key is mCaptcha identifier
        pub key: String,
        pub duration: u64,
    }

    impl From<CachedPoWConfig> for CacheResult {
        fn from(c: CachedPoWConfig) -> Self {
            use crate::utils::get_random;

            CacheResultBuilder::default()
                .key(c.key)
                .duration(c.duration)
                .token(get_random(32))
                .build()
                .unwrap()
        }
    }

    /// Message to verify captcha result against
    /// the stored captcha key
    #[derive(Message, Clone, Deserialize, Serialize)]
    #[rtype(result = "Receiver<CaptchaResult<bool>>")]
    pub struct VerifyCaptchaResult {
        pub token: String,
        pub key: String,
    }

    /// Message to delete cached capthca result when it expires
    #[derive(Message)]
    #[rtype(result = "CaptchaResult<()>")]
    pub struct DeleteCaptchaResult {
        pub token: String,
    }
}