      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

    /*
    * 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/>.
    */
    //! PoW Verification module

    use actix_web::{web, HttpResponse, Responder};
    use m_captcha::pow::Work;
    use serde::{Deserialize, Serialize};

    use crate::errors::*;
    use crate::stats::record::record_solve;
    use crate::Data;
    use crate::V1_API_ROUTES;

    #[derive(Clone, Debug, Deserialize, Serialize)]
    /// validation token that clients receive as proof for submiting
    /// valid PoW
    pub struct ValidationToken {
        pub token: String,
    }

    // API keys are mcaptcha actor names

    /// route handler that verifies PoW and issues a solution token
    /// if verification is successful
    #[my_codegen::post(
        path = "V1_API_ROUTES.pow.verify_pow.strip_prefix(V1_API_ROUTES.pow.scope).unwrap()"
    )]
    pub async fn verify_pow(
        payload: web::Json<Work>,
        data: web::Data<Data>,
    ) -> ServiceResult<impl Responder> {
        let key = payload.key.clone();
        let res = data.captcha.verify_pow(payload.into_inner()).await?;
        record_solve(&key, &data.db).await;
        let payload = ValidationToken { token: res };
        Ok(HttpResponse::Ok().json(payload))
    }

    #[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::pow::get_config::GetConfigPayload;
        use crate::tests::*;
        use crate::*;

        #[actix_rt::test]
        async fn verify_pow_works() {
            const NAME: &str = "powverifyusr";
            const PASSWORD: &str = "testingpas";
            const EMAIL: &str = "verifyuser@a.com";

            {
                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 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, 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;

            let pow = pow_sha256::ConfigBuilder::default()
                .salt(config.salt)
                .build()
                .unwrap();
            let work = pow
                .prove_work(&config.string.clone(), config.difficulty_factor)
                .unwrap();

            let work = Work {
                string: config.string.clone(),
                result: work.result,
                nonce: work.nonce,
                key: token_key.key.clone(),
            };

            let pow_verify_resp = test::call_service(
                &mut app,
                post_request!(&work, V1_API_ROUTES.pow.verify_pow).to_request(),
            )
            .await;
            assert_eq!(pow_verify_resp.status(), StatusCode::OK);

            let string_not_found = test::call_service(
                &mut app,
                post_request!(&work, V1_API_ROUTES.pow.verify_pow).to_request(),
            )
            .await;
            assert_eq!(string_not_found.status(), StatusCode::BAD_REQUEST);
            let err: ErrorToResponse = test::read_body_json(string_not_found).await;
            assert_eq!(
                err.error,
                format!(
                    "{}",
                    ServiceError::CaptchaError(
                        m_captcha::errors::CaptchaError::StringNotFound
                    )
                )
            );

            // let pow_config_resp = test::call_service(
            //     &mut app,
            //     post_request!(&get_config_payload, V1_API_ROUTES.pow.get_config).to_request(),
            // )
            // .await;
            // assert_eq!(pow_config_resp.status(), StatusCode::OK);
            // I'm not checking for errors because changing work.result triggered
            // InssuficientDifficulty, which is possible becuase m_captcha calculates
            // difficulty with the submitted result. Besides, this endpoint is merely
            // propagating errors from m_captcha and m_captcha has tests covering the
            // pow aspects ¯\_(ツ)_/¯
        }
    }