MediaWiki  1.28.0
BotPasswordSessionProvider.php
Go to the documentation of this file.
1 <?php
25 
27 use User;
29 
35 
42  public function __construct( array $params = [] ) {
43  if ( !isset( $params['sessionCookieName'] ) ) {
44  $params['sessionCookieName'] = '_BPsession';
45  }
46  parent::__construct( $params );
47 
48  if ( !isset( $params['priority'] ) ) {
49  throw new \InvalidArgumentException( __METHOD__ . ': priority must be specified' );
50  }
51  if ( $params['priority'] < SessionInfo::MIN_PRIORITY ||
53  ) {
54  throw new \InvalidArgumentException( __METHOD__ . ': Invalid priority' );
55  }
56 
57  $this->priority = $params['priority'];
58  }
59 
60  public function provideSessionInfo( WebRequest $request ) {
61  // Only relevant for the API
62  if ( !defined( 'MW_API' ) ) {
63  return null;
64  }
65 
66  // Enabled?
67  if ( !$this->config->get( 'EnableBotPasswords' ) ) {
68  return null;
69  }
70 
71  // Have a session ID?
72  $id = $this->getSessionIdFromCookie( $request );
73  if ( $id === null ) {
74  return null;
75  }
76 
77  return new SessionInfo( $this->priority, [
78  'provider' => $this,
79  'id' => $id,
80  'persisted' => true
81  ] );
82  }
83 
84  public function newSessionInfo( $id = null ) {
85  // We don't activate by default
86  return null;
87  }
88 
97  $id = $this->getSessionIdFromCookie( $request );
99  'provider' => $this,
100  'id' => $id,
101  'userInfo' => UserInfo::newFromUser( $user, true ),
102  'persisted' => $id !== null,
103  'metadata' => [
104  'centralId' => $bp->getUserCentralId(),
105  'appId' => $bp->getAppId(),
106  'token' => $bp->getToken(),
107  'rights' => \MWGrants::getGrantRights( $bp->getGrants() ),
108  ],
109  ] );
110  $session = $this->getManager()->getSessionFromInfo( $info, $request );
111  $session->persist();
112  return $session;
113  }
114 
115  public function refreshSessionInfo( SessionInfo $info, WebRequest $request, &$metadata ) {
116  $missingKeys = array_diff(
117  [ 'centralId', 'appId', 'token' ],
118  array_keys( $metadata )
119  );
120  if ( $missingKeys ) {
121  $this->logger->info( 'Session "{session}": Missing metadata: {missing}', [
122  'session' => $info,
123  'missing' => implode( ', ', $missingKeys ),
124  ] );
125  return false;
126  }
127 
128  $bp = BotPassword::newFromCentralId( $metadata['centralId'], $metadata['appId'] );
129  if ( !$bp ) {
130  $this->logger->info(
131  'Session "{session}": No BotPassword for {centralId} {appId}',
132  [
133  'session' => $info,
134  'centralId' => $metadata['centralId'],
135  'appId' => $metadata['appId'],
136  ] );
137  return false;
138  }
139 
140  if ( !hash_equals( $metadata['token'], $bp->getToken() ) ) {
141  $this->logger->info( 'Session "{session}": BotPassword token check failed', [
142  'session' => $info,
143  'centralId' => $metadata['centralId'],
144  'appId' => $metadata['appId'],
145  ] );
146  return false;
147  }
148 
149  $status = $bp->getRestrictions()->check( $request );
150  if ( !$status->isOK() ) {
151  $this->logger->info(
152  'Session "{session}": Restrictions check failed',
153  [
154  'session' => $info,
155  'restrictions' => $status->getValue(),
156  'centralId' => $metadata['centralId'],
157  'appId' => $metadata['appId'],
158  ] );
159  return false;
160  }
161 
162  // Update saved rights
163  $metadata['rights'] = \MWGrants::getGrantRights( $bp->getGrants() );
164 
165  return true;
166  }
167 
171  public function preventSessionsForUser( $username ) {
173  }
174 
175  public function getAllowedUserRights( SessionBackend $backend ) {
176  if ( $backend->getProvider() !== $this ) {
177  throw new \InvalidArgumentException( 'Backend\'s provider isn\'t $this' );
178  }
179  $data = $backend->getProviderMetadata();
180  if ( $data && isset( $data['rights'] ) && is_array( $data['rights'] ) ) {
181  return $data['rights'];
182  }
183 
184  // Should never happen
185  $this->logger->debug( __METHOD__ . ': No provider metadata, returning no rights allowed' );
186  return [];
187  }
188 }
const MIN_PRIORITY
Minimum allowed priority.
Definition: SessionInfo.php:36
This is the actual workhorse for Session.
the array() calling protocol came about after MediaWiki 1.4rc1.
getProviderMetadata()
Fetch provider metadata.
getProvider()
Fetch the SessionProvider for this session.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getGrantRights($grants)
Fetch the rights allowed by a set of grants.
Definition: MWGrants.php:106
getUserCentralId()
Get the central user ID.
newSessionForRequest(User $user, BotPassword $bp, WebRequest $request)
Create a new session for a request.
static newFromUser(User $user, $verified=false)
Create an instance from an existing User object.
Definition: UserInfo.php:116
getToken()
Get the token.
static newFromCentralId($centralId, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
static removeAllPasswordsForUser($username)
Remove all passwords for a user, by name.
getAppId()
Get the app ID.
getManager()
Get the session manager.
An ImmutableSessionProviderWithCookie doesn't persist the user, but optionally can use a cookie to su...
$params
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
const MAX_PRIORITY
Maximum allowed priority.
Definition: SessionInfo.php:39
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:802
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
refreshSessionInfo(SessionInfo $info, WebRequest $request, &$metadata)
getSessionIdFromCookie(WebRequest $request)
Get the session ID from the cookie, if any.
getGrants()
Get the grants.
Value object returned by SessionProvider.
Definition: SessionInfo.php:34