* @copyright Copyright (c) WHMCS Limited 2005-2013
* @license http://www.whmcs.com/license/ WHMCS Eula
* @version $Id$
* @link http://www.whmcs.com/
*/
class WHMCS_TokenManager
{
protected $namespaceSettings = array( );
protected $defaultNamespaceValue = true;
/**
*
* @param WHMCS_Init $whmcs
*
* @return WHMCS_TokenManager
*/
public static function init($whmcs)
{
$obj = new self();
$namespace_settings = $obj->getStoredNamespaceSettings($whmcs);
if( count($namespace_settings) < 1 )
{
$namespace_settings = $obj->getDefaultNamespaceSettings();
$obj->setStoredNamespaceSettings($whmcs, $namespace_settings);
}
$obj->setNamespaceSettings($namespace_settings);
return $obj;
}
/**
* Use WHMCS_TokenManager::init()
*
* @return WHMCS_TokenManager
*/
public function __construct()
{
return $this;
}
public function getToken()
{
return array_key_exists('tkval', $_SESSION) ? $_SESSION['tkval'] : null;
}
public function setToken($token)
{
if( !is_string($token) || empty($token) )
{
throw new UnexpectedValueException("Token must be a valid value");
}
$_SESSION['tkval'] = $token;
return $token;
}
public function conditionallySetToken()
{
if( is_null($this->getToken()) )
{
$this->setToken(genRandomVal());
}
return $this;
}
public function generateToken($type = 'form')
{
$tkval = ($t = $this->getToken()) ? $t : genRandomVal();
$token = sha1($tkval . session_id() . ":whmcscrsf");
if( $type == 'plain' )
{
return $token;
}
if( $type == 'link' )
{
return "&token=" . $token;
}
if( $type == 'form' )
{
return "";
}
}
/**
* Validate a token and alter application flow if invalid
*
* @param string $namespace
*
* @return boolean
*/
public function checkToken($namespace = "WHMCS.default")
{
$strict_check = true;
$namespace_settings = $this->getNamespaceSettings();
if( !$namespace_settings["WHMCS.default"] )
{
return true;
}
if( array_key_exists($namespace, $namespace_settings) )
{
$strict_check = $namespace_settings[$namespace] ? true : false;
}
if( !$strict_check )
{
return true;
}
if( !$this->isValidToken($_REQUEST['token']) )
{
$this->handleInvalidToken();
return false;
}
return true;
}
public function handleInvalidToken()
{
if( defined('CLIENTAREA') )
{
WHMCS_Session::destroy();
redir('', "clientarea.php");
}
exit( "Invalid Token" );
}
/**
* Validate a provided token
*
* @param string $token
*
* @return boolean
*/
public function isValidToken($token = '')
{
$expected = $this->generateToken('plain');
return $expected == $token ? true : false;
}
/**
*
* @return array
*/
public function getDefaultNamespaceSettings()
{
return array( "WHMCS.default" => $this->defaultNamespaceValue, "WHMCS.admin.default" => $this->defaultNamespaceValue, "WHMCS.domainchecker" => false );
}
/**
* Retrieve stored token namespace settings for application
*
* @param WHMCS_Init $whmcs
*
* @return array
*/
public function getStoredNamespaceSettings($whmcs)
{
$serialized_namespace = $whmcs->get_config('token_namespaces');
$namespace_settings = $serialized_namespace ? unserialize($serialized_namespace) : array( );
if( !is_array($namespace_settings) )
{
$namespace_settings = array( );
}
return $namespace_settings;
}
/**
* Store token namespace settings for application
* @param array
*
* @return WHMCS_TokenManager
*/
public function setStoredNamespaceSettings($whmcs, $namespace_settings)
{
$serialized_namespace = serialize($namespace_settings);
return $whmcs->set_config('token_namespaces', $serialized_namespace, $whmcs->getDatabaseObj()->retrieveDatabaseConnection());
}
/**
* Retrieve namespace settings of object
*
* @return array
*/
public function getNamespaceSettings()
{
return $this->namespaceSettings;
}
/**
* Set namespace settings of object
*
* @param array $namespace_settings
*
* @throws InvalidArgumentException
* @return WHMCS_TokenManager
*/
public function setNamespaceSettings($namespace_settings)
{
if( !is_array($namespace_settings) )
{
throw new InvalidArgumentException("Namespace settings must be an array");
}
$this->namespaceSettings = $namespace_settings;
return $this;
}
public function getNamespaceValue($namespace)
{
$settings = $this->getNamespaceSettings();
if( array_key_exists($namespace, $settings) )
{
return $settings[$namespace] ? true : false;
}
return $this->defaultNamespaceValue;
}
public function generateAdminConfigurationHTMLRows($aInt)
{
$rows = '';
$ns = $this->getNamespaceSettings();
$whmcs_defaults = $this->getDefaultNamespaceSettings();
$stored_default = $ns["WHMCS.default"];
$system_default_value = $whmcs_defaults["WHMCS.default"];
unset($ns["WHMCS.default"]);
$rows = $this->htmlRow($aInt, "WHMCS.default", $stored_default, $system_default_value);
foreach( $ns as $key => $value )
{
if( strpos($key, "WHMCS.admin.") === 0 )
{
continue;
}
$system_default_value = array_key_exists($key, $whmcs_defaults) ? $whmcs_defaults[$key] : null;
$rows .= $this->htmlRow($aInt, $key, $value, $system_default_value, $stored_default);
}
return $rows;
}
protected function htmlRow($aInt, $key, $value, $whmcs_default = null, $show = true)
{
$field = 'csrftoken';
$basekey = $field . "." . $key;
$htmlkey = str_replace(".", '_ns_', $basekey);
$text = $aInt->lang('general', $basekey);
$textinfo = $aInt->lang('general', $basekey . 'info');
if( !$text )
{
$text = $key;
}
if( !$textinfo )
{
$textinfo = $key;
}
$ondefault = '';
$offdefault = '';
$onvalue = '';
$offvalue = '';
if( $value )
{
$onvalue = " checked";
}
else
{
$offvalue = " checked";
}
if( !is_null($whmcs_default) )
{
if( $whmcs_default )
{
$ondefault = " (" . $aInt->lang('global', 'default') . ")";
}
else
{
$offdefault = " (" . $aInt->lang('global', 'default') . ")";
}
}
$jsshow = '';
$jshide = '';
$row_attr = '';
if( $key == "WHMCS.default" )
{
$jsshow = " onclick=\"\$('." . $field . "').show();\"";
$jshide = " onclick=\"\$('." . $field . "').hide();\"";
}
else
{
$row_attr = " class=\"" . $field . "\"";
}
if( !$show )
{
$row_attr .= "style=\"display:none\"";
}
$row = "" . "| " . $text . " | " . "" . "" . $textinfo . "
" . "
" . " | " . "\n";
return $row;
}
public function processAdminHTMLSave($whmcs)
{
$ns = $this->getNamespaceSettings();
foreach( $ns as $key => $value )
{
if( strpos($key, "WHMCS.admin.") === 0 )
{
continue;
}
$ns[$key] = $this->processOneNamespaceRequest($whmcs, $key);
}
$this->setNamespaceSettings($ns);
$this->setStoredNamespaceSettings($whmcs, $ns);
return $this;
}
protected function processOneNamespaceRequest($whmcs, $key)
{
$postvar_name = str_replace(".", '_ns_', "csrftoken." . $key);
$postvar_value = $whmcs->get_req_var($postvar_name);
return $postvar_value == 'on' ? true : false;
}
}