diff options
Diffstat (limited to 'includes/auth/AuthenticationResponse.php')
| -rw-r--r-- | includes/auth/AuthenticationResponse.php | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/includes/auth/AuthenticationResponse.php b/includes/auth/AuthenticationResponse.php new file mode 100644 index 000000000000..db0182552d6b --- /dev/null +++ b/includes/auth/AuthenticationResponse.php @@ -0,0 +1,190 @@ +<?php +/** + * Authentication response value object + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + * @ingroup Auth + */ + +namespace MediaWiki\Auth; + +use Message; + +/** + * This is a value object to hold authentication response data + * @ingroup Auth + * @since 1.27 + */ +class AuthenticationResponse { + /** Indicates that the authentication succeeded. */ + const PASS = 'PASS'; + + /** Indicates that the authentication failed. */ + const FAIL = 'FAIL'; + + /** Indicates that third-party authentication succeeded but no user exists. + * Either treat this like a UI response or pass $this->createRequest to + * AuthManager::beginCreateAccount(). + */ + const RESTART = 'RESTART'; + + /** Indicates that the authentication provider does not handle this request. */ + const ABSTAIN = 'ABSTAIN'; + + /** Indicates that the authentication needs further user input of some sort. */ + const UI = 'UI'; + + /** Indicates that the authentication needs to be redirected to a third party to proceed. */ + const REDIRECT = 'REDIRECT'; + + /** @var string One of the constants above */ + public $status; + + /** @var string|null URL to redirect to for a REDIRECT response */ + public $redirectTarget = null; + + /** + * @var mixed Data for a REDIRECT response that a client might use to + * query the remote site via its API rather than by following $redirectTarget. + * Value must be something acceptable to ApiResult::addValue(). + */ + public $redirectApiData = null; + + /** + * @var AuthenticationRequest[] Needed AuthenticationRequests to continue + * after a UI or REDIRECT response + */ + public $neededRequests = []; + + /** @var Message|null I18n message to display in case of UI or FAIL */ + public $message = null; + + /** + * @var string|null Local user name from authentication. + * May be null if the authentication passed but no local user is known. + */ + public $username = null; + + /** + * @var AuthenticationRequest|null + * + * Returned with a PrimaryAuthenticationProvider login FAIL, this holds a + * request that should result in a PASS when passed to that provider's + * PrimaryAuthenticationProvider::beginPrimaryAccountCreation(). + * + * Returned with an AuthManager login FAIL or RESTART, this holds a request + * that may be passed to AuthManager::beginCreateAccount() after setting + * its ->returnToUrl property. It may also be passed to + * AuthManager::beginAuthentication() to preserve state. + */ + public $createRequest = null; + + /** + * @var AuthenticationRequest|null Returned with a PrimaryAuthenticationProvider + * login PASS with no username, this holds a request to pass to + * AuthManager::changeAuthenticationData() to link the account once the + * local user has been determined. + */ + public $linkRequest = null; + + /** + * @var AuthenticationRequest|null Returned with an AuthManager account + * creation PASS, this holds a request to pass to AuthManager::beginAuthentication() + * to immediately log into the created account. + */ + public $loginRequest = null; + + /** + * @param string|null $username Local username + * @return AuthenticationResponse + */ + public static function newPass( $username = null ) { + $ret = new AuthenticationResponse; + $ret->status = AuthenticationResponse::PASS; + $ret->username = $username; + return $ret; + } + + /** + * @param Message $msg + * @return AuthenticationResponse + */ + public static function newFail( Message $msg ) { + $ret = new AuthenticationResponse; + $ret->status = AuthenticationResponse::FAIL; + $ret->message = $msg; + return $ret; + } + + /** + * @param Message $msg + * @return AuthenticationResponse + */ + public static function newRestart( Message $msg ) { + $ret = new AuthenticationResponse; + $ret->status = AuthenticationResponse::RESTART; + $ret->message = $msg; + return $ret; + } + + /** + * @return AuthenticationResponse + */ + public static function newAbstain() { + $ret = new AuthenticationResponse; + $ret->status = AuthenticationResponse::ABSTAIN; + return $ret; + } + + /** + * @param AuthenticationRequest[] $reqs AuthenticationRequests needed to continue + * @param Message $msg + * @return AuthenticationResponse + */ + public static function newUI( array $reqs, Message $msg ) { + if ( !$reqs ) { + throw new \InvalidArgumentException( '$reqs may not be empty' ); + } + + $ret = new AuthenticationResponse; + $ret->status = AuthenticationResponse::UI; + $ret->neededRequests = $reqs; + $ret->message = $msg; + return $ret; + } + + /** + * @param AuthenticationRequest[] $reqs AuthenticationRequests needed to continue + * @param string $redirectTarget URL + * @param mixed $redirectApiData Data suitable for adding to an ApiResult + * @return AuthenticationResponse + */ + public static function newRedirect( array $reqs, $redirectTarget, $redirectApiData = null ) { + if ( !$reqs ) { + throw new \InvalidArgumentException( '$reqs may not be empty' ); + } + + $ret = new AuthenticationResponse; + $ret->status = AuthenticationResponse::REDIRECT; + $ret->neededRequests = $reqs; + $ret->redirectTarget = $redirectTarget; + $ret->redirectApiData = $redirectApiData; + return $ret; + } + +} |