more text …

Signed-off-by: tracer <tracer@24unix.net>

README.md

@@ -335,7 +335,7 @@ ns1.24unix.net  176.9.165.128 pong              2a01:4f8:161:12cd::128 pong
 ns2.24unix.net 37.120.185.117 pong 2a03:4000:f:5e2:a80c:2dff:fed1:e109 pong
 ```
 
-Now we can add all out panels:
+Now we can add all our panels:
 
 ```
 $ ./bin/console panels:create executor.24unix.net a=176.9.165.128 aaaa=2a01:4f8:161:12cd::128 apikey=Lo7jsXYQ.[truncated]
@@ -446,6 +446,7 @@ tfunix has to be a group member of the „bind“ group.
 As root perform:
 
 `usermod -G bind tfunix`
+
 (Mind that it is a capital G, else you'll change the primary group and the checks will fail.
 Don't ask how I noticed …)
 
@@ -478,15 +479,46 @@ Checking permission:
 
 UID:	5001
 Name:	tfunix
+	✅ is in group 'bind
 Checking file: /etc/bind/local.zones
 	✅ Group has write access .
 Checking /etc/bind/named.conf.local
 	✅ /etc/bind/local.zones is included in /etc/bind/named.conf.local
 Checking directory: /etc/bind/zones/
 	✅ Group has write access .
+```
 
+Now, there is one manual step left, for now.
+We have to go to each panel and add an include file.
+BUT: This is a temporary workaround, a later version of Keyhelp will enable us to automate this step.
+
+So, execute ./bin/console check:showincludes:
 
 ```
+ ./bin/console check:showincludes
+You need to add these lines to /etc/bind/local.bindapi.options and make sure
+that include "/etc/bind/local.bindapi.options"; exists in /etc/bind/named.conf.options.
+
+allow-transfer {
+	176.9.165.128;
+	2a01:4f8:161:12cd::128;
+	37.120.185.117;
+	2a03:4000:f:5e2:a80c:2dff:fed1:e109;
+	212.227.160.159;
+	2001:8d8:1801:701::1;
+};
+also-notify {
+	176.9.165.128;
+	2a01:4f8:161:12cd::128;
+	37.120.185.117;
+	2a03:4000:f:5e2:a80c:2dff:fed1:e109;
+	212.227.160.159;
+	2001:8d8:1801:701::1;
+};
+
+After the modification feel free to run named-checkconf to ensure there were no errors.
+```
+
 
 TODO
 

config.json.sample

@@ -3,5 +3,6 @@
   "dbPort": 3306,
   "dbDatabase": "sampledb",
   "dbUser": "sampleuser",
-  "dbPassword": "secret"
+  "dbPassword": "secret",
+  "debug": false
 }

src/Controller/ApiController.php

@@ -41,7 +41,7 @@ class ApiController
 		}
 		
 		curl_setopt(handle: $curl, option: CURLOPT_RETURNTRANSFER, value: 1);
-		curl_setopt(handle: $curl, option: CURLOPT_TIMEOUT_MS, value: 3000);
+		curl_setopt(handle: $curl, option: CURLOPT_TIMEOUT_MS, value: 19999);
 		curl_setopt(handle: $curl, option: CURLOPT_HTTP_VERSION, value: CURL_HTTP_VERSION_2TLS);
 		
 		if ($versionIP == 4) {
@@ -91,8 +91,13 @@ class ApiController
 			$error = true;
 			$result = curl_error(handle: $curl);
 		}
+		
+		$info = curl_getinfo(handle: $curl);
+		$responseTime = $info['total_time'];
+		
 		curl_close(handle: $curl);
 		return [
+			'responseTime' => $responseTime,
 			'error'        => $error,
 			'data'         => $result,
 			'header'       => $httpResponse ?? ''

src/Controller/BindAPI.php

@@ -145,6 +145,8 @@ class BindAPI
 		echo COLOR_GREEN . "\t    check:permissions" . PHP_EOL;
 		echo COLOR_GREEN . "\t    check:panels {ID} {fix=yes}" . PHP_EOL;
 		echo COLOR_GREEN . "\t    check:domains {ID} {fix=yes}" . PHP_EOL;
+		echo COLOR_GREEN . "\t    check:showinclude" . COLOR_DEFAULT . " Temporary needed until KeyHelp 22.1" . PHP_EOL;
+		
 		
 		echo COLOR_YELLOW . "panels" . COLOR_DEFAULT . "\t    all Keyhelp systems configured" . PHP_EOL;
 		echo COLOR_GREEN . "\t    panels:list" . PHP_EOL;
@@ -185,6 +187,7 @@ class BindAPI
 			match ($subcommand) {
 				'permissions' => $this->handleCheckPermissions(),
 				'panels' => $this->handleCheckPanels(),
+				'showincludes' => $this->showIncludes(),
 			};
 		} catch (UnhandledMatchError) {
 			echo 'Unknown action: ' . $subcommand . PHP_EOL;
@@ -245,8 +248,51 @@ class BindAPI
 			$this->log->debug(message: "checkSinglePanel()");
 		}
 		
-		echo COLOR_DEFAULT . 'Keyhelp-Panel: ' . COLOR_YELLOW . $panel->getName() . PHP_EOL;
-		if (!empty($panel->getAaaa())) {
+		echo COLOR_DEFAULT . 'Keyhelp-Panel: ' . COLOR_YELLOW . $panel->getName();
+		
+		if ($this->config['verbose']) {
+			if (empty($panel->getA())) {
+				try {
+					$panelRequest = $this->apiController->sendCommand(
+						requestType: 'GET',
+						serverName : $panel->getName(),
+						versionIP  : 6,
+						apiKey     : $panel->getApikey(),
+						command    : '/server',
+						serverType : 'panel');
+				} catch (DependencyException|NotFoundException $e) {
+					echo $e->getMessage();
+					exit(1);
+				}
+			} else {
+				try {
+					$panelRequest = $this->apiController->sendCommand(
+						requestType: 'GET',
+						serverName : $panel->getName(),
+						versionIP  : 4,
+						apiKey     : $panel->getApikey(),
+						command    : '/server',
+						serverType : 'panel');
+				} catch (DependencyException|NotFoundException $e) {
+					echo $e->getMessage();
+					exit();
+				}
+			}
+			
+			$panelData = json_decode(json: $panelRequest['data']);
+			if (!empty($panelData)) {
+				$panelVersion = $panelData->meta->panel_version;
+				$responseTime = sprintf("%0.3f", $panelRequest['responseTime']);
+			} else {
+				$panelVersion = 'n/a';
+				$responseTime = 'n/a';
+			}
+			echo COLOR_DEFAULT . ' KeyHelp version: ' . $panelVersion . " ($responseTime seconds)" . PHP_EOL;
+		} else {
+			echo PHP_EOL;
+		}
+		
+		if (empty($panel->getA())) {
 			try {
 				$result = $this->apiController->sendCommand(
 					requestType: 'GET',
@@ -273,6 +319,7 @@ class BindAPI
 			}
 		}
 		
+		
 		if (!empty($result['error'])) {
 			echo $result['data'] . PHP_EOL;
 			exit(1);
@@ -306,9 +353,9 @@ class BindAPI
 			}
 		}
 		if ($domainCount == 0) {
-			echo 'No second level domains found.' . PHP_EOL;
+			echo 'No second level domains found.' . COLOR_DEFAULT . PHP_EOL;
 		}
-		
+		echo PHP_EOL;
 	}
 	
 	function isValidSecondLevelDomain(string $domainName, string $panel, int $parent): bool
@@ -969,28 +1016,14 @@ class BindAPI
 		}
 		if (!empty($domains)) {
 			$table = new ConsoleTable();
-			$table->setHeaders(content: ['ID', 'Name', 'Content']);
+			$table->setHeaders(content: ['ID', 'Name', 'Panel']);
 			/** @var Domain $domain */
 			foreach ($domains as $domain) {
 				$row = [];
 				try {
 					$row[] = $domain->getId();
 					$row[] = $domain->getName();
-					$content = json_decode(json: $domain->getContent());
-					$column = '';
-					if (!empty($content->panel)) {
-						$column = 'Panel: ' . $content->panel;
-					}
-					if (!empty($content->custom)) {
-						$column .= 'Custom: ';
-						if (!empty($content->custom->a)) {
-							$column .= 'A: ' . $content->custom->a;
-						}
-						if (!empty($content->custom->aaaa)) {
-							$column .= ' AAAA: ' . $content->custom->a;
-						}
-					}
-					$row[] = $column;
+					$row[] = $domain->getPanel();
 				} catch (DependencyException|NotFoundException $e) {
 					echo $e->getMessage();
 				}
@@ -1023,16 +1056,11 @@ class BindAPI
 		}
 		
 		$arguments = $this->parseArguments();
-		
-		
-		$a = $arguments['a'] ?? '';
-		$aaaa = $arguments['aaaa'] ?? '';
 		$panel = $arguments['panel'] ?? '';
 		
-		print("panel: $panel");
-		if (empty($a) && empty($aaaa) && empty($panel)) {
-			echo 'At least one IP address or panel is required.' . PHP_EOL;
-			exit(0);
+		if (empty($panel)) {
+			echo 'You need to supply the panel name.' . PHP_EOL;
+			exit(1);
 		}
 		
 		try {
@@ -1040,24 +1068,13 @@ class BindAPI
 				echo "Domain: $name already exists." . PHP_EOL;
 				exit(1);
 			} else {
-				if (!empty($panel)) {
 				if ($this->panelRepository->findByName(name: $panel)) {
 					$content = $this->domainController->createPanelContent(panel: $panel);
 				} else {
 					echo 'Unknown panel: ' . $panel;
 					exit(1);
 				}
-				} else {
-					$content = [];
-					if (!empty($a)) {
-						$content['a'] = $a;
-					}
-					if (!empty($aaaa)) {
-						$content['aaaa'] = $aaaa;
-					}
-					$content = $this->domainController->createIPContent(ip: $content);
-				}
-				$domain = new Domain(name: $name, content: $content);
+				$domain = new Domain(name: $name, panel: $panel);
 				$result = $this->domainRepository->insert(domain: $domain);
 				echo "Domain $name has been created with id $result" . PHP_EOL;
 				$this->domainController->createSlaveZoneFile(domain: $domain);
@@ -1078,9 +1095,7 @@ class BindAPI
 		
 		$id = intval(value: $this->arguments[1] ?? 0);
 		$name = $arguments['name'] ?? '';
-		$panel = $arguments['panel'] ?? '';
-		$a = $arguments['a'] ?? '';
-		$aaaa = $arguments['aaaa'] ?? '';
+		$panelName = $arguments['panel'] ?? '';
 		
 		if ($id == 0) {
 			echo 'An ID is required' . PHP_EOL;
@@ -1093,35 +1108,17 @@ class BindAPI
 		
 		
 		$content = [];
-		if (!empty($panel)) {
-			$panel = $this->panelRepository->findByName(name: $panel);
-			$content = $this->domainController->createPanelContent(panel: $panel->getName());
-		} else {
-			$addresses = [];
-			if (!empty($a)) {
-				$addresses[] = [
-					'a' => $a
-				];
+		if (!empty($panelName)) {
+			$panel = $this->panelRepository->findByName(name: $panelName);
 		}
-			if (!empty($aaaa)) {
-				$addresses[] = [
-					'aaaa' => $aaaa
-				];
-			}
-			if (!empty($addresses)) {
-				$content = $this->domainController->createIPContent(ip: $content);
-			}
-		}
-		if (empty($name) && empty($content)) {
+		
+		if (empty($name) && empty($panel)) {
 			echo 'No name or panel given, just recreate the config file' . PHP_EOL;
 			$this->domainController->createSlaveZoneFile(domain: $domain);
 			exit(1);
 		}
-		if (empty($content)) {
-			$newDomain = new Domain(name: $name, id: $domain->getId(), content: '');
-		} else {
-			$newDomain = new Domain(name: $name, id: $domain->getId(), content: $content);
-		}
+		$newDomain = new Domain(name: $name, panel: $panelName, id: $domain->getId());
+		
 		if ($this->domainRepository->update(domain: $newDomain) !== false) {
 			echo 'Domain server has been updated' . PHP_EOL;
 			$this->domainController->createSlaveZoneFile(domain: $domain);
@@ -1319,4 +1316,36 @@ class BindAPI
 		$this->nameserverRepository->delete(id: $id);
 		echo "The nameserver with ID $id has been deleted." . PHP_EOL;
 	}
+	
+	
+	/**
+	 * @throws \DI\DependencyException
+	 * @throws \DI\NotFoundException
+	 */
+	private function showIncludes()
+	{
+		$nameservers = $this->nameserverRepository->findAll();
+		
+		echo COLOR_DEFAULT . 'You need to add these lines to ' . COLOR_YELLOW . '/etc/bind/local.bindapi.options' . COLOR_DEFAULT . ' and make sure' . PHP_EOL;
+		echo 'that ' . COLOR_YELLOW . 'include "/etc/bind/local.bindapi.options";' . COLOR_DEFAULT . ' exists in ' . COLOR_YELLOW . '/etc/bind/named.conf.options' . COLOR_DEFAULT . '.' . PHP_EOL;
+		$ip = [];
+		foreach ($nameservers as $nameserver) {
+			if (!empty($nameserver->getA())) {
+				$ip[] = $nameserver->getA();
+			}
+			if (!empty($nameserver->getAaaa())) {
+				$ip[] = $nameserver->getAaaa();
+			}
+		}
+		echo PHP_EOL . 'allow-transfer {' . PHP_EOL;
+		foreach ($ip as $currentIp)
+			echo "\t$currentIp;" . PHP_EOL;
+		echo '};';
+		echo PHP_EOL . 'also-notify {' . PHP_EOL;
+		foreach ($ip as $currentIp)
+			echo "\t$currentIp;" . PHP_EOL;
+		echo '};' . PHP_EOL;
+		echo PHP_EOL . 'After the modification feel free to run ' . COLOR_YELLOW . 'named-checkconf' . COLOR_DEFAULT . ' to ensure there were no errors.' . PHP_EOL;
+		
+	}
 }

src/Controller/DatabaseConnection.php

@@ -53,9 +53,7 @@ class DatabaseConnection
 						CREATE TABLE `domains` (
 							`id` int(11) NOT NULL AUTO_INCREMENT,
 							`name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
-							`panel_id` int(11) DEFAULT 0,
-							`a` varbinary(255) DEFAULT NULL,
-							`aaaa` varbinary(255) DEFAULT NULL,
+  							`panel` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
 							PRIMARY KEY (`id`)
 						) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci";
 					$statement = $this->dbConnection->prepare(query: $sql);
@@ -81,7 +79,7 @@ class DatabaseConnection
 							`aaaa` varbinary(255) DEFAULT NULL,
 							`apikey` varbinary(255) DEFAULT NULL,
 							PRIMARY KEY (`id`)
-						) ENGINE=InnoDB AUTO_INCREMENT=28 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci";
+						) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci";
 					$statement = $this->dbConnection->prepare(query: $sql);
 					$statement->execute();
 					

src/Controller/DomainController.php

@@ -117,7 +117,7 @@ class DomainController
 		$bindGroup = posix_getgrnam(name: 'bind');
 		$members = $bindGroup['members'];
 		if (in_array(needle: $name, haystack: $members)) {
-			echo "\t✅ is in group 'bind" . PHP_EOL;
+			echo "\t✅ $name is in group 'bind" . PHP_EOL;
 		} else {
 			echo "\t❌$name needs to be in group $bindGroup!" . PHP_EOL;
 			
@@ -211,15 +211,13 @@ class DomainController
 		
 		// check if we're a master zone
 		$keyhelpConf = file_get_contents(filename: $this->keyhelpNamedCond);
-		if (str_contains($keyhelpConf, $domain->getName())) {
+		if (str_contains(haystack: $keyhelpConf, needle: $domain->getName())) {
 			echo 'We a zone master for ' . $domain->getName() . PHP_EOL;
 			exit(1);
 		}
 		
 		if ($zonefile = fopen(filename: $this->localZonesDir . $domain->getName(), mode: 'w')) {
-			// TODO fixme soon
-			$content = json_decode(json: $domain->getContent());
-			$panelName = $content->panel;
+			$panelName = $domain->getPanel();
 			$panel = $this->panelRepository->findByName(name: $panelName);
 			$a = $panel->getA();
 			$aaaa = $panel->getAaaa();
@@ -237,42 +235,7 @@ class DomainController
 			fputs(stream: $zonefile, data: "};" . PHP_EOL);
 		}
 		$this->createIncludeFile();
-		
-		// TODO add on nameservers
-	}
-	
-	/**
-	 * @param String $panel
-	 *
-	 * @return String
-	 */
-	function createPanelContent(String $panel): String
-	{
-		return json_encode(value: [
-			'panel' => $panel
-			]
-		);
 	}
 	
 	
-	/**
-	 * @param array $ip
-	 *
-	 * @return String
-	 */
-	function createIPContent(array $ip): String
-	{
-		$result = [];
-		if (!empty($ip['a'])) {
-			$result['a'] = $ip['a'];
-		}
-		if (!empty($ip['aaaa'])) {
-			$result['aaaa'] = $ip['aaaa'];
-		}
-		
-		return json_encode(value: [
-				'custom' => $result
-			]
-		);
-	}
 }

src/Controller/RequestController.php

@@ -316,7 +316,7 @@ class RequestController
 				$domain = [
 					'id'    => $result->getId(),
 					'name'  => $result->getName(),
-					'content' => json_decode(json: $result->getContent())
+					'panel' => $result->getPanel()
 				];
 				$this->result = $domain;
 			} else {
@@ -334,7 +334,7 @@ class RequestController
 						$domain = [
 							'id'    => $result->getId(),
 							'name'  => $result->getName(),
-							'content' => json_decode(json: $result->getContent())
+							'panel' => $result->getPanel()
 						];
 						$this->result = $domain;
 					} else {
@@ -342,7 +342,6 @@ class RequestController
 						$this->status = "404 Not Found ";
 						$this->message = "The specified domain was not found.";
 					}
-					
 				} else {
 					$this->header = "400 Bad request";
 					$this->status = "400 Not Found";
@@ -362,31 +361,30 @@ class RequestController
 	{
 		$name = $_POST['name'] ?? '';
 		$panel = $_POST['panel'] ?? '';
-			$content = $_POST['content'] ?? '';
 		if (empty($name)) {
 			$this->header = "400 Bad Request";
 			$this->status = "400 Bad Request";
 			$this->message = "A name is required";
 		} else {
-				if (empty($a) && empty($aaaa) && empty($panel)) {
+			if (empty($panel)) {
 				$this->header = "400 Bad Request";
 				$this->status = "400 Bad Request";
-					$this->message = "At least one IP address or panel ID is required.";
+				$this->message = "A panel ID is required.";
 			} else {
 				if ($this->domainRepository->findByName(name: $name)) {
 					$this->header = "400 Bad request";
 					$this->status = "400 Bad request";
 					$this->message = "Domain: $name already exists.";
 				} else {
-						$domain = new Domain(name: $name, content: $content);
+					$domain = new Domain(name: $name, panel: $panel);
 					if ($result = $this->domainRepository->insert(domain: $domain)) {
+						$this->header = "201 Created";
 						$this->status = "201 Created";
-							$this->message = $result;
 					} else {
 						$this->header = "500 Server error";
 						$this->status = "500 Server error";
-							$this->message = $result;
 					}
+					$this->message = $result;
 				}
 			}
 		}
@@ -396,8 +394,7 @@ class RequestController
 	/**
 	 * @return void
 	 */
-		public
-		function handleDomainPutRequest(): void
+	public function handleDomainPutRequest(): void
 	{
 		$putData = fopen(filename: 'php://input', mode: 'r');
 		$data = fread(stream: $putData, length: 512);
@@ -409,9 +406,10 @@ class RequestController
 		}
 		$id = $put['id'] ?? 0;
 		$name = $put['name'] ?? '';
-			$content = $put['content'] ?? "";
+		$panel = $put['panel'] ?? "";
 		
 		if ($id == 0) {
+			$this->header = "400 Bad Request";
 			$this->status = "400 Bad Request";
 			$this->message = "An ID is required";
 		} else {
@@ -420,15 +418,7 @@ class RequestController
 				$this->message = "Domain with ID : $id doesn't exist.";
 			} else {
 				// TODO not required, as we rely on the ID
-					if (empty($name)) {
-						$this->status = "400 Bad Request";
-						$this->message = "A name is required";
-					} else {
-						if (empty($a) && empty($aaaa)) {
-							$this->status = "400 Bad Request";
-							$this->message = "At least one IP address is required.";
-						} else {
-							$domain = new Domain(name: $name, id: $id, content: $content);
+				$domain = new Domain(name: $name, panel: $panel, id: $id);
 				$this->domainRepository->update(domain: $domain);
 				$this->header = "201 Updated";
 				$this->status = "201 Updated";
@@ -436,8 +426,6 @@ class RequestController
 			}
 		}
 	}
-			}
-		}
 	
 	
 	/**

src/Entity/Domain.php

@@ -14,9 +14,25 @@ class Domain
 	
 	/**
 	 */
-	public function __construct(private string $name, private int $id = 0, private string $content = '')
+	public function __construct(private string $name, private String $panel, private int $id = 0)
 	{}
 	
+	/**
+	 * @return String
+	 */
+	public function getPanel(): string
+	{
+		return $this->panel;
+	}
+	
+	/**
+	 * @param String $panel
+	 */
+	public function setPanel(string $panel): void
+	{
+		$this->panel = $panel;
+	}
+	
 	
 	/**
 	 * @return String
@@ -51,21 +67,4 @@ class Domain
 		$this->id = $id;
 	}
 	
-	/**
-	 * @return string
-	 */
-	public function getContent(): string
-	{
-		return $this->content;
-	}
-	
-	/**
-	 * @param string $content
-	 */
-	public function setContent(string $content): void
-	{
-		$this->content = $content;
-	}
-	
-	
 }

src/Repository/DomainRepository.php

@@ -33,7 +33,7 @@ class DomainRepository
 		
 		$domains = [];
 		$sql = "
-            SELECT id, name, content
+            SELECT id, name, panel
             FROM " . DatabaseConnection::TABLE_DOMAINS . "
             ORDER BY name";
 		
@@ -43,7 +43,7 @@ class DomainRepository
 			while ($result = $statement->fetch(mode: PDO::FETCH_ASSOC)) {
 				//print_r($result);
 				//die();
-				$domain = new Domain(name: $result['name'], id: $result['id'], content: $result['content']);
+				$domain = new Domain(name: $result['name'], panel: $result['panel'], id: $result['id']);
 				$domains[] = $domain;
 			}
 			return $domains;
@@ -75,7 +75,7 @@ class DomainRepository
 			$statement->execute();
 			if ($result = $statement->fetch(mode: PDO::FETCH_ASSOC)) {
 				
-				return new Domain(name: $result['name'], id: $result['id'], content: $result['content']);
+				return new Domain(name: $result['name'], panel: $result['content'], id: $result['id']);
 			} else {
 				return false;
 			}
@@ -105,7 +105,7 @@ class DomainRepository
 			$statement->bindParam(param: ':name', var: $name);
 			$statement->execute();
 			if ($result = $statement->fetch(mode: PDO::FETCH_ASSOC)) {
-				return new Domain(name: $result['name'], id: $result['id'], content: $result['content']);
+				return new Domain(name: $result['name'], panel: $result['content'], id: $result['id']);
 			} else {
 				return false;
 			}
@@ -133,10 +133,10 @@ class DomainRepository
 		
 		try {
 			$name = $domain->getName();
-			$content = $domain->getContent();
+			$panel = $domain->getPanel();
 			$statement = $this->databaseConnection->getConnection()->prepare(query: $sql);
 			$statement->bindParam(param: ':name', var: $name);
-			$statement->bindParam(param: ':content', var: $content);
+			$statement->bindParam(param: ':panel', var: $panel);
 			$statement->execute();
 			
 			return $this->databaseConnection->getConnection()->lastInsertId();
@@ -166,10 +166,10 @@ class DomainRepository
 		} else {
 			$name = $domain->getName();
 		}
-		if (empty($domain->getContent())) {
-			$content = $current->getContent();
+		if (empty($domain->getPanel())) {
+			$content = $current->getPanel();
 		} else {
-			$content = $domain->getContent();
+			$content = $domain->getPanel();
 		}
 		
 		$sql = "