1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 <?php
/**
* BEdita, API-first content management framework
* Copyright 2018 ChannelWeb Srl, Chialab Srl
*
* This file is part of BEdita: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
*/
namespace BEdita\Core\Model\Entity;
use Cake\Core\Configure;
use Cake\Database\Expression\QueryExpression;
use Cake\ORM\Entity;
use Cake\ORM\TableRegistry;
use Cake\Utility\Hash;
use Cake\Utility\Text;
/**
* AuthProvider Entity.
*
* @property int $id
* @property string $name
* @property string $auth_class
* @property string $slug
* @property string $url
* @property string $params
* @property bool $enabled
* @property \Cake\I18n\Time $created
* @property \Cake\I18n\Time $modified
* @property \BEdita\Core\Model\Entity\ExternalAuth[] $external_auth
* @since 4.0.0
*/
class AuthProvider extends Entity
{
/**
* @inheritDoc
*/
protected $_accessible = [
'*' => true,
'id' => false,
];
/**
* Getter for slug.
*
* @return string
*/
protected function _getSlug()
{
[, $name] = pluginSplit($this->name);
return mb_strtolower(Text::slug($name));
}
/**
* Get list of roles to be associated to users logging in with this auth provider.
*
* @return \BEdita\Core\Model\Entity\Role[]
*/
public function getRoles()
{
$roles = (array)Configure::read(sprintf('Roles.%s', $this->auth_class));
if (empty($roles)) {
return [];
}
$table = TableRegistry::getTableLocator()->get('Roles');
return $table->find()
->where(function (QueryExpression $exp) use ($table, $roles) {
return $exp->in($table->aliasField('name'), $roles);
})
->toArray();
}
/**
* Check auth providers credentials.
* Provider username MUST match external auth provider response.
*
* @param array $providerResponse Provider response in array format
* @param string $providerUsername Provider username to match
* @return bool True on success, false on failure
*/
public function checkAuthorization($providerResponse, $providerUsername)
{
$fieldPath = Hash::get($this->get('params'), 'provider_username_field', 'id');
$userName = Hash::get($providerResponse, (string)$fieldPath);
return $userName === $providerUsername;
}
}