19137327473

Committed 06 Nov 2025 01:30PM UTC coverage: 39.311%. First build

Build # 19137327473

Build Type

Pull #5757

github

Committed by

web-flow

Commit Message

Merge de2c40b18 into f56fcda6c

Pull Request Pull Request #5757: feat: use crl by cert

Run Details

54 of 116 new or added lines in 11 files covered. (46.55%)

4599 of 11699 relevant lines covered (39.31%)

3.08 hits per line

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

3.36

/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,
                );

                $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 {
                $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']);
        }

        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;
        }

        #[\Override]
        public function generateCrlDer(array $revokedCertificates, string $instanceId, int $generation): string {
                try {
                        $queryParams = [];
                        $queryParams['expiry'] = '168h'; // 7 days * 24 hours

                        $response = $this->getClient()->request('GET', 'crl', [
                                'query' => $queryParams
                        ]);

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

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

                        if (isset($responseData['result']) && is_string($responseData['result'])) {
                                return $responseData['result'];
                        }

                        throw new \RuntimeException('No CRL data returned from CFSSL');

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

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

LibreSign / libresign / 19137327473

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