Sop\CryptoTypes\Asymmetric\RSA\RSAPrivateKey

Complexity

Total Complexity

19

Size/Duplication

Total Lines	272
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	toPEM()	0	3	1
A	toDER()	0	3	1
A	fromASN1()	0	19	2
A	exponent1()	0	3	1
A	toASN1()	0	11	1
A	prime1()	0	3	1
A	privateExponent()	0	3	1
A	fromPEM()	0	7	2
A	coefficient()	0	3	1
A	fromDER()	0	3	1
A	prime2()	0	3	1
A	modulus()	0	3	1
A	publicExponent()	0	3	1
A	publicKey()	0	3	1
A	exponent2()	0	3	1
A	algorithmIdentifier()	0	3	1

<?php

declare(strict_types = 1);

namespace Sop\CryptoTypes\Asymmetric\RSA;

use Sop\ASN1\Type\Constructed\Sequence;
use Sop\ASN1\Type\Primitive\Integer;
use Sop\ASN1\Type\UnspecifiedType;
use Sop\CryptoEncoding\PEM;
use Sop\CryptoTypes\AlgorithmIdentifier\Asymmetric\RSAEncryptionAlgorithmIdentifier;
use Sop\CryptoTypes\AlgorithmIdentifier\Feature\AlgorithmIdentifierType;
use Sop\CryptoTypes\Asymmetric\PrivateKey;
use Sop\CryptoTypes\Asymmetric\PublicKey;

/**
 * Implements PKCS #1 RSAPrivateKey ASN.1 type.
 *
 * @see https://tools.ietf.org/html/rfc2437#section-11.1.2
 */
class RSAPrivateKey extends PrivateKey
{
    /**
     * Modulus as a base 10 integer.
     *
     * @var string
     */
    protected $_modulus;

    /**
     * Public exponent as a base 10 integer.
     *
     * @var string
     */
    protected $_publicExponent;

    /**
     * Private exponent as a base 10 integer.
     *
     * @var string
     */
    protected $_privateExponent;

    /**
     * First prime factor as a base 10 integer.
     *
     * @var string
     */
    protected $_prime1;

    /**
     * Second prime factor as a base 10 integer.
     *
     * @var string
     */
    protected $_prime2;

    /**
     * First factor exponent as a base 10 integer.
     *
     * @var string
     */
    protected $_exponent1;

    /**
     * Second factor exponent as a base 10 integer.
     *
     * @var string
     */
    protected $_exponent2;

    /**
     * CRT coefficient of the second factor as a base 10 integer.
     *
     * @var string
     */
    protected $_coefficient;

    /**
     * Constructor.
     *
     * @param int|string $n  Modulus
     * @param int|string $e  Public exponent
     * @param int|string $d  Private exponent
     * @param int|string $p  First prime factor
     * @param int|string $q  Second prime factor
     * @param int|string $dp First factor exponent
     * @param int|string $dq Second factor exponent
     * @param int|string $qi CRT coefficient of the second factor
     */
    public function __construct($n, $e, $d, $p, $q, $dp, $dq, $qi)
    {
        $this->_modulus = strval($n);
        $this->_publicExponent = strval($e);
        $this->_privateExponent = strval($d);
        $this->_prime1 = strval($p);
        $this->_prime2 = strval($q);
        $this->_exponent1 = strval($dp);
        $this->_exponent2 = strval($dq);
        $this->_coefficient = strval($qi);
    }

    /**
     * Initialize from ASN.1.
     *
     * @param Sequence $seq
     *
     * @throws \UnexpectedValueException
     *
     * @return self
     */
    public static function fromASN1(Sequence $seq): RSAPrivateKey
    {
        $version = $seq->at(0)->asInteger()->intNumber();
        if (0 !== $version) {
            throw new \UnexpectedValueException('Version must be 0.');
        }
        // helper function get integer from given index
        $get_int = function ($idx) use ($seq) {
            return $seq->at($idx)->asInteger()->number();
        };
        $n = $get_int(1);
        $e = $get_int(2);
        $d = $get_int(3);
        $p = $get_int(4);
        $q = $get_int(5);
        $dp = $get_int(6);
        $dq = $get_int(7);
        $qi = $get_int(8);
        return new self($n, $e, $d, $p, $q, $dp, $dq, $qi);
    }

    /**
     * Initialize from DER data.
     *
     * @param string $data
     *
     * @return self
     */
    public static function fromDER(string $data): RSAPrivateKey
    {
        return self::fromASN1(UnspecifiedType::fromDER($data)->asSequence());
    }

    /**
     * @see PrivateKey::fromPEM()
     *
     * @param PEM $pem
     *
     * @throws \UnexpectedValueException
     *
     * @return self
     */
    public static function fromPEM(PEM $pem): RSAPrivateKey
    {
        $pk = parent::fromPEM($pem);
        if (!($pk instanceof self)) {
            throw new \UnexpectedValueException('Not an RSA private key.');
        }
        return $pk;
    }

    /**
     * Get modulus.
     *
     * @return string Base 10 integer
     */
    public function modulus(): string
    {
        return $this->_modulus;
    }

    /**
     * Get public exponent.
     *
     * @return string Base 10 integer
     */
    public function publicExponent(): string
    {
        return $this->_publicExponent;
    }

    /**
     * Get private exponent.
     *
     * @return string Base 10 integer
     */
    public function privateExponent(): string
    {
        return $this->_privateExponent;
    }

    /**
     * Get first prime factor.
     *
     * @return string Base 10 integer
     */
    public function prime1(): string
    {
        return $this->_prime1;
    }

    /**
     * Get second prime factor.
     *
     * @return string Base 10 integer
     */
    public function prime2(): string
    {
        return $this->_prime2;
    }

    /**
     * Get first factor exponent.
     *
     * @return string Base 10 integer
     */
    public function exponent1(): string
    {
        return $this->_exponent1;
    }

    /**
     * Get second factor exponent.
     *
     * @return string Base 10 integer
     */
    public function exponent2(): string
    {
        return $this->_exponent2;
    }

    /**
     * Get CRT coefficient of the second factor.
     *
     * @return string Base 10 integer
     */
    public function coefficient(): string
    {
        return $this->_coefficient;
    }

    /**
     * {@inheritdoc}
     */
    public function algorithmIdentifier(): AlgorithmIdentifierType
    {
        return new RSAEncryptionAlgorithmIdentifier();
    }

    /**
     * {@inheritdoc}
     *
     * @return RSAPublicKey
     */
    public function publicKey(): PublicKey
    {
        return new RSAPublicKey($this->_modulus, $this->_publicExponent);
    }

    /**
     * Generate ASN.1 structure.
     *
     * @return Sequence
     */
    public function toASN1(): Sequence
    {
        return new Sequence(new Integer(0),
            new Integer($this->_modulus),
            new Integer($this->_publicExponent),
            new Integer($this->_privateExponent),
            new Integer($this->_prime1),
            new Integer($this->_prime2),
            new Integer($this->_exponent1),
            new Integer($this->_exponent2),
            new Integer($this->_coefficient));
    }

    /**
     * {@inheritdoc}
     */
    public function toDER(): string
    {
        return $this->toASN1()->toDER();
    }

    /**
     * {@inheritdoc}
     */
    public function toPEM(): PEM
    {
        return new PEM(PEM::TYPE_RSA_PRIVATE_KEY, $this->toDER());
    }
}