build: v1.0.1

Author: LordDashMe

.travis.yml

@@ -4,6 +4,7 @@ php:
   - 7.1
   - 7.0
   - 5.6
+  - 5.3
 before_script:
 script: 
   - rm composer.lock

README.md

@@ -16,10 +16,6 @@ A PHP library for RFC 4226 and RFC 6238.
 composer require lorddashme/php-two-factor-auth
 ```
 
-### Native Way
-
-- @TODO
-
 ## Usage
 
 ### HOTP
@@ -34,8 +30,12 @@ require __DIR__  . '/vendor/autoload.php';
 use LordDashMe\TwoFactorAuth\RFC4226\HOTP;
 use LordDashMe\TwoFactorAuth\Utility\Base32;
 
-$hotp = new HOTP(Base32::encode('P@ssw0rd!'));
+$secret = Base32::encode('P@ssw0rd!');
+
+$hotp = new HOTP($secret);
+
 $hotp->setLength(6)
+     ->setAlgorithm('sha1')
      ->prepare()
      ->generate();
 
@@ -52,8 +52,12 @@ require __DIR__  . '/vendor/autoload.php';
 use LordDashMe\TwoFactorAuth\RFC4226\HOTP;
 use LordDashMe\TwoFactorAuth\Utility\Base32;
 
-$hotp = new HOTP(Base32::encode('P@ssw0rd!'));
+$secret = Base32::encode('P@ssw0rd!');
+
+$hotp = new HOTP($secret);
+
 $hotp->setLength(6)
+     ->setAlgorithm('sha1')
      ->prepare();
 
 echo $hotp->verify('444555'); // true
@@ -71,10 +75,15 @@ require __DIR__  . '/vendor/autoload.php';
 use LordDashMe\TwoFactorAuth\RFC6238\TOTP;
 use LordDashMe\TwoFactorAuth\Utility\Base32;
 
-$totp = new TOTP(Base32::encode('P@ssw0rd!'));
-$totp->setTimeRemainingInSeconds(30)
+$secret = Base32::encode('P@ssw0rd!');
+
+$totp = new TOTP($secret);
+
+$totp->setTimeZone('Asia/Manila')
+     ->setTimeRemainingInSeconds(30)
      ->setTimeAdjustments(10)
      ->setLength(6)
+     ->setAlgorithm('sha1')
      ->prepare()
      ->generate();
 
@@ -91,10 +100,15 @@ require __DIR__  . '/vendor/autoload.php';
 use LordDashMe\TwoFactorAuth\RFC6238\TOTP;
 use LordDashMe\TwoFactorAuth\Utility\Base32;
 
-$totp = new TOTP(Base32::encode('P@ssw0rd!'));
-$totp->setTimeRemainingInSeconds(30)
+$secret = Base32::encode('P@ssw0rd!');
+
+$totp = new TOTP($secret);
+
+$totp->setTimeZone('Asia/Manila')
+     ->setTimeRemainingInSeconds(30)
      ->setTimeAdjustments(10)
      ->setLength(6)
+     ->setAlgorithm('sha1')
      ->prepare();
 
 echo $totp->verify('552344'); // true
@@ -113,15 +127,18 @@ use LordDashMe\TwoFactorAuth\Utility\Base32;
 use LordDashMe\TwoFactorAuth\GoogleAuthenticator\BarcodeURL;
 use LordDashMe\TwoFactorAuth\GoogleAuthenticator\TOTPFormat;
 
-$secret = Base32::encode('P@ssw0rd!', false);
+$secret = Base32::encode('P@ssw0rd!');
 $accountUser = 'reyesjoshuaclifford@gmail.com';
 $issuer = 'TwoFactorAuth';
 $digits = 6;
 $period = 30;
+$algorithm = 'sha1';
+
+$format = new TOTPFormat($period);
+
+$barcodeURL = new BarcodeURL($secret, $accountUser, $issuer, $format);
 
-$totpFormat = new TOTPFormat($period);
-$barcodeURL = new BarcodeURL($secret, $accountUser, $issuer, $totpFormat);
-$barcodeURL->setAlgorithm('SHA1')
+$barcodeURL->setAlgorithm($algorithm) // sha1 (Default), sha256, sha512
            ->setDigits($digits)
            ->build();
 

phpunit.xml.dist

@@ -37,7 +37,7 @@
             <file>tests/Unit/OTPTest.php</file>
         </testsuite>
         <testsuite name="Integration">
-            <directory suffix="Test.php">tests/Integration/</directory>
+            <directory suffix="Test.php">tests/Integration/GoogleAuthenticator/</directory>
         </testsuite>
     </testsuites>
     <logging>

src/GoogleAuthenticator/BarcodeURL.php

@@ -56,7 +56,7 @@ class BarcodeURL
      * 
      * @var string
      */
-    private $algorithm = 'SHA1';
+    private $algorithm = 'sha1';
 
     /**
      * The number for digit(s) in a OTP password generation used.
@@ -118,11 +118,11 @@ public function build()
     {
         $parameters = array(
             'secret' => $this->secret, 
-            'algorithm' => $this->algorithm,
+            'algorithm' => \strtoupper($this->algorithm),
             'digits' => $this->digits
         );
 
-        $parameters = array_merge($parameters, $this->format->getParameters());
+        $parameters = \array_merge($parameters, $this->format->getParameters());
 
         if ($this->issuer) {
             $this->accountName = $this->issuer . ':' . $this->accountName;

src/OTP.php

@@ -21,33 +21,40 @@
 class OTP 
 {
     /**
-     * The inputed secret string that will be use to generate one-time password.
+     * The max number of verification for the generated one-time password.
      * 
-     * @var string
+     * @var int
      */
-    protected $secret = '';
+    protected $maxVerificationNumber = 1;
 
     /**
-     * The max number of verification for the generated one-time password.
+     * The inputed secret string that will be use to generate one-time password.
      * 
-     * @var int
+     * @var string
      */
-    protected $maxVerificationNumber = 1;
+    private $secret = '';
 
     /**
      * The size of the generated one-time password.
      * 
      * @var int
      */
-    protected $length = 6;
+    private $length = 6;
 
     /**
      * The randomness counter for the generated password one-time password.
      * The value will depend on the sub class.
      * 
      * @var null
      */
-    protected $counter = null;
+    private $counter = null;
+
+    /**
+     * The algorithm to be use for the hash_hmac.
+     * 
+     * @var string
+     */
+    private $algorithm = 'sha1';
 
     /**
      * The generated one-time password.
@@ -89,6 +96,20 @@ public function setCounter($counter)
         return $this;
     }
 
+    /**
+     * The setter method for the algorithm class property.
+     * 
+     * @param  int $algorithm  The algorithm to be use for the hmac hashing.
+     * 
+     * @return $this
+     */
+    public function setAlgorithm($algorithm)
+    {
+        $this->algorithm = $algorithm;
+
+        return $this;
+    }
+
     /**
      * Generation process for the OTP.
      * 
@@ -99,26 +120,26 @@ public function generate()
         // Pack the counter into 64-bit int.
         // Use bitwise operators to manipulate and shift bits.
         // The 0xFFFFFFFF Hex = 4294967295 Decimal.
-        $counterBytes = pack(
+        $counterBytes = \pack(
             'NN', ($this->counter & (0xFFFFFFFF << 32)) >> 32, $this->counter & 0xFFFFFFFF
         );
 
         // Generate hmac hash based on the given counter bytes 
         // using sha1 algorithm that produce 160-bit.
-        $hash = hash_hmac('sha1', $counterBytes, Base32::decode($this->secret), true);
+        $hash = \hash_hmac($this->algorithm, $counterBytes, Base32::decode($this->secret), true);
 
         // Get the offset value in the hash data.
         // Using bitwise AND operator, if the value is more than 15 (0xF) then return 0.
-        $offset = ord($hash[19]) & 0xF;
+        $offset = \ord($hash[19]) & 0xF;
 
         // Unpack the hmac hashed.
-        $unpack = unpack('Nint', substr($hash, $offset, 4));
+        $unpack = \unpack('Nint', \substr($hash, $offset, 4));
 
         // The 0x7FFFFFFF Hex = 2147483647 Decimal.
         $code = $unpack['int'] & 0x7FFFFFFF;
 
-        $this->generatedOTP = str_pad(
-            $code % pow(10, $this->length), $this->length, 0, STR_PAD_LEFT
+        $this->generatedOTP = \str_pad(
+            $code % \pow(10, $this->length), $this->length, 0, STR_PAD_LEFT
         );
 
         return $this;

src/RFC6238/TOTP.php

@@ -29,6 +29,13 @@ class TOTP extends OTP
      */
     protected $maxVerificationNumber = 3;
 
+    /**
+     * The time zone for the TOTP.
+     * 
+     * @var string
+     */
+    private $timeZone = 'Asia/Manila';
+
     /**
      * The time remaining for the TOTP.
      * 
@@ -48,6 +55,20 @@ public function __construct($secret)
         parent::__construct($secret);
     }
 
+    /**
+     * The setter method for the time zone class property.
+     * 
+     * @param  string $timeZone  The time zone to be used for the TOTP.
+     * 
+     * @return $this
+     */
+    public function setTimeZone($timeZone)
+    {
+        $this->timeZone = $timeZone;
+
+        return $this;
+    }
+
     /**
      * The setter method for the time remaining in seconds class property.
      * 
@@ -85,11 +106,16 @@ public function setTimeAdjustments($timeAdjustments)
     public function prepare()
     {
         $now = new DateTime();
-        $timeZone = new DateTimeZone('Asia/Manila');
+        
+        $timeZone = new DateTimeZone($this->timeZone);
+        
         $now->setTimezone($timeZone);
+        
         $timeFormatted = $now->format('Y-m-d H:i:s T');
 
-        $time = \floor((\strtotime($timeFormatted) + ($this->timeAdjustments)) / $this->timeRemainingInSeconds);
+        $time = \floor(
+            (\strtotime($timeFormatted) + ($this->timeAdjustments)) / $this->timeRemainingInSeconds
+        );
 
         $this->setCounter($time);
 

…egration/GoogleAuthenticatorTOTPTest.php …Authenticator/GenerateBarcodeURLTest.phptests/Integration/GoogleAuthenticatorTOTPTest.php renamed to tests/Integration/GoogleAuthenticator/GenerateBarcodeURLTest.php tests/Integration/GoogleAuthenticatorTOTPTest.php renamed to tests/Integration/GoogleAuthenticator/GenerateBarcodeURLTest.php

@@ -1,5 +1,7 @@
 <?php
 
+namespace LordDashMe\TwoFactorAuth\Tests\Integration\GoogleAuthenticator;
+
 use Mockery as Mockery;
 use PHPUnit\Framework\TestCase;
 
@@ -8,12 +10,12 @@
 use LordDashMe\TwoFactorAuth\GoogleAuthenticator\BarcodeURL;
 use LordDashMe\TwoFactorAuth\GoogleAuthenticator\TOTPFormat;
 
-class GoogleAuthenticatorTOTPTest extends TestCase
+class GenerateBarcodeURLTest extends TestCase
 {
     /**
      * @test
      */
-    public function it_should_generate_google_authenticator_required_barcode()
+    public function it_should_generate_barcode_url_for_google_authenticator()
     {
         $secret = Base32::encode('P@ssw0rd!', false);
         $accountUser = 'reyesjoshuaclifford@gmail.com';
@@ -22,19 +24,23 @@ public function it_should_generate_google_authenticator_required_barcode()
         $period = 30;
 
         $totp = new TOTP($secret);
-        $totp->setTimeRemainingInSeconds($period);
-        $totp->setTimeAdjustments(10);
-        $totp->prepare();
-        $totp->setLength($digits);
-        $totp->generate();
+
+        $totp->setTimeZone('Asia/Manila')
+             ->setTimeRemainingInSeconds($period)
+             ->setTimeAdjustments(10)
+             ->setLength($digits)
+             ->prepare()
+             ->generate();
 
         // var_dump($totp->get());
 
-        $totpFormat = new TOTPFormat($period);
-        $barcodeURL = new BarcodeURL($secret, $accountUser, $issuer, $totpFormat);
-        $barcodeURL->setAlgorithm('SHA1');
-        $barcodeURL->setDigits($digits);
-        $barcodeURL->build();
+        $format = new TOTPFormat($period);
+
+        $barcodeURL = new BarcodeURL($secret, $accountUser, $issuer, $format);
+
+        $barcodeURL->setAlgorithm('sha1')
+                   ->setDigits($digits)
+                   ->build();
 
         $this->assertEquals('https://chart.googleapis.com/chart?chs=200x200&chld=M|0&cht=qr&chl=otpauth://totp/TwoFactorAuth:reyesjoshuaclifford@gmail.com?secret=KBAHG43XGBZGIII&algorithm=SHA1&digits=6&period=30&issuer=TwoFactorAuth', $barcodeURL->get());
     }