README

TOTP and HOTP Library with backup codes, compatible with google authenticator. Compatible with PHP >= 7.4.13.

Install

For PHP version >= 7.4.13:

composer require ekojs/otp

How to use

Generate TOTP (Time-Based One-Time Password) based on RFC 6238

<?php
require_once "vendor/autoload.php";

use Ekojs\Otp\TOTP;

$ejsotp = TOTP::getInstance();
$ejsotp->createOTP();
$ejsotp->otp->setLabel("ekojs@email.com");
$ejsotp->otp->setIssuer("My Service");

echo "The TOTP secret is: {$ejsotp->otp->getSecret()}".PHP_EOL;
echo "The current TOTP is: {$ejsotp->otp->now()}".PHP_EOL;
echo "The Uri is: {$ejsotp->otp->getProvisioningUri()}".PHP_EOL;

Verify TOTP

$ejsotp->createOTP(["secret" => "VE7RDW7LC45QHKVZI6SPHDQK254TKO7CPG6KHPQ4RYN4MGBBA6EAAHVYHRVAGO5LPF6XNDPAOLE3KYQHBBHPB62VFVNZURWRZUDER4A"]);
$ejsotp->otp->setLabel('ekojs@email.com');
$ejsotp->otp->setIssuer("My Service");

echo 'Current TOTP: ' . $ejsotp->otp->now() . PHP_EOL;
var_dump($ejsotp->otp->verify("988942"));

Generate HOTP (HMAC-Based One-Time Password) based on RFC 4226

require_once "vendor/autoload.php";

use Ekojs\Otp\HOTP;

$ejshotp = HOTP::getInstance();
$ejshotp->createOTP(["counter" => 1000]);
$ejshotp->otp->setLabel("ekojs@email.com");
$ejshotp->otp->setIssuer("My Service HOTP");

echo "The HOTP secret is: {$ejshotp->otp->getSecret()}".PHP_EOL;
echo "The current HOTP is: {$ejshotp->otp->at($ejshotp->otp->getCounter())}".PHP_EOL;
echo "The Uri is: {$ejshotp->otp->getProvisioningUri()}".PHP_EOL;

Verify HOTP

$ejshotp->createOTP([
    "secret" => "HZHL2VE2RWMT2KHDQCYCLPXJRJC7T63SZFNDTLEEEJISHLQS5Y6CRDTW4D7D3GA35VMSA32NAGLXEEFDSRT63E332JQOCTDAVK4HZHI",
    "counter" => 1000
]);
$ejshotp->otp->setLabel("ekojs@email.com");
$ejshotp->otp->setIssuer("My Service HOTP");

echo 'Current OTP: ' . $ejshotp->otp->at(1001) . PHP_EOL;
var_dump($ejshotp->otp->verify("598162",1001));

Generate Backup Codes (Mnemonic) based on BIP 39

echo "Hash secret : ". hash("md5","mysecret").PHP_EOL; // 06c219e5bc8378f3a8a3f83b4b7e4649
echo "Backup codes: ". implode(" ",$ejsotp->generateBackupCodes("mysecret")).PHP_EOL;

Reverse Mnemonic / Backup Codes

echo "Reverse Mnemonic: ".$ejsotp->reverseMnemonic("almost awkward just jungle daring keep penalty lecture deputy fossil muscle nasty").PHP_EOL; // 06c219e5bc8378f3a8a3f83b4b7e4649

Generate QrCode compatible with Google Authenticator

$result = $ejsotp->generateQr();
echo "<img src='".$result->getDataUri()."' />";

Generate QrCode with Logo and Label

$result = $ejsotp->generateQr("path_to_logo.png",true);
echo "<img src='".$result->getDataUri()."' />";

Generate QrCode with Label and without Logo

$result = $ejsotp->generateQr(null,true);
echo "<img src='".$result->getDataUri()."' />";

Generate QrCode and Save to File

$result = $ejsotp->generateQr();
$result->saveToFile("path/qrcode-totp.png");

Verify Using Google Authenticator

Scan this Qr using Google Authenticator

Create test.php, and execute it from terminal

<?php
require_once "vendor/autoload.php";

use Ekojs\Otp\TOTP;

$ejsotp = TOTP::getInstance();
$ejsotp->createOTP(["secret" => "VZCKGWRLS7CINEYALENYPH5T442LJUAFGSNCBTBQEHMN5GSVGTJCD2B7NHCZFK5FZ3QHTQ66JYDMNUI2UBWZJAYHI62VYVHVUGTO6SQ"]);
$ejsotp->otp->setLabel('ekojs@email.com');
$ejsotp->otp->setIssuer("My Service");

var_dump($ejsotp->otp->verify("input code from your Google Authenticator")); // if true the code is valid
echo 'Current OTP: ' . $ejsotp->otp->now() . PHP_EOL;

ekojs / otp

Maintainers

Details