aboutsummaryrefslogtreecommitdiffstats
path: root/apps/user_ldap/lib/Wizard.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/user_ldap/lib/Wizard.php')
-rw-r--r--apps/user_ldap/lib/Wizard.php880
1 files changed, 440 insertions, 440 deletions
diff --git a/apps/user_ldap/lib/Wizard.php b/apps/user_ldap/lib/Wizard.php
index bf7c6bbeb93..15a9f9cb212 100644
--- a/apps/user_ldap/lib/Wizard.php
+++ b/apps/user_ldap/lib/Wizard.php
@@ -1,85 +1,54 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Alexander Bergolth <leo@strike.wu.ac.at>
- * @author Allan Nordhøy <epost@anotheragency.no>
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Jean-Louis Dupond <jean-louis@dupond.be>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Nicolas Grekas <nicolas.grekas@gmail.com>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Stefan Weil <sw@weilnetz.de>
- * @author Tobias Brunner <tobias@tobru.ch>
- * @author Victor Dubiniuk <dubiniuk@owncloud.com>
- * @author Xuanwo <xuanwo@yunify.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/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCA\User_LDAP;
use OC\ServerNotAvailableException;
+use OCP\IL10N;
+use OCP\L10N\IFactory as IL10NFactory;
+use OCP\Server;
+use OCP\Util;
+use Psr\Log\LoggerInterface;
class Wizard extends LDAPUtility {
- /** @var \OCP\IL10N */
- static protected $l;
- protected $access;
- protected $cr;
- protected $configuration;
- protected $result;
- protected $resultCache = array();
+ protected static ?IL10N $l = null;
+ protected ?\LDAP\Connection $cr = null;
+ protected WizardResult $result;
+ protected LoggerInterface $logger;
- const LRESULT_PROCESSED_OK = 2;
- const LRESULT_PROCESSED_INVALID = 3;
- const LRESULT_PROCESSED_SKIP = 4;
+ public const LRESULT_PROCESSED_OK = 2;
+ public const LRESULT_PROCESSED_INVALID = 3;
+ public const LRESULT_PROCESSED_SKIP = 4;
- const LFILTER_LOGIN = 2;
- const LFILTER_USER_LIST = 3;
- const LFILTER_GROUP_LIST = 4;
+ public const LFILTER_LOGIN = 2;
+ public const LFILTER_USER_LIST = 3;
+ public const LFILTER_GROUP_LIST = 4;
- const LFILTER_MODE_ASSISTED = 2;
- const LFILTER_MODE_RAW = 1;
+ public const LFILTER_MODE_ASSISTED = 2;
+ public const LFILTER_MODE_RAW = 1;
- const LDAP_NW_TIMEOUT = 4;
+ public const LDAP_NW_TIMEOUT = 4;
- /**
- * Constructor
- * @param Configuration $configuration an instance of Configuration
- * @param ILDAPWrapper $ldap an instance of ILDAPWrapper
- * @param Access $access
- */
- public function __construct(Configuration $configuration, ILDAPWrapper $ldap, Access $access) {
+ public function __construct(
+ protected Configuration $configuration,
+ ILDAPWrapper $ldap,
+ protected Access $access,
+ ) {
parent::__construct($ldap);
- $this->configuration = $configuration;
- if(is_null(Wizard::$l)) {
- Wizard::$l = \OC::$server->getL10N('user_ldap');
+ if (is_null(static::$l)) {
+ static::$l = Server::get(IL10NFactory::class)->get('user_ldap');
}
- $this->access = $access;
$this->result = new WizardResult();
+ $this->logger = Server::get(LoggerInterface::class);
}
- public function __destruct() {
- if($this->result->hasChanges()) {
+ public function __destruct() {
+ if ($this->result->hasChanges()) {
$this->configuration->saveConfiguration();
}
}
@@ -89,80 +58,86 @@ class Wizard extends LDAPUtility {
*
* @param string $filter the LDAP search filter
* @param string $type a string being either 'users' or 'groups';
- * @return bool|int
* @throws \Exception
*/
- public function countEntries($filter, $type) {
- $reqs = array('ldapHost', 'ldapPort', 'ldapBase');
- if($type === 'users') {
+ public function countEntries(string $filter, string $type): int {
+ $reqs = ['ldapHost', 'ldapBase'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if ($type === 'users') {
$reqs[] = 'ldapUserFilter';
}
- if(!$this->checkRequirements($reqs)) {
+ if (!$this->checkRequirements($reqs)) {
throw new \Exception('Requirements not met', 400);
}
- $attr = array('dn'); // default
+ $attr = ['dn']; // default
$limit = 1001;
- if($type === 'groups') {
- $result = $this->access->countGroups($filter, $attr, $limit);
- } else if($type === 'users') {
+ if ($type === 'groups') {
+ $result = $this->access->countGroups($filter, $attr, $limit);
+ } elseif ($type === 'users') {
$result = $this->access->countUsers($filter, $attr, $limit);
- } else if ($type === 'objects') {
+ } elseif ($type === 'objects') {
$result = $this->access->countObjects($limit);
} else {
throw new \Exception('Internal error: Invalid object type', 500);
}
- return $result;
+ return (int)$result;
}
/**
- * formats the return value of a count operation to the string to be
- * inserted.
- *
- * @param bool|int $count
- * @return int|string
+ * @return WizardResult|false
*/
- private function formatCountResult($count) {
- $formatted = ($count !== false) ? $count : 0;
- if($formatted > 1000) {
- $formatted = '> 1000';
- }
- return $formatted;
- }
-
public function countGroups() {
$filter = $this->configuration->ldapGroupFilter;
- if(empty($filter)) {
- $output = self::$l->n('%s group found', '%s groups found', 0, array(0));
+ if (empty($filter)) {
+ $output = self::$l->n('%n group found', '%n groups found', 0);
$this->result->addChange('ldap_group_count', $output);
return $this->result;
}
try {
- $groupsTotal = $this->formatCountResult($this->countEntries($filter, 'groups'));
+ $groupsTotal = $this->countEntries($filter, 'groups');
} catch (\Exception $e) {
//400 can be ignored, 500 is forwarded
- if($e->getCode() === 500) {
+ if ($e->getCode() === 500) {
throw $e;
}
return false;
}
- $output = self::$l->n('%s group found', '%s groups found', $groupsTotal, array($groupsTotal));
+
+ if ($groupsTotal > 1000) {
+ $output = self::$l->t('> 1000 groups found');
+ } else {
+ $output = self::$l->n(
+ '%n group found',
+ '%n groups found',
+ $groupsTotal
+ );
+ }
$this->result->addChange('ldap_group_count', $output);
return $this->result;
}
/**
- * @return WizardResult
* @throws \Exception
*/
- public function countUsers() {
+ public function countUsers(): WizardResult {
$filter = $this->access->getFilterForUserCount();
- $usersTotal = $this->formatCountResult($this->countEntries($filter, 'users'));
- $output = self::$l->n('%s user found', '%s users found', $usersTotal, array($usersTotal));
+ $usersTotal = $this->countEntries($filter, 'users');
+ if ($usersTotal > 1000) {
+ $output = self::$l->t('> 1000 users found');
+ } else {
+ $output = self::$l->n(
+ '%n user found',
+ '%n users found',
+ $usersTotal
+ );
+ }
$this->result->addChange('ldap_user_count', $output);
return $this->result;
}
@@ -170,56 +145,50 @@ class Wizard extends LDAPUtility {
/**
* counts any objects in the currently set base dn
*
- * @return WizardResult
* @throws \Exception
*/
- public function countInBaseDN() {
+ public function countInBaseDN(): WizardResult {
// we don't need to provide a filter in this case
- $total = $this->countEntries(null, 'objects');
- if($total === false) {
- throw new \Exception('invalid results received');
- }
+ $total = $this->countEntries('', 'objects');
$this->result->addChange('ldap_test_base', $total);
return $this->result;
}
/**
* counts users with a specified attribute
- * @param string $attr
- * @param bool $existsCheck
- * @return int|bool
+ * @return int|false
*/
- public function countUsersWithAttribute($attr, $existsCheck = false) {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- 'ldapUserFilter',
- ))) {
+ public function countUsersWithAttribute(string $attr, bool $existsCheck = false) {
+ $reqs = ['ldapHost', 'ldapBase', 'ldapUserFilter'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
- $filter = $this->access->combineFilterWithAnd(array(
+ $filter = $this->access->combineFilterWithAnd([
$this->configuration->ldapUserFilter,
$attr . '=*'
- ));
+ ]);
- $limit = ($existsCheck === false) ? null : 1;
+ $limit = $existsCheck ? null : 1;
- return $this->access->countUsers($filter, array('dn'), $limit);
+ return $this->access->countUsers($filter, ['dn'], $limit);
}
/**
* detects the display name attribute. If a setting is already present that
* returns at least one hit, the detection will be canceled.
- * @return WizardResult|bool
+ * @return WizardResult|false
* @throws \Exception
*/
public function detectUserDisplayNameAttribute() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- 'ldapUserFilter',
- ))) {
+ $reqs = ['ldapHost', 'ldapBase', 'ldapUserFilter'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
@@ -227,8 +196,8 @@ class Wizard extends LDAPUtility {
if ($attr !== '' && $attr !== 'displayName') {
// most likely not the default value with upper case N,
// verify it still produces a result
- $count = intval($this->countUsersWithAttribute($attr, true));
- if($count > 0) {
+ $count = (int)$this->countUsersWithAttribute($attr, true);
+ if ($count > 0) {
//no change, but we sent it back to make sure the user interface
//is still correct, even if the ajax call was cancelled meanwhile
$this->result->addChange('ldap_display_name', $attr);
@@ -237,15 +206,15 @@ class Wizard extends LDAPUtility {
}
// first attribute that has at least one result wins
- $displayNameAttrs = array('displayname', 'cn');
+ $displayNameAttrs = ['displayname', 'cn'];
foreach ($displayNameAttrs as $attr) {
- $count = intval($this->countUsersWithAttribute($attr, true));
+ $count = (int)$this->countUsersWithAttribute($attr, true);
- if($count > 0) {
+ if ($count > 0) {
$this->applyFind('ldap_display_name', $attr);
return $this->result;
}
- };
+ }
throw new \Exception(self::$l->t('Could not detect user display name attribute. Please specify it yourself in advanced LDAP settings.'));
}
@@ -257,18 +226,18 @@ class Wizard extends LDAPUtility {
* @return WizardResult|bool
*/
public function detectEmailAttribute() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- 'ldapUserFilter',
- ))) {
+ $reqs = ['ldapHost', 'ldapBase', 'ldapUserFilter'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
$attr = $this->configuration->ldapEmailAttribute;
if ($attr !== '') {
- $count = intval($this->countUsersWithAttribute($attr, true));
- if($count > 0) {
+ $count = (int)$this->countUsersWithAttribute($attr, true);
+ if ($count > 0) {
return false;
}
$writeLog = true;
@@ -276,23 +245,25 @@ class Wizard extends LDAPUtility {
$writeLog = false;
}
- $emailAttributes = array('mail', 'mailPrimaryAddress');
+ $emailAttributes = ['mail', 'mailPrimaryAddress'];
$winner = '';
$maxUsers = 0;
- foreach($emailAttributes as $attr) {
+ foreach ($emailAttributes as $attr) {
$count = $this->countUsersWithAttribute($attr);
- if($count > $maxUsers) {
+ if ($count > $maxUsers) {
$maxUsers = $count;
$winner = $attr;
}
}
- if($winner !== '') {
+ if ($winner !== '') {
$this->applyFind('ldap_email_attr', $winner);
- if($writeLog) {
- \OCP\Util::writeLog('user_ldap', 'The mail attribute has ' .
- 'automatically been reset, because the original value ' .
- 'did not return any results.', \OCP\Util::INFO);
+ if ($writeLog) {
+ $this->logger->info(
+ 'The mail attribute has automatically been reset, '
+ . 'because the original value did not return any results.',
+ ['app' => 'user_ldap']
+ );
}
}
@@ -300,27 +271,31 @@ class Wizard extends LDAPUtility {
}
/**
- * @return WizardResult
+ * @return WizardResult|false
* @throws \Exception
*/
public function determineAttributes() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- 'ldapUserFilter',
- ))) {
+ $reqs = ['ldapHost', 'ldapBase', 'ldapUserFilter'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
$attributes = $this->getUserAttributes();
+ if (!is_array($attributes)) {
+ throw new \Exception('Failed to determine user attributes');
+ }
+
natcasesort($attributes);
$attributes = array_values($attributes);
$this->result->addOptions('ldap_loginfilter_attributes', $attributes);
$selected = $this->configuration->ldapLoginFilterAttributes;
- if(is_array($selected) && !empty($selected)) {
+ if (is_array($selected) && !empty($selected)) {
$this->result->addChange('ldap_loginfilter_attributes', $selected);
}
@@ -329,32 +304,36 @@ class Wizard extends LDAPUtility {
/**
* detects the available LDAP attributes
- * @return array|false The instance's WizardResult instance
+ * @return array|false
* @throws \Exception
*/
private function getUserAttributes() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- 'ldapUserFilter',
- ))) {
+ $reqs = ['ldapHost', 'ldapBase', 'ldapUserFilter'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
$cr = $this->getConnection();
- if(!$cr) {
+ if (!$cr) {
throw new \Exception('Could not connect to LDAP');
}
$base = $this->configuration->ldapBase[0];
$filter = $this->configuration->ldapUserFilter;
- $rr = $this->ldap->search($cr, $base, $filter, array(), 1, 1);
- if(!$this->ldap->isResource($rr)) {
+ $rr = $this->ldap->search($cr, $base, $filter, [], 1, 1);
+ if (!$this->ldap->isResource($rr)) {
return false;
}
+ /** @var \LDAP\Result $rr */
$er = $this->ldap->firstEntry($cr, $rr);
$attributes = $this->ldap->getAttributes($cr, $er);
- $pureAttributes = array();
- for($i = 0; $i < $attributes['count']; $i++) {
+ if ($attributes === false) {
+ return false;
+ }
+ $pureAttributes = [];
+ for ($i = 0; $i < $attributes['count']; $i++) {
$pureAttributes[] = $attributes[$i];
}
@@ -367,8 +346,8 @@ class Wizard extends LDAPUtility {
*/
public function determineGroupsForGroups() {
return $this->determineGroups('ldap_groupfilter_groups',
- 'ldapGroupFilterGroups',
- false);
+ 'ldapGroupFilterGroups',
+ false);
}
/**
@@ -377,35 +356,33 @@ class Wizard extends LDAPUtility {
*/
public function determineGroupsForUsers() {
return $this->determineGroups('ldap_userfilter_groups',
- 'ldapUserFilterGroups');
+ 'ldapUserFilterGroups');
}
/**
* detects the available LDAP groups
- * @param string $dbKey
- * @param string $confKey
- * @param bool $testMemberOf
* @return WizardResult|false the instance's WizardResult instance
* @throws \Exception
*/
- private function determineGroups($dbKey, $confKey, $testMemberOf = true) {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- ))) {
+ private function determineGroups(string $dbKey, string $confKey, bool $testMemberOf = true) {
+ $reqs = ['ldapHost', 'ldapBase'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
$cr = $this->getConnection();
- if(!$cr) {
+ if (!$cr) {
throw new \Exception('Could not connect to LDAP');
}
$this->fetchGroups($dbKey, $confKey);
- if($testMemberOf) {
- $this->configuration->hasMemberOfFilterSupport = $this->testMemberOf();
+ if ($testMemberOf) {
+ $this->configuration->hasMemberOfFilterSupport = (string)$this->testMemberOf();
$this->result->markChange();
- if(!$this->configuration->hasMemberOfFilterSupport) {
+ if (!$this->configuration->hasMemberOfFilterSupport) {
throw new \Exception('memberOf is not supported by the server');
}
}
@@ -416,34 +393,31 @@ class Wizard extends LDAPUtility {
/**
* fetches all groups from LDAP and adds them to the result object
*
- * @param string $dbKey
- * @param string $confKey
- * @return array $groupEntries
* @throws \Exception
*/
- public function fetchGroups($dbKey, $confKey) {
- $obclasses = array('posixGroup', 'group', 'zimbraDistributionList', 'groupOfNames', 'groupOfUniqueNames');
+ public function fetchGroups(string $dbKey, string $confKey): array {
+ $obclasses = ['posixGroup', 'group', 'zimbraDistributionList', 'groupOfNames', 'groupOfUniqueNames'];
- $filterParts = array();
- foreach($obclasses as $obclass) {
- $filterParts[] = 'objectclass='.$obclass;
+ $filterParts = [];
+ foreach ($obclasses as $obclass) {
+ $filterParts[] = 'objectclass=' . $obclass;
}
//we filter for everything
//- that looks like a group and
//- has the group display name set
$filter = $this->access->combineFilterWithOr($filterParts);
- $filter = $this->access->combineFilterWithAnd(array($filter, 'cn=*'));
+ $filter = $this->access->combineFilterWithAnd([$filter, 'cn=*']);
- $groupNames = array();
- $groupEntries = array();
+ $groupNames = [];
+ $groupEntries = [];
$limit = 400;
$offset = 0;
do {
// we need to request dn additionally here, otherwise memberOf
// detection will fail later
- $result = $this->access->searchGroups($filter, array('cn', 'dn'), $limit, $offset);
- foreach($result as $item) {
- if(!isset($item['cn']) && !is_array($item['cn']) && !isset($item['cn'][0])) {
+ $result = $this->access->searchGroups($filter, ['cn', 'dn'], $limit, $offset);
+ foreach ($result as $item) {
+ if (!isset($item['cn']) || !is_array($item['cn']) || !isset($item['cn'][0])) {
// just in case - no issue known
continue;
}
@@ -453,7 +427,7 @@ class Wizard extends LDAPUtility {
$offset += $limit;
} while ($this->access->hasMoreResults());
- if(count($groupNames) > 0) {
+ if (count($groupNames) > 0) {
natsort($groupNames);
$this->result->addOptions($dbKey, array_values($groupNames));
} else {
@@ -461,25 +435,29 @@ class Wizard extends LDAPUtility {
}
$setFeatures = $this->configuration->$confKey;
- if(is_array($setFeatures) && !empty($setFeatures)) {
+ if (is_array($setFeatures) && !empty($setFeatures)) {
//something is already configured? pre-select it.
$this->result->addChange($dbKey, $setFeatures);
}
return $groupEntries;
}
+ /**
+ * @return WizardResult|false
+ */
public function determineGroupMemberAssoc() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapGroupFilter',
- ))) {
+ $reqs = ['ldapHost', 'ldapGroupFilter'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
$attribute = $this->detectGroupMemberAssoc();
- if($attribute === false) {
+ if ($attribute === false) {
return false;
}
- $this->configuration->setConfiguration(array('ldapGroupMemberAssocAttr' => $attribute));
+ $this->configuration->setConfiguration(['ldapGroupMemberAssocAttr' => $attribute]);
$this->result->addChange('ldap_group_member_assoc_attribute', $attribute);
return $this->result;
@@ -491,54 +469,56 @@ class Wizard extends LDAPUtility {
* @throws \Exception
*/
public function determineGroupObjectClasses() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- ))) {
+ $reqs = ['ldapHost', 'ldapBase'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
$cr = $this->getConnection();
- if(!$cr) {
+ if (!$cr) {
throw new \Exception('Could not connect to LDAP');
}
- $obclasses = array('groupOfNames', 'groupOfUniqueNames', 'group', 'posixGroup', '*');
+ $obclasses = ['groupOfNames', 'groupOfUniqueNames', 'group', 'posixGroup', '*'];
$this->determineFeature($obclasses,
- 'objectclass',
- 'ldap_groupfilter_objectclass',
- 'ldapGroupFilterObjectclass',
- false);
+ 'objectclass',
+ 'ldap_groupfilter_objectclass',
+ 'ldapGroupFilterObjectclass',
+ false);
return $this->result;
}
/**
* detects the available object classes
- * @return WizardResult
+ * @return WizardResult|false
* @throws \Exception
*/
public function determineUserObjectClasses() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- ))) {
+ $reqs = ['ldapHost', 'ldapBase'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
$cr = $this->getConnection();
- if(!$cr) {
+ if (!$cr) {
throw new \Exception('Could not connect to LDAP');
}
- $obclasses = array('inetOrgPerson', 'person', 'organizationalPerson',
- 'user', 'posixAccount', '*');
+ $obclasses = ['inetOrgPerson', 'person', 'organizationalPerson',
+ 'user', 'posixAccount', '*'];
$filter = $this->configuration->ldapUserFilter;
//if filter is empty, it is probably the first time the wizard is called
//then, apply suggestions.
$this->determineFeature($obclasses,
- 'objectclass',
- 'ldap_userfilter_objectclass',
- 'ldapUserFilterObjectclass',
- empty($filter));
+ 'objectclass',
+ 'ldap_userfilter_objectclass',
+ 'ldapUserFilterObjectclass',
+ empty($filter));
return $this->result;
}
@@ -548,10 +528,11 @@ class Wizard extends LDAPUtility {
* @throws \Exception
*/
public function getGroupFilter() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- ))) {
+ $reqs = ['ldapHost', 'ldapBase'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
//make sure the use display name is set
@@ -559,7 +540,7 @@ class Wizard extends LDAPUtility {
if ($displayName === '') {
$d = $this->configuration->getDefaults();
$this->applyFind('ldap_group_display_name',
- $d['ldap_group_display_name']);
+ $d['ldap_group_display_name']);
}
$filter = $this->composeLdapFilter(self::LFILTER_GROUP_LIST);
@@ -572,10 +553,11 @@ class Wizard extends LDAPUtility {
* @throws \Exception
*/
public function getUserListFilter() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- ))) {
+ $reqs = ['ldapHost', 'ldapBase'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
//make sure the use display name is set
@@ -585,7 +567,7 @@ class Wizard extends LDAPUtility {
$this->applyFind('ldap_display_name', $d['ldap_display_name']);
}
$filter = $this->composeLdapFilter(self::LFILTER_USER_LIST);
- if(!$filter) {
+ if (!$filter) {
throw new \Exception('Cannot create filter');
}
@@ -594,20 +576,20 @@ class Wizard extends LDAPUtility {
}
/**
- * @return bool|WizardResult
+ * @return WizardResult|false
* @throws \Exception
*/
public function getUserLoginFilter() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- 'ldapUserFilter',
- ))) {
+ $reqs = ['ldapHost', 'ldapBase', 'ldapUserFilter'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
$filter = $this->composeLdapFilter(self::LFILTER_LOGIN);
- if(!$filter) {
+ if (!$filter) {
throw new \Exception('Cannot create filter');
}
@@ -616,31 +598,27 @@ class Wizard extends LDAPUtility {
}
/**
- * @return bool|WizardResult
- * @param string $loginName
+ * @return WizardResult|false
* @throws \Exception
*/
- public function testLoginName($loginName) {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- 'ldapBase',
- 'ldapLoginFilter',
- ))) {
+ public function testLoginName(string $loginName) {
+ $reqs = ['ldapHost', 'ldapBase', 'ldapUserFilter'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
$cr = $this->access->connection->getConnectionResource();
- if(!$this->ldap->isResource($cr)) {
- throw new \Exception('connection error');
- }
- if(mb_strpos($this->access->connection->ldapLoginFilter, '%uid', 0, 'UTF-8')
+ if (mb_strpos($this->access->connection->ldapLoginFilter, '%uid', 0, 'UTF-8')
=== false) {
throw new \Exception('missing placeholder');
}
$users = $this->access->countUsersByLoginName($loginName);
- if($this->ldap->errno($cr) !== 0) {
+ if ($this->ldap->errno($cr) !== 0) {
throw new \Exception($this->ldap->error($cr));
}
$filter = str_replace('%uid', $loginName, $this->access->connection->ldapLoginFilter);
@@ -655,23 +633,22 @@ class Wizard extends LDAPUtility {
* @throws \Exception
*/
public function guessPortAndTLS() {
- if(!$this->checkRequirements(array('ldapHost',
- ))) {
+ if (!$this->checkRequirements(['ldapHost',
+ ])) {
return false;
}
$this->checkHost();
$portSettings = $this->getPortSettingsToTry();
- if(!is_array($portSettings)) {
- throw new \Exception(print_r($portSettings, true));
- }
-
//proceed from the best configuration and return on first success
- foreach($portSettings as $setting) {
+ foreach ($portSettings as $setting) {
$p = $setting['port'];
$t = $setting['tls'];
- \OCP\Util::writeLog('user_ldap', 'Wiz: trying port '. $p . ', TLS '. $t, \OCP\Util::DEBUG);
- //connectAndBind may throw Exception, it needs to be catched by the
+ $this->logger->debug(
+ 'Wiz: trying port ' . $p . ', TLS ' . $t,
+ ['app' => 'user_ldap']
+ );
+ //connectAndBind may throw Exception, it needs to be caught by the
//callee of this method
try {
@@ -680,7 +657,7 @@ class Wizard extends LDAPUtility {
// any reply other than -1 (= cannot connect) is already okay,
// because then we found the server
// unavailable startTLS returns -11
- if($e->getCode() > 0) {
+ if ($e->getCode() > 0) {
$settingsFound = true;
} else {
throw $e;
@@ -688,12 +665,15 @@ class Wizard extends LDAPUtility {
}
if ($settingsFound === true) {
- $config = array(
- 'ldapPort' => $p,
- 'ldapTLS' => intval($t)
- );
+ $config = [
+ 'ldapPort' => (string)$p,
+ 'ldapTLS' => (string)$t,
+ ];
$this->configuration->setConfiguration($config);
- \OCP\Util::writeLog('user_ldap', 'Wiz: detected Port ' . $p, \OCP\Util::DEBUG);
+ $this->logger->debug(
+ 'Wiz: detected Port ' . $p,
+ ['app' => 'user_ldap']
+ );
$this->result->addChange('ldap_port', $p);
return $this->result;
}
@@ -708,18 +688,20 @@ class Wizard extends LDAPUtility {
* @return WizardResult|false WizardResult on success, false otherwise
*/
public function guessBaseDN() {
- if(!$this->checkRequirements(array('ldapHost',
- 'ldapPort',
- ))) {
+ $reqs = ['ldapHost'];
+ if (!$this->configuration->usesLdapi()) {
+ $reqs[] = 'ldapPort';
+ }
+ if (!$this->checkRequirements($reqs)) {
return false;
}
//check whether a DN is given in the agent name (99.9% of all cases)
$base = null;
$i = stripos($this->configuration->ldapAgentName, 'dc=');
- if($i !== false) {
+ if ($i !== false) {
$base = substr($this->configuration->ldapAgentName, $i);
- if($this->testBaseDN($base)) {
+ if ($this->testBaseDN($base)) {
$this->applyFind('ldap_base', $base);
return $this->result;
}
@@ -728,14 +710,14 @@ class Wizard extends LDAPUtility {
//this did not help :(
//Let's see whether we can parse the Host URL and convert the domain to
//a base DN
- $helper = new Helper(\OC::$server->getConfig());
+ $helper = Server::get(Helper::class);
$domain = $helper->getDomainFromURL($this->configuration->ldapHost);
- if(!$domain) {
+ if (!$domain) {
return false;
}
$dparts = explode('.', $domain);
- while(count($dparts) > 0) {
+ while (count($dparts) > 0) {
$base2 = 'dc=' . implode(',dc=', $dparts);
if ($base !== $base2 && $this->testBaseDN($base2)) {
$this->applyFind('ldap_base', $base2);
@@ -754,9 +736,9 @@ class Wizard extends LDAPUtility {
* @param string $value the (detected) value
*
*/
- private function applyFind($key, $value) {
+ private function applyFind(string $key, string $value): void {
$this->result->addChange($key, $value);
- $this->configuration->setConfiguration(array($key => $value));
+ $this->configuration->setConfiguration([$key => $value]);
}
/**
@@ -764,52 +746,53 @@ class Wizard extends LDAPUtility {
* field. In this case the port will be stripped off, but also stored as
* setting.
*/
- private function checkHost() {
+ private function checkHost(): void {
$host = $this->configuration->ldapHost;
$hostInfo = parse_url($host);
//removes Port from Host
- if(is_array($hostInfo) && isset($hostInfo['port'])) {
+ if (is_array($hostInfo) && isset($hostInfo['port'])) {
$port = $hostInfo['port'];
- $host = str_replace(':'.$port, '', $host);
+ $host = str_replace(':' . $port, '', $host);
$this->applyFind('ldap_host', $host);
- $this->applyFind('ldap_port', $port);
+ $this->applyFind('ldap_port', (string)$port);
}
}
/**
* tries to detect the group member association attribute which is
* one of 'uniqueMember', 'memberUid', 'member', 'gidNumber'
- * @return string|false, string with the attribute name, false on error
+ * @return string|false string with the attribute name, false on error
* @throws \Exception
*/
private function detectGroupMemberAssoc() {
- $possibleAttrs = array('uniqueMember', 'memberUid', 'member', 'gidNumber');
+ $possibleAttrs = ['uniqueMember', 'memberUid', 'member', 'gidNumber', 'zimbraMailForwardingAddress'];
$filter = $this->configuration->ldapGroupFilter;
- if(empty($filter)) {
+ if (empty($filter)) {
return false;
}
$cr = $this->getConnection();
- if(!$cr) {
+ if (!$cr) {
throw new \Exception('Could not connect to LDAP');
}
- $base = $this->configuration->ldapBase[0];
+ $base = $this->configuration->ldapBaseGroups[0] ?: $this->configuration->ldapBase[0];
$rr = $this->ldap->search($cr, $base, $filter, $possibleAttrs, 0, 1000);
- if(!$this->ldap->isResource($rr)) {
+ if (!$this->ldap->isResource($rr)) {
return false;
}
+ /** @var \LDAP\Result $rr */
$er = $this->ldap->firstEntry($cr, $rr);
- while(is_resource($er)) {
+ while ($this->ldap->isResource($er)) {
$this->ldap->getDN($cr, $er);
$attrs = $this->ldap->getAttributes($cr, $er);
- $result = array();
+ $result = [];
$possibleAttrsCount = count($possibleAttrs);
- for($i = 0; $i < $possibleAttrsCount; $i++) {
- if(isset($attrs[$possibleAttrs[$i]])) {
+ for ($i = 0; $i < $possibleAttrsCount; $i++) {
+ if (isset($attrs[$possibleAttrs[$i]])) {
$result[$possibleAttrs[$i]] = $attrs[$possibleAttrs[$i]]['count'];
}
}
- if(!empty($result)) {
+ if (!empty($result)) {
natsort($result);
return key($result);
}
@@ -826,22 +809,25 @@ class Wizard extends LDAPUtility {
* @return bool true on success, false otherwise
* @throws \Exception
*/
- private function testBaseDN($base) {
+ private function testBaseDN(string $base): bool {
$cr = $this->getConnection();
- if(!$cr) {
+ if (!$cr) {
throw new \Exception('Could not connect to LDAP');
}
//base is there, let's validate it. If we search for anything, we should
//get a result set > 0 on a proper base
- $rr = $this->ldap->search($cr, $base, 'objectClass=*', array('dn'), 0, 1);
- if(!$this->ldap->isResource($rr)) {
- $errorNo = $this->ldap->errno($cr);
+ $rr = $this->ldap->search($cr, $base, 'objectClass=*', ['dn'], 0, 1);
+ if (!$this->ldap->isResource($rr)) {
+ $errorNo = $this->ldap->errno($cr);
$errorMsg = $this->ldap->error($cr);
- \OCP\Util::writeLog('user_ldap', 'Wiz: Could not search base '.$base.
- ' Error '.$errorNo.': '.$errorMsg, \OCP\Util::INFO);
+ $this->logger->info(
+ 'Wiz: Could not search base ' . $base . ' Error ' . $errorNo . ': ' . $errorMsg,
+ ['app' => 'user_ldap']
+ );
return false;
}
+ /** @var \LDAP\Result $rr */
$entries = $this->ldap->countEntries($cr, $rr);
return ($entries !== false) && ($entries > 0);
}
@@ -855,13 +841,13 @@ class Wizard extends LDAPUtility {
* @return bool true if it does, false otherwise
* @throws \Exception
*/
- private function testMemberOf() {
+ private function testMemberOf(): bool {
$cr = $this->getConnection();
- if(!$cr) {
+ if (!$cr) {
throw new \Exception('Could not connect to LDAP');
}
- $result = $this->access->countUsers('memberOf=*', array('memberOf'), 1);
- if(is_int($result) && $result > 0) {
+ $result = $this->access->countUsers('memberOf=*', ['memberOf'], 1);
+ if (is_int($result) && $result > 0) {
return true;
}
return false;
@@ -869,52 +855,52 @@ class Wizard extends LDAPUtility {
/**
* creates an LDAP Filter from given configuration
- * @param integer $filterType int, for which use case the filter shall be created
- * can be any of self::LFILTER_USER_LIST, self::LFILTER_LOGIN or
- * self::LFILTER_GROUP_LIST
- * @return string|false string with the filter on success, false otherwise
+ * @param int $filterType int, for which use case the filter shall be created
+ * can be any of self::LFILTER_USER_LIST, self::LFILTER_LOGIN or
+ * self::LFILTER_GROUP_LIST
* @throws \Exception
*/
- private function composeLdapFilter($filterType) {
+ private function composeLdapFilter(int $filterType): string {
$filter = '';
$parts = 0;
switch ($filterType) {
case self::LFILTER_USER_LIST:
$objcs = $this->configuration->ldapUserFilterObjectclass;
//glue objectclasses
- if(is_array($objcs) && count($objcs) > 0) {
+ if (is_array($objcs) && count($objcs) > 0) {
$filter .= '(|';
- foreach($objcs as $objc) {
- $filter .= '(objectclass=' . $objc . ')';
+ foreach ($objcs as $objc) {
+ $filter .= '(objectclass=' . ldap_escape($objc, '', LDAP_ESCAPE_FILTER) . ')';
}
$filter .= ')';
$parts++;
}
//glue group memberships
- if($this->configuration->hasMemberOfFilterSupport) {
+ if ($this->configuration->hasMemberOfFilterSupport) {
$cns = $this->configuration->ldapUserFilterGroups;
- if(is_array($cns) && count($cns) > 0) {
+ if (is_array($cns) && count($cns) > 0) {
$filter .= '(|';
$cr = $this->getConnection();
- if(!$cr) {
+ if (!$cr) {
throw new \Exception('Could not connect to LDAP');
}
$base = $this->configuration->ldapBase[0];
- foreach($cns as $cn) {
- $rr = $this->ldap->search($cr, $base, 'cn=' . $cn, array('dn', 'primaryGroupToken'));
- if(!$this->ldap->isResource($rr)) {
+ foreach ($cns as $cn) {
+ $rr = $this->ldap->search($cr, $base, 'cn=' . ldap_escape($cn, '', LDAP_ESCAPE_FILTER), ['dn', 'primaryGroupToken']);
+ if (!$this->ldap->isResource($rr)) {
continue;
}
+ /** @var \LDAP\Result $rr */
$er = $this->ldap->firstEntry($cr, $rr);
$attrs = $this->ldap->getAttributes($cr, $er);
$dn = $this->ldap->getDN($cr, $er);
if ($dn === false || $dn === '') {
continue;
}
- $filterPart = '(memberof=' . $dn . ')';
- if(isset($attrs['primaryGroupToken'])) {
+ $filterPart = '(memberof=' . ldap_escape($dn, '', LDAP_ESCAPE_FILTER) . ')';
+ if (isset($attrs['primaryGroupToken'])) {
$pgt = $attrs['primaryGroupToken'][0];
- $primaryFilterPart = '(primaryGroupID=' . $pgt .')';
+ $primaryFilterPart = '(primaryGroupID=' . ldap_escape($pgt, '', LDAP_ESCAPE_FILTER) . ')';
$filterPart = '(|' . $filterPart . $primaryFilterPart . ')';
}
$filter .= $filterPart;
@@ -924,7 +910,7 @@ class Wizard extends LDAPUtility {
$parts++;
}
//wrap parts in AND condition
- if($parts > 1) {
+ if ($parts > 1) {
$filter = '(&' . $filter . ')';
}
if ($filter === '') {
@@ -935,26 +921,26 @@ class Wizard extends LDAPUtility {
case self::LFILTER_GROUP_LIST:
$objcs = $this->configuration->ldapGroupFilterObjectclass;
//glue objectclasses
- if(is_array($objcs) && count($objcs) > 0) {
+ if (is_array($objcs) && count($objcs) > 0) {
$filter .= '(|';
- foreach($objcs as $objc) {
- $filter .= '(objectclass=' . $objc . ')';
+ foreach ($objcs as $objc) {
+ $filter .= '(objectclass=' . ldap_escape($objc, '', LDAP_ESCAPE_FILTER) . ')';
}
$filter .= ')';
$parts++;
}
//glue group memberships
$cns = $this->configuration->ldapGroupFilterGroups;
- if(is_array($cns) && count($cns) > 0) {
+ if (is_array($cns) && count($cns) > 0) {
$filter .= '(|';
- foreach($cns as $cn) {
- $filter .= '(cn=' . $cn . ')';
+ foreach ($cns as $cn) {
+ $filter .= '(cn=' . ldap_escape($cn, '', LDAP_ESCAPE_FILTER) . ')';
}
$filter .= ')';
}
$parts++;
//wrap parts in AND condition
- if($parts > 1) {
+ if ($parts > 1) {
$filter = '(&' . $filter . ')';
}
break;
@@ -964,16 +950,19 @@ class Wizard extends LDAPUtility {
$loginpart = '=%uid';
$filterUsername = '';
$userAttributes = $this->getUserAttributes();
+ if ($userAttributes === false) {
+ throw new \Exception('Failed to get user attributes');
+ }
$userAttributes = array_change_key_case(array_flip($userAttributes));
$parts = 0;
- if($this->configuration->ldapLoginFilterUsername === '1') {
+ if ($this->configuration->ldapLoginFilterUsername === '1') {
$attr = '';
- if(isset($userAttributes['uid'])) {
+ if (isset($userAttributes['uid'])) {
$attr = 'uid';
- } else if(isset($userAttributes['samaccountname'])) {
+ } elseif (isset($userAttributes['samaccountname'])) {
$attr = 'samaccountname';
- } else if(isset($userAttributes['cn'])) {
+ } elseif (isset($userAttributes['cn'])) {
//fallback
$attr = 'cn';
}
@@ -984,16 +973,16 @@ class Wizard extends LDAPUtility {
}
$filterEmail = '';
- if($this->configuration->ldapLoginFilterEmail === '1') {
+ if ($this->configuration->ldapLoginFilterEmail === '1') {
$filterEmail = '(|(mailPrimaryAddress=%uid)(mail=%uid))';
$parts++;
}
$filterAttributes = '';
$attrsToFilter = $this->configuration->ldapLoginFilterAttributes;
- if(is_array($attrsToFilter) && count($attrsToFilter) > 0) {
+ if (is_array($attrsToFilter) && count($attrsToFilter) > 0) {
$filterAttributes = '(|';
- foreach($attrsToFilter as $attribute) {
+ foreach ($attrsToFilter as $attribute) {
$filterAttributes .= '(' . $attribute . $loginpart . ')';
}
$filterAttributes .= ')';
@@ -1001,21 +990,24 @@ class Wizard extends LDAPUtility {
}
$filterLogin = '';
- if($parts > 1) {
+ if ($parts > 1) {
$filterLogin = '(|';
}
$filterLogin .= $filterUsername;
$filterLogin .= $filterEmail;
$filterLogin .= $filterAttributes;
- if($parts > 1) {
+ if ($parts > 1) {
$filterLogin .= ')';
}
- $filter = '(&'.$ulf.$filterLogin.')';
+ $filter = '(&' . $ulf . $filterLogin . ')';
break;
}
- \OCP\Util::writeLog('user_ldap', 'Wiz: Final filter '.$filter, \OCP\Util::DEBUG);
+ $this->logger->debug(
+ 'Wiz: Final filter ' . $filter,
+ ['app' => 'user_ldap']
+ );
return $filter;
}
@@ -1025,21 +1017,24 @@ class Wizard extends LDAPUtility {
*
* @param int $port the port to connect with
* @param bool $tls whether startTLS is to be used
- * @return bool
* @throws \Exception
*/
- private function connectAndBind($port, $tls) {
+ private function connectAndBind(int $port, bool $tls): bool {
//connect, does not really trigger any server communication
$host = $this->configuration->ldapHost;
- $hostInfo = parse_url($host);
- if(!$hostInfo) {
+ $hostInfo = parse_url((string)$host);
+ if (!is_string($host) || !$hostInfo) {
throw new \Exception(self::$l->t('Invalid Host'));
}
- \OCP\Util::writeLog('user_ldap', 'Wiz: Attempting to connect ', \OCP\Util::DEBUG);
- $cr = $this->ldap->connect($host, $port);
- if(!is_resource($cr)) {
+ $this->logger->debug(
+ 'Wiz: Attempting to connect',
+ ['app' => 'user_ldap']
+ );
+ $cr = $this->ldap->connect($host, (string)$port);
+ if (!$this->ldap->isResource($cr)) {
throw new \Exception(self::$l->t('Invalid Host'));
}
+ /** @var \LDAP\Connection $cr */
//set LDAP options
$this->ldap->setOption($cr, LDAP_OPT_PROTOCOL_VERSION, 3);
@@ -1047,33 +1042,38 @@ class Wizard extends LDAPUtility {
$this->ldap->setOption($cr, LDAP_OPT_NETWORK_TIMEOUT, self::LDAP_NW_TIMEOUT);
try {
- if($tls) {
+ if ($tls) {
$isTlsWorking = @$this->ldap->startTls($cr);
- if(!$isTlsWorking) {
+ if (!$isTlsWorking) {
return false;
}
}
- \OCP\Util::writeLog('user_ldap', 'Wiz: Attemping to Bind ', \OCP\Util::DEBUG);
+ $this->logger->debug(
+ 'Wiz: Attempting to Bind',
+ ['app' => 'user_ldap']
+ );
//interesting part: do the bind!
$login = $this->ldap->bind($cr,
$this->configuration->ldapAgentName,
$this->configuration->ldapAgentPassword
);
$errNo = $this->ldap->errno($cr);
- $error = ldap_error($cr);
+ $error = $this->ldap->error($cr);
$this->ldap->unbind($cr);
- } catch(ServerNotAvailableException $e) {
+ } catch (ServerNotAvailableException $e) {
return false;
}
- if($login === true) {
- $this->ldap->unbind($cr);
- \OCP\Util::writeLog('user_ldap', 'Wiz: Bind successful to Port '. $port . ' TLS ' . intval($tls), \OCP\Util::DEBUG);
+ if ($login === true) {
+ $this->logger->debug(
+ 'Wiz: Bind successful to Port ' . $port . ' TLS ' . (int)$tls,
+ ['app' => 'user_ldap']
+ );
return true;
}
- if($errNo === -1) {
+ if ($errNo === -1) {
//host, port or TLS wrong
return false;
}
@@ -1083,27 +1083,23 @@ class Wizard extends LDAPUtility {
/**
* checks whether a valid combination of agent and password has been
* provided (either two values or nothing for anonymous connect)
- * @return bool, true if everything is fine, false otherwise
+ * @return bool true if everything is fine, false otherwise
*/
- private function checkAgentRequirements() {
+ private function checkAgentRequirements(): bool {
$agent = $this->configuration->ldapAgentName;
$pwd = $this->configuration->ldapAgentPassword;
return
($agent !== '' && $pwd !== '')
- || ($agent === '' && $pwd === '')
+ || ($agent === '' && $pwd === '')
;
}
- /**
- * @param array $reqs
- * @return bool
- */
- private function checkRequirements($reqs) {
+ private function checkRequirements(array $reqs): bool {
$this->checkAgentRequirements();
- foreach($reqs as $option) {
+ foreach ($reqs as $option) {
$value = $this->configuration->$option;
- if(empty($value)) {
+ if (empty($value)) {
return false;
}
}
@@ -1116,42 +1112,44 @@ class Wizard extends LDAPUtility {
* @param string[] $filters array, the filters that shall be used in the search
* @param string $attr the attribute of which a list of values shall be returned
* @param int $dnReadLimit the amount of how many DNs should be analyzed.
- * The lower, the faster
+ * The lower, the faster
* @param string $maxF string. if not null, this variable will have the filter that
- * yields most result entries
+ * yields most result entries
* @return array|false an array with the values on success, false otherwise
*/
- public function cumulativeSearchOnAttribute($filters, $attr, $dnReadLimit = 3, &$maxF = null) {
- $dnRead = array();
- $foundItems = array();
+ public function cumulativeSearchOnAttribute(array $filters, string $attr, int $dnReadLimit = 3, ?string &$maxF = null) {
+ $dnRead = [];
+ $foundItems = [];
$maxEntries = 0;
- if(!is_array($this->configuration->ldapBase)
+ if (!is_array($this->configuration->ldapBase)
|| !isset($this->configuration->ldapBase[0])) {
return false;
}
$base = $this->configuration->ldapBase[0];
$cr = $this->getConnection();
- if(!$this->ldap->isResource($cr)) {
+ if (!$this->ldap->isResource($cr)) {
return false;
}
+ /** @var \LDAP\Connection $cr */
$lastFilter = null;
- if(isset($filters[count($filters)-1])) {
- $lastFilter = $filters[count($filters)-1];
+ if (isset($filters[count($filters) - 1])) {
+ $lastFilter = $filters[count($filters) - 1];
}
- foreach($filters as $filter) {
- if($lastFilter === $filter && count($foundItems) > 0) {
+ foreach ($filters as $filter) {
+ if ($lastFilter === $filter && count($foundItems) > 0) {
//skip when the filter is a wildcard and results were found
continue;
}
// 20k limit for performance and reason
- $rr = $this->ldap->search($cr, $base, $filter, array($attr), 0, 20000);
- if(!$this->ldap->isResource($rr)) {
+ $rr = $this->ldap->search($cr, $base, $filter, [$attr], 0, 20000);
+ if (!$this->ldap->isResource($rr)) {
continue;
}
+ /** @var \LDAP\Result $rr */
$entries = $this->ldap->countEntries($cr, $rr);
$getEntryFunc = 'firstEntry';
- if(($entries !== false) && ($entries > 0)) {
- if(!is_null($maxF) && $entries > $maxEntries) {
+ if (($entries !== false) && ($entries > 0)) {
+ if (!is_null($maxF) && $entries > $maxEntries) {
$maxEntries = $entries;
$maxF = $filter;
}
@@ -1159,26 +1157,25 @@ class Wizard extends LDAPUtility {
do {
$entry = $this->ldap->$getEntryFunc($cr, $rr);
$getEntryFunc = 'nextEntry';
- if(!$this->ldap->isResource($entry)) {
+ if (!$this->ldap->isResource($entry)) {
continue 2;
}
$rr = $entry; //will be expected by nextEntry next round
$attributes = $this->ldap->getAttributes($cr, $entry);
$dn = $this->ldap->getDN($cr, $entry);
- if($dn === false || in_array($dn, $dnRead)) {
+ if ($attributes === false || $dn === false || in_array($dn, $dnRead)) {
continue;
}
- $newItems = array();
- $state = $this->getAttributeValuesFromEntry($attributes,
- $attr,
- $newItems);
+ $newItems = [];
+ $state = $this->getAttributeValuesFromEntry(
+ $attributes,
+ $attr,
+ $newItems
+ );
$dnReadCount++;
$foundItems = array_merge($foundItems, $newItems);
- $this->resultCache[$dn][$attr] = $newItems;
$dnRead[] = $dn;
- } while(($state === self::LRESULT_PROCESSED_SKIP
- || $this->ldap->isResource($entry))
- && ($dnReadLimit === 0 || $dnReadCount < $dnReadLimit));
+ } while ($dnReadLimit === 0 || $dnReadCount < $dnReadLimit);
}
}
@@ -1191,20 +1188,20 @@ class Wizard extends LDAPUtility {
* @param string $attr the attribute to look for
* @param string $dbkey the dbkey of the setting the feature is connected to
* @param string $confkey the confkey counterpart for the $dbkey as used in the
- * Configuration class
+ * Configuration class
* @param bool $po whether the objectClass with most result entries
- * shall be pre-selected via the result
- * @return array|false list of found items.
+ * shall be pre-selected via the result
+ * @return array list of found items.
* @throws \Exception
*/
- private function determineFeature($objectclasses, $attr, $dbkey, $confkey, $po = false) {
+ private function determineFeature(array $objectclasses, string $attr, string $dbkey, string $confkey, bool $po = false): array {
$cr = $this->getConnection();
- if(!$cr) {
+ if (!$cr) {
throw new \Exception('Could not connect to LDAP');
}
$p = 'objectclass=';
- foreach($objectclasses as $key => $value) {
- $objectclasses[$key] = $p.$value;
+ foreach ($objectclasses as $key => $value) {
+ $objectclasses[$key] = $p . $value;
}
$maxEntryObjC = '';
@@ -1212,10 +1209,10 @@ class Wizard extends LDAPUtility {
//When looking for objectclasses, testing few entries is sufficient,
$dig = 3;
- $availableFeatures =
- $this->cumulativeSearchOnAttribute($objectclasses, $attr,
- $dig, $maxEntryObjC);
- if(is_array($availableFeatures)
+ $availableFeatures
+ = $this->cumulativeSearchOnAttribute($objectclasses, $attr,
+ $dig, $maxEntryObjC);
+ if (is_array($availableFeatures)
&& count($availableFeatures) > 0) {
natcasesort($availableFeatures);
//natcasesort keeps indices, but we must get rid of them for proper
@@ -1226,10 +1223,10 @@ class Wizard extends LDAPUtility {
}
$setFeatures = $this->configuration->$confkey;
- if(is_array($setFeatures) && !empty($setFeatures)) {
+ if (is_array($setFeatures) && !empty($setFeatures)) {
//something is already configured? pre-select it.
$this->result->addChange($dbkey, $setFeatures);
- } else if ($po && $maxEntryObjC !== '') {
+ } elseif ($po && $maxEntryObjC !== '') {
//pre-select objectclass with most result entries
$maxEntryObjC = str_replace($p, '', $maxEntryObjC);
$this->applyFind($dbkey, $maxEntryObjC);
@@ -1241,28 +1238,27 @@ class Wizard extends LDAPUtility {
/**
* appends a list of values fr
- * @param resource $result the return value from ldap_get_attributes
+ * @param array $result the return value from ldap_get_attributes
* @param string $attribute the attribute values to look for
* @param array &$known new values will be appended here
- * @return int, state on of the class constants LRESULT_PROCESSED_OK,
- * LRESULT_PROCESSED_INVALID or LRESULT_PROCESSED_SKIP
+ * @return int state on of the class constants LRESULT_PROCESSED_OK,
+ * LRESULT_PROCESSED_INVALID or LRESULT_PROCESSED_SKIP
*/
- private function getAttributeValuesFromEntry($result, $attribute, &$known) {
- if(!is_array($result)
- || !isset($result['count'])
+ private function getAttributeValuesFromEntry(array $result, string $attribute, array &$known): int {
+ if (!isset($result['count'])
|| !$result['count'] > 0) {
return self::LRESULT_PROCESSED_INVALID;
}
// strtolower on all keys for proper comparison
- $result = \OCP\Util::mb_array_change_key_case($result);
+ $result = Util::mb_array_change_key_case($result);
$attribute = strtolower($attribute);
- if(isset($result[$attribute])) {
- foreach($result[$attribute] as $key => $val) {
- if($key === 'count') {
+ if (isset($result[$attribute])) {
+ foreach ($result[$attribute] as $key => $val) {
+ if ($key === 'count') {
continue;
}
- if(!in_array($val, $known)) {
+ if (!in_array($val, $known)) {
$known[] = $val;
}
}
@@ -1273,10 +1269,10 @@ class Wizard extends LDAPUtility {
}
/**
- * @return bool|mixed
+ * @return \LDAP\Connection|false a link resource on success, otherwise false
*/
- private function getConnection() {
- if(!is_null($this->cr)) {
+ private function getConnection(): \LDAP\Connection|false {
+ if (!is_null($this->cr)) {
return $this->cr;
}
@@ -1285,18 +1281,22 @@ class Wizard extends LDAPUtility {
$this->configuration->ldapPort
);
+ if ($cr === false) {
+ return false;
+ }
+
$this->ldap->setOption($cr, LDAP_OPT_PROTOCOL_VERSION, 3);
$this->ldap->setOption($cr, LDAP_OPT_REFERRALS, 0);
$this->ldap->setOption($cr, LDAP_OPT_NETWORK_TIMEOUT, self::LDAP_NW_TIMEOUT);
- if($this->configuration->ldapTLS === 1) {
+ if ($this->configuration->ldapTLS) {
$this->ldap->startTls($cr);
}
$lo = @$this->ldap->bind($cr,
- $this->configuration->ldapAgentName,
- $this->configuration->ldapAgentPassword);
- if($lo === true) {
- $this->$cr = $cr;
+ $this->configuration->ldapAgentName,
+ $this->configuration->ldapAgentPassword);
+ if ($lo === true) {
+ $this->cr = $cr;
return $cr;
}
@@ -1304,48 +1304,48 @@ class Wizard extends LDAPUtility {
}
/**
- * @return array
+ * @return array<array{port:int,tls:bool}>
*/
- private function getDefaultLdapPortSettings() {
- static $settings = array(
- array('port' => 7636, 'tls' => false),
- array('port' => 636, 'tls' => false),
- array('port' => 7389, 'tls' => true),
- array('port' => 389, 'tls' => true),
- array('port' => 7389, 'tls' => false),
- array('port' => 389, 'tls' => false),
- );
+ private function getDefaultLdapPortSettings(): array {
+ static $settings = [
+ ['port' => 7636, 'tls' => false],
+ ['port' => 636, 'tls' => false],
+ ['port' => 7389, 'tls' => true],
+ ['port' => 389, 'tls' => true],
+ ['port' => 7389, 'tls' => false],
+ ['port' => 389, 'tls' => false],
+ ];
return $settings;
}
/**
- * @return array
+ * @return array<array{port:int,tls:bool}>
*/
- private function getPortSettingsToTry() {
+ private function getPortSettingsToTry(): array {
//389 ← LDAP / Unencrypted or StartTLS
//636 ← LDAPS / SSL
//7xxx ← UCS. need to be checked first, because both ports may be open
$host = $this->configuration->ldapHost;
- $port = intval($this->configuration->ldapPort);
- $portSettings = array();
+ $port = (int)$this->configuration->ldapPort;
+ $portSettings = [];
//In case the port is already provided, we will check this first
- if($port > 0) {
+ if ($port > 0) {
$hostInfo = parse_url($host);
- if(!(is_array($hostInfo)
+ if (!(is_array($hostInfo)
&& isset($hostInfo['scheme'])
&& stripos($hostInfo['scheme'], 'ldaps') !== false)) {
- $portSettings[] = array('port' => $port, 'tls' => true);
+ $portSettings[] = ['port' => $port, 'tls' => true];
}
- $portSettings[] =array('port' => $port, 'tls' => false);
+ $portSettings[] = ['port' => $port, 'tls' => false];
+ } elseif ($this->configuration->usesLdapi()) {
+ $portSettings[] = ['port' => 0, 'tls' => false];
}
//default ports
$portSettings = array_merge($portSettings,
- $this->getDefaultLdapPortSettings());
+ $this->getDefaultLdapPortSettings());
return $portSettings;
}
-
-
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 21:06:46 +0000