SimpleSAML\XMLSecurity\Key\PrivateKey

Complexity

Total Complexity

6

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	fromFile()	0	21	5

<?php

declare(strict_types=1);

namespace SimpleSAML\XMLSecurity\Key;

use SimpleSAML\Assert\Assert;
use SimpleSAML\XMLSecurity\CryptoEncoding\PEM;
use SimpleSAML\XMLSecurity\Exception\OpenSSLException;

use function openssl_pkey_export;
use function openssl_pkey_get_private;
use function preg_filter;
use function preg_match;

/**
 * A class modeling private keys for their use in asymmetric algorithms.
 *
 * @package simplesamlphp/xml-security
 */
class PrivateKey extends AsymmetricKey
{
    /**
     * Create a new private key from the PEM-encoded key material.
     *
     * @param \SimpleSAML\XMLSecurity\CryptoEncoding\PEM $key The PEM-encoded key material.
     */
    final public function __construct(
        #[\SensitiveParameter]
        PEM $key,
    ) {
        Assert::oneOf(
            $key->type(),
            [PEM::TYPE_PRIVATE_KEY, PEM::TYPE_RSA_PRIVATE_KEY],
            "PEM structure has the wrong type %s.",
        );

        parent::__construct($key);
    }


    /**
     * Get a new private key from a file.
     *
     * @param string $file The file where the PEM-encoded private key is stored.
     * @param string $passphrase An optional passphrase used to decrypt the given key material.
     *
     * @return static A new private key.
     *
     * @throws \SimpleSAML\XMLSecurity\Exception\InvalidArgumentException If the file cannot be read.
     */
    public static function fromFile(
        string $file,
        #[\SensitiveParameter]
        string $passphrase = '',
    ): static {
        if (preg_match(PEM::PEM_REGEX, $file) !== 1) {
            // Not a PEM-encoded key. Must be a file
            if (preg_match('/^(file:\/\/)/Di', $file) !== 1) {
                $file = preg_filter('/^/', 'file://', $file);
            }
        }

        if (($key = openssl_pkey_get_private($file, $passphrase)) === false) {
            throw new OpenSSLException('Failed to read key');
        }

        if (openssl_pkey_export($key, $decrypted) === false) {
            throw new OpenSSLException('Failed to export key');
        }

        return new static(PEM::fromString($decrypted));
    }
}