Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 2k
Remove Config\App Security items#7630
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
kenjis
merged 12 commits into
codeigniter4:4.4
from
kenjis:remove-config-app-CSRF-items-4.4Jun 29, 2023
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
afeb419
refactor: remove CSRF config items in Config\App
kenjis a0665df
refactor: add property for SecurityConfig and use it
kenjis a9554b3
refactor: [BC] change Security constructor param from Config\App to C…
kenjis 5e7a1e6
docs: add changelog and upgrade note
kenjis 7a7e980
refactor: remove CSRF properties in MockAppConfig
kenjis 848436f
test: extract method to create instance
kenjis 241ac4c
test: update MockSecurity constructor param
kenjis 812b172
test: remove out-of-dated test case
kenjis eccbae4
docs: add Deprecations in changelog
kenjis 2868f5c
docs: add method signature change
kenjis 713db9e
fix: change Services::security() param type
kenjis 24e9cad
docs: add instruction in upgrade note
kenjis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -18,7 +18,6 @@ | ||
| use CodeIgniter\I18n\Time; | ||
| use CodeIgniter\Security\Exceptions\SecurityException; | ||
| use CodeIgniter\Session\Session; | ||
| use Config\App; | ||
| use Config\Cookie as CookieConfig; | ||
| use Config\Security as SecurityConfig; | ||
| use Config\Services; | ||
| @@ -44,13 +43,17 @@ class Security implements SecurityInterface | ||
| * Protection Method for Cross Site Request Forgery protection. | ||
| * | ||
| * @var string 'cookie' or 'session' | ||
| * | ||
| * @deprecated 4.4.0 Use $this->config->csrfProtection. | ||
| */ | ||
| protected $csrfProtection = self::CSRF_PROTECTION_COOKIE; | ||
| /** | ||
| * CSRF Token Randomization | ||
| * | ||
| * @var bool | ||
| * | ||
| * @deprecated 4.4.0 Use $this->config->tokenRandomize. | ||
| */ | ||
| protected $tokenRandomize = false; | ||
| @@ -69,6 +72,8 @@ class Security implements SecurityInterface | ||
| * Token name for Cross Site Request Forgery protection. | ||
| * | ||
| * @var string | ||
| * | ||
| * @deprecated 4.4.0 Use $this->config->tokenName. | ||
| */ | ||
| protected $tokenName = 'csrf_token_name'; | ||
| @@ -78,6 +83,8 @@ class Security implements SecurityInterface | ||
| * Header name for Cross Site Request Forgery protection. | ||
| * | ||
| * @var string | ||
| * | ||
| * @deprecated 4.4.0 Use $this->config->headerName. | ||
| */ | ||
| protected $headerName = 'X-CSRF-TOKEN'; | ||
| @@ -105,6 +112,8 @@ class Security implements SecurityInterface | ||
| * Defaults to two hours (in seconds). | ||
| * | ||
| * @var int | ||
| * | ||
| * @deprecated 4.4.0 Use $this->config->expires. | ||
| */ | ||
| protected $expires = 7200; | ||
| @@ -114,6 +123,8 @@ class Security implements SecurityInterface | ||
| * Regenerate CSRF Token on every request. | ||
| * | ||
| * @var bool | ||
| * | ||
| * @deprecated 4.4.0 Use $this->config->regenerate. | ||
| */ | ||
| protected $regenerate = true; | ||
| @@ -123,6 +134,8 @@ class Security implements SecurityInterface | ||
| * Redirect to previous page with error on failure. | ||
| * | ||
| * @var bool | ||
| * | ||
| * @deprecated 4.4.0 Use $this->config->redirect. | ||
| */ | ||
| protected $redirect = false; | ||
| @@ -163,35 +176,22 @@ class Security implements SecurityInterface | ||
| */ | ||
| private ?string $hashInCookie = null; | ||
| /** | ||
| * Security Config | ||
| */ | ||
| protected SecurityConfig $config; | ||
| /** | ||
| * Constructor. | ||
| * | ||
| * Stores our configuration and fires off the init() method to setup | ||
| * initial state. | ||
| */ | ||
| public function __construct(App $config) | ||
| public function __construct(SecurityConfig $config) | ||
| { | ||
| $security = config(SecurityConfig::class); | ||
| // Store CSRF-related configurations | ||
| if ($security instanceof SecurityConfig) { | ||
| $this->csrfProtection = $security->csrfProtection ?? $this->csrfProtection; | ||
| $this->tokenName = $security->tokenName ?? $this->tokenName; | ||
| $this->headerName = $security->headerName ?? $this->headerName; | ||
| $this->regenerate = $security->regenerate ?? $this->regenerate; | ||
| $this->redirect = $security->redirect ?? $this->redirect; | ||
| $this->rawCookieName = $security->cookieName ?? $this->rawCookieName; | ||
| $this->expires = $security->expires ?? $this->expires; | ||
| $this->tokenRandomize = $security->tokenRandomize ?? $this->tokenRandomize; | ||
michalsn marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| } else { | ||
| // `Config/Security.php` is absence | ||
| $this->tokenName = $config->CSRFTokenName ?? $this->tokenName; | ||
| $this->headerName = $config->CSRFHeaderName ?? $this->headerName; | ||
| $this->regenerate = $config->CSRFRegenerate ?? $this->regenerate; | ||
| $this->rawCookieName = $config->CSRFCookieName ?? $this->rawCookieName; | ||
| $this->expires = $config->CSRFExpire ?? $this->expires; | ||
| $this->redirect = $config->CSRFRedirect ?? $this->redirect; | ||
| } | ||
| $this->config = $config; | ||
| $this->rawCookieName = $config->cookieName; | ||
| if ($this->isCSRFCookie()) { | ||
| $cookie = config(CookieConfig::class); | ||
| @@ -213,7 +213,7 @@ public function __construct(App $config) | ||
| private function isCSRFCookie(): bool | ||
| { | ||
| return $this->csrfProtection === self::CSRF_PROTECTION_COOKIE; | ||
| return $this->config->csrfProtection === self::CSRF_PROTECTION_COOKIE; | ||
| } | ||
| private function configureSession(): void | ||
| @@ -287,7 +287,7 @@ public function verify(RequestInterface $request) | ||
| $postedToken = $this->getPostedToken($request); | ||
| try { | ||
| $token = ($postedToken !== null && $this->tokenRandomize) | ||
| $token = ($postedToken !== null && $this->config->tokenRandomize) | ||
| ? $this->derandomize($postedToken) : $postedToken; | ||
| } catch (InvalidArgumentException $e) { | ||
| $token = null; | ||
| @@ -300,7 +300,7 @@ public function verify(RequestInterface $request) | ||
| $this->removeTokenInRequest($request); | ||
| if ($this->regenerate) { | ||
| if ($this->config->regenerate) { | ||
| $this->generateHash(); | ||
| } | ||
| @@ -318,13 +318,13 @@ private function removeTokenInRequest(RequestInterface $request): void | ||
| $json = json_decode($request->getBody() ?? ''); | ||
| if (isset($_POST[$this->tokenName])) { | ||
| if (isset($_POST[$this->config->tokenName])) { | ||
| // We kill this since we're done and we don't want to pollute the POST array. | ||
| unset($_POST[$this->tokenName]); | ||
| unset($_POST[$this->config->tokenName]); | ||
| $request->setGlobal('post', $_POST); | ||
| } elseif (isset($json->{$this->tokenName})) { | ||
| } elseif (isset($json->{$this->config->tokenName})) { | ||
| // We kill this since we're done and we don't want to pollute the JSON data. | ||
| unset($json->{$this->tokenName}); | ||
| unset($json->{$this->config->tokenName}); | ||
| $request->setBody(json_encode($json)); | ||
| } | ||
| } | ||
| @@ -335,19 +335,19 @@ private function getPostedToken(RequestInterface $request): ?string | ||
| // Does the token exist in POST, HEADER or optionally php:://input - json data. | ||
| if ($tokenValue = $request->getPost($this->tokenName)) { | ||
| if ($tokenValue = $request->getPost($this->config->tokenName)) { | ||
| return $tokenValue; | ||
| } | ||
| if ($request->hasHeader($this->headerName) && ! empty($request->header($this->headerName)->getValue())) { | ||
| return $request->header($this->headerName)->getValue(); | ||
| if ($request->hasHeader($this->config->headerName) && ! empty($request->header($this->config->headerName)->getValue())) { | ||
| return $request->header($this->config->headerName)->getValue(); | ||
| } | ||
| $body = (string) $request->getBody(); | ||
| $json = json_decode($body); | ||
| if ($body !== '' && ! empty($json) && json_last_error() === JSON_ERROR_NONE) { | ||
| return $json->{$this->tokenName} ?? null; | ||
| return $json->{$this->config->tokenName} ?? null; | ||
| } | ||
| return null; | ||
| @@ -358,7 +358,7 @@ private function getPostedToken(RequestInterface $request): ?string | ||
| */ | ||
| public function getHash(): ?string | ||
| { | ||
| return $this->tokenRandomize ? $this->randomize($this->hash) : $this->hash; | ||
| return $this->config->tokenRandomize ? $this->randomize($this->hash) : $this->hash; | ||
| } | ||
| /** | ||
| @@ -407,23 +407,23 @@ protected function derandomize(string $token): string | ||
| */ | ||
| public function getTokenName(): string | ||
| { | ||
| return $this->tokenName; | ||
| return $this->config->tokenName; | ||
| } | ||
| /** | ||
| * Returns the CSRF Header Name. | ||
| */ | ||
| public function getHeaderName(): string | ||
| { | ||
| return $this->headerName; | ||
| return $this->config->headerName; | ||
| } | ||
| /** | ||
| * Returns the CSRF Cookie Name. | ||
| */ | ||
| public function getCookieName(): string | ||
| { | ||
| return $this->cookieName; | ||
| return $this->config->cookieName; | ||
| } | ||
| /** | ||
| @@ -443,7 +443,7 @@ public function isExpired(): bool | ||
| */ | ||
| public function shouldRedirect(): bool | ||
| { | ||
| return $this->redirect; | ||
| return $this->config->redirect; | ||
| } | ||
| /** | ||
| @@ -521,9 +521,9 @@ private function restoreHash(): void | ||
| if ($this->isHashInCookie()) { | ||
| $this->hash = $this->hashInCookie; | ||
| } | ||
| } elseif ($this->session->has($this->tokenName)) { | ||
| } elseif ($this->session->has($this->config->tokenName)) { | ||
| // Session based CSRF protection | ||
| $this->hash = $this->session->get($this->tokenName); | ||
| $this->hash = $this->session->get($this->config->tokenName); | ||
| } | ||
| } | ||
| @@ -562,7 +562,7 @@ private function saveHashInCookie(): void | ||
| $this->rawCookieName, | ||
| $this->hash, | ||
| [ | ||
| 'expires' => $this->expires === 0 ? 0 : Time::now()->getTimestamp() + $this->expires, | ||
| 'expires' => $this->config->expires === 0 ? 0 : Time::now()->getTimestamp() + $this->config->expires, | ||
| ] | ||
| ); | ||
| @@ -606,6 +606,6 @@ protected function doSendCookie(): void | ||
| private function saveHashInSession(): void | ||
| { | ||
| $this->session->set($this->tokenName, $this->hash); | ||
| $this->session->set($this->config->tokenName, $this->hash); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.