<?php

/* The MIT License (MIT)
*
* Copyright (c) 2022 Petr Muzikant <pmuzikant@email.cz>
*
* > Permission is hereby granted, free of charge, to any person obtaining a copy
* > of this software and associated documentation files (the "Software"), to deal
* > in the Software without restriction, including without limitation the rights
* > to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* > copies of the Software, and to permit persons to whom the Software is
* > furnished to do so, subject to the following conditions:
* >
* > The above copyright notice and this permission notice shall be included in
* > all copies or substantial portions of the Software.
* >
* > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* > THE SOFTWARE.
*/

declare(strict_types=1);

namespace muzosh\web_eid_authtoken_validation_php\validator\ocsp\service;

use DateTime;
use GuzzleHttp\Psr7\Uri;
use LengthException;
use muzosh\web_eid_authtoken_validation_php\certificate\CertificateValidator;
use muzosh\web_eid_authtoken_validation_php\exceptions\CertificateExpiredException;
use muzosh\web_eid_authtoken_validation_php\exceptions\CertificateNotTrustedException;
use muzosh\web_eid_authtoken_validation_php\exceptions\CertificateNotYetValidException;
use muzosh\web_eid_authtoken_validation_php\exceptions\OCSPCertificateException;
use muzosh\web_eid_authtoken_validation_php\exceptions\UserCertificateOCSPCheckFailedException;
use muzosh\web_eid_authtoken_validation_php\util\TrustedCertificates;
use muzosh\web_eid_authtoken_validation_php\validator\ocsp\OcspResponseValidator;
use muzosh\web_eid_authtoken_validation_php\validator\ocsp\OcspUrl;
use phpseclib3\Exception\InsufficientSetupException;
use phpseclib3\Exception\UnsupportedAlgorithmException;
use phpseclib3\File\X509;
use RangeException;
use RuntimeException;
use TypeError;

/**
 * An OCSP service that uses the responders from the Certificates' Authority Information Access (AIA) extension.
 */
class AiaOcspService implements OcspService
{
    private TrustedCertificates $trustedCertificates;
    private Uri $url;
    private bool $supportsNonce;

    /**
     * @throws UserCertificateOCSPCheckFailedException
     */
    public function __construct(AiaOcspServiceConfiguration $configuration, X509 $certificate)
    {
        $this->trustedCertificates = $configuration->getTrustedCertificates();
        $this->url = self::getOcspAiaUrlFromCertificate($certificate);
        $this->supportsNonce = !$configuration->getNonceDisabledOcspUrls()->inArray($this->url);
    }

    public function doesSupportNonce(): bool
    {
        return $this->supportsNonce;
    }

    public function getAccessLocation(): Uri
    {
        return $this->url;
    }

    /**
     * Validates that the certificate is:\
     * 1) valid on specified date\
     * 2) has id-ce-extKeyUsage extension\
     * 3) is signed by trusted certificate.
     *
     * @throws CertificateNotYetValidException
     * @throws CertificateExpiredException
     * @throws InsufficientSetupException
     * @throws LengthException
     * @throws TypeError
     * @throws OCSPCertificateException
     * @throws RangeException
     * @throws RuntimeException
     * @throws UnsupportedAlgorithmException
     * @throws CertificateNotTrustedException
     */
    public function validateResponderCertificate(X509 $cert, DateTime $producedAt): void
    {
        CertificateValidator::certificateIsValidOnDate($cert, $producedAt, 'AIA OCSP responder');
        // Trusted certificates' validity has been already verified in validateCertificateExpiry().
        OcspResponseValidator::validateHasSigningExtension($cert);
        CertificateValidator::validateIsSignedByTrustedCertificate($cert, $this->trustedCertificates);
    }

    /**
     * @throws UserCertificateOCSPCheckFailedException
     */
    private static function getOcspAiaUrlFromCertificate(X509 $certificate): Uri
    {
        $uri = OcspUrl::getOcspUri($certificate);
        if (null == $uri || false === $uri) {
            throw new UserCertificateOCSPCheckFailedException('Getting the AIA OCSP responder field from the certificate failed');
        }

        return $uri;
    }
}
