* Added unittests + travis-ci yml

2026-08-17 12:11:40 +00:00 · 2015-03-20 13:07:52 +01:00
parent 9e417bdb2f
commit 1db877ac79
3 changed files with 192 additions and 0 deletions
@@ -0,0 +1,180 @@
+<?php
+require_once 'lib/TwoFactorAuth.php';
+require_once 'lib/TwoFactorAuthException.php';
+
+require_once 'lib/Providers/Qr/IQRCodeProvider.php';
+require_once 'lib/Providers/Qr/BaseHTTPQRCodeProvider.php';
+require_once 'lib/Providers/Qr/GoogleQRCodeProvider.php';
+
+require_once 'lib/Providers/Rng/IRNGProvider.php';
+require_once 'lib/Providers/Rng/RNGException.php';
+require_once 'lib/Providers/Rng/MCryptRNGProvider.php';
+require_once 'lib/Providers/Rng/OpenSSLRNGProvider.php';
+require_once 'lib/Providers/Rng/HashRNGProvider.php';
+
+class TwoFactorAuthTest extends PHPUnit_Framework_TestCase
+{
+	/**
+     * @expectedException \RobThree\Auth\TwoFactorAuthException
+     */
+	public function testConstructorThrowsOnInvalidDigits() {
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 0);
+	}
+
+	/**
+     * @expectedException \RobThree\Auth\TwoFactorAuthException
+     */
+	public function testConstructorThrowsOnInvalidPeriod() {
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 0);
+	}
+
+	/**
+     * @expectedException \RobThree\Auth\TwoFactorAuthException
+     */
+	public function testConstructorThrowsOnInvalidAlgorithm() {
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 30, 'xxx');
+	}
+
+	/**
+     * @expectedException \RobThree\Auth\TwoFactorAuthException
+     */
+	public function testConstructorThrowsOnQrProviderNotImplementingInterface() {
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 30, 'sha1', new stdClass());
+	}
+
+	/**
+     * @expectedException \RobThree\Auth\TwoFactorAuthException
+     */
+	public function testConstructorThrowsOnRngProviderNotImplementingInterface() {
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 30, 'sha1', null, new stdClass());
+	}
+
+	public function testGetCodeReturnsCorrectResults() {
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test');
+		$this->assertEquals('543160', $tfa->getCode('VMR466AB62ZBOKHE', 1426847216));
+		$this->assertEquals('538532', $tfa->getCode('VMR466AB62ZBOKHE', 0));
+	}
+
+	/**
+     * @expectedException \RobThree\Auth\TwoFactorAuthException
+     */
+	public function testCreateSecretThrowsOnInsecureRNGProvider() {
+		$rng = new TestRNGProvider();
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 30, 'sha1', null, $rng);
+		$tfa->createSecret();
+	}
+
+	public function testCreateSecretOverrideSecureDoesNotThrowOnInsecureRNG() {
+		$rng = new TestRNGProvider();
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 30, 'sha1', null, $rng);
+		$this->assertEquals('ABCDEFGHIJKLMNOP', $tfa->createSecret(80, false));
+	}
+
+	public function testCreateSecretDoesNotThrowOnSecureRNGProvider() {
+		$rng = new TestRNGProvider(true);
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 30, 'sha1', null, $rng);
+		$this->assertEquals('ABCDEFGHIJKLMNOP', $tfa->createSecret());
+	}
+
+	public function testCreateSecretGeneratesDesiredAmountOfEntropy() {
+		$rng = new TestRNGProvider(true);
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 30, 'sha1', null, $rng);
+		$this->assertEquals('A', $tfa->createSecret(5));
+		$this->assertEquals('AB', $tfa->createSecret(6));
+		$this->assertEquals('ABCDEFGHIJKLMNOPQRSTUVWXYZ', $tfa->createSecret(128));
+		$this->assertEquals('ABCDEFGHIJKLMNOPQRSTUVWXYZ234567', $tfa->createSecret(160));
+		$this->assertEquals('ABCDEFGHIJKLMNOPQRSTUVWXYZ234567ABCDEFGHIJKLMNOPQRSTUVWXYZ234567', $tfa->createSecret(320));
+		$this->assertEquals('ABCDEFGHIJKLMNOPQRSTUVWXYZ234567ABCDEFGHIJKLMNOPQRSTUVWXYZ234567A', $tfa->createSecret(321));
+	}
+
+
+	public function testVerifyCodeWorksCorrectly() {
+
+		$tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 30);
+		$this->assertEquals(true , $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 1, 1426847190));
+		$this->assertEquals(true , $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 0, 1426847190 + 29));	//Test discrepancy
+		$this->assertEquals(false, $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 0, 1426847190 + 30));	//Test discrepancy
+		$this->assertEquals(false, $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 0, 1426847190 - 1));	//Test discrepancy
+
+		$this->assertEquals(true , $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 1, 1426847205 + 0));	//Test discrepancy
+		$this->assertEquals(true , $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 1, 1426847205 + 35));	//Test discrepancy
+		$this->assertEquals(true , $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 1, 1426847205 - 35));	//Test discrepancy
+
+		$this->assertEquals(false, $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 1, 1426847205 + 65));	//Test discrepancy
+		$this->assertEquals(false, $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 1, 1426847205 - 65));	//Test discrepancy
+
+		$this->assertEquals(true , $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 2, 1426847205 + 65));	//Test discrepancy
+		$this->assertEquals(true , $tfa->verifyCode('VMR466AB62ZBOKHE', '543160', 2, 1426847205 - 65));	//Test discrepancy
+	}
+
+    public function testTotpUriIsCorrect() {
+        $qr = new TestQrProvider();
+
+        $tfa = new \RobThree\Auth\TwoFactorAuth('Test&Issuer', 6, 30, 'sha1', $qr);
+		$data = $this->DecodeDataUri($tfa->getQRCodeImageAsDataUri('Test&Label', 'VMR466AB62ZBOKHE'));
+		$this->assertEquals('test/test', $data['mimetype']);
+		$this->assertEquals('base64', $data['encoding']);
+		$this->assertEquals('otpauth://totp/Test%26Label?secret=VMR466AB62ZBOKHE&issuer=Test%26Issuer&period=30&algorithm=SHA1&digits=6@200', $data['data']);
+    }
+
+    /**
+     * @expectedException \RobThree\Auth\TwoFactorAuthException
+     */
+    public function testGetQRCodeImageAsDataUriThrowsOnInvalidSize() {
+        $qr = new TestQrProvider();
+
+        $tfa = new \RobThree\Auth\TwoFactorAuth('Test', 6, 30, 'sha1', $qr);
+		$tfa->getQRCodeImageAsDataUri('Test', 'VMR466AB62ZBOKHE', 0);
+    }
+
+	private function DecodeDataUri($datauri) {
+		if (preg_match('/data:(?P<mimetype>[\w\.\-\/]+);(?P<encoding>\w+),(?P<data>.*)/', $datauri, $m) === 1) {
+			return array(
+				'mimetype' => $m['mimetype'],
+				'encoding' => $m['encoding'],
+				'data' => base64_decode($m['data'])
+			);
+		}
+		return null;
+	}
+}
+
+class TestRNGProvider implements \RobThree\Auth\Providers\Rng\IRNGProvider {
+    private $isSecure;
+    
+    function __construct($isSecure = false) {
+        $this->isSecure = $isSecure;
+    }
+    
+    public function getRandomBytes($bytecount) {
+        $result = '';
+        for ($i=0; $i<$bytecount; $i++)
+            $result.=chr($i);
+        return $result;
+
+    }
+    
+    public function isCryptographicallySecure() {
+        return $this->isSecure;
+    }
+}
+
+class TestQrProvider implements \RobThree\Auth\Providers\Qr\IQRCodeProvider {
+	public function getQRCodeImage($qrtext, $size) {
+		return $qrtext . '@' . $size;
+	}
+
+	public function getMimeType() {
+		return 'test/test';
+	}
+}