SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock

Complexity

Total Complexity

13

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getPublicKey()	0	4	1
A	getPlainCertificateContents()	0	6	1
A	getPlainPrivateKey()	0	4	1
A	getPlainPrivateKeyContents()	0	6	1
A	getCertificate()	0	4	1
A	buildCertsPath()	0	4	1
A	getPlainPublicKeyContents()	0	6	1
A	loadPlainCertificateFile()	0	3	1
A	loadPlainKeyFile()	0	3	1
A	buildKeysPath()	0	4	1
A	getPrivateKey()	0	4	1
A	getPlainCertificate()	0	4	1
A	getPlainPublicKey()	0	4	1

<?php

declare(strict_types=1);

namespace SimpleSAML\XMLSecurity\TestUtils;

use Exception;
use SimpleSAML\XMLSecurity\Key\PrivateKey;
use SimpleSAML\XMLSecurity\Key\PublicKey;
use SimpleSAML\XMLSecurity\Key\X509Certificate;
use SimpleSAML\XMLSecurity\Utils\Certificate as CertificateUtils;

use function dirname;
use function file_get_contents;
use function preg_match;
use function preg_replace;
use function trim;

/**
 * Class \SimpleSAML\TestUtils\PEMCertificatesMock
 */
class PEMCertificatesMock
{
    public const CERTS_DIR = 'resources/certificates';
    public const KEYS_DIR = 'resources/keys';
    public const PASSPHRASE = '1234';

    public const CERTIFICATE = 'signed.simplesamlphp.org.crt';
    public const PUBLIC_KEY = 'signed.simplesamlphp.org.pub';
    public const PRIVATE_KEY = 'signed.simplesamlphp.org.key';
    public const OTHER_CERTIFICATE = 'other.simplesamlphp.org.crt';
    public const OTHER_PUBLIC_KEY = 'other.simplesamlphp.org.pub';
    public const OTHER_PRIVATE_KEY = 'other.simplesamlphp.org.key';
    public const SELFSIGNED_CERTIFICATE = 'selfsigned.simplesamlphp.org.crt';
    public const SELFSIGNED_PUBLIC_KEY = 'selfsigned.simplesamlphp.org.pub';
    public const SELFSIGNED_PRIVATE_KEY = 'selfsigned.simplesamlphp.org.key';
    public const BROKEN_CERTIFICATE = 'broken.simplesamlphp.org.crt';
    public const BROKEN_PUBLIC_KEY = 'broken.simplesamlphp.org.pub';
    public const BROKEN_PRIVATE_KEY = 'broken.simplesamlphp.org.key';
    public const CORRUPTED_CERTIFICATE = 'corrupted.simplesamlphp.org.crt';
    public const CORRUPTED_PUBLIC_KEY = 'corrupted.simplesamlphp.org.pub';
    public const CORRUPTED_PRIVATE_KEY = 'corrupted.simplesamlphp.org.key';


    /**
     * @param string $file The file to use
     * @return string
     */
    public static function buildKeysPath(string $file): string
    {
        $base = dirname(__FILE__, 3);
        return 'file://' . $base . DIRECTORY_SEPARATOR . self::KEYS_DIR . DIRECTORY_SEPARATOR . $file;
    }


    /**
     * @param string $file The file to use
     * @return string
     */
    public static function buildCertsPath(string $file): string
    {
        $base = dirname(__FILE__, 3);
        return 'file://' . $base . DIRECTORY_SEPARATOR . self::CERTS_DIR . DIRECTORY_SEPARATOR . $file;
    }


    /**
     * @param string $file The file we should load
     * @return string The file contents
     */
    public static function loadPlainCertificateFile(string $file): string
    {
        return trim(file_get_contents(self::buildCertsPath($file)));
    }


    /**
     * @param string $file The file we should load
     * @return string The file contents
     */
    public static function loadPlainKeyFile(string $file): string
    {
        return trim(file_get_contents(self::buildKeysPath($file)));
    }


    /**
     * @param string $file The file to use
     * @return \SimpleSAML\XMLSecurity\Key\X509Certificate
     */
    public static function getCertificate(string $file): X509Certificate
    {
        $path = self::buildCertsPath($file);
        return X509Certificate::fromFile($path);
    }


    /**
     * @param string $file The file to use
     * @return \SimpleSAML\XMLSecurity\Key\PublicKey
     */
    public static function getPublicKey(string $file): PublicKey
    {
        $path = self::buildKeysPath($file);
        return PublicKey::fromFile($path);
    }


    /**
     * @param string $file The file to use
     * @param string $passphrase The passphrase to use
     * @return \SimpleSAML\XMLSecurity\Key\PrivateKey
     */
    public static function getPrivateKey(string $file, string $passphrase = self::PASSPHRASE): PrivateKey
    {
        $path = self::buildKeysPath($file);
        return PrivateKey::fromFile($path, $passphrase);
    }


    /**
     * @param string $file The file to use
     * @return string
     */
    public static function getPlainCertificate(
        string $file = self::CERTIFICATE
    ): string {
        return self::loadPlainCertificateFile($file);
    }


    /**
     * @param string $file The file to use
     * @return string
     */
    public static function getPlainPublicKey(
        string $file = self::PUBLIC_KEY
    ): string {
        return self::loadPlainKeyFile($file);
    }


    /**
     * @param string $file The file to use
     * @return string
     */
    public static function getPlainPrivateKey(
        string $file = self::PRIVATE_KEY
    ): string {
        return self::loadPlainKeyFile($file);
    }


    /**
     * @param string $file The file to use
     * @return string
     */
    public static function getPlainCertificateContents(
        string $file = self::CERTIFICATE
    ): string {
        return CertificateUtils::stripHeaders(
            self::loadPlainCertificateFile($file),
            CertificateUtils::CERTIFICATE_PATTERN
        );
    }


    /**
     * @param string $file The file to use
     * @return string
     */
    public static function getPlainPublicKeyContents(
        string $file = self::PUBLIC_KEY
    ): string {
        return CertificateUtils::stripHeaders(
            self::loadPlainKeyFile($file),
            CertificateUtils::PUBLIC_KEY_PATTERN
        );
    }


    /**
     * @param string $file The file to use
     * @return string
     */
    public static function getPlainPrivateKeyContents(
        string $file = self::PRIVATE_KEY
    ): string {
        return CertificateUtils::stripHeaders(
            self::loadPlainCertificateFile($file),
            CertificateUtils::PRIVATE_KEY_PATTERN
        );
    }
}