SilverStripe\TOTP\TOTPAware

Complexity

Total Complexity

3

Size/Duplication

Total Lines	27
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getTotp()	0	7	2
A	getEncryptionKey()	0	3	1

<?php

declare(strict_types=1);

namespace SilverStripe\TOTP;

use OTPHP\TOTP;
use OTPHP\TOTPInterface;
use RuntimeException;
use SilverStripe\Core\Environment;
use SilverStripe\MFA\Store\StoreInterface;

trait TOTPAware
{
    /**
     * Gets the encryption key to use from environment variables. This is generated by default on the Common Web
     * Platform, but can be defined as a custom value if required.
     *
     * @return string
     */
    protected function getEncryptionKey(): string
    {
        return (string) Environment::getEnv('SS_MFA_SECRET_KEY');
    }

    /**
     * Get an instance of the TOTP handler service. The secret must already be defined and set to the StoreInterface.
     *
     * @param StoreInterface $store
     * @return TOTPInterface
     * @throws RuntimeException
     */
    protected function getTotp(StoreInterface $store): TOTPInterface
    {
        $state = $store->getState();
        if (!isset($state['secret'])) {
            throw new RuntimeException('TOTP secret is not available in the StoreInterface');
        }
        return TOTP::create($state['secret']);
    }
}