tvdijen / simplesamlphp-module-monitor

src/TestCase/Cert.php

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\monitor\TestCase;

use SimpleSAML\Module\monitor\State;
use SimpleSAML\Module\monitor\TestData;
use SimpleSAML\Module\monitor\TestResult;

use function abs;
use function array_key_exists;
use function intval;

class Cert extends \SimpleSAML\Module\monitor\TestCaseFactory
{
    /** @var array */
    private array $certInfo = [];

    /** @var integer */
    private int $expiration;

    /** @var integer|null */
    private ?int $certExpirationWarning = null;


    /**
     * @var \SimpleSAML\Module\monitor\TestData $testData
     *
     * @return void
     */
    protected function initialize(TestData $testData): void
    {
        $this->setCategory($testData->getInputItem('category'));

It seems like $testData->getInputItem('category') can also be of type null; however, parameter $category of SimpleSAML\Module\monitor\TestCaseFactory::setCategory() does only seem to accept string, maybe add an additional type check?

        $this->setCertInfo($testData->getInputItem('certData'));

It seems like $testData->getInputItem('certData') can also be of type null; however, parameter $certInfo of SimpleSAML\Module\monitor\TestCase\Cert::setCertInfo() does only seem to accept array, maybe add an additional type check?

        $this->setCertExpirationWarning($testData->getInputItem('certExpirationWarning'));

It seems like $testData->getInputItem('certExpirationWarning') can also be of type null; however, parameter $certExpirationWarning of SimpleSAML\Module\monitor\TestCase\Cert::setCertExpirationWarning() does only seem to accept integer, maybe add an additional type check?

        parent::initialize($testData);
    }


    /**
     * @return string
     */
    public function getSubject(): string
    {
        $certInfo = $this->getCertInfo();
        if (
            isset($certInfo['subject'])
            && !empty($certInfo['subject'])
            && array_key_exists('CN', $certInfo['subject'])
        ) {
            return 'CN=' . $certInfo['subject']['CN'];
        } elseif (isset($certInfo['serialNumber'])) {
            return 'SN=' . $certInfo['serialNumber'];
        } else {
            return 'UNKNOWN';
        }
    }


    /**
     * @param array $certInfo
     *
     * @return void
     */
    protected function setCertInfo(array $certInfo): void
    {
        $this->certInfo = $certInfo;
    }


    /**
     * @return array
     */
    protected function getCertInfo(): array
    {
        return $this->certInfo;
    }


    /**
     * @param int $certExpirationWarning
     *
     * @return void
     */
    protected function setCertExpirationWarning(int $certExpirationWarning): void
    {
        $this->certExpirationWarning = $certExpirationWarning;
    }


    /**
     * @return int|null
     */
    protected function getCertExpirationWarning(): ?int
    {
        return $this->certExpirationWarning;
    }


    /**
     * @return int
     */
    protected function getExpiration(): int
    {
        return $this->expiration;
    }


    /**
     * @param integer $expiration
     *
     * @return void
     */
    private function setExpiration(int $expiration): void
    {
        $this->expiration = $expiration;
    }


    /**
     * @return void
     */
    protected function calculateExpiration(): void
    {
        $certInfo = $this->getCertInfo();
        $expiration = intval(($certInfo['validTo_time_t'] - time()) / 86400);
        $this->setExpiration($expiration);
    }


    /**
     * @return void
     */
    public function invokeTest(): void
    {
        $this->calculateExpiration();

        $threshold = $this->getCertExpirationWarning();
        $expiration = $this->getExpiration();

        $days = abs($expiration);
        $daysStr = $days . ' ' . (($days === 1) ? 'day' : 'days');

        $testResult = new TestResult($this->getCategory(), $this->getSubject());

        if ($expiration < 0) {
            $testResult->setState(State::ERROR);
            $testResult->setMessage('Certificate has expired ' . $daysStr . ' ago');
        } elseif ($expiration <= $threshold) {
            $testResult->setState(State::WARNING);
            $testResult->setMessage('Certificate will expire in ' . $daysStr);
        } else {
            $testResult->setState(State::OK);
            $testResult->setMessage('Certificate valid for another ' . $daysStr);
        }

        $testResult->addOutput($expiration, 'expiration');
        $this->setTestResult($testResult);
    }
}