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