2018-05-18 20:48:08 +03:00
|
|
|
<?php
|
2019-12-03 21:57:53 +03:00
|
|
|
|
2018-05-18 20:48:08 +03:00
|
|
|
declare(strict_types=1);
|
2019-12-03 21:57:53 +03:00
|
|
|
|
2018-05-18 20:48:08 +03:00
|
|
|
/**
|
|
|
|
*
|
2019-12-03 21:57:53 +03:00
|
|
|
*
|
|
|
|
* @author Daniel Kesselberg <mail@danielkesselberg.de>
|
2018-05-18 20:48:08 +03:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
|
|
*
|
|
|
|
* @license GNU AGPL version 3 or any later version
|
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License as
|
|
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
|
|
* License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* 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
|
2019-12-03 21:57:53 +03:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2018-05-18 20:48:08 +03:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace OC\Authentication\Token;
|
|
|
|
|
|
|
|
use OCP\AppFramework\Db\Entity;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @method void setId(int $id)
|
|
|
|
* @method void setUid(string $uid);
|
|
|
|
* @method void setLoginName(string $loginname)
|
|
|
|
* @method string getToken()
|
|
|
|
* @method void setType(int $type)
|
|
|
|
* @method int getType()
|
|
|
|
* @method void setRemember(int $remember)
|
|
|
|
* @method void setLastActivity(int $lastactivity)
|
|
|
|
* @method int getLastActivity()
|
|
|
|
* @method string getPrivateKey()
|
|
|
|
* @method void setPrivateKey(string $key)
|
|
|
|
* @method string getPublicKey()
|
|
|
|
* @method void setPublicKey(string $key)
|
|
|
|
* @method void setVersion(int $version)
|
2018-09-26 14:10:17 +03:00
|
|
|
* @method bool getPasswordInvalid()
|
2018-05-18 20:48:08 +03:00
|
|
|
*/
|
2019-04-03 17:00:46 +03:00
|
|
|
class PublicKeyToken extends Entity implements INamedToken, IWipeableToken {
|
2018-06-04 10:51:13 +03:00
|
|
|
const VERSION = 2;
|
|
|
|
|
2018-05-18 20:48:08 +03:00
|
|
|
/** @var string user UID */
|
|
|
|
protected $uid;
|
|
|
|
|
|
|
|
/** @var string login name used for generating the token */
|
|
|
|
protected $loginName;
|
|
|
|
|
|
|
|
/** @var string encrypted user password */
|
|
|
|
protected $password;
|
|
|
|
|
|
|
|
/** @var string token name (e.g. browser/OS) */
|
|
|
|
protected $name;
|
|
|
|
|
|
|
|
/** @var string */
|
|
|
|
protected $token;
|
|
|
|
|
|
|
|
/** @var int */
|
|
|
|
protected $type;
|
|
|
|
|
|
|
|
/** @var int */
|
|
|
|
protected $remember;
|
|
|
|
|
|
|
|
/** @var int */
|
|
|
|
protected $lastActivity;
|
|
|
|
|
|
|
|
/** @var int */
|
|
|
|
protected $lastCheck;
|
|
|
|
|
|
|
|
/** @var string */
|
|
|
|
protected $scope;
|
|
|
|
|
|
|
|
/** @var int */
|
|
|
|
protected $expires;
|
|
|
|
|
|
|
|
/** @var string */
|
|
|
|
protected $privateKey;
|
|
|
|
|
|
|
|
/** @var string */
|
|
|
|
protected $publicKey;
|
|
|
|
|
|
|
|
/** @var int */
|
|
|
|
protected $version;
|
|
|
|
|
2018-09-26 14:10:17 +03:00
|
|
|
/** @var bool */
|
|
|
|
protected $passwordInvalid;
|
|
|
|
|
2018-05-18 20:48:08 +03:00
|
|
|
public function __construct() {
|
|
|
|
$this->addType('uid', 'string');
|
|
|
|
$this->addType('loginName', 'string');
|
|
|
|
$this->addType('password', 'string');
|
|
|
|
$this->addType('name', 'string');
|
|
|
|
$this->addType('token', 'string');
|
|
|
|
$this->addType('type', 'int');
|
|
|
|
$this->addType('remember', 'int');
|
|
|
|
$this->addType('lastActivity', 'int');
|
|
|
|
$this->addType('lastCheck', 'int');
|
|
|
|
$this->addType('scope', 'string');
|
|
|
|
$this->addType('expires', 'int');
|
|
|
|
$this->addType('publicKey', 'string');
|
|
|
|
$this->addType('privateKey', 'string');
|
|
|
|
$this->addType('version', 'int');
|
2018-09-26 14:10:17 +03:00
|
|
|
$this->addType('passwordInvalid', 'bool');
|
2018-05-18 20:48:08 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
public function getId(): int {
|
|
|
|
return $this->id;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getUID(): string {
|
|
|
|
return $this->uid;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the login name used when generating the token
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getLoginName(): string {
|
|
|
|
return parent::getLoginName();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the (encrypted) login password
|
|
|
|
*
|
|
|
|
* @return string|null
|
|
|
|
*/
|
|
|
|
public function getPassword() {
|
|
|
|
return parent::getPassword();
|
|
|
|
}
|
|
|
|
|
|
|
|
public function jsonSerialize() {
|
|
|
|
return [
|
|
|
|
'id' => $this->id,
|
|
|
|
'name' => $this->name,
|
|
|
|
'lastActivity' => $this->lastActivity,
|
|
|
|
'type' => $this->type,
|
|
|
|
'scope' => $this->getScopeAsArray()
|
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the timestamp of the last password check
|
|
|
|
*
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
public function getLastCheck(): int {
|
|
|
|
return parent::getLastCheck();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the timestamp of the last password check
|
|
|
|
*
|
|
|
|
* @param int $time
|
|
|
|
*/
|
|
|
|
public function setLastCheck(int $time) {
|
|
|
|
parent::setLastCheck($time);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getScope(): string {
|
|
|
|
$scope = parent::getScope();
|
|
|
|
if ($scope === null) {
|
|
|
|
return '';
|
|
|
|
}
|
|
|
|
|
|
|
|
return $scope;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getScopeAsArray(): array {
|
|
|
|
$scope = json_decode($this->getScope(), true);
|
|
|
|
if (!$scope) {
|
|
|
|
return [
|
|
|
|
'filesystem'=> true
|
|
|
|
];
|
|
|
|
}
|
|
|
|
return $scope;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function setScope($scope) {
|
2018-06-14 20:39:07 +03:00
|
|
|
if (is_array($scope)) {
|
2018-05-18 20:48:08 +03:00
|
|
|
parent::setScope(json_encode($scope));
|
|
|
|
} else {
|
|
|
|
parent::setScope((string)$scope);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getName(): string {
|
|
|
|
return parent::getName();
|
|
|
|
}
|
|
|
|
|
2019-01-21 22:45:27 +03:00
|
|
|
public function setName(string $name): void {
|
|
|
|
parent::setName($name);
|
|
|
|
}
|
|
|
|
|
2018-05-18 20:48:08 +03:00
|
|
|
public function getRemember(): int {
|
|
|
|
return parent::getRemember();
|
|
|
|
}
|
|
|
|
|
|
|
|
public function setToken(string $token) {
|
|
|
|
parent::setToken($token);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function setPassword(string $password = null) {
|
|
|
|
parent::setPassword($password);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function setExpires($expires) {
|
|
|
|
parent::setExpires($expires);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return int|null
|
|
|
|
*/
|
|
|
|
public function getExpires() {
|
|
|
|
return parent::getExpires();
|
|
|
|
}
|
2018-10-02 12:50:41 +03:00
|
|
|
|
|
|
|
public function setPasswordInvalid(bool $invalid) {
|
|
|
|
parent::setPasswordInvalid($invalid);
|
|
|
|
}
|
2019-04-03 17:00:46 +03:00
|
|
|
|
|
|
|
public function wipe(): void {
|
|
|
|
parent::setType(IToken::WIPE_TOKEN);
|
|
|
|
}
|
2018-05-18 20:48:08 +03:00
|
|
|
}
|