create self-signed certificate as last fallback if system-wide cert/key file cannot be found; add english translations for installation (wip)

Signed-off-by: Michael Kaufmann <d00p@froxlor.org>

lib/Froxlor/Cron/Http/Apache.php

@@ -36,6 +36,7 @@ use Froxlor\Http\Statistics;
 use Froxlor\PhpHelper;
 use Froxlor\Settings;
 use Froxlor\Validate\Validate;
+use Froxlor\System\Crypt;
 use PDO;
 
 /**
@@ -351,9 +352,8 @@ class Apache extends HttpConfigBase
 					if (($row_ipsandports['ssl_cert_file'] == '' || !file_exists($row_ipsandports['ssl_cert_file'])) && (Settings::Get('system.le_froxlor_enabled') == '0' || $this->froxlorVhostHasLetsEncryptCert() == false)) {
 						$row_ipsandports['ssl_cert_file'] = Settings::Get('system.ssl_cert_file');
 						if (!file_exists($row_ipsandports['ssl_cert_file'])) {
-							// explicitly disable ssl for this vhost
+							FroxlorLogger::getInstanceOf()->logAction(FroxlorLogger::CRON_ACTION, LOG_DEBUG, 'System certificate file "' . Settings::Get('system.ssl_cert_file') . '" does not seem to exist. Creating self-signed certificate...');
-							$row_ipsandports['ssl_cert_file'] = "";
+							Crypt::createSelfSignedCertificate();
-							FroxlorLogger::getInstanceOf()->logAction(FroxlorLogger::CRON_ACTION, LOG_DEBUG, 'System certificate file "' . Settings::Get('system.ssl_cert_file') . '" does not seem to exist. Disabling SSL-vhost for "' . Settings::Get('system.hostname') . '"');
 						}
 					}
 

lib/Froxlor/Cron/Http/Lighttpd.php

@@ -35,6 +35,7 @@ use Froxlor\Http\Directory;
 use Froxlor\Http\Statistics;
 use Froxlor\Settings;
 use Froxlor\Validate\Validate;
+use Froxlor\System\Crypt;
 use PDO;
 
 /**
@@ -212,9 +213,16 @@ class Lighttpd extends HttpConfigBase
 				if (($row_ipsandports['ssl_cert_file'] == '' || !file_exists($row_ipsandports['ssl_cert_file'])) && (Settings::Get('system.le_froxlor_enabled') == '0' || $this->froxlorVhostHasLetsEncryptCert() == false)) {
 					$row_ipsandports['ssl_cert_file'] = Settings::Get('system.ssl_cert_file');
 					if (!file_exists($row_ipsandports['ssl_cert_file'])) {
+						$this->logger->logAction(FroxlorLogger::CRON_ACTION, LOG_DEBUG, 'System certificate file "' . Settings::Get('system.ssl_cert_file') . '" does not seem to exist. Creating self-signed certificate...');
+						Crypt::createSelfSignedCertificate();
+					}
+				}
+				if ($row_ipsandports['ssl_key_file'] == '') {
+					$row_ipsandports['ssl_key_file'] = Settings::Get('system.ssl_key_file');
+					if (!file_exists($row_ipsandports['ssl_key_file'])) {
 						// explicitly disable ssl for this vhost
 						$row_ipsandports['ssl_cert_file'] = "";
-						$this->logger->logAction(FroxlorLogger::CRON_ACTION, LOG_DEBUG, 'System certificate file "' . Settings::Get('system.ssl_cert_file') . '" does not seem to exist. Disabling SSL-vhost for "' . Settings::Get('system.hostname') . '"');
+						FroxlorLogger::getInstanceOf()->logAction(FroxlorLogger::CRON_ACTION, LOG_DEBUG, 'System certificate key-file "' . Settings::Get('system.ssl_key_file') . '" does not seem to exist. Disabling SSL-vhost for "' . Settings::Get('system.hostname') . '"');
 					}
 				}
 

lib/Froxlor/Cron/Http/Nginx.php

@@ -35,6 +35,7 @@ use Froxlor\Http\Directory;
 use Froxlor\Http\Statistics;
 use Froxlor\Settings;
 use Froxlor\Validate\Validate;
+use Froxlor\System\Crypt;
 use PDO;
 
 class Nginx extends HttpConfigBase
@@ -110,9 +111,8 @@ class Nginx extends HttpConfigBase
 					if (($row_ipsandports['ssl_cert_file'] == '' || !file_exists($row_ipsandports['ssl_cert_file'])) && (Settings::Get('system.le_froxlor_enabled') == '0' || $this->froxlorVhostHasLetsEncryptCert() == false)) {
 						$row_ipsandports['ssl_cert_file'] = Settings::Get('system.ssl_cert_file');
 						if (!file_exists($row_ipsandports['ssl_cert_file'])) {
-							// explicitly disable ssl for this vhost
+							FroxlorLogger::getInstanceOf()->logAction(FroxlorLogger::CRON_ACTION, LOG_DEBUG, 'System certificate file "' . Settings::Get('system.ssl_cert_file') . '" does not seem to exist. Creating self-signed certificate...');
-							$row_ipsandports['ssl_cert_file'] = "";
+							Crypt::createSelfSignedCertificate();
-							FroxlorLogger::getInstanceOf()->logAction(FroxlorLogger::CRON_ACTION, LOG_DEBUG, 'System certificate file "' . Settings::Get('system.ssl_cert_file') . '" does not seem to exist. Disabling SSL-vhost for "' . Settings::Get('system.hostname') . '"');
 						}
 					}
 					if ($row_ipsandports['ssl_key_file'] == '') {

lib/Froxlor/Install/Install.php

@@ -29,6 +29,7 @@ use Exception;
 use Froxlor\Install\Install\Core;
 use Froxlor\UI\Panel\UI;
 use Froxlor\UI\Request;
+use Froxlor\Config\ConfigParser;
 
 class Install
 {
@@ -42,18 +43,29 @@ class Install
 	public array $suggestions = [];
 	public array $criticals = [];
 	public array $loadedExtensions;
-	// TODO: add more os
+	public array $supportedOS = [];
-	public array $supportedOS = [
-		'focal' => 'Ubuntu 20.04 LTS (Focal Fossa)'
-	];
 	public array $webserverBackend = [
 		'php-fpm' => 'PHP-FPM',
 		'fcgid' => 'FCGID',
-		'none' => 'None',
+		'mod_php' => 'mod_php (not recommended)',
 	];
 
 	public function __construct()
 	{
+		// get all supported OS
+		// show list of available distro's
+		$distros = glob(dirname(__DIR__, 3) . '/lib/configfiles/*.xml');
+		$distributions_select[''] = '-';
+		// read in all the distros
+		foreach ($distros as $distribution) {
+			// get configparser object
+			$dist = new ConfigParser($distribution);
+			// store in tmp array
+			$this->supportedOS[str_replace(".xml", "", strtolower(basename($distribution)))] = $dist->getCompleteDistroName();
+		}
+		// sort by distribution name
+		asort($this->supportedOS);
+
 		// set formfield, so we can get the fields and steps etc.
 		$this->formfield = require dirname(__DIR__, 3) . '/lib/formfields/install/formfield.install.php';
 
@@ -180,10 +192,10 @@ class Install
 	private function getInformationText(): string
 	{
 		if (version_compare($this->requiredVersion, PHP_VERSION, "<")) {
-			$text = 'Your system is running with PHP ' . $this->phpVersion;
+			$text = lng('install.phpinfosuccess', [$this->phpVersion]);
 		} else {
-			$text = 'Your system is running a lower version than PHP ' . $this->requiredVersion;
+			$text = lng('install.phpinfowarn', [$this->requiredVersion]);
-			$this->criticals[] = 'Update your current PHP Version from ' . $this->phpVersion . ' to ' . $this->requiredVersion . ' or higher';
+			$this->criticals[] = lng('install.phpinfoupdate', [$this->phpVersion, $this->requiredVersion]);
 		}
 		return $text;
 	}

lib/formfields/install/formfield.install.php

@@ -23,29 +23,29 @@
  * @license    https://files.froxlor.org/misc/COPYING.txt GPLv2
  */
 
+use Froxlor\Froxlor;
+
 return [
 	'install' => [
-		'title' => lng('admin.admin_add'),
+		'title' => 'install',
-		'image' => 'fa-solid fa-user-plus',
-		'self_overview' => ['section' => 'admins', 'page' => 'admins'],
 		'sections' => [
 			'step1' => [
 				'title' => lng('install.database.title'),
 				'fields' => [
 					'mysql_host' => [
-						'label' => lng('mysql_host'),
+						'label' => lng('mysql.mysql_server'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('mysql_host', 'localhost', 'installation')
 					],
 					'mysql_root_user' => [
-						'label' => lng('mysql_root_user'),
+						'label' => lng('mysql.privileged_user'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('mysql_root_user', 'froxroot', 'installation'),
 						'next_to' => [
 							'mysql_root_pass' => [
-								'label' => lng('mysql_root_pass'),
+								'label' => lng('login.password'),
 								'type' => 'password',
 								'mandatory' => true,
 								'value' => old('mysql_root_pass', null, 'installation'),
@@ -53,13 +53,13 @@ return [
 						]
 					],
 					'mysql_unprivileged_user' => [
-						'label' => lng('mysql_unprivileged_user'),
+						'label' => lng('install.database.user'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('mysql_unprivileged_user', 'froxlor', 'installation'),
 						'next_to' => [
 							'mysql_unprivileged_pass' => [
-								'label' => lng('mysql_unprivileged_pass'),
+								'label' => lng('login.password'),
 								'type' => 'password',
 								'mandatory' => true,
 								'value' => old('mysql_unprivileged_pass', null, 'installation'),
@@ -67,48 +67,42 @@ return [
 						]
 					],
 					'mysql_database' => [
-						'label' => lng('mysql_database'),
+						'label' => lng('install.database.dbname'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('mysql_database', 'froxlor', 'installation'),
 					],
 					'mysql_force_create' => [
-						'label' => lng('mysql_force_create'),
+						'label' => lng('install.database.force_create'),
 						'type' => 'checkbox',
 						'value' => '1',
 						'checked' => old('mysql_force_create', '0', 'installation')
 					],
-					'mysql_access_host' => [
-						'label' => lng('mysql_access_host'),
-						'type' => 'text',
-						'mandatory' => true,
-						'value' => old('mysql_access_host', '127.0.0.1,localhost', 'installation'),
-					],
 				]
 			],
 			'step2' => [
 				'title' => lng('install.admin.title'),
 				'fields' => [
 					'admin_name' => [
-						'label' => lng('admin_name'),
+						'label' => lng('customer.name'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('admin_name', 'Administrator', 'installation'),
 					],
 					'admin_user' => [
-						'label' => lng('admin_user'),
+						'label' => lng('login.username'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('admin_user', 'admin', 'installation'),
 					],
 					'admin_pass' => [
-						'label' => lng('admin_pass'),
+						'label' => lng('login.password'),
 						'type' => 'password',
 						'mandatory' => true,
 						'value' => old('admin_pass', null, 'installation'),
 					],
 					'admin_email' => [
-						'label' => lng('admin_email'),
+						'label' => lng('customer.email'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('admin_email', null, 'installation'),
@@ -119,55 +113,56 @@ return [
 				'title' => lng('install.system.title'),
 				'fields' => [
 					'distribution' => [
-						'label' => lng('distribution'),
+						'label' => lng('admin.configfiles.distribution'),
 						'type' => 'select',
 						'mandatory' => true,
 						'select_var' => $this->supportedOS,
 					],
 					'serverip' => [
-						'label' => lng('serverip'),
+						'label' => lng('serversettings.ipaddress.title'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('serverip', null, 'installation'),
 					],
 					'servername' => [
-						'label' => lng('servername'),
+						'label' => lng('install.system.servername'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('servername', null, 'installation'),
 					],
 					'use_ssl' => [
-						'label' => lng('use_ssl'),
+						'label' => lng('serversettings.ssl.use_ssl.title'),
 						'type' => 'checkbox',
 						'value' => '1',
 						'checked' => old('use_ssl', '1', 'installation'),
 					],
 					'webserver' => [
-						'label' => lng('webserver'),
+						'label' => lng('admin.webserver'),
-						'type' => 'text',
+						'type' => 'select',
 						'mandatory' => true,
+						'select_var' => ['apache24' => 'Apache 2.4', 'nginx' => 'Nginx', 'lighttpd' => 'LigHTTPd'],
 						'value' => old('webserver', 'apache24', 'installation'),
 					],
 					'webserver_backend' => [
-						'label' => lng('webserver_backend'),
+						'label' => lng('install.system.phpbackend'),
 						'type' => 'select',
 						'mandatory' => true,
 						'select_var' => $this->webserverBackend,
 					],
 					'httpuser' => [
-						'label' => lng('httpuser'),
+						'label' => lng('admin.webserver_user'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('httpuser', 'www-data', 'installation'),
 					],
 					'httpgroup' => [
-						'label' => lng('httpgroup'),
+						'label' => lng('admin.webserver_group'),
 						'type' => 'text',
 						'mandatory' => true,
 						'value' => old('httpgroup', 'www-data', 'installation'),
 					],
 					'activate_newsfeed' => [
-						'label' => lng('activate_newsfeed'),
+						'label' => lng('install.system.activate_newsfeed'),
 						'type' => 'checkbox',
 						'value' => '1',
 						'checked' => false
@@ -178,9 +173,9 @@ return [
 				'title' => lng('install.system.title'),
 				'fields' => [
 					'system' => [
-						'label' => lng('install.system.system'),
+						'label' => lng('install.install.runcmd'),
 						'type' => 'textarea',
-						'value' => '/var/www/html/froxlor/bin/froxlor-cli cron --force',
+						'value' => Froxlor::getInstallDir().'bin/froxlor-cli froxlor:config-services -a [JSON PARAMETER] --yes-to-all',
 						'readonly' => true,
 						'rows' => 1
 					],

lng/en.lng.php

@@ -1368,6 +1368,7 @@ Yours sincerely, your administrator',
 		'mysql_server' => 'MySQL-Server',
 		'database_edit' => 'Edit database',
 		'size' => 'Size',
+		'privileged_user' => 'Privileged database user',
 	],
 	'opcacheinfo' => [
 		'generaltitle' => 'General Information',
@@ -2453,9 +2454,41 @@ Yours sincerely, your administrator',
 		],
 	],
 	'install' => [
+		'slogal' => 'froxlor Server Management Panel',
+		'preflight' => 'System check',
+		'critical_error' => 'Critical error',
+		'suggestions' => 'Not required but recommended',
+		'phpinfosuccess' => 'Your system is running with PHP %s',
+		'phpinfowarn' => 'Your system is running a lower version than PHP %s',
+		'phpinfoupdate' => 'Update your current PHP Version from %s to %s or higher',
+		'start_installation' => 'Start installation',
+		'check_again' => 'Reload to check again',
 		'dependency_check' => [
 			'title' => 'Welcome to froxlor',
 			'description' => 'We check the system for dependencies to ensure that all required php extensions and modules are enabled so that froxlor runs properly.',
 		],
+		'database' => [
+			'top' => 'Database',
+			'title' => 'Froxlor requires a database and additionally a privileged user to be able to create users and databases (GRANT option). The given database and unprivileged database-user will be created in this process. The privileged user must exist.',
+			'user' => 'Unprivileged database user',
+			'dbname' => 'Database name',
+			'force_create' => 'Backup and overwrite database if exists?',
+		],
+		'admin' => [
+			'top' => 'Admin user',
+			'title' => 'Let\'s create the main administrator user. This user has all privileges to adjust settings and add/update/delete resources like customers, domains, etc.',
+		],
+		'system' => [
+			'top' => 'System setup',
+			'title' => 'Set your environment as well as server relevant data and options here to let froxlor know about your system. These values are crucial for the system configuration and operating.',
+			'servername' => 'Server name (FQDN, no ip-address)',
+			'phpbackend' => 'PHP backend',
+			'activate_newsfeed' => 'Enable the official newsfeed<br><small>(https://inside.froxlor.org/news/)</small>',
+		],
+		'install' => [
+			'top' => 'Finish setup',
+			'title' => '@todo description',
+			'runcmd' => 'Run the following command as root-user in your shell on this server to install/configure all services',
+		],
 	],
 ];

templates/Froxlor/form/formfields.html.twig

@@ -63,7 +63,7 @@
 
 {% macro field(id, field, norow = true, nohide = false, em = false) %}
 	<div class="mb-3">
-		<label for="{{ id }}" class="form-label">{{ field.label }}</label>
+		<label for="{{ id }}" class="form-label">{{ field.label|raw }}</label>
 		{{ _self.fieldrow(id, field, norow, nohide, em) }}
 	</div>
 {% endmacro %}

templates/Froxlor/install/index.html.twig

@@ -2,7 +2,7 @@
 
 {% block content %}
 	<div class="container max-w-lg flex align-content-center mt-5">
-		<img src="{{ basehref|default('') }}templates/Froxlor/assets/img/logo.png" class="mb-5" alt="{{ lng('slogan') }}"/>
+		<img src="{{ basehref|default('') }}templates/Froxlor/assets/img/logo.png" class="mb-5" alt="{{ lng('install.slogan') }}"/>
 
 		{% if error is not null %}
 			<div class="alert alert-danger mb-4">{{ error }}</div>
@@ -11,23 +11,23 @@
 		<div class="row text-center gx-0">
 			<div class="col p-3{{ setup.step == 0 ? ' bg-white shadow rounded-top' : '' }}">
 				<i class="far fa-circle{{ setup.step > 0 ? '-check' : '' }}"></i>
-				{% if setup.step > 0 %}<a href="?step=0" class="text-decoration-none">{{ lng('preflight') }}</a>{% else %}{{ lng('preflight') }}{% endif %}
+				{% if setup.step > 0 %}<a href="?step=0" class="text-decoration-none">{{ lng('install.preflight') }}</a>{% else %}{{ lng('install.preflight') }}{% endif %}
 			</div>
 			<div class="col p-3{{ setup.step == 1 ? ' bg-white shadow rounded-top' : '' }}">
 				<i class="far fa-circle{{ setup.step > 1 ? '-check' : '' }}"></i>
-				{% if setup.step > 1 %}<a href="?step=1" class="text-decoration-none">{{ lng('database') }}</a>{% else %}{{ lng('database') }}{% endif %}
+				{% if setup.step > 1 %}<a href="?step=1" class="text-decoration-none">{{ lng('install.database.top') }}</a>{% else %}{{ lng('install.database.top') }}{% endif %}
 			</div>
 			<div class="col p-3{{ setup.step == 2 ? ' bg-white shadow rounded-top' : '' }}">
 				<i class="far fa-circle{{ setup.step > 2 ? '-check' : '' }}"></i>
-				{% if setup.step > 2 %}<a href="?step=2" class="text-decoration-none">{{ lng('admin') }}</a>{% else %}{{ lng('admin') }}{% endif %}
+				{% if setup.step > 2 %}<a href="?step=2" class="text-decoration-none">{{ lng('install.admin.top') }}</a>{% else %}{{ lng('install.admin.top') }}{% endif %}
 			</div>
 			<div class="col p-3{{ setup.step == 3 ? ' bg-white shadow rounded-top' : '' }}">
 				<i class="far fa-circle{{ setup.step > 3 ? '-check' : '' }}"></i>
-				{% if setup.step > 3 %}<a href="?step=3" class="text-decoration-none">{{ lng('system') }}</a>{% else %}{{ lng('system') }}{% endif %}
+				{% if setup.step > 3 %}<a href="?step=3" class="text-decoration-none">{{ lng('install.system.top') }}</a>{% else %}{{ lng('install.system.top') }}{% endif %}
 			</div>
 			<div class="col p-3{{ setup.step == 4 ? ' bg-white shadow rounded-top' : '' }}">
 				<i class="far fa-circle{{ setup.step > 4 ? '-check' : '' }}"></i>
-				{% if setup.step > 4 %}<a href="?step=4" class="text-decoration-none">{{ lng('install') }}</a>{% else %}{{ lng('install') }}{% endif %}
+				{% if setup.step > 4 %}<a href="?step=4" class="text-decoration-none">{{ lng('install.install.top') }}</a>{% else %}{{ lng('install.install.top') }}{% endif %}
 			</div>
 		</div>
 
@@ -45,20 +45,20 @@
 						{% endfor %}
 
 						<div class="d-flex justify-content-between mt-4">
-							<a href="?step={{ setup.step - 1 }}" class="btn btn-secondary">&laquo; {{ lng('back') }}</a>
+							<a href="?step={{ setup.step - 1 }}" class="btn btn-secondary">&laquo; {{ lng('panel.back') }}</a>
-							<button type="submit" name="submit" class="btn btn-primary">{{ lng('next') }} &raquo;</button>
+							<button type="submit" name="submit" class="btn btn-primary">{{ lng('panel.next') }} &raquo;</button>
 						</div>
 					{% else %}
 						<h4 class="mb-3">{{ lng('install.dependency_check.title') }}</h4>
 						<p class="lead">{{ lng('install.dependency_check.description') }}</p>
 
 						<p class="lead {{ preflight.criticals ? 'text-danger' : preflight.suggestions ? 'text-warning' : 'text-success'}}">
-							<i class="{{ preflight.criticals ? 'fa fa-triangle-exclamation' : preflight.suggestions ? 'fa-circle-info' : 'far fa-circle-check' }}"></i>
+							<i class="{{ preflight.criticals ? 'fa fa-triangle-exclamation' : preflight.suggestions ? 'fa fa-circle-info' : 'far fa-circle-check' }}"></i>
 							{{ preflight.text }}
 						</p>
 
 						{% if preflight.criticals %}
-							<p class="text-muted">{{ lng('critical_error') }}</p>
+							<p class="text-muted">{{ lng('install.critical_error') }}</p>
 							<ul>
 								{% for critical in preflight.criticals %}
 									<li>{{ critical|json_encode }}</li>
@@ -67,7 +67,7 @@
 						{% endif %}
 
 						{% if preflight.suggestions %}
-							<p class="text-muted">{{ lng('suggestions') }}</p>
+							<p class="text-muted">{{ lng('install.suggestions') }}</p>
 							<ul>
 								{% for suggestion in preflight.suggestions %}
 									<li>{{ suggestion|json_encode }}</li>
@@ -76,10 +76,10 @@
 						{% endif %}
 
 						<div class="d-flex justify-content-end mt-4">
-							{% if preflight.criticals or preflight.suggestions %}
+							{% if preflight.criticals %}
-								<a href="" class="btn btn-secondary"><i class="fa fa-arrow-rotate-left"></i> {{ lng('check_again') }}</a>
+								<a href="" class="btn btn-secondary"><i class="fa fa-arrow-rotate-left"></i> {{ lng('install.check_again') }}</a>
 							{% else %}
-								<a href="?step=1" class="btn btn-primary">{{ lng('start_installation') }}</a>
+								<a href="?step=1" class="btn btn-primary">{{ lng('install.start_installation') }}</a>
 							{% endif %}
 						</div>
 					{% endif %}

templates/Froxlor/src/js/components/domains.js

@@ -56,14 +56,19 @@ $(function() {
 		});
 	}
 
+	/**
+	 * email only domain - hide unnecessary/unused sections
+	 */
 	if ($('#id') && $('#email_only').is(':checked')) {
-		// hide unnecessary sections
 		$('#section_b').hide();
 		$('#section_bssl').hide();
 		$('#section_c').hide();
 		$('#section_d').hide();
 	}
 
+	/**
+	 * toggle show/hide of sections in case of email only flag
+	 */
 	$('#email_only').on('click', function () {
 		if ($(this).is(':checked')) {
 			// hide unnecessary sections