19835008570

Committed 01 Dec 2025 07:33PM UTC coverage: 40.733%. First build

Build # 19835008570

Build Type

Pull #5863

github

Committed by

web-flow

Commit Message

Merge f2b699f8e into 0f25c05f2

Pull Request Pull Request #5863: feat: root certificate validation

Run Details

63 of 98 new or added lines in 7 files covered. (64.29%)

4932 of 12108 relevant lines covered (40.73%)

3.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

3.58

/lib/Handler/CertificateEngine/CfsslHandler.php

<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2020-2024 LibreCode coop and contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\Libresign\Handler\CertificateEngine;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\ConnectException;
use GuzzleHttp\Exception\RequestException;
use OC\SystemConfig;
use OCA\Libresign\AppInfo\Application;
use OCA\Libresign\Db\CrlMapper;
use OCA\Libresign\Exception\LibresignException;
use OCA\Libresign\Handler\CfsslServerHandler;
use OCA\Libresign\Helper\ConfigureCheckHelper;
use OCA\Libresign\Service\CaIdentifierService;
use OCA\Libresign\Service\CertificatePolicyService;
use OCA\Libresign\Service\Install\InstallService;
use OCP\Files\AppData\IAppDataFactory;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IDateTimeFormatter;
use OCP\ITempManager;
use OCP\IURLGenerator;
use Psr\Log\LoggerInterface;

/**
 * Class CfsslHandler
 *
 * @package OCA\Libresign\Handler
 *
 * @method CfsslHandler setClient(Client $client)
 */
class CfsslHandler extends AEngineHandler implements IEngineHandler {
        public const CFSSL_URI = 'http://127.0.0.1:8888/api/v1/cfssl/';

        /** @var Client */
        protected $client;
        protected $cfsslUri;
        private string $binary = '';

        public function __construct(
                protected IConfig $config,
                protected IAppConfig $appConfig,
                private SystemConfig $systemConfig,
                protected IAppDataFactory $appDataFactory,
                protected IDateTimeFormatter $dateTimeFormatter,
                protected ITempManager $tempManager,
                protected CfsslServerHandler $cfsslServerHandler,
                protected CertificatePolicyService $certificatePolicyService,
                protected IURLGenerator $urlGenerator,
                protected CaIdentifierService $caIdentifierService,
                protected CrlMapper $crlMapper,
                protected LoggerInterface $logger,
        ) {
                parent::__construct(
                        $config,
                        $appConfig,
                        $appDataFactory,
                        $dateTimeFormatter,
                        $tempManager,
                        $certificatePolicyService,
                        $urlGenerator,
                        $caIdentifierService,
                        $logger,
                );

                $this->cfsslServerHandler->configCallback(fn () => $this->getCurrentConfigPath());
        }

        #[\Override]
        public function generateRootCert(
                string $commonName,
                array $names = [],
        ): void {
                $this->cfsslServerHandler->createConfigServer(
                        $commonName,
                        $names,
                        $this->getCaExpiryInDays(),
                        $this->getCrlDistributionUrl(),
                );

                $this->gencert();

                $this->stopIfRunning();

                for ($i = 1; $i <= 4; $i++) {
                        if ($this->isUp()) {
                                break;
                        }
                        sleep(2);
                }
        }

        #[\Override]
        public function generateCertificate(): string {
                $this->validateRootCertificate();

                $certKeys = $this->newCert();
                $pkcs12 = parent::exportToPkcs12(
                        $certKeys['certificate'],
                        $certKeys['private_key'],
                        [
                                'friendly_name' => $this->getFriendlyName(),
                                'extracerts' => [
                                        $certKeys['certificate'],
                                        $certKeys['certificate_request'],
                                ],
                        ],
                );

                $parsed = $this->readCertificate($pkcs12, $this->getPassword());
                $this->persistSerialNumberToCrl($parsed);

                return $pkcs12;
        }

        #[\Override]
        public function isSetupOk(): bool {
                $configPath = $this->getCurrentConfigPath();
                $certificate = file_exists($configPath . DIRECTORY_SEPARATOR . 'ca.pem');
                $privateKey = file_exists($configPath . DIRECTORY_SEPARATOR . 'ca-key.pem');
                if (!$certificate || !$privateKey) {
                        return false;
                }
                try {
                        $this->getClient();
                        return true;
                } catch (\Throwable) {
                }
                return false;
        }

        #[\Override]
        protected function getConfigureCheckResourceName(): string {
                return 'cfssl-configure';
        }

        #[\Override]
        protected function getCertificateRegenerationTip(): string {
                return 'Consider regenerating the root certificate with: occ libresign:configure:cfssl --cn="Your CA Name"';
        }

        #[\Override]
        protected function getEngineSpecificChecks(): array {
                return $this->checkBinaries();
        }

        #[\Override]
        protected function getSetupSuccessMessage(): string {
                return 'Root certificate config files found.';
        }

        #[\Override]
        protected function getSetupErrorMessage(): string {
                return 'CFSSL (root certificate) not configured.';
        }

        #[\Override]
        protected function getSetupErrorTip(): string {
                return 'Run occ libresign:configure:cfssl --help';
        }

        #[\Override]
        public function toArray(): array {
                $return = parent::toArray();
                if (!empty($return['configPath'])) {
                        $return['cfsslUri'] = $this->appConfig->getValueString(Application::APP_ID, 'cfssl_uri');
                }
                return $return;
        }

        public function getCommonName(): string {
                $uid = $this->getUID();
                if (!$uid) {
                        return $this->commonName;
                }
                return $uid . ', ' . $this->commonName;
        }

        private function newCert(): array {
                $json = [
                        'json' => [
                                'profile' => 'client',
                                'request' => [
                                        'hosts' => $this->getHosts(),
                                        'CN' => $this->getCommonName(),
                                        'key' => [
                                                'algo' => 'rsa',
                                                'size' => 2048,
                                        ],
                                        'names' => [],
                                        'crl_url' => $this->getCrlDistributionUrl(),
                                ],
                        ],
                ];

                $names = $this->getNames();
                foreach ($names as $key => $value) {
                        if (!empty($value) && is_array($value)) {
                                $names[$key] = implode(', ', $value);
                        }
                }
                if (!empty($names)) {
                        $json['json']['request']['names'][] = $names;
                }

                try {
                        $response = $this->getClient()
                                ->request('post',
                                        'newcert',
                                        $json
                                )
                        ;
                } catch (RequestException|ConnectException $th) {
                        if ($th->getHandlerContext() && $th->getHandlerContext()['error']) {
                                throw new \Exception($th->getHandlerContext()['error'], 1);
                        }
                        throw new LibresignException($th->getMessage(), 500);
                }

                $responseDecoded = json_decode((string)$response->getBody(), true);
                if (!isset($responseDecoded['success']) || !$responseDecoded['success']) {
                        throw new LibresignException('Error while generating certificate keys!', 500);
                }

                return $responseDecoded['result'];
        }

        private function gencert(): void {
                $binary = $this->getBinary();
                $configPath = $this->getCurrentConfigPath();
                $csrFile = $configPath . '/csr_server.json';

                $cmd = escapeshellcmd($binary) . ' gencert -initca ' . escapeshellarg($csrFile);
                $output = shell_exec($cmd);

                if (!$output) {
                        throw new \RuntimeException('cfssl without output.');
                }

                $json = json_decode($output, true);
                if (!$json || !isset($json['cert'], $json['key'], $json['csr'])) {
                        throw new \RuntimeException('Error generating CA: invalid cfssl output.');
                }

                file_put_contents($configPath . '/ca.pem', $json['cert']);
                file_put_contents($configPath . '/ca-key.pem', $json['key']);
                file_put_contents($configPath . '/ca.csr', $json['csr']);

                $this->persistRootCertificateFromData($json['cert']);
        }

        private function getClient(): Client {
                if (!$this->client) {
                        $this->setClient(new Client(['base_uri' => $this->getCfsslUri()]));
                }
                $this->wakeUp();
                return $this->client;
        }

        private function isUp(): bool {
                try {
                        $client = $this->getClient();
                        if (!$this->portOpen()) {
                                throw new LibresignException('CFSSL server is down', 500);
                        }
                        $response = $client
                                ->request('get',
                                        'health',
                                        [
                                                'base_uri' => $this->getCfsslUri()
                                        ]
                                )
                        ;
                } catch (RequestException|ConnectException $th) {
                        switch ($th->getCode()) {
                                case 404:
                                        throw new \Exception('Endpoint /health of CFSSL server not found. Maybe you are using incompatible version of CFSSL server. Use latests version.', 1);
                                default:
                                        if ($th->getHandlerContext() && $th->getHandlerContext()['error']) {
                                                throw new \Exception($th->getHandlerContext()['error'], 1);
                                        }
                                        throw new LibresignException($th->getMessage(), 500);
                        }
                }

                $responseDecoded = json_decode((string)$response->getBody(), true);
                if (!isset($responseDecoded['success']) || !$responseDecoded['success']) {
                        throw new LibresignException('Error while check cfssl API health!', 500);
                }

                if (empty($responseDecoded['result']) || empty($responseDecoded['result']['healthy'])) {
                        return false;
                }

                return (bool)$responseDecoded['result']['healthy'];
        }

        private function wakeUp(): void {
                if ($this->portOpen()) {
                        return;
                }
                $binary = $this->getBinary();
                $configPath = $this->getCurrentConfigPath();
                if (!$configPath) {
                        throw new LibresignException('CFSSL not configured.');
                }
                $this->cfsslServerHandler->updateExpirity($this->getCaExpiryInDays());
                $cmd = 'nohup ' . $binary . ' serve -address=127.0.0.1 '
                        . '-ca-key ' . $configPath . DIRECTORY_SEPARATOR . 'ca-key.pem '
                        . '-ca ' . $configPath . DIRECTORY_SEPARATOR . 'ca.pem '
                        . '-config ' . $configPath . DIRECTORY_SEPARATOR . 'config_server.json > /dev/null 2>&1 & echo $!';
                shell_exec($cmd);
                $loops = 0;
                while (!$this->portOpen() && $loops <= 4) {
                        sleep(1);
                        $loops++;
                }
        }

        private function portOpen(): bool {
                $host = parse_url($this->getCfsslUri(), PHP_URL_HOST);
                $port = parse_url($this->getCfsslUri(), PHP_URL_PORT);

                set_error_handler(function (): void { });
                $socket = fsockopen($host, $port, $errno, $errstr, 0.1);
                restore_error_handler();
                if (!$socket || $errno || $errstr) {
                        return false;
                }
                fclose($socket);
                return true;
        }

        private function getServerPid(): int {
                $cmd = 'ps -eo pid,command|';
                $cmd .= 'grep "cfssl.*serve.*-address"|'
                        . 'grep -v grep|'
                        . 'grep -v defunct|'
                        . 'sed -e "s/^[[:space:]]*//"|cut -d" " -f1';
                $output = shell_exec($cmd);
                if (!is_string($output)) {
                        return 0;
                }
                $pid = trim($output);
                return (int)$pid;
        }

        /**
         * Parse command
         *
         * Have commands that need to be executed as sudo otherwise don't will work,
         * by example the command runuser or kill. To prevent error when run in a
         * GitHub Actions, these commands are executed prefixed by sudo when exists
         * an environment called GITHUB_ACTIONS.
         */
        private function parseCommand(string $command): string {
                if (getenv('GITHUB_ACTIONS') !== false) {
                        $command = 'sudo ' . $command;
                }
                return $command;
        }

        private function stopIfRunning(): void {
                $pid = $this->getServerPid();
                if ($pid > 0) {
                        exec($this->parseCommand('kill -9 ' . $pid));
                }
        }

        private function getBinary(): string {
                if ($this->binary) {
                        return $this->binary;
                }

                if (PHP_OS_FAMILY === 'Windows') {
                        throw new LibresignException('Incompatible with Windows');
                }

                if ($this->appConfig->hasKey(Application::APP_ID, 'cfssl_bin')) {
                        $binary = $this->appConfig->getValueString(Application::APP_ID, 'cfssl_bin');
                        if (!file_exists($binary)) {
                                $this->appConfig->deleteKey(Application::APP_ID, 'cfssl_bin');
                        }
                        return $binary;
                }
                throw new LibresignException('Binary of CFSSL not found. Install binaries.');
        }

        private function getCfsslUri(): string {
                if ($this->cfsslUri) {
                        return $this->cfsslUri;
                }

                if ($uri = $this->appConfig->getValueString(Application::APP_ID, 'cfssl_uri')) {
                        return $uri;
                }
                $this->appConfig->deleteKey(Application::APP_ID, 'cfssl_uri');

                $this->cfsslUri = self::CFSSL_URI;
                return $this->cfsslUri;
        }

        public function setCfsslUri($uri): void {
                if ($uri) {
                        $this->appConfig->setValueString(Application::APP_ID, 'cfssl_uri', $uri);
                } else {
                        $this->appConfig->deleteKey(Application::APP_ID, 'cfssl_uri');
                }
                $this->cfsslUri = $uri;
        }

        private function checkBinaries(): array {
                if (PHP_OS_FAMILY === 'Windows') {
                        return [
                                (new ConfigureCheckHelper())
                                        ->setErrorMessage('CFSSL is incompatible with Windows')
                                        ->setResource('cfssl'),
                        ];
                }
                $binary = $this->appConfig->getValueString(Application::APP_ID, 'cfssl_bin');
                if (!$binary) {
                        return [
                                (new ConfigureCheckHelper())
                                        ->setErrorMessage('CFSSL not installed.')
                                        ->setResource('cfssl')
                                        ->setTip('Run occ libresign:install --cfssl'),
                        ];
                }

                if (!file_exists($binary)) {
                        return [
                                (new ConfigureCheckHelper())
                                        ->setErrorMessage('CFSSL not found.')
                                        ->setResource('cfssl')
                                        ->setTip('Run occ libresign:install --cfssl'),
                        ];
                }
                $version = shell_exec("$binary version");
                if (!is_string($version) || empty($version)) {
                        return [
                                (new ConfigureCheckHelper())
                                        ->setErrorMessage(sprintf(
                                                'Failed to run the command "%s" with user %s',
                                                "$binary version",
                                                get_current_user()
                                        ))
                                        ->setResource('cfssl')
                                        ->setTip('Run occ libresign:install --cfssl')
                        ];
                }
                preg_match_all('/: (?<version>.*)/', $version, $matches);
                if (!$matches || !isset($matches['version']) || count($matches['version']) !== 2) {
                        return [
                                (new ConfigureCheckHelper())
                                        ->setErrorMessage(sprintf(
                                                'Failed to identify cfssl version with command %s',
                                                "$binary version"
                                        ))
                                        ->setResource('cfssl')
                                        ->setTip('Run occ libresign:install --cfssl')
                        ];
                }
                if (!str_contains($matches['version'][0], InstallService::CFSSL_VERSION)) {
                        return [
                                (new ConfigureCheckHelper())
                                        ->setErrorMessage(sprintf(
                                                'Invalid version. Expected: %s, actual: %s',
                                                InstallService::CFSSL_VERSION,
                                                $matches['version'][0]
                                        ))
                                        ->setResource('cfssl')
                                        ->setTip('Run occ libresign:install --cfssl')
                        ];
                }
                $return = [];
                $return[] = (new ConfigureCheckHelper())
                        ->setSuccessMessage('CFSSL binary path: ' . $binary)
                        ->setResource('cfssl');
                $return[] = (new ConfigureCheckHelper())
                        ->setSuccessMessage('CFSSL version: ' . $matches['version'][0])
                        ->setResource('cfssl');
                $return[] = (new ConfigureCheckHelper())
                        ->setSuccessMessage('Runtime: ' . $matches['version'][1])
                        ->setResource('cfssl');
                return $return;
        }

        /**
         * Get Authority Key Identifier from certificate (needed for CFSSL revocation)
         *
         * @param string $certificatePem PEM encoded certificate
         * @return string Authority Key Identifier in lowercase without colons
         */
        public function getAuthorityKeyId(string $certificatePem): string {
                $cert = openssl_x509_read($certificatePem);
                if (!$cert) {
                        throw new \RuntimeException('Invalid certificate format');
                }

                $parsed = openssl_x509_parse($cert);
                if (!$parsed || !isset($parsed['extensions']['authorityKeyIdentifier'])) {
                        throw new \RuntimeException('Certificate does not contain Authority Key Identifier');
                }

                $authKeyId = $parsed['extensions']['authorityKeyIdentifier'];

                if (preg_match('/keyid:([A-Fa-f0-9:]+)/', $authKeyId, $matches)) {
                        return strtolower(str_replace(':', '', $matches[1]));
                }

                throw new \RuntimeException('Could not parse Authority Key Identifier');
        }

        /**
         * Revoke a certificate using CFSSL API
         *
         * @param string $serialNumber Certificate serial number in decimal format
         * @param string $authorityKeyId Authority key identifier (lowercase, no colons)
         * @param string $reason CRLReason description string (e.g., 'superseded', 'keyCompromise')
         */
        public function revokeCertificate(string $serialNumber, string $authorityKeyId, string $reason): bool {
                try {
                        $json = [
                                'json' => [
                                        'serial' => $serialNumber,
                                        'authority_key_id' => $authorityKeyId,
                                        'reason' => $reason,
                                ],
                        ];

                        $response = $this->getClient()->request('POST', 'revoke', $json);

                        $responseData = json_decode((string)$response->getBody(), true);

                        if (!isset($responseData['success'])) {
                                $errorMessage = isset($responseData['errors'])
                                        ? implode(', ', array_column($responseData['errors'], 'message'))
                                        : 'Unknown CFSSL error';
                                throw new \RuntimeException('CFSSL revocation failed: ' . $errorMessage);
                        }

                        return $responseData['success'];

                } catch (RequestException|ConnectException $e) {
                        throw new \RuntimeException('Failed to communicate with CFSSL server: ' . $e->getMessage());
                } catch (\Throwable $e) {
                        throw new \RuntimeException('CFSSL certificate revocation error: ' . $e->getMessage());
                }
        }

        private function persistSerialNumberToCrl(array $parsed): void {
                if (!isset($parsed['serialNumberHex']) || !isset($parsed['valid_to'])) {
                        return;
                }

                $serialNumber = $parsed['serialNumberHex'];

                $owner = $this->getCommonName() ?? 'Unknown';

                $expiresAt = null;
                if (isset($parsed['validTo_time_t'])) {
                        $expiresAt = new \DateTime('@' . $parsed['validTo_time_t']);
                }

                $this->crlMapper->createCertificate(
                        $serialNumber,
                        $owner,
                        'cfssl',
                        $this->caIdentifierService->getInstanceId(),
                        $this->caIdentifierService->getCaIdParsed()['generation'],
                        new \DateTime(),
                        $expiresAt
                );
        }

        private function persistRootCertificateFromData(string $certPem): void {
                $x509Resource = openssl_x509_read($certPem);
                if (!$x509Resource) {
                        throw new \RuntimeException('Failed to parse root certificate');
                }

                $parsed = openssl_x509_parse($x509Resource);
                if (!$parsed) {
                        throw new \RuntimeException('Failed to extract root certificate information');
                }

                $serialNumber = $parsed['serialNumberHex'] ?? '';
                if (empty($serialNumber)) {
                        throw new \RuntimeException('Root certificate has no serial number');
                }

                $owner = $this->getCommonName() ?? 'Root CA';

                $expiresAt = null;
                if (isset($parsed['validTo_time_t'])) {
                        $expiresAt = new \DateTime('@' . $parsed['validTo_time_t']);
                }

                $this->crlMapper->createCertificate(
                        $serialNumber,
                        $owner,
                        'cfssl',
                        $this->caIdentifierService->getInstanceId(),
                        $this->caIdentifierService->getCaIdParsed()['generation'],
                        new \DateTime(),
                        $expiresAt
                );
        }
}

1	<?php
2
3	declare(strict_types=1);
4	/**
5	* SPDX-FileCopyrightText: 2020-2024 LibreCode coop and contributors
6	* SPDX-License-Identifier: AGPL-3.0-or-later
7	*/
8
9	namespace OCA\Libresign\Handler\CertificateEngine;
10
11	use GuzzleHttp\Client;
12	use GuzzleHttp\Exception\ConnectException;
13	use GuzzleHttp\Exception\RequestException;
14	use OC\SystemConfig;
15	use OCA\Libresign\AppInfo\Application;
16	use OCA\Libresign\Db\CrlMapper;
17	use OCA\Libresign\Exception\LibresignException;
18	use OCA\Libresign\Handler\CfsslServerHandler;
19	use OCA\Libresign\Helper\ConfigureCheckHelper;
20	use OCA\Libresign\Service\CaIdentifierService;
21	use OCA\Libresign\Service\CertificatePolicyService;
22	use OCA\Libresign\Service\Install\InstallService;
23	use OCP\Files\AppData\IAppDataFactory;
24	use OCP\IAppConfig;
25	use OCP\IConfig;
26	use OCP\IDateTimeFormatter;
27	use OCP\ITempManager;
28	use OCP\IURLGenerator;
29	use Psr\Log\LoggerInterface;
30
31	/**
32	* Class CfsslHandler
33	*
34	* @package OCA\Libresign\Handler
35	*
36	* @method CfsslHandler setClient(Client $client)
37	*/
38	class CfsslHandler extends AEngineHandler implements IEngineHandler {
39	public const CFSSL_URI = 'http://127.0.0.1:8888/api/v1/cfssl/';
40
41	/** @var Client */
42	protected $client;
43	protected $cfsslUri;
44	private string $binary = '';
45
46	public function __construct(
47	protected IConfig $config,
48	protected IAppConfig $appConfig,
49	private SystemConfig $systemConfig,
50	protected IAppDataFactory $appDataFactory,
51	protected IDateTimeFormatter $dateTimeFormatter,
52	protected ITempManager $tempManager,
53	protected CfsslServerHandler $cfsslServerHandler,
54	protected CertificatePolicyService $certificatePolicyService,
55	protected IURLGenerator $urlGenerator,
56	protected CaIdentifierService $caIdentifierService,
57	protected CrlMapper $crlMapper,
58	protected LoggerInterface $logger,
59	) {
60	parent::__construct(	56✔
61	$config,	56✔
62	$appConfig,	56✔
63	$appDataFactory,	56✔
64	$dateTimeFormatter,	56✔
65	$tempManager,	56✔
66	$certificatePolicyService,	56✔
67	$urlGenerator,	56✔
68	$caIdentifierService,	56✔
69	$logger,	56✔
70	);	56✔
71
72	$this->cfsslServerHandler->configCallback(fn () => $this->getCurrentConfigPath());	56✔
73	}
74
75	#[\Override]
76	public function generateRootCert(
77	string $commonName,
78	array $names = [],
79	): void {
80	$this->cfsslServerHandler->createConfigServer(	×
81	$commonName,	×
82	$names,	×
83	$this->getCaExpiryInDays(),	×
84	$this->getCrlDistributionUrl(),	×
85	);	×
86
87	$this->gencert();	×
88
89	$this->stopIfRunning();	×
90
91	for ($i = 1; $i <= 4; $i++) {	×
92	if ($this->isUp()) {	×
93	break;	×
94	}
95	sleep(2);	×
96	}
97	}
98
99	#[\Override]
100	public function generateCertificate(): string {
NEW 101	$this->validateRootCertificate();	×
102
103	$certKeys = $this->newCert();	×
104	$pkcs12 = parent::exportToPkcs12(	×
105	$certKeys['certificate'],	×
106	$certKeys['private_key'],	×
107	[	×
108	'friendly_name' => $this->getFriendlyName(),	×
109	'extracerts' => [	×
110	$certKeys['certificate'],	×
111	$certKeys['certificate_request'],	×
112	],	×
113	],	×
114	);	×
115
116	$parsed = $this->readCertificate($pkcs12, $this->getPassword());	×
117	$this->persistSerialNumberToCrl($parsed);	×
118
119	return $pkcs12;	×
120	}
121
122	#[\Override]
123	public function isSetupOk(): bool {
124	$configPath = $this->getCurrentConfigPath();	×
125	$certificate = file_exists($configPath . DIRECTORY_SEPARATOR . 'ca.pem');	×
126	$privateKey = file_exists($configPath . DIRECTORY_SEPARATOR . 'ca-key.pem');	×
127	if (!$certificate \|\| !$privateKey) {	×
128	return false;	×
129	}
130	try {
131	$this->getClient();	×
132	return true;	×
133	} catch (\Throwable) {	×
134	}
135	return false;	×
136	}
137
138	#[\Override]
139	protected function getConfigureCheckResourceName(): string {
140	return 'cfssl-configure';	×
141	}
142
143	#[\Override]
144	protected function getCertificateRegenerationTip(): string {
145	return 'Consider regenerating the root certificate with: occ libresign:configure:cfssl --cn="Your CA Name"';	×
146	}
147
148	#[\Override]
149	protected function getEngineSpecificChecks(): array {
150	return $this->checkBinaries();	×
151	}
152
153	#[\Override]
154	protected function getSetupSuccessMessage(): string {
155	return 'Root certificate config files found.';	×
156	}
157
158	#[\Override]
159	protected function getSetupErrorMessage(): string {
160	return 'CFSSL (root certificate) not configured.';	×
161	}
162
163	#[\Override]
164	protected function getSetupErrorTip(): string {
165	return 'Run occ libresign:configure:cfssl --help';	×
166	}
167
168	#[\Override]
169	public function toArray(): array {
170	$return = parent::toArray();	×
171	if (!empty($return['configPath'])) {	×
172	$return['cfsslUri'] = $this->appConfig->getValueString(Application::APP_ID, 'cfssl_uri');	×
173	}
174	return $return;	×
175	}
176
177	public function getCommonName(): string {
178	$uid = $this->getUID();	×
179	if (!$uid) {	×
180	return $this->commonName;	×
181	}
182	return $uid . ', ' . $this->commonName;	×
183	}
184
185	private function newCert(): array {
186	$json = [	×
187	'json' => [	×
188	'profile' => 'client',	×
189	'request' => [	×
190	'hosts' => $this->getHosts(),	×
191	'CN' => $this->getCommonName(),	×
192	'key' => [	×
193	'algo' => 'rsa',	×
194	'size' => 2048,	×
195	],	×
196	'names' => [],	×
197	'crl_url' => $this->getCrlDistributionUrl(),	×
198	],	×
199	],	×
200	];	×
201
202	$names = $this->getNames();	×
203	foreach ($names as $key => $value) {	×
204	if (!empty($value) && is_array($value)) {	×
205	$names[$key] = implode(', ', $value);	×
206	}
207	}
208	if (!empty($names)) {	×
209	$json['json']['request']['names'][] = $names;	×
210	}
211
212	try {
213	$response = $this->getClient()	×
214	->request('post',	×
215	'newcert',	×
216	$json	×
217	)	×
218	;	×
219	} catch (RequestException\|ConnectException $th) {	×
220	if ($th->getHandlerContext() && $th->getHandlerContext()['error']) {	×
221	throw new \Exception($th->getHandlerContext()['error'], 1);	×
222	}
223	throw new LibresignException($th->getMessage(), 500);	×
224	}
225
226	$responseDecoded = json_decode((string)$response->getBody(), true);	×
227	if (!isset($responseDecoded['success']) \|\| !$responseDecoded['success']) {	×
228	throw new LibresignException('Error while generating certificate keys!', 500);	×
229	}
230
231	return $responseDecoded['result'];	×
232	}
233
234	private function gencert(): void {
235	$binary = $this->getBinary();	×
236	$configPath = $this->getCurrentConfigPath();	×
237	$csrFile = $configPath . '/csr_server.json';	×
238
239	$cmd = escapeshellcmd($binary) . ' gencert -initca ' . escapeshellarg($csrFile);	×
240	$output = shell_exec($cmd);	×
241
242	if (!$output) {	×
243	throw new \RuntimeException('cfssl without output.');	×
244	}
245
246	$json = json_decode($output, true);	×
247	if (!$json \|\| !isset($json['cert'], $json['key'], $json['csr'])) {	×
248	throw new \RuntimeException('Error generating CA: invalid cfssl output.');	×
249	}
250
251	file_put_contents($configPath . '/ca.pem', $json['cert']);	×
252	file_put_contents($configPath . '/ca-key.pem', $json['key']);	×
253	file_put_contents($configPath . '/ca.csr', $json['csr']);	×
254
255	$this->persistRootCertificateFromData($json['cert']);	×
256	}
257
258	private function getClient(): Client {
259	if (!$this->client) {	×
260	$this->setClient(new Client(['base_uri' => $this->getCfsslUri()]));	×
261	}
262	$this->wakeUp();	×
263	return $this->client;	×
264	}
265
266	private function isUp(): bool {
267	try {
268	$client = $this->getClient();	×
269	if (!$this->portOpen()) {	×
270	throw new LibresignException('CFSSL server is down', 500);	×
271	}
272	$response = $client	×
273	->request('get',	×
274	'health',	×
275	[	×
276	'base_uri' => $this->getCfsslUri()	×
277	]	×
278	)	×
279	;	×
280	} catch (RequestException\|ConnectException $th) {	×
281	switch ($th->getCode()) {	×
282	case 404:	×
283	throw new \Exception('Endpoint /health of CFSSL server not found. Maybe you are using incompatible version of CFSSL server. Use latests version.', 1);	×
284	default:
285	if ($th->getHandlerContext() && $th->getHandlerContext()['error']) {	×
286	throw new \Exception($th->getHandlerContext()['error'], 1);	×
287	}
288	throw new LibresignException($th->getMessage(), 500);	×
289	}
290	}
291
292	$responseDecoded = json_decode((string)$response->getBody(), true);	×
293	if (!isset($responseDecoded['success']) \|\| !$responseDecoded['success']) {	×
294	throw new LibresignException('Error while check cfssl API health!', 500);	×
295	}
296
297	if (empty($responseDecoded['result']) \|\| empty($responseDecoded['result']['healthy'])) {	×
298	return false;	×
299	}
300
301	return (bool)$responseDecoded['result']['healthy'];	×
302	}
303
304	private function wakeUp(): void {
305	if ($this->portOpen()) {	×
306	return;	×
307	}
308	$binary = $this->getBinary();	×
309	$configPath = $this->getCurrentConfigPath();	×
310	if (!$configPath) {	×
311	throw new LibresignException('CFSSL not configured.');	×
312	}
313	$this->cfsslServerHandler->updateExpirity($this->getCaExpiryInDays());	×
314	$cmd = 'nohup ' . $binary . ' serve -address=127.0.0.1 '	×
315	. '-ca-key ' . $configPath . DIRECTORY_SEPARATOR . 'ca-key.pem '	×
316	. '-ca ' . $configPath . DIRECTORY_SEPARATOR . 'ca.pem '	×
317	. '-config ' . $configPath . DIRECTORY_SEPARATOR . 'config_server.json > /dev/null 2>&1 & echo $!';	×
318	shell_exec($cmd);	×
319	$loops = 0;	×
320	while (!$this->portOpen() && $loops <= 4) {	×
321	sleep(1);	×
322	$loops++;	×
323	}
324	}
325
326	private function portOpen(): bool {
327	$host = parse_url($this->getCfsslUri(), PHP_URL_HOST);	×
328	$port = parse_url($this->getCfsslUri(), PHP_URL_PORT);	×
329
330	set_error_handler(function (): void { });	×
331	$socket = fsockopen($host, $port, $errno, $errstr, 0.1);	×
332	restore_error_handler();	×
333	if (!$socket \|\| $errno \|\| $errstr) {	×
334	return false;	×
335	}
336	fclose($socket);	×
337	return true;	×
338	}
339
340	private function getServerPid(): int {
341	$cmd = 'ps -eo pid,command\|';	×
342	$cmd .= 'grep "cfssl.serve.-address"\|'	×
343	. 'grep -v grep\|'	×
344	. 'grep -v defunct\|'	×
345	. 'sed -e "s/^[[:space:]]*//"\|cut -d" " -f1';	×
346	$output = shell_exec($cmd);	×
347	if (!is_string($output)) {	×
348	return 0;	×
349	}
350	$pid = trim($output);	×
351	return (int)$pid;	×
352	}
353
354	/**
355	* Parse command
356	*
357	* Have commands that need to be executed as sudo otherwise don't will work,
358	* by example the command runuser or kill. To prevent error when run in a
359	* GitHub Actions, these commands are executed prefixed by sudo when exists
360	* an environment called GITHUB_ACTIONS.
361	*/
362	private function parseCommand(string $command): string {
363	if (getenv('GITHUB_ACTIONS') !== false) {	×
364	$command = 'sudo ' . $command;	×
365	}
366	return $command;	×
367	}
368
369	private function stopIfRunning(): void {
370	$pid = $this->getServerPid();	×
371	if ($pid > 0) {	×
372	exec($this->parseCommand('kill -9 ' . $pid));	×
373	}
374	}
375
376	private function getBinary(): string {
377	if ($this->binary) {	×
378	return $this->binary;	×
379	}
380
381	if (PHP_OS_FAMILY === 'Windows') {	×
382	throw new LibresignException('Incompatible with Windows');	×
383	}
384
385	if ($this->appConfig->hasKey(Application::APP_ID, 'cfssl_bin')) {	×
386	$binary = $this->appConfig->getValueString(Application::APP_ID, 'cfssl_bin');	×
387	if (!file_exists($binary)) {	×
388	$this->appConfig->deleteKey(Application::APP_ID, 'cfssl_bin');	×
389	}
390	return $binary;	×
391	}
392	throw new LibresignException('Binary of CFSSL not found. Install binaries.');	×
393	}
394
395	private function getCfsslUri(): string {
396	if ($this->cfsslUri) {	×
397	return $this->cfsslUri;	×
398	}
399
400	if ($uri = $this->appConfig->getValueString(Application::APP_ID, 'cfssl_uri')) {	×
401	return $uri;	×
402	}
403	$this->appConfig->deleteKey(Application::APP_ID, 'cfssl_uri');	×
404
405	$this->cfsslUri = self::CFSSL_URI;	×
406	return $this->cfsslUri;	×
407	}
408
409	public function setCfsslUri($uri): void {
410	if ($uri) {	×
411	$this->appConfig->setValueString(Application::APP_ID, 'cfssl_uri', $uri);	×
412	} else {
413	$this->appConfig->deleteKey(Application::APP_ID, 'cfssl_uri');	×
414	}
415	$this->cfsslUri = $uri;	×
416	}
417
418	private function checkBinaries(): array {
419	if (PHP_OS_FAMILY === 'Windows') {	×
420	return [	×
421	(new ConfigureCheckHelper())	×
422	->setErrorMessage('CFSSL is incompatible with Windows')	×
423	->setResource('cfssl'),	×
424	];	×
425	}
426	$binary = $this->appConfig->getValueString(Application::APP_ID, 'cfssl_bin');	×
427	if (!$binary) {	×
428	return [	×
429	(new ConfigureCheckHelper())	×
430	->setErrorMessage('CFSSL not installed.')	×
431	->setResource('cfssl')	×
432	->setTip('Run occ libresign:install --cfssl'),	×
433	];	×
434	}
435
436	if (!file_exists($binary)) {	×
437	return [	×
438	(new ConfigureCheckHelper())	×
439	->setErrorMessage('CFSSL not found.')	×
440	->setResource('cfssl')	×
441	->setTip('Run occ libresign:install --cfssl'),	×
442	];	×
443	}
444	$version = shell_exec("$binary version");	×
445	if (!is_string($version) \|\| empty($version)) {	×
446	return [	×
447	(new ConfigureCheckHelper())	×
448	->setErrorMessage(sprintf(	×
449	'Failed to run the command "%s" with user %s',	×
450	"$binary version",	×
451	get_current_user()	×
452	))	×
453	->setResource('cfssl')	×
454	->setTip('Run occ libresign:install --cfssl')	×
455	];	×
456	}
457	preg_match_all('/: (?<version>.*)/', $version, $matches);	×
458	if (!$matches \|\| !isset($matches['version']) \|\| count($matches['version']) !== 2) {	×
459	return [	×
460	(new ConfigureCheckHelper())	×
461	->setErrorMessage(sprintf(	×
462	'Failed to identify cfssl version with command %s',	×
463	"$binary version"	×
464	))	×
465	->setResource('cfssl')	×
466	->setTip('Run occ libresign:install --cfssl')	×
467	];	×
468	}
469	if (!str_contains($matches['version'][0], InstallService::CFSSL_VERSION)) {	×
470	return [	×
471	(new ConfigureCheckHelper())	×
472	->setErrorMessage(sprintf(	×
473	'Invalid version. Expected: %s, actual: %s',	×
474	InstallService::CFSSL_VERSION,	×
475	$matches['version'][0]	×
476	))	×
477	->setResource('cfssl')	×
478	->setTip('Run occ libresign:install --cfssl')	×
479	];	×
480	}
481	$return = [];	×
482	$return[] = (new ConfigureCheckHelper())	×
483	->setSuccessMessage('CFSSL binary path: ' . $binary)	×
484	->setResource('cfssl');	×
485	$return[] = (new ConfigureCheckHelper())	×
486	->setSuccessMessage('CFSSL version: ' . $matches['version'][0])	×
487	->setResource('cfssl');	×
488	$return[] = (new ConfigureCheckHelper())	×
489	->setSuccessMessage('Runtime: ' . $matches['version'][1])	×
490	->setResource('cfssl');	×
491	return $return;	×
492	}
493
494	/**
495	* Get Authority Key Identifier from certificate (needed for CFSSL revocation)
496	*
497	* @param string $certificatePem PEM encoded certificate
498	* @return string Authority Key Identifier in lowercase without colons
499	*/
500	public function getAuthorityKeyId(string $certificatePem): string {
501	$cert = openssl_x509_read($certificatePem);	×
502	if (!$cert) {	×
503	throw new \RuntimeException('Invalid certificate format');	×
504	}
505
506	$parsed = openssl_x509_parse($cert);	×
507	if (!$parsed \|\| !isset($parsed['extensions']['authorityKeyIdentifier'])) {	×
508	throw new \RuntimeException('Certificate does not contain Authority Key Identifier');	×
509	}
510
511	$authKeyId = $parsed['extensions']['authorityKeyIdentifier'];	×
512
513	if (preg_match('/keyid:([A-Fa-f0-9:]+)/', $authKeyId, $matches)) {	×
514	return strtolower(str_replace(':', '', $matches[1]));	×
515	}
516
517	throw new \RuntimeException('Could not parse Authority Key Identifier');	×
518	}
519
520	/**
521	* Revoke a certificate using CFSSL API
522	*
523	* @param string $serialNumber Certificate serial number in decimal format
524	* @param string $authorityKeyId Authority key identifier (lowercase, no colons)
525	* @param string $reason CRLReason description string (e.g., 'superseded', 'keyCompromise')
526	*/
527	public function revokeCertificate(string $serialNumber, string $authorityKeyId, string $reason): bool {
528	try {
529	$json = [	×
530	'json' => [	×
531	'serial' => $serialNumber,	×
532	'authority_key_id' => $authorityKeyId,	×
533	'reason' => $reason,	×
534	],	×
535	];	×
536
537	$response = $this->getClient()->request('POST', 'revoke', $json);	×
538
539	$responseData = json_decode((string)$response->getBody(), true);	×
540
541	if (!isset($responseData['success'])) {	×
542	$errorMessage = isset($responseData['errors'])	×
543	? implode(', ', array_column($responseData['errors'], 'message'))	×
544	: 'Unknown CFSSL error';	×
545	throw new \RuntimeException('CFSSL revocation failed: ' . $errorMessage);	×
546	}
547
548	return $responseData['success'];	×
549
550	} catch (RequestException\|ConnectException $e) {	×
551	throw new \RuntimeException('Failed to communicate with CFSSL server: ' . $e->getMessage());	×
552	} catch (\Throwable $e) {	×
553	throw new \RuntimeException('CFSSL certificate revocation error: ' . $e->getMessage());	×
554	}
555	}
556
557	private function persistSerialNumberToCrl(array $parsed): void {
558	if (!isset($parsed['serialNumberHex']) \|\| !isset($parsed['valid_to'])) {	×
559	return;	×
560	}
561
562	$serialNumber = $parsed['serialNumberHex'];	×
563
564	$owner = $this->getCommonName() ?? 'Unknown';	×
565
566	$expiresAt = null;	×
567	if (isset($parsed['validTo_time_t'])) {	×
568	$expiresAt = new \DateTime('@' . $parsed['validTo_time_t']);	×
569	}
570
571	$this->crlMapper->createCertificate(	×
572	$serialNumber,	×
573	$owner,	×
574	'cfssl',	×
575	$this->caIdentifierService->getInstanceId(),	×
576	$this->caIdentifierService->getCaIdParsed()['generation'],	×
577	new \DateTime(),	×
578	$expiresAt	×
579	);	×
580	}
581
582	private function persistRootCertificateFromData(string $certPem): void {
583	$x509Resource = openssl_x509_read($certPem);	×
584	if (!$x509Resource) {	×
585	throw new \RuntimeException('Failed to parse root certificate');	×
586	}
587
588	$parsed = openssl_x509_parse($x509Resource);	×
589	if (!$parsed) {	×
590	throw new \RuntimeException('Failed to extract root certificate information');	×
591	}
592
593	$serialNumber = $parsed['serialNumberHex'] ?? '';	×
594	if (empty($serialNumber)) {	×
595	throw new \RuntimeException('Root certificate has no serial number');	×
596	}
597
598	$owner = $this->getCommonName() ?? 'Root CA';	×
599
600	$expiresAt = null;	×
601	if (isset($parsed['validTo_time_t'])) {	×
602	$expiresAt = new \DateTime('@' . $parsed['validTo_time_t']);	×
603	}
604
605	$this->crlMapper->createCertificate(	×
606	$serialNumber,	×
607	$owner,	×
608	'cfssl',	×
609	$this->caIdentifierService->getInstanceId(),	×
610	$this->caIdentifierService->getCaIdParsed()['generation'],	×
611	new \DateTime(),	×
612	$expiresAt	×
613	);	×
614	}
615	}

LibreSign / libresign / 19835008570

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous