LDAPAuthenticator::supportedServices() - Code Metrics - Inspection of "SS4 security changes and unit test fixes" - silverstripe/silverstripe-activedirectory - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#116)

by Franco

created 2017-08-30 05:54 UTC

LDAPAuthenticator::supportedServices() A

↳ Parent: LDAPAuthenticator

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace SilverStripe\ActiveDirectory\Authenticators;

use SilverStripe\ActiveDirectory\Services\LDAPService;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Email\Email;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\Session;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\Security\Authenticator;
use SilverStripe\Security\Member;
use SilverStripe\Security\MemberAuthenticator\LogoutHandler;
use SilverStripe\Security\MemberAuthenticator\MemberAuthenticator;

/**
 * Class LDAPAuthenticator
 *
 * Authenticate a user against LDAP, without the single sign-on component.
 *
 * See SAMLAuthenticator for further information.
 *
 * @package activedirectory
 */
class LDAPAuthenticator extends MemberAuthenticator
{
    /**
     * @var string
     */
    private $name = 'LDAP';


    /**
     * Set to 'yes' to indicate if this module should look up usernames in LDAP by matching the email addresses.
     *
     * CAVEAT #1: only set to 'yes' for systems that enforce email uniqueness.
     * Otherwise only the first LDAP user with matching email will be accessible.
     *
     * CAVEAT #2: this is untested for systems that use LDAP with principal style usernames (i.e. [email protected]).
     * The system will misunderstand emails for usernames with uncertain outcome.
     *
     * @var string 'no' or 'yes'
     */
    private static $allow_email_login = 'no';


    /**
     * Set to 'yes' to fallback login attempts to {@link $fallback_authenticator}.
     * This will occur if LDAP fails to authenticate the user.
     *
     * @var string 'no' or 'yes'
     */
    private static $fallback_authenticator = 'no';


    /**
     * The class of {@link Authenticator} to use as the fallback authenticator.
     *
     * @var string
     */
    private static $fallback_authenticator_class = MemberAuthenticator::class;


    /**
     * @return string
     */
    public static function get_name()
    {
        return Config::inst()->get(self::class, 'name');
    }

    /**
     * @param Controller $controller
     * @return LDAPLoginForm
     */
    public static function get_login_form(Controller $controller)
    {
        return new LDAPLoginForm($controller, 'LoginForm');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Performs the login, but will also create and sync the Member record on-the-fly, if not found.
     *
     * @param array $data
     * @param HTTPRequest $request
     * @param ValidationResult|null $result
     * @return bool|Member
     * @internal param Form $form
     */
    public function authenticate(array $data, HTTPRequest $request, ValidationResult &$result = null)
    {
        /** @var LDAPService $service */
        $service = Injector::inst()->get(LDAPService::class);
        $login = trim($data['Login']);
        if (Email::is_valid_address($login)) {
            if (Config::inst()->get(self::class, 'allow_email_login') != 'yes') {
                $result->addError(
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
                    _t(
                        'LDAPAuthenticator.PLEASEUSEUSERNAME',
                        'Please enter your username instead of your email to log in.'
                    )
                );
                return null;
            }

            $username = $service->getUsernameByEmail($login);

            // No user found with this email.
            if (!$username) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                if (Config::inst()->get(self::class, 'fallback_authenticator') === 'yes') {
                    if ($fallbackMember = $this->fallbackAuthenticate($data, $request)) {
                        {
                            return $fallbackMember;
                        }
                    }
                }

                $result->addError(_t('LDAPAuthenticator.INVALIDCREDENTIALS', 'Invalid credentials'));
                return null;
            }
        } else {
            $username = $login;
        }

        $serviceAuthenticationResult = $service->authenticate($username, $data['Password']);
        $success = $serviceAuthenticationResult['success'] === true;
        if (!$success) {

            if (Config::inst()->get(self::class, 'fallback_authenticator') === 'yes') {
                $fallbackMember = $this->fallbackAuthenticate($data, $request);
                if ($fallbackMember) {
                    return $fallbackMember;
                }
            }

            $result->addError($serviceAuthenticationResult['message']);

            return null;
        }

        $data = $service->getUserByUsername($serviceAuthenticationResult['identity']);
        if (!$data) {

            $result->addError(
                _t(
                    'LDAPAuthenticator.PROBLEMFINDINGDATA',
                    'There was a problem retrieving your user data'
                )
            );
            return null;
        }

        // LDAPMemberExtension::memberLoggedIn() will update any other AD attributes mapped to Member fields
        $member = Member::get()->filter('GUID', $data['objectguid'])->limit(1)->first();
        if (!($member && $member->exists())) {

            $member = new Member();
            $member->GUID = $data['objectguid'];
        }

        // Update the users from LDAP so we are sure that the email is correct.
        // This will also write the Member record.
        $service->updateMemberFromLDAP($member);


        $request->getSession()->clear('BackURL');

        return $member;
    }

    /**
     * Try to authenticate using the fallback authenticator.
     *
     * @param array $data
     * @param HTTPRequest $request
     * @return null|Member
     * @internal param null|Form $form
     */
    protected function fallbackAuthenticate($data, HTTPRequest $request)
    {
        $authenticatorClass = Config::inst()->get(self::class, 'fallback_authenticator_class');
        if ($authenticator = Injector::inst()->get($authenticatorClass)) {
            $result = call_user_func(
                [
                    $authenticator,
                    'authenticate'
                ],
                $data,
                $request
            );
            return $result;
        }
    }

    /**
     * @inheritdoc
     */
    public function getLoginHandler($link)
    {
        return LDAPLoginHandler::create($link, $this);
    }

    /**
     * @inheritdoc
     */
    public function supportedServices()
    {
        return Authenticator::LOGIN;
    }
}


1		<?php
2
3		namespace SilverStripe\ActiveDirectory\Authenticators;
4
5		use SilverStripe\ActiveDirectory\Services\LDAPService;
6		use SilverStripe\Control\Controller;
7		use SilverStripe\Control\Email\Email;
8		use SilverStripe\Control\HTTPRequest;
9		use SilverStripe\Control\Session;
10		use SilverStripe\Core\Config\Config;
11		use SilverStripe\Core\Injector\Injector;
12		use SilverStripe\ORM\ValidationResult;
13		use SilverStripe\Security\Authenticator;
14		use SilverStripe\Security\Member;
15		use SilverStripe\Security\MemberAuthenticator\LogoutHandler;
16		use SilverStripe\Security\MemberAuthenticator\MemberAuthenticator;
17
18		/**
19		* Class LDAPAuthenticator
20		*
21		* Authenticate a user against LDAP, without the single sign-on component.
22		*
23		* See SAMLAuthenticator for further information.
24		*
25		* @package activedirectory
26		*/
27		class LDAPAuthenticator extends MemberAuthenticator
28		{
29		/**
30		* @var string
31		*/
32		private $name = 'LDAP';
		0 ignored issues – show Unused Code introduced 2016-03-22 20:04 UTC by Report Bug Copy Issue Report The property `$name` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
33
34		/**
35		* Set to 'yes' to indicate if this module should look up usernames in LDAP by matching the email addresses.
36		*
37		* CAVEAT #1: only set to 'yes' for systems that enforce email uniqueness.
38		* Otherwise only the first LDAP user with matching email will be accessible.
39		*
40		* CAVEAT #2: this is untested for systems that use LDAP with principal style usernames (i.e. [email protected]).
41		* The system will misunderstand emails for usernames with uncertain outcome.
42		*
43		* @var string 'no' or 'yes'
44		*/
45		private static $allow_email_login = 'no';
		0 ignored issues – show Unused Code introduced 2016-03-22 20:04 UTC by Report Bug Copy Issue Report The property `$allow_email_login` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
46
47		/**
48		* Set to 'yes' to fallback login attempts to {@link $fallback_authenticator}.
49		* This will occur if LDAP fails to authenticate the user.
50		*
51		* @var string 'no' or 'yes'
52		*/
53		private static $fallback_authenticator = 'no';
		0 ignored issues – show Unused Code introduced 2017-01-16 21:03 UTC by Report Bug Copy Issue Report The property `$fallback_authenticator` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
54
55		/**
56		* The class of {@link Authenticator} to use as the fallback authenticator.
57		*
58		* @var string
59		*/
60		private static $fallback_authenticator_class = MemberAuthenticator::class;
		0 ignored issues – show Unused Code introduced 2017-04-11 01:05 UTC by Report Bug Copy Issue Report The property `$fallback_authenticator_class` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
61
62		/**
63		* @return string
64		*/
65		public static function get_name()
66		{
67		return Config::inst()->get(self::class, 'name');
68		}
69
70		/**
71		* @param Controller $controller
72		* @return LDAPLoginForm
73		*/
74		public static function get_login_form(Controller $controller)
75		{
76		return new LDAPLoginForm($controller, 'LoginForm');
		0 ignored issues – show Documentation introduced 2017-01-16 21:03 UTC by Report Bug Copy Issue Report `$controller` is of type `object<SilverStripe\Control\Controller>`, but the function expects a `object<SilverStripe\Acti...henticators\Controller>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
77		}
78
79		/**
80		* Performs the login, but will also create and sync the Member record on-the-fly, if not found.
81		*
82		* @param array $data
83		* @param HTTPRequest $request
84		* @param ValidationResult\|null $result
85		* @return bool\|Member
86		* @internal param Form $form
87		*/
88		public function authenticate(array $data, HTTPRequest $request, ValidationResult &$result = null)
89		{
90		/** @var LDAPService $service */
91		$service = Injector::inst()->get(LDAPService::class);
92		$login = trim($data['Login']);
93		if (Email::is_valid_address($login)) {
94		if (Config::inst()->get(self::class, 'allow_email_login') != 'yes') {
95		$result->addError(
		0 ignored issues – show Bug introduced 2017-08-17 23:47 UTC by Report Bug Copy Issue Report It seems like `$result` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
96		_t(
97		'LDAPAuthenticator.PLEASEUSEUSERNAME',
98		'Please enter your username instead of your email to log in.'
99		)
100		);
101		return null;
102		}
103
104		$username = $service->getUsernameByEmail($login);
105
106		// No user found with this email.
107	View Code Duplication	if (!$username) {
		0 ignored issues – show Bug Best Practice introduced 2017-08-30 05:56 UTC by Report Bug Copy Issue Report The expression `$username` of type `null\|string` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history... Duplication introduced 2017-01-16 21:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
108		if (Config::inst()->get(self::class, 'fallback_authenticator') === 'yes') {
109		if ($fallbackMember = $this->fallbackAuthenticate($data, $request)) {
110		{
111		return $fallbackMember;
112		}
113		}
114		}
115
116		$result->addError(_t('LDAPAuthenticator.INVALIDCREDENTIALS', 'Invalid credentials'));
117		return null;
118		}
119		} else {
120		$username = $login;
121		}
122
123		$serviceAuthenticationResult = $service->authenticate($username, $data['Password']);
124		$success = $serviceAuthenticationResult['success'] === true;
125	View Code Duplication	if (!$success) {
		0 ignored issues – show Duplication introduced 2017-01-16 21:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
126		if (Config::inst()->get(self::class, 'fallback_authenticator') === 'yes') {
127		$fallbackMember = $this->fallbackAuthenticate($data, $request);
128		if ($fallbackMember) {
129		return $fallbackMember;
130		}
131		}
132
133		$result->addError($serviceAuthenticationResult['message']);
134
135		return null;
136		}
137
138		$data = $service->getUserByUsername($serviceAuthenticationResult['identity']);
139		if (!$data) {
		0 ignored issues – show Bug Best Practice introduced 2017-08-30 05:56 UTC by Report Bug Copy Issue Report The expression `$data` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
140		$result->addError(
141		_t(
142		'LDAPAuthenticator.PROBLEMFINDINGDATA',
143		'There was a problem retrieving your user data'
144		)
145		);
146		return null;
147		}
148
149		// LDAPMemberExtension::memberLoggedIn() will update any other AD attributes mapped to Member fields
150		$member = Member::get()->filter('GUID', $data['objectguid'])->limit(1)->first();
151	View Code Duplication	if (!($member && $member->exists())) {
		0 ignored issues – show Duplication introduced 2016-03-22 20:04 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
152		$member = new Member();
153		$member->GUID = $data['objectguid'];
154		}
155
156		// Update the users from LDAP so we are sure that the email is correct.
157		// This will also write the Member record.
158		$service->updateMemberFromLDAP($member);
		0 ignored issues – show Compatibility introduced 2017-08-30 05:56 UTC by Report Bug Copy Issue Report `$member` of type `object<SilverStripe\ORM\DataObject>` is not a sub-type of `object<SilverStripe\Security\Member>`. It seems like you assume a child class of the class `SilverStripe\ORM\DataObject` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
159
160		$request->getSession()->clear('BackURL');
161
162		return $member;
163		}
164
165		/**
166		* Try to authenticate using the fallback authenticator.
167		*
168		* @param array $data
169		* @param HTTPRequest $request
170		* @return null\|Member
171		* @internal param null\|Form $form
172		*/
173		protected function fallbackAuthenticate($data, HTTPRequest $request)
174		{
175		$authenticatorClass = Config::inst()->get(self::class, 'fallback_authenticator_class');
176		if ($authenticator = Injector::inst()->get($authenticatorClass)) {
177		$result = call_user_func(
178		[
179		$authenticator,
180		'authenticate'
181		],
182		$data,
183		$request
184		);
185		return $result;
186		}
187		}
188
189		/**
190		* @inheritdoc
191		*/
192		public function getLoginHandler($link)
193		{
194		return LDAPLoginHandler::create($link, $this);
195		}
196
197		/**
198		* @inheritdoc
199		*/
200		public function supportedServices()
201		{
202		return Authenticator::LOGIN;
203		}
204		}
205

silverstripe / silverstripe-activedirectory

Pull Request — master (#116)

LDAPAuthenticator::supportedServices() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like