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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
|
<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\Auth\AuthenticationResponse;
class CheckUserHooks {
/**
* Hook function for RecentChange_save
* Saves user data into the cu_changes table
* Note that other extensions (like AbuseFilter) may call this function directly
* if they want to send data to CU without creating a recentchanges entry
* @param RecentChange $rc
* @return bool
*/
public static function updateCheckUserData( RecentChange $rc ) {
global $wgRequest;
/**
* RC_CATEGORIZE recent changes are generally triggered by other edits.
* Thus there is no reason to store checkuser data about them.
* @see https://phabricator.wikimedia.org/T125209
*/
if ( defined( 'RC_CATEGORIZE' ) && $rc->getAttribute( 'rc_type' ) == RC_CATEGORIZE ) {
return true;
}
/**
* RC_EXTERNAL recent changes are not triggered by actions on the local wiki.
* Thus there is no reason to store checkuser data about them.
* @see https://phabricator.wikimedia.org/T125664
*/
if ( defined( 'RC_EXTERNAL' ) && $rc->getAttribute( 'rc_type' ) == RC_EXTERNAL ) {
return true;
}
$attribs = $rc->getAttributes();
// Get IP
$ip = $wgRequest->getIP();
// Get XFF header
$xff = $wgRequest->getHeader( 'X-Forwarded-For' );
list( $xff_ip, $isSquidOnly ) = self::getClientIPfromXFF( $xff );
// Get agent
$agent = $wgRequest->getHeader( 'User-Agent' );
// Store the log action text for log events
// $rc_comment should just be the log_comment
// BC: check if log_type and log_action exists
// If not, then $rc_comment is the actiontext and comment
if ( isset( $attribs['rc_log_type'] ) && $attribs['rc_type'] == RC_LOG ) {
$target = Title::makeTitle( $attribs['rc_namespace'], $attribs['rc_title'] );
$context = RequestContext::newExtraneousContext( $target );
$formatter = LogFormatter::newFromRow( $rc->getAttributes() );
$formatter->setContext( $context );
$actionText = $formatter->getPlainActionText();
} else {
$actionText = '';
}
$dbw = wfGetDB( DB_MASTER );
$rcRow = [
'cuc_namespace' => $attribs['rc_namespace'],
'cuc_title' => $attribs['rc_title'],
'cuc_minor' => $attribs['rc_minor'],
'cuc_user' => $attribs['rc_user'],
'cuc_user_text' => $attribs['rc_user_text'],
'cuc_actiontext' => $actionText,
'cuc_comment' => $rc->getAttribute( 'rc_comment' ),
'cuc_this_oldid' => $attribs['rc_this_oldid'],
'cuc_last_oldid' => $attribs['rc_last_oldid'],
'cuc_type' => $attribs['rc_type'],
'cuc_timestamp' => $attribs['rc_timestamp'],
'cuc_ip' => IP::sanitizeIP( $ip ),
'cuc_ip_hex' => $ip ? IP::toHex( $ip ) : null,
'cuc_xff' => !$isSquidOnly ? $xff : '',
'cuc_xff_hex' => ( $xff_ip && !$isSquidOnly ) ? IP::toHex( $xff_ip ) : null,
'cuc_agent' => $agent
];
# On PG, MW unsets cur_id due to schema incompatibilites. So it may not be set!
if ( isset( $attribs['rc_cur_id'] ) ) {
$rcRow['cuc_page_id'] = $attribs['rc_cur_id'];
}
Hooks::run( 'CheckUserInsertForRecentChange', [ $rc, &$rcRow ] );
$dbw->insert( 'cu_changes', $rcRow, __METHOD__ );
return true;
}
/**
* Hook function to store password reset
* Saves user data into the cu_changes table
*
* @param User $user Sender
* @param string $ip
* @param User $account Receiver
* @return bool
*/
public static function updateCUPasswordResetData( User $user, $ip, $account ) {
global $wgRequest;
// Get XFF header
$xff = $wgRequest->getHeader( 'X-Forwarded-For' );
list( $xff_ip, $isSquidOnly ) = self::getClientIPfromXFF( $xff );
// Get agent
$agent = $wgRequest->getHeader( 'User-Agent' );
$dbw = wfGetDB( DB_MASTER );
$rcRow = [
'cuc_namespace' => NS_USER,
'cuc_title' => '',
'cuc_minor' => 0,
'cuc_user' => $user->getId(),
'cuc_user_text' => $user->getName(),
'cuc_actiontext' => wfMessage( 'checkuser-reset-action', $account->getName() )
->inContentLanguage()->text(),
'cuc_comment' => '',
'cuc_this_oldid' => 0,
'cuc_last_oldid' => 0,
'cuc_type' => RC_LOG,
'cuc_timestamp' => $dbw->timestamp( wfTimestampNow() ),
'cuc_ip' => IP::sanitizeIP( $ip ),
'cuc_ip_hex' => $ip ? IP::toHex( $ip ) : null,
'cuc_xff' => !$isSquidOnly ? $xff : '',
'cuc_xff_hex' => ( $xff_ip && !$isSquidOnly ) ? IP::toHex( $xff_ip ) : null,
'cuc_agent' => $agent
];
$dbw->insert( 'cu_changes', $rcRow, __METHOD__ );
return true;
}
/**
* Hook function to store email data.
*
* Saves user data into the cu_changes table.
* Uses a deferred update to save the data, because emails can be sent from code paths
* that don't open master connections.
*
* @param MailAddress $to
* @param MailAddress $from
* @param string $subject
* @param string $text
* @return bool
*/
public static function updateCUEmailData( $to, $from, $subject, $text ) {
global $wgSecretKey, $wgRequest, $wgCUPublicKey;
if ( !$wgSecretKey || $from->name == $to->name ) {
return true;
} elseif ( wfReadOnly() ) {
return true;
}
$userFrom = User::newFromName( $from->name );
$userTo = User::newFromName( $to->name );
$hash = md5( $userTo->getEmail() . $userTo->getId() . $wgSecretKey );
// Get IP
$ip = $wgRequest->getIP();
// Get XFF header
$xff = $wgRequest->getHeader( 'X-Forwarded-For' );
list( $xff_ip, $isSquidOnly ) = self::getClientIPfromXFF( $xff );
// Get agent
$agent = $wgRequest->getHeader( 'User-Agent' );
$dbr = wfGetDB( DB_REPLICA );
$rcRow = [
'cuc_namespace' => NS_USER,
'cuc_title' => '',
'cuc_minor' => 0,
'cuc_user' => $userFrom->getId(),
'cuc_user_text' => $userFrom->getName(),
'cuc_actiontext' =>
wfMessage( 'checkuser-email-action', $hash )->inContentLanguage()->text(),
'cuc_comment' => '',
'cuc_this_oldid' => 0,
'cuc_last_oldid' => 0,
'cuc_type' => RC_LOG,
'cuc_timestamp' => $dbr->timestamp( wfTimestampNow() ),
'cuc_ip' => IP::sanitizeIP( $ip ),
'cuc_ip_hex' => $ip ? IP::toHex( $ip ) : null,
'cuc_xff' => !$isSquidOnly ? $xff : '',
'cuc_xff_hex' => ( $xff_ip && !$isSquidOnly ) ? IP::toHex( $xff_ip ) : null,
'cuc_agent' => $agent
];
if ( trim( $wgCUPublicKey ) != '' ) {
$privateData = $userTo->getEmail() . ":" . $userTo->getId();
$encryptedData = new CheckUserEncryptedData( $privateData, $wgCUPublicKey );
$rcRow = array_merge( $rcRow, [ 'cuc_private' => serialize( $encryptedData ) ] );
}
$fname = __METHOD__;
DeferredUpdates::addCallableUpdate( function () use ( $rcRow, $fname ) {
$dbw = wfGetDB( DB_MASTER );
$dbw->insert( 'cu_changes', $rcRow, $fname );
} );
return true;
}
/**
* Hook function to store registration and autocreation data
* Saves user data into the cu_changes table
*
* @param User $user
* @param bool $autocreated
* @return true
*/
public static function onLocalUserCreated( User $user, $autocreated ) {
return self::logUserAccountCreation(
$user,
$autocreated ? 'checkuser-autocreate-action' : 'checkuser-create-action'
);
}
/**
* @param User $user
* @param string $actiontext
* @return bool
*/
protected static function logUserAccountCreation( User $user, $actiontext ) {
global $wgRequest;
// Get IP
$ip = $wgRequest->getIP();
// Get XFF header
$xff = $wgRequest->getHeader( 'X-Forwarded-For' );
list( $xff_ip, $isSquidOnly ) = self::getClientIPfromXFF( $xff );
// Get agent
$agent = $wgRequest->getHeader( 'User-Agent' );
$dbw = wfGetDB( DB_MASTER );
$rcRow = [
'cuc_page_id' => 0,
'cuc_namespace' => NS_USER,
'cuc_title' => '',
'cuc_minor' => 0,
'cuc_user' => $user->getId(),
'cuc_user_text' => $user->getName(),
'cuc_actiontext' => wfMessage( $actiontext )->inContentLanguage()->text(),
'cuc_comment' => '',
'cuc_this_oldid' => 0,
'cuc_last_oldid' => 0,
'cuc_type' => RC_LOG,
'cuc_timestamp' => $dbw->timestamp( wfTimestampNow() ),
'cuc_ip' => IP::sanitizeIP( $ip ),
'cuc_ip_hex' => $ip ? IP::toHex( $ip ) : null,
'cuc_xff' => !$isSquidOnly ? $xff : '',
'cuc_xff_hex' => ( $xff_ip && !$isSquidOnly ) ? IP::toHex( $xff_ip ) : null,
'cuc_agent' => $agent
];
$dbw->insert( 'cu_changes', $rcRow, __METHOD__ );
return true;
}
/**
* @param AuthenticationResponse $ret
* @param User $user
* @param string $username
*/
public static function onAuthManagerLoginAuthenticateAudit(
AuthenticationResponse $ret, $user, $username
) {
global $wgRequest, $wgCheckUserLogLogins;
if ( !$wgCheckUserLogLogins ) {
return;
}
if ( !$user ) {
$user = User::newFromName( $username, 'usable' );
}
if ( !$user ) {
return;
}
if ( $ret->status === AuthenticationResponse::FAIL ) {
$msg = 'checkuser-login-failure';
} elseif ( $ret->status === AuthenticationResponse::PASS ) {
$msg = 'checkuser-login-success';
} else {
// Abstain, Redirect, etc.
return;
}
$ip = $wgRequest->getIP();
$xff = $wgRequest->getHeader( 'X-Forwarded-For' );
list( $xff_ip, $isSquidOnly ) = self::getClientIPfromXFF( $xff );
$agent = $wgRequest->getHeader( 'User-Agent' );
$userName = $user->getName();
$target = "[[User:$userName|$userName]]";
$msg = wfMessage( $msg );
$msg->params( $target );
$dbw = wfGetDB( DB_MASTER );
$rcRow = [
'cuc_page_id' => 0,
'cuc_namespace' => NS_USER,
'cuc_title' => '',
'cuc_minor' => 0,
'cuc_user' => 0,
'cuc_user_text' => $ip,
'cuc_actiontext' => $msg->inContentLanguage()->text(),
'cuc_comment' => '',
'cuc_this_oldid' => 0,
'cuc_last_oldid' => 0,
'cuc_type' => RC_LOG,
'cuc_timestamp' => $dbw->timestamp( wfTimestampNow() ),
'cuc_ip' => IP::sanitizeIP( $ip ),
'cuc_ip_hex' => $ip ? IP::toHex( $ip ) : null,
'cuc_xff' => !$isSquidOnly ? $xff : '',
'cuc_xff_hex' => ( $xff_ip && !$isSquidOnly ) ? IP::toHex( $xff_ip ) : null,
'cuc_agent' => $agent
];
$dbw->insert( 'cu_changes', $rcRow, __METHOD__ );
}
/**
* Hook function to prune data from the cu_changes table
* @return true
*/
public static function maybePruneIPData() {
# Every 50th edit, prune the checkuser changes table.
if ( 0 == mt_rand( 0, 49 ) ) {
$fname = __METHOD__;
DeferredUpdates::addCallableUpdate( function () use ( $fname ) {
global $wgCUDMaxAge;
$dbw = wfGetDB( DB_MASTER );
$encCutoff = $dbw->addQuotes( $dbw->timestamp( time() - $wgCUDMaxAge ) );
$ids = $dbw->selectFieldValues( 'cu_changes',
'cuc_id',
[ "cuc_timestamp < $encCutoff" ],
$fname,
[ 'LIMIT' => 500 ]
);
if ( $ids ) {
$dbw->delete( 'cu_changes', [ 'cuc_id' => $ids ], $fname );
}
} );
}
return true;
}
/**
* Locates the client IP within a given XFF string.
* Unlike the XFF checking to determine a user IP in WebRequest,
* this simply follows the chain and does not account for server trust.
*
* This returns an array containing:
* - The best guess of the client IP
* - Whether all the proxies are just squid/varnish
*
* @param string $xff XFF header value
* @return array (string|null, bool)
* @todo move this to a utility class
*/
public static function getClientIPfromXFF( $xff ) {
global $wgUsePrivateIPs;
if ( !strlen( $xff ) ) {
return [ null, false ];
}
# Get the list in the form of <PROXY N, ... PROXY 1, CLIENT>
$ipchain = array_map( 'trim', explode( ',', $xff ) );
$ipchain = array_reverse( $ipchain );
if ( class_exists( ProxyLookup::class ) ) { // MW 1.28+
$proxyLookup = MediaWikiServices::getInstance()->getProxyLookup();
} else {
// This is kind of sketch, but is good enough for back-compat
$proxyLookup = new IP();
}
$client = null; // best guess of the client IP
$isSquidOnly = false; // all proxy servers where site Squid/Varnish servers?
# Step through XFF list and find the last address in the list which is a
# sensible proxy server. Set $ip to the IP address given by that proxy server,
# unless the address is not sensible (e.g. private). However, prefer private
# IP addresses over proxy servers controlled by this site (more sensible).
foreach ( $ipchain as $i => $curIP ) {
$curIP = IP::canonicalize( $curIP );
if ( $curIP === null ) {
break; // not a valid IP address
}
$curIsSquid = $proxyLookup->isConfiguredProxy( $curIP );
if ( $client === null ) {
$client = $curIP;
$isSquidOnly = $curIsSquid;
}
if (
isset( $ipchain[$i + 1] ) &&
IP::isIPAddress( $ipchain[$i + 1] ) &&
(
IP::isPublic( $ipchain[$i + 1] ) ||
$wgUsePrivateIPs ||
$curIsSquid // bug 48919
)
) {
$client = IP::canonicalize( $ipchain[$i + 1] );
$isSquidOnly = ( $isSquidOnly && $curIsSquid );
continue;
}
break;
}
return [ $client, $isSquidOnly ];
}
public static function onLoadExtensionSchemaUpdates( DatabaseUpdater $updater ) {
$base = __DIR__ . '/..';
$dbType = $updater->getDB()->getType();
$isCUInstalled = $updater->tableExists( 'cu_changes' );
$updater->addExtensionTable(
'cu_changes', self::getTableFileName( $dbType, 'cu_changes' )
);
$updater->addExtensionTable(
'cu_log', self::getTableFileName( $dbType, 'cu_log' )
);
if ( $dbType === 'mysql' ) {
$updater->addExtensionIndex(
'cu_changes',
'cuc_ip_hex_time',
"$base/archives/patch-cu_changes_indexes.sql"
);
$updater->addExtensionIndex(
'cu_changes',
'cuc_user_ip_time',
"$base/archives/patch-cu_changes_indexes2.sql"
);
$updater->addExtensionField(
'cu_changes',
'cuc_private',
"$base/archives/patch-cu_changes_privatedata.sql"
);
} elseif ( $dbType === 'postgres' ) {
$updater->addExtensionUpdate(
[ 'addPgField', 'cu_changes', 'cuc_private', 'BYTEA' ]
);
}
if ( !$isCUInstalled ) {
// First time so populate cu_changes with recentchanges data.
// Note: We cannot completely rely on updatelog here for old entries
// as populateCheckUserTable.php doesn't check for duplicates
$updater->addPostDatabaseUpdateMaintenance( 'PopulateCheckUserTable' );
}
}
/**
* @param string $type DB type
* @param string $name Table name
* @return string
*/
private static function getTableFileName( $type, $name ) {
$file = __DIR__ . '/../' . $name;
return $type === 'postgres'
? $file . '.pg.sql'
: $file . '.sql';
}
/**
* Tell the parser test engine to create a stub cu_changes table,
* or temporary pages won't save correctly during the test run.
* @param array &$tables
* @return bool
*/
public static function checkUserParserTestTables( &$tables ) {
$tables[] = 'cu_changes';
return true;
}
/**
* Add a link to Special:CheckUser and Special:CheckUserLog
* on Special:Contributions/<username> for
* privileged users.
* @param int $id User ID
* @param Title $nt User page title
* @param array &$links Tool links
* @param SpecialPage $sp Special page
*/
public static function checkUserContributionsLinks(
$id, Title $nt, array &$links, SpecialPage $sp
) {
$user = $sp->getUser();
$linkRenderer = $sp->getLinkRenderer();
if ( $user->isAllowed( 'checkuser' ) ) {
$links['checkuser'] = $linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'CheckUser' ),
$sp->msg( 'checkuser-contribs' )->text(),
[],
[ 'user' => $nt->getText() ]
);
}
if ( $user->isAllowed( 'checkuser-log' ) ) {
$links['checkuser-log'] = $linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'CheckUserLog' ),
$sp->msg( 'checkuser-contribs-log' )->text(),
[],
[
'cuSearchType' => 'target',
'cuSearch' => $nt->getText()
]
);
}
}
/**
* Retroactively autoblocks the last IP used by the user (if it is a user)
* blocked by this Block.
*
* @param Block $block
* @param array &$blockIds
* @return bool
*/
public static function doRetroactiveAutoblock( Block $block, array &$blockIds ) {
$dbr = wfGetDB( DB_REPLICA );
$user = User::newFromName( (string)$block->getTarget(), false );
if ( !$user->getId() ) {
return true; // user in an IP?
}
$options = [ 'ORDER BY' => 'cuc_timestamp DESC' ];
$options['LIMIT'] = 1; // just the last IP used
$res = $dbr->select( 'cu_changes',
[ 'cuc_ip' ],
[ 'cuc_user' => $user->getId() ],
__METHOD__,
$options
);
# Iterate through IPs used (this is just one or zero for now)
foreach ( $res as $row ) {
if ( $row->cuc_ip ) {
$id = $block->doAutoblock( $row->cuc_ip );
if ( $id ) {
$blockIds[] = $id;
}
}
}
return false; // autoblock handled
}
public static function onUserMergeAccountFields( array &$updateFields ) {
$updateFields[] = [ 'cu_changes', 'cuc_user', 'cuc_user_text' ];
$updateFields[] = [ 'cu_log', 'cul_user', 'cul_user_text' ];
$updateFields[] = [ 'cu_log', 'cul_target_id' ];
return true;
}
/**
* For integration with the Renameuser extension.
*
* @param RenameuserSQL $renameUserSQL
* @return bool
*/
public static function onRenameUserSQL( RenameuserSQL $renameUserSQL ) {
$renameUserSQL->tablesJob['cu_changes'] = [
RenameuserSQL::NAME_COL => 'cuc_user_text',
RenameuserSQL::UID_COL => 'cuc_user',
RenameuserSQL::TIME_COL => 'cuc_timestamp',
'uniqueKey' => 'cuc_id'
];
$renameUserSQL->tables['cu_log'] = [ 'cul_user_text', 'cul_user' ];
return true;
}
}
|