Surfnet\StepupMiddleware\ApiBundle\Security\Http\EntryPoint\JsonBasicAuthenticationEntryPoint

Complexity

Total Complexity

3

Size/Duplication

Total Lines	18
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	2	1
A	start()	0	9	2

<?php

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

Missing @link tag in file comment

namespace Surfnet\StepupMiddleware\ApiBundle\Security\Http\EntryPoint;

use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;

/**
 * JsonBasicAuthenticationEntryPoint starts an HTTP Basic authentication with a JSON response body.
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class JsonBasicAuthenticationEntryPoint implements AuthenticationEntryPointInterface
{
    public function __construct(private string $realmName)
    {
    }

    /**

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

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

     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function start(Request $request, AuthenticationException $authException = null): Response
    {
        $authExceptionMessage = $authException instanceof AuthenticationException ? $authException->getMessage() : '';
        $error = sprintf('You are required to authorise before accessing this API (%s).', $authExceptionMessage);

        return new JsonResponse(
            ['errors' => [$error]],
            Response::HTTP_UNAUTHORIZED,
            ['WWW-Authenticate' => sprintf('Basic realm="%s"', $this->realmName)],
        );
    }
}