includes/auth/TemporaryPasswordAuthenticationRequest.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Auth
  20  */
  21
  22 namespace MediaWiki\Auth;
  23
  24 use MediaWiki\MediaWikiServices;
  25
  26 /**
  27  * This represents the intention to set a temporary password for the user.
  28  * @ingroup Auth
  29  * @since 1.27
  30  */
  31 class TemporaryPasswordAuthenticationRequest extends AuthenticationRequest {
  32         /** @var string|null Temporary password */
  33         public $password;
  34
  35         /** @var bool Email password to the user. */
  36         public $mailpassword = false;
  37
  38         /** @var string Username or IP address of the caller */
  39         public $caller;
  40
  41         public function getFieldInfo() {
  42                 return [
  43                         'mailpassword' => [
  44                                 'type' => 'checkbox',
  45                                 'label' => wfMessage( 'createaccountmail' ),
  46                                 'help' => wfMessage( 'createaccountmail-help' ),
  47                         ],
  48                 ];
  49         }
  50
  51         /**
  52          * @param string|null $password
  53          */
  54         public function __construct( $password = null ) {
  55                 $this->password = $password;
  56                 if ( $password ) {
  57                         $this->mailpassword = true;
  58                 }
  59         }
  60
  61         /**
  62          * Return an instance with a new, random password
  63          * @return TemporaryPasswordAuthenticationRequest
  64          */
  65         public static function newRandom() {
  66                 $config = MediaWikiServices::getInstance()->getMainConfig();
  67
  68                 // get the min password length
  69                 $minLength = $config->get( 'MinimalPasswordLength' );
  70                 $policy = $config->get( 'PasswordPolicy' );
  71                 foreach ( $policy['policies'] as $p ) {
  72                         foreach ( [ 'MinimalPasswordLength', 'MinimumPasswordLengthToLogin' ] as $check ) {
  73                                 $minLength = max( $minLength, $p[$check]['value'] ?? $p[$check] ?? 0 );
  74                         }
  75                 }
  76
  77                 $password = \PasswordFactory::generateRandomPasswordString( $minLength );
  78
  79                 return new self( $password );
  80         }
  81
  82         /**
  83          * Return an instance with an invalid password
  84          * @return TemporaryPasswordAuthenticationRequest
  85          */
  86         public static function newInvalid() {
  87                 $request = new self( null );
  88                 return $request;
  89         }
  90
  91         public function describeCredentials() {
  92                 return [
  93                         'provider' => wfMessage( 'authmanager-provider-temporarypassword' ),
  94                         'account' => new \RawMessage( '$1', [ $this->username ] ),
  95                 ] + parent::describeCredentials();
  96         }
  97
  98 }