Subversion Repositories oidplus

Rev

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