Viel neues

This commit is contained in:
Sven Steinert
2026-04-30 12:06:00 +02:00
parent 118809bfae
commit fce31ebcd7
1274 changed files with 181255 additions and 0 deletions

View File

@@ -0,0 +1,607 @@
<?php
/**
* BCMath BigInteger Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines;
use phpseclib3\Common\Functions\Strings;
use phpseclib3\Exception\BadConfigurationException;
/**
* BCMath Engine.
*
* @author Jim Wigginton <terrafrost@php.net>
*/
class BCMath extends Engine
{
/**
* Can Bitwise operations be done fast?
*
* @see parent::bitwise_leftRotate()
* @see parent::bitwise_rightRotate()
*/
public const FAST_BITWISE = false;
/**
* Engine Directory
*
* @see parent::setModExpEngine
*/
public const ENGINE_DIR = 'BCMath';
/**
* Test for engine validity
*
* @see parent::__construct()
*/
public static function isValidEngine(): bool
{
return extension_loaded('bcmath');
}
/**
* Default constructor
*
* @param mixed $x integer Base-10 number or base-$base number if $base set.
* @see parent::__construct()
*/
public function __construct($x = 0, int $base = 10)
{
if (!isset(static::$isValidEngine[static::class])) {
static::$isValidEngine[static::class] = self::isValidEngine();
}
if (!static::$isValidEngine[static::class]) {
throw new BadConfigurationException('BCMath is not setup correctly on this system');
}
$this->value = '0';
parent::__construct($x, $base);
}
/**
* Initialize a BCMath BigInteger Engine instance
*
* @see parent::__construct()
*/
protected function initialize(int $base): void
{
switch (abs($base)) {
case 256:
// round $len to the nearest 4
$len = (strlen($this->value) + 3) & ~3;
$x = str_pad($this->value, $len, chr(0), STR_PAD_LEFT);
$this->value = '0';
for ($i = 0; $i < $len; $i += 4) {
$this->value = bcmul($this->value, '4294967296', 0); // 4294967296 == 2**32
$this->value = bcadd(
$this->value,
(string) (0x1000000 * ord($x[$i]) + ((ord($x[$i + 1]) << 16) | (ord($x[$i + 2]) << 8) | ord($x[$i + 3]))),
0
);
}
if ($this->is_negative) {
$this->value = '-' . $this->value;
}
break;
case 16:
$x = (strlen($this->value) & 1) ? '0' . $this->value : $this->value;
$temp = new self(Strings::hex2bin($x), 256);
$this->value = $this->is_negative ? '-' . $temp->value : $temp->value;
$this->is_negative = false;
break;
case 10:
// explicitly casting $x to a string is necessary, here, since doing $x[0] on -1 yields different
// results then doing it on '-1' does (modInverse does $x[0])
$this->value = $this->value === '-' ? '0' : (string)$this->value;
}
}
/**
* Converts a BigInteger to a base-10 number.
*/
public function toString(): string
{
if ($this->value === '0') {
return '0';
}
return ltrim($this->value, '0');
}
/**
* Converts a BigInteger to a byte string (eg. base-256).
*/
public function toBytes(bool $twos_compliment = false): string
{
if ($twos_compliment) {
return $this->toBytesHelper();
}
$value = '';
$current = $this->value;
if ($current[0] == '-') {
$current = substr($current, 1);
}
while (bccomp($current, '0', 0) > 0) {
$temp = bcmod($current, '16777216');
$value = chr($temp >> 16) . chr($temp >> 8) . chr((int) $temp) . $value;
$current = bcdiv($current, '16777216', 0);
}
return $this->precision > 0 ?
substr(str_pad($value, $this->precision >> 3, chr(0), STR_PAD_LEFT), -($this->precision >> 3)) :
ltrim($value, chr(0));
}
/**
* Adds two BigIntegers.
*/
public function add(BCMath $y): BCMath
{
$temp = new self();
$temp->value = bcadd($this->value, $y->value);
return $this->normalize($temp);
}
/**
* Subtracts two BigIntegers.
*/
public function subtract(BCMath $y): BCMath
{
$temp = new self();
$temp->value = bcsub($this->value, $y->value);
return $this->normalize($temp);
}
/**
* Multiplies two BigIntegers.
*/
public function multiply(BCMath $x): BCMath
{
$temp = new self();
$temp->value = bcmul($this->value, $x->value);
return $this->normalize($temp);
}
/**
* Divides two BigIntegers.
*
* Returns an array whose first element contains the quotient and whose second element contains the
* "common residue". If the remainder would be positive, the "common residue" and the remainder are the
* same. If the remainder would be negative, the "common residue" is equal to the sum of the remainder
* and the divisor (basically, the "common residue" is the first positive modulo).
*
* @return array{static, static}
*/
public function divide(BCMath $y): array
{
$quotient = new self();
$remainder = new self();
$quotient->value = bcdiv($this->value, $y->value, 0);
$remainder->value = bcmod($this->value, $y->value);
if ($remainder->value[0] == '-') {
$remainder->value = bcadd($remainder->value, $y->value[0] == '-' ? substr($y->value, 1) : $y->value, 0);
}
return [$this->normalize($quotient), $this->normalize($remainder)];
}
/**
* Calculates modular inverses.
*
* Say you have (30 mod 17 * x mod 17) mod 17 == 1. x can be found using modular inverses.
*
* @return false|BCMath
*/
public function modInverse(BCMath $n)
{
return $this->modInverseHelper($n);
}
/**
* Calculates the greatest common divisor and Bezout's identity.
*
* Say you have 693 and 609. The GCD is 21. Bezout's identity states that there exist integers x and y such that
* 693*x + 609*y == 21. In point of fact, there are actually an infinite number of x and y combinations and which
* combination is returned is dependent upon which mode is in use. See
* {@link http://en.wikipedia.org/wiki/B%C3%A9zout%27s_identity Bezout's identity - Wikipedia} for more information.
*
* @return array{gcd: static, x: static, y: static}
*/
public function extendedGCD(BCMath $n): array
{
// it might be faster to use the binary xGCD algorithim here, as well, but (1) that algorithim works
// best when the base is a power of 2 and (2) i don't think it'd make much difference, anyway. as is,
// the basic extended euclidean algorithim is what we're using.
$u = $this->value;
$v = $n->value;
$a = '1';
$b = '0';
$c = '0';
$d = '1';
while (bccomp($v, '0', 0) != 0) {
$q = bcdiv($u, $v, 0);
$temp = $u;
$u = $v;
$v = bcsub($temp, bcmul($v, $q, 0), 0);
$temp = $a;
$a = $c;
$c = bcsub($temp, bcmul($a, $q, 0), 0);
$temp = $b;
$b = $d;
$d = bcsub($temp, bcmul($b, $q, 0), 0);
}
return [
'gcd' => $this->normalize(new static($u)),
'x' => $this->normalize(new static($a)),
'y' => $this->normalize(new static($b)),
];
}
/**
* Calculates the greatest common divisor
*
* Say you have 693 and 609. The GCD is 21.
*/
public function gcd(BCMath $n): BCMath
{
extract($this->extendedGCD($n));
/** @var BCMath $gcd */
return $gcd;
}
/**
* Absolute value.
*/
public function abs(): BCMath
{
$temp = new static();
$temp->value = strlen($this->value) && $this->value[0] == '-' ?
substr($this->value, 1) :
$this->value;
return $temp;
}
/**
* Logical And
*/
public function bitwise_and(BCMath $x): BCMath
{
return $this->bitwiseAndHelper($x);
}
/**
* Logical Or
*/
public function bitwise_or(BCMath $x): BCMath
{
return $this->bitwiseOrHelper($x);
}
/**
* Logical Exclusive Or
*/
public function bitwise_xor(BCMath $x): BCMath
{
return $this->bitwiseXorHelper($x);
}
/**
* Logical Right Shift
*
* Shifts BigInteger's by $shift bits, effectively dividing by 2**$shift.
*/
public function bitwise_rightShift(int $shift): BCMath
{
$temp = new static();
$temp->value = bcdiv($this->value, bcpow('2', (string)$shift, 0), 0);
return $this->normalize($temp);
}
/**
* Logical Left Shift
*
* Shifts BigInteger's by $shift bits, effectively multiplying by 2**$shift.
*/
public function bitwise_leftShift(int $shift): BCMath
{
$temp = new static();
$temp->value = bcmul($this->value, bcpow('2', (string) $shift, 0), 0);
return $this->normalize($temp);
}
/**
* Compares two numbers.
*
* Although one might think !$x->compare($y) means $x != $y, it, in fact, means the opposite. The reason for this
* is demonstrated thusly:
*
* $x > $y: $x->compare($y) > 0
* $x < $y: $x->compare($y) < 0
* $x == $y: $x->compare($y) == 0
*
* Note how the same comparison operator is used. If you want to test for equality, use $x->equals($y).
*
* {@internal Could return $this->subtract($x), but that's not as fast as what we do do.}
*
* @return int in case < 0 if $this is less than $y; > 0 if $this is greater than $y, and 0 if they are equal.
* @see self::equals()
*/
public function compare(BCMath $y): int
{
return bccomp($this->value, $y->value, 0);
}
/**
* Tests the equality of two numbers.
*
* If you need to see if one number is greater than or less than another number, use BigInteger::compare()
*/
public function equals(BCMath $x): bool
{
return $this->value == $x->value;
}
/**
* Performs modular exponentiation.
*/
public function modPow(BCMath $e, BCMath $n): BCMath
{
return $this->powModOuter($e, $n);
}
/**
* Performs modular exponentiation.
*
* Alias for modPow().
*/
public function powMod(BCMath $e, BCMath $n): BCMath
{
return $this->powModOuter($e, $n);
}
/**
* Performs modular exponentiation.
*/
protected function powModInner(BCMath $e, BCMath $n): BCMath
{
try {
$class = static::$modexpEngine[static::class];
return $class::powModHelper($this, $e, $n, static::class);
} catch (\Exception $err) {
return BCMath\DefaultEngine::powModHelper($this, $e, $n, static::class);
}
}
/**
* Normalize
*
* Removes leading zeros and truncates (if necessary) to maintain the appropriate precision
*/
protected function normalize(BCMath $result): BCMath
{
$result->precision = $this->precision;
$result->bitmask = $this->bitmask;
if ($result->bitmask !== false) {
$result->value = bcmod($result->value, $result->bitmask->value);
}
return $result;
}
/**
* Generate a random prime number between a range
*
* If there's not a prime within the given range, false will be returned.
*
* @return false|BCMath
*/
public static function randomRangePrime(BCMath $min, BCMath $max)
{
return self::randomRangePrimeOuter($min, $max);
}
/**
* Generate a random number between a range
*
* Returns a random number between $min and $max where $min and $max
* can be defined using one of the two methods:
*
* BigInteger::randomRange($min, $max)
* BigInteger::randomRange($max, $min)
*/
public static function randomRange(BCMath $min, BCMath $max): BCMath
{
return self::randomRangeHelper($min, $max);
}
/**
* Make the current number odd
*
* If the current number is odd it'll be unchanged. If it's even, one will be added to it.
*
* @see self::randomPrime()
*/
protected function make_odd(): void
{
if (!$this->isOdd()) {
$this->value = bcadd($this->value, '1');
}
}
/**
* Test the number against small primes.
*
* @see self::isPrime()
*/
protected function testSmallPrimes(): bool
{
if ($this->value === '1') {
return false;
}
if ($this->value === '2') {
return true;
}
if ($this->value[-1] % 2 == 0) {
return false;
}
$value = $this->value;
foreach (self::PRIMES as $prime) {
$r = bcmod($this->value, (string)$prime);
if ($r == '0') {
return $this->value == $prime;
}
}
return true;
}
/**
* Scan for 1 and right shift by that amount
*
* ie. $s = gmp_scan1($n, 0) and $r = gmp_div_q($n, gmp_pow(gmp_init('2'), $s));
*
* @see self::isPrime()
*/
public static function scan1divide(BCMath $r): int
{
$r_value = &$r->value;
$s = 0;
// if $n was 1, $r would be 0 and this would be an infinite loop, hence our $this->equals(static::$one[static::class]) check earlier
while ($r_value[-1] % 2 == 0) {
$r_value = bcdiv($r_value, '2', 0);
++$s;
}
return $s;
}
/**
* Performs exponentiation.
*/
public function pow(BCMath $n): BCMath
{
$temp = new self();
$temp->value = bcpow($this->value, $n->value);
return $this->normalize($temp);
}
/**
* Return the minimum BigInteger between an arbitrary number of BigIntegers.
*/
public static function min(BCMath ...$nums): BCMath
{
return self::minHelper($nums);
}
/**
* Return the maximum BigInteger between an arbitrary number of BigIntegers.
*/
public static function max(BCMath ...$nums): BCMath
{
return self::maxHelper($nums);
}
/**
* Tests BigInteger to see if it is between two integers, inclusive
*/
public function between(BCMath $min, BCMath $max): bool
{
return $this->compare($min) >= 0 && $this->compare($max) <= 0;
}
/**
* Set Bitmask
*
* @see self::setPrecision()
*/
protected static function setBitmask(int $bits): Engine
{
$temp = parent::setBitmask($bits);
return $temp->add(static::$one[static::class]);
}
/**
* Is Odd?
*/
public function isOdd(): bool
{
return $this->value[-1] % 2 == 1;
}
/**
* Tests if a bit is set
*/
public function testBit($x): bool
{
return bccomp(
bcmod($this->value, bcpow('2', $x + 1, 0)),
bcpow('2', $x, 0),
0
) >= 0;
}
/**
* Is Negative?
*/
public function isNegative(): bool
{
return strlen($this->value) && $this->value[0] == '-';
}
/**
* Negate
*
* Given $k, returns -$k
*/
public function negate(): BCMath
{
$temp = clone $this;
if (!strlen($temp->value)) {
return $temp;
}
$temp->value = $temp->value[0] == '-' ?
substr($this->value, 1) :
'-' . $this->value;
return $temp;
}
}

View File

@@ -0,0 +1,89 @@
<?php
/**
* Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\BCMath;
use phpseclib3\Math\BigInteger\Engines\BCMath;
/**
* Sliding Window Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class Base extends BCMath
{
/**
* Cache constants
*
* $cache[self::VARIABLE] tells us whether or not the cached data is still valid.
*/
public const VARIABLE = 0;
/**
* $cache[self::DATA] contains the cached data.
*/
public const DATA = 1;
/**
* Test for engine validity
*/
public static function isValidEngine(): bool
{
return static::class != __CLASS__;
}
/**
* Performs modular exponentiation.
*/
protected static function powModHelper(BCMath $x, BCMath $e, BCMath $n, string $class): BCMath
{
if (empty($e->value)) {
$temp = new $class();
$temp->value = '1';
return $x->normalize($temp);
}
return $x->normalize(static::slidingWindow($x, $e, $n, $class));
}
/**
* Modular reduction preparation
*
* @see self::slidingWindow()
*/
protected static function prepareReduce(string $x, string $n, string $class): string
{
return static::reduce($x, $n);
}
/**
* Modular multiply
*
* @see self::slidingWindow()
*/
protected static function multiplyReduce(string $x, string $y, string $n, string $class): string
{
return static::reduce(bcmul($x, $y), $n);
}
/**
* Modular square
*
* @see self::slidingWindow()
*/
protected static function squareReduce(string $x, string $n, string $class): string
{
return static::reduce(bcmul($x, $x), $n);
}
}

View File

@@ -0,0 +1,37 @@
<?php
/**
* Built-In BCMath Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\BCMath;
use phpseclib3\Math\BigInteger\Engines\BCMath;
/**
* Built-In BCMath Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class BuiltIn extends BCMath
{
/**
* Performs modular exponentiation.
*/
protected static function powModHelper(BCMath $x, BCMath $e, BCMath $n): BCMath
{
$temp = new BCMath();
$temp->value = bcpowmod($x->value, $e->value, $n->value);
return $x->normalize($temp);
}
}

View File

@@ -0,0 +1,27 @@
<?php
/**
* BCMath Default Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\BCMath;
use phpseclib3\Math\BigInteger\Engines\BCMath\Reductions\Barrett;
/**
* PHP Default Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class DefaultEngine extends Barrett
{
}

View File

@@ -0,0 +1,27 @@
<?php
/**
* OpenSSL Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\BCMath;
use phpseclib3\Math\BigInteger\Engines\OpenSSL as Progenitor;
/**
* OpenSSL Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class OpenSSL extends Progenitor
{
}

View File

@@ -0,0 +1,179 @@
<?php
/**
* BCMath Barrett Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\BCMath\Reductions;
use phpseclib3\Math\BigInteger\Engines\BCMath\Base;
/**
* PHP Barrett Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class Barrett extends Base
{
/**
* Cache constants
*
* $cache[self::VARIABLE] tells us whether or not the cached data is still valid.
*/
public const VARIABLE = 0;
/**
* $cache[self::DATA] contains the cached data.
*/
public const DATA = 1;
/**
* Barrett Modular Reduction
*
* See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=14 HAC 14.3.3} /
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=165 MPM 6.2.5} for more information. Modified slightly,
* so as not to require negative numbers (initially, this script didn't support negative numbers).
*
* Employs "folding", as described at
* {@link http://www.cosic.esat.kuleuven.be/publications/thesis-149.pdf#page=66 thesis-149.pdf#page=66}. To quote from
* it, "the idea [behind folding] is to find a value x' such that x (mod m) = x' (mod m), with x' being smaller than x."
*
* Unfortunately, the "Barrett Reduction with Folding" algorithm described in thesis-149.pdf is not, as written, all that
* usable on account of (1) its not using reasonable radix points as discussed in
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=162 MPM 6.2.2} and (2) the fact that, even with reasonable
* radix points, it only works when there are an even number of digits in the denominator. The reason for (2) is that
* (x >> 1) + (x >> 1) != x / 2 + x / 2. If x is even, they're the same, but if x is odd, they're not. See the in-line
* comments for details.
*/
protected static function reduce(string $n, string $m): string
{
static $cache = [
self::VARIABLE => [],
self::DATA => [],
];
$m_length = strlen($m);
if (strlen($n) >= 2 * $m_length) {
return bcmod($n, $m);
}
// if (m.length >> 1) + 2 <= m.length then m is too small and n can't be reduced
if ($m_length < 5) {
return self::regularBarrett($n, $m);
}
// n = 2 * m.length
if (($key = array_search($m, $cache[self::VARIABLE])) === false) {
$key = count($cache[self::VARIABLE]);
$cache[self::VARIABLE][] = $m;
$lhs = '1' . str_repeat('0', $m_length + ($m_length >> 1));
$u = bcdiv($lhs, $m, 0);
$m1 = bcsub($lhs, bcmul($u, $m));
$cache[self::DATA][] = [
'u' => $u, // m.length >> 1 (technically (m.length >> 1) + 1)
'm1' => $m1, // m.length
];
} else {
extract($cache[self::DATA][$key]);
}
$cutoff = $m_length + ($m_length >> 1);
$lsd = substr($n, -$cutoff);
$msd = substr($n, 0, -$cutoff);
$temp = bcmul($msd, $m1); // m.length + (m.length >> 1)
$n = bcadd($lsd, $temp); // m.length + (m.length >> 1) + 1 (so basically we're adding two same length numbers)
//if ($m_length & 1) {
// return self::regularBarrett($n, $m);
//}
// (m.length + (m.length >> 1) + 1) - (m.length - 1) == (m.length >> 1) + 2
$temp = substr($n, 0, -$m_length + 1);
// if even: ((m.length >> 1) + 2) + (m.length >> 1) == m.length + 2
// if odd: ((m.length >> 1) + 2) + (m.length >> 1) == (m.length - 1) + 2 == m.length + 1
$temp = bcmul($temp, $u);
// if even: (m.length + 2) - ((m.length >> 1) + 1) = m.length - (m.length >> 1) + 1
// if odd: (m.length + 1) - ((m.length >> 1) + 1) = m.length - (m.length >> 1)
$temp = substr($temp, 0, -($m_length >> 1) - 1);
// if even: (m.length - (m.length >> 1) + 1) + m.length = 2 * m.length - (m.length >> 1) + 1
// if odd: (m.length - (m.length >> 1)) + m.length = 2 * m.length - (m.length >> 1)
$temp = bcmul($temp, $m);
// at this point, if m had an odd number of digits, we'd be subtracting a 2 * m.length - (m.length >> 1) digit
// number from a m.length + (m.length >> 1) + 1 digit number. ie. there'd be an extra digit and the while loop
// following this comment would loop a lot (hence our calling _regularBarrett() in that situation).
$result = bcsub($n, $temp);
//if (bccomp($result, '0') < 0) {
if ($result[0] == '-') {
$temp = '1' . str_repeat('0', $m_length + 1);
$result = bcadd($result, $temp);
}
while (bccomp($result, $m) >= 0) {
$result = bcsub($result, $m);
}
return $result;
}
/**
* (Regular) Barrett Modular Reduction
*
* For numbers with more than four digits BigInteger::_barrett() is faster. The difference between that and this
* is that this function does not fold the denominator into a smaller form.
*/
private static function regularBarrett(string $x, string $n): string
{
static $cache = [
self::VARIABLE => [],
self::DATA => [],
];
$n_length = strlen($n);
if (strlen($x) > 2 * $n_length) {
return bcmod($x, $n);
}
if (($key = array_search($n, $cache[self::VARIABLE])) === false) {
$key = count($cache[self::VARIABLE]);
$cache[self::VARIABLE][] = $n;
$lhs = '1' . str_repeat('0', 2 * $n_length);
$cache[self::DATA][] = bcdiv($lhs, $n, 0);
}
$temp = substr($x, 0, -$n_length + 1);
$temp = bcmul($temp, $cache[self::DATA][$key]);
$temp = substr($temp, 0, -$n_length - 1);
$r1 = substr($x, -$n_length - 1);
$r2 = substr(bcmul($temp, $n), -$n_length - 1);
$result = bcsub($r1, $r2);
//if (bccomp($result, '0') < 0) {
if ($result[0] == '-') {
$q = '1' . str_repeat('0', $n_length + 1);
$result = bcadd($result, $q);
}
while (bccomp($result, $n) >= 0) {
$result = bcsub($result, $n);
}
return $result;
}
}

View File

@@ -0,0 +1,104 @@
<?php
/**
* BCMath Dynamic Barrett Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\BCMath\Reductions;
use phpseclib3\Math\BigInteger\Engines\BCMath;
use phpseclib3\Math\BigInteger\Engines\BCMath\Base;
/**
* PHP Barrett Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class EvalBarrett extends Base
{
/**
* Custom Reduction Function
*
* @see self::generateCustomReduction
*/
private static $custom_reduction;
/**
* Barrett Modular Reduction
*
* This calls a dynamically generated loop unrolled function that's specific to a given modulo.
* Array lookups are avoided as are if statements testing for how many bits the host OS supports, etc.
*/
protected static function reduce(string $n, string $m): string
{
$inline = self::$custom_reduction;
return $inline($n);
}
/**
* Generate Custom Reduction
*
* @return callable|void
*/
protected static function generateCustomReduction(BCMath $m, string $class)
{
$m_length = strlen($m);
if ($m_length < 5) {
$code = 'return bcmod($x, $n);';
eval('$func = function ($n) { ' . $code . '};');
self::$custom_reduction = $func;
return;
}
$lhs = '1' . str_repeat('0', $m_length + ($m_length >> 1));
$u = bcdiv($lhs, $m, 0);
$m1 = bcsub($lhs, bcmul($u, $m));
$cutoff = $m_length + ($m_length >> 1);
$m = "'$m'";
$u = "'$u'";
$m1 = "'$m1'";
$code = '
$lsd = substr($n, -' . $cutoff . ');
$msd = substr($n, 0, -' . $cutoff . ');
$temp = bcmul($msd, ' . $m1 . ');
$n = bcadd($lsd, $temp);
$temp = substr($n, 0, ' . (-$m_length + 1) . ');
$temp = bcmul($temp, ' . $u . ');
$temp = substr($temp, 0, ' . (-($m_length >> 1) - 1) . ');
$temp = bcmul($temp, ' . $m . ');
$result = bcsub($n, $temp);
if ($result[0] == \'-\') {
$temp = \'1' . str_repeat('0', $m_length + 1) . '\';
$result = bcadd($result, $temp);
}
while (bccomp($result, ' . $m . ') >= 0) {
$result = bcsub($result, ' . $m . ');
}
return $result;';
eval('$func = function ($n) { ' . $code . '};');
self::$custom_reduction = $func;
return $func;
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,591 @@
<?php
/**
* GMP BigInteger Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines;
use phpseclib3\Exception\BadConfigurationException;
/**
* GMP Engine.
*
* @author Jim Wigginton <terrafrost@php.net>
*/
class GMP extends Engine
{
/**
* Can Bitwise operations be done fast?
*
* @see parent::bitwise_leftRotate()
* @see parent::bitwise_rightRotate()
*/
public const FAST_BITWISE = true;
/**
* Engine Directory
*
* @see parent::setModExpEngine
*/
public const ENGINE_DIR = 'GMP';
/**
* Test for engine validity
*
* @see parent::__construct()
*/
public static function isValidEngine(): bool
{
return extension_loaded('gmp');
}
/**
* Default constructor
*
* @param mixed $x integer Base-10 number or base-$base number if $base set.
* @see parent::__construct()
*/
public function __construct($x = 0, int $base = 10)
{
if (!isset(static::$isValidEngine[static::class])) {
static::$isValidEngine[static::class] = self::isValidEngine();
}
if (!static::$isValidEngine[static::class]) {
throw new BadConfigurationException('GMP is not setup correctly on this system');
}
if ($x instanceof \GMP) {
$this->value = $x;
return;
}
$this->value = gmp_init(0);
parent::__construct($x, $base);
}
/**
* Initialize a GMP BigInteger Engine instance
*
* @see parent::__construct()
*/
protected function initialize(int $base): void
{
switch (abs($base)) {
case 256:
$this->value = gmp_import($this->value);
if ($this->is_negative) {
$this->value = -$this->value;
}
break;
case 16:
$temp = $this->is_negative ? '-0x' . $this->value : '0x' . $this->value;
$this->value = gmp_init($temp);
break;
case 10:
$this->value = gmp_init($this->value ?? '0');
}
}
/**
* Converts a BigInteger to a base-10 number.
*/
public function toString(): string
{
return (string)$this->value;
}
/**
* Converts a BigInteger to a bit string (eg. base-2).
*
* Negative numbers are saved as positive numbers, unless $twos_compliment is set to true, at which point, they're
* saved as two's compliment.
*/
public function toBits(bool $twos_compliment = false): string
{
$hex = $this->toHex($twos_compliment);
$bits = gmp_strval(gmp_init($hex, 16), 2);
if ($this->precision > 0) {
$bits = substr($bits, -$this->precision);
}
if ($twos_compliment && $this->compare(new static()) > 0 && $this->precision <= 0) {
return '0' . $bits;
}
return $bits;
}
/**
* Converts a BigInteger to a byte string (eg. base-256).
*/
public function toBytes(bool $twos_compliment = false): string
{
if ($twos_compliment) {
return $this->toBytesHelper();
}
if (gmp_cmp($this->value, gmp_init(0)) == 0) {
return $this->precision > 0 ? str_repeat(chr(0), ($this->precision + 1) >> 3) : '';
}
$temp = gmp_export($this->value);
return $this->precision > 0 ?
substr(str_pad($temp, $this->precision >> 3, chr(0), STR_PAD_LEFT), -($this->precision >> 3)) :
ltrim($temp, chr(0));
}
/**
* Adds two BigIntegers.
*/
public function add(GMP $y): GMP
{
$temp = new self();
$temp->value = $this->value + $y->value;
return $this->normalize($temp);
}
/**
* Subtracts two BigIntegers.
*/
public function subtract(GMP $y): GMP
{
$temp = new self();
$temp->value = $this->value - $y->value;
return $this->normalize($temp);
}
/**
* Multiplies two BigIntegers.
*/
public function multiply(GMP $x): GMP
{
$temp = new self();
$temp->value = $this->value * $x->value;
return $this->normalize($temp);
}
/**
* Divides two BigIntegers.
*
* Returns an array whose first element contains the quotient and whose second element contains the
* "common residue". If the remainder would be positive, the "common residue" and the remainder are the
* same. If the remainder would be negative, the "common residue" is equal to the sum of the remainder
* and the divisor (basically, the "common residue" is the first positive modulo).
*
* @return array{GMP, GMP}
*/
public function divide(GMP $y): array
{
$quotient = new self();
$remainder = new self();
[$quotient->value, $remainder->value] = gmp_div_qr($this->value, $y->value);
if (gmp_sign($remainder->value) < 0) {
$remainder->value = $remainder->value + gmp_abs($y->value);
}
return [$this->normalize($quotient), $this->normalize($remainder)];
}
/**
* Compares two numbers.
*
* Although one might think !$x->compare($y) means $x != $y, it, in fact, means the opposite. The reason for this
* is demonstrated thusly:
*
* $x > $y: $x->compare($y) > 0
* $x < $y: $x->compare($y) < 0
* $x == $y: $x->compare($y) == 0
*
* Note how the same comparison operator is used. If you want to test for equality, use $x->equals($y).
*
* {@internal Could return $this->subtract($x), but that's not as fast as what we do do.}
*
* @return int in case < 0 if $this is less than $y; > 0 if $this is greater than $y, and 0 if they are equal.
* @see self::equals()
*/
public function compare(GMP $y): int
{
$r = gmp_cmp($this->value, $y->value);
if ($r < -1) {
$r = -1;
}
if ($r > 1) {
$r = 1;
}
return $r;
}
/**
* Tests the equality of two numbers.
*
* If you need to see if one number is greater than or less than another number, use BigInteger::compare()
*/
public function equals(GMP $x): bool
{
return $this->value == $x->value;
}
/**
* Calculates modular inverses.
*
* Say you have (30 mod 17 * x mod 17) mod 17 == 1. x can be found using modular inverses.
*
* @return false|GMP
*/
public function modInverse(GMP $n)
{
$temp = new self();
$temp->value = gmp_invert($this->value, $n->value);
return $temp->value === false ? false : $this->normalize($temp);
}
/**
* Calculates the greatest common divisor and Bezout's identity.
*
* Say you have 693 and 609. The GCD is 21. Bezout's identity states that there exist integers x and y such that
* 693*x + 609*y == 21. In point of fact, there are actually an infinite number of x and y combinations and which
* combination is returned is dependent upon which mode is in use. See
* {@link http://en.wikipedia.org/wiki/B%C3%A9zout%27s_identity Bezout's identity - Wikipedia} for more information.
*
* @return GMP[]
*/
public function extendedGCD(GMP $n): array
{
extract(gmp_gcdext($this->value, $n->value));
return [
'gcd' => $this->normalize(new self($g)),
'x' => $this->normalize(new self($s)),
'y' => $this->normalize(new self($t)),
];
}
/**
* Calculates the greatest common divisor
*
* Say you have 693 and 609. The GCD is 21.
*/
public function gcd(GMP $n): GMP
{
$r = gmp_gcd($this->value, $n->value);
return $this->normalize(new self($r));
}
/**
* Absolute value.
*/
public function abs(): GMP
{
$temp = new self();
$temp->value = gmp_abs($this->value);
return $temp;
}
/**
* Logical And
*/
public function bitwise_and(GMP $x): GMP
{
$temp = new self();
$temp->value = $this->value & $x->value;
return $this->normalize($temp);
}
/**
* Logical Or
*/
public function bitwise_or(GMP $x): GMP
{
$temp = new self();
$temp->value = $this->value | $x->value;
return $this->normalize($temp);
}
/**
* Logical Exclusive Or
*/
public function bitwise_xor(GMP $x): GMP
{
$temp = new self();
$temp->value = $this->value ^ $x->value;
return $this->normalize($temp);
}
/**
* Logical Right Shift
*
* Shifts BigInteger's by $shift bits, effectively dividing by 2**$shift.
*/
public function bitwise_rightShift(int $shift): GMP
{
// 0xFFFFFFFF >> 2 == -1 (on 32-bit systems)
// gmp_init('0xFFFFFFFF') >> 2 == gmp_init('0x3FFFFFFF')
$temp = new self();
$temp->value = $this->value >> $shift;
return $this->normalize($temp);
}
/**
* Logical Left Shift
*
* Shifts BigInteger's by $shift bits, effectively multiplying by 2**$shift.
*/
public function bitwise_leftShift(int $shift): GMP
{
$temp = new self();
$temp->value = $this->value << $shift;
return $this->normalize($temp);
}
/**
* Performs modular exponentiation.
*/
public function modPow(GMP $e, GMP $n): GMP
{
return $this->powModOuter($e, $n);
}
/**
* Performs modular exponentiation.
*
* Alias for modPow().
*/
public function powMod(GMP $e, GMP $n): GMP
{
return $this->powModOuter($e, $n);
}
/**
* Performs modular exponentiation.
*/
protected function powModInner(GMP $e, GMP $n): GMP
{
$class = static::$modexpEngine[static::class];
return $class::powModHelper($this, $e, $n);
}
/**
* Normalize
*
* Removes leading zeros and truncates (if necessary) to maintain the appropriate precision
*/
protected function normalize(GMP $result): GMP
{
$result->precision = $this->precision;
$result->bitmask = $this->bitmask;
if ($result->bitmask !== false) {
$flip = $result->value < 0;
if ($flip) {
$result->value = -$result->value;
}
$result->value = $result->value & $result->bitmask->value;
if ($flip) {
$result->value = -$result->value;
}
}
return $result;
}
/**
* Performs some post-processing for randomRangePrime
*
* @return GMP
*/
protected static function randomRangePrimeInner(Engine $x, Engine $min, Engine $max)
{
$p = gmp_nextprime($x->value);
if ($p <= $max->value) {
return new self($p);
}
if ($min->value != $x->value) {
$x = new self($x->value - 1);
}
return self::randomRangePrime($min, $x);
}
/**
* Generate a random prime number between a range
*
* If there's not a prime within the given range, false will be returned.
*
* @return false|GMP
*/
public static function randomRangePrime(GMP $min, GMP $max)
{
return self::randomRangePrimeOuter($min, $max);
}
/**
* Generate a random number between a range
*
* Returns a random number between $min and $max where $min and $max
* can be defined using one of the two methods:
*
* BigInteger::randomRange($min, $max)
* BigInteger::randomRange($max, $min)
*/
public static function randomRange(GMP $min, GMP $max): GMP
{
return self::randomRangeHelper($min, $max);
}
/**
* Make the current number odd
*
* If the current number is odd it'll be unchanged. If it's even, one will be added to it.
*
* @see self::randomPrime()
*/
protected function make_odd(): void
{
gmp_setbit($this->value, 0);
}
/**
* Tests Primality
*/
protected function testPrimality(int $t): bool
{
return gmp_prob_prime($this->value, $t) != 0;
}
/**
* Calculates the nth root of a biginteger.
*
* Returns the nth root of a positive biginteger, where n defaults to 2
*/
protected function rootInner(int $n): GMP
{
$root = new self();
$root->value = gmp_root($this->value, $n);
return $this->normalize($root);
}
/**
* Performs exponentiation.
*/
public function pow(GMP $n): GMP
{
$temp = new self();
$temp->value = $this->value ** $n->value;
return $this->normalize($temp);
}
/**
* Return the minimum BigInteger between an arbitrary number of BigIntegers.
*/
public static function min(GMP ...$nums): GMP
{
return self::minHelper($nums);
}
/**
* Return the maximum BigInteger between an arbitrary number of BigIntegers.
*/
public static function max(GMP ...$nums): GMP
{
return self::maxHelper($nums);
}
/**
* Tests BigInteger to see if it is between two integers, inclusive
*/
public function between(GMP $min, GMP $max): bool
{
return $this->compare($min) >= 0 && $this->compare($max) <= 0;
}
/**
* Create Recurring Modulo Function
*
* Sometimes it may be desirable to do repeated modulos with the same number outside of
* modular exponentiation
*/
public function createRecurringModuloFunction(): \Closure
{
$temp = $this->value;
return fn (GMP $x) => new GMP($x->value % $temp);
}
/**
* Scan for 1 and right shift by that amount
*
* ie. $s = gmp_scan1($n, 0) and $r = gmp_div_q($n, gmp_pow(gmp_init('2'), $s));
*/
public static function scan1divide(GMP $r): int
{
$s = gmp_scan1($r->value, 0);
$r->value >>= $s;
return $s;
}
/**
* Is Odd?
*/
public function isOdd(): bool
{
return gmp_testbit($this->value, 0);
}
/**
* Tests if a bit is set
*/
public function testBit($x): bool
{
return gmp_testbit($this->value, $x);
}
/**
* Is Negative?
*/
public function isNegative(): bool
{
return gmp_sign($this->value) == -1;
}
/**
* Negate
*
* Given $k, returns -$k
*/
public function negate(): GMP
{
$temp = clone $this;
$temp->value = -$this->value;
return $temp;
}
}

View File

@@ -0,0 +1,37 @@
<?php
/**
* GMP Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\GMP;
use phpseclib3\Math\BigInteger\Engines\GMP;
/**
* GMP Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class DefaultEngine extends GMP
{
/**
* Performs modular exponentiation.
*/
protected static function powModHelper(GMP $x, GMP $e, GMP $n): GMP
{
$temp = new GMP();
$temp->value = gmp_powm($x->value, $e->value, $n->value);
return $x->normalize($temp);
}
}

View File

@@ -0,0 +1,65 @@
<?php
/**
* OpenSSL Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines;
use phpseclib3\Crypt\RSA\Formats\Keys\PKCS8;
use phpseclib3\Exception\OutOfRangeException;
use phpseclib3\Exception\UnexpectedValueException;
use phpseclib3\Math\BigInteger;
/**
* OpenSSL Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class OpenSSL
{
/**
* Test for engine validity
*/
public static function isValidEngine(): bool
{
return extension_loaded('openssl') && static::class != __CLASS__;
}
/**
* Performs modular exponentiation.
*/
public static function powModHelper(Engine $x, Engine $e, Engine $n): Engine
{
if ($n->getLengthInBytes() < 31 || $n->getLengthInBytes() > 16384) {
throw new OutOfRangeException('Only modulo between 31 and 16384 bits are accepted');
}
$key = PKCS8::savePublicKey(
new BigInteger($n),
new BigInteger($e)
);
$plaintext = str_pad($x->toBytes(), $n->getLengthInBytes(), "\0", STR_PAD_LEFT);
// this is easily prone to failure. if the modulo is a multiple of 2 or 3 or whatever it
// won't work and you'll get a "failure: error:0906D06C:PEM routines:PEM_read_bio:no start line"
// error. i suppose, for even numbers, we could do what PHP\Montgomery.php does, but then what
// about odd numbers divisible by 3, by 5, etc?
if (!openssl_public_encrypt($plaintext, $result, $key, OPENSSL_NO_PADDING)) {
throw new UnexpectedValueException(openssl_error_string());
}
$class = $x::class;
return new $class($result, 256);
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,122 @@
<?php
/**
* PHP Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP;
use phpseclib3\Math\BigInteger\Engines\PHP;
/**
* PHP Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class Base extends PHP
{
/**
* Cache constants
*
* $cache[self::VARIABLE] tells us whether or not the cached data is still valid.
*/
public const VARIABLE = 0;
/**
* $cache[self::DATA] contains the cached data.
*/
public const DATA = 1;
/**
* Test for engine validity
*/
public static function isValidEngine(): bool
{
return static::class != __CLASS__;
}
/**
* Performs modular exponentiation.
*
* The most naive approach to modular exponentiation has very unreasonable requirements, and
* and although the approach involving repeated squaring does vastly better, it, too, is impractical
* for our purposes. The reason being that division - by far the most complicated and time-consuming
* of the basic operations (eg. +,-,*,/) - occurs multiple times within it.
*
* Modular reductions resolve this issue. Although an individual modular reduction takes more time
* then an individual division, when performed in succession (with the same modulo), they're a lot faster.
*
* The two most commonly used modular reductions are Barrett and Montgomery reduction. Montgomery reduction,
* although faster, only works when the gcd of the modulo and of the base being used is 1. In RSA, when the
* base is a power of two, the modulo - a product of two primes - is always going to have a gcd of 1 (because
* the product of two odd numbers is odd), but what about when RSA isn't used?
*
* In contrast, Barrett reduction has no such constraint. As such, some bigint implementations perform a
* Barrett reduction after every operation in the modpow function. Others perform Barrett reductions when the
* modulo is even and Montgomery reductions when the modulo is odd. BigInteger.java's modPow method, however,
* uses a trick involving the Chinese Remainder Theorem to factor the even modulo into two numbers - one odd and
* the other, a power of two - and recombine them, later. This is the method that this modPow function uses.
* {@link http://islab.oregonstate.edu/papers/j34monex.pdf Montgomery Reduction with Even Modulus} elaborates.
*/
protected static function powModHelper(PHP $x, PHP $e, PHP $n, string $class): PHP
{
if (empty($e->value)) {
$temp = new $class();
$temp->value = [1];
return $x->normalize($temp);
}
if ($e->value == [1]) {
[, $temp] = $x->divide($n);
return $x->normalize($temp);
}
if ($e->value == [2]) {
$temp = new $class();
$temp->value = $class::square($x->value);
[, $temp] = $temp->divide($n);
return $x->normalize($temp);
}
return $x->normalize(static::slidingWindow($x, $e, $n, $class));
}
/**
* Modular reduction preparation
*
* @see self::slidingWindow()
*/
protected static function prepareReduce(array $x, array $n, string $class): array
{
return static::reduce($x, $n, $class);
}
/**
* Modular multiply
*
* @see self::slidingWindow()
*/
protected static function multiplyReduce(array $x, array $y, array $n, string $class): array
{
$temp = $class::multiplyHelper($x, false, $y, false);
return static::reduce($temp[self::VALUE], $n, $class);
}
/**
* Modular square
*
* @see self::slidingWindow()
*/
protected static function squareReduce(array $x, array $n, string $class): array
{
return static::reduce($class::square($x), $n, $class);
}
}

View File

@@ -0,0 +1,27 @@
<?php
/**
* PHP Default Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP;
use phpseclib3\Math\BigInteger\Engines\PHP\Reductions\EvalBarrett;
/**
* PHP Default Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class DefaultEngine extends EvalBarrett
{
}

View File

@@ -0,0 +1,86 @@
<?php
/**
* PHP Montgomery Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP;
use phpseclib3\Math\BigInteger\Engines\Engine;
use phpseclib3\Math\BigInteger\Engines\PHP;
use phpseclib3\Math\BigInteger\Engines\PHP\Reductions\PowerOfTwo;
/**
* PHP Montgomery Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class Montgomery extends Base
{
/**
* Test for engine validity
*/
public static function isValidEngine(): bool
{
return static::class != __CLASS__;
}
/**
* Performs modular exponentiation.
*
* @template T of Engine
* @param class-string<T> $class
* @return T
*/
protected static function slidingWindow(Engine $x, Engine $e, Engine $n, string $class)
{
// is the modulo odd?
if ($n->value[0] & 1) {
return parent::slidingWindow($x, $e, $n, $class);
}
// if it's not, it's even
// find the lowest set bit (eg. the max pow of 2 that divides $n)
for ($i = 0; $i < count($n->value); ++$i) {
if ($n->value[$i]) {
$temp = decbin($n->value[$i]);
$j = strlen($temp) - strrpos($temp, '1') - 1;
$j += $class::BASE * $i;
break;
}
}
// at this point, 2^$j * $n/(2^$j) == $n
$mod1 = clone $n;
$mod1->rshift($j);
$mod2 = new $class();
$mod2->value = [1];
$mod2->lshift($j);
$part1 = $mod1->value != [1] ? parent::slidingWindow($x, $e, $mod1, $class) : new $class();
$part2 = PowerOfTwo::slidingWindow($x, $e, $mod2, $class);
$y1 = $mod2->modInverse($mod1);
$y2 = $mod1->modInverse($mod2);
$result = $part1->multiply($mod2);
$result = $result->multiply($y1);
$temp = $part2->multiply($mod1);
$temp = $temp->multiply($y2);
$result = $result->add($temp);
[, $result] = $result->divide($n);
return $result;
}
}

View File

@@ -0,0 +1,27 @@
<?php
/**
* OpenSSL Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP;
use phpseclib3\Math\BigInteger\Engines\OpenSSL as Progenitor;
/**
* OpenSSL Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class OpenSSL extends Progenitor
{
}

View File

@@ -0,0 +1,268 @@
<?php
/**
* PHP Barrett Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP\Reductions;
use phpseclib3\Math\BigInteger\Engines\PHP;
use phpseclib3\Math\BigInteger\Engines\PHP\Base;
/**
* PHP Barrett Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class Barrett extends Base
{
/**
* Barrett Modular Reduction
*
* See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=14 HAC 14.3.3} /
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=165 MPM 6.2.5} for more information. Modified slightly,
* so as not to require negative numbers (initially, this script didn't support negative numbers).
*
* Employs "folding", as described at
* {@link http://www.cosic.esat.kuleuven.be/publications/thesis-149.pdf#page=66 thesis-149.pdf#page=66}. To quote from
* it, "the idea [behind folding] is to find a value x' such that x (mod m) = x' (mod m), with x' being smaller than x."
*
* Unfortunately, the "Barrett Reduction with Folding" algorithm described in thesis-149.pdf is not, as written, all that
* usable on account of (1) its not using reasonable radix points as discussed in
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=162 MPM 6.2.2} and (2) the fact that, even with reasonable
* radix points, it only works when there are an even number of digits in the denominator. The reason for (2) is that
* (x >> 1) + (x >> 1) != x / 2 + x / 2. If x is even, they're the same, but if x is odd, they're not. See the in-line
* comments for details.
*
* @param class-string<PHP> $class
*/
protected static function reduce(array $n, array $m, string $class): array
{
static $cache = [
self::VARIABLE => [],
self::DATA => [],
];
$m_length = count($m);
// if (self::compareHelper($n, $static::square($m)) >= 0) {
if (count($n) >= 2 * $m_length) {
$lhs = new $class();
$rhs = new $class();
$lhs->value = $n;
$rhs->value = $m;
[, $temp] = $lhs->divide($rhs);
return $temp->value;
}
// if (m.length >> 1) + 2 <= m.length then m is too small and n can't be reduced
if ($m_length < 5) {
return self::regularBarrett($n, $m, $class);
}
// n = 2 * m.length
if (($key = array_search($m, $cache[self::VARIABLE])) === false) {
$key = count($cache[self::VARIABLE]);
$cache[self::VARIABLE][] = $m;
$lhs = new $class();
$lhs_value = &$lhs->value;
$lhs_value = self::array_repeat(0, $m_length + ($m_length >> 1));
$lhs_value[] = 1;
$rhs = new $class();
$rhs->value = $m;
[$u, $m1] = $lhs->divide($rhs);
$u = $u->value;
$m1 = $m1->value;
$cache[self::DATA][] = [
'u' => $u, // m.length >> 1 (technically (m.length >> 1) + 1)
'm1' => $m1, // m.length
];
} else {
extract($cache[self::DATA][$key]);
}
$cutoff = $m_length + ($m_length >> 1);
$lsd = array_slice($n, 0, $cutoff); // m.length + (m.length >> 1)
$msd = array_slice($n, $cutoff); // m.length >> 1
$lsd = self::trim($lsd);
$temp = $class::multiplyHelper($msd, false, $m1, false); // m.length + (m.length >> 1)
$n = $class::addHelper($lsd, false, $temp[self::VALUE], false); // m.length + (m.length >> 1) + 1 (so basically we're adding two same length numbers)
//if ($m_length & 1) {
// return self::regularBarrett($n[self::VALUE], $m, $class);
//}
// (m.length + (m.length >> 1) + 1) - (m.length - 1) == (m.length >> 1) + 2
$temp = array_slice($n[self::VALUE], $m_length - 1);
// if even: ((m.length >> 1) + 2) + (m.length >> 1) == m.length + 2
// if odd: ((m.length >> 1) + 2) + (m.length >> 1) == (m.length - 1) + 2 == m.length + 1
$temp = $class::multiplyHelper($temp, false, $u, false);
// if even: (m.length + 2) - ((m.length >> 1) + 1) = m.length - (m.length >> 1) + 1
// if odd: (m.length + 1) - ((m.length >> 1) + 1) = m.length - (m.length >> 1)
$temp = array_slice($temp[self::VALUE], ($m_length >> 1) + 1);
// if even: (m.length - (m.length >> 1) + 1) + m.length = 2 * m.length - (m.length >> 1) + 1
// if odd: (m.length - (m.length >> 1)) + m.length = 2 * m.length - (m.length >> 1)
$temp = $class::multiplyHelper($temp, false, $m, false);
// at this point, if m had an odd number of digits, we'd be subtracting a 2 * m.length - (m.length >> 1) digit
// number from a m.length + (m.length >> 1) + 1 digit number. ie. there'd be an extra digit and the while loop
// following this comment would loop a lot (hence our calling _regularBarrett() in that situation).
$result = $class::subtractHelper($n[self::VALUE], false, $temp[self::VALUE], false);
while (self::compareHelper($result[self::VALUE], $result[self::SIGN], $m, false) >= 0) {
$result = $class::subtractHelper($result[self::VALUE], $result[self::SIGN], $m, false);
}
return $result[self::VALUE];
}
/**
* (Regular) Barrett Modular Reduction
*
* For numbers with more than four digits BigInteger::_barrett() is faster. The difference between that and this
* is that this function does not fold the denominator into a smaller form.
*/
private static function regularBarrett(array $x, array $n, string $class): array
{
static $cache = [
self::VARIABLE => [],
self::DATA => [],
];
$n_length = count($n);
if (count($x) > 2 * $n_length) {
$lhs = new $class();
$rhs = new $class();
$lhs->value = $x;
$rhs->value = $n;
[, $temp] = $lhs->divide($rhs);
return $temp->value;
}
if (($key = array_search($n, $cache[self::VARIABLE])) === false) {
$key = count($cache[self::VARIABLE]);
$cache[self::VARIABLE][] = $n;
$lhs = new $class();
$lhs_value = &$lhs->value;
$lhs_value = self::array_repeat(0, 2 * $n_length);
$lhs_value[] = 1;
$rhs = new $class();
$rhs->value = $n;
[$temp, ] = $lhs->divide($rhs); // m.length
$cache[self::DATA][] = $temp->value;
}
// 2 * m.length - (m.length - 1) = m.length + 1
$temp = array_slice($x, $n_length - 1);
// (m.length + 1) + m.length = 2 * m.length + 1
$temp = $class::multiplyHelper($temp, false, $cache[self::DATA][$key], false);
// (2 * m.length + 1) - (m.length - 1) = m.length + 2
$temp = array_slice($temp[self::VALUE], $n_length + 1);
// m.length + 1
$result = array_slice($x, 0, $n_length + 1);
// m.length + 1
$temp = self::multiplyLower($temp, false, $n, false, $n_length + 1, $class);
// $temp == array_slice($class::regularMultiply($temp, false, $n, false)->value, 0, $n_length + 1)
if (self::compareHelper($result, false, $temp[self::VALUE], $temp[self::SIGN]) < 0) {
$corrector_value = self::array_repeat(0, $n_length + 1);
$corrector_value[count($corrector_value)] = 1;
$result = $class::addHelper($result, false, $corrector_value, false);
$result = $result[self::VALUE];
}
// at this point, we're subtracting a number with m.length + 1 digits from another number with m.length + 1 digits
$result = $class::subtractHelper($result, false, $temp[self::VALUE], $temp[self::SIGN]);
while (self::compareHelper($result[self::VALUE], $result[self::SIGN], $n, false) > 0) {
$result = $class::subtractHelper($result[self::VALUE], $result[self::SIGN], $n, false);
}
return $result[self::VALUE];
}
/**
* Performs long multiplication up to $stop digits
*
* If you're going to be doing array_slice($product->value, 0, $stop), some cycles can be saved.
*
* @see self::regularBarrett()
*/
private static function multiplyLower(array $x_value, bool $x_negative, array $y_value, bool $y_negative, int $stop, string $class): array
{
$x_length = count($x_value);
$y_length = count($y_value);
if (!$x_length || !$y_length) { // a 0 is being multiplied
return [
self::VALUE => [],
self::SIGN => false,
];
}
if ($x_length < $y_length) {
$temp = $x_value;
$x_value = $y_value;
$y_value = $temp;
$x_length = count($x_value);
$y_length = count($y_value);
}
$product_value = self::array_repeat(0, $x_length + $y_length);
// the following for loop could be removed if the for loop following it
// (the one with nested for loops) initially set $i to 0, but
// doing so would also make the result in one set of unnecessary adds,
// since on the outermost loops first pass, $product->value[$k] is going
// to always be 0
$carry = 0;
for ($j = 0; $j < $x_length; ++$j) { // ie. $i = 0, $k = $i
$temp = $x_value[$j] * $y_value[0] + $carry; // $product_value[$k] == 0
$carry = $class::BASE === 26 ? intval($temp / 0x4000000) : ($temp >> 31);
$product_value[$j] = (int) ($temp - $class::BASE_FULL * $carry);
}
if ($j < $stop) {
$product_value[$j] = $carry;
}
// the above for loop is what the previous comment was talking about. the
// following for loop is the "one with nested for loops"
for ($i = 1; $i < $y_length; ++$i) {
$carry = 0;
for ($j = 0, $k = $i; $j < $x_length && $k < $stop; ++$j, ++$k) {
$temp = $product_value[$k] + $x_value[$j] * $y_value[$i] + $carry;
$carry = $class::BASE === 26 ? intval($temp / 0x4000000) : ($temp >> 31);
$product_value[$k] = (int) ($temp - $class::BASE_FULL * $carry);
}
if ($k < $stop) {
$product_value[$k] = $carry;
}
}
return [
self::VALUE => self::trim($product_value),
self::SIGN => $x_negative != $y_negative,
];
}
}

View File

@@ -0,0 +1,39 @@
<?php
/**
* PHP Classic Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP\Reductions;
use phpseclib3\Math\BigInteger\Engines\PHP\Base;
/**
* PHP Classic Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class Classic extends Base
{
/**
* Regular Division
*/
protected static function reduce(array $x, array $n, string $class): array
{
$lhs = new $class();
$lhs->value = $x;
$rhs = new $class();
$rhs->value = $n;
[, $temp] = $lhs->divide($rhs);
return $temp->value;
}
}

View File

@@ -0,0 +1,444 @@
<?php
/**
* PHP Dynamic Barrett Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP\Reductions;
use phpseclib3\Math\BigInteger\Engines\PHP;
use phpseclib3\Math\BigInteger\Engines\PHP\Base;
/**
* PHP Dynamic Barrett Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class EvalBarrett extends Base
{
/**
* Custom Reduction Function
*
* @see self::generateCustomReduction
*/
private static $custom_reduction;
/**
* Barrett Modular Reduction
*
* This calls a dynamically generated loop unrolled function that's specific to a given modulo.
* Array lookups are avoided as are if statements testing for how many bits the host OS supports, etc.
*/
protected static function reduce(array $n, array $m, string $class): array
{
$inline = self::$custom_reduction;
return $inline($n);
}
/**
* Generate Custom Reduction
*/
protected static function generateCustomReduction(PHP $m, string $class): callable
{
$m_length = count($m->value);
if ($m_length < 5) {
$code = '
$lhs = new ' . $class . '();
$lhs->value = $x;
$rhs = new ' . $class . '();
$rhs->value = [' .
implode(',', array_map(self::class . '::float2string', $m->value)) . '];
list(, $temp) = $lhs->divide($rhs);
return $temp->value;
';
eval('$func = function ($x) { ' . $code . '};');
self::$custom_reduction = $func;
//self::$custom_reduction = \Closure::bind($func, $m, $class);
return $func;
}
$lhs = new $class();
$lhs_value = &$lhs->value;
$lhs_value = self::array_repeat(0, $m_length + ($m_length >> 1));
$lhs_value[] = 1;
$rhs = new $class();
[$u, $m1] = $lhs->divide($m);
if ($class::BASE != 26) {
$u = $u->value;
} else {
$lhs_value = self::array_repeat(0, 2 * $m_length);
$lhs_value[] = 1;
$rhs = new $class();
[$u] = $lhs->divide($m);
$u = $u->value;
}
$m = $m->value;
$m1 = $m1->value;
$cutoff = count($m) + (count($m) >> 1);
$code = '
if (count($n) >= ' . (2 * count($m)) . ') {
$lhs = new ' . $class . '();
$rhs = new ' . $class . '();
$lhs->value = $n;
$rhs->value = [' .
implode(',', array_map(self::class . '::float2string', $m)) . '];
list(, $temp) = $lhs->divide($rhs);
return $temp->value;
}
$lsd = array_slice($n, 0, ' . $cutoff . ');
$msd = array_slice($n, ' . $cutoff . ');';
$code .= self::generateInlineTrim('msd');
$code .= self::generateInlineMultiply('msd', $m1, 'temp', $class);
$code .= self::generateInlineAdd('lsd', 'temp', 'n', $class);
$code .= '$temp = array_slice($n, ' . (count($m) - 1) . ');';
$code .= self::generateInlineMultiply('temp', $u, 'temp2', $class);
$code .= self::generateInlineTrim('temp2');
$code .= $class::BASE == 26 ?
'$temp = array_slice($temp2, ' . (count($m) + 1) . ');' :
'$temp = array_slice($temp2, ' . ((count($m) >> 1) + 1) . ');';
$code .= self::generateInlineMultiply('temp', $m, 'temp2', $class);
$code .= self::generateInlineTrim('temp2');
/*
if ($class::BASE == 26) {
$code.= '$n = array_slice($n, 0, ' . (count($m) + 1) . ');
$temp2 = array_slice($temp2, 0, ' . (count($m) + 1) . ');';
}
*/
$code .= self::generateInlineSubtract2('n', 'temp2', 'temp', $class);
$subcode = self::generateInlineSubtract1('temp', $m, 'temp2', $class);
$subcode .= '$temp = $temp2;';
$code .= self::generateInlineCompare($m, 'temp', $subcode);
$code .= 'return $temp;';
eval('$func = function ($n) { ' . $code . '};');
self::$custom_reduction = $func;
return $func;
//self::$custom_reduction = \Closure::bind($func, $m, $class);
}
/**
* Inline Trim
*
* Removes leading zeros
*/
private static function generateInlineTrim(string $name): string
{
return '
for ($i = count($' . $name . ') - 1; $i >= 0; --$i) {
if ($' . $name . '[$i]) {
break;
}
unset($' . $name . '[$i]);
}';
}
/**
* Inline Multiply (unknown, known)
*/
private static function generateInlineMultiply(string $input, array $arr, string $output, string $class): string
{
if (!count($arr)) {
return 'return [];';
}
$regular = '
$length = count($' . $input . ');
if (!$length) {
$' . $output . ' = [];
}else{
$' . $output . ' = array_fill(0, $length + ' . count($arr) . ', 0);
$carry = 0;';
for ($i = 0; $i < count($arr); $i++) {
$regular .= '
$subtemp = $' . $input . '[0] * ' . $arr[$i];
$regular .= $i ? ' + $carry;' : ';';
$regular .= '$carry = ';
$regular .= $class::BASE === 26 ?
'intval($subtemp / 0x4000000);' :
'$subtemp >> 31;';
$regular .=
'$' . $output . '[' . $i . '] = ';
if ($class::BASE === 26) {
$regular .= '(int) (';
}
$regular .= '$subtemp - ' . $class::BASE_FULL . ' * $carry';
$regular .= $class::BASE === 26 ? ');' : ';';
}
$regular .= '$' . $output . '[' . count($arr) . '] = $carry;';
$regular .= '
for ($i = 1; $i < $length; ++$i) {';
for ($j = 0; $j < count($arr); $j++) {
$regular .= $j ? '$k++;' : '$k = $i;';
$regular .= '
$subtemp = $' . $output . '[$k] + $' . $input . '[$i] * ' . $arr[$j];
$regular .= $j ? ' + $carry;' : ';';
$regular .= '$carry = ';
$regular .= $class::BASE === 26 ?
'intval($subtemp / 0x4000000);' :
'$subtemp >> 31;';
$regular .=
'$' . $output . '[$k] = ';
if ($class::BASE === 26) {
$regular .= '(int) (';
}
$regular .= '$subtemp - ' . $class::BASE_FULL . ' * $carry';
$regular .= $class::BASE === 26 ? ');' : ';';
}
$regular .= '$' . $output . '[++$k] = $carry; $carry = 0;';
$regular .= '}}';
//if (count($arr) < 2 * self::KARATSUBA_CUTOFF) {
//}
return $regular;
}
/**
* Inline Addition
*/
private static function generateInlineAdd(string $x, string $y, string $result, string $class): string
{
$code = '
$length = max(count($' . $x . '), count($' . $y . '));
$' . $result . ' = array_pad($' . $x . ', $length + 1, 0);
$_' . $y . ' = array_pad($' . $y . ', $length, 0);
$carry = 0;
for ($i = 0, $j = 1; $j < $length; $i+=2, $j+=2) {
$sum = ($' . $result . '[$j] + $_' . $y . '[$j]) * ' . $class::BASE_FULL . '
+ $' . $result . '[$i] + $_' . $y . '[$i] +
$carry;
$carry = $sum >= ' . self::float2string($class::MAX_DIGIT2) . ';
$sum = $carry ? $sum - ' . self::float2string($class::MAX_DIGIT2) . ' : $sum;';
$code .= $class::BASE === 26 ?
'$upper = intval($sum / 0x4000000); $' . $result . '[$i] = (int) ($sum - ' . $class::BASE_FULL . ' * $upper);' :
'$upper = $sum >> 31; $' . $result . '[$i] = $sum - ' . $class::BASE_FULL . ' * $upper;';
$code .= '
$' . $result . '[$j] = $upper;
}
if ($j == $length) {
$sum = $' . $result . '[$i] + $_' . $y . '[$i] + $carry;
$carry = $sum >= ' . self::float2string($class::BASE_FULL) . ';
$' . $result . '[$i] = $carry ? $sum - ' . self::float2string($class::BASE_FULL) . ' : $sum;
++$i;
}
if ($carry) {
for (; $' . $result . '[$i] == ' . $class::MAX_DIGIT . '; ++$i) {
$' . $result . '[$i] = 0;
}
++$' . $result . '[$i];
}';
$code .= self::generateInlineTrim($result);
return $code;
}
/**
* Inline Subtraction 2
*
* For when $known is more digits than $unknown. This is the harder use case to optimize for.
*/
private static function generateInlineSubtract2(string $known, string $unknown, string $result, string $class): string
{
$code = '
$' . $result . ' = $' . $known . ';
$carry = 0;
$size = count($' . $unknown . ');
for ($i = 0, $j = 1; $j < $size; $i+= 2, $j+= 2) {
$sum = ($' . $known . '[$j] - $' . $unknown . '[$j]) * ' . $class::BASE_FULL . ' + $' . $known . '[$i]
- $' . $unknown . '[$i]
- $carry;
$carry = $sum < 0;
if ($carry) {
$sum+= ' . self::float2string($class::MAX_DIGIT2) . ';
}
$subtemp = ';
$code .= $class::BASE === 26 ?
'intval($sum / 0x4000000);' :
'$sum >> 31;';
$code .= '$' . $result . '[$i] = ';
if ($class::BASE === 26) {
$code .= '(int) (';
}
$code .= '$sum - ' . $class::BASE_FULL . ' * $subtemp';
if ($class::BASE === 26) {
$code .= ')';
}
$code .= ';
$' . $result . '[$j] = $subtemp;
}
if ($j == $size) {
$sum = $' . $known . '[$i] - $' . $unknown . '[$i] - $carry;
$carry = $sum < 0;
$' . $result . '[$i] = $carry ? $sum + ' . $class::BASE_FULL . ' : $sum;
++$i;
}
if ($carry) {
for (; !$' . $result . '[$i]; ++$i) {
$' . $result . '[$i] = ' . $class::MAX_DIGIT . ';
}
--$' . $result . '[$i];
}';
$code .= self::generateInlineTrim($result);
return $code;
}
/**
* Inline Subtraction 1
*
* For when $unknown is more digits than $known. This is the easier use case to optimize for.
*/
private static function generateInlineSubtract1(string $unknown, array $known, string $result, string $class): string
{
$code = '$' . $result . ' = $' . $unknown . ';';
for ($i = 0, $j = 1; $j < count($known); $i += 2, $j += 2) {
$code .= '$sum = $' . $unknown . '[' . $j . '] * ' . $class::BASE_FULL . ' + $' . $unknown . '[' . $i . '] - ';
$code .= self::float2string($known[$j] * $class::BASE_FULL + $known[$i]);
if ($i != 0) {
$code .= ' - $carry';
}
$code .= ';
if ($carry = $sum < 0) {
$sum+= ' . self::float2string($class::MAX_DIGIT2) . ';
}
$subtemp = ';
$code .= $class::BASE === 26 ?
'intval($sum / 0x4000000);' :
'$sum >> 31;';
$code .= '
$' . $result . '[' . $i . '] = ';
if ($class::BASE === 26) {
$code .= ' (int) (';
}
$code .= '$sum - ' . $class::BASE_FULL . ' * $subtemp';
if ($class::BASE === 26) {
$code .= ')';
}
$code .= ';
$' . $result . '[' . $j . '] = $subtemp;';
}
$code .= '$i = ' . $i . ';';
if ($j == count($known)) {
$code .= '
$sum = $' . $unknown . '[' . $i . '] - ' . $known[$i] . ' - $carry;
$carry = $sum < 0;
$' . $result . '[' . $i . '] = $carry ? $sum + ' . $class::BASE_FULL . ' : $sum;
++$i;';
}
$code .= '
if ($carry) {
for (; !$' . $result . '[$i]; ++$i) {
$' . $result . '[$i] = ' . $class::MAX_DIGIT . ';
}
--$' . $result . '[$i];
}';
$code .= self::generateInlineTrim($result);
return $code;
}
/**
* Inline Comparison
*
* If $unknown >= $known then loop
*/
private static function generateInlineCompare(array $known, string $unknown, string $subcode): string
{
$uniqid = uniqid();
$code = 'loop_' . $uniqid . ':
$clength = count($' . $unknown . ');
switch (true) {
case $clength < ' . count($known) . ':
goto end_' . $uniqid . ';
case $clength > ' . count($known) . ':';
for ($i = count($known) - 1; $i >= 0; $i--) {
$code .= '
case $' . $unknown . '[' . $i . '] > ' . $known[$i] . ':
goto subcode_' . $uniqid . ';
case $' . $unknown . '[' . $i . '] < ' . $known[$i] . ':
goto end_' . $uniqid . ';';
}
$code .= '
default:
// do subcode
}
subcode_' . $uniqid . ':' . $subcode . '
goto loop_' . $uniqid . ';
end_' . $uniqid . ':';
return $code;
}
/**
* Convert a float to a string
*
* If you do echo floatval(pow(2, 52)) you'll get 4.6116860184274E+18. It /can/ be displayed without a loss of
* precision but displayed in this way there will be precision loss, hence the need for this method.
*
* @param int|float $num
*/
private static function float2string($num): string
{
if (!is_float($num)) {
return (string) $num;
}
if ($num < 0) {
return '-' . self::float2string(abs($num));
}
$temp = '';
while ($num) {
$temp = fmod($num, 10) . $temp;
$num = floor($num / 10);
}
return $temp;
}
}

View File

@@ -0,0 +1,114 @@
<?php
/**
* PHP Montgomery Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP\Reductions;
use phpseclib3\Math\BigInteger\Engines\PHP\Montgomery as Progenitor;
/**
* PHP Montgomery Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class Montgomery extends Progenitor
{
/**
* Prepare a number for use in Montgomery Modular Reductions
*/
protected static function prepareReduce(array $x, array $n, string $class): array
{
$lhs = new $class();
$lhs->value = array_merge(self::array_repeat(0, count($n)), $x);
$rhs = new $class();
$rhs->value = $n;
[, $temp] = $lhs->divide($rhs);
return $temp->value;
}
/**
* Montgomery Multiply
*
* Interleaves the montgomery reduction and long multiplication algorithms together as described in
* {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=13 HAC 14.36}
*/
protected static function reduce(array $x, array $n, string $class): array
{
static $cache = [
self::VARIABLE => [],
self::DATA => [],
];
if (($key = array_search($n, $cache[self::VARIABLE])) === false) {
$key = count($cache[self::VARIABLE]);
$cache[self::VARIABLE][] = $x;
$cache[self::DATA][] = self::modInverse67108864($n, $class);
}
$k = count($n);
$result = [self::VALUE => $x];
for ($i = 0; $i < $k; ++$i) {
$temp = $result[self::VALUE][$i] * $cache[self::DATA][$key];
$temp = $temp - $class::BASE_FULL * ($class::BASE === 26 ? intval($temp / 0x4000000) : ($temp >> 31));
$temp = $class::regularMultiply([$temp], $n);
$temp = array_merge(self::array_repeat(0, $i), $temp);
$result = $class::addHelper($result[self::VALUE], false, $temp, false);
}
$result[self::VALUE] = array_slice($result[self::VALUE], $k);
if (self::compareHelper($result, false, $n, false) >= 0) {
$result = $class::subtractHelper($result[self::VALUE], false, $n, false);
}
return $result[self::VALUE];
}
/**
* Modular Inverse of a number mod 2**26 (eg. 67108864)
*
* Based off of the bnpInvDigit function implemented and justified in the following URL:
*
* {@link http://www-cs-students.stanford.edu/~tjw/jsbn/jsbn.js}
*
* The following URL provides more info:
*
* {@link http://groups.google.com/group/sci.crypt/msg/7a137205c1be7d85}
*
* As for why we do all the bitmasking... strange things can happen when converting from floats to ints. For
* instance, on some computers, var_dump((int) -4294967297) yields int(-1) and on others, it yields
* int(-2147483648). To avoid problems stemming from this, we use bitmasks to guarantee that ints aren't
* auto-converted to floats. The outermost bitmask is present because without it, there's no guarantee that
* the "residue" returned would be the so-called "common residue". We use fmod, in the last step, because the
* maximum possible $x is 26 bits and the maximum $result is 16 bits. Thus, we have to be able to handle up to
* 40 bits, which only 64-bit floating points will support.
*
* Thanks to Pedro Gimeno Fortea for input!
*/
protected static function modInverse67108864(array $x, string $class): int // 2**26 == 67,108,864
{
$x = -$x[0];
$result = $x & 0x3; // x**-1 mod 2**2
$result = ($result * (2 - $x * $result)) & 0xF; // x**-1 mod 2**4
$result = ($result * (2 - ($x & 0xFF) * $result)) & 0xFF; // x**-1 mod 2**8
$result = ($result * ((2 - ($x & 0xFFFF) * $result) & 0xFFFF)) & 0xFFFF; // x**-1 mod 2**16
$result = $class::BASE == 26 ?
fmod($result * (2 - fmod($x * $result, $class::BASE_FULL)), $class::BASE_FULL) : // x**-1 mod 2**26
($result * (2 - ($x * $result) % $class::BASE_FULL)) % $class::BASE_FULL;
return $result & $class::MAX_DIGIT;
}
}

View File

@@ -0,0 +1,74 @@
<?php
/**
* PHP Montgomery Modular Exponentiation Engine with interleaved multiplication
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP\Reductions;
use phpseclib3\Math\BigInteger\Engines\PHP;
/**
* PHP Montgomery Modular Exponentiation Engine with interleaved multiplication
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class MontgomeryMult extends Montgomery
{
/**
* Montgomery Multiply
*
* Interleaves the montgomery reduction and long multiplication algorithms together as described in
* {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=13 HAC 14.36}
*
* @param class-string<PHP> $class
* @see self::_prepMontgomery()
* @see self::_montgomery()
*/
public static function multiplyReduce(array $x, array $y, array $m, string $class): array
{
// the following code, although not callable, can be run independently of the above code
// although the above code performed better in my benchmarks the following could might
// perform better under different circumstances. in lieu of deleting it it's just been
// made uncallable
static $cache = [
self::VARIABLE => [],
self::DATA => [],
];
if (($key = array_search($m, $cache[self::VARIABLE])) === false) {
$key = count($cache[self::VARIABLE]);
$cache[self::VARIABLE][] = $m;
$cache[self::DATA][] = self::modInverse67108864($m, $class);
}
$n = max(count($x), count($y), count($m));
$x = array_pad($x, $n, 0);
$y = array_pad($y, $n, 0);
$m = array_pad($m, $n, 0);
$a = [self::VALUE => self::array_repeat(0, $n + 1)];
for ($i = 0; $i < $n; ++$i) {
$temp = $a[self::VALUE][0] + $x[$i] * $y[0];
$temp = $temp - $class::BASE_FULL * ($class::BASE === 26 ? intval($temp / 0x4000000) : ($temp >> 31));
$temp = $temp * $cache[self::DATA][$key];
$temp = $temp - $class::BASE_FULL * ($class::BASE === 26 ? intval($temp / 0x4000000) : ($temp >> 31));
$temp = $class::addHelper($class::regularMultiply([$x[$i]], $y), false, $class::regularMultiply([$temp], $m), false);
$a = $class::addHelper($a[self::VALUE], false, $temp[self::VALUE], false);
$a[self::VALUE] = array_slice($a[self::VALUE], 1);
}
if (self::compareHelper($a[self::VALUE], false, $m, false) >= 0) {
$a = $class::subtractHelper($a[self::VALUE], false, $m, false);
}
return $a[self::VALUE];
}
}

View File

@@ -0,0 +1,51 @@
<?php
/**
* PHP Power of Two Modular Exponentiation Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines\PHP\Reductions;
use phpseclib3\Math\BigInteger\Engines\PHP\Base;
/**
* PHP Power Of Two Modular Exponentiation Engine
*
* @author Jim Wigginton <terrafrost@php.net>
*/
abstract class PowerOfTwo extends Base
{
/**
* Prepare a number for use in Montgomery Modular Reductions
*/
protected static function prepareReduce(array $x, array $n, string $class): array
{
return self::reduce($x, $n, $class);
}
/**
* Power Of Two Reduction
*/
protected static function reduce(array $x, array $n, string $class): array
{
$lhs = new $class();
$lhs->value = $x;
$rhs = new $class();
$rhs->value = $n;
$temp = new $class();
$temp->value = [1];
$result = $lhs->bitwise_and($rhs->subtract($temp));
return $result->value;
}
}

View File

@@ -0,0 +1,317 @@
<?php
/**
* Pure-PHP 32-bit BigInteger Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines;
/**
* Pure-PHP 32-bit Engine.
*
* Uses 64-bit floats if int size is 4 bits
*
* @author Jim Wigginton <terrafrost@php.net>
*/
class PHP32 extends PHP
{
// Constants used by PHP.php
public const BASE = 26;
public const BASE_FULL = 0x4000000;
public const MAX_DIGIT = 0x3FFFFFF;
public const MSB = 0x2000000;
/**
* MAX10 in greatest MAX10LEN satisfying
* MAX10 = 10**MAX10LEN <= 2**BASE.
*/
public const MAX10 = 10000000;
/**
* MAX10LEN in greatest MAX10LEN satisfying
* MAX10 = 10**MAX10LEN <= 2**BASE.
*/
public const MAX10LEN = 7;
public const MAX_DIGIT2 = 4503599627370496;
/**
* Initialize a PHP32 BigInteger Engine instance
*
* @see parent::initialize()
*/
protected function initialize(int $base): void
{
if ($base != 256 && $base != -256) {
parent::initialize($base);
return;
}
$val = $this->value;
$this->value = [];
$vals = &$this->value;
$i = strlen($val);
if (!$i) {
return;
}
while (true) {
$i -= 4;
if ($i < 0) {
if ($i == -4) {
break;
}
$val = substr($val, 0, 4 + $i);
$val = str_pad($val, 4, "\0", STR_PAD_LEFT);
if ($val == "\0\0\0\0") {
break;
}
$i = 0;
}
[, $digit] = unpack('N', substr($val, $i, 4));
if ($digit < 0) {
$digit += 0xFFFFFFFF + 1;
}
$step = count($vals) & 3;
if ($step) {
$digit = (int) floor($digit / 2 ** (2 * $step));
}
if ($step != 3) {
$digit = (int) fmod($digit, static::BASE_FULL);
$i++;
}
$vals[] = $digit;
}
while (end($vals) === 0) {
array_pop($vals);
}
reset($vals);
}
/**
* Test for engine validity
*
* @see parent::__construct()
*/
public static function isValidEngine(): bool
{
return PHP_INT_SIZE >= 4 && !self::testJITOnWindows();
}
/**
* Adds two BigIntegers.
*/
public function add(PHP32 $y): PHP32
{
$temp = self::addHelper($this->value, $this->is_negative, $y->value, $y->is_negative);
return $this->convertToObj($temp);
}
/**
* Subtracts two BigIntegers.
*/
public function subtract(PHP32 $y): PHP32
{
$temp = self::subtractHelper($this->value, $this->is_negative, $y->value, $y->is_negative);
return $this->convertToObj($temp);
}
/**
* Multiplies two BigIntegers.
*/
public function multiply(PHP32 $y): PHP32
{
$temp = self::multiplyHelper($this->value, $this->is_negative, $y->value, $y->is_negative);
return $this->convertToObj($temp);
}
/**
* Divides two BigIntegers.
*
* Returns an array whose first element contains the quotient and whose second element contains the
* "common residue". If the remainder would be positive, the "common residue" and the remainder are the
* same. If the remainder would be negative, the "common residue" is equal to the sum of the remainder
* and the divisor (basically, the "common residue" is the first positive modulo).
*
* @return array{PHP32, PHP32}
*/
public function divide(PHP32 $y): array
{
return $this->divideHelper($y);
}
/**
* Calculates modular inverses.
*
* Say you have (30 mod 17 * x mod 17) mod 17 == 1. x can be found using modular inverses.
* @return false|PHP32
*/
public function modInverse(PHP32 $n)
{
return $this->modInverseHelper($n);
}
/**
* Calculates modular inverses.
*
* Say you have (30 mod 17 * x mod 17) mod 17 == 1. x can be found using modular inverses.
* @return PHP32[]
*/
public function extendedGCD(PHP32 $n): array
{
return $this->extendedGCDHelper($n);
}
/**
* Calculates the greatest common divisor
*
* Say you have 693 and 609. The GCD is 21.
*/
public function gcd(PHP32 $n): PHP32
{
return $this->extendedGCD($n)['gcd'];
}
/**
* Logical And
*/
public function bitwise_and(PHP32 $x): PHP32
{
return $this->bitwiseAndHelper($x);
}
/**
* Logical Or
*/
public function bitwise_or(PHP32 $x): PHP32
{
return $this->bitwiseOrHelper($x);
}
/**
* Logical Exclusive Or
*/
public function bitwise_xor(PHP32 $x): PHP32
{
return $this->bitwiseXorHelper($x);
}
/**
* Compares two numbers.
*
* Although one might think !$x->compare($y) means $x != $y, it, in fact, means the opposite. The reason for this is
* demonstrated thusly:
*
* $x > $y: $x->compare($y) > 0
* $x < $y: $x->compare($y) < 0
* $x == $y: $x->compare($y) == 0
*
* Note how the same comparison operator is used. If you want to test for equality, use $x->equals($y).
*
* {@internal Could return $this->subtract($x), but that's not as fast as what we do do.}
*
* @return int in case < 0 if $this is less than $y; > 0 if $this is greater than $y, and 0 if they are equal.
* @see self::equals()
*/
public function compare(PHP32 $y): int
{
return $this->compareHelper($this->value, $this->is_negative, $y->value, $y->is_negative);
}
/**
* Tests the equality of two numbers.
*
* If you need to see if one number is greater than or less than another number, use BigInteger::compare()
*/
public function equals(PHP32 $x): bool
{
return $this->value === $x->value && $this->is_negative == $x->is_negative;
}
/**
* Performs modular exponentiation.
*/
public function modPow(PHP32 $e, PHP32 $n): PHP32
{
return $this->powModOuter($e, $n);
}
/**
* Performs modular exponentiation.
*
* Alias for modPow().
*/
public function powMod(PHP32 $e, PHP32 $n): PHP32
{
return $this->powModOuter($e, $n);
}
/**
* Generate a random prime number between a range
*
* If there's not a prime within the given range, false will be returned.
*
* @return false|PHP32
*/
public static function randomRangePrime(PHP32 $min, PHP32 $max)
{
return self::randomRangePrimeOuter($min, $max);
}
/**
* Generate a random number between a range
*
* Returns a random number between $min and $max where $min and $max
* can be defined using one of the two methods:
*
* BigInteger::randomRange($min, $max)
* BigInteger::randomRange($max, $min)
*/
public static function randomRange(PHP32 $min, PHP32 $max): PHP32
{
return self::randomRangeHelper($min, $max);
}
/**
* Performs exponentiation.
*/
public function pow(PHP32 $n): PHP32
{
return $this->powHelper($n);
}
/**
* Return the minimum BigInteger between an arbitrary number of BigIntegers.
*/
public static function min(PHP32 ...$nums): PHP32
{
return self::minHelper($nums);
}
/**
* Return the maximum BigInteger between an arbitrary number of BigIntegers.
*/
public static function max(PHP32 ...$nums): PHP32
{
return self::maxHelper($nums);
}
/**
* Tests BigInteger to see if it is between two integers, inclusive
*/
public function between(PHP32 $min, PHP32 $max): bool
{
return $this->compare($min) >= 0 && $this->compare($max) <= 0;
}
}

View File

@@ -0,0 +1,320 @@
<?php
/**
* Pure-PHP 64-bit BigInteger Engine
*
* PHP version 5 and 7
*
* @author Jim Wigginton <terrafrost@php.net>
* @copyright 2017 Jim Wigginton
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link http://pear.php.net/package/Math_BigInteger
*/
declare(strict_types=1);
namespace phpseclib3\Math\BigInteger\Engines;
/**
* Pure-PHP 64-bit Engine.
*
* Uses 64-bit integers if int size is 8 bits
*
* @author Jim Wigginton <terrafrost@php.net>
*/
class PHP64 extends PHP
{
// Constants used by PHP.php
public const BASE = 31;
public const BASE_FULL = 0x80000000;
public const MAX_DIGIT = 0x7FFFFFFF;
public const MSB = 0x40000000;
/**
* MAX10 in greatest MAX10LEN satisfying
* MAX10 = 10**MAX10LEN <= 2**BASE.
*/
public const MAX10 = 1000000000;
/**
* MAX10LEN in greatest MAX10LEN satisfying
* MAX10 = 10**MAX10LEN <= 2**BASE.
*/
public const MAX10LEN = 9;
public const MAX_DIGIT2 = 4611686018427387904;
/**
* Initialize a PHP64 BigInteger Engine instance
*
* @see parent::initialize()
*/
protected function initialize(int $base): void
{
if ($base != 256 && $base != -256) {
parent::initialize($base);
return;
}
$val = $this->value;
$this->value = [];
$vals = &$this->value;
$i = strlen($val);
if (!$i) {
return;
}
while (true) {
$i -= 4;
if ($i < 0) {
if ($i == -4) {
break;
}
$val = substr($val, 0, 4 + $i);
$val = str_pad($val, 4, "\0", STR_PAD_LEFT);
if ($val == "\0\0\0\0") {
break;
}
$i = 0;
}
[, $digit] = unpack('N', substr($val, $i, 4));
$step = count($vals) & 7;
if (!$step) {
$digit &= static::MAX_DIGIT;
$i++;
} else {
$shift = 8 - $step;
$digit >>= $shift;
$shift = 32 - $shift;
$digit &= (1 << $shift) - 1;
$temp = $i > 0 ? ord($val[$i - 1]) : 0;
$digit |= ($temp << $shift) & 0x7F000000;
}
$vals[] = $digit;
}
while (end($vals) === 0) {
array_pop($vals);
}
reset($vals);
}
/**
* Test for engine validity
*
* @see parent::__construct()
*/
public static function isValidEngine(): bool
{
return PHP_INT_SIZE >= 8 && !self::testJITOnWindows();
}
/**
* Adds two BigIntegers.
*/
public function add(PHP64 $y): PHP64
{
$temp = self::addHelper($this->value, $this->is_negative, $y->value, $y->is_negative);
return $this->convertToObj($temp);
}
/**
* Subtracts two BigIntegers.
*/
public function subtract(PHP64 $y): PHP64
{
$temp = self::subtractHelper($this->value, $this->is_negative, $y->value, $y->is_negative);
return $this->convertToObj($temp);
}
/**
* Multiplies two BigIntegers.
*/
public function multiply(PHP64 $y): PHP64
{
$temp = self::multiplyHelper($this->value, $this->is_negative, $y->value, $y->is_negative);
return $this->convertToObj($temp);
}
/**
* Divides two BigIntegers.
*
* Returns an array whose first element contains the quotient and whose second element contains the
* "common residue". If the remainder would be positive, the "common residue" and the remainder are the
* same. If the remainder would be negative, the "common residue" is equal to the sum of the remainder
* and the divisor (basically, the "common residue" is the first positive modulo).
*
* @return array{PHP64, PHP64}
*/
public function divide(PHP64 $y): array
{
return $this->divideHelper($y);
}
/**
* Calculates modular inverses.
*
* Say you have (30 mod 17 * x mod 17) mod 17 == 1. x can be found using modular inverses.
* @return false|PHP64
*/
public function modInverse(PHP64 $n)
{
return $this->modInverseHelper($n);
}
/**
* Calculates modular inverses.
*
* Say you have (30 mod 17 * x mod 17) mod 17 == 1. x can be found using modular inverses.
* @return PHP64[]
*/
public function extendedGCD(PHP64 $n): array
{
return $this->extendedGCDHelper($n);
}
/**
* Calculates the greatest common divisor
*
* Say you have 693 and 609. The GCD is 21.
*/
public function gcd(PHP64 $n): PHP64
{
return $this->extendedGCD($n)['gcd'];
}
/**
* Logical And
*/
public function bitwise_and(PHP64 $x): PHP64
{
return $this->bitwiseAndHelper($x);
}
/**
* Logical Or
*/
public function bitwise_or(PHP64 $x): PHP64
{
return $this->bitwiseOrHelper($x);
}
/**
* Logical Exclusive Or
*/
public function bitwise_xor(PHP64 $x): PHP64
{
return $this->bitwiseXorHelper($x);
}
/**
* Compares two numbers.
*
* Although one might think !$x->compare($y) means $x != $y, it, in fact, means the opposite. The reason for this is
* demonstrated thusly:
*
* $x > $y: $x->compare($y) > 0
* $x < $y: $x->compare($y) < 0
* $x == $y: $x->compare($y) == 0
*
* Note how the same comparison operator is used. If you want to test for equality, use $x->equals($y).
*
* {@internal Could return $this->subtract($x), but that's not as fast as what we do do.}
*
* @return int in case < 0 if $this is less than $y; > 0 if $this is greater than $y, and 0 if they are equal.
* @see self::equals()
*/
public function compare(PHP64 $y): int
{
return parent::compareHelper($this->value, $this->is_negative, $y->value, $y->is_negative);
}
/**
* Tests the equality of two numbers.
*
* If you need to see if one number is greater than or less than another number, use BigInteger::compare()
*/
public function equals(PHP64 $x): bool
{
return $this->value === $x->value && $this->is_negative == $x->is_negative;
}
/**
* Performs modular exponentiation.
*/
public function modPow(PHP64 $e, PHP64 $n): PHP64
{
return $this->powModOuter($e, $n);
}
/**
* Performs modular exponentiation.
*
* Alias for modPow().
*
* @return PHP64|false
*/
public function powMod(PHP64 $e, PHP64 $n)
{
return $this->powModOuter($e, $n);
}
/**
* Generate a random prime number between a range
*
* If there's not a prime within the given range, false will be returned.
*
* @return false|PHP64
*/
public static function randomRangePrime(PHP64 $min, PHP64 $max)
{
return self::randomRangePrimeOuter($min, $max);
}
/**
* Generate a random number between a range
*
* Returns a random number between $min and $max where $min and $max
* can be defined using one of the two methods:
*
* BigInteger::randomRange($min, $max)
* BigInteger::randomRange($max, $min)
*/
public static function randomRange(PHP64 $min, PHP64 $max): PHP64
{
return self::randomRangeHelper($min, $max);
}
/**
* Performs exponentiation.
*/
public function pow(PHP64 $n): PHP64
{
return $this->powHelper($n);
}
/**
* Return the minimum BigInteger between an arbitrary number of BigIntegers.
*/
public static function min(PHP64 ...$nums): PHP64
{
return self::minHelper($nums);
}
/**
* Return the maximum BigInteger between an arbitrary number of BigIntegers.
*/
public static function max(PHP64 ...$nums): PHP64
{
return self::maxHelper($nums);
}
/**
* Tests BigInteger to see if it is between two integers, inclusive
*/
public function between(PHP64 $min, PHP64 $max): bool
{
return $this->compare($min) >= 0 && $this->compare($max) <= 0;
}
}