Subversion Repositories oidplus

Rev

Rev 1131 | Rev 1166 | 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 OIDplusPagePublicLoginLdap extends OIDplusPagePluginPublic
  27.         implements INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_5, /* alternativeLoginMethods */
  28.                    INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_8  /* getNotifications */
  29. {
  30.  
  31.         /**
  32.          * @param OIDplusRA $ra
  33.          * @param array $ldap_userinfo
  34.          * @return void
  35.          * @throws OIDplusException
  36.          */
  37.         private function registerRA(OIDplusRA $ra, array $ldap_userinfo) {
  38.                 $email = $ra->raEmail();
  39.  
  40.                 $ra->register_ra(null); // create a user account without password
  41.  
  42.                 /*
  43.                 OIDplus DB Field          ActiveDirectory field
  44.                 ------------------------------------------------
  45.                 ra_name                   cn
  46.                 personal_name             displayname (or: givenname + " " + sn)
  47.                 organization              company
  48.                 office                    physicaldeliveryofficename or department
  49.                 street                    streetaddress
  50.                 zip_town                  postalcode + " " + l
  51.                 country                   co (human-readable) or c (ISO country code)
  52.                 phone                     telephonenumber or homephone
  53.                 mobile                    mobile
  54.                 fax                       facsimiletelephonenumber
  55.                 (none)                    wwwhomepage
  56.                 */
  57.  
  58.                 $opuserdata = array();
  59.                 $opuserdata['ra_name'] = \VtsLDAPUtils::getString($ldap_userinfo,'cn');
  60.                 if (!empty(\VtsLDAPUtils::getString($ldap_userinfo,'displayname'))) {
  61.                         $opuserdata['personal_name'] = \VtsLDAPUtils::getString($ldap_userinfo,'displayname');
  62.                 } else {
  63.                         $opuserdata['personal_name'] = trim(\VtsLDAPUtils::getString($ldap_userinfo,'givenname').' '.\VtsLDAPUtils::getString($ldap_userinfo,'sn'));
  64.                 }
  65.                 $opuserdata['organization'] = \VtsLDAPUtils::getString($ldap_userinfo,'company');
  66.                 if (!empty(\VtsLDAPUtils::getString($ldap_userinfo,'physicaldeliveryofficename'))) {
  67.                         $opuserdata['office'] = \VtsLDAPUtils::getString($ldap_userinfo,'physicaldeliveryofficename');
  68.                 } else {
  69.                         $opuserdata['office'] = \VtsLDAPUtils::getString($ldap_userinfo,'department');
  70.                 }
  71.                 $opuserdata['street'] = \VtsLDAPUtils::getString($ldap_userinfo,'streetaddress');
  72.                 $opuserdata['zip_town'] = trim(\VtsLDAPUtils::getString($ldap_userinfo,'postalcode').' '.\VtsLDAPUtils::getString($ldap_userinfo,'l'));
  73.                 $opuserdata['country'] = \VtsLDAPUtils::getString($ldap_userinfo,'co'); // ISO country code: \VtsLDAPUtils::getString($ldap_userinfo,'c')
  74.                 $opuserdata['phone'] = \VtsLDAPUtils::getString($ldap_userinfo,'telephonenumber'); // homephone for private phone number
  75.                 $opuserdata['mobile'] = \VtsLDAPUtils::getString($ldap_userinfo,'mobile');
  76.                 $opuserdata['fax'] = \VtsLDAPUtils::getString($ldap_userinfo,'facsimiletelephonenumber');
  77.  
  78.                 foreach ($opuserdata as $dbfield => $val) {
  79.                         if (!empty($val)) {
  80.                                 OIDplus::db()->query("update ###ra set ".$dbfield." = ? where email = ?", array($val, $email));
  81.                         }
  82.                 }
  83.         }
  84.  
  85.         /**
  86.          * @param bool $remember_me
  87.          * @param string $email
  88.          * @param array $ldap_userinfo
  89.          * @return void
  90.          * @throws OIDplusException
  91.          */
  92.         private function doLoginRA(bool $remember_me, string $email, array $ldap_userinfo) {
  93.                 $ra = new OIDplusRA($email);
  94.                 if (!$ra->existing()) {
  95.                         $this->registerRA($ra, $ldap_userinfo);
  96.                         OIDplus::logger()->log("[INFO]RA($email)!", "RA '$email' was created because of successful LDAP login");
  97.                 }
  98.  
  99.                 OIDplus::authUtils()->raLoginEx($email, $remember_me, 'LDAP');
  100.  
  101.                 OIDplus::db()->query("UPDATE ###ra set last_login = ".OIDplus::db()->sqlDate()." where email = ?", array($email));
  102.         }
  103.  
  104.         /**
  105.          * @param string $upn
  106.          * @return int
  107.          * @throws OIDplusException
  108.          */
  109.         private function getDomainNumber(string $upn): int {
  110.                 $numDomains = OIDplus::baseConfig()->getValue('LDAP_NUM_DOMAINS', 1);
  111.                 for ($i=1; $i<=$numDomains; $i++) {
  112.                         $cfgSuffix = $i == 1 ? '' : "__$i";
  113.                         $upnSuffix = OIDplus::baseConfig()->getValue('LDAP_UPN_SUFFIX'.$cfgSuffix, '');
  114.                         if (str_ends_with($upn, $upnSuffix)) return $i;
  115.                 }
  116.                 return -1;
  117.         }
  118.  
  119.         /**
  120.          * @param string $actionID
  121.          * @param array $params
  122.          * @return array
  123.          * @throws OIDplusConfigInitializationException
  124.          * @throws OIDplusException
  125.          */
  126.         public function action(string $actionID, array $params): array {
  127.                 if ($actionID == 'ra_login_ldap') {
  128.                         if (!OIDplus::baseConfig()->getValue('LDAP_ENABLED', false)) {
  129.                                 throw new OIDplusException(_L('LDAP authentication is disabled on this system.'));
  130.                         }
  131.  
  132.                         if (!function_exists('ldap_connect')) throw new OIDplusConfigInitializationException(_L('PHP extension "%1" not installed','LDAP'));
  133.  
  134.                         OIDplus::getActiveCaptchaPlugin()->captchaVerify($params, 'captcha');
  135.  
  136.                         _CheckParamExists($params, 'email');
  137.                         _CheckParamExists($params, 'password');
  138.  
  139.                         $upn = $params['email'];
  140.                         $password = $params['password'];
  141.  
  142.                         $domainNumber = $this->getDomainNumber($upn);
  143.                         if ($domainNumber <= 0) {
  144.                                 throw new OIDplusException(_L('The server is not configured to handle this domain (the part behind the at-sign)'));
  145.                         }
  146.                         $cfgSuffix = $domainNumber == 1 ? '' : "__$domainNumber";
  147.  
  148.                         if (empty($upn)) {
  149.                                 throw new OIDplusException(_L('Please enter a valid username'));
  150.                         }
  151.  
  152.                         $ldap = new \VtsLDAPUtils();
  153.  
  154.                         try {
  155.  
  156.                                 $cfg_ldap_server      = OIDplus::baseConfig()->getValue('LDAP_SERVER'.$cfgSuffix);
  157.                                 $cfg_ldap_port        = OIDplus::baseConfig()->getValue('LDAP_PORT'.$cfgSuffix, 389);
  158.                                 $cfg_ldap_base_dn     = OIDplus::baseConfig()->getValue('LDAP_BASE_DN'.$cfgSuffix);
  159.  
  160.                                 // Note: Will throw an Exception if connect fails
  161.                                 $ldap->connect($cfg_ldap_server, $cfg_ldap_port);
  162.  
  163.                                 if (!$ldap->login($upn, $password)) {
  164.                                         if (OIDplus::config()->getValue('log_failed_ra_logins', false)) {
  165.                                                 OIDplus::logger()->log("[WARN]A!", "Failed login to RA account '$upn' using LDAP");
  166.                                         }
  167.                                         throw new OIDplusException(_L('Wrong password or user not registered'));
  168.                                 }
  169.  
  170.                                 $ldap_userinfo = $ldap->getUserInfo($upn, $cfg_ldap_base_dn);
  171.  
  172.                                 if (!$ldap_userinfo) {
  173.                                         throw new OIDplusException(_L('The LDAP login was successful, but the own user %1 cannot be found. Please check the base configuration setting %2 and %3', $upn, "LDAP_BASE_DN$cfgSuffix", "LDAP_UPN_SUFFIX$cfgSuffix"));
  174.                                 }
  175.  
  176.                                 $foundSomething = false;
  177.  
  178.                                 // ---
  179.  
  180.                                 $cfgAdminGroup = OIDplus::baseConfig()->getValue('LDAP_ADMIN_GROUP'.$cfgSuffix,'');
  181.                                 if (!empty($cfgAdminGroup)) {
  182.                                         $isAdmin = $ldap->isMemberOfRec($ldap_userinfo, $cfgAdminGroup);
  183.                                 } else {
  184.                                         $isAdmin = false;
  185.                                 }
  186.                                 if ($isAdmin) {
  187.                                         $foundSomething = true;
  188.                                         $remember_me = isset($params['remember_me']) && ($params['remember_me']);
  189.                                         OIDplus::authUtils()->adminLoginEx($remember_me, 'LDAP login');
  190.                                 }
  191.  
  192.                                 // ---
  193.  
  194.                                 $cfgRaGroup = OIDplus::baseConfig()->getValue('LDAP_RA_GROUP'.$cfgSuffix,'');
  195.                                 if (!empty($cfgRaGroup)) {
  196.                                         $isRA = $ldap->isMemberOfRec($ldap_userinfo, $cfgRaGroup);
  197.                                 } else {
  198.                                         $isRA = true;
  199.                                 }
  200.                                 if ($isRA) {
  201.                                         if (OIDplus::baseConfig()->getValue('LDAP_AUTHENTICATE_UPN'.$cfgSuffix,true)) {
  202.                                                 $mail = \VtsLDAPUtils::getString($ldap_userinfo, 'userprincipalname');
  203.                                                 $foundSomething = true;
  204.                                                 $remember_me = isset($params['remember_me']) && ($params['remember_me']);
  205.                                                 $this->doLoginRA($remember_me, $mail, $ldap_userinfo);
  206.                                         }
  207.                                         if (OIDplus::baseConfig()->getValue('LDAP_AUTHENTICATE_EMAIL'.$cfgSuffix,false)) {
  208.                                                 $mails = \VtsLDAPUtils::getArray($ldap_userinfo, 'mail');
  209.                                                 foreach ($mails as $mail) {
  210.                                                         $foundSomething = true;
  211.                                                         $remember_me = isset($params['remember_me']) && ($params['remember_me']);
  212.                                                         $this->doLoginRA($remember_me, $mail, $ldap_userinfo);
  213.                                                 }
  214.                                         }
  215.                                 }
  216.  
  217.                         } finally {
  218.                                 $ldap->disconnect();
  219.                                 $ldap = null;
  220.                         }
  221.  
  222.                         if (!$foundSomething) {
  223.                                 throw new OIDplusException(_L("Error: These credentials cannot be used with OIDplus. Please check the base configuration."));
  224.                         }
  225.  
  226.                         return array("status" => 0);
  227.                 } else {
  228.                         return parent::action($actionID, $params);
  229.                 }
  230.         }
  231.  
  232.         /**
  233.          * @param bool $html
  234.          * @return void
  235.          */
  236.         public function init(bool $html=true) {
  237.                 // Nothing
  238.         }
  239.  
  240.         /**
  241.          * @param string $id
  242.          * @param array $out
  243.          * @param bool $handled
  244.          * @return void
  245.          * @throws OIDplusException
  246.          */
  247.         public function gui(string $id, array &$out, bool &$handled) {
  248.                 if ($id === 'oidplus:login_ldap') {
  249.                         $handled = true;
  250.                         $out['title'] = _L('Login using LDAP / ActiveDirectory');
  251.                         $out['icon']  = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png';
  252.  
  253.                         if (!OIDplus::baseConfig()->getValue('LDAP_ENABLED', false)) {
  254.                                 $out['icon'] = 'img/error.png';
  255.                                 $out['text'] = _L('LDAP authentication is disabled on this system.');
  256.                                 return;
  257.                         }
  258.  
  259.                         if (!function_exists('ldap_connect')) {
  260.                                 $out['icon'] = 'img/error.png';
  261.                                 $out['text'] = _L('PHP extension "%1" not installed','LDAP');
  262.                                 return;
  263.                         }
  264.  
  265.                         $out['text']  = '<noscript>';
  266.                         $out['text'] .= '<p>'._L('You need to enable JavaScript to use the login area.').'</p>';
  267.                         $out['text'] .= '</noscript>';
  268.  
  269.                         $out['text'] .= '<div id="loginLdapArea" style="visibility: hidden">';
  270.  
  271.                         $out['text'] .= OIDplus::getActiveCaptchaPlugin()->captchaGenerate(_L('Before logging in, please solve the following CAPTCHA'));
  272.                         $out['text'] .= '<br>';
  273.  
  274.                         $out['text'] .= '<p><a '.OIDplus::gui()->link('oidplus:login').'><img src="img/arrow_back.png" width="16" alt="'._L('Go back').'"> '._L('Regular login method').'</a></p>';
  275.  
  276.                         $out['text'] .= '<h2>'._L('Login as RA').'</h2>';
  277.  
  278.                         $login_list = OIDplus::authUtils()->loggedInRaList();
  279.                         if (count($login_list) > 0) {
  280.                                 foreach ($login_list as $x) {
  281.                                         $out['text'] .= '<p>'._L('You are logged in as %1','<b>'.$x->raEmail().'</b>').' (<a href="#" onclick="return OIDplusPagePublicLogin.raLogout('.js_escape($x->raEmail()).');">'._L('Logout').'</a>)</p>';
  282.                                 }
  283.                                 $out['text'] .= '<p>'._L('If you have more accounts, you can log in with another account here.').'</p>';
  284.                         } else {
  285.                                 $out['text'] .= '<p>'._L('Enter your domain username and your password to log in as Registration Authority.').'</p>';
  286.                         }
  287.                         $out['text'] .= '<form onsubmit="return OIDplusPagePublicLoginLDAP.raLoginLdapOnSubmit(this);">';
  288.                         $out['text'] .= '<div><label class="padding_label">'._L('Username').':</label><input type="text" name="username" value="" id="raLoginLdapUsername">';
  289.                         $out['text'] .= '&nbsp;&nbsp;';
  290.                         $out['text'] .= '<select id="ldapUpnSuffix" name="upnSuffix">';
  291.  
  292.                         $numDomains = OIDplus::baseConfig()->getValue('LDAP_NUM_DOMAINS', 1);
  293.                         for ($i=1; $i<=$numDomains; $i++) {
  294.                                 $cfgSuffix = $i == 1 ? '' : "__$i";
  295.                                 $upnSuffix = OIDplus::baseConfig()->getValue('LDAP_UPN_SUFFIX'.$cfgSuffix, '');
  296.                                 if ($upnSuffix == '') throw new OIDplusException(_L('Invalid base configuration setting: %1 is missing or empty', 'LDAP_UPN_SUFFIX'.$cfgSuffix));
  297.                                 $out['text'] .= '<option value="'.htmlentities($upnSuffix).'">'.htmlentities($upnSuffix).'</option>';
  298.                         }
  299.  
  300.                         $out['text'] .= '</select>';
  301.                         $out['text'] .= '</div>';
  302.                         $out['text'] .= '<div><label class="padding_label">'._L('Password').':</label><input type="password" name="password" value="" id="raLoginLdapPassword"></div>';
  303.                         if (OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_USER', true)) {
  304.                                 if ((OIDplus::authUtils()->getAuthMethod() === OIDplusAuthContentStoreJWT::class)) {
  305.                                         if (OIDplus::authUtils()->getExtendedAttribute('oidplus_generator',-1) === OIDplusAuthContentStoreJWT::JWT_GENERATOR_LOGIN) {
  306.                                                 $att = 'disabled checked';
  307.                                         } else {
  308.                                                 $att = 'disabled';
  309.                                         }
  310.                                 } else if ((OIDplus::authUtils()->getAuthMethod() === OIDplusAuthContentStoreSession::class)) {
  311.                                         $att = 'disabled';
  312.                                 } else {
  313.                                         $att = '';
  314.                                 }
  315.                                 $out['text'] .= '<div><input '.$att.' type="checkbox" value="1" id="remember_me_ldap" name="remember_me_ldap"> <label for="remember_me_ldap">'._L('Remember me').'</label></div>';
  316.                         }
  317.                         $out['text'] .= '<br><input type="submit" value="'._L('Login').'"><br><br>';
  318.                         $out['text'] .= '</form>';
  319.  
  320.                         $invitePlugin = OIDplus::getPluginByOid('1.3.6.1.4.1.37476.2.5.2.4.2.92'); // OIDplusPageRaInvite
  321.                         $out['text'] .= '<p><abbr title="'._L('You don\'t need to register. Just enter your Windows/Company credentials.').'">'._L('How to register?').'</abbr></p>';
  322.  
  323.                         $mins = ceil(OIDplus::baseConfig()->getValue('SESSION_LIFETIME', 30*60)/60);
  324.                         $out['text'] .= '<p><font size="-1">'._L('<i>Privacy information</i>: By using the login functionality, you are accepting that a "session cookie" is temporarily stored in your browser. The session cookie is a small text file that is sent to this website every time you visit it, to identify you as an already logged in user. It does not track any of your online activities outside OIDplus. The cookie will be destroyed when you log out or after an inactivity of %1 minutes (except if the "Remember me" option is used).', $mins);
  325.                         $privacy_document_file = 'OIDplus/privacy_documentation.html';
  326.                         $resourcePlugin = OIDplus::getPluginByOid('1.3.6.1.4.1.37476.2.5.2.4.1.500'); // OIDplusPagePublicResources
  327.                         if (!is_null($resourcePlugin) && file_exists(OIDplus::localpath().'res/'.$privacy_document_file)) {
  328.                                 $out['text'] .= ' <a '.OIDplus::gui()->link('oidplus:resources$'.$privacy_document_file.'#cookies').'>'._L('More information about the cookies used').'</a>';
  329.                         }
  330.                         $out['text'] .= '</font></p></div>';
  331.  
  332.                         $out['text'] .= '<script>$("#loginLdapArea")[0].style.visibility = "visible";</script>';
  333.                 }
  334.         }
  335.  
  336.         /**
  337.          * @param array $out
  338.          * @return void
  339.          */
  340.         public function publicSitemap(array &$out) {
  341.                 $out[] = 'oidplus:login_ldap';
  342.         }
  343.  
  344.         /**
  345.          * @param array $json
  346.          * @param string|null $ra_email
  347.          * @param bool $nonjs
  348.          * @param string $req_goto
  349.          * @return bool
  350.          */
  351.         public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool {
  352.                 return true;
  353.         }
  354.  
  355.         /**
  356.          * @param string $request
  357.          * @return array|false
  358.          */
  359.         public function tree_search(string $request) {
  360.                 return false;
  361.         }
  362.  
  363.         /**
  364.          * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_5
  365.          * @return array
  366.          * @throws OIDplusException
  367.          */
  368.         public function alternativeLoginMethods(): array {
  369.                 $logins = array();
  370.                 if (OIDplus::baseConfig()->getValue('LDAP_ENABLED', false)) {
  371.                         $logins[] = array(
  372.                                 'oidplus:login_ldap',
  373.                                 _L('Login using LDAP / ActiveDirectory'),
  374.                                 OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon16.png'
  375.                         );
  376.                 }
  377.                 return $logins;
  378.         }
  379.  
  380.         /**
  381.          * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_8
  382.          * @param string|null $user
  383.          * @return array
  384.          * @throws OIDplusException
  385.          */
  386.         public function getNotifications(string $user=null): array {
  387.                 $notifications = array();
  388.                 if ((!$user || ($user == 'admin')) && OIDplus::authUtils()->isAdminLoggedIn()) {
  389.                         if (OIDplus::baseConfig()->getValue('LDAP_ENABLED', false)) {
  390.                                 if (!function_exists('ldap_connect')) {
  391.                                         $title = _L('LDAP Login');
  392.                                         $notifications[] = array('ERR', _L('OIDplus plugin "%1" is enabled, but the required PHP extension "%2" is not installed.', htmlentities($title), 'php_ldap'));
  393.                                 }
  394.                         }
  395.                 }
  396.                 return $notifications;
  397.         }
  398.  
  399. }
  400.