Surfnet\StepupSelfService\SelfServiceBundle\Service\YubikeyService

Complexity

Total Complexity

8

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	2	1
B	verify()	0	45	7

<?php

declare(strict_types = 1);

/**
 * Copyright 2014 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.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupSelfService\SelfServiceBundle\Service;

use GuzzleHttp\Client;
use Psr\Log\LoggerInterface;
use Surfnet\StepupBundle\Http\JsonHelper;
use Surfnet\StepupSelfService\SelfServiceBundle\Command\VerifyYubikeyOtpCommand;
use RuntimeException;

class YubikeyService implements YubikeyServiceInterface

Missing doc comment for class YubikeyService

{
    /**

Missing short description in doc comment

Parameter $logger should have a doc-comment as per coding-style.

     * @param Client $guzzleClient A Guzzle client configured with the Yubikey API base URL and authentication.
     */
    public function __construct(private readonly Client $guzzleClient, private readonly LoggerInterface $logger)
    {
    }

    /**

Missing short description in doc comment

Parameter $command should have a doc-comment as per coding-style.

     * @return YubikeyVerificationResult
     */
    public function verify(VerifyYubikeyOtpCommand $command): YubikeyVerificationResult
    {
        $this->logger->info('Verifying Yubikey OTP');

        $body = [
            'requester' => ['institution' => $command->institution, 'identity' => $command->identity],
            'otp' => ['value' => $command->otp],
        ];
        $response = $this->guzzleClient->post('api/verify-yubikey', ['json' => $body, 'http_errors' => false]);
        $statusCode = $response->getStatusCode();

        if ($statusCode != 200) {
            $type = $statusCode >= 400 && $statusCode < 500 ? 'client' : 'server';
            $this->logger->info(sprintf(

The opening parenthesis of a multi-line function call should be the last content on the line.

                'Yubikey OTP verification failed; %s error; HTTP/%d %s',
                $type,
                $statusCode,
                $response->getReasonPhrase()
            ));

For multi-line function calls, the closing parenthesis should be on a new line.

            $this->logger->warning((string) $response->getBody());

            return new YubikeyVerificationResult(true, false);
        }

        try {
            $result = JsonHelper::decode((string) $response->getBody());
        } catch (RuntimeException) {
            $this->logger->error('Yubikey OTP verification failed; server responded with malformed JSON.');

            return new YubikeyVerificationResult(false, true);
        }

        if (!isset($result['status'])) {
            $this->logger->error('Yubikey OTP verification failed; server responded without status report.');

            return new YubikeyVerificationResult(false, true);
        }

        if ($result['status'] !== 'OK') {
            $this->logger->error('Yubikey OTP verification failed; server responded with non-OK status report.');

            return new YubikeyVerificationResult(false, true);
        }

        return new YubikeyVerificationResult(false, false);
    }
}