shanecurran / phpecc

src/Curves/NistCurve.php

<?php
declare(strict_types=1);

namespace Mdanter\Ecc\Curves;

use Mdanter\Ecc\Math\GmpMathInterface;
use Mdanter\Ecc\Primitives\CurveParameters;
use Mdanter\Ecc\Primitives\GeneratorPoint;
use Mdanter\Ecc\Random\RandomNumberGeneratorInterface;

/**
 * *********************************************************************
 * Copyright (C) 2012 Matyas Danter
 *
 * 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.
 * ***********************************************************************
 */

/**
 * This class encapsulates the NIST recommended curves
 * - fields are Mersenne primes, i.e.
 * for some p, Mersenne_prine = 2^p - 1
 */
class NistCurve
{

    const NAME_P192 = 'nistp192';
    const NAME_P224 = 'nistp224';
    const NAME_P256 = 'nistp256';
    const NAME_P384 = 'nistp384';
    const NAME_P521 = 'nistp521';

    /**
     * @var GmpMathInterface
     */
    private $adapter;

    /**
     * @param GmpMathInterface $adapter
     */
    public function __construct(GmpMathInterface $adapter)
    {
        $this->adapter = $adapter;
    }

    /**
     * Returns an NIST P-192 curve.
     *
     * @return NamedCurveFp
     */
    public function curve192(): NamedCurveFp
    {
        $p = gmp_init('6277101735386680763835789423207666416083908700390324961279', 10);
        $b = gmp_init('64210519e59c80e70fa7e9ab72243049feb8deecc146b9b1', 16);

        $parameters = new CurveParameters(192, $p, gmp_init('-3', 10), $b);

It seems like $b can also be of type resource; however, parameter $b of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like $p can also be of type resource; however, parameter $prime of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like gmp_init('-3', 10) can also be of type resource; however, parameter $a of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

        return new NamedCurveFp(self::NAME_P192, $parameters, $this->adapter);
    }

    /**
     * Returns an NIST P-192 generator.
     *
     * @param  RandomNumberGeneratorInterface $randomGenerator
     * @return GeneratorPoint
     */
    public function generator192(RandomNumberGeneratorInterface $randomGenerator = null): GeneratorPoint
    {
        $curve = $this->curve192();
        $order = gmp_init('6277101735386680763835789423176059013767194773182842284081', 10);

        $x = gmp_init('188da80eb03090f67cbf20eb43a18800f4ff0afd82ff1012', 16);
        $y = gmp_init('07192b95ffc8da78631011ed6b24cdd573f977a11e794811', 16);

        return $curve->getGenerator($x, $y, $order, $randomGenerator);

It seems like $order can also be of type resource; however, parameter $order of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $y can also be of type resource; however, parameter $y of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $x can also be of type resource; however, parameter $x of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

    }

    /**
     * Returns an NIST P-224 curve
     *
     * @return NamedCurveFp
     */
    public function curve224(): NamedCurveFp
    {
        $p = gmp_init('26959946667150639794667015087019630673557916260026308143510066298881', 10);
        $b = gmp_init('b4050a850c04b3abf54132565044b0b7d7bfd8ba270b39432355ffb4', 16);

        $parameters = new CurveParameters(224, $p, gmp_init(-3, 10), $b);

It seems like $p can also be of type resource; however, parameter $prime of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like $b can also be of type resource; however, parameter $b of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like gmp_init(-3, 10) can also be of type resource; however, parameter $a of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

        return new NamedCurveFp(self::NAME_P224, $parameters, $this->adapter);
    }

    /**
     * Returns an NIST P-224 generator.
     *
     * @param  RandomNumberGeneratorInterface $randomGenerator
     * @return GeneratorPoint
     */
    public function generator224(RandomNumberGeneratorInterface $randomGenerator = null): GeneratorPoint
    {
        $curve = $this->curve224();
        $order = gmp_init('26959946667150639794667015087019625940457807714424391721682722368061', 10);

        $x = gmp_init('b70e0cbd6bb4bf7f321390b94a03c1d356c21122343280d6115c1d21', 16);
        $y = gmp_init('bd376388b5f723fb4c22dfe6cd4375a05a07476444d5819985007e34', 16);

        return $curve->getGenerator($x, $y, $order, $randomGenerator);

It seems like $order can also be of type resource; however, parameter $order of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $x can also be of type resource; however, parameter $x of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $y can also be of type resource; however, parameter $y of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

    }

    /**
     * Returns an NIST P-256 curve.
     *
     * @return NamedCurveFp
     */
    public function curve256(): NamedCurveFp
    {
        $p = gmp_init('115792089210356248762697446949407573530086143415290314195533631308867097853951', 10);
        $b = gmp_init('0x5ac635d8aa3a93e7b3ebbd55769886bc651d06b0cc53b0f63bce3c3e27d2604b', 16);

        $parameters = new CurveParameters(256, $p, gmp_init(-3, 10), $b);

It seems like $p can also be of type resource; however, parameter $prime of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like gmp_init(-3, 10) can also be of type resource; however, parameter $a of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like $b can also be of type resource; however, parameter $b of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

        return new NamedCurveFp(self::NAME_P256, $parameters, $this->adapter);
    }

    /**
     * Returns an NIST P-256 generator.
     *
     * @param  RandomNumberGeneratorInterface $randomGenerator
     * @return GeneratorPoint
     */
    public function generator256(RandomNumberGeneratorInterface $randomGenerator = null): GeneratorPoint
    {
        $curve = $this->curve256();
        $order = gmp_init('115792089210356248762697446949407573529996955224135760342422259061068512044369', 10);

        $x = gmp_init('0x6b17d1f2e12c4247f8bce6e563a440f277037d812deb33a0f4a13945d898c296', 16);
        $y = gmp_init('0x4fe342e2fe1a7f9b8ee7eb4a7c0f9e162bce33576b315ececbb6406837bf51f5', 16);

        return $curve->getGenerator($x, $y, $order, $randomGenerator);

It seems like $x can also be of type resource; however, parameter $x of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $order can also be of type resource; however, parameter $order of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $y can also be of type resource; however, parameter $y of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

    }

    /**
     * Returns an NIST P-384 curve.
     *
     * @return NamedCurveFp
     */
    public function curve384(): NamedCurveFp
    {
        $p = gmp_init('39402006196394479212279040100143613805079739270465446667948293404245721771496870329047266088258938001861606973112319', 10);
        $b = gmp_init('0xb3312fa7e23ee7e4988e056be3f82d19181d9c6efe8141120314088f5013875ac656398d8a2ed19d2a85c8edd3ec2aef', 16);

        $parameters = new CurveParameters(384, $p, gmp_init(-3, 10), $b);

It seems like gmp_init(-3, 10) can also be of type resource; however, parameter $a of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like $p can also be of type resource; however, parameter $prime of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like $b can also be of type resource; however, parameter $b of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

        return new NamedCurveFp(self::NAME_P384, $parameters, $this->adapter);
    }

    /**
     * Returns an NIST P-384 generator.
     *
     * @param  RandomNumberGeneratorInterface $randomGenerator
     * @return GeneratorPoint
     */
    public function generator384(RandomNumberGeneratorInterface $randomGenerator = null): GeneratorPoint
    {
        $curve = $this->curve384();
        $order = gmp_init('39402006196394479212279040100143613805079739270465446667946905279627659399113263569398956308152294913554433653942643', 10);

        $x = gmp_init('0xaa87ca22be8b05378eb1c71ef320ad746e1d3b628ba79b9859f741e082542a385502f25dbf55296c3a545e3872760ab7', 16);
        $y = gmp_init('0x3617de4a96262c6f5d9e98bf9292dc29f8f41dbd289a147ce9da3113b5f0b8c00a60b1ce1d7e819d7a431d7c90ea0e5f', 16);

        return $curve->getGenerator($x, $y, $order, $randomGenerator);

It seems like $x can also be of type resource; however, parameter $x of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $y can also be of type resource; however, parameter $y of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $order can also be of type resource; however, parameter $order of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

    }

    /**
     * Returns an NIST P-521 curve.
     *
     * @return NamedCurveFp
     */
    public function curve521(): NamedCurveFp
    {
        $p = gmp_init('6864797660130609714981900799081393217269435300143305409394463459185543183397656052122559640661454554977296311391480858037121987999716643812574028291115057151', 10);
        $b = gmp_init('0x051953eb9618e1c9a1f929a21a0b68540eea2da725b99b315f3b8b489918ef109e156193951ec7e937b1652c0bd3bb1bf073573df883d2c34f1ef451fd46b503f00', 16);

        $parameters = new CurveParameters(521, $p, gmp_init(-3, 10), $b);

It seems like $b can also be of type resource; however, parameter $b of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like gmp_init(-3, 10) can also be of type resource; however, parameter $a of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

It seems like $p can also be of type resource; however, parameter $prime of Mdanter\Ecc\Primitives\CurveParameters::__construct() does only seem to accept GMP, maybe add an additional type check?

        return new NamedCurveFp(self::NAME_P521, $parameters, $this->adapter);
    }

    /**
     * Returns an NIST P-521 generator.
     *
     * @param  RandomNumberGeneratorInterface $randomGenerator
     * @return GeneratorPoint
     */
    public function generator521(RandomNumberGeneratorInterface $randomGenerator = null): GeneratorPoint
    {
        $curve = $this->curve521();
        $order = gmp_init('6864797660130609714981900799081393217269435300143305409394463459185543183397655394245057746333217197532963996371363321113864768612440380340372808892707005449', 10);

        $x = gmp_init('0xc6858e06b70404e9cd9e3ecb662395b4429c648139053fb521f828af606b4d3dbaa14b5e77efe75928fe1dc127a2ffa8de3348b3c1856a429bf97e7e31c2e5bd66', 16);
        $y = gmp_init('0x11839296a789a3bc0045c8a5fb42c7d1bd998f54449579b446817afbd17273e662c97ee72995ef42640c550b9013fad0761353c7086a272c24088be94769fd16650', 16);

        return $curve->getGenerator($x, $y, $order, $randomGenerator);

It seems like $y can also be of type resource; however, parameter $y of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $order can also be of type resource; however, parameter $order of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

It seems like $x can also be of type resource; however, parameter $x of Mdanter\Ecc\Primitives\CurveFp::getGenerator() does only seem to accept GMP, maybe add an additional type check?

    }
}