68 lines
2.2 KiB
PHP
68 lines
2.2 KiB
PHP
<?php
|
||
/************************************************************************
|
||
* This file is part of EspoCRM.
|
||
*
|
||
* EspoCRM – Open Source CRM application.
|
||
* Copyright (C) 2014-2025 EspoCRM, Inc.
|
||
* Website: https://www.espocrm.com
|
||
*
|
||
* 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
|
||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
*
|
||
* The interactive user interfaces in modified source and object code versions
|
||
* of this program must display Appropriate Legal Notices, as required under
|
||
* Section 5 of the GNU Affero General Public License version 3.
|
||
*
|
||
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
|
||
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
||
************************************************************************/
|
||
|
||
namespace Espo\Core\Authentication\AuthToken;
|
||
|
||
/**
|
||
* An auth token record.
|
||
*/
|
||
interface AuthToken
|
||
{
|
||
/**
|
||
* Get a token.
|
||
*/
|
||
public function getToken(): string;
|
||
|
||
/**
|
||
* Get a user ID.
|
||
*/
|
||
public function getUserId(): string;
|
||
|
||
/**
|
||
* Get a portal ID. If a token belongs to a specific portal.
|
||
*/
|
||
public function getPortalId(): ?string;
|
||
|
||
/**
|
||
* Get a token secret. Secret is used as an additional security check.
|
||
*/
|
||
public function getSecret(): ?string;
|
||
|
||
/**
|
||
* Whether a token is active.
|
||
*/
|
||
public function isActive(): bool;
|
||
|
||
/**
|
||
* Get a password hash. If a password hash is not stored in token, then return NULL.
|
||
* If you store auth tokens remotely it's reasonable to avoid hashes being sent.
|
||
*/
|
||
public function getHash(): ?string;
|
||
}
|