Auth.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 4.3.0

matomo / app / core / Auth.php

matomo / app / core Last commit date

API 5 years ago Access 5 years ago Application 5 years ago Archive 5 years ago ArchiveProcessor 5 years ago Archiver 5 years ago AssetManager 5 years ago Auth 5 years ago Category 5 years ago CliMulti 5 years ago Columns 5 years ago Composer 5 years ago Concurrency 5 years ago Config 5 years ago Container 5 years ago CronArchive 5 years ago DataAccess 5 years ago DataFiles 5 years ago DataTable 5 years ago Db 5 years ago DeviceDetector 5 years ago Email 5 years ago Exception 5 years ago Http 5 years ago Intl 5 years ago Mail 5 years ago Measurable 5 years ago Menu 5 years ago Metrics 5 years ago Notification 5 years ago Period 5 years ago Plugin 5 years ago ProfessionalServices 5 years ago Report 5 years ago ReportRenderer 5 years ago Scheduler 5 years ago Segment 5 years ago Session 5 years ago Settings 5 years ago Tracker 5 years ago Translation 5 years ago UpdateCheck 5 years ago Updater 5 years ago Updates 5 years ago Validators 5 years ago View 5 years ago ViewDataTable 5 years ago Visualization 5 years ago Widget 5 years ago .htaccess 6 years ago Access.php 5 years ago Archive.php 5 years ago ArchiveProcessor.php 5 years ago AssetManager.php 5 years ago Auth.php 5 years ago AuthResult.php 5 years ago BaseFactory.php 5 years ago Cache.php 5 years ago CacheId.php 5 years ago CliMulti.php 5 years ago Common.php 5 years ago Config.php 5 years ago Console.php 5 years ago Context.php 5 years ago Cookie.php 5 years ago CronArchive.php 5 years ago DataArray.php 5 years ago DataTable.php 5 years ago Date.php 5 years ago Db.php 5 years ago DbHelper.php 5 years ago Development.php 5 years ago ErrorHandler.php 5 years ago EventDispatcher.php 5 years ago ExceptionHandler.php 5 years ago FileIntegrity.php 5 years ago Filechecks.php 5 years ago Filesystem.php 5 years ago FrontController.php 5 years ago Http.php 5 years ago IP.php 5 years ago Log.php 5 years ago LogDeleter.php 5 years ago Mail.php 5 years ago Metrics.php 5 years ago NoAccessException.php 5 years ago Nonce.php 5 years ago Notification.php 5 years ago NumberFormatter.php 5 years ago Option.php 5 years ago Period.php 5 years ago Piwik.php 5 years ago Plugin.php 5 years ago Profiler.php 5 years ago ProxyHeaders.php 5 years ago ProxyHttp.php 5 years ago QuickForm2.php 5 years ago RankingQuery.php 5 years ago ReportRenderer.php 5 years ago Segment.php 5 years ago Sequence.php 5 years ago Session.php 5 years ago SettingsPiwik.php 5 years ago SettingsServer.php 5 years ago Singleton.php 5 years ago Site.php 5 years ago SupportedBrowser.php 5 years ago TCPDF.php 5 years ago Theme.php 5 years ago Timer.php 5 years ago Tracker.php 5 years ago Twig.php 5 years ago Unzip.php 5 years ago UpdateCheck.php 5 years ago Updater.php 5 years ago UpdaterErrorException.php 5 years ago Updates.php 5 years ago Url.php 5 years ago UrlHelper.php 5 years ago Version.php 5 years ago View.php 5 years ago bootstrap.php 5 years ago dispatch.php 5 years ago testMinimumPhpVersion.php 5 years ago

Auth.php

123 lines

1	<?php
2	/**
3	* Matomo - free/libre analytics platform
4	*
5	* @link https://matomo.org
6	* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
7	*
8	*/
9
10	namespace Piwik;
11
12	use Exception;
13
14	/**
15	* Base interface for authentication implementations.
16	*
17	* Plugins that provide Auth implementations must provide a class that implements
18	* this interface. Additionally, an instance of that class must be set in the
19	* container with the 'Piwik\Auth' key during the
20	* [Request.initAuthenticationObject](https://developer.matomo.org/api-reference/events#requestinitauthenticationobject)
21	* event.
22	*
23	* Authentication implementations must support authentication via username and
24	* clear-text password and authentication via username and token auth. They can
25	* additionally support authentication via username and an MD5 hash of a password. If
26	* they don't support it, then [formless authentication](https://matomo.org/faq/how-to/faq_30/) will fail.
27	*
28	* Derived implementations should favor authenticating by password over authenticating
29	* by token auth. That is to say, if a token auth and a password are set, password
30	* authentication should be used.
31	*
32	* ### Examples
33	*
34	* How an Auth implementation will be used
35	*
36	* // authenticating by password
37	* $auth = StaticContainer::get('Piwik\Auth');
38	* $auth->setLogin('user');
39	* $auth->setPassword('password');
40	* $result = $auth->authenticate();
41	*
42	* // authenticating by token auth
43	* $auth = StaticContainer::get('Piwik\Auth');
44	* $auth->setLogin('user');
45	* $auth->setTokenAuth('...');
46	* $result = $auth->authenticate();
47	*
48	* @api
49	*/
50	interface Auth
51	{
52	/**
53	* Must return the Authentication module's name, e.g., `"Login"`.
54	*
55	* @return string
56	*/
57	public function getName();
58
59	/**
60	* Sets the authentication token to authenticate with.
61	*
62	* @param string $token_auth authentication token
63	*/
64	public function setTokenAuth($token_auth);
65
66	/**
67	* Returns the login of the user being authenticated.
68	*
69	* @return string
70	*/
71	public function getLogin();
72
73	/**
74	* Returns the secret used to calculate a user's token auth.
75	*
76	* A users token auth is generated using the user's login and this secret. The secret
77	* should be specific to the user and not easily guessed. Piwik's default Auth implementation
78	* uses an MD5 hash of a user's password.
79	*
80	* @return string
81	* @throws Exception if the token auth secret does not exist or cannot be obtained.
82	*/
83	public function getTokenAuthSecret();
84
85	/**
86	* Sets the login name to authenticate with.
87	*
88	* @param string $login The username.
89	*/
90	public function setLogin($login);
91
92	/**
93	* Sets the password to authenticate with.
94	*
95	* @param string $password Password (not hashed).
96	*/
97	public function setPassword($password);
98
99	/**
100	* Sets the hash of the password to authenticate with. The hash will be an MD5 hash.
101	*
102	* @param string $passwordHash The hashed password.
103	* @throws Exception if authentication by hashed password is not supported.
104	*/
105	public function setPasswordHash($passwordHash);
106
107	/**
108	* Authenticates a user using the login and password set using the setters. Can also authenticate
109	* via token auth if one is set and no password is set.
110	*
111	* Note: this method must successfully authenticate if the token auth supplied is a special hash
112	* of the user's real token auth. This is because the SessionInitializer class stores a
113	* hash of the token auth in the session cookie. You can calculate the token auth hash using the
114	* {@link \Piwik\Plugins\Login\SessionInitializer::getHashTokenAuth()} method.
115	*
116	* @return AuthResult
117	* @throws Exception if the Auth implementation has an invalid state (ie, no login
118	* was specified). Note: implementations are not required to throw
119	* exceptions for invalid state, but they are allowed to.
120	*/
121	public function authenticate();
122	}
123