Rev 1201 | Rev 1266 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
635 | daniel-mar | 1 | <?php |
2 | |||
3 | /* |
||
4 | * OIDplus 2.0 |
||
1086 | daniel-mar | 5 | * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft |
635 | daniel-mar | 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 | |||
1050 | daniel-mar | 20 | namespace ViaThinkSoft\OIDplus; |
635 | daniel-mar | 21 | |
1086 | daniel-mar | 22 | // phpcs:disable PSR1.Files.SideEffects |
23 | \defined('INSIDE_OIDPLUS') or die; |
||
24 | // phpcs:enable PSR1.Files.SideEffects |
||
25 | |||
635 | daniel-mar | 26 | class OIDplusPageRaInvite extends OIDplusPagePluginRa { |
27 | |||
1116 | daniel-mar | 28 | /** |
29 | * @param string $actionID |
||
30 | * @param array $params |
||
1143 | daniel-mar | 31 | * @return array |
1116 | daniel-mar | 32 | * @throws OIDplusException |
33 | * @throws OIDplusMailException |
||
34 | */ |
||
35 | public function action(string $actionID, array $params): array { |
||
635 | daniel-mar | 36 | if ($actionID == 'invite_ra') { |
37 | $email = $params['email']; |
||
38 | |||
39 | if (!OIDplus::mailUtils()->validMailAddress($email)) { |
||
40 | throw new OIDplusException(_L('Invalid email address')); |
||
41 | } |
||
42 | |||
702 | daniel-mar | 43 | OIDplus::getActiveCaptchaPlugin()->captchaVerify($params, 'captcha'); |
635 | daniel-mar | 44 | |
45 | $this->inviteSecurityCheck($email); |
||
46 | // TODO: should we also log who has invited? |
||
1199 | daniel-mar | 47 | OIDplus::logger()->log("[INFO]RA(%1)!", "RA '%1' has been invited", $email); |
635 | daniel-mar | 48 | |
49 | $timestamp = time(); |
||
801 | daniel-mar | 50 | $activate_url = OIDplus::webpath(null,OIDplus::PATH_ABSOLUTE_CANONICAL) . '?goto='.urlencode('oidplus:activate_ra$'.$email.'$'.$timestamp.'$'.OIDplus::authUtils()->makeAuthKey('activate_ra;'.$email.';'.$timestamp)); |
635 | daniel-mar | 51 | |
52 | $message = $this->getInvitationText($email); |
||
53 | $message = str_replace('{{ACTIVATE_URL}}', $activate_url, $message); |
||
54 | |||
875 | daniel-mar | 55 | OIDplus::mailUtils()->sendMail($email, OIDplus::config()->getValue('system_title').' - Invitation', $message); |
635 | daniel-mar | 56 | |
57 | return array("status" => 0); |
||
58 | |||
59 | } else if ($actionID == 'activate_ra') { |
||
60 | |||
61 | _CheckParamExists($params, 'password1'); |
||
62 | _CheckParamExists($params, 'password2'); |
||
63 | _CheckParamExists($params, 'email'); |
||
64 | _CheckParamExists($params, 'auth'); |
||
65 | _CheckParamExists($params, 'timestamp'); |
||
66 | |||
67 | $password1 = $params['password1']; |
||
68 | $password2 = $params['password2']; |
||
69 | $email = $params['email']; |
||
70 | $auth = $params['auth']; |
||
71 | $timestamp = $params['timestamp']; |
||
72 | |||
73 | if (!OIDplus::authUtils()->validateAuthKey('activate_ra;'.$email.';'.$timestamp, $auth)) { |
||
74 | throw new OIDplusException(_L('Invalid auth key')); |
||
75 | } |
||
76 | |||
77 | if ((OIDplus::config()->getValue('max_ra_invite_time') > 0) && (time()-$timestamp > OIDplus::config()->getValue('max_ra_invite_time'))) { |
||
78 | throw new OIDplusException(_L('Invitation expired!')); |
||
79 | } |
||
80 | |||
81 | if ($password1 !== $password2) { |
||
82 | throw new OIDplusException(_L('Passwords do not match')); |
||
83 | } |
||
84 | |||
85 | if (strlen($password1) < OIDplus::config()->getValue('ra_min_password_length')) { |
||
86 | $minlen = OIDplus::config()->getValue('ra_min_password_length'); |
||
87 | throw new OIDplusException(_L('Password is too short. Need at least %1 characters',$minlen)); |
||
88 | } |
||
89 | |||
1199 | daniel-mar | 90 | OIDplus::logger()->log("[OK]RA(%1)!", "RA '%1' has been registered due to invitation", $email); |
635 | daniel-mar | 91 | |
92 | $ra = new OIDplusRA($email); |
||
93 | $ra->register_ra($password1); |
||
94 | |||
95 | return array("status" => 0); |
||
96 | } else { |
||
1116 | daniel-mar | 97 | return parent::action($actionID, $params); |
635 | daniel-mar | 98 | } |
99 | } |
||
100 | |||
1116 | daniel-mar | 101 | /** |
102 | * @param bool $html |
||
103 | * @return void |
||
104 | * @throws OIDplusException |
||
105 | */ |
||
106 | public function init(bool $html=true) { |
||
635 | daniel-mar | 107 | OIDplus::config()->prepareConfigKey('max_ra_invite_time', 'Max RA invite time in seconds (0 = infinite)', '0', OIDplusConfig::PROTECTION_EDITABLE, function($value) { |
108 | if (!is_numeric($value) || ($value < 0)) { |
||
109 | throw new OIDplusException(_L('Please enter a valid value.')); |
||
110 | } |
||
111 | }); |
||
112 | OIDplus::config()->prepareConfigKey('ra_invitation_enabled', 'May RAs be invited? (0=no, 1=yes)', '1', OIDplusConfig::PROTECTION_EDITABLE, function($value) { |
||
113 | if (($value != 0) && ($value != 1)) { |
||
114 | throw new OIDplusException(_L('Please enter a valid value (0=no, 1=yes).')); |
||
115 | } |
||
116 | }); |
||
117 | } |
||
118 | |||
1116 | daniel-mar | 119 | /** |
120 | * @param string $id |
||
121 | * @param array $out |
||
122 | * @param bool $handled |
||
123 | * @return void |
||
124 | * @throws OIDplusException |
||
125 | */ |
||
126 | public function gui(string $id, array &$out, bool &$handled) { |
||
635 | daniel-mar | 127 | if (explode('$',$id)[0] == 'oidplus:invite_ra') { |
128 | $handled = true; |
||
129 | |||
130 | $email = explode('$',$id)[1]; |
||
131 | $origin = explode('$',$id)[2]; |
||
132 | |||
133 | $out['title'] = _L('Invite a Registration Authority'); |
||
134 | |||
135 | if (!OIDplus::config()->getValue('ra_invitation_enabled')) { |
||
1206 | daniel-mar | 136 | throw new OIDplusException(_L('Invitations are disabled by the administrator.'), $out['title']); |
635 | daniel-mar | 137 | } |
138 | |||
801 | daniel-mar | 139 | $out['icon'] = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/invite_icon.png'; |
635 | daniel-mar | 140 | |
141 | try { |
||
142 | $this->inviteSecurityCheck($email); |
||
143 | $cont = $this->getInvitationText($email); |
||
144 | |||
145 | $out['text'] .= '<p>'._L('You have chosen to invite %1 as a Registration Authority. If you click "Send", the following email will be sent to %2:','<b>'.$email.'</b>',$email).'</p><p><i>'.nl2br(htmlentities($cont)).'</i></p> |
||
146 | <form id="inviteForm" action="javascript:void(0);" onsubmit="return OIDplusPageRaInvite.inviteFormOnSubmit();"> |
||
147 | <input type="hidden" id="email" value="'.htmlentities($email).'"/> |
||
702 | daniel-mar | 148 | <input type="hidden" id="origin" value="'.htmlentities($origin).'"/> |
149 | '.OIDplus::getActiveCaptchaPlugin()->captchaGenerate().' |
||
150 | <br> |
||
635 | daniel-mar | 151 | <input type="submit" value="'._L('Send invitation').'"> |
152 | </form>'; |
||
153 | |||
1050 | daniel-mar | 154 | } catch (\Exception $e) { |
635 | daniel-mar | 155 | |
1201 | daniel-mar | 156 | $htmlmsg = $e instanceof OIDplusException ? $e->getHtmlMessage() : htmlentities($e->getMessage()); |
1206 | daniel-mar | 157 | throw new OIDplusHtmlException(_L('Error: %1',$htmlmsg), $out['title']); |
635 | daniel-mar | 158 | |
159 | } |
||
160 | } else if (explode('$',$id)[0] == 'oidplus:activate_ra') { |
||
161 | $handled = true; |
||
162 | |||
163 | $email = explode('$',$id)[1]; |
||
164 | $timestamp = explode('$',$id)[2]; |
||
165 | $auth = explode('$',$id)[3]; |
||
166 | |||
167 | $out['title'] = _L('Register as Registration Authority'); |
||
168 | |||
169 | if (!OIDplus::config()->getValue('ra_invitation_enabled')) { |
||
1206 | daniel-mar | 170 | throw new OIDplusException(_L('Invitations are disabled by the administrator.'), $out['title']); |
635 | daniel-mar | 171 | } |
172 | |||
801 | daniel-mar | 173 | $out['icon'] = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/activate_icon.png'; |
635 | daniel-mar | 174 | |
175 | $res = OIDplus::db()->query("select * from ###ra where email = ?", array($email)); |
||
790 | daniel-mar | 176 | if ($res->any()) { |
635 | daniel-mar | 177 | $out['text'] = _L('This RA is already registered and does not need to be invited.'); |
178 | } else { |
||
179 | if (!OIDplus::authUtils()->validateAuthKey('activate_ra;'.$email.';'.$timestamp, $auth)) { |
||
1206 | daniel-mar | 180 | throw new OIDplusException(_L('Invalid authorization. Is the URL OK?'), $out['title']); |
635 | daniel-mar | 181 | } else { |
182 | // TODO: like in the FreeOID plugin, we could ask here at least for a name for the RA |
||
183 | $out['text'] = '<p>'._L('E-Mail-Address').': <b>'.$email.'</b></p> |
||
184 | |||
185 | <form id="activateRaForm" action="javascript:void(0);" onsubmit="return OIDplusPageRaInvite.activateRaFormOnSubmit();"> |
||
186 | <input type="hidden" id="email" value="'.htmlentities($email).'"/> |
||
187 | <input type="hidden" id="timestamp" value="'.htmlentities($timestamp).'"/> |
||
188 | <input type="hidden" id="auth" value="'.htmlentities($auth).'"/> |
||
189 | <div><label class="padding_label">'._L('New password').':</label><input type="password" id="password1" value=""/></div> |
||
190 | <div><label class="padding_label">'._L('Repeat').':</label><input type="password" id="password2" value=""/></div> |
||
191 | <br><input type="submit" value="'._L('Register').'"> |
||
192 | </form>'; |
||
193 | } |
||
194 | } |
||
195 | } |
||
196 | } |
||
197 | |||
1116 | daniel-mar | 198 | /** |
199 | * @param array $json |
||
200 | * @param string|null $ra_email |
||
201 | * @param bool $nonjs |
||
202 | * @param string $req_goto |
||
203 | * @return bool |
||
204 | */ |
||
205 | public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool { |
||
635 | daniel-mar | 206 | //if (!$ra_email) return false; |
207 | //if (!OIDplus::authUtils()->isRaLoggedIn($ra_email) && !OIDplus::authUtils()->isAdminLoggedIn()) return false; |
||
208 | |||
209 | return false; |
||
210 | } |
||
211 | |||
1116 | daniel-mar | 212 | /** |
1125 | daniel-mar | 213 | * @param string $email |
1116 | daniel-mar | 214 | * @return void |
215 | * @throws OIDplusException |
||
216 | */ |
||
1125 | daniel-mar | 217 | private function inviteSecurityCheck(string $email) { |
635 | daniel-mar | 218 | $res = OIDplus::db()->query("select * from ###ra where email = ?", array($email)); |
790 | daniel-mar | 219 | if ($res->any()) { |
635 | daniel-mar | 220 | throw new OIDplusException(_L('This RA is already registered and does not need to be invited.')); |
221 | } |
||
222 | |||
223 | if (!OIDplus::authUtils()->isAdminLoggedIn()) { |
||
224 | // Check if the RA may invite the user (i.e. the they are the parent of an OID of that person) |
||
225 | $ok = false; |
||
226 | $res = OIDplus::db()->query("select parent from ###objects where ra_email = ?", array($email)); |
||
227 | while ($row = $res->fetch_array()) { |
||
1120 | daniel-mar | 228 | if (!$row['parent']) continue; |
635 | daniel-mar | 229 | $objParent = OIDplusObject::parse($row['parent']); |
1116 | daniel-mar | 230 | if (!$objParent) throw new OIDplusException(_L('Type of %1 unknown',$row['parent'])); |
635 | daniel-mar | 231 | if ($objParent->userHasWriteRights()) { |
232 | $ok = true; |
||
233 | } |
||
234 | } |
||
235 | if (!$ok) { |
||
1201 | daniel-mar | 236 | throw new OIDplusHtmlException(_L('You may not invite this RA. Maybe you need to <a %1>log in</a> again.',OIDplus::gui()->link('oidplus:login'))); |
635 | daniel-mar | 237 | } |
238 | } |
||
239 | } |
||
240 | |||
1116 | daniel-mar | 241 | /** |
1125 | daniel-mar | 242 | * @param string $email |
1116 | daniel-mar | 243 | * @return string |
244 | * @throws OIDplusException |
||
245 | */ |
||
1125 | daniel-mar | 246 | private function getInvitationText(string $email): string { |
635 | daniel-mar | 247 | $list_of_oids = array(); |
248 | $res = OIDplus::db()->query("select id from ###objects where ra_email = ?", array($email)); |
||
249 | while ($row = $res->fetch_array()) { |
||
250 | $list_of_oids[] = $row['id']; |
||
251 | } |
||
252 | |||
253 | $message = file_get_contents(__DIR__ . '/invite_msg.tpl'); |
||
254 | |||
255 | // Resolve stuff |
||
1130 | daniel-mar | 256 | // Note: {{ACTIVATE_URL}} will be resolved in ajax.php |
257 | |||
801 | daniel-mar | 258 | $message = str_replace('{{SYSTEM_URL}}', OIDplus::webpath(null,OIDplus::PATH_ABSOLUTE_CANONICAL), $message); |
635 | daniel-mar | 259 | $message = str_replace('{{OID_LIST}}', implode("\n", $list_of_oids), $message); |
260 | $message = str_replace('{{ADMIN_EMAIL}}', OIDplus::config()->getValue('admin_email'), $message); |
||
261 | |||
1130 | daniel-mar | 262 | return str_replace('{{PARTY}}', OIDplus::authUtils()->isAdminLoggedIn() ? 'the system administrator' : 'a superior Registration Authority', $message); |
635 | daniel-mar | 263 | } |
264 | |||
1116 | daniel-mar | 265 | /** |
266 | * @param string $request |
||
267 | * @return array|false |
||
268 | */ |
||
269 | public function tree_search(string $request) { |
||
635 | daniel-mar | 270 | return false; |
271 | } |
||
272 | } |