Jose\Component\Core\Util\Ecc\Math\NumberTheory

Complexity

Total Complexity

29

Size/Duplication

Total Lines	233
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	polynomialReduceMod()	0	31	6
B	polynomialMultiplyMod()	0	29	4
B	polynomialPowMod()	0	36	6
C	squareRootModP()	0	93	12

<?php

namespace Jose\Component\Core\Util\Ecc\Math;

/***********************************************************************
     * 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.
     ************************************************************************/

/**
 * Implementation of some number theoretic algorithms
 *
 * @author Matyas Danter
 */

/**
 * Rewritten to take a MathAdaptor to handle different environments. Has
 * some desireable functions for public key compression/recovery.
 */
final class NumberTheory
{
    /**
     * @var GmpMath
     */
    protected $adapter;

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

    /**
     * @param \GMP[] $poly
     * @param $polymod
     * @param $p
     * @return array
     */
    public function polynomialReduceMod($poly, $polymod, $p): array
    {
        $adapter = $this->adapter;
        $count_polymod = count($polymod);
        if ($adapter->equals(end($polymod), gmp_init(1)) && $count_polymod > 1) {
            $zero = gmp_init(0);
            while (count($poly) >= $count_polymod) {
                if (!$adapter->equals(end($poly), $zero)) {
                    for ($i = 2; $i < $count_polymod + 1; $i++) {
                        $poly[count($poly) - $i] =
                            $adapter->mod(
                                $adapter->sub(
                                    $poly[count($poly) - $i],
                                    $adapter->mul(
                                        end($poly),
                                        $polymod[$count_polymod - $i]
                                    )
                                ),
                                $p
                            );
                    }
                }

                $poly = array_slice($poly, 0, count($poly) - 1);
            }

            return $poly;
        }

        throw new \InvalidArgumentException('Unable to calculate polynomialReduceMod');
    }

    /**
     * @param $m1
     * @param $m2
     * @param $polymod
     * @param $p
     * @return array
     */
    public function polynomialMultiplyMod($m1, $m2, $polymod, $p): array
    {
        $prod = array();
        $cm1 = count($m1);
        $cm2 = count($m2);
        $zero = gmp_init(0, 10);

        for ($i = 0; $i < $cm1; $i++) {
            for ($j = 0; $j < $cm2; $j++) {
                $index = $i + $j;
                if (!isset($prod[$index])) {
                    $prod[$index] = $zero;
                }
                $prod[$index] =
                    $this->adapter->mod(
                        $this->adapter->add(
                            $prod[$index],
                            $this->adapter->mul(
                                $m1[$i],
                                $m2[$j]
                            )
                        ),
                        $p
                    );
            }
        }

        return $this->polynomialReduceMod($prod, $polymod, $p);
    }

    /**
     * @param array $base
     * @param \GMP $exponent
     * @param array $polymod
     * @param \GMP $p
     * @return array|int
     */
    public function polynomialPowMod($base, \GMP $exponent, $polymod, \GMP $p)
    {
        $adapter = $this->adapter;
        $zero = gmp_init(0, 10);
        $one = gmp_init(1, 10);
        $two = gmp_init(2, 10);

        if ($adapter->cmp($exponent, $p) < 0) {
            if ($adapter->equals($exponent, $zero)) {
                return $one;
            }

            $G = $base;
            $k = $exponent;

            if ($adapter->equals($adapter->mod($k, $two), $one)) {
                $s = $G;
            } else {
                $s = array($one);
            }

            while ($adapter->cmp($k, $one) > 0) {
                $k = $adapter->div($k, $two);

                $G = $this->polynomialMultiplyMod($G, $G, $polymod, $p);
                if ($adapter->equals($adapter->mod($k, $two), $one)) {
                    $s = $this->polynomialMultiplyMod($G, $s, $polymod, $p);
                }
            }

            return $s;
        }

        throw new \InvalidArgumentException('Unable to calculate polynomialPowMod');

    }

    /**
     * @param \GMP $a
     * @param \GMP $p
     * @return \GMP
     */
    public function squareRootModP(\GMP $a, \GMP $p)
    {
        $math = $this->adapter;
        $zero = gmp_init(0, 10);
        $one = gmp_init(1, 10);
        $two = gmp_init(2, 10);
        $four = gmp_init(4, 10);
        $eight = gmp_init(8, 10);

        $modMath = $math->getModularArithmetic($p);
        if ($math->cmp($one, $p) < 0) {
            if ($math->equals($a, $zero)) {
                return $zero;
            }

            if ($math->equals($p, $two)) {
                return $a;
            }

            $jac = $math->jacobi($a, $p);
            if ($jac == -1) {
                throw new \LogicException($math->toString($a)." has no square root modulo ".$math->toString($p));
            }

            if ($math->equals($math->mod($p, $four), gmp_init(3, 10))) {
                return $modMath->pow($a, $math->div($math->add($p, $one), $four));
            }

            if ($math->equals($math->mod($p, $eight), gmp_init(5, 10))) {
                $d = $modMath->pow($a, $math->div($math->sub($p, $one), $four));
                if ($math->equals($d, $one)) {
                    return $modMath->pow($a, $math->div($math->add($p, gmp_init(3, 10)), $eight));
                }

                if ($math->equals($d, $math->sub($p, $one))) {
                    return $modMath->mul(
                        $math->mul(
                            $two,
                            $a
                        ),
                        $modMath->pow(
                            $math->mul(
                                $four,
                                $a
                            ),
                            $math->div(
                                $math->sub(
                                    $p,
                                    gmp_init(5, 10)
                                ),
                                $eight
                            )
                        )
                    );
                }
                //shouldn't get here
            }

            for ($b = gmp_init(2, 10); $math->cmp($b, $p) < 0; $b = gmp_add($b, gmp_init(1, 10))) {

It seems like $b defined by gmp_add($b, gmp_init(1, 10)) on line 234 can also be of type resource; however, Jose\Component\Core\Util\Ecc\Math\GmpMath::cmp() does only seem to accept object<GMP>, maybe add an additional type check?

Consider avoiding function calls on each iteration of the for loop.

                if ($math->jacobi(
                    $math->sub(
                        $math->mul($b, $b),

It seems like $b defined by gmp_add($b, gmp_init(1, 10)) on line 234 can also be of type resource; however, Jose\Component\Core\Util\Ecc\Math\GmpMath::mul() does only seem to accept object<GMP>, maybe add an additional type check?

                        $math->mul($four, $a)
                    ),
                    $p
                ) == -1
                ) {
                    $f = array($a, $math->sub($zero, $b), $one);

It seems like $b defined by gmp_add($b, gmp_init(1, 10)) on line 234 can also be of type resource; however, Jose\Component\Core\Util\Ecc\Math\GmpMath::sub() does only seem to accept object<GMP>, maybe add an additional type check?

                    $ff = $this->polynomialPowMod(
                        array($zero, $one),
                        $math->div(
                            $math->add(
                                $p,
                                $one
                            ),
                            $two
                        ),
                        $f,
                        $p
                    );

                    if ($math->equals($ff[1], $zero)) {
                        return $ff[0];
                    }
                    // if we got here no b was found
                }
            }
        }

        throw new \InvalidArgumentException('Unable to calculate square root mod p!');

    }
}