Subversion Repositories oidplus

Rev

Rev 1130 | Rev 1283 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

  1. <?php
  2.  
  3. /*
  4.  * OIDplus 2.0
  5.  * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
  6.  *
  7.  * Licensed under the Apache License, Version 2.0 (the "License");
  8.  * you may not use this file except in compliance with the License.
  9.  * You may obtain a copy of the License at
  10.  *
  11.  *     http://www.apache.org/licenses/LICENSE-2.0
  12.  *
  13.  * Unless required by applicable law or agreed to in writing, software
  14.  * distributed under the License is distributed on an "AS IS" BASIS,
  15.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16.  * See the License for the specific language governing permissions and
  17.  * limitations under the License.
  18.  */
  19.  
  20. namespace ViaThinkSoft\OIDplus;
  21.  
  22. // phpcs:disable PSR1.Files.SideEffects
  23. \defined('INSIDE_OIDPLUS') or die;
  24. // phpcs:enable PSR1.Files.SideEffects
  25.  
  26. class OIDplusCaptchaPluginVtsClientChallenge extends OIDplusCaptchaPlugin {
  27.  
  28.         /**
  29.          * @return string
  30.          */
  31.         public static function id(): string {
  32.                 return 'ViaThinkSoft Client Challenge';
  33.         }
  34.  
  35.         /**
  36.          * @return bool
  37.          */
  38.         public function isVisible(): bool {
  39.                 return false;
  40.         }
  41.  
  42.         /**
  43.          * @param string $actionID
  44.          * @return bool
  45.          */
  46.         public function csrfUnlock(string $actionID): bool {
  47.                 if ($actionID == 'get_challenge') return true;
  48.                 return parent::csrfUnlock($actionID);
  49.         }
  50.  
  51.         /**
  52.          * @param string $actionID
  53.          * @param array $params
  54.          * @return array
  55.          * @throws OIDplusException
  56.          */
  57.         public function action(string $actionID, array $params): array {
  58.                 if ($actionID == 'get_challenge') {
  59.                         $offset = 0; // doesn't matter
  60.                         $min = $offset;
  61.                         $max = $offset + OIDplus::baseConfig()->getValue('VTS_CAPTCHA_COMPLEXITY', 50000);
  62.                         if ($max > mt_getrandmax()) $max = mt_getrandmax();
  63.  
  64.                         $starttime = time();
  65.                         $random = mt_rand($min,$max);
  66.                         $ip_target = $_SERVER['REMOTE_ADDR'] ?? 'unknown';
  67.                         $challenge = sha3_512($starttime.'/'.$ip_target.'/'.$random); // $random is secret!
  68.                         $challenge_integrity = OIDplus::authUtils()->makeAuthKey('797bfc34-f4fa-11ed-86ca-3c4a92df8582:'.$challenge);
  69.                         $send_to_client = array($starttime, $ip_target, $challenge, $min, $max, $challenge_integrity);
  70.  
  71.                         $open_trans_file = self::getOpenTransFileName($ip_target, $random);
  72.                         if (@file_put_contents($open_trans_file, '') === false) {
  73.                                 throw new OIDplusException(_L('Cannot write file %1', $open_trans_file));
  74.                         }
  75.  
  76.                         return array(
  77.                                 "status" => 0,
  78.                                 "challenge" => $send_to_client,
  79.                                 // Autosolve on=calculate result on page load; off=calculate result on form submit
  80.                                 "autosolve" => OIDplus::baseConfig()->getValue('VTS_CAPTCHA_AUTOSOLVE', true)
  81.                         );
  82.                 } else {
  83.                         return parent::action($actionID, $params);
  84.                 }
  85.         }
  86.  
  87.         /**
  88.          * @param string $ip_target
  89.          * @param string|int $random
  90.          * @return string
  91.          * @throws OIDplusException
  92.          */
  93.         private static function getOpenTransFileName(string $ip_target, $random): string {
  94.                 $dir = OIDplus::localpath().'/userdata/cache';
  95.  
  96.                 // First, delete challenges which were never completed
  97.                 $files = glob($dir.'/vts_client_challenge_*.tmp');
  98.                 $expire = strtotime('-3 DAYS');
  99.                 foreach ($files as $file) {
  100.                         if (!is_file($file)) continue;
  101.                         if (filemtime($file) > $expire) continue;
  102.                         @unlink($file);
  103.                 }
  104.  
  105.                 return $dir.'/vts_client_challenge_'.OIDplus::authUtils()->makeSecret('461f4a9e-f4fa-11ed-86ca-3c4a92df8582:'.$ip_target.'/'.$random).'.tmp';
  106.         }
  107.  
  108.         /**
  109.          * @param string|null $header_text
  110.          * @param string|null $footer_text
  111.          * @return string
  112.          * @throws OIDplusException
  113.          */
  114.         public function captchaGenerate(string $header_text=null, string $footer_text=null): string {
  115.                 return '<noscript>'.
  116.                        '<p><font color="red">'._L('You need to enable JavaScript to solve the CAPTCHA.').'</font></p>'.
  117.                        '</noscript>'.
  118.                        '<input type="hidden" id="vts_validation_result" name="vts_validation_result" value="">'.
  119.                        '<script>'.
  120.                        'OIDplusCaptchaPluginVtsClientChallenge.captchaShow('.js_escape(OIDplus::webpath(null,OIDplus::PATH_RELATIVE)).');'.
  121.                        '</script>';
  122.         }
  123.  
  124.         /**
  125.          * @param array $params
  126.          * @param string|null $fieldname
  127.          * @return void
  128.          * @throws OIDplusException
  129.          */
  130.         public function captchaVerify(array $params, string $fieldname=null) {
  131.  
  132.                 if (is_null($fieldname)) $fieldname = 'vts_validation_result';
  133.  
  134.                 if (!isset($params[$fieldname])) throw new OIDplusException(_L('No challenge response found').' (A)');
  135.  
  136.                 $client_response = @json_decode($params[$fieldname], true);
  137.  
  138.                 if (!is_array($client_response)) throw new OIDplusException(_L('Challenge response is invalid').' (B)');
  139.                 if (count($client_response) != 5) throw new OIDplusException(_L('Challenge response is invalid').' (C)');
  140.                 list($starttime, $ip_target, $challenge, $answer, $challenge_integrity) = $client_response;
  141.                 if (!is_numeric($starttime)) throw new OIDplusException(_L('Challenge response is invalid').' (D)');
  142.                 if (!is_string($ip_target)) throw new OIDplusException(_L('Challenge response is invalid').' (E)');
  143.                 if (!is_string($challenge)) throw new OIDplusException(_L('Challenge response is invalid').' (F)');
  144.                 if (!is_numeric($answer)) throw new OIDplusException(_L('Challenge response is invalid').' (G)');
  145.                 if (!is_string($challenge_integrity)) throw new OIDplusException(_L('Challenge response is invalid').' (H)');
  146.  
  147.                 $open_trans_file = self::getOpenTransFileName($ip_target, $answer);
  148.  
  149.                 $current_ip = ($_SERVER['REMOTE_ADDR'] ?? 'unknown');
  150.                 if ($ip_target != $current_ip) {
  151.                         throw new OIDplusException(_L('IP address has changed. Please try again. (current IP %1, expected %2)', $current_ip, $ip_target));
  152.                 } else if (time()-$starttime > OIDplus::baseConfig()->getValue('VTS_CAPTCHA_MAXTIME', 10*60/*10 minutes*/)) {
  153.                         throw new OIDplusException(_L('Challenge expired. Please try again.'));
  154.                 } else if (!OIDplus::authUtils()->validateAuthKey('797bfc34-f4fa-11ed-86ca-3c4a92df8582:'.$challenge, $challenge_integrity)) {
  155.                         throw new OIDplusException(_L('Challenge integrity failed'));
  156.                 } else if ($challenge !== sha3_512($starttime.'/'.$ip_target.'/'.$answer)) {
  157.                         throw new OIDplusException(_L('Wrong answer'));
  158.                 } else if (!file_exists($open_trans_file)) {
  159.                         throw new OIDplusException(_L('Challenge submitted twice or transaction missing'));
  160.                 } else {
  161.                         @unlink($open_trans_file);
  162.                 }
  163.         }
  164.  
  165.         /**
  166.          * @return string
  167.          */
  168.         public static function setupHTML(): string {
  169.                 return '<div id="CAPTCHAPLUGIN_PARAMS_VtsClientChallenge">'.
  170.                        '<p>'._L('ViaThinkSoft Client Challenge lets the client computer solve a cryptographic problem instead of letting the user solve a CAPTCHA. This slows down brute-force attacks.').'</p>'.
  171.                        '</div>';
  172.         }
  173.  
  174. }
  175.