-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #188 from nextcloud/add-wnd
Add "Global Auth" option to external storage
- Loading branch information
Showing
9 changed files
with
282 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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,88 @@ | ||
<?php | ||
/** | ||
* @author Robin Appelman <[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 OCA\Files_External\Lib\Auth\Password; | ||
|
||
use OCA\Files_External\Service\BackendService; | ||
use OCP\IL10N; | ||
use OCP\IUser; | ||
use OCA\Files_External\Lib\Auth\AuthMechanism; | ||
use OCA\Files_External\Lib\StorageConfig; | ||
use OCP\Security\ICredentialsManager; | ||
use OCP\Files\Storage; | ||
use OCA\Files_External\Lib\InsufficientDataForMeaningfulAnswerException; | ||
|
||
/** | ||
* Global Username and Password | ||
*/ | ||
class GlobalAuth extends AuthMechanism { | ||
|
||
const CREDENTIALS_IDENTIFIER = 'password::global'; | ||
|
||
/** @var ICredentialsManager */ | ||
protected $credentialsManager; | ||
|
||
public function __construct(IL10N $l, ICredentialsManager $credentialsManager) { | ||
$this->credentialsManager = $credentialsManager; | ||
|
||
$this | ||
->setIdentifier('password::global') | ||
->setVisibility(BackendService::VISIBILITY_DEFAULT) | ||
->setScheme(self::SCHEME_PASSWORD) | ||
->setText($l->t('Global Credentials')); | ||
} | ||
|
||
public function getAuth($uid) { | ||
$auth = $this->credentialsManager->retrieve($uid, self::CREDENTIALS_IDENTIFIER); | ||
if (!is_array($auth)) { | ||
return [ | ||
'user' => '', | ||
'password' => '' | ||
]; | ||
} else { | ||
return $auth; | ||
} | ||
} | ||
|
||
public function saveAuth($uid, $user, $password) { | ||
$this->credentialsManager->store($uid, self::CREDENTIALS_IDENTIFIER, [ | ||
'user' => $user, | ||
'password' => $password | ||
]); | ||
} | ||
|
||
public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { | ||
if ($storage->getType() === StorageConfig::MOUNT_TYPE_ADMIN) { | ||
$uid = ''; | ||
} elseif (is_null($user)) { | ||
throw new InsufficientDataForMeaningfulAnswerException('No credentials saved'); | ||
} else { | ||
$uid = $user->getUID(); | ||
} | ||
$credentials = $this->credentialsManager->retrieve($uid, self::CREDENTIALS_IDENTIFIER); | ||
|
||
if (is_array($credentials)) { | ||
$storage->setBackendOption('user', $credentials['user']); | ||
$storage->setBackendOption('password', $credentials['password']); | ||
} | ||
} | ||
|
||
} |
This file contains 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 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 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 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,117 @@ | ||
<?php | ||
/** | ||
* @author Robin Appelman <[email protected]> | ||
* | ||
* @copyright Copyright (c) 2016, 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 OCA\Files_External\Tests\Auth\Password; | ||
|
||
use OCA\Files_External\Lib\Auth\Password\GlobalAuth; | ||
use OCA\Files_external\Lib\StorageConfig; | ||
use Test\TestCase; | ||
|
||
class GlobalAuthTest extends TestCase { | ||
/** | ||
* @var \OCP\IL10N|\PHPUnit_Framework_MockObject_MockObject | ||
*/ | ||
private $l10n; | ||
|
||
/** | ||
* @var \OCP\Security\ICredentialsManager|\PHPUnit_Framework_MockObject_MockObject | ||
*/ | ||
private $credentialsManager; | ||
|
||
/** | ||
* @var GlobalAuth | ||
*/ | ||
private $instance; | ||
|
||
protected function setUp() { | ||
parent::setUp(); | ||
$this->l10n = $this->getMock('\OCP\IL10N'); | ||
$this->credentialsManager = $this->getMock('\OCP\Security\ICredentialsManager'); | ||
$this->instance = new GlobalAuth($this->l10n, $this->credentialsManager); | ||
} | ||
|
||
private function getStorageConfig($type, $config = []) { | ||
/** @var \OCA\Files_External\Lib\StorageConfig|\PHPUnit_Framework_MockObject_MockObject $storageConfig */ | ||
$storageConfig = $this->getMock('\OCA\Files_External\Lib\StorageConfig'); | ||
$storageConfig->expects($this->any()) | ||
->method('getType') | ||
->will($this->returnValue($type)); | ||
$storageConfig->expects($this->any()) | ||
->method('getBackendOptions') | ||
->will($this->returnCallback(function () use (&$config) { | ||
return $config; | ||
})); | ||
$storageConfig->expects($this->any()) | ||
->method('getBackendOption') | ||
->will($this->returnCallback(function ($key) use (&$config) { | ||
return $config[$key]; | ||
})); | ||
$storageConfig->expects($this->any()) | ||
->method('setBackendOption') | ||
->will($this->returnCallback(function ($key, $value) use (&$config) { | ||
$config[$key] = $value; | ||
})); | ||
|
||
return $storageConfig; | ||
} | ||
|
||
public function testNoCredentials() { | ||
$this->credentialsManager->expects($this->once()) | ||
->method('retrieve') | ||
->will($this->returnValue(null)); | ||
|
||
$storage = $this->getStorageConfig(StorageConfig::MOUNT_TYPE_ADMIN); | ||
|
||
$this->instance->manipulateStorageConfig($storage); | ||
$this->assertEquals([], $storage->getBackendOptions()); | ||
} | ||
|
||
public function testSavedCredentials() { | ||
$this->credentialsManager->expects($this->once()) | ||
->method('retrieve') | ||
->will($this->returnValue([ | ||
'user' => 'a', | ||
'password' => 'b' | ||
])); | ||
|
||
$storage = $this->getStorageConfig(StorageConfig::MOUNT_TYPE_ADMIN); | ||
|
||
$this->instance->manipulateStorageConfig($storage); | ||
$this->assertEquals([ | ||
'user' => 'a', | ||
'password' => 'b' | ||
], $storage->getBackendOptions()); | ||
} | ||
|
||
/** | ||
* @expectedException \OCA\Files_External\Lib\InsufficientDataForMeaningfulAnswerException | ||
*/ | ||
public function testNoCredentialsPersonal() { | ||
$this->credentialsManager->expects($this->never()) | ||
->method('retrieve'); | ||
|
||
$storage = $this->getStorageConfig(StorageConfig::MOUNT_TYPE_PERSONAl); | ||
|
||
$this->instance->manipulateStorageConfig($storage); | ||
$this->assertEquals([], $storage->getBackendOptions()); | ||
} | ||
|
||
} |