X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/03dbe32f9926b53c1a0c35534e57f526c5d2bc2b..refs/pull/1881/head:/app/Auth/Access/LdapService.php diff --git a/app/Auth/Access/LdapService.php b/app/Auth/Access/LdapService.php index 3111ea9fa..07e9f7b64 100644 --- a/app/Auth/Access/LdapService.php +++ b/app/Auth/Access/LdapService.php @@ -1,36 +1,28 @@ ldap = $ldap; $this->config = config('services.ldap'); - $this->userRepo = $userRepo; $this->enabled = config('auth.method') === 'ldap'; } @@ -44,13 +36,10 @@ class LdapService extends Access\ExternalAuthService } /** - * Search for attributes for a specific user on the ldap - * @param string $userName - * @param array $attributes - * @return null|array + * Search for attributes for a specific user on the ldap. * @throws LdapException */ - private function getUserWithAttributes($userName, $attributes) + private function getUserWithAttributes(string $userName, array $attributes): ?array { $ldapConnection = $this->getConnection(); $this->bindSystemUser($ldapConnection); @@ -72,16 +61,15 @@ class LdapService extends Access\ExternalAuthService /** * Get the details of a user from LDAP using the given username. * User found via configurable user filter. - * @param $userName - * @return array|null * @throws LdapException */ - public function getUserDetails($userName) + public function getUserDetails(string $userName): ?array { + $idAttr = $this->config['id_attribute']; $emailAttr = $this->config['email_attribute']; $displayNameAttr = $this->config['display_name_attribute']; - $user = $this->getUserWithAttributes($userName, ['cn', 'uid', 'dn', $emailAttr, $displayNameAttr]); + $user = $this->getUserWithAttributes($userName, ['cn', 'dn', $idAttr, $emailAttr, $displayNameAttr]); if ($user === null) { return null; @@ -89,7 +77,7 @@ class LdapService extends Access\ExternalAuthService $userCn = $this->getUserResponseProperty($user, 'cn', null); return [ - 'uid' => $this->getUserResponseProperty($user, 'uid', $user['dn']), + 'uid' => $this->getUserResponseProperty($user, $idAttr, $user['dn']), 'name' => $this->getUserResponseProperty($user, $displayNameAttr, $userCn), 'dn' => $user['dn'], 'email' => $this->getUserResponseProperty($user, $emailAttr, null), @@ -99,13 +87,10 @@ class LdapService extends Access\ExternalAuthService /** * Get a property from an LDAP user response fetch. * Handles properties potentially being part of an array. - * @param array $userDetails - * @param string $propertyKey - * @param $defaultValue - * @return mixed */ protected function getUserResponseProperty(array $userDetails, string $propertyKey, $defaultValue) { + $propertyKey = strtolower($propertyKey); if (isset($userDetails[$propertyKey])) { return (is_array($userDetails[$propertyKey]) ? $userDetails[$propertyKey][0] : $userDetails[$propertyKey]); } @@ -114,27 +99,19 @@ class LdapService extends Access\ExternalAuthService } /** - * @param Authenticatable $user - * @param string $username - * @param string $password - * @return bool + * Check if the given credentials are valid for the given user. * @throws LdapException */ - public function validateUserCredentials(Authenticatable $user, $username, $password) + public function validateUserCredentials(array $ldapUserDetails, string $username, string $password): bool { - $ldapUser = $this->getUserDetails($username); - if ($ldapUser === null) { - return false; - } - - if ($ldapUser['uid'] !== $user->external_auth_id) { + if ($ldapUserDetails === null) { return false; } $ldapConnection = $this->getConnection(); try { - $ldapBind = $this->ldap->bind($ldapConnection, $ldapUser['dn'], $password); - } catch (\ErrorException $e) { + $ldapBind = $this->ldap->bind($ldapConnection, $ldapUserDetails['dn'], $password); + } catch (ErrorException $e) { $ldapBind = false; } @@ -204,12 +181,10 @@ class LdapService extends Access\ExternalAuthService } /** - * Parse a LDAP server string and return the host and port for - * a connection. Is flexible to formats such as 'ldap.example.com:8069' or 'ldaps://ldap.example.com' - * @param $serverString - * @return array + * Parse a LDAP server string and return the host and port for a connection. + * Is flexible to formats such as 'ldap.example.com:8069' or 'ldaps://ldap.example.com'. */ - protected function parseServerString($serverString) + protected function parseServerString(string $serverString): array { $serverNameParts = explode(':', $serverString); @@ -226,11 +201,8 @@ class LdapService extends Access\ExternalAuthService /** * Build a filter string by injecting common variables. - * @param string $filterString - * @param array $attrs - * @return string */ - protected function buildFilter($filterString, array $attrs) + protected function buildFilter(string $filterString, array $attrs): string { $newAttrs = []; foreach ($attrs as $key => $attrText) { @@ -241,12 +213,10 @@ class LdapService extends Access\ExternalAuthService } /** - * Get the groups a user is a part of on ldap - * @param string $userName - * @return array + * Get the groups a user is a part of on ldap. * @throws LdapException */ - public function getUserGroups($userName) + public function getUserGroups(string $userName): array { $groupsAttr = $this->config['group_attribute']; $user = $this->getUserWithAttributes($userName, [$groupsAttr]); @@ -261,40 +231,36 @@ class LdapService extends Access\ExternalAuthService } /** - * Get the parent groups of an array of groups - * @param array $groupsArray - * @param array $checked - * @return array + * Get the parent groups of an array of groups. * @throws LdapException */ - private function getGroupsRecursive($groupsArray, $checked) + private function getGroupsRecursive(array $groupsArray, array $checked): array { - $groups_to_add = []; + $groupsToAdd = []; foreach ($groupsArray as $groupName) { if (in_array($groupName, $checked)) { continue; } - $groupsToAdd = $this->getGroupGroups($groupName); - $groups_to_add = array_merge($groups_to_add, $groupsToAdd); + $parentGroups = $this->getGroupGroups($groupName); + $groupsToAdd = array_merge($groupsToAdd, $parentGroups); $checked[] = $groupName; } - $groupsArray = array_unique(array_merge($groupsArray, $groups_to_add), SORT_REGULAR); - if (!empty($groups_to_add)) { - return $this->getGroupsRecursive($groupsArray, $checked); - } else { + $groupsArray = array_unique(array_merge($groupsArray, $groupsToAdd), SORT_REGULAR); + + if (empty($groupsToAdd)) { return $groupsArray; } + + return $this->getGroupsRecursive($groupsArray, $checked); } /** - * Get the parent groups of a single group - * @param string $groupName - * @return array + * Get the parent groups of a single group. * @throws LdapException */ - private function getGroupGroups($groupName) + private function getGroupGroups(string $groupName): array { $ldapConnection = $this->getConnection(); $this->bindSystemUser($ldapConnection); @@ -311,17 +277,14 @@ class LdapService extends Access\ExternalAuthService return []; } - $groupGroups = $this->groupFilter($groups[0]); - return $groupGroups; + return $this->groupFilter($groups[0]); } /** - * Filter out LDAP CN and DN language in a ldap search return - * Gets the base CN (common name) of the string - * @param array $userGroupSearchResponse - * @return array + * Filter out LDAP CN and DN language in a ldap search return. + * Gets the base CN (common name) of the string. */ - protected function groupFilter(array $userGroupSearchResponse) + protected function groupFilter(array $userGroupSearchResponse): array { $groupsAttr = strtolower($this->config['group_attribute']); $ldapGroups = []; @@ -342,9 +305,7 @@ class LdapService extends Access\ExternalAuthService } /** - * Sync the LDAP groups to the user roles for the current user - * @param \BookStack\Auth\User $user - * @param string $username + * Sync the LDAP groups to the user roles for the current user. * @throws LdapException */ public function syncGroups(User $user, string $username)