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\Language\RawMessage;
  25 use MediaWiki\MainConfigNames;
  26 use MediaWiki\MediaWikiServices;
  27 use MediaWiki\Password\PasswordFactory;
  28
  29 /**
  30  * This represents the intention to set a temporary password for the user.
  31  * @stable to extend
  32  * @ingroup Auth
  33  * @since 1.27
  34  */
  35 class TemporaryPasswordAuthenticationRequest extends AuthenticationRequest {
  36         /** @var string|null Temporary password */
  37         public $password;
  38
  39         /** @var bool Email password to the user. */
  40         public $mailpassword = false;
  41
  42         /** @var string Username or IP address of the caller */
  43         public $caller;
  44
  45         /**
  46          * @inheritDoc
  47          * @stable to override
  48          */
  49         public function getFieldInfo() {
  50                 return [
  51                         'mailpassword' => [
  52                                 'type' => 'checkbox',
  53                                 'label' => wfMessage( 'createaccountmail' ),
  54                                 'help' => wfMessage( 'createaccountmail-help' ),
  55                         ],
  56                 ];
  57         }
  58
  59         /**
  60          * @stable to call
  61          * @param string|null $password
  62          */
  63         public function __construct( $password = null ) {
  64                 $this->password = $password;
  65                 if ( $password ) {
  66                         $this->mailpassword = true;
  67                 }
  68         }
  69
  70         /**
  71          * Return an instance with a new, random password
  72          * @return TemporaryPasswordAuthenticationRequest
  73          */
  74         public static function newRandom() {
  75                 $config = MediaWikiServices::getInstance()->getMainConfig();
  76
  77                 // get the min password length
  78                 $minLength = 0;
  79                 $policy = $config->get( MainConfigNames::PasswordPolicy );
  80                 foreach ( $policy['policies'] as $p ) {
  81                         foreach ( [ 'MinimalPasswordLength', 'MinimumPasswordLengthToLogin' ] as $check ) {
  82                                 $minLength = max( $minLength, $p[$check]['value'] ?? $p[$check] ?? 0 );
  83                         }
  84                 }
  85
  86                 $password = PasswordFactory::generateRandomPasswordString( $minLength );
  87
  88                 return new self( $password );
  89         }
  90
  91         /**
  92          * Return an instance with an invalid password
  93          * @return TemporaryPasswordAuthenticationRequest
  94          */
  95         public static function newInvalid() {
  96                 return new self( null );
  97         }
  98
  99         /**
 100          * @inheritDoc
 101          * @stable to override
 102          */
 103         public function describeCredentials() {
 104                 return [
 105                         'provider' => wfMessage( 'authmanager-provider-temporarypassword' ),
 106                         'account' => new RawMessage( '$1', [ $this->username ] ),
 107                 ] + parent::describeCredentials();
 108         }
 109
 110 }