Gecko [ dp-client.com ]

Name	Size	Permission
API	[ DIR ]	drwxr-xr-x
Access	[ DIR ]	drwxr-xr-x
Application	[ DIR ]	drwxr-xr-x
Archive	[ DIR ]	drwxr-xr-x
ArchiveProcessor	[ DIR ]	drwxr-xr-x
Archiver	[ DIR ]	drwxr-xr-x
AssetManager	[ DIR ]	drwxr-xr-x
Auth	[ DIR ]	drwxr-xr-x
Category	[ DIR ]	drwxr-xr-x
Changes	[ DIR ]	drwxr-xr-x
CliMulti	[ DIR ]	drwxr-xr-x
Columns	[ DIR ]	drwxr-xr-x
Concurrency	[ DIR ]	drwxr-xr-x
Config	[ DIR ]	drwxr-xr-x
Container	[ DIR ]	drwxr-xr-x
CronArchive	[ DIR ]	drwxr-xr-x
DataAccess	[ DIR ]	drwxr-xr-x
DataFiles	[ DIR ]	drwxr-xr-x
DataTable	[ DIR ]	drwxr-xr-x
Db	[ DIR ]	drwxr-xr-x
DeviceDetector	[ DIR ]	drwxr-xr-x
Email	[ DIR ]	drwxr-xr-x
Exception	[ DIR ]	drwxr-xr-x
Http	[ DIR ]	drwxr-xr-x
Intl	[ DIR ]	drwxr-xr-x
Mail	[ DIR ]	drwxr-xr-x
Measurable	[ DIR ]	drwxr-xr-x
Menu	[ DIR ]	drwxr-xr-x
Metrics	[ DIR ]	drwxr-xr-x
Notification	[ DIR ]	drwxr-xr-x
Period	[ DIR ]	drwxr-xr-x
Plugin	[ DIR ]	drwxr-xr-x
ProfessionalServices	[ DIR ]	drwxr-xr-x
Report	[ DIR ]	drwxr-xr-x
ReportRenderer	[ DIR ]	drwxr-xr-x
Scheduler	[ DIR ]	drwxr-xr-x
Segment	[ DIR ]	drwxr-xr-x
Session	[ DIR ]	drwxr-xr-x
Settings	[ DIR ]	drwxr-xr-x
Tracker	[ DIR ]	drwxr-xr-x
Translation	[ DIR ]	drwxr-xr-x
UpdateCheck	[ DIR ]	drwxr-xr-x
Updater	[ DIR ]	drwxr-xr-x
Updates	[ DIR ]	drwxr-xr-x
Validators	[ DIR ]	drwxr-xr-x
View	[ DIR ]	drwxr-xr-x
ViewDataTable	[ DIR ]	drwxr-xr-x
Visualization	[ DIR ]	drwxr-xr-x
Widget	[ DIR ]	drwxr-xr-x
.htaccess	545 B	-rw-r--r--
Access.php	24.89 KB	-rw-r--r--
Archive.php	35.4 KB	-rw-r--r--
ArchiveProcessor.php	26.97 KB	-rw-r--r--
AssetManager.php	15.48 KB	-rw-r--r--
Auth.php	4.03 KB	-rw-r--r--
AuthResult.php	2.13 KB	-rw-r--r--
BaseFactory.php	1.77 KB	-rw-r--r--
Cache.php	3.51 KB	-rw-r--r--
CacheId.php	2.53 KB	-rw-r--r--
CliMulti.php	14.98 KB	-rw-r--r--
Common.php	39.79 KB	-rw-r--r--
Config.php	14.69 KB	-rw-r--r--
Console.php	10.09 KB	-rw-r--r--
Context.php	3.42 KB	-rw-r--r--
Cookie.php	15.12 KB	-rw-r--r--
CronArchive.php	50.69 KB	-rw-r--r--
DataArray.php	17.97 KB	-rw-r--r--
DataTable.php	69.61 KB	-rw-r--r--
Date.php	35.04 KB	-rw-r--r--
Db.php	29.43 KB	-rw-r--r--
DbHelper.php	10.84 KB	-rw-r--r--
Development.php	6.67 KB	-rw-r--r--
ErrorHandler.php	7.55 KB	-rw-r--r--
EventDispatcher.php	6.79 KB	-rw-r--r--
ExceptionHandler.php	7.06 KB	-rw-r--r--
FileIntegrity.php	15.8 KB	-rw-r--r--
Filechecks.php	8.79 KB	-rw-r--r--
Filesystem.php	18.74 KB	-rw-r--r--
FrontController.php	29.31 KB	-rw-r--r--
Http.php	44.42 KB	-rw-r--r--
IP.php	5.08 KB	-rw-r--r--
Log.php	8.14 KB	-rw-r--r--
LogDeleter.php	3.81 KB	-rw-r--r--
Mail.php	9.32 KB	-rw-r--r--
Metrics.php	20.76 KB	-rw-r--r--
NoAccessException.php	398 B	-rw-r--r--
Nonce.php	8.25 KB	-rw-r--r--
Notification.php	5.72 KB	-rw-r--r--
NumberFormatter.php	10 KB	-rw-r--r--
Option.php	8.25 KB	-rw-r--r--
Period.php	13.52 KB	-rw-r--r--
Piwik.php	27.95 KB	-rw-r--r--
Plugin.php	21.52 KB	-rw-r--r--
Profiler.php	13.32 KB	-rw-r--r--
ProxyHeaders.php	2.16 KB	-rw-r--r--
ProxyHttp.php	11.94 KB	-rw-r--r--
QuickForm2.php	3.94 KB	-rw-r--r--
RankingQuery.php	13.06 KB	-rw-r--r--
ReportRenderer.php	8.59 KB	-rw-r--r--
Segment.php	24.24 KB	-rw-r--r--
Sequence.php	3.11 KB	-rw-r--r--
Session.php	8.04 KB	-rw-r--r--
SettingsPiwik.php	18.07 KB	-rw-r--r--
SettingsServer.php	7.58 KB	-rw-r--r--
Singleton.php	1.46 KB	-rw-r--r--
Site.php	17.86 KB	-rw-r--r--
SiteContentDetector.php	14.22 KB	-rw-r--r--
SupportedBrowser.php	2.25 KB	-rw-r--r--
TCPDF.php	1.87 KB	-rw-r--r--
Theme.php	4.93 KB	-rw-r--r--
Timer.php	2.57 KB	-rw-r--r--
Tracker.php	11.79 KB	-rw-r--r--
Twig.php	19.74 KB	-rw-r--r--
Unzip.php	1.28 KB	-rw-r--r--
UpdateCheck.php	3.34 KB	-rw-r--r--
Updater.php	25.08 KB	-rw-r--r--
UpdaterErrorException.php	304 B	-rw-r--r--
Updates.php	3.86 KB	-rw-r--r--
Url.php	25.67 KB	-rw-r--r--
UrlHelper.php	11.24 KB	-rw-r--r--
Version.php	806 B	-rw-r--r--
View.php	18.2 KB	-rw-r--r--
bootstrap.php	2.03 KB	-rw-r--r--
dispatch.php	928 B	-rw-r--r--
testMinimumPhpVersion.php	10.82 KB	-rw-r--r--

Name

Size

Permission

Action

API

[ DIR ]

drwxr-xr-x

Access

[ DIR ]

drwxr-xr-x

Application

[ DIR ]

drwxr-xr-x

Code Editor : Auth.php

<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */

namespace Piwik;

use Exception;

/**
 * Base interface for authentication implementations.
 *
 * Plugins that provide Auth implementations must provide a class that implements
 * this interface. Additionally, an instance of that class must be set in the
 * container with the 'Piwik\Auth' key during the
 * [Request.initAuthenticationObject](https://developer.matomo.org/api-reference/events#requestinitauthenticationobject)
 * event.
 *
 * Authentication implementations must support authentication via username and
 * clear-text password and authentication via username and token auth. They can
 * additionally support authentication via username and an MD5 hash of a password. If
 * they don't support it, then [formless authentication](https://matomo.org/faq/how-to/faq_30/) will fail.
 *
 * Derived implementations should favor authenticating by password over authenticating
 * by token auth. That is to say, if a token auth and a password are set, password
 * authentication should be used.
 *
 * ### Examples
 *
 * **How an Auth implementation will be used**
 *
 *     // authenticating by password
 *     $auth = StaticContainer::get('Piwik\Auth');
 *     $auth->setLogin('user');
 *     $auth->setPassword('password');
 *     $result = $auth->authenticate();
 *
 *     // authenticating by token auth
 *     $auth = StaticContainer::get('Piwik\Auth');
 *     $auth->setLogin('user');
 *     $auth->setTokenAuth('...');
 *     $result = $auth->authenticate();
 *
 * @api
 */
interface Auth
{
    /**
     * Must return the Authentication module's name, e.g., `"Login"`.
     *
     * @return string
     */
    public function getName();

/**
     * Sets the authentication token to authenticate with.
     *
     * @param string $token_auth authentication token
     */
    public function setTokenAuth($token_auth);

/**
     * Returns the login of the user being authenticated.
     *
     * @return string
     */
    public function getLogin();

/**
     * Returns the secret used to calculate a user's token auth.
     *
     * A users token auth is generated using the user's login and this secret. The secret
     * should be specific to the user and not easily guessed. Piwik's default Auth implementation
     * uses an MD5 hash of a user's password.
     *
     * @return string
     * @throws Exception if the token auth secret does not exist or cannot be obtained.
     */
    public function getTokenAuthSecret();

/**
     * Sets the login name to authenticate with.
     *
     * @param string $login The username.
     */
    public function setLogin($login);

/**
     * Sets the password to authenticate with.
     *
     * @param string $password Password (not hashed).
     */
    public function setPassword($password);

/**
     * Sets the hash of the password to authenticate with. The hash will be an MD5 hash.
     *
     * @param string $passwordHash The hashed password.
     * @throws Exception if authentication by hashed password is not supported.
     */
    public function setPasswordHash($passwordHash);

/**
     * Authenticates a user using the login and password set using the setters. Can also authenticate
     * via token auth if one is set and no password is set.
     *
     * Note: this method must successfully authenticate if the token auth supplied is a special hash
     * of the user's real token auth. This is because the SessionInitializer class stores a
     * hash of the token auth in the session cookie. You can calculate the token auth hash using the
     * {@link \Piwik\Plugins\Login\SessionInitializer::getHashTokenAuth()} method.
     *
     * @return AuthResult
     * @throws Exception if the Auth implementation has an invalid state (ie, no login
     *                   was specified). Note: implementations are not **required** to throw
     *                   exceptions for invalid state, but they are allowed to.
     */
    public function authenticate();
}

${this.title}

Code Editor : Auth.php