WebSVN – oidplus – Diff – /trunk/includes/classes/OIDplusAuthUtils.class.php

 class OIDplusAuthUtils extends OIDplusBaseClass {
         // Useful functions
+        /**
+         * @param string $password
+         * @return string
+         * @throws OIDplusException
+         */
         private static function raPepperProcessing(string $password): string {
                 // Additional feature: Pepper
                 // The pepper is stored inside the base configuration file
                 // It prevents that an attacker with SQL write rights can
                 // create accounts.
                         if (strtolower($algo) === 'sha3-512') {
                                 $hmac = sha3_512_hmac($password, $pepper);
                         } else {
                                 $hmac = hash_hmac($algo, $password, $pepper);
+                        }
-                        if ($hmac === false) throw new OIDplusException(_L('HMAC failed'));
+                        if ($hmac === "") throw new OIDplusException(_L('HMAC failed'));
                         return $hmac;
                 } else {
                         return $password;
+                }
+        }
         // Content provider
+        /**
+         * @return string
+         * @throws OIDplusException
+         */
         public function getAuthMethod() {
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return 'null';
                 return get_class($acs);
+        }
+        /**
+         * @return OIDplusAuthContentStore|null
+         * @throws OIDplusException
+         */
-        protected function getAuthContentStore() {
+        protected function getAuthContentStore()/*: ?OIDplusAuthContentStore*/ {
                 // Logged in via JWT
                 $tmp = OIDplusAuthContentStoreJWT::getActiveProvider();
                 if ($tmp) return $tmp;
                 // Normal login via web-browser
                 // No active session and no JWT token available. User is not logged in.
                 return null;
+        }
+        /**
+         * @param string $name
+         * @param mixed|null $default
+         * @return mixed
+         * @throws OIDplusException
+         */
-        public function getExtendedAttribute($name, $default=NULL) {
+        public function getExtendedAttribute(string $name, $default=NULL) {
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return $default;
                 return $acs->getValue($name, $default);
+        }
         // RA authentication functions
+        /**
+         * @param string $email
+         * @return void
+         * @throws OIDplusException
+         */
-        public function raLogin($email) {
+        public function raLogin(string $email) {
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return;
-                return $acs->raLogin($email);
+                $acs->raLogin($email);
+        }
+        /**
+         * @param string $email
+         * @return void
+         * @throws OIDplusException
+         */
-        public function raLogout($email) {
+        public function raLogout(string $email) {
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return;
-                return $acs->raLogout($email);
+                $acs->raLogout($email);
+        }
+        /**
+         * @param string $ra_email
+         * @param string $password
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function raCheckPassword($ra_email, $password) {
+        public function raCheckPassword(string $ra_email, string $password): bool {
                 $ra = new OIDplusRA($ra_email);
                 // Get RA info from RA
                 $authInfo = $ra->getAuthInfo();
                 if (!$authInfo) return false; // user not found
+                }
                 return false;
+        }
+        /**
+         * @return int
+         * @throws OIDplusException
+         */
-        public function raNumLoggedIn() {
+        public function raNumLoggedIn(): int {
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return 0;
                 return $acs->raNumLoggedIn();
+        }
+        /**
+         * @return OIDplusRA[]
+         * @throws OIDplusException
+         */
-        public function loggedInRaList() {
+        public function loggedInRaList(): array {
                 if ($this->forceAllLoggedOut()) {
                         return array();
                 } else {
                         $acs = $this->getAuthContentStore();
                         if (is_null($acs)) return array();
                         return $acs->loggedInRaList();
+                }
+        }
+        /**
+         * @param string $email
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function isRaLoggedIn($email) {
+        public function isRaLoggedIn(string $email): bool {
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return false;
                 return $acs->isRaLoggedIn($email);
+        }
         // "High level" function including logging and checking for valid JWT alternations
+        /**
+         * @param string $email
+         * @param bool $remember_me
+         * @param string $origin
+         * @return void
+         * @throws OIDplusException
+         */
-        public function raLoginEx($email, $remember_me, $origin='') {
+        public function raLoginEx(string $email, bool $remember_me, string $origin='') {
                 $loginfo = '';
                 $acs = $this->getAuthContentStore();
                 if (!is_null($acs)) {
                         $acs->raLoginEx($email, $loginfo);
                         $acs->activate();
                 if ($origin != '') $logmsg .= " via $origin";
                 if ($loginfo != '') $logmsg .= " ($loginfo)";
                 OIDplus::logger()->log("[OK]RA($email)!", $logmsg);
+        }
+        /**
+         * @param string $email
+         * @return void
+         * @throws OIDplusException
+         */
-        public function raLogoutEx($email) {
+        public function raLogoutEx(string $email) {
                 $loginfo = '';
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return;
-                $res = $acs->raLogoutEx($email, $loginfo);
+                $acs->raLogoutEx($email, $loginfo);
                 OIDplus::logger()->log("[OK]RA($email)!", "RA '$email' logged out ($loginfo)");
                 if (($this->raNumLoggedIn() == 0) && (!$this->isAdminLoggedIn())) {
                         // Nobody logged in anymore. Destroy session cookie to make GDPR people happy
                         $acs->destroySession();
                 } else {
                         // Get a new token for the remaining users
                         $acs->activate();
+                }
-                return $res;
+        }
         // Admin authentication functions
+        /**
+         * @return void
+         * @throws OIDplusException
+         */
         public function adminLogin() {
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return;
-                return $acs->adminLogin();
+                $acs->adminLogin();
+        }
+        /**
+         * @return void
+         * @throws OIDplusException
+         */
         public function adminLogout() {
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return;
-                return $acs->adminLogout();
+                $acs->adminLogout();
+        }
+        /**
+         * @param string $password
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function adminCheckPassword($password) {
+        public function adminCheckPassword(string $password): bool {
                 $cfgData = OIDplus::baseConfig()->getValue('ADMIN_PASSWORD', '');
                 if (empty($cfgData)) {
                         throw new OIDplusException(_L('No admin password set in %1','userdata/baseconfig/config.inc.php'));
+                }
+                }
                 return false;
+        }
+        /**
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function isAdminLoggedIn() {
+        public function isAdminLoggedIn(): bool {
                 if ($this->forceAllLoggedOut()) {
                         return false;
                 } else {
                         $acs = $this->getAuthContentStore();
                         if (is_null($acs)) return false;
                         return $acs->isAdminLoggedIn();
+                }
+        }
+        /**
-        // "High level" function including logging and checking for valid JWT alternations
+         * "High level" function including logging and checking for valid JWT alternations
+         * @param bool $remember_me
+         * @param string $origin
+         * @return void
+         * @throws OIDplusException
+         */
-        public function adminLoginEx($remember_me, $origin='') {
+        public function adminLoginEx(bool $remember_me, string $origin='') {
                 $loginfo = '';
                 $acs = $this->getAuthContentStore();
                 if (!is_null($acs)) {
                         $acs->adminLoginEx($loginfo);
                         $acs->activate();
                 if ($origin != '') $logmsg .= " via $origin";
                 if ($loginfo != '') $logmsg .= " ($loginfo)";
                 OIDplus::logger()->log("[OK]A!", $logmsg);
+        }
+        /**
+         * @return void
+         * @throws OIDplusException
+         */
         public function adminLogoutEx() {
                 $loginfo = '';
                 $acs = $this->getAuthContentStore();
                 if (is_null($acs)) return;
-                $res = $acs->adminLogoutEx($loginfo);
+                $acs->adminLogoutEx($loginfo);
                 if ($this->raNumLoggedIn() == 0) {
                         // Nobody here anymore. Destroy the cookie to make GDPR people happy
                         $acs->destroySession();
                 } else {
                         // Get a new token for the remaining users
                         $acs->activate();
+                }
                 OIDplus::logger()->log("[OK]A!", "Admin logged out ($loginfo)");
-                return $res;
+        }
         // Authentication keys for validating arguments (e.g. sent by mail)
+        /**
+         * @param string $data
+         * @return string
+         * @throws OIDplusException
+         */
-        public static function makeAuthKey($data) {
+        public static function makeAuthKey(string $data): string {
                 return sha3_512_hmac($data, 'authkey:'.OIDplus::baseConfig()->getValue('SERVER_SECRET'), false);
+        }
+        /**
+         * @param string $data
+         * @param string $auth_key
+         * @return bool
+         * @throws OIDplusException
+         */
-        public static function validateAuthKey($data, $auth_key) {
+        public static function validateAuthKey(string $data, string $auth_key): bool {
                 return hash_equals(self::makeAuthKey($data), $auth_key);
+        }
         // "Veto" functions to force logout state
+        /**
+         * @return bool
+         */
-        protected function forceAllLoggedOut() {
+        protected function forceAllLoggedOut(): bool {
                 if (isset($_SERVER['SCRIPT_FILENAME']) && (basename($_SERVER['SCRIPT_FILENAME']) == 'sitemap.php')) {
                         // The sitemap may not contain any confidential information,
                         // even if the user is logged in, because the admin could
                         // accidentally copy-paste the sitemap to a
                         // search engine control panel while they are logged in
         // CSRF functions
         private $enable_csrf = true;
+        /**
+         * @return void
+         */
         public function enableCSRF() {
                 $this->enable_csrf = true;
+        }
+        /**
+         * @return void
+         */
         public function disableCSRF() {
                 $this->enable_csrf = false;
+        }
+        /**
+         * @return string
+         * @throws \Random\RandomException
+         */
-        public function genCSRFToken() {
+        public function genCSRFToken(): string {
                 return random_bytes_ex(64, false, false);
+        }
+        /**
+         * @return void
+         * @throws OIDplusException
+         */
         public function checkCSRF() {
                 if (!$this->enable_csrf) return;
                 $request_token = isset($_REQUEST['csrf_token']) ? $_REQUEST['csrf_token'] : '';
                 $cookie_token = isset($_COOKIE['csrf_token']) ? $_COOKIE['csrf_token'] : '';
+                }
+        }
         // Generate RA passwords
+        /**
+         * @param string $password
+         * @return OIDplusRAAuthInfo
+         * @throws OIDplusException
+         */
-        public static function raGeneratePassword($password): OIDplusRAAuthInfo {
+        public static function raGeneratePassword(string $password): OIDplusRAAuthInfo {
                 $plugin = OIDplus::getDefaultRaAuthPlugin(true);
                 return $plugin->generate(self::raPepperProcessing($password));
+        }
         // Generate admin password

Subversion Repositories oidplus

oidplus/trunk/includes/classes/OIDplusAuthUtils.class.php – Rev 1107 → 1116