enwikipedia-acc / waca

includes/Security/CredentialProviders/TotpCredentialProvider.php

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\Security\CredentialProviders;

use DateTimeImmutable;
use OTPHP\Factory;
use OTPHP\TOTP;
use Waca\DataObjects\User;
use Waca\Exceptions\ApplicationLogicException;
use Waca\PdoDatabase;
use Waca\Security\EncryptionHelper;
use Waca\SiteConfiguration;

class TotpCredentialProvider extends CredentialProviderBase
{
    /** @var EncryptionHelper */
    private $encryptionHelper;

    /**
     * TotpCredentialProvider constructor.
     *
     * @param PdoDatabase       $database
     * @param SiteConfiguration $configuration
     */
    public function __construct(PdoDatabase $database, SiteConfiguration $configuration)
    {
        parent::__construct($database, $configuration, 'totp');
        $this->encryptionHelper = new EncryptionHelper($configuration);
    }

    /**
     * Validates a user-provided credential
     *
     * @param User   $user The user to test the authentication against
     * @param string $data The raw credential data to be validated
     *
     * @return bool
     * @throws ApplicationLogicException
     */
    public function authenticate(User $user, $data)
    {
        if (is_array($data)) {
            return false;
        }

        $storedData = $this->getCredentialData($user->getId());

        if ($storedData === null) {
            throw new ApplicationLogicException('Credential data not found');
        }

        $provisioningUrl = $this->encryptionHelper->decryptData($storedData->getData());
        $totp = Factory::loadFromProvisioningUri($provisioningUrl);

        return $totp->verify($data, null, 2);
    }

    public function verifyEnable(User $user, $data)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $storedData = $this->getCredentialData($user->getId(), true);

        if ($storedData === null) {
            throw new ApplicationLogicException('Credential data not found');
        }

        $provisioningUrl = $this->encryptionHelper->decryptData($storedData->getData());
        $totp = Factory::loadFromProvisioningUri($provisioningUrl);

        $result = $totp->verify($data, null, 2);

        if ($result && $storedData->getTimeout() > new DateTimeImmutable()) {
            $storedData->setDisabled(0);
            $storedData->setPriority(5);
            $storedData->setTimeout(null);
            $storedData->save();
        }

        return $result;
    }

    /**
     * @param User   $user   The user the credential belongs to
     * @param int    $factor The factor this credential provides
     * @param string $data   Unused here, due to there being no user-provided data. We provide the user with the secret.
     */
    public function setCredential(User $user, $factor, $data)
    {
        $issuer = 'ACC - ' . $this->getConfiguration()->getIrcNotificationsInstance();
        $totp = new TOTP($user->getUsername());
        $totp->setIssuer($issuer);

        $storedData = $this->getCredentialData($user->getId(), null);

null is of type null, but the function expects a boolean.

        if ($storedData !== null) {
            $storedData->delete();
        }

        $storedData = $this->createNewCredential($user);

        $storedData->setData($this->encryptionHelper->encryptData($totp->getProvisioningUri()));
        $storedData->setFactor($factor);
        $storedData->setTimeout(new DateTimeImmutable('+ 1 hour'));
        $storedData->setDisabled(1);
        $storedData->setVersion(1);

        $storedData->save();
    }

    public function getProvisioningUrl(User $user)
    {
        $storedData = $this->getCredentialData($user->getId(), true);

        if ($storedData->getTimeout() < new DateTimeImmutable()) {
            $storedData->delete();
            $storedData = null;
        }

        if ($storedData === null) {
            throw new ApplicationLogicException('Credential data not found');
        }

        return $this->encryptionHelper->decryptData($storedData->getData());
    }

    public function isPartiallyEnrolled(User $user)

This method seems to be duplicated in your project.

    {
        $storedData = $this->getCredentialData($user->getId(), true);

        if ($storedData->getTimeout() < new DateTimeImmutable()) {
            $storedData->delete();

            return false;
        }

        if ($storedData === null) {

This if statement, and the following return statement can be replaced with return !($storedData === null);.

            return false;
        }

        return true;
    }

    public function getSecret(User $user)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $totp = Factory::loadFromProvisioningUri($this->getProvisioningUrl($user));

        return $totp->getSecret();
    }
}