(auth) style cleanups

src/opnsense/mvc/app/library/OPNsense/Auth/AuthenticationFactory.php

@@ -39,6 +39,8 @@ class AuthenticationFactory
 {
     /**
      * search already known local userDN's into simple mapping if auth method is current standard method
+     * @param string $authserver auth server name
+     * @return array list of dn's
      */
     private function fetchUserDNs($authserver = null)
     {
@@ -80,7 +82,7 @@ class AuthenticationFactory
 
     /**
      * get new authenticator
-     * @param $authserver authentication server name
+     * @param string $authserver authentication server name
      * @return IAuthConnector|null
      */
     public function get($authserver)

src/opnsense/mvc/app/library/OPNsense/Auth/IAuthConnector.php

@@ -49,8 +49,8 @@ interface IAuthConnector
 
     /**
      * authenticate user
-     * @param $username username to authenticate
-     * @param $password user password
+     * @param string $username username to authenticate
+     * @param string $password user password
      * @return bool
      */
     public function authenticate($username, $password);

src/opnsense/mvc/app/library/OPNsense/Auth/LDAP.php

@@ -109,7 +109,7 @@ class LDAP implements IAuthConnector
 
     /**
      * search ldap tree
-     * @param $filter ldap filter string to use
+     * @param string $filter ldap filter string to use
      * @param string $ldap_scope scope either one or tree
      * @return array|bool result list or false on errors
      */
@@ -144,7 +144,7 @@ class LDAP implements IAuthConnector
 
     /**
      * construct a new LDAP connector
-     * @param null $baseSearchDN setup base searchDN or list of DN's separated by ;
+     * @param null|string $baseSearchDN setup base searchDN or list of DN's separated by ;
      * @param int $ldapVersion setup ldap version
      */
     public function __construct($baseSearchDN = null, $ldapVersion = 3)
@@ -201,8 +201,8 @@ class LDAP implements IAuthConnector
     /**
      * initiate a connection.
      * @param $bind_url string url to use
-     * @param null $userdn connect dn to use, leave empty for anonymous
-     * @param null $password password
+     * @param null|string $userdn connect dn to use, leave empty for anonymous
+     * @param null|string $password password
      * @param int $timeout network timeout
      * @return bool connect status (success/fail)
      */
@@ -228,9 +228,9 @@ class LDAP implements IAuthConnector
 
     /**
      * search user by name or expression
-     * @param $username string username(s) to search
-     * @param $userNameAttribute string ldap attribute to use for the search
-     * @param $extendedQuery string|null additional search criteria (narrow down search)
+     * @param string $username username(s) to search
+     * @param string $userNameAttribute ldap attribute to use for the search
+     * @param string|null $extendedQuery additional search criteria (narrow down search)
      * @return array|bool
      */
     public function searchUsers($username, $userNameAttribute, $extendedQuery = null)
@@ -297,8 +297,8 @@ class LDAP implements IAuthConnector
 
     /**
      * authenticate user against ldap server
-     * @param $username username to authenticate
-     * @param $password user password
+     * @param string $username username to authenticate
+     * @param string $password user password
      * @return bool authentication status
      */
     public function authenticate($username, $password)

src/opnsense/mvc/app/library/OPNsense/Auth/Local.php

@@ -57,8 +57,8 @@ class Local implements IAuthConnector
 
     /**
      * authenticate user against local database (in config.xml)
-     * @param $username username to authenticate
-     * @param $password user password
+     * @param string $username username to authenticate
+     * @param string $password user password
      * @return bool authentication status
      */
     public function authenticate($username, $password)