[ ['autoload', 100000], ['onPluginsInitialized', 0] ], 'onUserLoginAuthenticate' => ['userLoginAuthenticate', 1000], 'onUserLoginFailure' => ['userLoginFailure', 0], 'onUserLogin' => ['userLogin', 0], 'onUserLogout' => ['userLogout', 0], ]; } /** * [onPluginsInitialized:100000] Composer autoload. * * @return ClassLoader */ public function autoload() { return require __DIR__ . '/vendor/autoload.php'; } /** * Initialize the plugin */ public function onPluginsInitialized() { // Check for PHP LDAP if (!function_exists('ldap_connect')) { throw new \RuntimeException('The PHP LDAP module needs to be installed and enabled'); } // Check to ensure login plugin is enabled. if (!$this->grav['config']->get('plugins.login.enabled')) { throw new \RuntimeException('The Login plugin needs to be installed and enabled'); } } public function userLoginAuthenticate(UserLoginEvent $event) { $credentials = $event->getCredentials(); // Get Proper username $user_dn = $this->config->get('plugins.login-ldap.user_dn'); $search_dn = $this->config->get('plugins.login-ldap.search_dn'); $username = str_replace('[username]', $credentials['username'], $user_dn); // Get Host info $host = $this->config->get('plugins.login-ldap.host'); $port = $this->config->get('plugins.login-ldap.port'); $version = $this->config->get('plugins.login-ldap.version'); $ssl = $this->config->get('plugins.login-ldap.ssl'); $start_tls = $this->config->get('plugins.login-ldap.start_tls'); $opt_referrals = $this->config->get('plugins.login-ldap.opt_referrals'); // Set Encryption if ((bool) $ssl) { $encryption = 'ssl'; } elseif ((bool) $start_tls) { $encryption = 'tls'; } else { $encryption = 'none'; } try { $ldap = Ldap::create('ext_ldap', array( 'host' => $host, 'port' => $port, 'encryption' => $encryption, 'options' => array( 'protocol_version' => $version, 'referrals' => (bool) $opt_referrals, ), )); // Map Info $map_username = $this->config->get('plugins.login-ldap.map_username'); $map_fullname = $this->config->get('plugins.login-ldap.map_fullname'); $map_email = $this->config->get('plugins.login-ldap.map_email'); $ldap->bind($username, $credentials['password']); $query = $ldap->query($search_dn, $map_username .'='. $credentials['username']); $results = $query->execute()->toArray(); // Create Grav User $grav_user = User::load($username); // Get LDAP Data $ldap_data = array_shift($results)->getAttributes(); $userdata = []; $userdata['login'] = $this->getLDAPMappedItem($map_username, $ldap_data); $userdata['fullname'] = $this->getLDAPMappedItem($map_fullname, $ldap_data); $userdata['email'] = $this->getLDAPMappedItem($map_email, $ldap_data); // Get LDAP Data if required if ($this->config->get('plugins.login-ldap.store_ldap_data', false)) { // $userdata['ldap'] = $ldap_data; foreach($ldap_data as $key => $data) { $userdata['ldap'][$key] = array_shift($data); } unset($userdata['ldap']['userPassword']); } $grav_user->merge($userdata); // Set Groups $current_groups = $grav_user->get('groups'); if (!$current_groups) { $groups = $this->config->get('plugins.login-ldap.default_access_levels.groups', []); if (count($groups) > 0) { $data['groups'] = $groups; $grav_user->merge($data); } } // Set Access $current_access = $grav_user->get('access'); $access = $this->config->get('plugins.login-ldap.default_access_levels.access.site'); if (!$current_access && $access) { if (count($access) > 0) { $data['access']['site'] = $access; $grav_user->merge($data); } } // Optional save if ($this->config->get('plugins.login-ldap.save_grav_user', false)) { $grav_user->save(); } $event->setUser($grav_user); $event->setStatus($event::AUTHENTICATION_SUCCESS); $event->stopPropagation(); return; } catch (ConnectionException $e) { print $e->getMessage(); $this->grav['log']->error('plugin.login-ldap: ' . $username . ' - ' . $e->getMessage()); $event->setStatus($event::AUTHENTICATION_FAILURE); $event->stopPropagation(); return; } } public function userLoginFailure(UserLoginEvent $event) { // This gets fired if user fails to log in. } public function userLogin(UserLoginEvent $event) { // This gets fired if user successfully logs in. } public function userLogout(UserLoginEvent $event) { // This gets fired on user logout. } protected function getLDAPMappedItem($map, $ldap_data) { $item_bits = []; $map_bits = explode(' ', $map); foreach($map_bits as $bit) { if(isset($ldap_data[$bit])) { $item_bits[] = array_shift($ldap_data[$bit]); } } $item = implode(' ', $item_bits); return $item; } }