12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463 |
- <?php
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Alexander Bergolth <leo@strike.wu.ac.at>
- * @author Alex Weirig <alex.weirig@technolink.lu>
- * @author alexweirig <alex.weirig@technolink.lu>
- * @author Andreas Fischer <bantu@owncloud.com>
- * @author Andreas Pflug <dev@admin4.org>
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Clement Wong <git@clement.hk>
- * @author Frédéric Fortier <frederic.fortier@oronospolytechnique.com>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Nicolas Grekas <nicolas.grekas@gmail.com>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Roland Tapken <roland@bitarbeiter.net>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Tobias Perschon <tobias@perschon.at>
- * @author Victor Dubiniuk <dubiniuk@owncloud.com>
- * @author Vinicius Cubas Brand <vinicius@eita.org.br>
- * @author Xuanwo <xuanwo@yunify.com>
- * @author Carl Schwan <carl@carlschwan.eu>
- * @author Côme Chilliet <come.chilliet@nextcloud.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- namespace OCA\User_LDAP;
- use Exception;
- use OC\ServerNotAvailableException;
- use OCA\User_LDAP\User\OfflineUser;
- use OCP\Cache\CappedMemoryCache;
- use OCP\Group\Backend\ABackend;
- use OCP\Group\Backend\IDeleteGroupBackend;
- use OCP\Group\Backend\IGetDisplayNameBackend;
- use OCP\Group\Backend\IIsAdminBackend;
- use OCP\GroupInterface;
- use OCP\IConfig;
- use OCP\IUserManager;
- use OCP\Server;
- use Psr\Log\LoggerInterface;
- use function json_decode;
- class Group_LDAP extends ABackend implements GroupInterface, IGroupLDAP, IGetDisplayNameBackend, IDeleteGroupBackend, IIsAdminBackend {
- protected bool $enabled = false;
- /** @var CappedMemoryCache<string[]> $cachedGroupMembers array of user DN with gid as key */
- protected CappedMemoryCache $cachedGroupMembers;
- /** @var CappedMemoryCache<array[]> $cachedGroupsByMember array of groups with user DN as key */
- protected CappedMemoryCache $cachedGroupsByMember;
- /** @var CappedMemoryCache<string[]> $cachedNestedGroups array of groups with gid (DN) as key */
- protected CappedMemoryCache $cachedNestedGroups;
- protected GroupPluginManager $groupPluginManager;
- protected LoggerInterface $logger;
- protected Access $access;
- /**
- * @var string $ldapGroupMemberAssocAttr contains the LDAP setting (in lower case) with the same name
- */
- protected string $ldapGroupMemberAssocAttr;
- private IConfig $config;
- private IUserManager $ncUserManager;
- public function __construct(
- Access $access,
- GroupPluginManager $groupPluginManager,
- IConfig $config,
- IUserManager $ncUserManager
- ) {
- $this->access = $access;
- $filter = $this->access->connection->ldapGroupFilter;
- $gAssoc = $this->access->connection->ldapGroupMemberAssocAttr;
- if (!empty($filter) && !empty($gAssoc)) {
- $this->enabled = true;
- }
- $this->cachedGroupMembers = new CappedMemoryCache();
- $this->cachedGroupsByMember = new CappedMemoryCache();
- $this->cachedNestedGroups = new CappedMemoryCache();
- $this->groupPluginManager = $groupPluginManager;
- $this->logger = Server::get(LoggerInterface::class);
- $this->ldapGroupMemberAssocAttr = strtolower((string)$gAssoc);
- $this->config = $config;
- $this->ncUserManager = $ncUserManager;
- }
- /**
- * Check if user is in group
- *
- * @param string $uid uid of the user
- * @param string $gid gid of the group
- * @throws Exception
- * @throws ServerNotAvailableException
- */
- public function inGroup($uid, $gid): bool {
- if (!$this->enabled) {
- return false;
- }
- $cacheKey = 'inGroup' . $uid . ':' . $gid;
- $inGroup = $this->access->connection->getFromCache($cacheKey);
- if (!is_null($inGroup)) {
- return (bool)$inGroup;
- }
- $userDN = $this->access->username2dn($uid);
- if (isset($this->cachedGroupMembers[$gid])) {
- return in_array($userDN, $this->cachedGroupMembers[$gid]);
- }
- $cacheKeyMembers = 'inGroup-members:' . $gid;
- $members = $this->access->connection->getFromCache($cacheKeyMembers);
- if (!is_null($members)) {
- $this->cachedGroupMembers[$gid] = $members;
- $isInGroup = in_array($userDN, $members, true);
- $this->access->connection->writeToCache($cacheKey, $isInGroup);
- return $isInGroup;
- }
- $groupDN = $this->access->groupname2dn($gid);
- // just in case
- if (!$groupDN || !$userDN) {
- $this->access->connection->writeToCache($cacheKey, false);
- return false;
- }
- //check primary group first
- if ($gid === $this->getUserPrimaryGroup($userDN)) {
- $this->access->connection->writeToCache($cacheKey, true);
- return true;
- }
- //usually, LDAP attributes are said to be case insensitive. But there are exceptions of course.
- $members = $this->_groupMembers($groupDN);
- //extra work if we don't get back user DNs
- switch ($this->ldapGroupMemberAssocAttr) {
- case 'memberuid':
- case 'zimbramailforwardingaddress':
- $requestAttributes = $this->access->userManager->getAttributes(true);
- $users = [];
- $filterParts = [];
- $bytes = 0;
- foreach ($members as $mid) {
- if ($this->ldapGroupMemberAssocAttr === 'zimbramailforwardingaddress') {
- $parts = explode('@', $mid); //making sure we get only the uid
- $mid = $parts[0];
- }
- $filter = str_replace('%uid', $mid, $this->access->connection->ldapLoginFilter);
- $filterParts[] = $filter;
- $bytes += strlen($filter);
- if ($bytes >= 9000000) {
- // AD has a default input buffer of 10 MB, we do not want
- // to take even the chance to exceed it
- // so we fetch results with the filterParts we collected so far
- $filter = $this->access->combineFilterWithOr($filterParts);
- $search = $this->access->fetchListOfUsers($filter, $requestAttributes, count($filterParts));
- $bytes = 0;
- $filterParts = [];
- $users = array_merge($users, $search);
- }
- }
- if (count($filterParts) > 0) {
- // if there are filterParts left we need to add their result
- $filter = $this->access->combineFilterWithOr($filterParts);
- $search = $this->access->fetchListOfUsers($filter, $requestAttributes, count($filterParts));
- $users = array_merge($users, $search);
- }
- // now we cleanup the users array to get only dns
- $dns = [];
- foreach ($users as $record) {
- $dns[$record['dn'][0]] = 1;
- }
- $members = array_keys($dns);
- break;
- }
- if (count($members) === 0) {
- $this->access->connection->writeToCache($cacheKey, false);
- return false;
- }
- $isInGroup = in_array($userDN, $members);
- $this->access->connection->writeToCache($cacheKey, $isInGroup);
- $this->access->connection->writeToCache($cacheKeyMembers, $members);
- $this->cachedGroupMembers[$gid] = $members;
- return $isInGroup;
- }
- /**
- * For a group that has user membership defined by an LDAP search url
- * attribute returns the users that match the search url otherwise returns
- * an empty array.
- *
- * @throws ServerNotAvailableException
- */
- public function getDynamicGroupMembers(string $dnGroup): array {
- $dynamicGroupMemberURL = strtolower((string)$this->access->connection->ldapDynamicGroupMemberURL);
- if (empty($dynamicGroupMemberURL)) {
- return [];
- }
- $dynamicMembers = [];
- $memberURLs = $this->access->readAttribute(
- $dnGroup,
- $dynamicGroupMemberURL,
- $this->access->connection->ldapGroupFilter
- );
- if ($memberURLs !== false) {
- // this group has the 'memberURL' attribute so this is a dynamic group
- // example 1: ldap:///cn=users,cn=accounts,dc=dcsubbase,dc=dcbase??one?(o=HeadOffice)
- // example 2: ldap:///cn=users,cn=accounts,dc=dcsubbase,dc=dcbase??one?(&(o=HeadOffice)(uidNumber>=500))
- $pos = strpos($memberURLs[0], '(');
- if ($pos !== false) {
- $memberUrlFilter = substr($memberURLs[0], $pos);
- $foundMembers = $this->access->searchUsers($memberUrlFilter, ['dn']);
- $dynamicMembers = [];
- foreach ($foundMembers as $value) {
- $dynamicMembers[$value['dn'][0]] = 1;
- }
- } else {
- $this->logger->debug('No search filter found on member url of group {dn}',
- [
- 'app' => 'user_ldap',
- 'dn' => $dnGroup,
- ]
- );
- }
- }
- return $dynamicMembers;
- }
- /**
- * Get group members from dn.
- * @psalm-param array<string, bool> $seen List of DN that have already been processed.
- * @throws ServerNotAvailableException
- */
- private function _groupMembers(string $dnGroup, array $seen = [], bool &$recursive = false): array {
- if (isset($seen[$dnGroup])) {
- $recursive = true;
- return [];
- }
- $seen[$dnGroup] = true;
- // used extensively in cron job, caching makes sense for nested groups
- $cacheKey = '_groupMembers' . $dnGroup;
- $groupMembers = $this->access->connection->getFromCache($cacheKey);
- if ($groupMembers !== null) {
- return $groupMembers;
- }
- if ($this->access->connection->ldapNestedGroups
- && $this->access->connection->useMemberOfToDetectMembership
- && $this->access->connection->hasMemberOfFilterSupport
- && $this->access->connection->ldapMatchingRuleInChainState !== Configuration::LDAP_SERVER_FEATURE_UNAVAILABLE
- ) {
- $attemptedLdapMatchingRuleInChain = true;
- // Use matching rule 1.2.840.113556.1.4.1941 if available (LDAP_MATCHING_RULE_IN_CHAIN)
- $filter = $this->access->combineFilterWithAnd([
- $this->access->connection->ldapUserFilter,
- $this->access->connection->ldapUserDisplayName . '=*',
- 'memberof:1.2.840.113556.1.4.1941:=' . $dnGroup
- ]);
- $memberRecords = $this->access->fetchListOfUsers(
- $filter,
- $this->access->userManager->getAttributes(true)
- );
- $result = array_reduce($memberRecords, function ($carry, $record) {
- $carry[] = $record['dn'][0];
- return $carry;
- }, []);
- if ($this->access->connection->ldapMatchingRuleInChainState === Configuration::LDAP_SERVER_FEATURE_AVAILABLE) {
- $this->access->connection->writeToCache($cacheKey, $result);
- return $result;
- } elseif (!empty($memberRecords)) {
- $this->access->connection->ldapMatchingRuleInChainState = Configuration::LDAP_SERVER_FEATURE_AVAILABLE;
- $this->access->connection->saveConfiguration();
- $this->access->connection->writeToCache($cacheKey, $result);
- return $result;
- }
- // when feature availability is unknown, and the result is empty, continue and test with original approach
- }
- $allMembers = [];
- $members = $this->access->readAttribute($dnGroup, $this->access->connection->ldapGroupMemberAssocAttr);
- if (is_array($members)) {
- if ((int)$this->access->connection->ldapNestedGroups === 1) {
- while ($recordDn = array_shift($members)) {
- $nestedMembers = $this->_groupMembers($recordDn, $seen, $recursive);
- if (!empty($nestedMembers)) {
- // Group, queue its members for processing
- $members = array_merge($members, $nestedMembers);
- } else {
- // User (or empty group, or previously seen group), add it to the member list
- $allMembers[] = $recordDn;
- }
- }
- } else {
- $allMembers = $members;
- }
- }
- $allMembers += $this->getDynamicGroupMembers($dnGroup);
- $allMembers = array_unique($allMembers);
- // A group cannot be a member of itself
- $index = array_search($dnGroup, $allMembers, true);
- if ($index !== false) {
- unset($allMembers[$index]);
- }
- if (!$recursive) {
- $this->access->connection->writeToCache($cacheKey, $allMembers);
- }
- if (isset($attemptedLdapMatchingRuleInChain)
- && $this->access->connection->ldapMatchingRuleInChainState === Configuration::LDAP_SERVER_FEATURE_UNKNOWN
- && !empty($allMembers)
- ) {
- $this->access->connection->ldapMatchingRuleInChainState = Configuration::LDAP_SERVER_FEATURE_UNAVAILABLE;
- $this->access->connection->saveConfiguration();
- }
- return $allMembers;
- }
- /**
- * @return string[]
- * @throws ServerNotAvailableException
- */
- private function _getGroupDNsFromMemberOf(string $dn, array &$seen = []): array {
- if (isset($seen[$dn])) {
- return [];
- }
- $seen[$dn] = true;
- if (isset($this->cachedNestedGroups[$dn])) {
- return $this->cachedNestedGroups[$dn];
- }
- $allGroups = [];
- $groups = $this->access->readAttribute($dn, 'memberOf');
- if (is_array($groups)) {
- if ((int)$this->access->connection->ldapNestedGroups === 1) {
- while ($recordDn = array_shift($groups)) {
- $nestedParents = $this->_getGroupDNsFromMemberOf($recordDn, $seen);
- $groups = array_merge($groups, $nestedParents);
- $allGroups[] = $recordDn;
- }
- } else {
- $allGroups = $groups;
- }
- }
- // We do not perform array_unique here at it is done in getUserGroups later
- $this->cachedNestedGroups[$dn] = $allGroups;
- return $this->filterValidGroups($allGroups);
- }
- /**
- * Translates a gidNumber into the Nextcloud internal name.
- *
- * @return string|false The nextcloud internal name.
- * @throws Exception
- * @throws ServerNotAvailableException
- */
- public function gidNumber2Name(string $gid, string $dn) {
- $cacheKey = 'gidNumberToName' . $gid;
- $groupName = $this->access->connection->getFromCache($cacheKey);
- if (!is_null($groupName) && isset($groupName)) {
- return $groupName;
- }
- //we need to get the DN from LDAP
- $filter = $this->access->combineFilterWithAnd([
- $this->access->connection->ldapGroupFilter,
- 'objectClass=posixGroup',
- $this->access->connection->ldapGidNumber . '=' . $gid
- ]);
- return $this->getNameOfGroup($filter, $cacheKey) ?? false;
- }
- /**
- * @return string|null|false The name of the group
- * @throws ServerNotAvailableException
- * @throws Exception
- */
- private function getNameOfGroup(string $filter, string $cacheKey) {
- $result = $this->access->searchGroups($filter, ['dn'], 1);
- if (empty($result)) {
- $this->access->connection->writeToCache($cacheKey, false);
- return null;
- }
- $dn = $result[0]['dn'][0];
- //and now the group name
- //NOTE once we have separate Nextcloud group IDs and group names we can
- //directly read the display name attribute instead of the DN
- $name = $this->access->dn2groupname($dn);
- $this->access->connection->writeToCache($cacheKey, $name);
- return $name;
- }
- /**
- * @return string|bool The entry's gidNumber
- * @throws ServerNotAvailableException
- */
- private function getEntryGidNumber(string $dn, string $attribute) {
- $value = $this->access->readAttribute($dn, $attribute);
- if (is_array($value) && !empty($value)) {
- return $value[0];
- }
- return false;
- }
- /**
- * @return string|bool The group's gidNumber
- * @throws ServerNotAvailableException
- */
- public function getGroupGidNumber(string $dn) {
- return $this->getEntryGidNumber($dn, 'gidNumber');
- }
- /**
- * @return string|bool The user's gidNumber
- * @throws ServerNotAvailableException
- */
- public function getUserGidNumber(string $dn) {
- $gidNumber = false;
- if ($this->access->connection->hasGidNumber) {
- // FIXME: when $dn does not exist on LDAP anymore, this will be set wrongly to false :/
- $gidNumber = $this->getEntryGidNumber($dn, $this->access->connection->ldapGidNumber);
- if ($gidNumber === false) {
- $this->access->connection->hasGidNumber = false;
- }
- }
- return $gidNumber;
- }
- /**
- * @throws ServerNotAvailableException
- * @throws Exception
- */
- private function prepareFilterForUsersHasGidNumber(string $groupDN, string $search = ''): string {
- $groupID = $this->getGroupGidNumber($groupDN);
- if ($groupID === false) {
- throw new Exception('Not a valid group');
- }
- $filterParts = [];
- $filterParts[] = $this->access->getFilterForUserCount();
- if ($search !== '') {
- $filterParts[] = $this->access->getFilterPartForUserSearch($search);
- }
- $filterParts[] = $this->access->connection->ldapGidNumber . '=' . $groupID;
- return $this->access->combineFilterWithAnd($filterParts);
- }
- /**
- * @return array<int,string> A list of users that have the given group as gid number
- * @throws ServerNotAvailableException
- */
- public function getUsersInGidNumber(
- string $groupDN,
- string $search = '',
- ?int $limit = -1,
- ?int $offset = 0
- ): array {
- try {
- $filter = $this->prepareFilterForUsersHasGidNumber($groupDN, $search);
- $users = $this->access->fetchListOfUsers(
- $filter,
- $this->access->userManager->getAttributes(true),
- $limit,
- $offset
- );
- return $this->access->nextcloudUserNames($users);
- } catch (ServerNotAvailableException $e) {
- throw $e;
- } catch (Exception $e) {
- return [];
- }
- }
- /**
- * @throws ServerNotAvailableException
- * @return false|string
- */
- public function getUserGroupByGid(string $dn) {
- $groupID = $this->getUserGidNumber($dn);
- if ($groupID !== false) {
- $groupName = $this->gidNumber2Name($groupID, $dn);
- if ($groupName !== false) {
- return $groupName;
- }
- }
- return false;
- }
- /**
- * Translates a primary group ID into an Nextcloud internal name
- *
- * @return string|false
- * @throws Exception
- * @throws ServerNotAvailableException
- */
- public function primaryGroupID2Name(string $gid, string $dn) {
- $cacheKey = 'primaryGroupIDtoName_' . $gid;
- $groupName = $this->access->connection->getFromCache($cacheKey);
- if (!is_null($groupName)) {
- return $groupName;
- }
- $domainObjectSid = $this->access->getSID($dn);
- if ($domainObjectSid === false) {
- return false;
- }
- //we need to get the DN from LDAP
- $filter = $this->access->combineFilterWithAnd([
- $this->access->connection->ldapGroupFilter,
- 'objectsid=' . $domainObjectSid . '-' . $gid
- ]);
- return $this->getNameOfGroup($filter, $cacheKey) ?? false;
- }
- /**
- * @return string|false The entry's group Id
- * @throws ServerNotAvailableException
- */
- private function getEntryGroupID(string $dn, string $attribute) {
- $value = $this->access->readAttribute($dn, $attribute);
- if (is_array($value) && !empty($value)) {
- return $value[0];
- }
- return false;
- }
- /**
- * @return string|false The entry's primary group Id
- * @throws ServerNotAvailableException
- */
- public function getGroupPrimaryGroupID(string $dn) {
- return $this->getEntryGroupID($dn, 'primaryGroupToken');
- }
- /**
- * @return string|false
- * @throws ServerNotAvailableException
- */
- public function getUserPrimaryGroupIDs(string $dn) {
- $primaryGroupID = false;
- if ($this->access->connection->hasPrimaryGroups) {
- $primaryGroupID = $this->getEntryGroupID($dn, 'primaryGroupID');
- if ($primaryGroupID === false) {
- $this->access->connection->hasPrimaryGroups = false;
- }
- }
- return $primaryGroupID;
- }
- /**
- * @throws Exception
- * @throws ServerNotAvailableException
- */
- private function prepareFilterForUsersInPrimaryGroup(string $groupDN, string $search = ''): string {
- $groupID = $this->getGroupPrimaryGroupID($groupDN);
- if ($groupID === false) {
- throw new Exception('Not a valid group');
- }
- $filterParts = [];
- $filterParts[] = $this->access->getFilterForUserCount();
- if ($search !== '') {
- $filterParts[] = $this->access->getFilterPartForUserSearch($search);
- }
- $filterParts[] = 'primaryGroupID=' . $groupID;
- return $this->access->combineFilterWithAnd($filterParts);
- }
- /**
- * @throws ServerNotAvailableException
- * @return array<int,string>
- */
- public function getUsersInPrimaryGroup(
- string $groupDN,
- string $search = '',
- ?int $limit = -1,
- ?int $offset = 0
- ): array {
- try {
- $filter = $this->prepareFilterForUsersInPrimaryGroup($groupDN, $search);
- $users = $this->access->fetchListOfUsers(
- $filter,
- $this->access->userManager->getAttributes(true),
- $limit,
- $offset
- );
- return $this->access->nextcloudUserNames($users);
- } catch (ServerNotAvailableException $e) {
- throw $e;
- } catch (Exception $e) {
- return [];
- }
- }
- /**
- * @throws ServerNotAvailableException
- */
- public function countUsersInPrimaryGroup(
- string $groupDN,
- string $search = '',
- int $limit = -1,
- int $offset = 0
- ): int {
- try {
- $filter = $this->prepareFilterForUsersInPrimaryGroup($groupDN, $search);
- $users = $this->access->countUsers($filter, ['dn'], $limit, $offset);
- return (int)$users;
- } catch (ServerNotAvailableException $e) {
- throw $e;
- } catch (Exception $e) {
- return 0;
- }
- }
- /**
- * @return string|false
- * @throws ServerNotAvailableException
- */
- public function getUserPrimaryGroup(string $dn) {
- $groupID = $this->getUserPrimaryGroupIDs($dn);
- if ($groupID !== false) {
- $groupName = $this->primaryGroupID2Name($groupID, $dn);
- if ($groupName !== false) {
- return $groupName;
- }
- }
- return false;
- }
- private function isUserOnLDAP(string $uid): bool {
- // forces a user exists check - but does not help if a positive result is cached, while group info is not
- $ncUser = $this->ncUserManager->get($uid);
- if ($ncUser === null) {
- return false;
- }
- $backend = $ncUser->getBackend();
- if ($backend instanceof User_Proxy) {
- // ignoring cache as safeguard (and we are behind the group cache check anyway)
- return $backend->userExistsOnLDAP($uid, true);
- }
- return false;
- }
- protected function getCachedGroupsForUserId(string $uid): array {
- $groupStr = $this->config->getUserValue($uid, 'user_ldap', 'cached-group-memberships-' . $this->access->connection->getConfigPrefix(), '[]');
- return json_decode($groupStr, true) ?? [];
- }
- /**
- * This function fetches all groups a user belongs to. It does not check
- * if the user exists at all.
- *
- * This function includes groups based on dynamic group membership.
- *
- * @param string $uid Name of the user
- * @return string[] Group names
- * @throws Exception
- * @throws ServerNotAvailableException
- */
- public function getUserGroups($uid): array {
- if (!$this->enabled) {
- return [];
- }
- $ncUid = $uid;
- $cacheKey = 'getUserGroups' . $uid;
- $userGroups = $this->access->connection->getFromCache($cacheKey);
- if (!is_null($userGroups)) {
- return $userGroups;
- }
- $user = $this->access->userManager->get($uid);
- if ($user instanceof OfflineUser) {
- // We load known group memberships from configuration for remnants,
- // because LDAP server does not contain them anymore
- return $this->getCachedGroupsForUserId($uid);
- }
- $userDN = $this->access->username2dn($uid);
- if (!$userDN) {
- $this->access->connection->writeToCache($cacheKey, []);
- return [];
- }
- $groups = [];
- $primaryGroup = $this->getUserPrimaryGroup($userDN);
- $gidGroupName = $this->getUserGroupByGid($userDN);
- $dynamicGroupMemberURL = strtolower($this->access->connection->ldapDynamicGroupMemberURL);
- if (!empty($dynamicGroupMemberURL)) {
- // look through dynamic groups to add them to the result array if needed
- $groupsToMatch = $this->access->fetchListOfGroups(
- $this->access->connection->ldapGroupFilter, ['dn', $dynamicGroupMemberURL]);
- foreach ($groupsToMatch as $dynamicGroup) {
- if (!isset($dynamicGroup[$dynamicGroupMemberURL][0])) {
- continue;
- }
- $pos = strpos($dynamicGroup[$dynamicGroupMemberURL][0], '(');
- if ($pos !== false) {
- $memberUrlFilter = substr($dynamicGroup[$dynamicGroupMemberURL][0], $pos);
- // apply filter via ldap search to see if this user is in this
- // dynamic group
- $userMatch = $this->access->readAttribute(
- $userDN,
- $this->access->connection->ldapUserDisplayName,
- $memberUrlFilter
- );
- if ($userMatch !== false) {
- // match found so this user is in this group
- $groupName = $this->access->dn2groupname($dynamicGroup['dn'][0]);
- if (is_string($groupName)) {
- // be sure to never return false if the dn could not be
- // resolved to a name, for whatever reason.
- $groups[] = $groupName;
- }
- }
- } else {
- $this->logger->debug('No search filter found on member url of group {dn}',
- [
- 'app' => 'user_ldap',
- 'dn' => $dynamicGroup,
- ]
- );
- }
- }
- }
- // if possible, read out membership via memberOf. It's far faster than
- // performing a search, which still is a fallback later.
- // memberof doesn't support memberuid, so skip it here.
- if ((int)$this->access->connection->hasMemberOfFilterSupport === 1
- && (int)$this->access->connection->useMemberOfToDetectMembership === 1
- && $this->ldapGroupMemberAssocAttr !== 'memberuid'
- && $this->ldapGroupMemberAssocAttr !== 'zimbramailforwardingaddress') {
- $groupDNs = $this->_getGroupDNsFromMemberOf($userDN);
- foreach ($groupDNs as $dn) {
- $groupName = $this->access->dn2groupname($dn);
- if (is_string($groupName)) {
- // be sure to never return false if the dn could not be
- // resolved to a name, for whatever reason.
- $groups[] = $groupName;
- }
- }
- } else {
- // uniqueMember takes DN, memberuid the uid, so we need to distinguish
- switch ($this->ldapGroupMemberAssocAttr) {
- case 'uniquemember':
- case 'member':
- $uid = $userDN;
- break;
- case 'memberuid':
- case 'zimbramailforwardingaddress':
- $result = $this->access->readAttribute($userDN, 'uid');
- if ($result === false) {
- $this->logger->debug('No uid attribute found for DN {dn} on {host}',
- [
- 'app' => 'user_ldap',
- 'dn' => $userDN,
- 'host' => $this->access->connection->ldapHost,
- ]
- );
- $uid = false;
- } else {
- $uid = $result[0];
- }
- break;
- default:
- // just in case
- $uid = $userDN;
- break;
- }
- if ($uid !== false) {
- $groupsByMember = array_values($this->getGroupsByMember($uid));
- $groupsByMember = $this->access->nextcloudGroupNames($groupsByMember);
- $groups = array_merge($groups, $groupsByMember);
- }
- }
- if ($primaryGroup !== false) {
- $groups[] = $primaryGroup;
- }
- if ($gidGroupName !== false) {
- $groups[] = $gidGroupName;
- }
- if (empty($groups) && !$this->isUserOnLDAP($ncUid)) {
- // Groups are enabled, but you user has none? Potentially suspicious:
- // it could be that the user was deleted from LDAP, but we are not
- // aware of it yet.
- $groups = $this->getCachedGroupsForUserId($ncUid);
- $this->access->connection->writeToCache($cacheKey, $groups);
- return $groups;
- }
- $groups = array_values(array_unique($groups, SORT_LOCALE_STRING));
- $this->access->connection->writeToCache($cacheKey, $groups);
- $groupStr = \json_encode($groups);
- $this->config->setUserValue($ncUid, 'user_ldap', 'cached-group-memberships-' . $this->access->connection->getConfigPrefix(), $groupStr);
- return $groups;
- }
- /**
- * @return array[]
- * @throws ServerNotAvailableException
- */
- private function getGroupsByMember(string $dn, array &$seen = []): array {
- if (isset($seen[$dn])) {
- return [];
- }
- $seen[$dn] = true;
- if (isset($this->cachedGroupsByMember[$dn])) {
- return $this->cachedGroupsByMember[$dn];
- }
- $filter = $this->access->connection->ldapGroupMemberAssocAttr . '=' . $dn;
- if ($this->ldapGroupMemberAssocAttr === 'zimbramailforwardingaddress') {
- //in this case the member entries are email addresses
- $filter .= '@*';
- }
- $nesting = (int)$this->access->connection->ldapNestedGroups;
- if ($nesting === 0) {
- $filter = $this->access->combineFilterWithAnd([$filter, $this->access->connection->ldapGroupFilter]);
- }
- $allGroups = [];
- $groups = $this->access->fetchListOfGroups($filter,
- [strtolower($this->access->connection->ldapGroupMemberAssocAttr), $this->access->connection->ldapGroupDisplayName, 'dn']);
- if ($nesting === 1) {
- while ($record = array_shift($groups)) {
- // Note: this has no effect when ldapGroupMemberAssocAttr is uid based
- $nestedParents = $this->getGroupsByMember($record['dn'][0], $seen);
- $groups = array_merge($groups, $nestedParents);
- $allGroups[] = $record;
- }
- } else {
- $allGroups = $groups;
- }
- $visibleGroups = $this->filterValidGroups($allGroups);
- $this->cachedGroupsByMember[$dn] = $visibleGroups;
- return $visibleGroups;
- }
- /**
- * get a list of all users in a group
- *
- * @param string $gid
- * @param string $search
- * @param int $limit
- * @param int $offset
- * @return array<int,string> user ids
- * @throws Exception
- * @throws ServerNotAvailableException
- */
- public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
- if (!$this->enabled) {
- return [];
- }
- if (!$this->groupExists($gid)) {
- return [];
- }
- $search = $this->access->escapeFilterPart($search, true);
- $cacheKey = 'usersInGroup-' . $gid . '-' . $search . '-' . $limit . '-' . $offset;
- // check for cache of the exact query
- $groupUsers = $this->access->connection->getFromCache($cacheKey);
- if (!is_null($groupUsers)) {
- return $groupUsers;
- }
- if ($limit === -1) {
- $limit = null;
- }
- // check for cache of the query without limit and offset
- $groupUsers = $this->access->connection->getFromCache('usersInGroup-' . $gid . '-' . $search);
- if (!is_null($groupUsers)) {
- $groupUsers = array_slice($groupUsers, $offset, $limit);
- $this->access->connection->writeToCache($cacheKey, $groupUsers);
- return $groupUsers;
- }
- $groupDN = $this->access->groupname2dn($gid);
- if (!$groupDN) {
- // group couldn't be found, return empty result-set
- $this->access->connection->writeToCache($cacheKey, []);
- return [];
- }
- $primaryUsers = $this->getUsersInPrimaryGroup($groupDN, $search, $limit, $offset);
- $posixGroupUsers = $this->getUsersInGidNumber($groupDN, $search, $limit, $offset);
- $members = $this->_groupMembers($groupDN);
- if (!$members && empty($posixGroupUsers) && empty($primaryUsers)) {
- //in case users could not be retrieved, return empty result set
- $this->access->connection->writeToCache($cacheKey, []);
- return [];
- }
- $groupUsers = [];
- $attrs = $this->access->userManager->getAttributes(true);
- foreach ($members as $member) {
- switch ($this->ldapGroupMemberAssocAttr) {
- /** @noinspection PhpMissingBreakStatementInspection */
- case 'zimbramailforwardingaddress':
- //we get email addresses and need to convert them to uids
- $parts = explode('@', $member);
- $member = $parts[0];
- //no break needed because we just needed to remove the email part and now we have uids
- case 'memberuid':
- //we got uids, need to get their DNs to 'translate' them to user names
- $filter = $this->access->combineFilterWithAnd([
- str_replace('%uid', trim($member), $this->access->connection->ldapLoginFilter),
- $this->access->combineFilterWithAnd([
- $this->access->getFilterPartForUserSearch($search),
- $this->access->connection->ldapUserFilter
- ])
- ]);
- $ldap_users = $this->access->fetchListOfUsers($filter, $attrs, 1);
- if (empty($ldap_users)) {
- break;
- }
- $uid = $this->access->dn2username($ldap_users[0]['dn'][0]);
- if (!$uid) {
- break;
- }
- $groupUsers[] = $uid;
- break;
- default:
- //we got DNs, check if we need to filter by search or we can give back all of them
- $uid = $this->access->dn2username($member);
- if (!$uid) {
- break;
- }
- $cacheKey = 'userExistsOnLDAP' . $uid;
- $userExists = $this->access->connection->getFromCache($cacheKey);
- if ($userExists === false) {
- break;
- }
- if ($userExists === null || $search !== '') {
- if (!$this->access->readAttribute($member,
- $this->access->connection->ldapUserDisplayName,
- $this->access->combineFilterWithAnd([
- $this->access->getFilterPartForUserSearch($search),
- $this->access->connection->ldapUserFilter
- ]))) {
- if ($search === '') {
- $this->access->connection->writeToCache($cacheKey, false);
- }
- break;
- }
- $this->access->connection->writeToCache($cacheKey, true);
- }
- $groupUsers[] = $uid;
- break;
- }
- }
- $groupUsers = array_unique(array_merge($groupUsers, $primaryUsers, $posixGroupUsers));
- natsort($groupUsers);
- $this->access->connection->writeToCache('usersInGroup-' . $gid . '-' . $search, $groupUsers);
- $groupUsers = array_slice($groupUsers, $offset, $limit);
- $this->access->connection->writeToCache($cacheKey, $groupUsers);
- return $groupUsers;
- }
- /**
- * returns the number of users in a group, who match the search term
- *
- * @param string $gid the internal group name
- * @param string $search optional, a search string
- * @return int|bool
- * @throws Exception
- * @throws ServerNotAvailableException
- */
- public function countUsersInGroup($gid, $search = '') {
- if ($this->groupPluginManager->implementsActions(GroupInterface::COUNT_USERS)) {
- return $this->groupPluginManager->countUsersInGroup($gid, $search);
- }
- $cacheKey = 'countUsersInGroup-' . $gid . '-' . $search;
- if (!$this->enabled || !$this->groupExists($gid)) {
- return false;
- }
- $groupUsers = $this->access->connection->getFromCache($cacheKey);
- if (!is_null($groupUsers)) {
- return $groupUsers;
- }
- $groupDN = $this->access->groupname2dn($gid);
- if (!$groupDN) {
- // group couldn't be found, return empty result set
- $this->access->connection->writeToCache($cacheKey, false);
- return false;
- }
- $members = $this->_groupMembers($groupDN);
- $primaryUserCount = $this->countUsersInPrimaryGroup($groupDN, '');
- if (!$members && $primaryUserCount === 0) {
- //in case users could not be retrieved, return empty result set
- $this->access->connection->writeToCache($cacheKey, false);
- return false;
- }
- if ($search === '') {
- $groupUsers = count($members) + $primaryUserCount;
- $this->access->connection->writeToCache($cacheKey, $groupUsers);
- return $groupUsers;
- }
- $search = $this->access->escapeFilterPart($search, true);
- $isMemberUid =
- ($this->ldapGroupMemberAssocAttr === 'memberuid' ||
- $this->ldapGroupMemberAssocAttr === 'zimbramailforwardingaddress');
- //we need to apply the search filter
- //alternatives that need to be checked:
- //a) get all users by search filter and array_intersect them
- //b) a, but only when less than 1k 10k ?k users like it is
- //c) put all DNs|uids in a LDAP filter, combine with the search string
- // and let it count.
- //For now this is not important, because the only use of this method
- //does not supply a search string
- $groupUsers = [];
- foreach ($members as $member) {
- if ($isMemberUid) {
- if ($this->ldapGroupMemberAssocAttr === 'zimbramailforwardingaddress') {
- //we get email addresses and need to convert them to uids
- $parts = explode('@', $member);
- $member = $parts[0];
- }
- //we got uids, need to get their DNs to 'translate' them to user names
- $filter = $this->access->combineFilterWithAnd([
- str_replace('%uid', $member, $this->access->connection->ldapLoginFilter),
- $this->access->getFilterPartForUserSearch($search)
- ]);
- $ldap_users = $this->access->fetchListOfUsers($filter, ['dn'], 1);
- if (count($ldap_users) < 1) {
- continue;
- }
- $groupUsers[] = $this->access->dn2username($ldap_users[0]);
- } else {
- //we need to apply the search filter now
- if (!$this->access->readAttribute($member,
- $this->access->connection->ldapUserDisplayName,
- $this->access->getFilterPartForUserSearch($search))) {
- continue;
- }
- // dn2username will also check if the users belong to the allowed base
- if ($ncGroupId = $this->access->dn2username($member)) {
- $groupUsers[] = $ncGroupId;
- }
- }
- }
- //and get users that have the group as primary
- $primaryUsers = $this->countUsersInPrimaryGroup($groupDN, $search);
- return count($groupUsers) + $primaryUsers;
- }
- /**
- * get a list of all groups using a paged search
- *
- * @param string $search
- * @param int $limit
- * @param int $offset
- * @return array with group names
- *
- * Returns a list with all groups
- * Uses a paged search if available to override a
- * server side search limit.
- * (active directory has a limit of 1000 by default)
- * @throws Exception
- */
- public function getGroups($search = '', $limit = -1, $offset = 0) {
- if (!$this->enabled) {
- return [];
- }
- $search = $this->access->escapeFilterPart($search, true);
- $cacheKey = 'getGroups-' . $search . '-' . $limit . '-' . $offset;
- //Check cache before driving unnecessary searches
- $ldap_groups = $this->access->connection->getFromCache($cacheKey);
- if (!is_null($ldap_groups)) {
- return $ldap_groups;
- }
- // if we'd pass -1 to LDAP search, we'd end up in a Protocol
- // error. With a limit of 0, we get 0 results. So we pass null.
- if ($limit <= 0) {
- $limit = null;
- }
- $filter = $this->access->combineFilterWithAnd([
- $this->access->connection->ldapGroupFilter,
- $this->access->getFilterPartForGroupSearch($search)
- ]);
- $ldap_groups = $this->access->fetchListOfGroups($filter,
- [$this->access->connection->ldapGroupDisplayName, 'dn'],
- $limit,
- $offset);
- $ldap_groups = $this->access->nextcloudGroupNames($ldap_groups);
- $this->access->connection->writeToCache($cacheKey, $ldap_groups);
- return $ldap_groups;
- }
- /**
- * check if a group exists
- *
- * @param string $gid
- * @return bool
- * @throws ServerNotAvailableException
- */
- public function groupExists($gid) {
- return $this->groupExistsOnLDAP($gid, false);
- }
- /**
- * Check if a group exists
- *
- * @throws ServerNotAvailableException
- */
- public function groupExistsOnLDAP(string $gid, bool $ignoreCache = false): bool {
- $cacheKey = 'groupExists' . $gid;
- if (!$ignoreCache) {
- $groupExists = $this->access->connection->getFromCache($cacheKey);
- if (!is_null($groupExists)) {
- return (bool)$groupExists;
- }
- }
- //getting dn, if false the group does not exist. If dn, it may be mapped
- //only, requires more checking.
- $dn = $this->access->groupname2dn($gid);
- if (!$dn) {
- $this->access->connection->writeToCache($cacheKey, false);
- return false;
- }
- if (!$this->access->isDNPartOfBase($dn, $this->access->connection->ldapBaseGroups)) {
- $this->access->connection->writeToCache($cacheKey, false);
- return false;
- }
- //if group really still exists, we will be able to read its objectClass
- if (!is_array($this->access->readAttribute($dn, '', $this->access->connection->ldapGroupFilter))) {
- $this->access->connection->writeToCache($cacheKey, false);
- return false;
- }
- $this->access->connection->writeToCache($cacheKey, true);
- return true;
- }
- /**
- * @template T
- * @param array<array-key, T> $listOfGroups
- * @return array<array-key, T>
- * @throws ServerNotAvailableException
- * @throws Exception
- */
- protected function filterValidGroups(array $listOfGroups): array {
- $validGroupDNs = [];
- foreach ($listOfGroups as $key => $item) {
- $dn = is_string($item) ? $item : $item['dn'][0];
- if (is_array($item) && !isset($item[$this->access->connection->ldapGroupDisplayName][0])) {
- continue;
- }
- $name = $item[$this->access->connection->ldapGroupDisplayName][0] ?? null;
- $gid = $this->access->dn2groupname($dn, $name);
- if (!$gid) {
- continue;
- }
- if ($this->groupExists($gid)) {
- $validGroupDNs[$key] = $item;
- }
- }
- return $validGroupDNs;
- }
- /**
- * Check if backend implements actions
- *
- * @param int $actions bitwise-or'ed actions
- * @return boolean
- *
- * Returns the supported actions as int to be
- * compared with GroupInterface::CREATE_GROUP etc.
- */
- public function implementsActions($actions): bool {
- return (bool)((GroupInterface::COUNT_USERS |
- GroupInterface::DELETE_GROUP |
- GroupInterface::IS_ADMIN |
- $this->groupPluginManager->getImplementedActions()) & $actions);
- }
- /**
- * Return access for LDAP interaction.
- *
- * @return Access instance of Access for LDAP interaction
- */
- public function getLDAPAccess($gid) {
- return $this->access;
- }
- /**
- * create a group
- *
- * @param string $gid
- * @return bool
- * @throws Exception
- * @throws ServerNotAvailableException
- */
- public function createGroup($gid) {
- if ($this->groupPluginManager->implementsActions(GroupInterface::CREATE_GROUP)) {
- if ($dn = $this->groupPluginManager->createGroup($gid)) {
- //updates group mapping
- $uuid = $this->access->getUUID($dn, false);
- if (is_string($uuid)) {
- $this->access->mapAndAnnounceIfApplicable(
- $this->access->getGroupMapper(),
- $dn,
- $gid,
- $uuid,
- false
- );
- $this->access->cacheGroupExists($gid);
- }
- }
- return $dn != null;
- }
- throw new Exception('Could not create group in LDAP backend.');
- }
- /**
- * delete a group
- *
- * @param string $gid gid of the group to delete
- * @throws Exception
- */
- public function deleteGroup(string $gid): bool {
- if ($this->groupPluginManager->canDeleteGroup()) {
- if ($ret = $this->groupPluginManager->deleteGroup($gid)) {
- // Delete group in nextcloud internal db
- $this->access->getGroupMapper()->unmap($gid);
- $this->access->connection->writeToCache("groupExists" . $gid, false);
- }
- return $ret;
- }
- // Getting dn, if false the group is not mapped
- $dn = $this->access->groupname2dn($gid);
- if (!$dn) {
- throw new Exception('Could not delete unknown group '.$gid.' in LDAP backend.');
- }
- if (!$this->groupExists($gid)) {
- // The group does not exist in the LDAP, remove the mapping
- $this->access->getGroupMapper()->unmap($gid);
- $this->access->connection->writeToCache("groupExists" . $gid, false);
- return true;
- }
- throw new Exception('Could not delete existing group '.$gid.' in LDAP backend.');
- }
- /**
- * Add a user to a group
- *
- * @param string $uid Name of the user to add to group
- * @param string $gid Name of the group in which add the user
- * @return bool
- * @throws Exception
- */
- public function addToGroup($uid, $gid) {
- if ($this->groupPluginManager->implementsActions(GroupInterface::ADD_TO_GROUP)) {
- if ($ret = $this->groupPluginManager->addToGroup($uid, $gid)) {
- $this->access->connection->clearCache();
- unset($this->cachedGroupMembers[$gid]);
- }
- return $ret;
- }
- throw new Exception('Could not add user to group in LDAP backend.');
- }
- /**
- * Removes a user from a group
- *
- * @param string $uid Name of the user to remove from group
- * @param string $gid Name of the group from which remove the user
- * @return bool
- * @throws Exception
- */
- public function removeFromGroup($uid, $gid) {
- if ($this->groupPluginManager->implementsActions(GroupInterface::REMOVE_FROM_GROUP)) {
- if ($ret = $this->groupPluginManager->removeFromGroup($uid, $gid)) {
- $this->access->connection->clearCache();
- unset($this->cachedGroupMembers[$gid]);
- }
- return $ret;
- }
- throw new Exception('Could not remove user from group in LDAP backend.');
- }
- /**
- * Gets group details
- *
- * @param string $gid Name of the group
- * @return array|false
- * @throws Exception
- */
- public function getGroupDetails($gid) {
- if ($this->groupPluginManager->implementsActions(GroupInterface::GROUP_DETAILS)) {
- return $this->groupPluginManager->getGroupDetails($gid);
- }
- throw new Exception('Could not get group details in LDAP backend.');
- }
- /**
- * Return LDAP connection resource from a cloned connection.
- * The cloned connection needs to be closed manually.
- * of the current access.
- *
- * @param string $gid
- * @return \LDAP\Connection The LDAP connection
- * @throws ServerNotAvailableException
- */
- public function getNewLDAPConnection($gid): \LDAP\Connection {
- $connection = clone $this->access->getConnection();
- return $connection->getConnectionResource();
- }
- /**
- * @throws ServerNotAvailableException
- */
- public function getDisplayName(string $gid): string {
- if ($this->groupPluginManager instanceof IGetDisplayNameBackend) {
- return $this->groupPluginManager->getDisplayName($gid);
- }
- $cacheKey = 'group_getDisplayName' . $gid;
- if (!is_null($displayName = $this->access->connection->getFromCache($cacheKey))) {
- return $displayName;
- }
- $displayName = $this->access->readAttribute(
- $this->access->groupname2dn($gid),
- $this->access->connection->ldapGroupDisplayName);
- if (($displayName !== false) && (count($displayName) > 0)) {
- $displayName = $displayName[0];
- } else {
- $displayName = '';
- }
- $this->access->connection->writeToCache($cacheKey, $displayName);
- return $displayName;
- }
- /**
- * returns the groupname for the given LDAP DN, if available
- */
- public function dn2GroupName(string $dn): string|false {
- return $this->access->dn2groupname($dn);
- }
- public function addRelationshipToCaches(string $uid, ?string $dnUser, string $gid): void {
- $dnGroup = $this->access->groupname2dn($gid);
- $dnUser ??= $this->access->username2dn($uid);
- if ($dnUser === false || $dnGroup === false) {
- return;
- }
- if (isset($this->cachedGroupMembers[$gid])) {
- $this->cachedGroupMembers[$gid] = array_merge($this->cachedGroupMembers[$gid], [$dnUser]);
- }
- unset($this->cachedGroupsByMember[$dnUser]);
- unset($this->cachedNestedGroups[$gid]);
- $cacheKey = 'inGroup' . $uid . ':' . $gid;
- $this->access->connection->writeToCache($cacheKey, true);
- $cacheKeyMembers = 'inGroup-members:' . $gid;
- if (!is_null($data = $this->access->connection->getFromCache($cacheKeyMembers))) {
- $this->access->connection->writeToCache($cacheKeyMembers, array_merge($data, [$dnUser]));
- }
- $cacheKey = '_groupMembers' . $dnGroup;
- if (!is_null($data = $this->access->connection->getFromCache($cacheKey))) {
- $this->access->connection->writeToCache($cacheKey, array_merge($data, [$dnUser]));
- }
- $cacheKey = 'getUserGroups' . $uid;
- if (!is_null($data = $this->access->connection->getFromCache($cacheKey))) {
- $this->access->connection->writeToCache($cacheKey, array_merge($data, [$gid]));
- }
- // These cache keys cannot be easily updated:
- // $cacheKey = 'usersInGroup-' . $gid . '-' . $search . '-' . $limit . '-' . $offset;
- // $cacheKey = 'usersInGroup-' . $gid . '-' . $search;
- // $cacheKey = 'countUsersInGroup-' . $gid . '-' . $search;
- }
- /**
- * @throws ServerNotAvailableException
- */
- public function isAdmin(string $uid): bool {
- if (!$this->enabled) {
- return false;
- }
- $ldapAdminGroup = $this->access->connection->ldapAdminGroup;
- if ($ldapAdminGroup === '') {
- return false;
- }
- return $this->inGroup($uid, $ldapAdminGroup);
- }
- }
|