Compare commits

...

5 Commits

Author SHA1 Message Date
tracer 010914b7bd added test support 2022-10-06 16:18:25 +02:00
tracer c166b5774c modified constructor 2022-09-29 19:26:12 +02:00
tracer 9dca565296 renamed ApiToken to apikey 2022-09-29 19:25:18 +02:00
tracer bc1b9c1204 renamed some inline variables 2022-09-29 19:24:22 +02:00
tracer 402934f02c added encryption to the first functions 2022-09-29 19:23:47 +02:00
5 changed files with 704 additions and 680 deletions

View File

@ -34,11 +34,11 @@ class CommandGroup
echo COLOR_YELLOW . str_pad(string: $this->name, length: $longestCommandLength + 1) . COLOR_WHITE . $this->description . COLOR_DEFAULT . PHP_EOL;
foreach ($this->commands as $command) {
echo COLOR_GREEN . str_pad(string: ' ', length: $longestCommandLength + 1, pad_type: STR_PAD_LEFT) . $this->name . ':' . $command->getName();
foreach ($command->getMandatoryParameters() as $parameter) {
echo ' <' . $parameter . '>';
foreach ($command->getMandatoryParameters() as $optionals) {
echo ' <' . $optionals . '>';
}
foreach ($command->getOptionalParameters() as $parameter) {
echo ' {' . $parameter . '}';
foreach ($command->getOptionalParameters() as $mandatory) {
echo ' {' . $mandatory . '}';
}
echo COLOR_WHITE . ' ' . $command->getDescription();
echo COLOR_DEFAULT . PHP_EOL;

View File

@ -9,7 +9,21 @@ class ConfigController
{
private array $config;
public function __construct(bool $verbose = false, bool $quiet = false) {
/**
* @param bool $verbose
* @param bool $quiet
* @param bool $test
*/
public function __construct(bool $verbose = false, bool $quiet = false, bool $test = false)
{
if ($test) {
$configFile = dirname(path: __DIR__, levels: 2) . "/config.json.test";
if (!file_exists(filename: $configFile)) {
echo 'No testing (config.json.test) config has benn setup.' . PHP_EOL;
die(1);
}
} else {
$configFile = dirname(path: __DIR__, levels: 2) . "/config.json.local";
if (!file_exists(filename: $configFile)) {
$configFile = dirname(path: __DIR__, levels: 2) . "/config.json";
@ -26,6 +40,7 @@ class ConfigController
}
exit(1);
}
}
$configJSON = file_get_contents(filename: $configFile);
if (json_decode(json: $configJSON) === null) {
@ -36,19 +51,13 @@ class ConfigController
$this->config = json_decode(json: $configJSON, associative: true);
if ($verbose) {
$this->config['verbose'] = true;
} else {
$this->config['verbose'] = false;
}
if ($quiet) {
$this->config['quiet'] = true;
} else {
$this->config['quiet'] = false;
}
$this->config['verbose'] = (bool)$verbose;
$this->config['quiet'] = (bool)$quiet;
$this->config['test'] = (bool)$test;
}
public function getConfig(string $configKey): string {
public function getConfig(string $configKey): string
{
return $this->config[$configKey];
}
}

View File

@ -22,17 +22,17 @@ use UnhandledMatchError;
*/
#[OAT\Info(version: '0.0.1', title: 'bindAPI')]
#[OAT\Server(
url : "{schema}://{hostname}/api",
url: "{schema}://{hostname}/api",
description: "The bindAPI URL.",
variables : [
variables: [
new OAT\ServerVariable(
serverVariable: "schema",
default : "https",
enum : ["https", "http"]
default: "https",
enum: ["https", "http"]
),
new OAT\ServerVariable(
serverVariable: "hostname",
default : "ns2.24unix.net",
default: "ns2.24unix.net",
)
]
)]
@ -41,10 +41,10 @@ use UnhandledMatchError;
)]
#[OAT\SecurityScheme(
securityScheme: "Authorization",
type : "apiKey",
description : "description",
name : "X-API-Key",
in : "header"
type: "apiKey",
description: "description",
name: "X-API-Key",
in: "header"
)]
class RequestController
{
@ -63,6 +63,8 @@ class RequestController
* @param DomainRepository $domainRepository
* @param DynDNSRepository $dynDNSRepository
* @param PanelRepository $panelRepository
* @param ConfigController $configController
* @param EncryptionController $encryptionController
* @param Logger $logger
*/
public function __construct(
@ -72,6 +74,8 @@ class RequestController
private readonly DomainRepository $domainRepository,
private readonly DynDNSRepository $dynDNSRepository,
private readonly PanelRepository $panelRepository,
private readonly ConfigController $configController,
private readonly EncryptionController $encryptionController,
private readonly Logger $logger)
{
$this->status = '';
@ -84,29 +88,29 @@ class RequestController
* @return void
*/
#[OAT\Get(
path : '/domains',
path: '/domains',
operationId: 'getAllDomains',
description: 'Returns a list of all domains on this server.',
summary : 'Listing all domains.',
summary: 'Listing all domains.',
// security: [
// 'Authorization' => [
//
// "read:api"
// ]
// ],
servers : [],
tags : ['Domains'],
responses : [
servers: [],
tags: ['Domains'],
responses: [
new OAT\Response(
response : 200,
response: 200,
description: 'OK'
),
new OAT\Response(
response : 401,
response: 401,
description: 'API key is missing or invalid.'
),
new OAT\Response(
response : 404,
response: 404,
description: 'Domain not found.'
)]
)]
@ -207,27 +211,27 @@ class RequestController
#[
OAT\Get(
path : '/domains/{name}',
path: '/domains/{name}',
operationId: 'getSingleDomain',
description: 'Returns information of a single domain specified by its domain name.',
summary : 'Returns a single domain.',
security : [
summary: 'Returns a single domain.',
security: [
],
tags : ['Domains'],
parameters : [
tags: ['Domains'],
parameters: [
new OAT\Parameter(name: 'name', in: 'path', required: true, schema: new OAT\Schema(type: 'string')),
],
responses : [
responses: [
new OAT\Response(
response : 200,
response: 200,
description: 'OK'
),
new OAT\Response(
response : 401,
response: 401,
description: 'API key is missing or invalid.'
),
new OAT\Response(
response : 404,
response: 404,
description: 'Domain not found.'
)]
@ -296,8 +300,11 @@ class RequestController
} else {
[$prefix,] = explode(separator: '.', string: $apiKey);
if ($apiResult = $this->apikeyRepository->findByPrefix(prefix: $prefix)) {
$storedHash = $apiResult->getApiToken();
if (!password_verify(password: $apiKey, hash: $storedHash)) {
$encryptedHash = $apiResult->getApikey();
$encryptionKey = $this->configController->getConfig(configKey: 'encryptionKey');
$decryptedHash = $this->encryptionController->safeDecrypt(encrypted: $encryptedHash, key: $encryptionKey);
if (!password_verify(password: $apiKey, hash: $decryptedHash)) {
$this->status = "401 Unauthorized";
$this->message = "API key mismatch.";
return false;
@ -532,19 +539,19 @@ class RequestController
if (!empty($panel->getAaaa())) {
$domainData = $this->apiController->sendCommand(
requestType: 'GET',
serverName : $panel->getName(),
versionIP : 6,
apiKey : $panel->getApikey(),
command : 'domains/name/' . $domainName,
serverType : 'panel');
serverName: $panel->getName(),
versionIP: 6,
apiKey: $panel->getApikey(),
command: 'domains/name/' . $domainName,
serverType: 'panel');
} else {
$domainData = $this->apiController->sendCommand(
requestType: 'GET',
serverName : $panel->getName(),
versionIP : 4,
apiKey : $panel->getApikey(),
command : 'domains/name/' . $domainName,
serverType : 'panel');
serverName: $panel->getName(),
versionIP: 4,
apiKey: $panel->getApikey(),
command: 'domains/name/' . $domainName,
serverType: 'panel');
}
$domainDecodedData = json_decode(json: $domainData['data']);
@ -553,19 +560,19 @@ class RequestController
if (!empty($panel->getAaaa())) {
$dnsData = $this->apiController->sendCommand(
requestType: 'GET',
serverName : $panel->getName(),
versionIP : 6,
apiKey : $panel->getApikey(),
command : 'dns/' . $domainID,
serverType : 'panel');
serverName: $panel->getName(),
versionIP: 6,
apiKey: $panel->getApikey(),
command: 'dns/' . $domainID,
serverType: 'panel');
} else {
$dnsData = $this->apiController->sendCommand(
requestType: 'GET',
serverName : $panel->getName(),
versionIP : 4,
apiKey : $panel->getApikey(),
command : 'dns/' . $domainID,
serverType : 'panel');
serverName: $panel->getName(),
versionIP: 4,
apiKey: $panel->getApikey(),
command: 'dns/' . $domainID,
serverType: 'panel');
}
$dnsDataDecoded = json_decode(json: $dnsData['data']);
@ -602,22 +609,22 @@ class RequestController
if (!empty($panel->getAaaa())) {
$result = $this->apiController->sendCommand(
requestType: 'PUT',
serverName : $panel->getName(),
versionIP : 6,
apiKey : $panel->getApikey(),
command : 'dns/' . $domainID,
serverType : 'panel',
body : json_decode(json: $newDnsData, associative: true)
serverName: $panel->getName(),
versionIP: 6,
apiKey: $panel->getApikey(),
command: 'dns/' . $domainID,
serverType: 'panel',
body: json_decode(json: $newDnsData, associative: true)
);
} else {
$result = $this->apiController->sendCommand(
requestType: 'PUT',
serverName : $panel->getName(),
versionIP : 4,
apiKey : $panel->getApikey(),
command : 'dns/' . $domainID,
serverType : 'panel',
body : json_decode(json: $newDnsData, associative: true)
serverName: $panel->getName(),
versionIP: 4,
apiKey: $panel->getApikey(),
command: 'dns/' . $domainID,
serverType: 'panel',
body: json_decode(json: $newDnsData, associative: true)
);
}
if ($result['header'] == 200) {

View File

@ -16,8 +16,8 @@ class Apikey
public function __construct(
private int $id = 0,
private string $name = '',
private string $apiTokenPrefix = '',
private string $apiToken = '',
private string $apikey = '',
private string $apikeyPrefix = '',
private readonly string $passphrase = ''
)
{
@ -27,31 +27,39 @@ class Apikey
$encryptionKey = $configController->getConfig(configKey: 'encryptionKey');
$this->apiTokenPrefix = strtok(string: $this->passphrase, token: '.');
$this->apikey = strtok(string: $this->passphrase, token: '.');
try {
$this->apiToken = $encryptionController->safeEncrypt(message: $this->passphrase, key: $encryptionKey);
$this->apikey = $encryptionController->safeEncrypt(message: $this->passphrase, key: $encryptionKey);
} catch (Exception|SodiumException $e) {
die($e->getMessage() . PHP_EOL);
}
}
}
/**
* @return string
*/
public function getPassphrase(): string
{
return $this->passphrase;
}
/**
* @return String
*/
public function getApiToken(): string
public function getApikey(): string
{
return $this->apiToken;
return $this->apikey;
}
/**
* @return string
*/
public function getApiTokenPrefix(): string
public function getApikeyPrefix(): string
{
return $this->apiTokenPrefix;
return $this->apikeyPrefix;
}
@ -80,19 +88,19 @@ class Apikey
}
/**
* @param string $apiTokenPrefix
* @param string $apikeyPrefix
*/
public function setApiTokenPrefix(string $apiTokenPrefix): void
public function setApikeyPrefix(string $apikeyPrefix): void
{
$this->apiTokenPrefix = $apiTokenPrefix;
$this->apikeyPrefix = $apikeyPrefix;
}
/**
* @param String $apiToken
*/
public function setApiToken(string $apiToken): void
public function setApikey(string $apikey): void
{
$this->apiToken = $apiToken;
$this->apikey = $apikey;
}

View File

@ -11,7 +11,7 @@ class DynDNS
/**
*/
public function __construct(private string $name, private string $a, private string $aaaa, private $password = '', private int $id = 0)
public function __construct(private string $name, private string $a = '', private string $aaaa = '', private $password = '', private int $id = 0)
{
}