-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Block old legacy clients #15683
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
Block old legacy clients #15683
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
<?php | ||
/** | ||
* @author Lukas Reschke <[email protected]> | ||
* | ||
* @copyright Copyright (c) 2015, ownCloud, Inc. | ||
* @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 OC\Connector\Sabre; | ||
|
||
use OCP\IConfig; | ||
use Sabre\HTTP\RequestInterface; | ||
use Sabre\DAV\ServerPlugin; | ||
use Sabre\DAV\Exception; | ||
|
||
/** | ||
* Class BlockLegacyClientPlugin is used to detect old legacy sync clients and | ||
* returns a 403 status to those clients | ||
* | ||
* @package OC\Connector\Sabre | ||
*/ | ||
class BlockLegacyClientPlugin extends ServerPlugin { | ||
/** @var \Sabre\DAV\Server */ | ||
protected $server; | ||
/** @var IConfig */ | ||
protected $config; | ||
|
||
/** | ||
* @param IConfig $config | ||
*/ | ||
public function __construct(IConfig $config) { | ||
$this->config = $config; | ||
} | ||
|
||
/** | ||
* @param \Sabre\DAV\Server $server | ||
* @return void | ||
*/ | ||
public function initialize(\Sabre\DAV\Server $server) { | ||
$this->server = $server; | ||
$this->server->on('beforeMethod', [$this, 'beforeHandler'], 200); | ||
} | ||
|
||
/** | ||
* Detects all unsupported clients and throws a \Sabre\DAV\Exception\Forbidden | ||
* exception which will result in a 403 to them. | ||
* @param RequestInterface $request | ||
* @throws \Sabre\DAV\Exception\Forbidden If the client version is not supported | ||
*/ | ||
public function beforeHandler(RequestInterface $request) { | ||
$userAgent = $request->getHeader('User-Agent'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what happens if no user agent is defined? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Indeed. That will probably fail as There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
if($userAgent === null) { | ||
return; | ||
} | ||
|
||
$minimumSupportedDesktopVersion = $this->config->getSystemValue('minimum.supported.desktop.version', '1.7.0'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what happens in case of miss configuration and the variable is set to:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Well. 💣 but honestly, if you add wrong data to your configuration ownCloud explodes in a lot of places 🙈 |
||
|
||
// Match on the mirall version which is in scheme "Mozilla/5.0 (%1) mirall/%2" or | ||
// "mirall/%1" for older releases | ||
preg_match("/(?:mirall\\/)([\d.]+)/i", $userAgent, $versionMatches); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @danimo is this enough to get all clients - even branded? |
||
if(isset($versionMatches[1]) && | ||
version_compare($versionMatches[1], $minimumSupportedDesktopVersion) === -1) { | ||
throw new \Sabre\DAV\Exception\Forbidden('Unsupported client version.'); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
<?php | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. lower case file names as per DeepDiver somewhere else in the PRs There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Honestly, I will not change this on my own. If @DeepDiver1975 wants this then we shall document this properly and enforce this in Jenkins. We have a hell of test files that use upper case and PHPStorm will highlight PHPUnit files only using this syntax. Since we don't have that mad autoloader madness problem here it will also work quite well… There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As in: Needs to get documented at https://doc.owncloud.org/server/8.0/developer_manual/general/codingguidelines.html 🙈 |
||
/** | ||
* @author Lukas Reschke <[email protected]> | ||
* | ||
* @copyright Copyright (c) 2015, ownCloud, Inc. | ||
* @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 Test\Connector\Sabre; | ||
|
||
use OC\Connector\Sabre\BlockLegacyClientPlugin; | ||
use Test\TestCase; | ||
use OCP\IConfig; | ||
|
||
/** | ||
* Class BlockLegacyClientPluginTest | ||
* | ||
* @package Test\Connector\Sabre | ||
*/ | ||
class BlockLegacyClientPluginTest extends TestCase { | ||
/** @var IConfig */ | ||
private $config; | ||
/** @var BlockLegacyClientPlugin */ | ||
private $blockLegacyClientVersionPlugin; | ||
|
||
public function setUp() { | ||
parent::setUp(); | ||
|
||
$this->config = $this->getMock('\OCP\IConfig'); | ||
$this->blockLegacyClientVersionPlugin = new BlockLegacyClientPlugin($this->config); | ||
} | ||
|
||
/** | ||
* @return array | ||
*/ | ||
public function oldDesktopClientProvider() { | ||
return [ | ||
['Mozilla/5.0 (1.5.0) mirall/1.5.0'], | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
['mirall/1.5.0'], | ||
['mirall/1.5.4'], | ||
['mirall/1.6.0'], | ||
['Mozilla/5.0 (Bogus Text) mirall/1.6.9'], | ||
]; | ||
} | ||
|
||
/** | ||
* @dataProvider oldDesktopClientProvider | ||
* @param string $userAgent | ||
* @expectedException \Sabre\DAV\Exception\Forbidden | ||
* @expectedExceptionMessage Unsupported client version. | ||
*/ | ||
public function testBeforeHandlerException($userAgent) { | ||
/** @var \Sabre\HTTP\RequestInterface $request */ | ||
$request = $this->getMock('\Sabre\HTTP\RequestInterface'); | ||
$request | ||
->expects($this->once()) | ||
->method('getHeader') | ||
->with('User-Agent') | ||
->will($this->returnValue($userAgent)); | ||
|
||
$this->config | ||
->expects($this->once()) | ||
->method('getSystemValue') | ||
->with('minimum.supported.desktop.version', '1.7.0') | ||
->will($this->returnValue('1.7.0')); | ||
|
||
$this->blockLegacyClientVersionPlugin->beforeHandler($request); | ||
} | ||
|
||
/** | ||
* @return array | ||
*/ | ||
public function newAndAlternateDesktopClientProvider() { | ||
return [ | ||
['Mozilla/5.0 (1.7.0) mirall/1.7.0'], | ||
['mirall/1.8.3'], | ||
['mirall/1.7.2'], | ||
['mirall/1.7.0'], | ||
['Mozilla/5.0 (Bogus Text) mirall/1.9.3'], | ||
]; | ||
} | ||
|
||
/** | ||
* @dataProvider newAndAlternateDesktopClientProvider | ||
* @param string $userAgent | ||
*/ | ||
public function testBeforeHandlerSuccess($userAgent) { | ||
/** @var \Sabre\HTTP\RequestInterface $request */ | ||
$request = $this->getMock('\Sabre\HTTP\RequestInterface'); | ||
$request | ||
->expects($this->once()) | ||
->method('getHeader') | ||
->with('User-Agent') | ||
->will($this->returnValue($userAgent)); | ||
|
||
$this->config | ||
->expects($this->once()) | ||
->method('getSystemValue') | ||
->with('minimum.supported.desktop.version', '1.7.0') | ||
->will($this->returnValue('1.7.0')); | ||
|
||
$this->blockLegacyClientVersionPlugin->beforeHandler($request); | ||
} | ||
|
||
public function testBeforeHandlerNoUserAgent() { | ||
/** @var \Sabre\HTTP\RequestInterface $request */ | ||
$request = $this->getMock('\Sabre\HTTP\RequestInterface'); | ||
$request | ||
->expects($this->once()) | ||
->method('getHeader') | ||
->with('User-Agent') | ||
->will($this->returnValue(null)); | ||
$this->blockLegacyClientVersionPlugin->beforeHandler($request); | ||
} | ||
|
||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@carlaschroder @MTRichards for wording and check if that is okay so.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few minor adjustments.
The minimum ownCloud desktop client version that will be allowed to sync with this server instance. All connections made from earlier clients will be denied by the server. Defaults to the minimum officially supported ownCloud version at the time of release of this server version.
When changing this, note that older unsupported versions of ownCloud may not function as expected, and could lead to permanent data loss for clients or other unexpected results.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjusted. Thanks!