SessionController::deleteSessionAction() - Code Metrics - Inspection of "EZP-26179: Refactored session rest actions to thei..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp26179-rest_session_controll... ( e030e6 )

unknown

created 2016-09-16 13:41 UTC

SessionController::deleteSessionAction() A

↳ Parent: SessionController

Complexity

Conditions	3
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	2
nop	2
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\REST\Server\Controller;

use eZ\Publish\Core\MVC\Symfony\Security\Authentication\AuthenticatorInterface;
use eZ\Publish\Core\REST\Common\Message;
use eZ\Publish\Core\REST\Server\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Exception\SessionUnavailableException;
use Symfony\Component\Security\Csrf\CsrfToken;
use Symfony\Component\Security\Csrf\CsrfTokenManager;
use eZ\Publish\Core\REST\Server\Values;
use eZ\Publish\Core\REST\Server\Exceptions;
use eZ\Publish\Core\Base\Exceptions\UnauthorizedException;
use eZ\Publish\Core\REST\Common\Exceptions\NotFoundException;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface;

class SessionController extends Controller
{
    /**
     * @var AuthenticatorInterface
     */
    private $authenticator;
    /**
     * @var CsrfTokenManager
     */
    private $csrfTokenManager;

    /**
     * @var \Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface
     */
    private $csrfTokenStorage;

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

    public function __construct(
        AuthenticatorInterface $authenticator,
        $tokenIntention,
        CsrfTokenManager $csrfTokenManager = null,
        TokenStorageInterface $csrfTokenStorage = null
    ) {

        $this->authenticator = $authenticator;
        $this->csrfTokenIntention = $tokenIntention;
        $this->csrfTokenManager = $csrfTokenManager;
        $this->csrfTokenStorage = $csrfTokenStorage;
    }

    /**
     * Creates a new session based on the credentials provided as POST parameters.
     *
     * @throws \eZ\Publish\Core\Base\Exceptions\UnauthorizedException If the login or password are incorrect or invalid CSRF
     *
     * @return Values\UserSession|Values\Conflict
     */
    public function createSessionAction(Request $request)
    {
        /** @var $sessionInput \eZ\Publish\Core\REST\Server\Values\SessionInput */
        $sessionInput = $this->inputDispatcher->parse(
            new Message(
                array('Content-Type' => $request->headers->get('Content-Type')),
                $request->getContent()

            )
        );
        $request->attributes->set('username', $sessionInput->login);
        $request->attributes->set('password', $sessionInput->password);

        try {
            $session = $request->getSession();
            if ($session->isStarted() && $this->hasStoredCsrfToken()) {
                $this->checkCsrfToken($request);
            }

            $token = $this->authenticator->authenticate($request);
            $csrfToken = $this->getCsrfToken();

            return new Values\UserSession(
                $token->getUser()->getAPIUser(),
                $session->getName(),
                $session->getId(),
                $csrfToken,
                !$token->hasAttribute('isFromSession')
            );
        } catch (Exceptions\UserConflictException $e) {
            // Already logged in with another user, this will be converted to HTTP status 409
            return new Values\Conflict();
        } catch (AuthenticationException $e) {
            throw new UnauthorizedException('Invalid login or password', $request->getPathInfo());
        } catch (AccessDeniedException $e) {
            throw new UnauthorizedException($e->getMessage(), $request->getPathInfo());
        }
    }

    /**
     * Refresh given session.
     *
     * @param string $sessionId
     *
     * @throws \eZ\Publish\Core\REST\Common\Exceptions\NotFoundException
     *
     * @return \eZ\Publish\Core\REST\Server\Values\UserSession
     */
    public function refreshSessionAction($sessionId, Request $request)
    {
        $session = $request->getSession();

        if ($session === null || !$session->isStarted() || $session->getId() != $sessionId || !$this->hasStoredCsrfToken()) {
            $response = $this->authenticator->logout($request);
            $response->setStatusCode(404);

            return $response;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        $this->checkCsrfToken($request);

        return new Values\UserSession(
            $this->repository->getCurrentUser(),

            $session->getName(),
            $session->getId(),
            $request->headers->get('X-CSRF-Token'),
            false
        );
    }

    /**
     * Deletes given session.
     *
     * @param string $sessionId
     *
     * @return Values\DeletedUserSession
     *
     * @throws NotFoundException
     */
    public function deleteSessionAction($sessionId, Request $request)
    {
        /** @var $session \Symfony\Component\HttpFoundation\Session\Session */
        $session = $request->getSession();
        if (!$session->isStarted() || $session->getId() != $sessionId) {
            throw new NotFoundException("Session not found: '{$sessionId}'.");
        }

        return new Values\DeletedUserSession(
            $this->authenticator->logout($request)
        );
    }

    /**
     * Tests if a CSRF token is stored.
     *
     * @return bool
     */
    private function hasStoredCsrfToken()
    {
        if (!isset($this->csrfTokenStorage)) {
            return true;
        }

        return $this->csrfTokenStorage->hasToken(
            $this->container->getParameter('ezpublish_rest.csrf_token_intention')
        );
    }

    public function setTokenStorage(TokenStorageInterface $csrfTokenStorage)
    {
        $this->csrfTokenStorage = $csrfTokenStorage;
    }

    /**
     * Checks the presence / validity of the CSRF token.
     *
     * @param Request $request
     *
     * @throws UnauthorizedException if the token is missing or invalid.
     */
    private function checkCsrfToken(Request $request)
    {
        if ($this->csrfTokenManager === null) {
            return;
        }

        $exception = new UnauthorizedException(
            'Missing or invalid CSRF token',
            $request->getMethod() . ' ' . $request->getPathInfo()
        );

        if (!$request->headers->has('X-CSRF-Token')) {
            throw $exception;
        }

        $csrfToken = new CsrfToken(
            $this->csrfTokenIntention,
            $request->headers->get('X-CSRF-Token')
        );

        if (!$this->csrfTokenManager->isTokenValid($csrfToken)) {
            throw $exception;
        }
    }

    /**
     * Returns the csrf token for REST. The token is generated if it doesn't exist.
     *
     * @return string The csrf token, or an empty string if csrf check is disabled.
     */
    private function getCsrfToken()
    {
        if ($this->csrfTokenManager === null) {
            return '';
        }

        return $this->csrfTokenManager->getToken($this->csrfTokenIntention)->getValue();
    }
}


1			<?php
2			/**
3			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
4			* @license For full copyright and license information view LICENSE file distributed with this source code.
5			*/
6			namespace eZ\Publish\Core\REST\Server\Controller;
7
8			use eZ\Publish\Core\MVC\Symfony\Security\Authentication\AuthenticatorInterface;
9			use eZ\Publish\Core\REST\Common\Message;
10			use eZ\Publish\Core\REST\Server\Controller;
11			use Symfony\Component\HttpFoundation\Request;
12			use Symfony\Component\Security\Core\Exception\SessionUnavailableException;
13			use Symfony\Component\Security\Csrf\CsrfToken;
14			use Symfony\Component\Security\Csrf\CsrfTokenManager;
15			use eZ\Publish\Core\REST\Server\Values;
16			use eZ\Publish\Core\REST\Server\Exceptions;
17			use eZ\Publish\Core\Base\Exceptions\UnauthorizedException;
18			use eZ\Publish\Core\REST\Common\Exceptions\NotFoundException;
19			use Symfony\Component\Security\Core\Exception\AccessDeniedException;
20			use Symfony\Component\Security\Core\Exception\AuthenticationException;
21			use Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface;
22
23			class SessionController extends Controller
24			{
25			/**
26			* @var AuthenticatorInterface
27			*/
28			private $authenticator;
29			/**
30			* @var CsrfTokenManager
31			*/
32			private $csrfTokenManager;
33
34			/**
35			* @var \Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface
36			*/
37			private $csrfTokenStorage;
38
39			/**
40			* @var string
41			*/
42			private $csrfTokenIntention;
43
44			public function __construct(
45			AuthenticatorInterface $authenticator,
46			$tokenIntention,
47			CsrfTokenManager $csrfTokenManager = null,
48			TokenStorageInterface $csrfTokenStorage = null
49			) {
50
51			$this->authenticator = $authenticator;
52			$this->csrfTokenIntention = $tokenIntention;
53			$this->csrfTokenManager = $csrfTokenManager;
54			$this->csrfTokenStorage = $csrfTokenStorage;
55			}
56
57			/**
58			* Creates a new session based on the credentials provided as POST parameters.
59			*
60			* @throws \eZ\Publish\Core\Base\Exceptions\UnauthorizedException If the login or password are incorrect or invalid CSRF
61			*
62			* @return Values\UserSession\|Values\Conflict
63			*/
64			public function createSessionAction(Request $request)
65			{
66			/** @var $sessionInput \eZ\Publish\Core\REST\Server\Values\SessionInput */
67			$sessionInput = $this->inputDispatcher->parse(
68			new Message(
69			array('Content-Type' => $request->headers->get('Content-Type')),
70			$request->getContent()
			0 ignored issues – show Bug introduced 2016-09-16 14:08 UTC by Report Bug Copy Issue Report It seems like `$request->getContent()` targeting `Symfony\Component\HttpFo...n\Request::getContent()` can also be of type `resource`; however, `eZ\Publish\Core\REST\Common\Message::__construct()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
71			)
72			);
73			$request->attributes->set('username', $sessionInput->login);
74			$request->attributes->set('password', $sessionInput->password);
75
76			try {
77			$session = $request->getSession();
78			if ($session->isStarted() && $this->hasStoredCsrfToken()) {
79			$this->checkCsrfToken($request);
80			}
81
82			$token = $this->authenticator->authenticate($request);
83			$csrfToken = $this->getCsrfToken();
84
85			return new Values\UserSession(
86			$token->getUser()->getAPIUser(),
87			$session->getName(),
88			$session->getId(),
89			$csrfToken,
90			!$token->hasAttribute('isFromSession')
91			);
92			} catch (Exceptions\UserConflictException $e) {
93			// Already logged in with another user, this will be converted to HTTP status 409
94			return new Values\Conflict();
95			} catch (AuthenticationException $e) {
96			throw new UnauthorizedException('Invalid login or password', $request->getPathInfo());
97			} catch (AccessDeniedException $e) {
98			throw new UnauthorizedException($e->getMessage(), $request->getPathInfo());
99			}
100			}
101
102			/**
103			* Refresh given session.
104			*
105			* @param string $sessionId
106			*
107			* @throws \eZ\Publish\Core\REST\Common\Exceptions\NotFoundException
108			*
109			* @return \eZ\Publish\Core\REST\Server\Values\UserSession
110			*/
111			public function refreshSessionAction($sessionId, Request $request)
112			{
113			$session = $request->getSession();
114
115			if ($session === null \|\| !$session->isStarted() \|\| $session->getId() != $sessionId \|\| !$this->hasStoredCsrfToken()) {
116			$response = $this->authenticator->logout($request);
117			$response->setStatusCode(404);
118
119			return $response;
			0 ignored issues – show Bug Best Practice introduced 2016-09-16 14:08 UTC by Report Bug Copy Issue Report The return type of `return $response;` (`Symfony\Component\HttpFoundation\Response`) is incompatible with the return type documented by `eZ\Publish\Core\REST\Ser...r::refreshSessionAction` of type `eZ\Publish\Core\REST\Server\Values\UserSession`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
120			}
121
122			$this->checkCsrfToken($request);
123
124			return new Values\UserSession(
125			$this->repository->getCurrentUser(),
			0 ignored issues – show Deprecated Code introduced 2016-09-16 14:08 UTC by Report Bug Copy Issue Report The method `eZ\Publish\API\Repositor...itory::getCurrentUser()` has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::getCurrentUserReference() instead. Get current user. Loads the full user object if not already loaded, if you only need to know user id use {@see getCurrentUserReference()} This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
126			$session->getName(),
127			$session->getId(),
128			$request->headers->get('X-CSRF-Token'),
129			false
130			);
131			}
132
133			/**
134			* Deletes given session.
135			*
136			* @param string $sessionId
137			*
138			* @return Values\DeletedUserSession
139			*
140			* @throws NotFoundException
141			*/
142			public function deleteSessionAction($sessionId, Request $request)
143			{
144			/** @var $session \Symfony\Component\HttpFoundation\Session\Session */
145			$session = $request->getSession();
146			if (!$session->isStarted() \|\| $session->getId() != $sessionId) {
147			throw new NotFoundException("Session not found: '{$sessionId}'.");
148			}
149
150			return new Values\DeletedUserSession(
151			$this->authenticator->logout($request)
152			);
153			}
154
155			/**
156			* Tests if a CSRF token is stored.
157			*
158			* @return bool
159			*/
160			private function hasStoredCsrfToken()
161			{
162			if (!isset($this->csrfTokenStorage)) {
163			return true;
164			}
165
166			return $this->csrfTokenStorage->hasToken(
167			$this->container->getParameter('ezpublish_rest.csrf_token_intention')
168			);
169			}
170
171			public function setTokenStorage(TokenStorageInterface $csrfTokenStorage)
172			{
173			$this->csrfTokenStorage = $csrfTokenStorage;
174			}
175
176			/**
177			* Checks the presence / validity of the CSRF token.
178			*
179			* @param Request $request
180			*
181			* @throws UnauthorizedException if the token is missing or invalid.
182			*/
183			private function checkCsrfToken(Request $request)
184			{
185			if ($this->csrfTokenManager === null) {
186			return;
187			}
188
189			$exception = new UnauthorizedException(
190			'Missing or invalid CSRF token',
191			$request->getMethod() . ' ' . $request->getPathInfo()
192			);
193
194			if (!$request->headers->has('X-CSRF-Token')) {
195			throw $exception;
196			}
197
198			$csrfToken = new CsrfToken(
199			$this->csrfTokenIntention,
200			$request->headers->get('X-CSRF-Token')
201			);
202
203			if (!$this->csrfTokenManager->isTokenValid($csrfToken)) {
204			throw $exception;
205			}
206			}
207
208			/**
209			* Returns the csrf token for REST. The token is generated if it doesn't exist.
210			*
211			* @return string The csrf token, or an empty string if csrf check is disabled.
212			*/
213			private function getCsrfToken()
214			{
215			if ($this->csrfTokenManager === null) {
216			return '';
217			}
218
219			return $this->csrfTokenManager->getToken($this->csrfTokenIntention)->getValue();
220			}
221			}
222

ezsystems / ezpublish-kernel

Push — ezp26179-rest_session_controll... ( e030e6 )

SessionController::deleteSessionAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like