-
Notifications
You must be signed in to change notification settings - Fork 14
/
CentralAuthUtils.php
280 lines (242 loc) · 8.11 KB
/
CentralAuthUtils.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<?php
use MediaWiki\Auth\AuthManager;
use MediaWiki\Session\Session;
use MediaWiki\Session\SessionManager;
use MediaWiki\MediaWikiServices;
class CentralAuthUtils {
/** @var BagOStuff|null Session cache */
private static $sessionCache = null;
public static function isReadOnly() {
return ( self::getReadOnlyReason() !== false );
}
public static function getReadOnlyReason() {
global $wgCentralAuthDatabase;
if ( wfReadOnly() ) {
return wfReadOnlyReason();
}
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
$lb = $lbFactory->getMainLB( $wgCentralAuthDatabase );
$reason = $lb->getReadOnlyReason( $wgCentralAuthDatabase );
if ( $reason !== false ) {
return $reason;
}
return false;
}
/**
* Wait for the CentralAuth DB slaves to catch up
*/
public static function waitForSlaves() {
global $wgCentralAuthDatabase;
wfWaitForSlaves( false, $wgCentralAuthDatabase );
}
/**
* Gets a master (read/write) database connection to the CentralAuth database
*
* @return \Wikimedia\Rdbms\IDatabase
* @throws CentralAuthReadOnlyError
*/
public static function getCentralDB() {
global $wgCentralAuthDatabase, $wgCentralAuthReadOnly;
if ( $wgCentralAuthReadOnly ) {
throw new CentralAuthReadOnlyError();
}
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
return $lbFactory->getMainLB( $wgCentralAuthDatabase )->getConnectionRef( DB_MASTER, [],
$wgCentralAuthDatabase );
}
/**
* Gets a slave (readonly) database connection to the CentralAuth database
*
* @return \Wikimedia\Rdbms\IDatabase
*/
public static function getCentralSlaveDB() {
global $wgCentralAuthDatabase;
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
return $lbFactory->getMainLB( $wgCentralAuthDatabase )->getConnectionRef(
DB_REPLICA, 'centralauth', $wgCentralAuthDatabase );
}
/**
* @param WebRequest|null $request
*/
public static function setP3P( WebRequest $request = null ) {
if ( !$request ) {
$request = RequestContext::getMain()->getRequest();
}
$response = $request->response();
$sent = is_callable( [ $response, 'headersSent' ] )
? $response->headersSent()
: headers_sent();
if ( !$sent && $response->getHeader( 'P3P' ) === null ) {
// IE requires that a P3P header be provided for the cookies to be
// visible to the auto-login check.
global $wgCentralAuthCookiesP3P;
if ( $wgCentralAuthCookiesP3P === true ) {
// Note this policy is not valid: it has no valid tokens, while
// a valid policy would contain an "access" token and at least
// one statement, which would contain either the NID token or
// at least one "purpose" token, one "recipient" token, and one
// "retention" token.
$url = Title::makeTitle( NS_SPECIAL, 'CentralAutoLogin/P3P' )->getCanonicalURL();
$response->header( "P3P: CP=\"This is not a P3P policy! See $url for more info.\"" );
} elseif ( $wgCentralAuthCookiesP3P ) {
$response->header( "P3P: $wgCentralAuthCookiesP3P" );
}
}
}
/**
* @return string
*/
public static function memcKey( /*...*/ ) {
global $wgCentralAuthDatabase;
$args = func_get_args();
return $wgCentralAuthDatabase . ':' . implode( ':', $args );
}
/**
* @return BagOStuff
*/
public static function getSessionCache() {
global $wgSessionsInObjectCache, $wgSessionCacheType;
if ( !self::$sessionCache ) {
$cache = $wgSessionsInObjectCache
? ObjectCache::getInstance( $wgSessionCacheType )
: ObjectCache::getMainStashInstance();
self::$sessionCache = $cache instanceof CachedBagOStuff
? $cache : new CachedBagOStuff( $cache );
}
return self::$sessionCache;
}
/**
* Auto-create a user
* @param User $user
* @return StatusValue
*/
public static function autoCreateUser( User $user ) {
global $wgDisableAuthManager;
// Ignore warnings about master connections/writes...hard to avoid here
Profiler::instance()->getTransactionProfiler()->resetExpectations();
if ( !$wgDisableAuthManager ) {
$authManager = AuthManager::singleton();
$source = CentralAuthPrimaryAuthenticationProvider::class;
if ( !$authManager->getAuthenticationProvider( $source ) ) {
$source = AuthManager::AUTOCREATE_SOURCE_SESSION;
}
$sv = $authManager->autoCreateUser( $user, $source, false );
} else {
$sv = StatusValue::newGood();
if ( !SessionManager::autoCreateUser( $user ) ) {
$sv->fatal( new RawMessage( 'auto-creation via SessionManager failed' ) );
}
}
\MediaWiki\Logger\LoggerFactory::getInstance( 'authevents' )->info( 'Autocreation attempt', [
'event' => 'autocreate',
'status' => $sv,
] );
return $sv;
}
/**
* Get the central session data
* @param Session|null $session
* @return array
*/
public static function getCentralSession( $session = null ) {
if ( !$session ) {
$session = SessionManager::getGlobalSession();
}
$id = $session->get( 'CentralAuth::centralSessionId' );
if ( $id !== null ) {
return self::getCentralSessionById( $id );
} else {
return [];
}
}
/**
* Get the central session data
* @param string $id
* @return array
*/
public static function getCentralSessionById( $id ) {
$key = self::memcKey( 'session', $id );
$stime = microtime( true );
$data = self::getSessionCache()->get( $key ) ?: [];
$real = microtime( true ) - $stime;
MediaWikiServices::getInstance()
->getStatsdDataFactory()->timing( 'centralauth.session.read', $real );
return $data;
}
/**
* Set data in the central session
* @param array $data
* @param bool|string $reset Reset the session ID. If a string, this is the new ID.
* @param Session|null $session
* @return string|null Session ID
*/
public static function setCentralSession( array $data, $reset = false, $session = null ) {
static $keepKeys = [ 'user' => true, 'token' => true, 'expiry' => true ];
if ( $session === null ) {
$session = SessionManager::getGlobalSession();
}
$id = $session->get( 'CentralAuth::centralSessionId' );
if ( $reset || $id === null ) {
$id = is_string( $reset ) ? $reset : MWCryptRand::generateHex( 32 );
}
$data['sessionId'] = $id;
$key = self::memcKey( 'session', $id );
// Copy certain keys from the existing session, if any (T124821)
$existing = self::getSessionCache()->get( $key );
if ( is_array( $existing ) ) {
$data += array_intersect_key( $existing, $keepKeys );
}
if ( $data !== $existing || !isset( $data['expiry'] ) || $data['expiry'] < time() + 32100 ) {
$data['expiry'] = time() + 86400;
$stime = microtime( true );
self::getSessionCache()->set( $key, $data, 86400 );
$real = microtime( true ) - $stime;
MediaWikiServices::getInstance()
->getStatsdDataFactory()->timing( 'centralauth.session.write', $real );
}
if ( $session ) {
$session->set( 'CentralAuth::centralSessionId', $id );
}
return $id;
}
/**
* Delete the central session data
* @param Session|null $session
*/
public static function deleteCentralSession( $session = null ) {
if ( !$session ) {
$session = SessionManager::getGlobalSession();
}
$id = $session->get( 'CentralAuth::centralSessionId' );
if ( $id !== null ) {
$key = self::memcKey( 'session', $id );
$stime = microtime( true );
self::getSessionCache()->delete( $key );
$real = microtime( true ) - $stime;
MediaWikiServices::getInstance()
->getStatsdDataFactory()->timing( "centralauth.session.delete", $real );
}
}
/**
* Sets up jobs to create and attach a local account for the given user on every wiki listed in
* $wgCentralAuthAutoCreateWikis.
* @param CentralAuthUser $centralUser
*/
public static function scheduleCreationJobs( CentralAuthUser $centralUser ) {
global $wgCentralAuthAutoCreateWikis;
$name = $centralUser->getName();
$thisWiki = wfWikiID();
$session = RequestContext::getMain()->exportSession();
foreach ( $wgCentralAuthAutoCreateWikis as $wiki ) {
if ( $wiki === $thisWiki ) {
continue;
}
$job = Job::factory(
'CentralAuthCreateLocalAccountJob',
Title::makeTitleSafe( NS_USER, $name ),
[ 'name' => $name, 'from' => $thisWiki, 'session' => $session ]
);
JobQueueGroup::singleton( $wiki )->lazyPush( $job );
}
}
}