firefly-iii/app/Console/Commands/VerifiesAccessToken.php

79 lines
2.3 KiB
PHP
Raw Normal View History

<?php
/**
* VerifiesAccessToken.php
* Copyright (c) 2017 thegrumpydictator@gmail.com
*
2017-10-21 01:40:00 -05:00
* This file is part of Firefly III.
*
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
2017-12-17 07:41:58 -06:00
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Console\Commands;
use FireflyIII\Repositories\User\UserRepositoryInterface;
use Log;
use Preferences;
2017-09-16 00:41:03 -05:00
/**
2017-11-15 05:25:49 -06:00
* Trait VerifiesAccessToken.
2017-09-16 00:41:03 -05:00
*
* Verifies user access token for sensitive commands.
*/
trait VerifiesAccessToken
{
2017-09-16 00:17:58 -05:00
/**
2017-09-16 00:41:03 -05:00
* Abstract method to make sure trait knows about method "option".
2017-10-05 04:49:06 -05:00
*
2017-09-16 00:17:58 -05:00
* @param null $key
*
* @return mixed
*/
abstract public function option($key = null);
/**
2017-09-16 00:41:03 -05:00
* Returns false when given token does not match given user token.
*
* @return bool
*/
protected function verifyAccessToken(): bool
{
$userId = intval($this->option('user'));
$token = strval($this->option('token'));
/** @var UserRepositoryInterface $repository */
$repository = app(UserRepositoryInterface::class);
$user = $repository->find($userId);
2017-11-15 05:25:49 -06:00
if (null === $user->id) {
Log::error(sprintf('verifyAccessToken(): no such user for input "%d"', $userId));
return false;
}
$accessToken = Preferences::getForUser($user, 'access_token', null);
2017-11-15 05:25:49 -06:00
if (null === $accessToken) {
Log::error(sprintf('User #%d has no access token, so cannot access command line options.', $userId));
return false;
}
if (!($accessToken->data === $token)) {
Log::error(sprintf('Invalid access token for user #%d.', $userId));
Log::error(sprintf('Token given is "%s", expected "%s".', $token, $accessToken->data));
return false;
}
return true;
}
2017-11-08 02:05:10 -06:00
}