PHP Classes

File: src/Core32/Curve25519/Fe.php

Recommend this page to a friend!
  Classes of Scott Arciszewski   PHP Sodium Compat   src/Core32/Curve25519/Fe.php   Download  
File: src/Core32/Curve25519/Fe.php
Role: Class source
Content type: text/plain
Description: Class source
Class: PHP Sodium Compat
Cryptographic functions of libsodium in pure PHP
Author: By
Last change: Fix myriad bugs with PHP 8.1 on x86

Related to #140, determined from local testing as per https://github.com/paragonie/sodium_compat/issues/140#issuecomment-1076132051
PHP 8.1: fix deprecation warnings

As of PHP 8.1, PHP will start throwing deprecation warnings along the lines of:
```
Deprecated: Return type of [CLASS]::[METHOD]() should either be compatible with [PHP NATIVE INTERFACE]::[METHOD](): [TYPE], or the #[ReturnTypeWillChange] attribute should be used to temporarily suppress the notice
```

These type of deprecation notices relate to the [Return types for internal methods RFC](https://wiki.php.net/rfc/internal_method_return_types) in PHP 8.1.

Basically, as of PHP 8.1, these methods in classes which implement PHP native interfaces are expected to have a return type declared.
The return type can be the same as used in PHP itself or a more specific type. This complies with the Liskov principle of covariance, which allows the return type of a child overloaded method to be more specific than that of the parent.

As this package has a minimum PHP requirement of PHP 5.2 based on the `composer.json` file, the return type (PHP 7.0 feature) can not be added, so I've added the attribute instead.

While attributes are a PHP 8.0 feature only, due to the syntax choice for `#[]`, they will ignored in PHP < 8 and can be safely added.
Date: 1 year ago
Size: 5,498 bytes
 

Contents

Class file image Download
<?php

if (class_exists('ParagonIE_Sodium_Core32_Curve25519_Fe', false)) {
    return;
}

/**
 * Class ParagonIE_Sodium_Core32_Curve25519_Fe
 *
 * This represents a Field Element
 */
class ParagonIE_Sodium_Core32_Curve25519_Fe implements ArrayAccess
{
   
/**
     * @var array<int, ParagonIE_Sodium_Core32_Int32>
     */
   
protected $container = array();

   
/**
     * @var int
     */
   
protected $size = 10;

   
/**
     * @internal You should not use this directly from another application
     *
     * @param array<int, ParagonIE_Sodium_Core32_Int32> $array
     * @param bool $save_indexes
     * @return self
     * @throws SodiumException
     * @throws TypeError
     */
   
public static function fromArray($array, $save_indexes = null)
    {
       
$count = count($array);
        if (
$save_indexes) {
           
$keys = array_keys($array);
        } else {
           
$keys = range(0, $count - 1);
        }
       
$array = array_values($array);

       
$obj = new ParagonIE_Sodium_Core32_Curve25519_Fe();
        if (
$save_indexes) {
            for (
$i = 0; $i < $count; ++$i) {
               
$array[$i]->overflow = 0;
               
$obj->offsetSet($keys[$i], $array[$i]);
            }
        } else {
            for (
$i = 0; $i < $count; ++$i) {
                if (!(
$array[$i] instanceof ParagonIE_Sodium_Core32_Int32)) {
                    throw new
TypeError('Expected ParagonIE_Sodium_Core32_Int32');
                }
               
$array[$i]->overflow = 0;
               
$obj->offsetSet($i, $array[$i]);
            }
        }
        return
$obj;
    }

   
/**
     * @internal You should not use this directly from another application
     *
     * @param array<int, int> $array
     * @param bool $save_indexes
     * @return self
     * @throws SodiumException
     * @throws TypeError
     */
   
public static function fromIntArray($array, $save_indexes = null)
    {
       
$count = count($array);
        if (
$save_indexes) {
           
$keys = array_keys($array);
        } else {
           
$keys = range(0, $count - 1);
        }
       
$array = array_values($array);
       
$set = array();
       
/** @var int $i */
        /** @var int $v */
       
foreach ($array as $i => $v) {
           
$set[$i] = ParagonIE_Sodium_Core32_Int32::fromInt($v);
        }

       
$obj = new ParagonIE_Sodium_Core32_Curve25519_Fe();
        if (
$save_indexes) {
            for (
$i = 0; $i < $count; ++$i) {
               
$set[$i]->overflow = 0;
               
$obj->offsetSet($keys[$i], $set[$i]);
            }
        } else {
            for (
$i = 0; $i < $count; ++$i) {
               
$set[$i]->overflow = 0;
               
$obj->offsetSet($i, $set[$i]);
            }
        }
        return
$obj;
    }

   
/**
     * @internal You should not use this directly from another application
     *
     * @param mixed $offset
     * @param mixed $value
     * @return void
     * @throws SodiumException
     * @throws TypeError
     */
    #[ReturnTypeWillChange]
   
public function offsetSet($offset, $value)
    {
        if (!(
$value instanceof ParagonIE_Sodium_Core32_Int32)) {
            throw new
InvalidArgumentException('Expected an instance of ParagonIE_Sodium_Core32_Int32');
        }
        if (
is_null($offset)) {
           
$this->container[] = $value;
        } else {
           
ParagonIE_Sodium_Core32_Util::declareScalarType($offset, 'int', 1);
           
$this->container[(int) $offset] = $value;
        }
    }

   
/**
     * @internal You should not use this directly from another application
     *
     * @param mixed $offset
     * @return bool
     * @psalm-suppress MixedArrayOffset
     */
    #[ReturnTypeWillChange]
   
public function offsetExists($offset)
    {
        return isset(
$this->container[$offset]);
    }

   
/**
     * @internal You should not use this directly from another application
     *
     * @param mixed $offset
     * @return void
     * @psalm-suppress MixedArrayOffset
     */
    #[ReturnTypeWillChange]
   
public function offsetUnset($offset)
    {
        unset(
$this->container[$offset]);
    }

   
/**
     * @internal You should not use this directly from another application
     *
     * @param mixed $offset
     * @return ParagonIE_Sodium_Core32_Int32
     * @psalm-suppress MixedArrayOffset
     */
    #[ReturnTypeWillChange]
   
public function offsetGet($offset)
    {
        if (!isset(
$this->container[$offset])) {
           
$this->container[(int) $offset] = new ParagonIE_Sodium_Core32_Int32();
        }
       
/** @var ParagonIE_Sodium_Core32_Int32 $get */
       
$get = $this->container[$offset];
        return
$get;
    }

   
/**
     * @internal You should not use this directly from another application
     *
     * @return array
     */
   
public function __debugInfo()
    {
        if (empty(
$this->container)) {
            return array();
        }
       
$c = array(
            (int) (
$this->container[0]->toInt()),
            (int) (
$this->container[1]->toInt()),
            (int) (
$this->container[2]->toInt()),
            (int) (
$this->container[3]->toInt()),
            (int) (
$this->container[4]->toInt()),
            (int) (
$this->container[5]->toInt()),
            (int) (
$this->container[6]->toInt()),
            (int) (
$this->container[7]->toInt()),
            (int) (
$this->container[8]->toInt()),
            (int) (
$this->container[9]->toInt())
        );
        return array(
implode(', ', $c));
    }
}