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


<?php
 
/*
 * OIDplus 2.0
 * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
namespace ViaThinkSoft\OIDplus;
 
// phpcs:disable PSR1.Files.SideEffects
\defined('INSIDE_OIDPLUS') or die;
// phpcs:enable PSR1.Files.SideEffects
 
class OIDplusAuthContentStoreJWT extends OIDplusAuthContentStore {
 
        /**
         * Cookie name for the JWT auth token
         */
        const COOKIE_NAME = 'OIDPLUS_AUTH_JWT';
 
        /**
         * "Automated AJAX" plugin
         */
        const JWT_GENERATOR_AJAX   = 10;
        /**
         * "REST API" plugin
         */
        const JWT_GENERATOR_REST   = 20;
        /**
         * "Remember me" login method
         */
        const JWT_GENERATOR_LOGIN  = 40;
        /**
         * "Manually crafted" JWT tokens
         */
        const JWT_GENERATOR_MANUAL = 80;
 
        /**
         * @param int $gen OIDplusAuthContentStoreJWT::JWT_GENERATOR_...
         * @param string $sub
         * @return string
         */
        private static function jwtGetBlacklistConfigKey(int $gen, string $sub): string {
                // Note: Needs to be <= 50 characters! If $gen is 2 chars, then the config key is 49 chars long
                return 'jwt_blacklist_gen('.$gen.')_sub('.trim(base64_encode(md5($sub,true)),'=').')';
        }
 
        /**
         * @param int $gen
         */
        private static function generatorName($gen) {
                // Note: The strings are not translated, because the name is used in config keys or logs
                if ($gen === self::JWT_GENERATOR_AJAX)   return 'Automated AJAX calls';
                if ($gen === self::JWT_GENERATOR_REST)   return 'REST API';
                if ($gen === self::JWT_GENERATOR_LOGIN)  return 'Login ("Remember me")';
                if ($gen === self::JWT_GENERATOR_MANUAL) return 'Manually created';
                return 'Unknown generator';
        }
 
        /**
         * @param int $gen OIDplusAuthContentStoreJWT::JWT_GENERATOR_...
         * @param string $sub
         * @return void
         * @throws OIDplusException
         */
        public static function jwtBlacklist(int $gen, string $sub) {
                $cfg = self::jwtGetBlacklistConfigKey($gen, $sub);
                $bl_time = time()-1;
 
                $gen_desc = self::generatorName($gen);
 
                OIDplus::config()->prepareConfigKey($cfg, 'Revoke timestamp of all JWT tokens for $sub with generator $gen ($gen_desc)', "$bl_time", OIDplusConfig::PROTECTION_HIDDEN, function($value) {});
                OIDplus::config()->setValue($cfg, $bl_time);
        }
 
        /**
         * @param int $gen OIDplusAuthContentStoreJWT::JWT_GENERATOR_...
         * @param string $sub
         * @return int
         * @throws OIDplusException
         */
        public static function jwtGetBlacklistTime(int $gen, string $sub): int {
                $cfg = self::jwtGetBlacklistConfigKey($gen, $sub);
                return (int)OIDplus::config()->getValue($cfg,0);
        }
 
        /**
         * We include a hash of the server-secret here (ssh = server-secret-hash), so that the JWT can be invalidated by changing the server-secret
         * @return string
         * @throws OIDplusException
         */
        private static function getSsh(): string {
                return OIDplus::authUtils()->makeSecret(['bb1aebd6-fe6a-11ed-a553-3c4a92df8582']);
        }
 
        /**
         * Do various checks if the token is allowed and not blacklisted
         * @param OIDplusAuthContentStore $contentProvider
         * @param int|null $validGenerators Bitmask which generators to allow (null = allow all)
         * @return void
         * @throws OIDplusException
         */
        private static function jwtSecurityCheck(OIDplusAuthContentStore $contentProvider, int $validGenerators=null) {
                // Check if the token is intended for us
                if ($contentProvider->getValue('aud','') !== OIDplus::getEditionInfo()['jwtaud']) {
                        throw new OIDplusException(_L('Token has wrong audience'));
                }
 
                if ($contentProvider->getValue('oidplus_ssh', '') !== self::getSsh()) {
                        throw new OIDplusException(_L('"Server Secret" was changed; therefore the JWT is not valid anymore'));
                }
 
                $gen = $contentProvider->getValue('oidplus_generator', -1);
 
                $has_admin = $contentProvider->isAdminLoggedIn();
                $has_ra = $contentProvider->raNumLoggedIn() > 0;
 
                // Check if the token generator is allowed
                if ($gen === self::JWT_GENERATOR_AJAX) {
                        if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_AJAX_ADMIN', true)) {
                                // Generator: plugins/viathinksoft/adminPages/910_automated_ajax_calls/OIDplusPageAdminAutomatedAJAXCalls.class.php
                                throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_AJAX_ADMIN'));
                        }
                        if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_AJAX_USER', true)) {
                                // Generator: plugins/viathinksoft/raPages/910_automated_ajax_calls/OIDplusPageRaAutomatedAJAXCalls.class.php
                                throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_AJAX_USER'));
                        }
                }
                else if ($gen === self::JWT_GENERATOR_REST) {
                        if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_ADMIN', true)) {
                                // Generator: plugins/viathinksoft/adminPages/911_rest_api/OIDplusPageAdminRestApi.class.php
                                throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_ADMIN'));
                        }
                        if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_USER', true)) {
                                // Generator: plugins/viathinksoft/raPages/911_rest_api/OIDplusPageRaRestApi.class.php
                                throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_USER'));
                        }
                }
                else if ($gen === self::JWT_GENERATOR_LOGIN) {
                        // Used for feature "Remember me" (use JWT token in a cookie as alternative to PHP session):
                        // - No PHP session will be used
                        // - Session will not be bound to IP address (therefore, you can switch between mobile/WiFi for example)
                        // - No server-side session needed
                        if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_ADMIN', true)) {
                                throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_LOGIN_ADMIN'));
                        }
                        if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_USER', true)) {
                                throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_LOGIN_USER'));
                        }
                }
                else if ($gen === self::JWT_GENERATOR_MANUAL) {
                        // Generator: "hand-crafted" tokens
                        if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_MANUAL_ADMIN', false)) {
                                throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_MANUAL_ADMIN'));
                        }
                        if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_MANUAL_USER', false)) {
                                throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_MANUAL_USER'));
                        }
                } else {
                        throw new OIDplusException(_L('Token generator %1 not recognized',$gen));
                }
 
                // Make sure that the IAT (issued at time) isn't in a blacklisted timeframe
                // When an user believes that a token was compromised, then they can blacklist the tokens identified by their "iat" ("Issued at") property
                // When a user logs out of a "remember me" session, the JWT token will be blacklisted as well
                // Small side effect: All "remember me" sessions of that user will be revoked then
                $iat = $contentProvider->getValue('iat',0);
                if (($iat-120/*leeway 2min*/) > time()) {
                        // Token was created in the future. Something is wrong!
                        throw new OIDplusException(_L('JWT Token cannot be verified because the server time is wrong'));
                }
                $sublist = $contentProvider->loggedInRaList();
                $usernames = array();
                foreach ($sublist as $sub) {
                        $usernames[] = $sub->raEmail();
                }
                if ($has_admin) $usernames[] = 'admin';
                foreach ($usernames as $username) {
                        $bl_time = self::jwtGetBlacklistTime($gen, $username);
                        if ($iat <= $bl_time) {
                                // Token is blacklisted (it was created before the last blacklist time)
                                throw new OIDplusException(_L('The JWT token was blacklisted on %1. Please generate a new one',date('d F Y, H:i:s',$bl_time)));
                        }
                }
 
                // Optional feature: Limit the JWT to a specific IP address
                // Currently not used in OIDplus
                $ip = $contentProvider->getValue('oidplus_limit_ip','');
                if ($ip !== '') {
                        if (isset($_SERVER['REMOTE_ADDR']) && ($ip !== $_SERVER['REMOTE_ADDR'])) {
                                throw new OIDplusException(_L('Your IP address is not allowed to use this token'));
                        }
                }
 
                // Checks if JWT are dependent on the generator
                if (!is_null($validGenerators)) {
                        if (($gen & $validGenerators) === 0) {
                                throw new OIDplusException(_L('This kind of JWT token (%1) cannot be used in this request type', self::generatorName($gen)));
                        }
                }
        }
 
        // Override abstract functions
 
        /**
         * @var array
         */
        protected $content = array();
 
        /**
         * @param string $name
         * @param mixed|null $default
         * @return mixed|null
         */
        public function getValue(string $name, $default = NULL) {
                return $this->content[$name] ?? $default;
        }
 
        /**
         * @param string $name
         * @param mixed $value
         * @return void
         */
        public function setValue(string $name, $value) {
                $this->content[$name] = $value;
        }
 
        /**
         * @param string $name
         * @return bool
         */
        public function exists(string $name): bool {
                return isset($this->content[$name]);
        }
 
        /**
         * @param string $name
         * @return void
         */
        public function delete(string $name) {
                unset($this->content[$name]);
        }
 
        /**
         * @return void
         */
        public function activate() {
                // Send cookie at the end of the HTTP request, in case there are multiple activate() calls
                OIDplus::register_shutdown_function(array($this,'activateNow'));
        }
 
        /**
         * @return void
         * @throws OIDplusException
         */
        public function activateNow() {
                $token = $this->getJWTToken();
                $exp = $this->getValue('exp',0);
                OIDplus::cookieUtils()->setcookie(self::COOKIE_NAME, $token, $exp, false);
        }
 
        /**
         * @return void
         * @throws OIDplusException
         */
        public function destroySession() {
                OIDplus::cookieUtils()->unsetcookie(self::COOKIE_NAME);
        }
 
        /**
         * @param string $email
         * @return void
         * @throws OIDplusException
         */
        public function raLogout(string $email) {
                $gen = $this->getValue('oidplus_generator', -1);
                if ($gen >= 0) self::jwtBlacklist($gen, $email);
                parent::raLogout($email);
        }
 
        /**
         * @param string $email
         * @param string $loginfo
         * @return void
         * @throws OIDplusException
         */
        public function raLogoutEx(string $email, string &$loginfo) {
                $this->raLogout($email);
                $loginfo = 'from JWT session';
        }
 
        /**
         * @return void
         * @throws OIDplusException
         */
        public function adminLogout() {
                $gen = $this->getValue('oidplus_generator', -1);
                if ($gen >= 0) self::jwtBlacklist($gen, 'admin');
                parent::adminLogout();
        }
 
        /**
         * @param string $loginfo
         * @return void
         * @throws OIDplusException
         */
        public function adminLogoutEx(string &$loginfo) {
                $this->adminLogout();
                $loginfo = 'from JWT session';
        }
 
        private static $contentProvider = null;
 
        /**
         * @return OIDplusAuthContentStore|null
         * @throws OIDplusException
         */
        public static function getActiveProvider()/*: ?OIDplusAuthContentStore*/ {
                if (!self::$contentProvider) {
 
                        $tmp = null;
                        $silent_error = false;
 
                        try {
 
                                $rel_url = substr($_SERVER['REQUEST_URI'], strlen(OIDplus::webpath(null, OIDplus::PATH_RELATIVE_TO_ROOT)));
                                if (str_starts_with($rel_url, 'rest/')) { // <== TODO: Find a way how to move this into the plugin, since REST does not belong to the core.
 
                                        // REST may only use Bearer Authentication
                                        $bearer = getBearerToken();
                                        if (!is_null($bearer)) {
                                                $silent_error = false;
                                                $tmp = new OIDplusAuthContentStoreJWT();
                                                $tmp->loadJWT($bearer);
                                                self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_REST | self::JWT_GENERATOR_MANUAL);
                                        }
 
                                } else {
 
                                        // A web-visitor (HTML and AJAX, but not REST) can use a JWT "remember me" Cookie
                                        if (isset($_COOKIE[self::COOKIE_NAME])) {
                                                $silent_error = true;
                                                $tmp = new OIDplusAuthContentStoreJWT();
                                                $tmp->loadJWT($_COOKIE[self::COOKIE_NAME]);
                                                self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_LOGIN | self::JWT_GENERATOR_MANUAL);
                                        }
 
                                        // AJAX may additionally use GET/POST automated AJAX (in addition to the normal JWT "remember me" Cookie)
                                        if (isset($_SERVER['SCRIPT_FILENAME']) && (strtolower(basename($_SERVER['SCRIPT_FILENAME'])) !== 'ajax.php')) {
                                                if (isset($_POST[self::COOKIE_NAME])) {
                                                        $silent_error = false;
                                                        $tmp = new OIDplusAuthContentStoreJWT();
                                                        $tmp->loadJWT($_POST[self::COOKIE_NAME]);
                                                        self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_AJAX | self::JWT_GENERATOR_MANUAL);
                                                }
                                                if (isset($_GET[self::COOKIE_NAME])) {
                                                        $silent_error = false;
                                                        $tmp = new OIDplusAuthContentStoreJWT();
                                                        $tmp->loadJWT($_GET[self::COOKIE_NAME]);
                                                        self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_AJAX | self::JWT_GENERATOR_MANUAL);
                                                }
                                        }
 
                                }
 
                        } catch (\Exception $e) {
                                if (!$silent_error) {
                                        // Most likely an AJAX request. We can throw an Exception
                                        throw new OIDplusException(_L('The JWT token was rejected: %1',$e->getMessage()));
                                } else {
                                        // Most likely an expired Cookie/Login session. We must not throw an Exception, otherwise we will break jsTree
                                        OIDplus::cookieUtils()->unsetcookie(self::COOKIE_NAME);
                                        return null;
                                }
                        }
 
                        self::$contentProvider = $tmp;
                }
 
                return self::$contentProvider;
        }
 
        /**
         * @param string $email
         * @param string $loginfo
         * @return void
         * @throws OIDplusException
         */
        public function raLoginEx(string $email, string &$loginfo) {
                if (is_null(self::getActiveProvider())) {
                        $this->raLogin($email);
                        $loginfo = 'into new JWT session';
                        self::$contentProvider = $this;
                } else {
                        $gen = $this->getValue('oidplus_generator',-1);
                        switch ($gen) {
                                case OIDplusAuthContentStoreJWT::JWT_GENERATOR_AJAX :
                                case OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST :
                                case OIDplusAuthContentStoreJWT::JWT_GENERATOR_MANUAL :
                                        throw new OIDplusException(_L('This kind of JWT token cannot be altered. Therefore you cannot do this action.'));
                                case OIDplusAuthContentStoreJWT::JWT_GENERATOR_LOGIN :
                                        if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_USER', true)) {
                                                throw new OIDplusException(_L('You cannot add this login credential to your existing "remember me" session. You need to log-out first.'));
                                        }
                                        break;
                                default:
                                        assert(false); // This cannot happen because jwtSecurityCheck will check for unknown generators
                                        break;
                        }
                        $this->raLogin($email);
                        $loginfo = 'into existing JWT session';
                }
        }
 
        /**
         * @param string $loginfo
         * @return void
         * @throws OIDplusException
         */
        public function adminLoginEx(string &$loginfo) {
                if (is_null(self::getActiveProvider())) {
                        $this->adminLogin();
                        $loginfo = 'into new JWT session';
                        self::$contentProvider = $this;
                } else {
                        $gen = $this->getValue('oidplus_generator',-1);
                        switch ($gen) {
                                case OIDplusAuthContentStoreJWT::JWT_GENERATOR_AJAX :
                                case OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST :
                                case OIDplusAuthContentStoreJWT::JWT_GENERATOR_MANUAL :
                                        throw new OIDplusException(_L('This kind of JWT token cannot be altered. Therefore you cannot do this action.'));
                                case OIDplusAuthContentStoreJWT::JWT_GENERATOR_LOGIN :
                                        if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_ADMIN', true)) {
                                                throw new OIDplusException(_L('You cannot add this login credential to your existing "remember me" session. You need to log-out first.'));
                                        }
                                        break;
                                default:
                                        assert(false); // This cannot happen because jwtSecurityCheck will check for unknown generators
                                        break;
                        }
                        $this->adminLogin();
                        $loginfo = 'into existing JWT session';
                }
        }
 
        // Individual functions
 
        /**
         * Decode the JWT. In this step, the signature as well as EXP/NBF times will be checked
         * @param string $jwt
         * @return void
         * @throws OIDplusException
         */
        public function loadJWT(string $jwt) {
                \Firebase\JWT\JWT::$leeway = 60; // leeway in seconds
                if (OIDplus::getPkiStatus()) {
                        $pubKey = OIDplus::getSystemPublicKey();
                        $k = new \Firebase\JWT\Key($pubKey, 'RS256'); // RSA+SHA256 is hardcoded in getPkiStatus() generation
                        $this->content = (array) \Firebase\JWT\JWT::decode($jwt, $k);
                } else {
                        $key = OIDplus::authUtils()->makeSecret(['0be35e52-f4ef-11ed-b67e-3c4a92df8582']);
                        $key = hash_pbkdf2('sha512', $key, '', 10000, 32/*256bit*/, false);
                        $k = new \Firebase\JWT\Key($key, 'HS512'); // HMAC+SHA512 is hardcoded here
                        $this->content = (array) \Firebase\JWT\JWT::decode($jwt, $k);
                }
        }
 
        /**
         * @return string
         * @throws OIDplusException
         */
        public function getJWTToken(): string {
                $payload = $this->content;
                $payload["oidplus_ssh"] = self::getSsh(); // SSH = Server Secret Hash
                $payload["iss"] = OIDplus::getEditionInfo()['jwtaud'];
                $payload["aud"] = OIDplus::getEditionInfo()['jwtaud'];
                $payload["jti"] = gen_uuid();
                $payload["iat"] = time();
 
                if (OIDplus::getPkiStatus()) {
                        $privKey = OIDplus::getSystemPrivateKey();
                        return \Firebase\JWT\JWT::encode($payload, $privKey, 'RS256'); // RSA+SHA256 is hardcoded in getPkiStatus() generation
                } else {
                        $key = OIDplus::authUtils()->makeSecret(['0be35e52-f4ef-11ed-b67e-3c4a92df8582']);
                        $key = hash_pbkdf2('sha512', $key, '', 10000, 32/*256bit*/, false);
                        return \Firebase\JWT\JWT::encode($payload, $key, 'HS512'); // HMAC+SHA512 is hardcoded here
                }
        }
 
}
 
Subversion Repositories oidplus

oidplus/trunk/includes/classes/OIDplusAuthContentStoreJWT.class.php – Rev 1300 → 1301
