Subversion Repositories oidplus

Rev

Rev 1301 | Rev 1304 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

  1. <?php
  2.  
  3. /*
  4.  * OIDplus 2.0
  5.  * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
  6.  *
  7.  * Licensed under the Apache License, Version 2.0 (the "License");
  8.  * you may not use this file except in compliance with the License.
  9.  * You may obtain a copy of the License at
  10.  *
  11.  *     http://www.apache.org/licenses/LICENSE-2.0
  12.  *
  13.  * Unless required by applicable law or agreed to in writing, software
  14.  * distributed under the License is distributed on an "AS IS" BASIS,
  15.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16.  * See the License for the specific language governing permissions and
  17.  * limitations under the License.
  18.  */
  19.  
  20. namespace ViaThinkSoft\OIDplus;
  21.  
  22. // phpcs:disable PSR1.Files.SideEffects
  23. \defined('INSIDE_OIDPLUS') or die;
  24. // phpcs:enable PSR1.Files.SideEffects
  25.  
  26. class OIDplusAuthUtils extends OIDplusBaseClass {
  27.  
  28.         // Useful functions
  29.  
  30.         /**
  31.          * @param string $password
  32.          * @return string
  33.          * @throws OIDplusException
  34.          */
  35.         private function raPepperProcessing(string $password): string {
  36.                 // Additional feature: Pepper
  37.                 // The pepper is stored inside the base configuration file
  38.                 // It prevents that an attacker with SQL write rights can
  39.                 // create accounts.
  40.                 // ATTENTION!!! If a pepper is used, then the
  41.                 // hashes are bound to that pepper. If you change the pepper,
  42.                 // then ALL passwords of RAs become INVALID!
  43.                 $pepper = OIDplus::baseConfig()->getValue('RA_PASSWORD_PEPPER','');
  44.                 if ($pepper !== '') {
  45.                         $algo = OIDplus::baseConfig()->getValue('RA_PASSWORD_PEPPER_ALGO','sha512'); // sha512 works with PHP 7.0
  46.                         if (strtolower($algo) === 'sha3-512') {
  47.                                 $hmac = sha3_512_hmac($password, $pepper);
  48.                         } else {
  49.                                 $hmac = hash_hmac($algo, $password, $pepper);
  50.                         }
  51.                         if ($hmac === "") throw new OIDplusException(_L('HMAC failed'));
  52.                         return $hmac;
  53.                 } else {
  54.                         return $password;
  55.                 }
  56.         }
  57.  
  58.         // Content provider
  59.  
  60.         /**
  61.          * @return string
  62.          * @throws OIDplusException
  63.          */
  64.         public function getAuthMethod(): string {
  65.                 $acs = $this->getAuthContentStore();
  66.                 if (is_null($acs)) return 'null';
  67.                 return get_class($acs);
  68.         }
  69.  
  70.         /**
  71.          * @return OIDplusAuthContentStore|null
  72.          * @throws OIDplusException
  73.          */
  74.         protected function getAuthContentStore()/*: ?OIDplusAuthContentStore*/ {
  75.                 // TODO: Should we implement these AuthContentStore as plugin type, so that there can be more than just JWT and PHP session?
  76.  
  77.                 // Logged in via JWT
  78.                 // (The JWT can come from a REST Authentication Bearer, an AJAX Cookie, or an Automated AJAX Call GET/POST token.)
  79.                 $tmp = OIDplusAuthContentStoreJWT::getActiveProvider();
  80.                 if ($tmp) return $tmp;
  81.  
  82.                 // Normal login via web-browser
  83.                 // Cookie will only be created once content is stored
  84.                 $tmp = OIDplusAuthContentStoreSession::getActiveProvider();
  85.                 if ($tmp) return $tmp;
  86.  
  87.                 // No active session and no JWT token available. User is not logged in.
  88.                 return null;
  89.         }
  90.  
  91.         /**
  92.          * @param string $name
  93.          * @param mixed|null $default
  94.          * @return mixed
  95.          * @throws OIDplusException
  96.          */
  97.         public function getExtendedAttribute(string $name, $default=NULL) {
  98.                 $acs = $this->getAuthContentStore();
  99.                 if (is_null($acs)) return $default;
  100.                 return $acs->getValue($name, $default);
  101.         }
  102.  
  103.         // RA authentication functions
  104.  
  105.         /**
  106.          * @param string $email
  107.          * @return void
  108.          * @throws OIDplusException
  109.          */
  110.         public function raLogin(string $email) {
  111.                 $acs = $this->getAuthContentStore();
  112.                 if (is_null($acs)) return;
  113.                 $acs->raLogin($email);
  114.         }
  115.  
  116.         /**
  117.          * @param string $email
  118.          * @return void
  119.          * @throws OIDplusException
  120.          */
  121.         public function raLogout(string $email) {
  122.                 $acs = $this->getAuthContentStore();
  123.                 if (is_null($acs)) return;
  124.                 $acs->raLogout($email);
  125.         }
  126.  
  127.         /**
  128.          * @param string $ra_email
  129.          * @param string $password
  130.          * @return bool
  131.          * @throws OIDplusException
  132.          */
  133.         public function raCheckPassword(string $ra_email, string $password): bool {
  134.                 $ra = new OIDplusRA($ra_email);
  135.  
  136.                 // Get RA info from RA
  137.                 $authInfo = $ra->getAuthInfo();
  138.                 if (!$authInfo) return false; // user not found
  139.  
  140.                 // Ask plugins if they can verify this hash
  141.                 $plugins = OIDplus::getAuthPlugins();
  142.                 if (count($plugins) == 0) {
  143.                         throw new OIDplusException(_L('No RA authentication plugins found'));
  144.                 }
  145.                 foreach ($plugins as $plugin) {
  146.                         if ($plugin->verify($authInfo, $this->raPepperProcessing($password))) return true;
  147.                 }
  148.  
  149.                 return false;
  150.         }
  151.  
  152.         /**
  153.          * @return int
  154.          * @throws OIDplusException
  155.          */
  156.         public function raNumLoggedIn(): int {
  157.                 $acs = $this->getAuthContentStore();
  158.                 if (is_null($acs)) return 0;
  159.                 return $acs->raNumLoggedIn();
  160.         }
  161.  
  162.         /**
  163.          * @return OIDplusRA[]
  164.          * @throws OIDplusException
  165.          */
  166.         public function loggedInRaList(): array {
  167.                 if ($this->forceAllLoggedOut()) {
  168.                         return array();
  169.                 } else {
  170.                         $acs = $this->getAuthContentStore();
  171.                         if (is_null($acs)) return array();
  172.                         return $acs->loggedInRaList();
  173.                 }
  174.         }
  175.  
  176.         /**
  177.          * @param string|OIDplusRA $ra
  178.          * @return bool
  179.          * @throws OIDplusException
  180.          */
  181.         public function isRaLoggedIn($ra): bool {
  182.                 $email = $ra instanceof OIDplusRA ? $ra->raEmail() : $ra;
  183.                 $acs = $this->getAuthContentStore();
  184.                 if (is_null($acs)) return false;
  185.                 return $acs->isRaLoggedIn($email);
  186.         }
  187.  
  188.         // "High level" function including logging and checking for valid JWT alternations
  189.  
  190.         /**
  191.          * @param string $email
  192.          * @param bool $remember_me
  193.          * @param string $origin
  194.          * @return void
  195.          * @throws OIDplusException
  196.          */
  197.         public function raLoginEx(string $email, bool $remember_me, string $origin='') {
  198.                 $loginfo = '';
  199.                 $acs = $this->getAuthContentStore();
  200.                 if (!is_null($acs)) {
  201.                         // User is already logged in (a session or JWT exists), so we modify their login status
  202.                         $acs->raLoginEx($email, $loginfo);
  203.                         $acs->activate();
  204.                 } else {
  205.                         // No user is logged in (no session or JWT exists). We now create a auth content store and activate it (cookies will be set etc.)
  206.                         if ($remember_me) {
  207.                                 if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_USER', true)) {
  208.                                         throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_LOGIN_USER'));
  209.                                 }
  210.                                 $ttl = OIDplus::baseConfig()->getValue('JWT_TTL_LOGIN_USER', 10*365*24*60*60);
  211.                                 $newAuthStore = new OIDplusAuthContentStoreJWT();
  212.                                 $newAuthStore->setValue('oidplus_generator', OIDplusAuthContentStoreJWT::JWT_GENERATOR_LOGIN);
  213.                                 $newAuthStore->setValue('exp', time()+$ttl); // JWT "exp" attribute
  214.                         } else {
  215.                                 $newAuthStore = new OIDplusAuthContentStoreSession();
  216.                         }
  217.                         $newAuthStore->raLoginEx($email, $loginfo);
  218.                         $newAuthStore->activate();
  219.                 }
  220.                 $logmsg = "RA '$email' logged in";
  221.                 if ($origin != '') $logmsg .= " via $origin";
  222.                 if ($loginfo != '') $logmsg .= " ($loginfo)";
  223.                 OIDplus::logger()->log("V2:[OK]RA(%1)", "%2", $email, $logmsg);
  224.         }
  225.  
  226.         /**
  227.          * @param string $email
  228.          * @return void
  229.          * @throws OIDplusException
  230.          */
  231.         public function raLogoutEx(string $email) {
  232.                 $loginfo = '';
  233.  
  234.                 $acs = $this->getAuthContentStore();
  235.                 if (is_null($acs)) return;
  236.                 $acs->raLogoutEx($email, $loginfo);
  237.  
  238.                 OIDplus::logger()->log("V2:[OK]RA(%1)", "RA '%1' logged out (%2)", $email, $loginfo);
  239.  
  240.                 if (($this->raNumLoggedIn() == 0) && (!$this->isAdminLoggedIn())) {
  241.                         // Nobody logged in anymore. Destroy session cookie to make GDPR people happy
  242.                         $acs->destroySession();
  243.                 } else {
  244.                         // Get a new token for the remaining users
  245.                         $acs->activate();
  246.                 }
  247.         }
  248.  
  249.         // Admin authentication functions
  250.  
  251.         /**
  252.          * @return void
  253.          * @throws OIDplusException
  254.          */
  255.         public function adminLogin() {
  256.                 $acs = $this->getAuthContentStore();
  257.                 if (is_null($acs)) return;
  258.                 $acs->adminLogin();
  259.         }
  260.  
  261.         /**
  262.          * @return void
  263.          * @throws OIDplusException
  264.          */
  265.         public function adminLogout() {
  266.                 $acs = $this->getAuthContentStore();
  267.                 if (is_null($acs)) return;
  268.                 $acs->adminLogout();
  269.         }
  270.  
  271.         /**
  272.          * @param string $password
  273.          * @return bool
  274.          * @throws OIDplusException
  275.          */
  276.         public function adminCheckPassword(string $password): bool {
  277.                 $cfgData = OIDplus::baseConfig()->getValue('ADMIN_PASSWORD', '');
  278.                 if (empty($cfgData)) {
  279.                         throw new OIDplusException(_L('No admin password set in %1','userdata/baseconfig/config.inc.php'));
  280.                 }
  281.  
  282.                 if (!is_array($cfgData)) {
  283.                         $passwordDataArray = array($cfgData);
  284.                 } else {
  285.                         $passwordDataArray = $cfgData; // Multiple Administrator passwords
  286.                 }
  287.  
  288.                 foreach ($passwordDataArray as $passwordData) {
  289.                         if (str_starts_with($passwordData, '$')) {
  290.                                 // Version 3: BCrypt (or any other crypt)
  291.                                 $ok = password_verify($password, $passwordData);
  292.                         } else if (strpos($passwordData, '$') !== false) {
  293.                                 // Version 2: SHA3-512 with salt
  294.                                 list($salt, $hash) = explode('$', $passwordData, 2);
  295.                                 $ok = hash_equals(sha3_512($salt.$password, true), base64_decode($hash));
  296.                         } else {
  297.                                 // Version 1: SHA3-512 without salt
  298.                                 $ok = hash_equals(sha3_512($password, true), base64_decode($passwordData));
  299.                         }
  300.                         if ($ok) return true;
  301.                 }
  302.  
  303.                 return false;
  304.         }
  305.  
  306.         /**
  307.          * @return bool
  308.          * @throws OIDplusException
  309.          */
  310.         public function isAdminLoggedIn(): bool {
  311.                 if ($this->forceAllLoggedOut()) {
  312.                         return false;
  313.                 } else {
  314.                         $acs = $this->getAuthContentStore();
  315.                         if (is_null($acs)) return false;
  316.                         return $acs->isAdminLoggedIn();
  317.                 }
  318.         }
  319.  
  320.         /**
  321.          * "High level" function including logging and checking for valid JWT alternations
  322.          * @param bool $remember_me
  323.          * @param string $origin
  324.          * @return void
  325.          * @throws OIDplusException
  326.          */
  327.         public function adminLoginEx(bool $remember_me, string $origin='') {
  328.                 $loginfo = '';
  329.                 $acs = $this->getAuthContentStore();
  330.                 if (!is_null($acs)) {
  331.                         // User is already logged in (a session or JWT exists), so we modify their login status
  332.                         $acs->adminLoginEx($loginfo);
  333.                         $acs->activate();
  334.                 } else {
  335.                         // No user is logged in (no session or JWT exists). We now create a auth content store and activate it (cookies will be set etc.)
  336.                         if ($remember_me) {
  337.                                 if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_ADMIN', true)) {
  338.                                         throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_LOGIN_ADMIN'));
  339.                                 }
  340.                                 $ttl = OIDplus::baseConfig()->getValue('JWT_TTL_LOGIN_ADMIN', 10*365*24*60*60);
  341.                                 $newAuthStore = new OIDplusAuthContentStoreJWT();
  342.                                 $newAuthStore->setValue('oidplus_generator', OIDplusAuthContentStoreJWT::JWT_GENERATOR_LOGIN);
  343.                                 $newAuthStore->setValue('exp', time()+$ttl); // JWT "exp" attribute
  344.                         } else {
  345.                                 $newAuthStore = new OIDplusAuthContentStoreSession();
  346.                         }
  347.                         $newAuthStore->adminLoginEx($loginfo);
  348.                         $newAuthStore->activate();
  349.                 }
  350.                 $logmsg = "Admin logged in";
  351.                 if ($origin != '') $logmsg .= " via $origin";
  352.                 if ($loginfo != '') $logmsg .= " ($loginfo)";
  353.                 OIDplus::logger()->log("V2:[OK]A", "%1", $logmsg);
  354.         }
  355.  
  356.         /**
  357.          * @return void
  358.          * @throws OIDplusException
  359.          */
  360.         public function adminLogoutEx() {
  361.                 $loginfo = '';
  362.  
  363.                 $acs = $this->getAuthContentStore();
  364.                 if (is_null($acs)) return;
  365.                 $acs->adminLogoutEx($loginfo);
  366.  
  367.                 if ($this->raNumLoggedIn() == 0) {
  368.                         // Nobody here anymore. Destroy the cookie to make GDPR people happy
  369.                         $acs->destroySession();
  370.                 } else {
  371.                         // Get a new token for the remaining users
  372.                         $acs->activate();
  373.                 }
  374.  
  375.                 OIDplus::logger()->log("V2:[OK]A", "Admin logged out (%1)", $loginfo);
  376.         }
  377.  
  378.         // Authentication keys for generating secrets or validating arguments (e.g. sent by mail)
  379.  
  380.         /**
  381.          * @param array|string $data
  382.          * @return string
  383.          * @throws OIDplusException
  384.          */
  385.         public function makeSecret($data): string {
  386.                 if (!is_array($data)) $data = [$data];
  387.                 $data = json_encode($data);
  388.                 return sha3_512_hmac($data, 'OIDplus:'.OIDplus::baseConfig()->getValue('SERVER_SECRET'), false);
  389.         }
  390.  
  391.         /**
  392.          * @param array|string $data Arbitary data to be validated later
  393.          * @return string A string that need to be validated with validateAuthKey
  394.          * @throws OIDplusException
  395.          */
  396.         public function makeAuthKey($data): string {
  397.                 if (!is_array($data)) $data = [$data];
  398.                 $ts = time();
  399.                 $data_ext = [$ts, $data];
  400.                 $secret = $this->makeSecret($data_ext);
  401.                 return $ts.'.'.$secret;
  402.         }
  403.  
  404.         /**
  405.          * @param array|string $data The original data that had been passed to makeAuthKey()
  406.          * @param string $auth_key The result from makeAuthKey()
  407.          * @param int $valid_secs How many seconds is the auth key valid? (-1 for infinite)
  408.          * @return bool True if the key is valid and not expired.
  409.          * @throws OIDplusException
  410.          */
  411.         public function validateAuthKey($data, string $auth_key, int $valid_secs=-1): bool {
  412.                 $auth_key_ary = explode('.', $auth_key, 2);
  413.                 if (count($auth_key_ary) != 2) return false; // invalid auth key syntax
  414.                 list($ts, $secret) = $auth_key_ary;
  415.                 if (!is_numeric($ts)) return false; // invalid auth key syntax
  416.                 if ($valid_secs >= 0) {
  417.                         if (time() > ($ts+$valid_secs)) return false; // expired auth key
  418.                 }
  419.                 if (!is_array($data)) $data = [$data];
  420.                 $data_ext = [(int)$ts, $data];
  421.                 return hash_equals($this->makeSecret($data_ext), $secret);
  422.         }
  423.  
  424.         // "Veto" functions to force logout state
  425.  
  426.         /**
  427.          * @return bool
  428.          */
  429.         protected function forceAllLoggedOut(): bool {
  430.                 if (isset($_SERVER['SCRIPT_FILENAME']) && (basename($_SERVER['SCRIPT_FILENAME']) == 'sitemap.php')) {
  431.                         // The sitemap may not contain any confidential information,
  432.                         // even if the user is logged in, because the admin could
  433.                         // accidentally copy-paste the sitemap to a
  434.                         // search engine control panel while they are logged in
  435.                         return true;
  436.                 } else {
  437.                         return false;
  438.                 }
  439.         }
  440.  
  441.         // CSRF functions
  442.  
  443.         private $enable_csrf = true;
  444.  
  445.         /**
  446.          * @return void
  447.          */
  448.         public function enableCSRF() {
  449.                 $this->enable_csrf = true;
  450.         }
  451.  
  452.         /**
  453.          * @return void
  454.          */
  455.         public function disableCSRF() {
  456.                 $this->enable_csrf = false;
  457.         }
  458.  
  459.         /**
  460.          * @return string
  461.          * @throws \Random\RandomException
  462.          */
  463.         public function genCSRFToken(): string {
  464.                 return random_bytes_ex(64, false, false);
  465.         }
  466.  
  467.         /**
  468.          * @return void
  469.          * @throws OIDplusException
  470.          */
  471.         public function checkCSRF() {
  472.                 if (!$this->enable_csrf) return;
  473.  
  474.                 $request_token = $_REQUEST['csrf_token'] ?? '';
  475.                 $cookie_token = $_COOKIE['csrf_token'] ?? '';
  476.  
  477.                 if (empty($request_token) || empty($cookie_token) || ($request_token !== $cookie_token)) {
  478.                         if (OIDplus::baseConfig()->getValue('DEBUG')) {
  479.                                 throw new OIDplusException(_L('Missing or wrong CSRF Token: Request %1 vs Cookie %2',
  480.                                         isset($_REQUEST['csrf_token']) ? '"'.$_REQUEST['csrf_token'].'"' : 'NULL',
  481.                                         $_COOKIE['csrf_token'] ?? 'NULL'
  482.                                 ));
  483.                         } else {
  484.                                 throw new OIDplusException(_L('Missing or wrong "CSRF Token". To fix the issue, try clearing your browser cache and reload the page. If you visited the page via HTTPS before, try HTTPS in case you are currently connected via HTTP.'));
  485.                         }
  486.                 }
  487.         }
  488.  
  489.         // Generate RA passwords
  490.  
  491.         /**
  492.          * @param string $password
  493.          * @return OIDplusRAAuthInfo
  494.          * @throws OIDplusException
  495.          */
  496.         public function raGeneratePassword(string $password): OIDplusRAAuthInfo {
  497.                 $plugin = OIDplus::getDefaultRaAuthPlugin(true);
  498.                 return $plugin->generate($this->raPepperProcessing($password));
  499.         }
  500.  
  501.         // Generate admin password
  502.  
  503.         /* Nothing here; the admin password will be generated in setup_base.js , purely in the web-browser */
  504.  
  505. }
  506.