Allow to configure "allowed domains" for CORS on DAV #40537
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 | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,176 @@ | ||||||
| <?php | ||||||
| /** | ||||||
| * @copyright Copyright (c) 2018, ownCloud GmbH | ||||||
| * | ||||||
| * @author Noveen Sachdeva <[email protected]> | ||||||
| * @author Ferdinand Thiessen <[email protected]> | ||||||
| * | ||||||
| * @license AGPL-3.0 | ||||||
| * | ||||||
| * This code is free software: you can redistribute it and/or modify | ||||||
| * it under the terms of the GNU Affero General Public License, version 3, | ||||||
| * as published by the Free Software Foundation. | ||||||
| * | ||||||
| * This program is distributed in the hope that it will be useful, | ||||||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||||
| * GNU Affero General Public License for more details. | ||||||
| * | ||||||
| * You should have received a copy of the GNU Affero General Public License, version 3, | ||||||
| * along with this program. If not, see <http://www.gnu.org/licenses/> | ||||||
| * | ||||||
| */ | ||||||
|
|
||||||
| namespace OCA\DAV\Connector\Sabre; | ||||||
|
|
||||||
| use OCP\IConfig; | ||||||
| use OCP\IUserSession; | ||||||
| use OCP\Util; | ||||||
| use Sabre\DAV\ServerPlugin; | ||||||
| use Sabre\HTTP\RequestInterface; | ||||||
| use Sabre\HTTP\ResponseInterface; | ||||||
|
|
||||||
| /** | ||||||
| * Class CorsPlugin is a plugin which adds CORS headers to the responses | ||||||
| */ | ||||||
| class CorsPlugin extends ServerPlugin { | ||||||
| /** | ||||||
| * Reference to main server object | ||||||
| */ | ||||||
| private \Sabre\DAV\Server $server; | ||||||
|
|
||||||
| private bool $alreadyExecuted = false; | ||||||
|
|
||||||
| /** | ||||||
| * @param IUserSession $userSession | ||||||
| */ | ||||||
| public function __construct( | ||||||
| private IUserSession $userSession, | ||||||
| private IConfig $config, | ||||||
| ) { | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * This initializes the plugin. | ||||||
| * | ||||||
| * This function is called by \Sabre\DAV\Server, after | ||||||
| * addPlugin is called. | ||||||
| * | ||||||
| * This method should set up the required event subscriptions. | ||||||
| * | ||||||
| * @param \Sabre\DAV\Server $server | ||||||
| * @return void | ||||||
| */ | ||||||
| public function initialize(\Sabre\DAV\Server $server) { | ||||||
| $this->server = $server; | ||||||
|
|
||||||
| $request = $this->server->httpRequest; | ||||||
| if (!$request->hasHeader('Origin')) { | ||||||
| return; | ||||||
| } | ||||||
|
Comment on lines
+68
to
+70
Collaborator
There was a problem hiding this comment. I think you can skip this part. The test |
||||||
| $originHeader = $request->getHeader('Origin'); | ||||||
| if ($originHeader === null || $this->ignoreOriginHeader($originHeader)) { | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| try { | ||||||
| if (Util::isSameDomain($originHeader, $request->getAbsoluteUrl())) { | ||||||
| return; | ||||||
| } | ||||||
| } catch (\InvalidArgumentException $e) { | ||||||
| \OC::$server->getLogger()->debug('Invalid origin header was passed', ['Origin' => $originHeader, 'exception' => $e]); | ||||||
Check noticeCode scanning / Psalm DeprecatedMethod
Collaborator
There was a problem hiding this comment.
Suggested change
Check noticeCode scanning / Psalm DeprecatedMethod |
||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| $this->server->on('beforeMethod:*', [$this, 'setCorsHeaders']); | ||||||
| $this->server->on('exception', [$this, 'onException']); | ||||||
| $this->server->on('beforeMethod:OPTIONS', [$this, 'setOptionsRequestHeaders'], 5); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @param \Throwable $ex The thrown exception | ||||||
| * @return void | ||||||
| */ | ||||||
| public function onException(\Throwable $ex) { | ||||||
| $this->setCorsHeaders($this->server->httpRequest, $this->server->httpResponse); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * This method sets the cors headers for all requests | ||||||
| * | ||||||
| * @param RequestInterface $request | ||||||
| * @param ResponseInterface $response | ||||||
| * @return void | ||||||
| */ | ||||||
| public function setCorsHeaders(RequestInterface $request, ResponseInterface $response) { | ||||||
| $requesterDomain = $request->getHeader('Origin'); | ||||||
| if ($requesterDomain === null) { | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| if ($this->alreadyExecuted) { | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| $this->alreadyExecuted = true; | ||||||
|
|
||||||
| // unauthenticated request shall add cors headers as well | ||||||
| $userId = null; | ||||||
| if ($this->userSession->getUser() !== null) { | ||||||
| $userId = $this->userSession->getUser()->getUID(); | ||||||
Check noticeCode scanning / Psalm PossiblyNullReference |
||||||
| } | ||||||
|
|
||||||
| \OC_Response::setCorsHeaders( | ||||||
| $response, | ||||||
| $userId, | ||||||
| $requesterDomain, | ||||||
| $this->config, | ||||||
| $this->server->getAllowedMethods($request->getPath()) | ||||||
| ); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Handles the OPTIONS request | ||||||
| * | ||||||
| * @param RequestInterface $request | ||||||
| * @param ResponseInterface $response | ||||||
| * | ||||||
| * @return false|void | ||||||
| * @throws \InvalidArgumentException | ||||||
| */ | ||||||
| public function setOptionsRequestHeaders(RequestInterface $request, ResponseInterface $response) { | ||||||
| $authorization = $request->getHeader('Authorization'); | ||||||
| if ($authorization === null || $authorization === '') { | ||||||
|
Collaborator
There was a problem hiding this comment. Maybe:
Suggested change
|
||||||
| // Set the proper response | ||||||
| $response->setStatus(200); | ||||||
| \OC_Response::setOptionsRequestHeaders( | ||||||
| $response, | ||||||
| $this->config, | ||||||
| $this->server->getAllowedMethods($request->getPath()) | ||||||
| ); | ||||||
|
|
||||||
| // Since All OPTIONS requests are unauthorized, we will have to return false from here | ||||||
| // If we don't return false, due to no authorization, a 401-Unauthorized will be thrown | ||||||
| // Which we don't want here | ||||||
| // Hence this sendResponse | ||||||
| $this->server->sapi->sendResponse($response); | ||||||
| return false; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * in addition to schemas used by extensions we ignore empty origin header | ||||||
| * values as well as 'null' which is not valid by the specification but used | ||||||
| * by some clients (Buttercup and Tusk) | ||||||
| * | ||||||
| * @param string $originHeader | ||||||
| * @return bool | ||||||
| */ | ||||||
| public function ignoreOriginHeader($originHeader) { | ||||||
| if (\in_array($originHeader, ['', null, 'null'], true)) { | ||||||
| return true; | ||||||
| } | ||||||
| $schema = \parse_url($originHeader, PHP_URL_SCHEME); | ||||||
| return \in_array(\strtolower($schema), ['moz-extension', 'chrome-extension']); | ||||||
| } | ||||||
| } | ||||||
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
Oops, something went wrong.
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.