Rev 1130 | Rev 1143 | 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 OIDplusPagePublicFreeOID extends OIDplusPagePluginPublic { |
27 | |||
1116 | daniel-mar | 28 | /** |
1121 | daniel-mar | 29 | * @param bool $with_ns |
30 | * @return string|null |
||
1116 | daniel-mar | 31 | * @throws OIDplusException |
32 | */ |
||
1121 | daniel-mar | 33 | private static function getFreeRootOid(bool $with_ns)/*: ?string*/ { |
34 | if (!in_array('ViaThinkSoft\OIDplus\OIDplusOid',OIDplus::getEnabledObjectTypes())) { |
||
35 | return null; |
||
36 | } else { |
||
37 | $res = ($with_ns ? 'oid:' : '').OIDplus::config()->getValue('freeoid_root_oid'); |
||
38 | return !empty($res) ? $res : null; |
||
39 | } |
||
635 | daniel-mar | 40 | } |
41 | |||
1116 | daniel-mar | 42 | /** |
1130 | daniel-mar | 43 | * @param string $email |
1121 | daniel-mar | 44 | * @param bool $getId |
45 | * @return bool|null |
||
1116 | daniel-mar | 46 | * @throws OIDplusException |
47 | */ |
||
1130 | daniel-mar | 48 | public static function alreadyHasFreeOid(string $email, bool $getId = false)/*: ?bool*/ { |
635 | daniel-mar | 49 | $res = OIDplus::db()->query("select id from ###objects where ra_email = ? and id like ? order by ".OIDplus::db()->natOrder('id'), array($email, self::getFreeRootOid(true).'.%')); |
1140 | daniel-mar | 50 | if ($row = $res->fetch_array()) { |
635 | daniel-mar | 51 | return $getId ? $row['id'] : true; |
52 | } |
||
53 | return $getId ? null : false; |
||
54 | } |
||
55 | |||
1116 | daniel-mar | 56 | /** |
57 | * @param string $actionID |
||
58 | * @param array $params |
||
59 | * @return array|int[] |
||
60 | * @throws OIDplusException |
||
61 | * @throws OIDplusMailException |
||
62 | */ |
||
63 | public function action(string $actionID, array $params): array { |
||
635 | daniel-mar | 64 | if (empty(self::getFreeRootOid(false))) throw new OIDplusException(_L('FreeOID service not available. Please ask your administrator.')); |
65 | |||
66 | if ($actionID == 'request_freeoid') { |
||
67 | _CheckParamExists($params, 'email'); |
||
68 | $email = $params['email']; |
||
69 | |||
70 | if ($already_registered_oid = $this->alreadyHasFreeOid($email, true)) { |
||
71 | throw new OIDplusException(_L('This email address already has a FreeOID registered (%1)', $already_registered_oid)); |
||
72 | } |
||
73 | |||
74 | if (!OIDplus::mailUtils()->validMailAddress($email)) { |
||
75 | throw new OIDplusException(_L('Invalid email address')); |
||
76 | } |
||
77 | |||
702 | daniel-mar | 78 | OIDplus::getActiveCaptchaPlugin()->captchaVerify($params, 'captcha'); |
635 | daniel-mar | 79 | |
80 | $root_oid = self::getFreeRootOid(false); |
||
81 | OIDplus::logger()->log("[INFO]OID(oid:$root_oid)+RA($email)!", "Requested a free OID for email '$email' to be placed into root '$root_oid'"); |
||
82 | |||
83 | $timestamp = time(); |
||
801 | daniel-mar | 84 | $activate_url = OIDplus::webpath(null,OIDplus::PATH_ABSOLUTE_CANONICAL) . '?goto='.urlencode('oidplus:com.viathinksoft.freeoid.activate_freeoid$'.$email.'$'.$timestamp.'$'.OIDplus::authUtils()->makeAuthKey('com.viathinksoft.freeoid.activate_freeoid;'.$email.';'.$timestamp)); |
635 | daniel-mar | 85 | |
86 | $message = file_get_contents(__DIR__ . '/request_msg.tpl'); |
||
801 | daniel-mar | 87 | $message = str_replace('{{SYSTEM_URL}}', OIDplus::webpath(null,OIDplus::PATH_ABSOLUTE_CANONICAL), $message); |
635 | daniel-mar | 88 | $message = str_replace('{{SYSTEM_TITLE}}', OIDplus::config()->getValue('system_title'), $message); |
89 | $message = str_replace('{{ADMIN_EMAIL}}', OIDplus::config()->getValue('admin_email'), $message); |
||
90 | $message = str_replace('{{ACTIVATE_URL}}', $activate_url, $message); |
||
91 | |||
875 | daniel-mar | 92 | OIDplus::mailUtils()->sendMail($email, OIDplus::config()->getValue('system_title').' - Free OID request', $message); |
635 | daniel-mar | 93 | |
94 | return array("status" => 0); |
||
95 | |||
96 | } else if ($actionID == 'activate_freeoid') { |
||
97 | _CheckParamExists($params, 'email'); |
||
98 | _CheckParamExists($params, 'auth'); |
||
99 | _CheckParamExists($params, 'timestamp'); |
||
100 | |||
101 | $email = $params['email']; |
||
102 | $auth = $params['auth']; |
||
103 | $timestamp = $params['timestamp']; |
||
104 | |||
105 | if (!OIDplus::authUtils()->validateAuthKey('com.viathinksoft.freeoid.activate_freeoid;'.$email.';'.$timestamp, $auth)) { |
||
106 | throw new OIDplusException(_L('Invalid auth key')); |
||
107 | } |
||
108 | |||
109 | if ((OIDplus::config()->getValue('max_ra_invite_time') > 0) && (time()-$timestamp > OIDplus::config()->getValue('max_ra_invite_time'))) { |
||
110 | throw new OIDplusException(_L('Invitation expired!')); |
||
111 | } |
||
112 | |||
113 | // 1. step: Check entered data and add the RA to the database |
||
114 | |||
115 | $ra = new OIDplusRA($email); |
||
116 | if (!$ra->existing()) { |
||
117 | _CheckParamExists($params, 'password1'); |
||
118 | _CheckParamExists($params, 'password2'); |
||
119 | _CheckParamExists($params, 'ra_name'); |
||
702 | daniel-mar | 120 | |
635 | daniel-mar | 121 | $password1 = $params['password1']; |
122 | $password2 = $params['password2']; |
||
123 | $ra_name = $params['ra_name']; |
||
124 | |||
125 | if ($password1 !== $password2) { |
||
126 | throw new OIDplusException(_L('Passwords do not match')); |
||
127 | } |
||
128 | |||
129 | if (strlen($password1) < OIDplus::config()->getValue('ra_min_password_length')) { |
||
130 | $minlen = OIDplus::config()->getValue('ra_min_password_length'); |
||
131 | throw new OIDplusException(_L('Password is too short. Need at least %1 characters',$minlen)); |
||
132 | } |
||
133 | |||
134 | if (empty($ra_name)) { |
||
135 | throw new OIDplusException(_L('Please enter your personal name or the name of your group.')); |
||
136 | } |
||
137 | |||
138 | $ra->register_ra($password1); |
||
139 | $ra->setRaName($ra_name); |
||
140 | } else { |
||
141 | // RA already exists (e.g. was logged in using Google OAuth) |
||
142 | $ra_name = $ra->raName(); |
||
143 | } |
||
144 | |||
145 | // 2. step: Add the new OID to the database |
||
146 | |||
1130 | daniel-mar | 147 | $url = $params['url'] ?? ''; |
148 | $title = $params['title'] ?? ''; |
||
635 | daniel-mar | 149 | |
150 | $root_oid = self::getFreeRootOid(false); |
||
151 | $new_oid = OIDplusOid::parse('oid:'.$root_oid)->appendArcs($this->freeoid_max_id()+1)->nodeId(false); |
||
152 | |||
153 | OIDplus::logger()->log("[INFO]OID(oid:$root_oid)+OIDRA(oid:$root_oid)!", "Child OID '$new_oid' added automatically by '$email' (RA Name: '$ra_name')"); |
||
154 | OIDplus::logger()->log("[INFO]OID(oid:$new_oid)+[OK]RA($email)!", "Free OID '$new_oid' activated (RA Name: '$ra_name')"); |
||
155 | |||
156 | if ((!empty($url)) && (substr($url, 0, 4) != 'http')) $url = 'http://'.$url; |
||
157 | |||
158 | $description = ''; // '<p>'.htmlentities($ra_name).'</p>'; |
||
159 | if (!empty($url)) { |
||
160 | $description .= '<p>'._L('More information at %1','<a href="'.htmlentities($url).'">'.htmlentities($url).'</a>').'</p>'; |
||
161 | } |
||
162 | |||
163 | if (empty($title)) $title = $ra_name; |
||
164 | |||
165 | try { |
||
166 | $maxlen = OIDplus::baseConfig()->getValue('LIMITS_MAX_ID_LENGTH')-strlen('oid:'); |
||
167 | if (strlen($new_oid) > $maxlen) { |
||
168 | throw new OIDplusException(_L('The resulting OID %1 is too long (max allowed length: %2)',$new_oid,$maxlen)); |
||
169 | } |
||
170 | |||
171 | OIDplus::db()->query("insert into ###objects (id, ra_email, parent, title, description, confidential, created) values (?, ?, ?, ?, ?, ?, ".OIDplus::db()->sqlDate().")", array('oid:'.$new_oid, $email, self::getFreeRootOid(true), $title, $description, false)); |
||
978 | daniel-mar | 172 | OIDplusObject::resetObjectInformationCache(); |
1050 | daniel-mar | 173 | } catch (\Exception $e) { |
635 | daniel-mar | 174 | $ra->delete(); |
175 | throw $e; |
||
176 | } |
||
177 | |||
178 | // Send delegation report email to admin |
||
179 | |||
180 | $message = "OID delegation report\n"; |
||
181 | $message .= "\n"; |
||
1116 | daniel-mar | 182 | $message .= "OID: ".$new_oid."\n"; |
635 | daniel-mar | 183 | $message .= "\n"; |
184 | $message .= "RA Name: $ra_name\n"; |
||
185 | $message .= "RA eMail: $email\n"; |
||
186 | $message .= "URL for more information: $url\n"; |
||
187 | $message .= "OID Name: $title\n"; |
||
188 | $message .= "\n"; |
||
962 | daniel-mar | 189 | $message .= "More details: ".OIDplus::webpath(null,OIDplus::PATH_ABSOLUTE_CANONICAL)."?goto=oid%3A$new_oid\n"; |
635 | daniel-mar | 190 | |
875 | daniel-mar | 191 | OIDplus::mailUtils()->sendMail($email, OIDplus::config()->getValue('system_title')." - OID $new_oid registered", $message); |
635 | daniel-mar | 192 | |
193 | // Send delegation information to user |
||
194 | |||
195 | $message = file_get_contents(__DIR__ . '/allocated_msg.tpl'); |
||
801 | daniel-mar | 196 | $message = str_replace('{{SYSTEM_URL}}', OIDplus::webpath(null,OIDplus::PATH_ABSOLUTE_CANONICAL), $message); |
635 | daniel-mar | 197 | $message = str_replace('{{SYSTEM_TITLE}}', OIDplus::config()->getValue('system_title'), $message); |
198 | $message = str_replace('{{ADMIN_EMAIL}}', OIDplus::config()->getValue('admin_email'), $message); |
||
199 | $message = str_replace('{{NEW_OID}}', $new_oid, $message); |
||
875 | daniel-mar | 200 | OIDplus::mailUtils()->sendMail($email, OIDplus::config()->getValue('system_title').' - Free OID allocated', $message); |
635 | daniel-mar | 201 | |
202 | return array( |
||
203 | "new_oid" => $new_oid, |
||
204 | "status" => 0 |
||
205 | ); |
||
206 | } else { |
||
1116 | daniel-mar | 207 | return parent::action($actionID, $params); |
635 | daniel-mar | 208 | } |
209 | } |
||
210 | |||
1116 | daniel-mar | 211 | /** |
212 | * @param bool $html |
||
213 | * @return void |
||
214 | * @throws OIDplusException |
||
215 | */ |
||
216 | public function init(bool $html=true) { |
||
635 | daniel-mar | 217 | OIDplus::config()->prepareConfigKey('freeoid_root_oid', 'Root-OID of free OID service (a service where visitors can create their own OID using email verification)', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) { |
218 | if (($value != '') && !oid_valid_dotnotation($value,false,false,1)) { |
||
219 | throw new OIDplusException(_L('Please enter a valid OID in dot notation or nothing')); |
||
220 | } |
||
221 | }); |
||
222 | } |
||
223 | |||
1116 | daniel-mar | 224 | /** |
225 | * @param string $id |
||
226 | * @param array $out |
||
227 | * @param bool $handled |
||
228 | * @return void |
||
229 | * @throws OIDplusException |
||
230 | */ |
||
231 | public function gui(string $id, array &$out, bool &$handled) { |
||
635 | daniel-mar | 232 | if (empty(self::getFreeRootOid(false))) return; |
233 | |||
234 | if (explode('$',$id)[0] == 'oidplus:com.viathinksoft.freeoid') { |
||
235 | $handled = true; |
||
236 | |||
237 | $out['title'] = _L('Register a free OID'); |
||
801 | daniel-mar | 238 | $out['icon'] = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : ''; |
635 | daniel-mar | 239 | |
240 | // Note: We are using the highest OID instead of the rowcount, because there might be OIDs which could have been deleted in between |
||
241 | $highest_id = $this->freeoid_max_id(); |
||
242 | |||
243 | $out['text'] .= '<p>'._L('Currently <a %1>%2 free OIDs have been</a> registered. Please enter your email below to receive a free OID.',OIDplus::gui()->link(self::getFreeRootOid(true)),$highest_id).'</p>'; |
||
244 | |||
245 | try { |
||
246 | $out['text'] .= ' |
||
247 | <form id="freeOIDForm" action="javascript:void(0);" onsubmit="return OIDplusPagePublicFreeOID.freeOIDFormOnSubmit();"> |
||
702 | daniel-mar | 248 | '._L('E-Mail').': <input type="text" id="email" value=""/><br><br> |
249 | '.OIDplus::getActiveCaptchaPlugin()->captchaGenerate().' |
||
250 | <br> |
||
962 | daniel-mar | 251 | <input type="submit" value="'._L('Request a free OID').'"> |
635 | daniel-mar | 252 | </form>'; |
253 | |||
254 | $obj = OIDplusOid::parse(self::getFreeRootOid(true)); |
||
255 | |||
256 | if (file_exists(__DIR__ . '/tos$'.OIDplus::getCurrentLang().'.html')) { |
||
257 | $tos = file_get_contents(__DIR__ . '/tos$'.OIDplus::getCurrentLang().'.html'); |
||
258 | } else { |
||
259 | $tos = file_get_contents(__DIR__ . '/tos.html'); |
||
260 | } |
||
261 | |||
262 | list($html, $js, $css) = extractHtmlContents($tos); |
||
263 | $tos = ''; |
||
264 | if (!empty($js)) $tos .= "<script>\n$js\n</script>"; |
||
265 | if (!empty($css)) $tos .= "<style>\n$css\n</style>"; |
||
821 | daniel-mar | 266 | $tos .= stripHtmlComments($html); |
635 | daniel-mar | 267 | |
268 | $tos = str_replace('{{ADMIN_EMAIL}}', OIDplus::config()->getValue('admin_email'), $tos); |
||
269 | if ($obj) { |
||
270 | $tos = str_replace('{{ROOT_OID}}', $obj->getDotNotation(), $tos); |
||
271 | $tos = str_replace('{{ROOT_OID_ASN1}}', $obj->getAsn1Notation(), $tos); |
||
272 | $tos = str_replace('{{ROOT_OID_IRI}}', $obj->getIriNotation(), $tos); |
||
273 | } |
||
274 | $out['text'] .= $tos; |
||
960 | daniel-mar | 275 | |
276 | if (OIDplus::config()->getValue('freeoid_root_oid') == '1.3.6.1.4.1.37476.9000') { |
||
277 | $out['text'] .= '<p>'._L('<b>Note:</b> Since September 2022, owners of FreeOID automatically receive a free ISO-7816 compliant <b>Application Identifier</b> (AID) with the format <code>D2:76:00:01:86:F0:(FreeOID):FF:(PIX)</code> (up to 64 bits application specific PIX, depending on the length of the FreeOID number).'); |
||
278 | $out['text'] .= ' - <a '.OIDplus::gui()->link('aid:D276000186F1').'>'._L('More information').'</a></p>'; |
||
279 | } |
||
1050 | daniel-mar | 280 | } catch (\Exception $e) { |
635 | daniel-mar | 281 | $out['text'] = _L('Error: %1',$e->getMessage()); |
282 | } |
||
283 | } else if (explode('$',$id)[0] == 'oidplus:com.viathinksoft.freeoid.activate_freeoid') { |
||
284 | $handled = true; |
||
285 | |||
286 | $email = explode('$',$id)[1]; |
||
287 | $timestamp = explode('$',$id)[2]; |
||
288 | $auth = explode('$',$id)[3]; |
||
289 | |||
290 | $out['title'] = _L('Activate Free OID'); |
||
801 | daniel-mar | 291 | $out['icon'] = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : ''; |
635 | daniel-mar | 292 | |
293 | if ($already_registered_oid = $this->alreadyHasFreeOid($email, true)) { |
||
294 | throw new OIDplusException(_L('This email address already has a FreeOID registered (%1)', $already_registered_oid)); |
||
295 | } else { |
||
296 | if (!OIDplus::authUtils()->validateAuthKey('com.viathinksoft.freeoid.activate_freeoid;'.$email.';'.$timestamp, $auth)) { |
||
800 | daniel-mar | 297 | $out['icon'] = 'img/error.png'; |
635 | daniel-mar | 298 | $out['text'] = _L('Invalid authorization. Is the URL OK?'); |
299 | } else { |
||
300 | $ra = new OIDplusRA($email); |
||
301 | $ra_existing = $ra->existing(); |
||
302 | |||
303 | $out['text'] = '<p>'._L('eMail-Address').': <b>'.$email.'</b></p>'; |
||
304 | |||
305 | $out['text'] .= ' <form id="activateFreeOIDForm" action="javascript:void(0);" onsubmit="return OIDplusPagePublicFreeOID.activateFreeOIDFormOnSubmit();">'; |
||
306 | $out['text'] .= ' <input type="hidden" id="email" value="'.htmlentities($email).'"/>'; |
||
307 | $out['text'] .= ' <input type="hidden" id="timestamp" value="'.htmlentities($timestamp).'"/>'; |
||
308 | $out['text'] .= ' <input type="hidden" id="auth" value="'.htmlentities($auth).'"/>'; |
||
309 | |||
310 | if ($ra_existing) { |
||
311 | $out['text'] .= ' '._L('Your personal name or the name of your group').':<br><b>'.htmlentities($ra->raName()).'</b><br><br>'; |
||
312 | } else { |
||
313 | $out['text'] .= ' '._L('Your personal name or the name of your group').':<br><input type="text" id="ra_name" value=""/><br><br>'; // TODO: disable autocomplete |
||
314 | } |
||
315 | $out['text'] .= ' '._L('Title of your OID (usually equal to your name, optional)').':<br><input type="text" id="title" value=""/><br><br>'; |
||
316 | $out['text'] .= ' '._L('URL for more information about your project(s) (optional)').':<br><input type="text" id="url" value=""/><br><br>'; |
||
317 | |||
318 | if (!$ra_existing) { |
||
319 | $out['text'] .= ' <div><label class="padding_label">'._L('Password').':</label><input type="password" id="password1" value=""/></div>'; |
||
320 | $out['text'] .= ' <div><label class="padding_label">'._L('Repeat').':</label><input type="password" id="password2" value=""/></div>'; |
||
321 | } |
||
322 | $out['text'] .= ' <br><input type="submit" value="'._L('Register').'">'; |
||
323 | $out['text'] .= ' </form>'; |
||
324 | } |
||
325 | } |
||
326 | } |
||
327 | } |
||
328 | |||
1116 | daniel-mar | 329 | /** |
330 | * @param array $out |
||
331 | * @return void |
||
332 | * @throws OIDplusException |
||
333 | */ |
||
334 | public function publicSitemap(array &$out) { |
||
635 | daniel-mar | 335 | if (empty(self::getFreeRootOid(false))) return; |
336 | $out[] = 'oidplus:com.viathinksoft.freeoid'; |
||
337 | } |
||
338 | |||
1116 | daniel-mar | 339 | /** |
340 | * @param array $json |
||
341 | * @param string|null $ra_email |
||
342 | * @param bool $nonjs |
||
343 | * @param string $req_goto |
||
344 | * @return bool |
||
345 | * @throws OIDplusException |
||
346 | */ |
||
347 | public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool { |
||
635 | daniel-mar | 348 | if (empty(self::getFreeRootOid(false))) return false; |
349 | |||
800 | daniel-mar | 350 | if (file_exists(__DIR__.'/img/main_icon16.png')) { |
801 | daniel-mar | 351 | $tree_icon = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon16.png'; |
635 | daniel-mar | 352 | } else { |
353 | $tree_icon = null; // default icon (folder) |
||
354 | } |
||
355 | |||
356 | $json[] = array( |
||
357 | 'id' => 'oidplus:com.viathinksoft.freeoid', |
||
358 | 'icon' => $tree_icon, |
||
359 | 'text' => _L('Register a free OID') |
||
360 | ); |
||
361 | |||
362 | return true; |
||
363 | } |
||
364 | |||
365 | # --- |
||
366 | |||
1116 | daniel-mar | 367 | /** |
368 | * @return int |
||
369 | * @throws OIDplusException |
||
370 | */ |
||
371 | protected static function freeoid_max_id(): int { |
||
635 | daniel-mar | 372 | $res = OIDplus::db()->query("select id from ###objects where id like ? order by ".OIDplus::db()->natOrder('id'), array(self::getFreeRootOid(true).'.%')); |
373 | $highest_id = 0; |
||
374 | while ($row = $res->fetch_array()) { |
||
375 | $arc = substr_count(self::getFreeRootOid(false), '.')+1; |
||
376 | $highest_id = explode('.',$row['id'])[$arc]; |
||
377 | } |
||
378 | return $highest_id; |
||
379 | } |
||
380 | |||
1116 | daniel-mar | 381 | /** |
382 | * @param string $request |
||
383 | * @return array|false |
||
384 | */ |
||
385 | public function tree_search(string $request) { |
||
635 | daniel-mar | 386 | return false; |
387 | } |
||
388 | } |