      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

    /*
     * 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::AddVisitor, 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(AddVisitor).await.unwrap();
    //!
    //!     Ok(())
    //! }
    //! ```

    use std::time::Duration;

    //use actix::clock::sleep;
    use actix::dev::*;
    use serde::{Deserialize, Serialize};

    use crate::{
        defense::Defense,
        errors::{CaptchaError, CaptchaResult},
    };

    /// Builder for [MCaptcha]
    #[derive(Clone, Serialize, Deserialize, Debug)]
    pub struct MCaptchaBuilder {
        visitor_threshold: u32,
        defense: Option<Defense>,
        duration: Option<u64>,
    }

    impl Default for MCaptchaBuilder {
        fn default() -> Self {
            MCaptchaBuilder {
                visitor_threshold: 0,
                defense: None,
                duration: None,
            }
        }
    }

    /// This struct represents the mCaptcha state and is used
    /// to configure leaky-bucket lifetime and manage defense
    #[derive(Clone, Serialize, Deserialize, Debug)]
    pub struct MCaptcha {
        visitor_threshold: u32,
        defense: Defense,
        duration: u64,
    }

    impl MCaptchaBuilder {
        /// set defense
        pub fn defense(&mut self, d: Defense) -> &mut Self {
            self.defense = Some(d);
            self
        }

        /// set duration
        pub fn duration(&mut self, d: u64) -> &mut Self {
            self.duration = Some(d);
            self
        }

        /// Builds new [MCaptcha]
        pub fn build(&mut self) -> CaptchaResult<MCaptcha> {
            if self.duration.is_none() {
                Err(CaptchaError::PleaseSetValue("duration".into()))
            } else if self.defense.is_none() {
                Err(CaptchaError::PleaseSetValue("defense".into()))
            } else if self.duration <= Some(0) {
                Err(CaptchaError::CaptchaDurationZero)
            } else {
                let m = MCaptcha {
                    duration: self.duration.unwrap(),
                    defense: self.defense.clone().unwrap(),
                    visitor_threshold: self.visitor_threshold,
                };
                Ok(m)
            }
        }
    }

    impl MCaptcha {
        /// increments the visitor 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();
            }
        }

        /// decrements the visitor count by one
        pub fn decrement_visitor(&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_visitor();
        }
    }

    /// Message to increment the visitor count
    /// returns difficulty factor and lifetime
    #[derive(Message)]
    #[rtype(result = "AddVisitorResult")]
    pub struct AddVisitor;

    /// 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 {
        fn new(m: &MCaptcha) -> Self {
            AddVisitorResult {
                duration: m.get_duration(),
                difficulty_factor: m.get_difficulty(),
            }
        }
    }

    impl Handler<AddVisitor> for MCaptcha {
        type Result = MessageResult<AddVisitor>;

        fn handle(&mut self, _: AddVisitor, ctx: &mut Self::Context) -> Self::Result {
            let addr = ctx.address();
            use actix::clock::delay_for;

            let duration: Duration = Duration::new(self.duration.clone(), 0);
            let wait_for = async move {
                //sleep(duration).await;
                delay_for(duration).await;
                addr.send(DeleteVisitor).await.unwrap();
            }
            .into_actor(self);
            ctx.spawn(wait_for);

            self.add_visitor();
            MessageResult(AddVisitorResult::new(&self))
        }
    }

    /// Message to get the visitor count
    #[derive(Message)]
    #[rtype(result = "u32")]
    pub struct GetCurrentVisitorCount;

    impl Handler<GetCurrentVisitorCount> for MCaptcha {
        type Result = MessageResult<GetCurrentVisitorCount>;

        fn handle(&mut self, _: GetCurrentVisitorCount, _ctx: &mut Self::Context) -> Self::Result {
            MessageResult(self.visitor_threshold)
        }
    }

    /// Message to stop [MCaptcha]
    #[derive(Message)]
    #[rtype(result = "()")]
    pub struct Stop;

    impl Handler<Stop> for MCaptcha {
        type Result = ();

        fn handle(&mut self, _: Stop, ctx: &mut Self::Context) -> Self::Result {
            ctx.stop()
        }
    }

    #[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 = 5;

        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(AddVisitor).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(AddVisitor).await.unwrap();
            assert_eq!(mcaptcha.difficulty_factor, LEVEL_1.0);

            race(addr.clone(), LEVEL_2).await;
            mcaptcha = addr.send(AddVisitor).await.unwrap();
            assert_eq!(mcaptcha.difficulty_factor, LEVEL_2.1);
        }

        #[actix_rt::test]
        async fn counter_defense_loosenup_works() {
            //use actix::clock::sleep;
            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(AddVisitor).await.unwrap();
            assert_eq!(mcaptcha.difficulty_factor, LEVEL_2.1);

            let duration = Duration::new(DURATION, 0);
            //sleep(duration).await;
            delay_for(duration).await;

            mcaptcha = addr.send(AddVisitor).await.unwrap();
            assert_eq!(mcaptcha.difficulty_factor, LEVEL_1.1);
        }

        #[test]
        fn test_mcatcptha_builder() {
            let defense = get_defense();
            let m = MCaptchaBuilder::default()
                .duration(0)
                .defense(defense.clone())
                .build();

            assert_eq!(m.err(), Some(CaptchaError::CaptchaDurationZero));

            let m = MCaptchaBuilder::default().duration(30).build();
            assert_eq!(
                m.err(),
                Some(CaptchaError::PleaseSetValue("defense".into()))
            );

            let m = MCaptchaBuilder::default().defense(defense.clone()).build();
            assert_eq!(
                m.err(),
                Some(CaptchaError::PleaseSetValue("duration".into()))
            );
        }

        #[actix_rt::test]
        async fn get_current_visitor_count_works() {
            let addr: MyActor = get_counter().start();

            addr.send(AddVisitor).await.unwrap();
            addr.send(AddVisitor).await.unwrap();
            addr.send(AddVisitor).await.unwrap();
            addr.send(AddVisitor).await.unwrap();
            let count = addr.send(GetCurrentVisitorCount).await.unwrap();

            assert_eq!(count, 4);
        }

        #[actix_rt::test]
        #[should_panic]
        async fn stop_works() {
            let addr: MyActor = get_counter().start();
            addr.send(Stop).await.unwrap();
            addr.send(AddVisitor).await.unwrap();
        }
    }