Update copyright year, make totallyTyped (Psalm).

paragonie · Jan 23, 2018 · 20130f4 · 20130f4
1 parent 7c74c5d
commit 20130f4
Show file tree

Hide file tree

Showing 13 changed files with 84 additions and 15 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Paragon Initiative Enterprises
+Copyright (c) 2016 - 2018 Paragon Initiative Enterprises
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/psalm.xml b/psalm.xml
@@ -2,7 +2,7 @@
 <psalm
     stopOnFirstError="false"
     useDocblockTypes="true"
-    totallyTyped="false"
+    totallyTyped="true"
 >
     <projectFiles>
         <directory name="src" />

diff --git a/src/Base32.php b/src/Base32.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 - 2017 Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -150,7 +150,7 @@ protected static function decode5BitsUpper(int $src): int
      * Uses bitwise operators instead of table-lookups to turn 8-bit integers
      * into 5-bit integers.
      *
-     * @param $src
+     * @param int $src
      * @return string
      */
     protected static function encode5Bits(int $src): string
@@ -169,7 +169,7 @@ protected static function encode5Bits(int $src): string
      *
      * Uppercase variant.
      *
-     * @param $src
+     * @param int $src
      * @return string
      */
     protected static function encode5BitsUpper(int $src): string
@@ -228,14 +228,23 @@ protected static function doDecode(string $src, bool $upper = false, bool $stric
         $dest = '';
         // Main loop (no padding):
         for ($i = 0; $i + 8 <= $srcLen; $i += 8) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C*', Binary::safeSubstr($src, $i, 8));
+            /** @var int $c0 */
             $c0 = static::$method($chunk[1]);
+            /** @var int $c1 */
             $c1 = static::$method($chunk[2]);
+            /** @var int $c2 */
             $c2 = static::$method($chunk[3]);
+            /** @var int $c3 */
             $c3 = static::$method($chunk[4]);
+            /** @var int $c4 */
             $c4 = static::$method($chunk[5]);
+            /** @var int $c5 */
             $c5 = static::$method($chunk[6]);
+            /** @var int $c6 */
             $c6 = static::$method($chunk[7]);
+            /** @var int $c7 */
             $c7 = static::$method($chunk[8]);
 
             $dest .= \pack(
@@ -250,15 +259,23 @@ protected static function doDecode(string $src, bool $upper = false, bool $stric
         }
         // The last chunk, which may have padding:
         if ($i < $srcLen) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C*', Binary::safeSubstr($src, $i, $srcLen - $i));
+            /** @var int $c0 */
             $c0 = static::$method($chunk[1]);
 
             if ($i + 6 < $srcLen) {
+                /** @var int $c1 */
                 $c1 = static::$method($chunk[2]);
+                /** @var int $c2 */
                 $c2 = static::$method($chunk[3]);
+                /** @var int $c3 */
                 $c3 = static::$method($chunk[4]);
+                /** @var int $c4 */
                 $c4 = static::$method($chunk[5]);
+                /** @var int $c5 */
                 $c5 = static::$method($chunk[6]);
+                /** @var int $c6 */
                 $c6 = static::$method($chunk[7]);
 
                 $dest .= \pack(
@@ -270,10 +287,15 @@ protected static function doDecode(string $src, bool $upper = false, bool $stric
                 );
                 $err |= ($c0 | $c1 | $c2 | $c3 | $c4 | $c5 | $c6) >> 8;
             } elseif ($i + 5 < $srcLen) {
+                /** @var int $c1 */
                 $c1 = static::$method($chunk[2]);
+                /** @var int $c2 */
                 $c2 = static::$method($chunk[3]);
+                /** @var int $c3 */
                 $c3 = static::$method($chunk[4]);
+                /** @var int $c4 */
                 $c4 = static::$method($chunk[5]);
+                /** @var int $c5 */
                 $c5 = static::$method($chunk[6]);
 
                 $dest .= \pack(
@@ -285,9 +307,13 @@ protected static function doDecode(string $src, bool $upper = false, bool $stric
                 );
                 $err |= ($c0 | $c1 | $c2 | $c3 | $c4 | $c5) >> 8;
             } elseif ($i + 4 < $srcLen) {
+                /** @var int $c1 */
                 $c1 = static::$method($chunk[2]);
+                /** @var int $c2 */
                 $c2 = static::$method($chunk[3]);
+                /** @var int $c3 */
                 $c3 = static::$method($chunk[4]);
+                /** @var int $c4 */
                 $c4 = static::$method($chunk[5]);
 
                 $dest .= \pack(
@@ -298,8 +324,11 @@ protected static function doDecode(string $src, bool $upper = false, bool $stric
                 );
                 $err |= ($c0 | $c1 | $c2 | $c3 | $c4) >> 8;
             } elseif ($i + 3 < $srcLen) {
+                /** @var int $c1 */
                 $c1 = static::$method($chunk[2]);
+                /** @var int $c2 */
                 $c2 = static::$method($chunk[3]);
+                /** @var int $c3 */
                 $c3 = static::$method($chunk[4]);
 
                 $dest .= \pack(
@@ -309,7 +338,9 @@ protected static function doDecode(string $src, bool $upper = false, bool $stric
                 );
                 $err |= ($c0 | $c1 | $c2 | $c3) >> 8;
             } elseif ($i + 2 < $srcLen) {
+                /** @var int $c1 */
                 $c1 = static::$method($chunk[2]);
+                /** @var int $c2 */
                 $c2 = static::$method($chunk[3]);
 
                 $dest .= \pack(
@@ -319,6 +350,7 @@ protected static function doDecode(string $src, bool $upper = false, bool $stric
                 );
                 $err |= ($c0 | $c1 | $c2) >> 8;
             } elseif ($i + 1 < $srcLen) {
+                /** @var int $c1 */
                 $c1 = static::$method($chunk[2]);
 
                 $dest .= \pack(
@@ -363,6 +395,7 @@ protected static function doEncode(string $src, bool $upper = false, $pad = true
 
         // Main loop (no padding):
         for ($i = 0; $i + 5 <= $srcLen; $i += 5) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C*', Binary::safeSubstr($src, $i, 5));
             $b0 = $chunk[1];
             $b1 = $chunk[2];
@@ -381,6 +414,7 @@ protected static function doEncode(string $src, bool $upper = false, $pad = true
         }
         // The last chunk, which may have padding:
         if ($i < $srcLen) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C*', Binary::safeSubstr($src, $i, $srcLen - $i));
             $b0 = $chunk[1];
             if ($i + 3 < $srcLen) {

diff --git a/src/Base32Hex.php b/src/Base32Hex.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 - 2017  Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/src/Base64.php b/src/Base64.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 - 2017 Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -40,6 +40,7 @@ abstract class Base64 implements EncoderInterface
      *
      * @param string $src
      * @return string
+     * @throws \TypeError
      */
     public static function encode(string $src): string
     {
@@ -72,6 +73,7 @@ protected static function doEncode(string $src, bool $pad = true): string
         $srcLen = Binary::safeStrlen($src);
         // Main loop (no padding):
         for ($i = 0; $i + 3 <= $srcLen; $i += 3) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C*', Binary::safeSubstr($src, $i, 3));
             $b0 = $chunk[1];
             $b1 = $chunk[2];
@@ -85,6 +87,7 @@ protected static function doEncode(string $src, bool $pad = true): string
         }
         // The last chunk, which may have padding:
         if ($i < $srcLen) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C*', Binary::safeSubstr($src, $i, $srcLen - $i));
             $b0 = $chunk[1];
             if ($i + 1 < $srcLen) {
@@ -155,6 +158,7 @@ public static function decode(string $src, bool $strictPadding = false): string
         $dest = '';
         // Main loop (no padding):
         for ($i = 0; $i + 4 <= $srcLen; $i += 4) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C*', Binary::safeSubstr($src, $i, 4));
             $c0 = static::decode6Bits($chunk[1]);
             $c1 = static::decode6Bits($chunk[2]);
@@ -171,6 +175,7 @@ public static function decode(string $src, bool $strictPadding = false): string
         }
         // The last chunk, which may have padding:
         if ($i < $srcLen) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C*', Binary::safeSubstr($src, $i, $srcLen - $i));
             $c0 = static::decode6Bits($chunk[1]);
 

diff --git a/src/Base64DotSlash.php b/src/Base64DotSlash.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 - 2017 Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/src/Base64DotSlashOrdered.php b/src/Base64DotSlashOrdered.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 - 2017 Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/src/Base64UrlSafe.php b/src/Base64UrlSafe.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 - 2017 Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/src/Binary.php b/src/Binary.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 - 2017 Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/src/EncoderInterface.php b/src/EncoderInterface.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/src/Encoding.php b/src/Encoding.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -132,6 +132,7 @@ public static function base32HexDecodeUpper(string $str): string
      *
      * @param string $str
      * @return string
+     * @throws \TypeError
      */
     public static function base64Encode(string $str): string
     {
@@ -156,6 +157,7 @@ public static function base64Decode(string $str): string
      * Base64 character set "./[A-Z][a-z][0-9]"
      * @param string $str
      * @return string
+     * @throws \TypeError
      */
     public static function base64EncodeDotSlash(string $str): string
     {
@@ -183,6 +185,7 @@ public static function base64DecodeDotSlash(string $str): string
      * Base64 character set "[.-9][A-Z][a-z]" or "./[0-9][A-Z][a-z]"
      * @param string $str
      * @return string
+     * @throws \TypeError
      */
     public static function base64EncodeDotSlashOrdered(string $str): string
     {

diff --git a/src/Hex.php b/src/Hex.php
@@ -3,7 +3,7 @@
 namespace ParagonIE\ConstantTime;
 
 /**
- *  Copyright (c) 2016 - 2017 Paragon Initiative Enterprises.
+ *  Copyright (c) 2016 - 2018 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -41,12 +41,17 @@ abstract class Hex implements EncoderInterface
      */
     public static function encode(string $binString): string
     {
+        /** @var string $hex */
         $hex = '';
         $len = Binary::safeStrlen($binString);
         for ($i = 0; $i < $len; ++$i) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C', Binary::safeSubstr($binString, $i, 1));
+            /** @var int $c */
             $c = $chunk[1] & 0xf;
+            /** @var int $b */
             $b = $chunk[1] >> 4;
+
             $hex .= pack(
                 'CC',
                 (87 + $b + ((($b - 10) >> 8) & ~38)),
@@ -66,12 +71,19 @@ public static function encode(string $binString): string
      */
     public static function encodeUpper(string $binString): string
     {
+        /** @var string $hex */
         $hex = '';
+        /** @var int $len */
         $len = Binary::safeStrlen($binString);
+
         for ($i = 0; $i < $len; ++$i) {
+            /** @var array<int, int> $chunk */
             $chunk = \unpack('C', Binary::safeSubstr($binString, $i, 2));
+            /** @var int $c */
             $c = $chunk[1] & 0xf;
+            /** @var int $b */
             $b = $chunk[1] >> 4;
+
             $hex .= pack(
                 'CC',
                 (55 + $b + ((($b - 10) >> 8) & ~6)),
@@ -92,10 +104,15 @@ public static function encodeUpper(string $binString): string
      */
     public static function decode(string $hexString, bool $strictPadding = false): string
     {
+        /** @var int $hex_pos */
         $hex_pos = 0;
+        /** @var string $bin */
         $bin = '';
+        /** @var int $c_acc */
         $c_acc = 0;
+        /** @var int $hex_len */
         $hex_len = Binary::safeStrlen($hexString);
+        /** @var int $state */
         $state = 0;
         if (($hex_len & 1) !== 0) {
             if ($strictPadding) {
@@ -108,19 +125,27 @@ public static function decode(string $hexString, bool $strictPadding = false): s
             }
         }
 
+        /** @var array<int, ing> $chunk */
         $chunk = \unpack('C*', $hexString);
         while ($hex_pos < $hex_len) {
             ++$hex_pos;
+            /** @var int $c */
             $c = $chunk[$hex_pos];
+            /** @var int $c_num */
             $c_num = $c ^ 48;
+            /** @var int $c_num0 */
             $c_num0 = ($c_num - 10) >> 8;
+            /** @var int $c_alpha */
             $c_alpha = ($c & ~32) - 55;
+            /** @var int $c_alpha0 */
             $c_alpha0 = (($c_alpha - 10) ^ ($c_alpha - 16)) >> 8;
+
             if (($c_num0 | $c_alpha0) === 0) {
                 throw new \RangeException(
                     'hexEncode() only expects hexadecimal characters'
                 );
             }
+            /** @var int $c_val */
             $c_val = ($c_num0 & $c_num) | ($c_alpha & $c_alpha0);
             if ($state === 0) {
                 $c_acc = $c_val * 16;