# pow.rs - source
Source of the Rust file `src/api/v1/mcaptcha/pow.rs`.
Keywords: rust, rustlang, rust-lang

      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

    /*
    * Copyright (C) 2021  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_identity::Identity;
    use actix_web::{post, web, HttpResponse, Responder};
    use m_captcha::{defense::LevelBuilder, master::AddSiteBuilder, DefenseBuilder, MCaptchaBuilder};
    use serde::{Deserialize, Serialize};

    use super::duration::GetDurationResp;
    use super::is_authenticated;
    use super::levels::I32Levels;
    use crate::errors::*;
    use crate::Data;

    #[derive(Clone, Debug, Deserialize, Serialize)]
    pub struct PoWConfig {
        pub name: String,
        pub domain: String,
    }

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

    // API keys are mcaptcha actor names

    #[post("/api/v1/mcaptcha/pow/config")]
    pub async fn get_config(
        payload: web::Json<GetConfigPayload>,
        data: web::Data<Data>,
        id: Identity,
    ) -> ServiceResult<impl Responder> {
        is_authenticated(&id)?;

        let res = sqlx::query!(
            "SELECT EXISTS (SELECT 1 from mcaptcha_config WHERE key = $1)",
            &payload.key,
        )
        .fetch_one(&data.db)
        .await?;

        if res.exists.is_none() {
            return Err(ServiceError::TokenNotFound);
        }
        let payload = payload.into_inner();
        match res.exists {
            Some(true) => {
                ();
                match data.captcha.get_pow(payload.key.clone()).await {
                    Some(config) => Ok(HttpResponse::Ok().json(config)),
                    None => {
                        init_mcaptcha(&data, &payload.key).await?;
                        let config = data
                            .captcha
                            .get_pow(payload.key)
                            .await
                            .expect("mcaptcha should be initialized and ready to go");
                        Ok(HttpResponse::Ok().json(config))
                    }
                }
            }

            Some(false) => Err(ServiceError::TokenNotFound),
            None => Err(ServiceError::TokenNotFound),
        }
    }

    async fn init_mcaptcha(data: &Data, key: &str) -> ServiceResult<()> {
        // get levels
        let levels_fut = sqlx::query_as!(
            I32Levels,
            "SELECT difficulty_factor, visitor_threshold FROM mcaptcha_levels  WHERE
                config_id = (
                    SELECT config_id FROM mcaptcha_config WHERE key = ($1)
                    );",
            &key,
        )
        .fetch_all(&data.db);
        // get duration
        let duration_fut = sqlx::query_as!(
            GetDurationResp,
            "SELECT duration FROM mcaptcha_config
            WHERE key = $1",
            &key,
        )
        .fetch_one(&data.db);
        //let (levels, duration) = futures::try_join!(levels_fut, duration_fut).await?;
        let (levels, duration) = futures::try_join!(levels_fut, duration_fut)?;

        // 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()?;

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

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

        Ok(())
    }

    #[cfg(test)]
    mod tests {
        use actix_web::http::{header, StatusCode};
        use actix_web::test;
        use m_captcha::pow::PoWConfig;

        use super::*;
        use crate::api::v1::services as v1_services;
        use crate::tests::*;
        use crate::*;

        #[actix_rt::test]
        async fn get_pow_config_works() {
            const NAME: &str = "powusrworks";
            const PASSWORD: &str = "testingpas";
            const EMAIL: &str = "randomuser@a.com";
            const GET_URL: &str = "/api/v1/mcaptcha/pow/config";
            //        const UPDATE_URL: &str = "/api/v1/mcaptcha/domain/token/duration/update";

            {
                let data = Data::new().await;
                delete_user(NAME, &data).await;
            }

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

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

            // update and check changes

            let get_config_resp = test::call_service(
                &mut app,
                post_request!(&get_config_payload, GET_URL)
                    .cookie(cookies.clone())
                    .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);
        }
    }