Surfnet\StepupGateway\GatewayBundle\Sso2fa\ValueObject\Configuration

Complexity

Total Complexity

9

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getEncryptionKey()	0	3	1
A	isPersistent()	0	3	1
A	__construct()	0	34	5
A	getName()	0	3	1
A	getLifetime()	0	3	1

<?php declare(strict_types=1);

/**
 * Copyright 2022 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupGateway\GatewayBundle\Sso2fa\ValueObject;

use Exception;
use ParagonIE\ConstantTime\Binary;
use Surfnet\StepupGateway\GatewayBundle\Sso2fa\Exception\InvalidCookieTypeException;
use Surfnet\StepupGateway\GatewayBundle\Sso2fa\Exception\InvalidEncryptionKeyException;

class Configuration
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var CookieType
     */
    private $type;

    /**
     * @var int
     */
    private $lifetime;

    /**
     * @var string
     */
    private $encryptionKey;

    public function __construct(string $name, string $type, int $lifetime, string $encryptionKey)
    {
        $this->name = $name;
        $this->type = CookieType::fromConfiguration($type);
        if ($lifetime === 0 && $this->type->isPersistent()) {
            throw new InvalidCookieTypeException(
                'When using a persistent cookie, you must configure a non zero cookie lifetime'
            );
        }
        $this->lifetime = $lifetime;

        // Convert the key from the configuration from hex to binary. sodium_hex2bin
        try {
            $binaryKey = sodium_hex2bin($encryptionKey);
        } catch (Exception $e) {
            // The key contains non-hexadecimal values. Show a custom error message in logs.
            throw new InvalidEncryptionKeyException(
                'The configured SSO on 2FA encryption key contains illegal characters. It should be a 64 digits long ' .
                'hexadecimal value. Example value: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f',
                0,
                $e
            );
        }
        // The key length, converted back to binary must be 32 bytes long
        if (Binary::safeStrlen($binaryKey) < SODIUM_CRYPTO_STREAM_KEYBYTES) {
            throw new InvalidEncryptionKeyException(
                sprintf(
                    'The configured SSO on 2FA encryption key must be exactly %d bytes. ' .
                    'This comes down to 64 hex digits value, configured in the sso_encryption_key configuration option',
                    SODIUM_CRYPTO_STREAM_KEYBYTES
                )
            );
        }
        $this->encryptionKey = $binaryKey;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function isPersistent(): bool
    {
        return $this->type->isPersistent();
    }

    public function getLifetime(): int
    {
        return $this->lifetime;
    }

    public function getEncryptionKey(): string
    {
        return $this->encryptionKey;
    }
}