[Security][Http] Add type-hints

andreia · chalasr · commit 09f861b0727c · 2019-08-08T00:23:45.000+02:00
diff --git a/src/Symfony/Component/Security/Http/AccessMap.php b/src/Symfony/Component/Security/Http/AccessMap.php
@@ -28,7 +28,7 @@ class AccessMap implements AccessMapInterface
      * @param array       $attributes An array of attributes to pass to the access decision manager (like roles)
      * @param string|null $channel    The channel to enforce (http, https, or null)
      */
-    public function add(RequestMatcherInterface $requestMatcher, array $attributes = [], $channel = null)
+    public function add(RequestMatcherInterface $requestMatcher, array $attributes = [], string $channel = null)
     {
         $this->map[] = [$requestMatcher, $attributes, $channel];
     }
diff --git a/src/Symfony/Component/Security/Http/Authentication/AuthenticationUtils.php b/src/Symfony/Component/Security/Http/Authentication/AuthenticationUtils.php
@@ -31,11 +31,9 @@ public function __construct(RequestStack $requestStack)
     }
 
     /**
-     * @param bool $clearSession
-     *
      * @return AuthenticationException|null
      */
-    public function getLastAuthenticationError($clearSession = true)
+    public function getLastAuthenticationError(bool $clearSession = true)
     {
         $request = $this->getRequest();
         $authenticationException = null;
diff --git a/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationSuccessHandler.php b/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationSuccessHandler.php
@@ -82,12 +82,7 @@ public function getProviderKey()
         return $this->providerKey;
     }
 
-    /**
-     * Set the provider key.
-     *
-     * @param string $providerKey
-     */
-    public function setProviderKey($providerKey)
+    public function setProviderKey(string $providerKey)
     {
         $this->providerKey = $providerKey;
     }
diff --git a/src/Symfony/Component/Security/Http/HttpUtils.php b/src/Symfony/Component/Security/Http/HttpUtils.php
@@ -58,7 +58,7 @@ public function __construct(UrlGeneratorInterface $urlGenerator = null, $urlMatc
      *
      * @return RedirectResponse A RedirectResponse instance
      */
-    public function createRedirectResponse(Request $request, $path, $status = 302)
+    public function createRedirectResponse(Request $request, string $path, int $status = 302)
     {
         if (null !== $this->secureDomainRegexp && 'https' === $this->urlMatcher->getContext()->getScheme() && preg_match('#^https?:[/\\\\]{2,}+[^/]++#i', $path, $host) && !preg_match(sprintf($this->secureDomainRegexp, preg_quote($request->getHttpHost())), $host[0])) {
             $path = '/';
@@ -78,7 +78,7 @@ public function createRedirectResponse(Request $request, $path, $status = 302)
      *
      * @return Request A Request instance
      */
-    public function createRequest(Request $request, $path)
+    public function createRequest(Request $request, string $path)
     {
         $newRequest = Request::create($this->generateUri($request, $path), 'get', [], $request->cookies->all(), [], $request->server->all());
 
@@ -116,7 +116,7 @@ public function createRequest(Request $request, $path)
      *
      * @return bool true if the path is the same as the one from the Request, false otherwise
      */
-    public function checkRequestPath(Request $request, $path)
+    public function checkRequestPath(Request $request, string $path)
     {
         if ('/' !== $path[0]) {
             try {
@@ -147,7 +147,7 @@ public function checkRequestPath(Request $request, $path)
      *
      * @throws \LogicException
      */
-    public function generateUri(Request $request, $path)
+    public function generateUri(Request $request, string $path)
     {
         if (0 === strpos($path, 'http') || !$path) {
             return $path;
diff --git a/src/Symfony/Component/Security/Http/Logout/LogoutUrlGenerator.php b/src/Symfony/Component/Security/Http/Logout/LogoutUrlGenerator.php
@@ -56,32 +56,24 @@ public function registerListener($key, $logoutPath, $csrfTokenId, $csrfParameter
     /**
      * Generates the absolute logout path for the firewall.
      *
-     * @param string|null $key The firewall key or null to use the current firewall key
-     *
      * @return string The logout path
      */
-    public function getLogoutPath($key = null)
+    public function getLogoutPath(string $key = null)
     {
         return $this->generateLogoutUrl($key, UrlGeneratorInterface::ABSOLUTE_PATH);
     }
 
     /**
      * Generates the absolute logout URL for the firewall.
      *
-     * @param string|null $key The firewall key or null to use the current firewall key
-     *
      * @return string The logout URL
      */
-    public function getLogoutUrl($key = null)
+    public function getLogoutUrl(string $key = null)
     {
         return $this->generateLogoutUrl($key, UrlGeneratorInterface::ABSOLUTE_URL);
     }
 
-    /**
-     * @param string|null $key     The current firewall key
-     * @param string|null $context The current firewall context
-     */
-    public function setCurrentFirewall($key, $context = null)
+    public function setCurrentFirewall(?string $key, string $context = null)
     {
         $this->currentFirewall = [$key, $context];
     }
diff --git a/src/Symfony/Component/Security/Http/ParameterBagUtils.php b/src/Symfony/Component/Security/Http/ParameterBagUtils.php
@@ -29,14 +29,11 @@ final class ParameterBagUtils
      *
      * Paths like foo[bar] will be evaluated to find deeper items in nested data structures.
      *
-     * @param ParameterBag $parameters The parameter bag
-     * @param string       $path       The key
-     *
      * @return mixed
      *
      * @throws InvalidArgumentException when the given path is malformed
      */
-    public static function getParameterBagValue(ParameterBag $parameters, $path)
+    public static function getParameterBagValue(ParameterBag $parameters, string $path)
     {
         if (false === $pos = strpos($path, '[')) {
             return $parameters->get($path);
@@ -64,14 +61,11 @@ public static function getParameterBagValue(ParameterBag $parameters, $path)
      *
      * Paths like foo[bar] will be evaluated to find deeper items in nested data structures.
      *
-     * @param Request $request The request
-     * @param string  $path    The key
-     *
      * @return mixed
      *
      * @throws InvalidArgumentException when the given path is malformed
      */
-    public static function getRequestParameterValue(Request $request, $path)
+    public static function getRequestParameterValue(Request $request, string $path)
     {
         if (false === $pos = strpos($path, '[')) {
             return $request->get($path);
diff --git a/src/Symfony/Component/Security/Http/RememberMe/AbstractRememberMeServices.php b/src/Symfony/Component/Security/Http/RememberMe/AbstractRememberMeServices.php
@@ -235,11 +235,9 @@ final protected function getUserProvider($class)
     /**
      * Decodes the raw cookie value.
      *
-     * @param string $rawCookie
-     *
      * @return array
      */
-    protected function decodeCookie($rawCookie)
+    protected function decodeCookie(string $rawCookie)
     {
         return explode(self::COOKIE_DELIMITER, base64_decode($rawCookie));
     }
diff --git a/src/Symfony/Component/Security/Http/RememberMe/TokenBasedRememberMeServices.php b/src/Symfony/Component/Security/Http/RememberMe/TokenBasedRememberMeServices.php
@@ -91,14 +91,12 @@ protected function onLoginSuccess(Request $request, Response $response, TokenInt
     /**
      * Generates the cookie value.
      *
-     * @param string $class
-     * @param string $username The username
      * @param int    $expires  The Unix timestamp when the cookie expires
      * @param string $password The encoded password
      *
      * @return string
      */
-    protected function generateCookieValue($class, $username, $expires, $password)
+    protected function generateCookieValue(string $class, string $username, int $expires, string $password)
     {
         // $username is encoded because it might contain COOKIE_DELIMITER,
         // we assume other values don't
@@ -113,14 +111,12 @@ protected function generateCookieValue($class, $username, $expires, $password)
     /**
      * Generates a hash for the cookie to ensure it is not being tampered with.
      *
-     * @param string $class
-     * @param string $username The username
      * @param int    $expires  The Unix timestamp when the cookie expires
      * @param string $password The encoded password
      *
      * @return string
      */
-    protected function generateCookieHash($class, $username, $expires, $password)
+    protected function generateCookieHash(string $class, string $username, int $expires, string $password)
     {
         return hash_hmac('sha256', $class.self::COOKIE_DELIMITER.$username.self::COOKIE_DELIMITER.$expires.self::COOKIE_DELIMITER.$password, $this->getSecret());
     }

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class AccessMap implements AccessMapInterface`
`28`	`28`	`* @param array $attributes An array of attributes to pass to the access decision manager (like roles)`
`29`	`29`	`* @param string\|null $channel The channel to enforce (http, https, or null)`
`30`	`30`	`*/`
`31`		`- public function add(RequestMatcherInterface $requestMatcher, array $attributes = [], $channel = null)`
	`31`	`+ public function add(RequestMatcherInterface $requestMatcher, array $attributes = [], string $channel = null)`
`32`	`32`	`{`
`33`	`33`	`$this->map[] = [$requestMatcher, $attributes, $channel];`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,11 +31,9 @@ public function __construct(RequestStack $requestStack)`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * @param bool $clearSession`
`35`		`- *`
`36`	`34`	`* @return AuthenticationException\|null`
`37`	`35`	`*/`
`38`		`- public function getLastAuthenticationError($clearSession = true)`
	`36`	`+ public function getLastAuthenticationError(bool $clearSession = true)`
`39`	`37`	`{`
`40`	`38`	`$request = $this->getRequest();`
`41`	`39`	`$authenticationException = null;`
Original file line number	Diff line number	Diff line change
`@@ -82,12 +82,7 @@ public function getProviderKey()`
`82`	`82`	`return $this->providerKey;`
`83`	`83`	`}`
`84`	`84`
`85`		`- /**`
`86`		`- * Set the provider key.`
`87`		`- *`
`88`		`- * @param string $providerKey`
`89`		`- */`
`90`		`- public function setProviderKey($providerKey)`
	`85`	`+ public function setProviderKey(string $providerKey)`
`91`	`86`	`{`
`92`	`87`	`$this->providerKey = $providerKey;`
`93`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public function __construct(UrlGeneratorInterface $urlGenerator = null, $urlMatc`
`58`	`58`	`*`
`59`	`59`	`* @return RedirectResponse A RedirectResponse instance`
`60`	`60`	`*/`
`61`		`- public function createRedirectResponse(Request $request, $path, $status = 302)`
	`61`	`+ public function createRedirectResponse(Request $request, string $path, int $status = 302)`
`62`	`62`	`{`
`63`	`63`	`if (null !== $this->secureDomainRegexp && 'https' === $this->urlMatcher->getContext()->getScheme() && preg_match('#^https?:[/\\\\]{2,}+[^/]++#i', $path, $host) && !preg_match(sprintf($this->secureDomainRegexp, preg_quote($request->getHttpHost())), $host[0])) {`
`64`	`64`	`$path = '/';`
`@@ -78,7 +78,7 @@ public function createRedirectResponse(Request $request, $path, $status = 302)`
`78`	`78`	`*`
`79`	`79`	`* @return Request A Request instance`
`80`	`80`	`*/`
`81`		`- public function createRequest(Request $request, $path)`
	`81`	`+ public function createRequest(Request $request, string $path)`
`82`	`82`	`{`
`83`	`83`	`$newRequest = Request::create($this->generateUri($request, $path), 'get', [], $request->cookies->all(), [], $request->server->all());`
`84`	`84`
`@@ -116,7 +116,7 @@ public function createRequest(Request $request, $path)`
`116`	`116`	`*`
`117`	`117`	`* @return bool true if the path is the same as the one from the Request, false otherwise`
`118`	`118`	`*/`
`119`		`- public function checkRequestPath(Request $request, $path)`
	`119`	`+ public function checkRequestPath(Request $request, string $path)`
`120`	`120`	`{`
`121`	`121`	`if ('/' !== $path[0]) {`
`122`	`122`	`try {`
`@@ -147,7 +147,7 @@ public function checkRequestPath(Request $request, $path)`
`147`	`147`	`*`
`148`	`148`	`* @throws \LogicException`
`149`	`149`	`*/`
`150`		`- public function generateUri(Request $request, $path)`
	`150`	`+ public function generateUri(Request $request, string $path)`
`151`	`151`	`{`
`152`	`152`	`if (0 === strpos($path, 'http') \|\| !$path) {`
`153`	`153`	`return $path;`
Original file line number	Diff line number	Diff line change
`@@ -56,32 +56,24 @@ public function registerListener($key, $logoutPath, $csrfTokenId, $csrfParameter`
`56`	`56`	`/**`
`57`	`57`	`* Generates the absolute logout path for the firewall.`
`58`	`58`	`*`
`59`		`- * @param string\|null $key The firewall key or null to use the current firewall key`
`60`		`- *`
`61`	`59`	`* @return string The logout path`
`62`	`60`	`*/`
`63`		`- public function getLogoutPath($key = null)`
	`61`	`+ public function getLogoutPath(string $key = null)`
`64`	`62`	`{`
`65`	`63`	`return $this->generateLogoutUrl($key, UrlGeneratorInterface::ABSOLUTE_PATH);`
`66`	`64`	`}`
`67`	`65`
`68`	`66`	`/**`
`69`	`67`	`* Generates the absolute logout URL for the firewall.`
`70`	`68`	`*`
`71`		`- * @param string\|null $key The firewall key or null to use the current firewall key`
`72`		`- *`
`73`	`69`	`* @return string The logout URL`
`74`	`70`	`*/`
`75`		`- public function getLogoutUrl($key = null)`
	`71`	`+ public function getLogoutUrl(string $key = null)`
`76`	`72`	`{`
`77`	`73`	`return $this->generateLogoutUrl($key, UrlGeneratorInterface::ABSOLUTE_URL);`
`78`	`74`	`}`
`79`	`75`
`80`		`- /**`
`81`		`- * @param string\|null $key The current firewall key`
`82`		`- * @param string\|null $context The current firewall context`
`83`		`- */`
`84`		`- public function setCurrentFirewall($key, $context = null)`
	`76`	`+ public function setCurrentFirewall(?string $key, string $context = null)`
`85`	`77`	`{`
`86`	`78`	`$this->currentFirewall = [$key, $context];`
`87`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,14 +29,11 @@ final class ParameterBagUtils`
`29`	`29`	`*`
`30`	`30`	`* Paths like foo[bar] will be evaluated to find deeper items in nested data structures.`
`31`	`31`	`*`
`32`		`- * @param ParameterBag $parameters The parameter bag`
`33`		`- * @param string $path The key`
`34`		`- *`
`35`	`32`	`* @return mixed`
`36`	`33`	`*`
`37`	`34`	`* @throws InvalidArgumentException when the given path is malformed`
`38`	`35`	`*/`
`39`		`- public static function getParameterBagValue(ParameterBag $parameters, $path)`
	`36`	`+ public static function getParameterBagValue(ParameterBag $parameters, string $path)`
`40`	`37`	`{`
`41`	`38`	`if (false === $pos = strpos($path, '[')) {`
`42`	`39`	`return $parameters->get($path);`
`@@ -64,14 +61,11 @@ public static function getParameterBagValue(ParameterBag $parameters, $path)`
`64`	`61`	`*`
`65`	`62`	`* Paths like foo[bar] will be evaluated to find deeper items in nested data structures.`
`66`	`63`	`*`
`67`		`- * @param Request $request The request`
`68`		`- * @param string $path The key`
`69`		`- *`
`70`	`64`	`* @return mixed`
`71`	`65`	`*`
`72`	`66`	`* @throws InvalidArgumentException when the given path is malformed`
`73`	`67`	`*/`
`74`		`- public static function getRequestParameterValue(Request $request, $path)`
	`68`	`+ public static function getRequestParameterValue(Request $request, string $path)`
`75`	`69`	`{`
`76`	`70`	`if (false === $pos = strpos($path, '[')) {`
`77`	`71`	`return $request->get($path);`
Original file line number	Diff line number	Diff line change
`@@ -235,11 +235,9 @@ final protected function getUserProvider($class)`
`235`	`235`	`/**`
`236`	`236`	`* Decodes the raw cookie value.`
`237`	`237`	`*`
`238`		`- * @param string $rawCookie`
`239`		`- *`
`240`	`238`	`* @return array`
`241`	`239`	`*/`
`242`		`- protected function decodeCookie($rawCookie)`
	`240`	`+ protected function decodeCookie(string $rawCookie)`
`243`	`241`	`{`
`244`	`242`	`return explode(self::COOKIE_DELIMITER, base64_decode($rawCookie));`
`245`	`243`	`}`
Original file line number	Diff line number	Diff line change
`@@ -91,14 +91,12 @@ protected function onLoginSuccess(Request $request, Response $response, TokenInt`
`91`	`91`	`/**`
`92`	`92`	`* Generates the cookie value.`
`93`	`93`	`*`
`94`		`- * @param string $class`
`95`		`- * @param string $username The username`
`96`	`94`	`* @param int $expires The Unix timestamp when the cookie expires`
`97`	`95`	`* @param string $password The encoded password`
`98`	`96`	`*`
`99`	`97`	`* @return string`
`100`	`98`	`*/`
`101`		`- protected function generateCookieValue($class, $username, $expires, $password)`
	`99`	`+ protected function generateCookieValue(string $class, string $username, int $expires, string $password)`
`102`	`100`	`{`
`103`	`101`	`// $username is encoded because it might contain COOKIE_DELIMITER,`
`104`	`102`	`// we assume other values don't`
`@@ -113,14 +111,12 @@ protected function generateCookieValue($class, $username, $expires, $password)`
`113`	`111`	`/**`
`114`	`112`	`* Generates a hash for the cookie to ensure it is not being tampered with.`
`115`	`113`	`*`
`116`		`- * @param string $class`
`117`		`- * @param string $username The username`
`118`	`114`	`* @param int $expires The Unix timestamp when the cookie expires`
`119`	`115`	`* @param string $password The encoded password`
`120`	`116`	`*`
`121`	`117`	`* @return string`
`122`	`118`	`*/`
`123`		`- protected function generateCookieHash($class, $username, $expires, $password)`
	`119`	`+ protected function generateCookieHash(string $class, string $username, int $expires, string $password)`
`124`	`120`	`{`
`125`	`121`	`return hash_hmac('sha256', $class.self::COOKIE_DELIMITER.$username.self::COOKIE_DELIMITER.$expires.self::COOKIE_DELIMITER.$password, $this->getSecret());`
`126`	`122`	`}`