Portions created by the Initial Developer are Copyright (C) 2008-2024 the Initial Developer. All Rights Reserved. Contributor(s): Mark J Crane */ /** * authentication * * @method validate uses authentication plugins to check if a user is authorized to login * @method get_domain used to get the domain name from the URL or username and then sets both domain_name and domain_uuid */ class authentication { /** * Define variables and their scope */ private $database; public $domain_uuid; public $user_uuid; public $domain_name; public $username; public $password; /** * Called when the object is created */ public function __construct() { $this->database = database::new(); } /** * validate uses authentication plugins to check if a user is authorized to login * @return array [plugin] => last plugin used to authenticate the user [authorized] => true or false */ public function validate() { //get the domain_name and domain_uuid if (!isset($this->domain_name) || !isset($this->domain_uuid)) { $this->get_domain(); } //create a settings object to pass to plugins $settings = new settings(['database' => $this->database, 'domain_uuid' => $this->domain_uuid]); //start the session if its not started if (session_status() === PHP_SESSION_NONE) { session_start(); } //set the default authentication method to the database if (empty($_SESSION['authentication']['methods']) || !is_array($_SESSION['authentication']['methods'])) { $_SESSION['authentication']['methods'][] = 'database'; } //set the database as the default plugin if (!isset($_SESSION['authentication']['methods'])) { $_SESSION['authentication']['methods'][] = 'database'; } //check if contacts app exists $contacts_exists = file_exists($_SERVER["DOCUMENT_ROOT"].PROJECT_PATH.'/core/contacts/') ? true : false; //use the authentication plugins foreach ($_SESSION['authentication']['methods'] as $name) { //already processed the plugin move to the next plugin if (!empty($_SESSION['authentication']['plugin'][$name]['authorized']) && $_SESSION['authentication']['plugin'][$name]['authorized']) { continue; } //prepare variables $class_name = "plugin_".$name; $base = __DIR__ . "/plugins"; $plugin = $base."/".$name.".php"; //process the plugin if (file_exists($plugin)) { //run the plugin $object = new $class_name(); $object->domain_name = $this->domain_name; $object->domain_uuid = $this->domain_uuid; if ($name == 'database' && isset($this->key)) { $object->key = $this->key; } if ($name == 'database' && isset($this->username)) { $object->username = $this->username; $object->password = $this->password; } //database plugin requires the authentication object and settings if ($name == 'database') { $array = $object->$name($this, $settings); } else { //get the array from the plugin $array = $object->$name(); } //build a result array if (!empty($array) && is_array($array)) { $result['plugin'] = $array["plugin"]; $result['domain_name'] = $array["domain_name"]; $result['username'] = $array["username"]; $result['user_uuid'] = $array["user_uuid"]; $result['contact_uuid'] = $array["contact_uuid"]; if ($contacts_exists) { $result["contact_organization"] = $array["contact_organization"]; $result["contact_name_given"] = $array["contact_name_given"]; $result["contact_name_family"] = $array["contact_name_family"]; $result["contact_image"] = $array["contact_image"]; } $result['domain_uuid'] = $array["domain_uuid"]; $result['authorized'] = $array["authorized"]; //set the domain_uuid $this->domain_uuid = $array["domain_uuid"]; //set the user_uuid $this->user_uuid = $array["user_uuid"]; //save the result to the authentication plugin $_SESSION['authentication']['plugin'][$name] = $result; } //plugin authorized false if (!$result['authorized']) { break; } } } //make sure all plugins are in the array if (!empty($_SESSION['authentication']['methods'])) { foreach ($_SESSION['authentication']['methods'] as $name) { if (!isset($_SESSION['authentication']['plugin'][$name]['authorized'])) { $_SESSION['authentication']['plugin'][$name]['plugin'] = $name; $_SESSION['authentication']['plugin'][$name]['domain_name'] = $_SESSION['domain_name']; $_SESSION['authentication']['plugin'][$name]['domain_uuid'] = $_SESSION['domain_uuid']; $_SESSION['authentication']['plugin'][$name]['username'] = $_SESSION['username']; $_SESSION['authentication']['plugin'][$name]['user_uuid'] = $_SESSION['user_uuid']; $_SESSION['authentication']['plugin'][$name]['user_email'] = $_SESSION['user_email']; $_SESSION['authentication']['plugin'][$name]['authorized'] = 0; } } } //debug information //view_array($_SESSION['authentication'], false); //set authorized to false if any authentication method failed $authorized = false; if (is_array($_SESSION['authentication']['plugin'])) { foreach($_SESSION['authentication']['plugin'] as $row) { if ($row["authorized"]) { $authorized = true; } else { $authorized = false; break; } } } //result array // $result["plugin"] = "database"; // $result["domain_name"] = $_SESSION['domain_name']; // if (!isset($_SESSION['username'])) { // $result["username"] = $_SESSION['username']; // } // if (!isset($_SESSION['user_uuid'])) { // $result["user_uuid"] = $_SESSION['user_uuid']; // } // $result["domain_uuid"] = $_SESSION['domain_uuid']; // if (!isset($_SESSION['contact_uuid'])) { // $result["contact_uuid"] = $_SESSION['contact_uuid']; // } // $result["authorized"] = $authorized; //user is authorized - get user settings, check user cidr if ($authorized) { //get the user settings $sql = "select * from v_user_settings "; $sql .= "where domain_uuid = :domain_uuid "; $sql .= "and user_uuid = :user_uuid "; $sql .= "and user_setting_enabled = 'true' "; $parameters['domain_uuid'] = $result["domain_uuid"]; $parameters['user_uuid'] = $result["user_uuid"]; $user_settings = $this->database->select($sql, $parameters, 'all'); unset($sql, $parameters); //build the user cidr array if (is_array($user_settings) && @sizeof($user_settings) != 0) { foreach ($user_settings as $row) { if ($row['user_setting_category'] == "domain" && $row['user_setting_subcategory'] == "cidr" && $row['user_setting_name'] == "array") { $cidr_array[] = $row['user_setting_value']; } } } //check to see if user address is in the cidr array if (isset($cidr_array) && !defined('STDIN')) { $found = false; foreach($cidr_array as $cidr) { if (check_cidr($cidr, $_SERVER['REMOTE_ADDR'])) { $found = true; break; } } if (!$found) { //log the failed attempt $plugin_classname = substr($class_name, 7); user_logs::add($_SESSION['authentication']['plugin'][$plugin_classname]); //destroy session session_unset(); session_destroy(); //send http 403 header('HTTP/1.0 403 Forbidden', true, 403); //exit the code exit(); } } //set the session variables $_SESSION["domain_uuid"] = $result["domain_uuid"]; $_SESSION["domain_name"] = $result["domain_name"]; $_SESSION["user_uuid"] = $result["user_uuid"]; $_SESSION["context"] = $result['domain_name']; //build the session server array to validate the session global $conf; if (!isset($conf['session.validate'])) { $conf['session.validate'][] = 'HTTP_USER_AGENT'; } foreach($conf['session.validate'] as $name) { $server_array[$name] = $_SERVER[$name]; } //save the user hash to be used in validate the session $_SESSION["user_hash"] = hash('sha256', implode($server_array)); //user session array $_SESSION["user"]["domain_uuid"] = $result["domain_uuid"]; $_SESSION["user"]["domain_name"] = $result["domain_name"]; $_SESSION["user"]["user_uuid"] = $result["user_uuid"]; $_SESSION["user"]["username"] = $result["username"]; $_SESSION["user"]["contact_uuid"] = $result["contact_uuid"]; if ($contacts_exists) { $_SESSION["user"]["contact_organization"] = $result["contact_organization"] ?? null; $_SESSION["user"]["contact_name"] = trim(($result["contact_name_given"] ?? '').' '.($result["contact_name_family"] ?? '')); $_SESSION["user"]["contact_name_given"] = $result["contact_name_given"] ?? null; $_SESSION["user"]["contact_name_family"] = $result["contact_name_family"] ?? null; $_SESSION["user"]["contact_image"] = !empty($result["contact_image"]) && is_uuid($result["contact_image"]) ? $result["contact_image"] : null; } //empty the permissions if (isset($_SESSION['permissions'])) { unset($_SESSION['permissions']); } //get the groups assigned to the user $group = new groups($this->database, $result["domain_uuid"], $result["user_uuid"]); $group->session(); //get the permissions assigned to the user through the assigned groups $permission = new permissions($this->database, $result["domain_uuid"], $result["user_uuid"]); $permission->session(); //get the domains if (file_exists($_SERVER["PROJECT_ROOT"]."/app/domains/app_config.php") && !is_cli()){ require_once "app/domains/resources/domains.php"; } //get the user settings if (is_array($user_settings) && @sizeof($user_settings) != 0) { foreach ($user_settings as $row) { $name = $row['user_setting_name']; $category = $row['user_setting_category']; $subcategory = $row['user_setting_subcategory']; if (!empty($row['user_setting_value'])) { if (empty($subcategory)) { //$$category[$name] = $row['domain_setting_value']; if ($name == "array") { $_SESSION[$category][] = $row['user_setting_value']; } else { $_SESSION[$category][$name] = $row['user_setting_value']; } } else { //$$category[$subcategory][$name] = $row['domain_setting_value']; if ($name == "array") { $_SESSION[$category][$subcategory][] = $row['user_setting_value']; } else { $_SESSION[$category][$subcategory][$name] = $row['user_setting_value']; } } } } } unset($user_settings); //get the extensions that are assigned to this user if (file_exists($_SERVER["PROJECT_ROOT"]."/app/extensions/app_config.php")) { if (isset($_SESSION["user"]) && is_uuid($_SESSION["user_uuid"]) && is_uuid($_SESSION["domain_uuid"]) && !isset($_SESSION['user']['extension'])) { //get the user extension list $_SESSION['user']['extension'] = null; $sql = "select "; $sql .= "e.extension_uuid, "; $sql .= "e.extension, "; $sql .= "e.number_alias, "; $sql .= "e.user_context, "; $sql .= "e.outbound_caller_id_name, "; $sql .= "e.outbound_caller_id_number, "; $sql .= "e.description "; $sql .= "from "; $sql .= "v_extension_users as u, "; $sql .= "v_extensions as e "; $sql .= "where "; $sql .= "e.domain_uuid = :domain_uuid "; $sql .= "and e.extension_uuid = u.extension_uuid "; $sql .= "and u.user_uuid = :user_uuid "; $sql .= "and e.enabled = 'true' "; $sql .= "order by "; $sql .= "e.extension asc "; $parameters['domain_uuid'] = $_SESSION['domain_uuid']; $parameters['user_uuid'] = $_SESSION['user_uuid']; $result = $this->database->select($sql, $parameters, 'all'); if (is_array($result) && @sizeof($result) != 0) { foreach($result as $x => $row) { //set the destination $destination = $row['extension']; if (!empty($row['number_alias'])) { $destination = $row['number_alias']; } //build the user array $_SESSION['user']['extension'][$x]['user'] = $row['extension']; $_SESSION['user']['extension'][$x]['number_alias'] = $row['number_alias']; $_SESSION['user']['extension'][$x]['destination'] = $destination; $_SESSION['user']['extension'][$x]['extension_uuid'] = $row['extension_uuid']; $_SESSION['user']['extension'][$x]['outbound_caller_id_name'] = $row['outbound_caller_id_name']; $_SESSION['user']['extension'][$x]['outbound_caller_id_number'] = $row['outbound_caller_id_number']; $_SESSION['user']['extension'][$x]['user_context'] = $row['user_context']; $_SESSION['user']['extension'][$x]['description'] = $row['description']; //set the context $_SESSION['user']['user_context'] = $row["user_context"]; $_SESSION['user_context'] = $row["user_context"]; } } unset($sql, $parameters, $result, $row); } } //set the time zone if (!isset($_SESSION["time_zone"]["user"])) { $_SESSION["time_zone"]["user"] = null; } if (strlen($_SESSION["time_zone"]["user"] ?? '') === 0) { //set the domain time zone as the default time zone date_default_timezone_set($_SESSION['domain']['time_zone']['name']); } else { //set the user defined time zone date_default_timezone_set($_SESSION["time_zone"]["user"]); } //regenerate the session on login //session_regenerate_id(true); //set a session variable to indicate authorized is set to true $_SESSION['authorized'] = true; //add the username to the session - username session could be set so check_auth uses an authorized session variable instead $_SESSION['username'] = $_SESSION['user']["username"]; } //authorized true //log the attempt $plugin_classname = substr($class_name, 7); user_logs::add($_SESSION['authentication']['plugin'][$plugin_classname]); //return the result return $result ?? false; } /** * get_domain used to get the domain name from the URL or username and then sets both domain_name and domain_uuid */ public function get_domain() { //get the domain from the url $this->domain_name = $_SERVER["HTTP_HOST"]; //get the domain name from the http value if (!empty($_REQUEST["domain_name"])) { $this->domain_name = $_REQUEST["domain_name"]; } //remote port number from the domain name $domain_array = explode(":", $this->domain_name); if (count($domain_array) > 1) { $domain_name = $domain_array[0]; } //if the username if (!empty($_REQUEST["username"])) { $_SESSION['username'] = $_REQUEST["username"]; } //set a default value for unqiue if (empty($_SESSION["users"]["unique"]["text"])) { $_SESSION["users"]["unique"]["text"] = 'false'; } //get the domain name from the username if (!empty($_SESSION['username']) && $_SESSION["users"]["unique"]["text"] != "global") { $username_array = explode("@", $_SESSION['username']); if (count($username_array) > 1) { //get the domain name $domain_name = $username_array[count($username_array) -1]; //check if the domain from the username exists $domain_exists = false; foreach ($_SESSION['domains'] as $row) { if (lower_case($row['domain_name']) == lower_case($domain_name)) { $this->domain_uuid = $row['domain_uuid']; $domain_exists = true; break; } } //if the domain exists then set domain_name and update the username if ($domain_exists) { $this->domain_name = $domain_name; $this->username = substr($_SESSION['username'], 0, -(strlen($domain_name)+1)); //$_SESSION['domain_name'] = $domain_name; $_SESSION['username'] = $this->username; $_SESSION['domain_uuid'] = $this->domain_uuid; } //unset the domain name variable unset($domain_name); } } //get the domain uuid and domain settings if (isset($this->domain_name) && !isset($this->domain_uuid)) { foreach ($_SESSION['domains'] as $row) { if (lower_case($row['domain_name']) == lower_case($this->domain_name)) { $this->domain_uuid = $row['domain_uuid']; $_SESSION['domain_uuid'] = $row['domain_uuid']; break; } } } //set the setting arrays $obj = new domains(['database' => $this->database]); $obj->set(); //set the domain settings if (!empty($this->domain_name) && !empty($_SESSION["domain_uuid"])) { $_SESSION['domain_name'] = $this->domain_name; $_SESSION['domain_parent_uuid'] = $_SESSION["domain_uuid"]; } //set the domain name return $this->domain_name; } } /* $auth = new authentication; $auth->username = "user"; $auth->password = "password"; $auth->domain_name = "sip.fusionpbx.com"; $response = $auth->validate(); print_r($response); */ ?>