2022-01-25 21:17:32 +09:00
|
|
|
<?php
|
|
|
|
|
|
|
|
declare(strict_types = 1);
|
|
|
|
|
|
|
|
// {{{ License
|
|
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
|
|
//
|
|
|
|
// GNU social 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.
|
|
|
|
//
|
|
|
|
// GNU social 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
|
|
|
|
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
// }}}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* OAuth2 Client
|
|
|
|
*
|
|
|
|
* @package GNUsocial
|
|
|
|
*
|
|
|
|
* @author Hugo Sales <hugo@hsal.es>
|
|
|
|
* @copyright 2022 Free Software Foundation, Inc http://www.fsf.org
|
|
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Plugin\OAuth2\Entity;
|
|
|
|
|
|
|
|
use App\Core\Entity;
|
2022-02-05 03:34:08 +09:00
|
|
|
use DateTimeImmutable;
|
2022-01-25 21:17:32 +09:00
|
|
|
use DateTimeInterface;
|
|
|
|
use League\OAuth2\Server\Entities\AccessTokenEntityInterface;
|
|
|
|
use League\OAuth2\Server\Entities\RefreshTokenEntityInterface;
|
2022-02-05 03:34:08 +09:00
|
|
|
use Plugin\OAuth2\Repository;
|
2022-01-25 21:17:32 +09:00
|
|
|
|
|
|
|
class RefreshToken extends Entity implements RefreshTokenEntityInterface
|
|
|
|
{
|
|
|
|
// {{{ Autocode
|
|
|
|
// @codeCoverageIgnoreStart
|
|
|
|
private string $id;
|
|
|
|
private DateTimeInterface $expiry;
|
|
|
|
private ?string $access_token_id = null;
|
|
|
|
private bool $revoked;
|
|
|
|
private DateTimeInterface $created;
|
|
|
|
|
2022-02-05 03:34:08 +09:00
|
|
|
public function getId(): string
|
|
|
|
{
|
|
|
|
return $this->id;
|
|
|
|
}
|
|
|
|
|
2022-01-25 21:17:32 +09:00
|
|
|
public function setId(string $id): self
|
|
|
|
{
|
|
|
|
$this->id = mb_substr($id, 0, 64);
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2022-02-05 03:34:08 +09:00
|
|
|
public function getExpiry(): DateTimeInterface
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
return $this->expiry;
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
public function setExpiry(DateTimeInterface $expiry): self
|
|
|
|
{
|
|
|
|
$this->expiry = $expiry;
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2022-02-05 03:34:08 +09:00
|
|
|
public function getAccessTokenId(): ?string
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
return $this->access_token_id;
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
public function setAccessTokenId(?string $access_token_id): self
|
|
|
|
{
|
|
|
|
$this->access_token_id = \is_null($access_token_id) ? null : mb_substr($access_token_id, 0, 64);
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2022-02-05 03:34:08 +09:00
|
|
|
public function getRevoked(): bool
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
return $this->revoked;
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
public function setRevoked(bool $revoked): self
|
|
|
|
{
|
|
|
|
$this->revoked = $revoked;
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2022-02-05 03:34:08 +09:00
|
|
|
public function getCreated(): DateTimeInterface
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
return $this->created;
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
public function setCreated(DateTimeInterface $created): self
|
|
|
|
{
|
|
|
|
$this->created = $created;
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
// }}} Autocode
|
|
|
|
|
|
|
|
/**
|
2022-02-05 03:34:08 +09:00
|
|
|
* Get the access token that the refresh token was originally associated with.
|
2022-01-25 21:17:32 +09:00
|
|
|
*/
|
2022-02-05 03:34:08 +09:00
|
|
|
public function getAccessToken(): AccessTokenEntityInterface
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
return (new Repository\AccessToken())->getAccessTokenEntity($this->getAccessTokenId());
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2022-02-05 03:34:08 +09:00
|
|
|
* Set the access token that the refresh token was associated with.
|
2022-01-25 21:17:32 +09:00
|
|
|
*/
|
2022-02-05 03:34:08 +09:00
|
|
|
public function setAccessToken(AccessTokenEntityInterface $accessToken)
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
$this->setAccessTokenId($accessToken->getIdentifier());
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
2022-02-05 03:34:08 +09:00
|
|
|
public function setIdentifier($identifier): self
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
return $this->setId($identifier);
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
2022-02-05 03:34:08 +09:00
|
|
|
public function getIdentifier(): string
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
return $this->getId();
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2022-02-05 03:34:08 +09:00
|
|
|
* Set the date time when the token expires.
|
2022-01-25 21:17:32 +09:00
|
|
|
*/
|
2022-02-05 03:34:08 +09:00
|
|
|
public function setExpiryDateTime(DateTimeImmutable $dateTime)
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
$this->setExpiry($dateTime);
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
2022-02-05 03:34:08 +09:00
|
|
|
public function getExpiryDateTime(): DateTimeImmutable
|
2022-01-25 21:17:32 +09:00
|
|
|
{
|
2022-02-05 03:34:08 +09:00
|
|
|
return DateTimeImmutable::createFromInterface($this->getExpiry());
|
2022-01-25 21:17:32 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
public static function schemaDef(): array
|
|
|
|
{
|
|
|
|
return [
|
|
|
|
'name' => 'oauth2_refresh_token',
|
|
|
|
'fields' => [
|
|
|
|
'id' => ['type' => 'char', 'length' => 64, 'not null' => true, 'description' => 'identifier for this token'],
|
|
|
|
'expiry' => ['type' => 'datetime', 'not null' => true, 'description' => 'when this token expires'],
|
|
|
|
'access_token_id' => ['type' => 'char', 'length' => 64, 'foreign key' => true, 'description' => 'Actor foreign key'],
|
|
|
|
'revoked' => ['type' => 'bool', 'not null' => true, 'foreign key' => true, 'description' => 'Whether this token is revoked'],
|
|
|
|
'created' => ['type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
|
|
|
|
],
|
|
|
|
'primary key' => ['id'],
|
|
|
|
];
|
|
|
|
}
|
|
|
|
}
|