nextcloud/lib/private/Authentication/Token/DefaultTokenProvider.php

241 lines
6.0 KiB
PHP
Raw Normal View History

<?php
/**
* @author Christoph Wurst <christoph@owncloud.com>
*
* @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 OC\Authentication\Token;
use Exception;
use OC\Authentication\Exceptions\InvalidTokenException;
use OC\Authentication\Exceptions\PasswordlessTokenException;
use OCP\AppFramework\Db\DoesNotExistException;
2016-05-02 20:58:19 +03:00
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\IConfig;
use OCP\ILogger;
use OCP\IUser;
use OCP\Security\ICrypto;
class DefaultTokenProvider implements IProvider {
/** @var DefaultTokenMapper */
private $mapper;
/** @var ICrypto */
private $crypto;
/** @var IConfig */
private $config;
/** @var ILogger $logger */
private $logger;
2016-05-02 20:58:19 +03:00
/** @var ITimeFactory $time */
private $time;
/**
* @param DefaultTokenMapper $mapper
* @param ICrypto $crypto
* @param IConfig $config
* @param ILogger $logger
2016-05-06 17:31:40 +03:00
* @param ITimeFactory $time
*/
2016-05-02 20:58:19 +03:00
public function __construct(DefaultTokenMapper $mapper, ICrypto $crypto, IConfig $config, ILogger $logger, ITimeFactory $time) {
$this->mapper = $mapper;
$this->crypto = $crypto;
$this->config = $config;
$this->logger = $logger;
2016-05-02 20:58:19 +03:00
$this->time = $time;
}
/**
* Create and persist a new token
*
* @param string $token
* @param string $uid
* @param string $loginName
* @param string|null $password
2016-05-06 17:31:40 +03:00
* @param string $name
2016-05-02 20:58:19 +03:00
* @param int $type token type
* @return IToken
*/
public function generateToken($token, $uid, $loginName, $password, $name, $type = IToken::TEMPORARY_TOKEN) {
$dbToken = new DefaultToken();
$dbToken->setUid($uid);
$dbToken->setLoginName($loginName);
if (!is_null($password)) {
$dbToken->setPassword($this->encryptPassword($password, $token));
}
$dbToken->setName($name);
$dbToken->setToken($this->hashToken($token));
$dbToken->setType($type);
2016-05-02 20:58:19 +03:00
$dbToken->setLastActivity($this->time->getTime());
$this->mapper->insert($dbToken);
return $dbToken;
}
/**
* Update token activity timestamp
*
2016-05-06 17:31:40 +03:00
* @throws InvalidTokenException
* @param IToken $token
*/
2016-04-27 10:38:30 +03:00
public function updateToken(IToken $token) {
if (!($token instanceof DefaultToken)) {
throw new InvalidTokenException();
}
/** @var DefaultToken $token */
2016-05-02 20:58:19 +03:00
$token->setLastActivity($this->time->getTime());
$this->mapper->update($token);
}
/**
* Get all token of a user
*
* The provider may limit the number of result rows in case of an abuse
* where a high number of (session) tokens is generated
*
* @param IUser $user
* @return IToken[]
*/
public function getTokenByUser(IUser $user) {
return $this->mapper->getTokenByUser($user);
}
/**
2016-05-17 18:20:54 +03:00
* Get a token by token id
*
* @param string $tokenId
* @throws InvalidTokenException
2016-05-06 17:31:40 +03:00
* @return DefaultToken
*/
2016-05-17 18:20:54 +03:00
public function getToken($tokenId) {
try {
2016-05-17 18:20:54 +03:00
return $this->mapper->getToken($this->hashToken($tokenId));
} catch (DoesNotExistException $ex) {
throw new InvalidTokenException();
}
}
/**
2016-05-17 18:20:54 +03:00
* @param IToken $savedToken
* @param string $tokenId session token
2016-05-18 19:25:05 +03:00
* @throws InvalidTokenException
* @throws PasswordlessTokenException
2016-05-06 17:31:40 +03:00
* @return string
*/
2016-05-17 18:20:54 +03:00
public function getPassword(IToken $savedToken, $tokenId) {
$password = $savedToken->getPassword();
if (is_null($password)) {
throw new PasswordlessTokenException();
}
return $this->decryptPassword($password, $tokenId);
}
/**
* Invalidate (delete) the given session token
*
* @param string $token
*/
public function invalidateToken($token) {
$this->mapper->invalidate($this->hashToken($token));
}
/**
* Invalidate (delete) the given token
*
* @param IUser $user
* @param int $id
*/
public function invalidateTokenById(IUser $user, $id) {
$this->mapper->deleteById($user, $id);
}
/**
* Invalidate (delete) old session tokens
*/
public function invalidateOldTokens() {
2016-05-02 20:58:19 +03:00
$olderThan = $this->time->getTime() - (int) $this->config->getSystemValue('session_lifetime', 60 * 60 * 24);
$this->logger->info('Invalidating tokens older than ' . date('c', $olderThan));
$this->mapper->invalidateOld($olderThan);
}
/**
* @param string $token
* @throws InvalidTokenException
2016-05-06 17:31:40 +03:00
* @return DefaultToken user UID
*/
public function validateToken($token) {
try {
$dbToken = $this->mapper->getToken($this->hashToken($token));
$this->logger->debug('valid default token for ' . $dbToken->getUID());
2016-04-27 10:38:30 +03:00
return $dbToken;
} catch (DoesNotExistException $ex) {
throw new InvalidTokenException();
}
}
/**
* @param string $token
* @return string
*/
private function hashToken($token) {
2016-05-02 20:58:19 +03:00
$secret = $this->config->getSystemValue('secret');
return hash('sha512', $token . $secret);
}
/**
* Encrypt the given password
*
* The token is used as key
*
* @param string $password
* @param string $token
* @return string encrypted password
*/
private function encryptPassword($password, $token) {
$secret = $this->config->getSystemValue('secret');
return $this->crypto->encrypt($password, $token . $secret);
}
/**
* Decrypt the given password
*
* The token is used as key
*
* @param string $password
* @param string $token
2016-05-18 19:25:05 +03:00
* @throws InvalidTokenException
* @return string the decrypted key
*/
private function decryptPassword($password, $token) {
$secret = $this->config->getSystemValue('secret');
try {
return $this->crypto->decrypt($password, $token . $secret);
} catch (Exception $ex) {
// Delete the invalid token
$this->invalidateToken($token);
throw new InvalidTokenException();
}
}
}