holabs/totp

Time-based One-time Password implementation for Nette framework

v0.1.0 2018-06-04 11:53 UTC

This package is auto-updated.

Last update: 2024-10-07 19:32:40 UTC


README

Implementation of RobThree/TwoFactorAuth for Nette Framework.

Installation

Requirements:

composer require holabs/totp

Configuration

extensions:
	holabs.totp: Holabs\TOTP\Bridges\Nette\TOTPExtension


holabs.totp:
	issuer: "AsIs"          # Will be displayed in the app as issuer name
	digits: 6               # The number of digits the resulting codes will be
	period: 30              # The number of seconds a code will be valid
	bits: 160               # The number of bits for encryption [recommended 80 or 160]
	discrepancy: 1			# The number of periods used to equal code from app
	algorythm: "sha1"		# The algorithm used [sha1, sha256, sha512, md5]
	qr:
		label: 'holabs'		# Required label for app
		provider: NULL		# QR-code provider [@see \RobThree\Auth\Providers\Qr\IQRCodeProvider]
	rng:
		provider: NULL		# Pseodo-random string provider [@see \RobThree\Auth\Providers\Rng\IRNGProvider]
	time:
		provider: NULL		# Time provider [@see \RobThree\Auth\Providers\Time\ITimeProvider]

You can choose your providers or use predefined.

Using

Your SignPresenter now can looks like this:

<?php 

use Holabs\TOTP;
use Nette\Application\UI\Form;
use Nette\Utils\ArrayHash;

/**
 * @author       Tomáš Holan <mail@tomasholan.eu>
 * @package      holabs/totp
 * @copyright    Copyright © 2016, Tomáš Holan [www.tomasholan.cz]
 */
class SignPresenter extends BasePresenter
{

	/** @var TOTP @inject */
	public $totp;


	public function actionDefault() {
		if (!isset($_SESSION['totp'])) {
			// Store in Database or file is better
			// Every time you generate secret, your use have to delete old and add new in APP
			$_SESSION['totp'] = $this->totp->generateSecret();
		}

		$secret = $_SESSION['totp'];

		$this->template->qr = $this->totp->getQRUrl($secret);
		$this->template->secret = chunk_split($secret, 4, ' ');
		$this->template->status = '';
	}


	/**
	 * Sign-up form factory.
	 * @return Form
	 */
	protected function createComponentSecondFactor()
	{
		$form = new Form();

		$form->addText('code', 'Code', 6)
			->setRequired('Code is required');
		$form->addSubmit('submit', 'Send');

		$form->onSuccess[] = function ($form, ArrayHash $values) {
			if ($this->totp->verify($_SESSION['totp'], $values->code)) {
				$this->template->status = 'Code OK';
			} else {
				$this->template->status = 'Bad code';
			}
		};

		return $form;
	}
}
{block content}
<div style="text-align:center">
Register by read QR<br>
<img src="{$qr|nocheck}">
<p>Or type code into APP</p>
<code>
	{$secret}
</code>

<p>Enter security code</p>
{control secondFactor}

<p>{$status}</p>
</div>