    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

    /*
     * Copyright (C) 2022  Aravinth Manivannan <realaravinth@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 <https://www.gnu.org/licenses/>.
     */

    //use actix::prelude::*;
    use actix_web::{web, HttpResponse, Responder};
    use libmcaptcha::{
        defense::LevelBuilder, master::messages::AddSiteBuilder, DefenseBuilder,
        MCaptchaBuilder,
    };
    use serde::{Deserialize, Serialize};

    use crate::errors::*;
    //use crate::stats::record::record_fetch;
    use crate::AppData;
    use crate::V1_API_ROUTES;

    #[derive(Clone, Debug, Deserialize, Serialize)]
    pub struct GetConfigPayload {
        pub key: String,
    }

    // API keys are mcaptcha actor names

    /// get PoW configuration for an mcaptcha key
    #[my_codegen::post(path = "V1_API_ROUTES.pow.get_config()")]
    pub async fn get_config(
        payload: web::Json<GetConfigPayload>,
        data: AppData,
    ) -> ServiceResult<impl Responder> {
        //if res.exists.is_none() {
        if !data.db.captcha_exists(None, &payload.key).await? {
            return Err(ServiceError::TokenNotFound);
        }
        let payload = payload.into_inner();

        match data.captcha.get_pow(payload.key.clone()).await {
            Ok(Some(config)) => {
                data.stats.record_fetch(&data, &payload.key).await?;
                Ok(HttpResponse::Ok().json(config))
            }
            Ok(None) => {
                init_mcaptcha(&data, &payload.key).await?;
                let config = data
                    .captcha
                    .get_pow(payload.key.clone())
                    .await
                    .expect("mcaptcha should be initialized and ready to go");
                // background it. would require data::Data to be static
                // to satidfy lifetime
                data.stats.record_fetch(&data, &payload.key).await?;
                Ok(HttpResponse::Ok().json(config))
            }
            Err(e) => Err(e.into()),
        }

        //    match res.exists {
        //        Some(true) => {
        //            match data.captcha.get_pow(payload.key.clone()).await {
        //                Ok(Some(config)) => {
        //                    record_fetch(&payload.key, &data.db).await;
        //                    Ok(HttpResponse::Ok().json(config))
        //                }
        //                Ok(None) => {
        //                    init_mcaptcha(&data, &payload.key).await?;
        //                    let config = data
        //                        .captcha
        //                        .get_pow(payload.key.clone())
        //                        .await
        //                        .expect("mcaptcha should be initialized and ready to go");
        //                    // background it. would require data::Data to be static
        //                    // to satidfy lifetime
        //                    record_fetch(&payload.key, &data.db).await;
        //                    Ok(HttpResponse::Ok().json(config))
        //                }
        //                Err(e) => Err(e.into()),
        //            }
        //        }
        //
        //        Some(false) => Err(ServiceError::TokenNotFound),
        //        None => Err(ServiceError::TokenNotFound),
        //    }
    }
    /// Call this when [MCaptcha][libmcaptcha::MCaptcha] is not in master.
    ///
    /// This fn gets mcaptcha config from database, builds [Defense][libmcaptcha::Defense],
    /// creates [MCaptcha][libmcaptcha::MCaptcha] and adds it to [Master][libmcaptcha::Defense]
    pub async fn init_mcaptcha(data: &AppData, key: &str) -> ServiceResult<()> {
        println!("Initializing captcha");
        // get levels
        let levels = data.db.get_captcha_levels(None, key).await?;
        let duration = data.db.get_captcha_cooldown(key).await?;

        // build defense
        let mut defense = DefenseBuilder::default();

        for level in levels.iter() {
            let level = LevelBuilder::default()
                .visitor_threshold(level.visitor_threshold as u32)
                .difficulty_factor(level.difficulty_factor as u32)
                .unwrap()
                .build()
                .unwrap();
            defense.add_level(level).unwrap();
        }

        let defense = defense.build()?;
        println!("{:?}", defense);

        // create captcha
        let mcaptcha = MCaptchaBuilder::default()
            .defense(defense)
            // leaky bucket algorithm's emission interval
            .duration(duration as u64)
            //   .cache(cache)
            .build()
            .unwrap();

        // add captcha to master
        let msg = AddSiteBuilder::default()
            .id(key.into())
            .mcaptcha(mcaptcha)
            .build()
            .unwrap();

        data.captcha.add_site(msg).await?;

        Ok(())
    }

    #[cfg(test)]
    pub mod tests {
        use crate::*;
        use libmcaptcha::pow::PoWConfig;

        #[actix_rt::test]
        async fn get_pow_config_works_pg() {
            let data = crate::tests::pg::get_data().await;
            get_pow_config_works(data).await;
        }

        #[actix_rt::test]
        async fn get_pow_config_works_maria() {
            let data = crate::tests::maria::get_data().await;
            get_pow_config_works(data).await;
        }

        pub async fn get_pow_config_works(data: ArcData) {
            use super::*;
            use crate::tests::*;
            use crate::*;
            use actix_web::test;

            const NAME: &str = "powusrworks";
            const PASSWORD: &str = "testingpas";
            const EMAIL: &str = "randomuser@a.com";

            let data = &data;

            delete_user(data, NAME).await;

            register_and_signin(data, NAME, EMAIL, PASSWORD).await;
            let (_, _signin_resp, token_key) = add_levels_util(data, NAME, PASSWORD).await;
            let app = get_app!(data).await;

            let get_config_payload = GetConfigPayload {
                key: token_key.key.clone(),
            };

            // update and check changes

            let url = V1_API_ROUTES.pow.get_config;
            println!("{}", &url);
            let get_config_resp = test::call_service(
                &app,
                post_request!(&get_config_payload, V1_API_ROUTES.pow.get_config)
                    .to_request(),
            )
            .await;
            assert_eq!(get_config_resp.status(), StatusCode::OK);
            let config: PoWConfig = test::read_body_json(get_config_resp).await;
            assert_eq!(config.difficulty_factor, L1.difficulty_factor);
        }

        #[actix_rt::test]
        async fn pow_difficulty_factor_increases_on_visitor_count_increase_pg() {
            let data = crate::tests::pg::get_data().await;
            pow_difficulty_factor_increases_on_visitor_count_increase(data).await;
        }

        #[actix_rt::test]
        async fn pow_difficulty_factor_increases_on_visitor_count_increase_maria() {
            let data = crate::tests::maria::get_data().await;
            pow_difficulty_factor_increases_on_visitor_count_increase(data).await;
        }

        pub async fn pow_difficulty_factor_increases_on_visitor_count_increase(
            data: ArcData,
        ) {
            use super::*;
            use crate::tests::*;
            use crate::*;
            use actix_web::test;

            use libmcaptcha::defense::Level;

            use crate::api::v1::mcaptcha::create::CreateCaptcha;
            use crate::api::v1::mcaptcha::create::MCaptchaDetails;

            const NAME: &str = "powusrworks2";
            const PASSWORD: &str = "testingpas";
            const EMAIL: &str = "randomuser2@a.com";
            pub const L1: Level = Level {
                difficulty_factor: 10,
                visitor_threshold: 10,
            };
            pub const L2: Level = Level {
                difficulty_factor: 20,
                visitor_threshold: 20,
            };

            pub const L3: Level = Level {
                difficulty_factor: 30,
                visitor_threshold: 30,
            };

            let data = &data;
            let levels = [L1, L2, L3];

            delete_user(data, NAME).await;

            let (_, signin_resp) = register_and_signin(data, NAME, EMAIL, PASSWORD).await;
            let cookies = get_cookie!(signin_resp);
            let app = get_app!(data).await;

            let create_captcha = CreateCaptcha {
                levels: levels.into(),
                duration: 30,
                description: "dummy".into(),
            };

            // 1. add level
            let add_token_resp = test::call_service(
                &app,
                post_request!(&create_captcha, V1_API_ROUTES.captcha.create)
                    .cookie(cookies.clone())
                    .to_request(),
            )
            .await;
            assert_eq!(add_token_resp.status(), StatusCode::OK);
            let token_key: MCaptchaDetails = test::read_body_json(add_token_resp).await;

            let get_config_payload = GetConfigPayload {
                key: token_key.key.clone(),
            };

            let url = V1_API_ROUTES.pow.get_config;
            let mut prev = 0;
            for (count, l) in levels.iter().enumerate() {
                for l in prev..l.visitor_threshold * 2 {
                    let get_config_resp = test::call_service(
                        &app,
                        post_request!(&get_config_payload, V1_API_ROUTES.pow.get_config)
                            .to_request(),
                    )
                    .await;
                }

                let get_config_resp = test::call_service(
                    &app,
                    post_request!(&get_config_payload, V1_API_ROUTES.pow.get_config)
                        .to_request(),
                )
                .await;

                let config: PoWConfig = test::read_body_json(get_config_resp).await;
                println!(
                    "[{count}] received difficulty_factor: {} prev difficulty_factor {}",
                    config.difficulty_factor, prev
                );
                if count == levels.len() - 1 {
                    assert!(config.difficulty_factor == prev);
                } else {
                    assert!(config.difficulty_factor > prev);
                }
                prev = config.difficulty_factor;
            }
            // update and check changes
        }
    }