OTPAuthenticate\OTPHelper

Complexity

Total Complexity

20

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	generateKeyURI()	0	18	1
A	validateType()	0	7	3
A	validateAlgorithm()	0	7	3
A	formatLabel()	0	13	3
A	setAccount()	0	9	2
A	setIssuer()	0	8	2
A	setParameter()	0	7	2
A	setCounter()	0	12	4

<?php

/**
 * OTPHelper
 * @package OTPAuthenticate
 * @copyright (c) Marc Alexander <admin@m-a-styles.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace OTPAuthenticate;

class OTPHelper
{
	/** @var array Allowed types of OTP */
	protected $allowedType = array(
		'hotp',
		'totp',
	);

	/** @var array Allowed algorithms */
	protected $allowedAlgorithm = array(
		'sha1',
		'sha256',
		'sha512',
	);

	/** @var string Label string for URI */
	protected $label;

	/** @var string Issuer string for URI */
	protected $issuer;

	/** @var string Additional parameters for URI */
	protected $parameters = '';

	/**
	 * Generate OTP key URI
	 *
	 * @param string $type OTP type
	 * @param string $secret Base32 encoded secret
	 * @param string $account Account name
	 * @param string $issuer Issuer name (optional)
	 * @param int $counter Counter for HOTP (optional)
	 * @param string $algorithm Algorithm name (optional)
	 * @param string $digits Number of digits for code (optional)
	 * @param string $period Period for TOTP codes (optional)
	 *
	 * @return string OTP key URI
	 */
	public function generateKeyURI($type, $secret, $account, $issuer = '', $counter = 0, $algorithm = '', $digits = '', $period = '')
	{
		// Check if type is supported
		$this->validateType($type);
		$this->validateAlgorithm($algorithm);

		// Format label string
		$this->formatLabel($issuer, 'issuer');
		$this->formatLabel($account, 'account');

		// Set additional parameters
		$this->setCounter($type, $counter);
		$this->setParameter($algorithm, 'algorithm');
		$this->setParameter($digits, 'digits');
		$this->setParameter($period, 'period');

		return 'otpauth://' . $type . '/' . $this->label . '?secret=' . $secret . $this->issuer . $this->parameters;
	}

	/**
	 * Check if OTP type is supported
	 *
	 * @param string $type OTP type
	 *
	 * @throws \InvalidArgumentException When type is not supported
	 */
	protected function validateType($type)
	{
		if (empty($type) || !in_array($type, $this->allowedType))
		{
			throw new \InvalidArgumentException("The OTP type $type is not supported");
		}
	}

	/**
	 * Check if algorithm is supported
	 *
	 * @param string $algorithm Algorithm to use
	 *
	 * @throws \InvalidArgumentException When algorithm is not supported
	 */
	protected function validateAlgorithm($algorithm)
	{
		if (!empty($algorithm) && !in_array($algorithm, $this->allowedAlgorithm))
		{
			throw new \InvalidArgumentException("The algorithm $algorithm is not supported");
		}
	}

	/**
	 * Format label string according to expected urlencoded standards.
	 *
	 * @param string $string The label string
	 * @param string $part Part of label
	 */
	protected function formatLabel($string, $part)
	{
		$string = trim($string);

		if ($part === 'account')
		{
			$this->setAccount($string);
		}
		else if ($part === 'issuer')
		{
			$this->setIssuer($string);
		}
	}

	/**
	 * Format and and set account name
	 *
	 * @param string $account Account name
	 *
	 * @throws \InvalidArgumentException When given account name is an empty string
	 */
	protected function setAccount($account)
	{
		if (empty($account))
		{
			throw new \InvalidArgumentException("Label can't contain empty strings");
		}

		$this->label .= str_replace('%40', '@', rawurlencode($account));
	}

	/**
	 * Format and set issuer
	 *
	 * @param string $issuer Issuer name
	 */
	protected function setIssuer($issuer)
	{
		if (!empty($issuer))
		{
			$this->label = rawurlencode($issuer) . ':';
			$this->issuer = '&issuer=' . rawurlencode($issuer);
		}
	}

	/**
	 * Set parameter if it is defined
	 *
	 * @param string $data Data to set
	 * @param string $name Name of data
	 */
	protected function setParameter($data, $name)
	{
		if (!empty($data))
		{
			$this->parameters .= "&$name=" . rawurlencode($data);
		}
	}

	/**
	 * Set counter value if hotp is being used
	 *
	 * @param string $type Type of OTP auth, either HOTP or TOTP
	 * @param int $counter Counter value
	 *
	 * @throws \InvalidArgumentException If counter is empty while using HOTP
	 */
	protected function setCounter($type, $counter)
	{
		if ($type === 'hotp')
		{
			if ($counter !== 0 && empty($counter))
			{
				throw new \InvalidArgumentException("Counter can't be empty if HOTP is being used");
			}

			$this->parameters .= "&counter=$counter";
		}
	}
}