API
2 weeks ago
Access
2 weeks ago
Application
2 weeks ago
Archive
2 weeks ago
ArchiveProcessor
2 weeks ago
Archiver
2 years ago
AssetManager
2 weeks ago
Auth
2 weeks ago
Category
2 weeks ago
Changes
2 months ago
CliMulti
2 weeks ago
Columns
2 weeks ago
Concurrency
2 weeks ago
Config
2 weeks ago
Container
2 months ago
CronArchive
2 weeks ago
DataAccess
2 weeks ago
DataFiles
2 years ago
DataTable
2 weeks ago
Db
2 weeks ago
DeviceDetector
1 year ago
Email
2 years ago
Exception
5 months ago
Http
2 weeks ago
Intl
4 months ago
Log
2 years ago
Mail
1 year ago
Measurable
8 months ago
Menu
2 weeks ago
Metrics
2 weeks ago
Notification
8 months ago
Period
2 weeks ago
Plugin
2 weeks ago
Policy
2 months ago
ProfessionalServices
1 year ago
Report
1 year ago
ReportRenderer
2 weeks ago
Request
2 weeks ago
Scheduler
2 weeks ago
Segment
2 weeks ago
Session
1 month ago
Settings
2 weeks ago
Tracker
2 weeks ago
Translation
2 months ago
Twig
1 year ago
UpdateCheck
4 months ago
Updater
2 weeks ago
Updates
1 month ago
Validators
1 year ago
View
2 months ago
ViewDataTable
2 weeks ago
Visualization
2 weeks ago
Widget
2 weeks ago
.htaccess
2 years ago
Access.php
2 weeks ago
Archive.php
2 months ago
ArchiveProcessor.php
2 weeks ago
AssetManager.php
2 weeks ago
Auth.php
8 months ago
AuthResult.php
8 months ago
BaseFactory.php
2 years ago
Cache.php
2 weeks ago
CacheId.php
5 months ago
CliMulti.php
2 weeks ago
Common.php
2 weeks ago
Config.php
2 weeks ago
Console.php
4 months ago
Context.php
2 years ago
Cookie.php
2 weeks ago
CronArchive.php
2 weeks ago
DI.php
4 months ago
DataArray.php
2 weeks ago
DataTable.php
2 weeks ago
Date.php
2 months ago
Db.php
2 months ago
DbHelper.php
2 weeks ago
Development.php
2 weeks ago
ErrorHandler.php
8 months ago
EventDispatcher.php
2 months ago
ExceptionHandler.php
5 months ago
FileIntegrity.php
2 weeks ago
Filechecks.php
1 year ago
Filesystem.php
2 weeks ago
FrontController.php
2 weeks ago
Http.php
2 weeks ago
IP.php
1 year ago
Log.php
4 months ago
LogDeleter.php
2 weeks ago
Mail.php
1 year ago
Metrics.php
2 months ago
NoAccessException.php
2 years ago
Nonce.php
8 months ago
Notification.php
2 months ago
NumberFormatter.php
2 weeks ago
Option.php
2 weeks ago
Period.php
2 weeks ago
Piwik.php
2 weeks ago
Plugin.php
2 months ago
Process.php
2 months ago
Profiler.php
2 weeks ago
ProxyHeaders.php
5 months ago
ProxyHttp.php
2 weeks ago
QuickForm2.php
4 months ago
RankingQuery.php
2 months ago
ReportRenderer.php
2 weeks ago
Request.php
2 months ago
Segment.php
2 weeks ago
Sequence.php
2 weeks ago
Session.php
1 month ago
SettingsPiwik.php
2 weeks ago
SettingsServer.php
2 weeks ago
Singleton.php
2 years ago
Site.php
2 months ago
SiteContentDetector.php
2 months ago
SupportedBrowser.php
2 years ago
TCPDF.php
1 year ago
Theme.php
2 weeks ago
Timer.php
2 weeks ago
Tracker.php
2 weeks ago
Twig.php
2 months ago
Unzip.php
1 year ago
UpdateCheck.php
2 months ago
Updater.php
2 weeks ago
UpdaterErrorException.php
2 years ago
Updates.php
2 weeks ago
Url.php
2 weeks ago
UrlHelper.php
2 months ago
Version.php
2 weeks ago
View.php
2 weeks ago
bootstrap.php
1 year ago
dispatch.php
2 years ago
testMinimumPhpVersion.php
8 months ago
Auth.php
120 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik; |
| 10 | |
| 11 | use Exception; |
| 12 | /** |
| 13 | * Base interface for authentication implementations. |
| 14 | * |
| 15 | * Plugins that provide Auth implementations must provide a class that implements |
| 16 | * this interface. Additionally, an instance of that class must be set in the |
| 17 | * container with the 'Piwik\Auth' key during the |
| 18 | * [Request.initAuthenticationObject](https://developer.matomo.org/api-reference/events#requestinitauthenticationobject) |
| 19 | * event. |
| 20 | * |
| 21 | * Authentication implementations must support authentication via username and |
| 22 | * clear-text password and authentication via username and token auth. They can |
| 23 | * additionally support authentication via username and an MD5 hash of a password. If |
| 24 | * they don't support it, then [formless authentication](https://matomo.org/faq/how-to/faq_30/) will fail. |
| 25 | * |
| 26 | * Derived implementations should favor authenticating by password over authenticating |
| 27 | * by token auth. That is to say, if a token auth and a password are set, password |
| 28 | * authentication should be used. |
| 29 | * |
| 30 | * ### Examples |
| 31 | * |
| 32 | * **How an Auth implementation will be used** |
| 33 | * |
| 34 | * // authenticating by password |
| 35 | * $auth = StaticContainer::get('Piwik\Auth'); |
| 36 | * $auth->setLogin('user'); |
| 37 | * $auth->setPassword('password'); |
| 38 | * $result = $auth->authenticate(); |
| 39 | * |
| 40 | * // authenticating by token auth |
| 41 | * $auth = StaticContainer::get('Piwik\Auth'); |
| 42 | * $auth->setLogin('user'); |
| 43 | * $auth->setTokenAuth('...'); |
| 44 | * $result = $auth->authenticate(); |
| 45 | * |
| 46 | * @api |
| 47 | */ |
| 48 | interface Auth |
| 49 | { |
| 50 | /** |
| 51 | * Must return the Authentication module's name, e.g., `"Login"`. |
| 52 | * |
| 53 | * @return ?string |
| 54 | */ |
| 55 | public function getName(); |
| 56 | /** |
| 57 | * Sets the authentication token to authenticate with. |
| 58 | * |
| 59 | * @param string|null $token_auth authentication token |
| 60 | */ |
| 61 | public function setTokenAuth( |
| 62 | #[\SensitiveParameter] |
| 63 | $token_auth); |
| 64 | /** |
| 65 | * Returns the login of the user being authenticated. |
| 66 | * |
| 67 | * @return ?string |
| 68 | */ |
| 69 | public function getLogin(); |
| 70 | /** |
| 71 | * Returns the secret used to calculate a user's token auth. |
| 72 | * |
| 73 | * A users token auth is generated using the user's login and this secret. The secret |
| 74 | * should be specific to the user and not easily guessed. Piwik's default Auth implementation |
| 75 | * uses an MD5 hash of a user's password. |
| 76 | * |
| 77 | * @return ?string |
| 78 | * @throws Exception if the token auth secret does not exist or cannot be obtained. |
| 79 | */ |
| 80 | public function getTokenAuthSecret(); |
| 81 | /** |
| 82 | * Sets the login name to authenticate with. |
| 83 | * |
| 84 | * @param string $login The username. |
| 85 | */ |
| 86 | public function setLogin($login); |
| 87 | /** |
| 88 | * Sets the password to authenticate with. |
| 89 | * |
| 90 | * @param string $password Password (not hashed). |
| 91 | */ |
| 92 | public function setPassword( |
| 93 | #[\SensitiveParameter] |
| 94 | $password); |
| 95 | /** |
| 96 | * Sets the hash of the password to authenticate with. The hash will be an MD5 hash. |
| 97 | * |
| 98 | * @param string $passwordHash The hashed password. |
| 99 | * @throws Exception if authentication by hashed password is not supported. |
| 100 | */ |
| 101 | public function setPasswordHash( |
| 102 | #[\SensitiveParameter] |
| 103 | $passwordHash); |
| 104 | /** |
| 105 | * Authenticates a user using the login and password set using the setters. Can also authenticate |
| 106 | * via token auth if one is set and no password is set. |
| 107 | * |
| 108 | * Note: this method must successfully authenticate if the token auth supplied is a special hash |
| 109 | * of the user's real token auth. This is because the SessionInitializer class stores a |
| 110 | * hash of the token auth in the session cookie. You can calculate the token auth hash using the |
| 111 | * {@link \Piwik\Plugins\Login\SessionInitializer::getHashTokenAuth()} method. |
| 112 | * |
| 113 | * @return AuthResult |
| 114 | * @throws Exception if the Auth implementation has an invalid state (ie, no login |
| 115 | * was specified). Note: implementations are not **required** to throw |
| 116 | * exceptions for invalid state, but they are allowed to. |
| 117 | */ |
| 118 | public function authenticate(); |
| 119 | } |
| 120 |