Subversion Repositories oidplus

Rev

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