2 if (version_compare(PHP_VERSION
, '8.0.0', '<'))
3 die("This webserver is using PHP version ".PHP_VERSION
." but we require at least PHP 8.0.0.<br>".
4 "If you already installed PHP8 but are still seeing this error, then it means ".
5 "apache/nginx/.. is loading an older PHP version. Eg. on Debian/Ubuntu you need ".
6 "<code>apt-get install libapache2-mod-php8.2</code> (or a similar version) and ".
7 "<code>apt-get remove libapache2-mod-php7.4</code> (or a similar version). ".
8 "You may also need to choose again the PHP module to load in apache via <code>a2enmod php8.2</code>");
10 define('UPATH', dirname(__DIR__
));
12 function get_config($setting)
17 foreach(explode("::", $setting) as $x)
27 function page_requires_no_config()
29 if (str_ends_with($_SERVER['SCRIPT_FILENAME'],"install.php") ||
30 str_ends_with($_SERVER['SCRIPT_FILENAME'],"installation.php"))
37 function page_requires_no_login()
39 if (str_ends_with($_SERVER['SCRIPT_FILENAME'],"login/index.php") ||
40 page_requires_no_config())
47 function read_config_file()
50 GLOBAL $config_transition_unreal_server;
53 if (!file_exists(UPATH
."/config/config.php") && file_exists(UPATH
."/config.php"))
55 require_once UPATH
. "/config.php";
56 require_once UPATH
. "/config/compat.php";
58 if ((@include(UPATH
. "/config/config.php")) !== 1)
60 if (isset($config['unrealircd']))
61 $config_transition_unreal_server = true;
63 $plugins_modified = false;
64 foreach ($config["plugins"] as $k=>$v)
68 $config["plugins"][$k] = "sql_db";
69 $plugins_modified = true;
71 if ($v == "file_auth")
73 $config["plugins"][$k] = "file_db";
74 $plugins_modified = true;
77 if ($plugins_modified)
83 function read_config_db()
87 if (page_requires_no_config())
90 $merge = DbSettings
::get();
91 /* DB settings overwrite config.php keys: */
92 $config = array_merge($config, $merge);
95 function config_is_file_item($name)
97 if (($name == "plugins") ||
99 ($name == "base_url") ||
100 ($name == "secrets"))
107 function write_config_file()
112 foreach($config as $k=>$v)
114 if (config_is_file_item($k))
115 $file_settings[$k] = $v;
118 $cfg_filename = UPATH
.'/config/config.php';
119 $tmpfile = UPATH
.'/config/config.tmp.'.bin2hex(random_bytes(8)).'.php';
120 $fd = fopen($tmpfile, "w");
122 die("Could not write to temporary config file $tmpfile.<br>We need write permissions on the config/ directory!<br>");
124 $str = var_export($file_settings, true);
126 die("Error while running write_config_file() -- weird!");
127 if (!fwrite($fd, "<?php\n".
128 "/* This config file is written automatically by the UnrealIRCd webpanel.\n".
129 " * You are not really supposed to edit it manually.\n".
131 '$config = '.$str.";\n"))
133 die("Error writing to config file $tmpfile (on fwrite).<br>");
136 die("Error writing to config file $tmpfile (on close).<br>");
137 /* Now atomically rename the file */
138 if (!rename($tmpfile, $cfg_filename))
139 die("Could not write (rename) to file ".$cfg_filename."<br>");
140 if (function_exists('opcache_invalidate'))
141 opcache_invalidate($cfg_filename);
143 /* Do not re-read config, as it would reinitialize config
144 * without having the DB settings read. (And it also
150 // XXX: handle unsetting of config items :D - explicit unset function ?
152 function write_config($setting = null)
156 /* Specific request? Easy, write only this setting to the DB (never used for file) */
157 if ($setting !== null)
159 return DbSettings
::set($setting, $config[$setting]);
162 /* Otherwise write the whole config.
163 * TODO: avoid writing settings file if unneeded,
164 * as it is more noisy than db settings.
168 foreach($config as $k=>$v)
170 if (!config_is_file_item($k))
171 $db_settings[$k] = $v;
174 if (!write_config_file())
177 foreach($db_settings as $k=>$v)
179 $ret = DbSettings
::set($k, $v);
187 function get_version()
189 $fd = @fopen(UPATH
."/.git/FETCH_HEAD", "r");
192 $line = fgets($fd, 512);
194 $commit = substr($line, 0, 8);
195 return $commit; /* short git commit id */
198 function generate_secrets()
202 if (!isset($config['secrets']))
203 $config['secrets'] = Array();
205 if (!isset($config['secrets']['pepper']))
206 $config['secrets']['pepper'] = rtrim(base64_encode(random_bytes(16)),'=');
208 if (!isset($config['secrets']['key']))
209 $config['secrets']['key'] = rtrim(base64_encode(sodium_crypto_aead_xchacha20poly1305_ietf_keygen()),'=');
212 function secret_encrypt(string $text)
216 $key = base64_decode($config['secrets']['key']);
217 $nonce = \random_bytes
(\SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES
);
218 $encrypted_text = sodium_crypto_aead_xchacha20poly1305_ietf_encrypt($text, '', $nonce, $key);
219 return "secret:".rtrim(base64_encode($nonce),'=').':'.rtrim(base64_encode($encrypted_text),'='); // secret:base64(NONCE):base64(ENCRYPTEDTEXT)
222 function secret_decrypt(string $crypted)
226 $key = base64_decode($config['secrets']['key']);
227 $d = explode(":", $crypted);
230 $nonce = base64_decode($d[1]);
231 $ciphertext = base64_decode($d[2]);
233 $ret = sodium_crypto_aead_xchacha20poly1305_ietf_decrypt($ciphertext, '', $nonce, $key);
239 function upgrade_check()
241 GLOBAL $config_transition_unreal_server;
244 /* Moving of a config.php item to DB: */
245 if ($config_transition_unreal_server)
248 /* Our own stuff may need upgrading.. */
249 /* - generating secrets */
250 if (!isset($config['secrets']))
255 /* - encrypting rpc_password */
256 if (isset($config['unrealircd']) &&
257 isset($config['unrealircd']['rpc_password']) &&
258 !str_starts_with($config['unrealircd']['rpc_password'], "secret:"))
260 $ret = secret_encrypt($config['unrealircd']['rpc_password']);
263 $config['unrealircd']['rpc_password'] = $ret;
264 write_config('unrealircd');
268 $version = get_version();
269 if (!isset($config['webpanel_version']))
270 $config['webpanel_version'] = '';
271 if ($version != $config['webpanel_version'])
274 "old_version" => $config['webpanel_version'],
275 "new_version" => $version
277 /* And inform the hook (eg the database backends) */
278 Hook
::run(HOOKTYPE_UPGRADE
, $versioninfo);
279 /* And set the new version now that the upgrade is "done" */
280 $config['webpanel_version'] = $version;
281 write_config("webpanel_version");
285 function panel_start_session($user = false)
287 if (!isset($_SESSION))
289 session_set_cookie_params(86400); // can't set this to session_timeout due to catch-22
295 $user = unreal_get_current_user();
301 if (isset($user->user_meta
['session_timeout']))
302 $timeout = (INT)$user->user_meta
['session_timeout'];
304 if (!isset($_SESSION['session_timeout']))
305 $_SESSION['session_timeout'] = $timeout;
307 $_SESSION['last-activity'] = time();
311 /* Now read the config, and redirect to install screen if we don't have it */
312 $config_transition_unreal_server = false;
313 if (!read_config_file())
315 if (page_requires_no_config())
317 /* Allow empty conf */
319 if (!file_exists(UPATH
."/config/config.php") && !file_exists(UPATH
."/config.php"))
321 header("Location: settings/install.php");
326 require_once UPATH
. "/Classes/class-hook.php";
327 if (!is_dir(UPATH
. "/vendor"))
328 die("The vendor/ directory is missing. Most likely the admin forgot to run 'composer install'\n");
329 require_once UPATH
. '/vendor/autoload.php';
330 require_once UPATH
. "/Classes/class-cmodes.php";
331 require_once UPATH
. "/inc/defines.php";
332 require_once UPATH
. "/misc/strings.php";
333 require_once UPATH
. "/misc/channel-lookup-misc.php";
334 require_once UPATH
. "/misc/user-lookup-misc.php";
335 require_once UPATH
. "/misc/server-lookup-misc.php";
336 require_once UPATH
. "/misc/ip-whois-misc.php";
337 require_once UPATH
. "/Classes/class-log.php";
338 require_once UPATH
. "/Classes/class-message.php";
339 require_once UPATH
. "/Classes/class-rpc.php";
340 require_once UPATH
. "/Classes/class-paneluser.php";
341 require_once UPATH
. "/plugins.php";
343 /* Do various checks and reading, except during setup step 1. */
344 if (!page_requires_no_config())
346 /* Now that plugins are loaded, read config from DB */
349 /* Check if anything needs upgrading (eg on panel version change) */
353 if (!get_config("base_url"))
354 die("The base_url was not found in your config. Setup went wrong?");
360 "Channels" => "channels",
361 "Servers" => "servers",
363 "Server Bans" => "server-bans",
364 "Name Bans" => "server-bans/name-bans.php",
365 "Ban Exceptions" => "server-bans/ban-exceptions.php"
367 "Spamfilter" => "spamfilter.php",
369 "IP WHOIS" => "tools/ip-whois.php",
372 "Plugins" => "settings/plugins.php",
375 "News" => "news.php",
378 if (!panel_start_session())
380 if (!page_requires_no_login())
382 if (!is_auth_provided())
383 die("No authentication plugin loaded. You must load either sql_db, file_db, or a similar auth plugin!");
384 $current_page = $_SERVER['REQUEST_URI'];
385 header("Location: ".get_config("base_url")."login/?redirect=".urlencode($current_page));
389 $pages["Settings"]["Accounts"] = "settings";
390 if (current_user_can(PERMISSION_MANAGE_USERS
))
391 $pages["Settings"]["Role Editor"] = "settings/user-role-edit.php";
392 $user = unreal_get_current_user();
395 /* Add logout page, if logged in */
396 $pages["Logout"] = "login/?logout=true";
400 Hook
::run(HOOKTYPE_NAVBAR
, $pages);
402 /* Example to add new menu item:
407 * function __construct()
409 * Hook::func(HOOKTYPE_NAVBAR, [$this, 'add_menu'])
412 * function add_menu(&$pages) // this should pass by reference (using the & prefix)
414 * $page_name = "My New Page";
415 * $page_link = "link/to/page.php";
416 * $pages[$page_name] = $page_link;