Authenticator.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred\User;

abstract class Authenticator extends \Rsi\Fred\Component{

  public $maxSessionTime = null; //!< Maximum duration of a session (minutes; empty = infinite).
  public $maxInactiveTime = null; //!< Maximum period of inactivity (minutes; empty = infinite).

  public $controllerName = null; //!< Controller to redirect the user to if more information is required (e.g. a username and
    // password).

  /**
   * Perform the check.
   * @return bool  True if the user is authenticated. False if something is wrong. Null if the user has to provide some more
   *   information (set the $controllerName for this purpose).
   */
  abstract protected function check();
  /**
   * Process the result of a verification.
   * @param bool $result
   */
  public function verified($result){
    $this->component('log')->debug(get_called_class() . '::verified(' . \Rsi\Str::bool($result) . ')',__FILE__,__LINE__);
    $this->component('security')->bruteForceDelay($this->checked = $result ?: null,get_called_class());
    if($result) $this->regenerateSessionId();
  }

  public function regenerateSessionId(){
    try{
      $alive = $this->component('alive');
      $alive->journalFilename; //fixate on current session ID
      session_regenerate_id(true);
      $alive->journal('Session ID changed to ' . session_id());
    }
    catch(\Exception $e){
      $this->component('log')->notice('Could not regenerate session id: ' . $e->getMessage(),__FILE__,__LINE__);
    }
  }

  public function invalidate(){
    $this->checked = null;
  }

  protected function getAuthenticated(){
    if($this->checked === null) $this->checked = $this->check();
    return $this->checked;
  }

  protected function getChecked(){
    if($this->session->checked){
      if(
        ($this->maxSessionTime && (time() - $this->session->start > $this->maxSessionTime * 60)) ||
        ($this->maxInactiveTime && (time() - $this->session->alive > $this->maxInactiveTime * 60))
      ) $this->invalidate();
    }
    $this->session->alive = time();
    return $this->session->checked;
  }

  protected function setChecked($value){
    $this->session->start = $this->session->alive = time();
    $this->session->checked = $value;
  }

}