-
Notifications
You must be signed in to change notification settings - Fork 14
/
class-ip-geo-block-logs.php
1230 lines (1064 loc) · 40.2 KB
/
class-ip-geo-block-logs.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
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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* IP Geo Block - Handling validation log
*
* @package IP_Geo_Block
* @author tokkonopapa <tokkonopapa@yahoo.com>
* @license GPL-3.0
* @link https://www.ipgeoblock.com/
* @copyright 2013-2019 tokkonopapa
*/
// varchar can not be exceeded over 255 before MySQL-5.0.3.
define( 'IP_GEO_BLOCK_MAX_STR_LEN', 255 );
define( 'IP_GEO_BLOCK_MAX_BIN_LEN', 512 );
// Cipher mode and type
define( 'IP_GEO_BLOCK_CIPHER_MODE', 2 ); // 0:before 3.0.13, 1:mysql default, 2:openssl
define( 'IP_GEO_BLOCK_CIPHER_TYPE', 'AES-256-CBC' ); // for openssl
class IP_Geo_Block_Logs {
const TABLE_LOGS = 'ip_geo_block_logs';
const TABLE_STAT = 'ip_geo_block_stat';
// Initial statistics data
private static $default = array(
'blocked' => 0,
'unknown' => 0,
'IPv4' => 0,
'IPv6' => 0,
'countries' => array(),
'providers' => array(),
'daystats' => array(),
);
// Cipher mode and key
private static $cipher = array();
// SQLite for Live update
private static $pdo = NULL;
private static $stm = NULL;
/**
* Create
*
* @internal creating mixed storage engine may cause troubles with some plugins.
*/
public static function create_tables() {
global $wpdb;
$charset_collate = $wpdb->get_charset_collate(); // @since 3.5.0
// for logs
$table = $wpdb->prefix . self::TABLE_LOGS;
$sql = "CREATE TABLE IF NOT EXISTS `$table` (
`No` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`time` int(10) unsigned NOT NULL DEFAULT '0',
`ip` varbinary(96) NOT NULL,
`asn` varchar(8) NULL,
`hook` varchar(8) NOT NULL,
`auth` int(10) unsigned NOT NULL DEFAULT '0',
`code` varchar(2) NOT NULL DEFAULT 'ZZ',
`result` varchar(8) NULL,
`method` varchar(" . IP_GEO_BLOCK_MAX_STR_LEN . ") NOT NULL,
`user_agent` varchar(" . IP_GEO_BLOCK_MAX_STR_LEN . ") NULL,
`headers` varbinary(" . IP_GEO_BLOCK_MAX_BIN_LEN . ") NULL,
`data` text NULL,
PRIMARY KEY (`No`),
KEY `time` (`time`),
KEY `hook` (`hook`)
) $charset_collate";
$wpdb->query( $sql ) or self::error( __LINE__ );
// for statistics
$table = $wpdb->prefix . self::TABLE_STAT;
$sql = "CREATE TABLE IF NOT EXISTS `$table` (
`No` tinyint(4) unsigned NOT NULL AUTO_INCREMENT,
`data` longtext NULL,
PRIMARY KEY (`No`)
) $charset_collate";
$wpdb->query( $sql ) or self::error( __LINE__ );
// Create 1 record if not exists
$sql = $wpdb->prepare(
"INSERT INTO `$table` (`No`, `data`) VALUES (%d, %s)
ON DUPLICATE KEY UPDATE No = No", 1, serialize( self::$default )
) and $wpdb->query( $sql );
// for IP address cache
$table = $wpdb->prefix . IP_Geo_Block::CACHE_NAME;
$sql = "CREATE TABLE IF NOT EXISTS `$table` (
`No` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`time` int(10) unsigned NOT NULL DEFAULT '0',
`hook` varchar(8) NOT NULL,
`ip` varbinary(96) UNIQUE NOT NULL,
`asn` varchar(8) NULL,
`code` varchar(2) NOT NULL DEFAULT 'ZZ',
`auth` int(10) unsigned NOT NULL DEFAULT '0',
`fail` int(10) unsigned NOT NULL DEFAULT '0',
`reqs` int(10) unsigned NOT NULL DEFAULT '0',
`last` int(10) unsigned NOT NULL DEFAULT '0',
`view` int(10) unsigned NOT NULL DEFAULT '0',
`host` varbinary(512) NULL,
PRIMARY KEY (`No`)
) $charset_collate";
$wpdb->query( $sql ) or self::error( __LINE__ );
return TRUE;
}
/**
* Upgrade
*
*/
public static function upgrade( $version ) {
// AES 128 -> AES 256
if ( version_compare( $version, '3.0.13' ) < 0 ) {
// delete IP address cache
self::clear_cache();
// restore logs by old format
$logs = self::restore_logs( NULL, FALSE ); // should be called before `cipher_mode_key()`
if ( 1 === ( $mode = self::cipher_mode_key() ) )
$key = bin2hex( self::$cipher['key'] );
// `No`, `hook`, `time`, `ip`, `code`, `result`, `asn`, `method`, `user_agent`, `headers`, `data`
$fields = $ips = $headers = array();
foreach ( $logs as $log ) {
if ( $log[3] ) { // if `ip` is successfully extracted
$fields[] = $log[0]; // `No`
if ( 2 === $mode ) {
$ips [] = "UNHEX('" . bin2hex( self::encrypt( $log[3] ) ) . "')"; // `ip`
$headers[] = "UNHEX('" . bin2hex( self::encrypt( $log[9] ) ) . "')"; // `headers`
} else {
$ips [] = "AES_ENCRYPT(UNHEX('" . bin2hex( $log[3] ) . "'), UNHEX('" . $key . "'))"; // `ip`
$headers[] = "AES_ENCRYPT(UNHEX('" . bin2hex( $log[9] ) . "'), UNHEX('" . $key . "'))"; // `headers`
}
}
}
// bulk update logs
if ( ! empty( $fields ) ) {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_LOGS;
$sql = sprintf(
"UPDATE `$table` set `ip` = ELT(FIELD(`No`, %s), %s), `headers` = ELT(FIELD(`No`, %s), %s) WHERE `No` IN (%s)",
$fields = implode( ',', $fields ), implode( ',', $ips ), $fields, implode( ',', $headers ), $fields
) and $wpdb->query( $sql ) or self::error( __LINE__ );
}
}
// call -> reqs
if ( version_compare( $version, '3.0.15' ) < 0 ) {
self::delete_tables( IP_Geo_Block::CACHE_NAME );
self::create_tables();
}
}
/**
* Encrypts / Decrypts a string.
*
* @link https://php.net/manual/en/function.openssl-encrypt.php#119346
* @link https://mysqlserverteam.com/understand-and-satisfy-your-aes-encryption-needs-with-5-6-17/
*
* @param int $mode 0:before 3.0.12, 1:mysql default, 2:openssl
* @return array actual mode and cipher key
*/
private static function cipher_mode_key( $mode = IP_GEO_BLOCK_CIPHER_MODE ) {
$mode and $mode = defined( 'OPENSSL_RAW_DATA' ) ? $mode : 1; // @since PHP 5.3.3
if ( empty( self::$cipher['mode'] ) ) {
// openssl
if ( 2 === $mode ) {
// `openssl_random_pseudo_bytes()` can not be used as an IV because of search function
self::$cipher['iv' ] = md5( NONCE_KEY . NONCE_SALT, TRUE ); // 16 bytes (128 bits)
self::$cipher['key'] = IP_Geo_Block_Util::hash_hmac(
function_exists( 'hash' ) ? 'sha256' /* 32 bytes (256 bits) */ : 'sha1' /* 20 bytes (160 bits) */,
AUTH_KEY, AUTH_SALT, TRUE
);
}
// mysql default
elseif ( 1 === $mode ) {
self::$cipher['key'] = md5( NONCE_KEY . NONCE_SALT, TRUE ); // 16 bytes (128 bits)
}
// before 3.0.12
else {
self::$cipher['key'] = NONCE_KEY;
}
}
return self::$cipher['mode'] = $mode;
}
private static function decrypt( $data ) {
return openssl_decrypt( $data, IP_GEO_BLOCK_CIPHER_TYPE, self::$cipher['key'], OPENSSL_RAW_DATA, self::$cipher['iv'] ); // @since PHP 5.3.0
}
private static function encrypt( $data ) {
return openssl_encrypt( $data, IP_GEO_BLOCK_CIPHER_TYPE, self::$cipher['key'], OPENSSL_RAW_DATA, self::$cipher['iv'] ); // @since PHP 5.3.0
}
private static function encrypt_ip( $ip ) {
return isset( self::$cipher[ $ip ] ) ? self::$cipher[ $ip ] : self::$cipher[ $ip ] = self::encrypt( $ip );
}
/**
* Delete specific tables
*
*/
public static function delete_tables( $which = 'all' ) {
global $wpdb;
$tables = array( self::TABLE_LOGS, self::TABLE_STAT, IP_Geo_Block::CACHE_NAME );
foreach ( $tables as $table ) {
if ( 'all' === $which || $table === $which ) {
$table = $wpdb->prefix . $table;
$wpdb->query( "DROP TABLE IF EXISTS `$table`" ) or self::error( __LINE__ );
}
}
}
/**
* Diagnose tables
*
*/
public static function diag_tables() {
global $wpdb;
$tables = array( self::TABLE_LOGS, self::TABLE_STAT, IP_Geo_Block::CACHE_NAME );
foreach ( $tables as $table ) {
$table = $wpdb->prefix . $table;
if ( $wpdb->get_var( "SHOW TABLES LIKE '$table'" ) !== $table ) {
self::error( __LINE__, sprintf( __( 'Creating a DB table %s had failed. Once de-activate this plugin, and then activate again.', 'ip-geo-block' ), $table ) );
return FALSE;
}
$result = $wpdb->get_results( "SELECT COLUMN_NAME, DATA_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = '$table'", ARRAY_A );
foreach ( empty( $result ) ? array() : $result as $col ) {
if ( in_array( $col['COLUMN_NAME'], array( 'ip', 'host' ), TRUE ) && 'varbinary' !== $col['DATA_TYPE'] ) {
self::error( __LINE__, sprintf( __( 'Column type in %s unmatched. Once de-activate this plugin, and then activate again.', 'ip-geo-block' ), $table ) );
return FALSE;
}
}
}
return TRUE;
}
/**
* Clear log data
*
*/
public static function clear_logs( $hook = NULL ) {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_LOGS;
if ( in_array( $hook, array( 'comment', 'login', 'admin', 'xmlrpc', 'public' ), TRUE ) )
$sql = $wpdb->prepare( "DELETE FROM `$table` WHERE `hook` = %s", $hook )
and $wpdb->query( $sql ) or self::error( __LINE__ );
else
$wpdb->query( "TRUNCATE TABLE `$table`" ) or self::error( __LINE__ );
}
/**
* Clear statistics data.
*
*/
public static function clear_stat() {
self::record_stat( self::$default );
}
/**
* Restore statistics data.
*
*/
public static function restore_stat() {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_STAT;
$data = $wpdb->get_results( "SELECT * FROM `$table`", ARRAY_A ) or self::error( __LINE__ );
return empty( $data ) ? self::$default : unserialize( $data[0]['data'] ) + self::$default;
}
/**
* Record statistics data.
*
*/
public static function record_stat( $stat ) {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_STAT;
if ( ! is_array( $stat ) )
$stat = self::$default;
$sql = $wpdb->prepare( "UPDATE `$table` SET `data` = %s", serialize( $stat ) )
and $wpdb->query( $sql ) or self::error( __LINE__ );
}
/**
* Validate string whether utf8
*
* @see wp_check_invalid_utf8() in wp-includes/formatting.php
* @link https://core.trac.wordpress.org/browser/trunk/src/wp-includes/formatting.php
*/
private static function validate_utf8( $str ) {
$str = (string) $str;
if ( 0 === strlen( $str ) )
return '';
// Store the site charset as a static to avoid multiple calls to get_option()
static $is_utf8 = NULL;
if ( $is_utf8 === NULL )
$is_utf8 = array_key_exists(
get_option( 'blog_charset' ),
array( 'utf8' => NULL, 'utf-8' => NULL, 'UTF8' => NULL, 'UTF-8' => NULL )
);
// handle utf8 only
if ( ! $is_utf8 )
return '…';
// Check support for utf8 in the installed PCRE library
static $utf8_pcre = NULL;
if ( $utf8_pcre === NULL )
$utf8_pcre = preg_match( '/^./u', 'a' );
// if no support then reject $str for safety
if ( ! $utf8_pcre )
return '…';
// preg_match fails when it encounters invalid UTF8 in $str
if ( 1 === preg_match( '/^./us', $str ) ) {
// remove utf8mb4 4 bytes character
// @see strip_invalid_text() in wp-includes/wp-db.php
$regex = '/(?:\xF0[\x90-\xBF][\x80-\xBF]{2}|[\xF1-\xF3][\x80-\xBF]{3}|\xF4[\x80-\x8F][\x80-\xBF]{2})/';
return preg_replace( $regex, '', $str );
}
return '…';
}
/**
* Truncate string as utf8
*
* @see https://jetpack.wp-a2z.org/oik_api/mbstring_binary_safe_encoding/
* @link https://core.trac.wordpress.org/browser/trunk/src/wp-includes/formatting.php
* @link https://core.trac.wordpress.org/browser/trunk/src/wp-includes/functions.php
*/
private static function truncate_utf8( $str, $regexp = NULL, $replace = '', $len = IP_GEO_BLOCK_MAX_STR_LEN ) {
// remove unnecessary characters
$str = preg_replace( '/[\x00-\x1f\x7f]/', '', $str );
if ( $regexp )
$str = preg_replace( $regexp, $replace, $str );
// limit the length of the string
if ( function_exists( 'mb_strcut' ) ) {
mbstring_binary_safe_encoding(); // @since 3.7.0
if ( strlen( $str ) > $len )
$str = mb_strcut( $str, 0, $len ) . '…';
reset_mbstring_encoding(); // @since 3.7.0
}
else { // https://core.trac.wordpress.org/ticket/25259
mbstring_binary_safe_encoding(); // @since 3.7.0
$original = strlen( $str );
$str = substr( $str, 0, $len );
$length = strlen( $str );
reset_mbstring_encoding(); // @since 3.7.0
if ( $length !== $original ) {
// bit pattern from seems_utf8() in wp-includes/formatting.php
static $code = array(
array( 0x80, 0x00 ), // 1byte 0bbbbbbb
array( 0xE0, 0xC0 ), // 2bytes 110bbbbb
array( 0xF0, 0xE0 ), // 3bytes 1110bbbb
array( 0xF8, 0xF0 ), // 4bytes 11110bbb
array( 0xFC, 0xF8 ), // 5bytes 111110bb
array( 0xFE, 0xFC ), // 6bytes 1111110b
);
// truncate extra characters
$len = min( $length, 6 );
for ( $i = 0; $i < $len; ++$i ) {
$c = ord( $str[$length-1 - $i] );
for ( $j = $i; $j < 6; ++$j ) {
if ( ( $c & $code[$j][0] ) == $code[$j][1] ) {
mbstring_binary_safe_encoding(); // @since 3.7.0
$str = substr( $str, 0, $length - (int)($j > 0) - $i );
reset_mbstring_encoding(); // @since 3.7.0
// validate whole characters
$str = self::validate_utf8( $str );
return '…' !== $str ? $str . '…' : '…';
}
}
}
// $str may not fit utf8
return '…';
}
}
// validate whole characters
return self::validate_utf8( $str );
}
/**
* Get data
*
* These data must be sanitized before rendering
*/
private static function get_user_agent() {
return isset( $_SERVER['HTTP_USER_AGENT'] ) ? self::truncate_utf8( $_SERVER['HTTP_USER_AGENT'] ) : '';
}
private static function get_http_headers( $anonymize ) {
$exclusions = array(
'HTTP_ACCEPT' => TRUE,
'HTTP_ACCEPT_CHARSET' => TRUE,
'HTTP_ACCEPT_ENCODING' => TRUE,
'HTTP_ACCEPT_LANGUAGE' => TRUE,
'HTTP_CACHE_CONTROL' => TRUE,
'HTTP_CONNECTION' => TRUE,
'HTTP_COOKIE' => TRUE,
'HTTP_HOST' => TRUE,
'HTTP_PRAGMA' => TRUE,
'HTTP_USER_AGENT' => TRUE,
);
// select headers to hold in the logs
$headers = array();
foreach ( array_keys( $_SERVER ) as $key ) {
if ( 'HTTP_' === substr( $key, 0, 5 ) && empty( $exclusions[ $key ] ) )
$headers[] = $key . '=' . $_SERVER[ $key ];
}
$headers = self::truncate_utf8( implode( ',', $headers ) );
return $anonymize ? IP_Geo_Block_Util::anonymize_ip( $headers, FALSE ) : $headers;
}
private static function get_post_data( $hook, $validate, $settings ) {
// condition of masking password
$mask_pwd = ( IP_Geo_Block::is_passed( $validate['result'] ) || IP_Geo_Block::is_failed( $validate['result'] ) );
// XML-RPC
if ( 'xmlrpc' === $hook ) {
$posts = self::truncate_utf8(
file_get_contents( 'php://input' ), '!\s*([<>])\s*!', '$1'
);
// mask the password
if ( $mask_pwd &&
preg_match_all( '/<string>(\S*?)<\/string>/', $posts, $matches ) >= 2 &&
strpos( $matches[1][1], home_url() ) !== 0 ) { // except pingback
$posts = str_replace( $matches[1][1], '***', $posts );
}
return $posts;
}
// post data
else {
$keys = explode( ',', $settings['validation']['postkey'] );
$data = array();
$posts = $_POST;
// uploading files
if ( ! empty( $_FILES ) ) {
$posts['FILES'] = str_replace( PHP_EOL, ' ', print_r( $_FILES, TRUE ) );
! in_array( 'FILES', $keys, TRUE ) and $keys[] = 'FILES';
}
// mask the password
if ( ! empty( $posts['pwd'] ) && $mask_pwd )
$posts['pwd'] = '***';
// primaly: $_POST keys
foreach ( $keys as $key ) {
array_key_exists( $key, $posts ) and $data[] = $key . '=' . $posts[ $key ];
}
// secondary: rest of the keys in $_POST
foreach ( array_keys( $_POST ) as $key ) {
! in_array( $key, $keys, TRUE ) and $data[] = $key;
}
return self::truncate_utf8( implode( ',', $data ), '/\s+/', ' ' );
}
}
/**
* Backup the validation log to text files
*
* $path should be absolute to the directory and should not be within the public_html.
*/
private static function backup_logs( $hook, $validate, $method, $agent, $heads, $posts, $path ) {
if ( validate_file( $path ) === 0 ) {
file_put_contents(
IP_Geo_Block_Util::slashit( $path ) . IP_Geo_Block::PLUGIN_NAME . date('-Y-m') . '.log',
sprintf( "%d,%s,%s,%s,%d,%s,%s,%s,%s,%s,%s\n",
$_SERVER['REQUEST_TIME'],
$validate['ip'],
$validate['asn'],
$hook,
$validate['auth'],
$validate['code'],
$validate['result'],
$method,
str_replace( ',', '‚', $agent ), // , --> ‚
str_replace( ',', '‚', $heads ), // , --> ‚
str_replace( ',', '‚', $posts ) // , --> ‚
),
FILE_APPEND | LOCK_EX
);
}
}
/**
* Open and close sqlite database for live log
*
* The absolute path to the database can be set via filter hook `ip-geo-block-live-log`.
*
* @see https://php.net/manual/en/pdo.connections.php
* @see https://php.net/manual/en/features.persistent-connections.php
* @see https://www.sqlite.org/sharedcache.html#shared_cache_and_in_memory_databases
*
* @param int $id ID of the blog
* @param bool $dsn data source name for PDO, TRUE for `in_memory`, FALSE for file
* @return PDO $pdo instance of PDO class or WP_Error
*/
private static function open_sqlite_db( $id, $dsn = FALSE ) {
// For the sake of emergency, register the shutdown function
self::$pdo = self::$stm = NULL;
register_shutdown_function( 'IP_Geo_Block_Logs::close_sqlite_db' );
// Set data source name
$id = apply_filters( IP_Geo_Block::PLUGIN_NAME . '-live-log',
( $dsn ? ':memory:' : get_temp_dir() . IP_Geo_Block::PLUGIN_NAME . "-${id}.sqlite" )
);
try {
$pdo = new PDO( 'sqlite:' . $id, null, null, array(
PDO::ATTR_PERSISTENT => (bool)$dsn, // https://www.sqlite.org/inmemorydb.html
PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
PDO::ATTR_TIMEOUT => 3, // reduce `SQLSTATE[HY000]: General error: 5 database is locked`
) );
}
catch ( PDOException $e ) {
return new WP_Error( 'Warn', $e->getMessage() );
}
$pdo->exec( "CREATE TABLE IF NOT EXISTS " . self::TABLE_LOGS . " (
No INTEGER PRIMARY KEY AUTOINCREMENT,
blog_id integer DEFAULT 1 NOT NULL,
time bigint NOT NULL,
ip varchar(40) NOT NULL,
asn varchar(8) NULL,
hook varchar(8) NOT NULL,
auth integer DEFAULT 0 NOT NULL,
code varchar(2) DEFAULT 'ZZ' NOT NULL,
result varchar(8) NULL,
method varchar(" . IP_GEO_BLOCK_MAX_STR_LEN . ") NOT NULL,
user_agent varchar(" . IP_GEO_BLOCK_MAX_STR_LEN . ") NULL,
headers varchar(" . IP_GEO_BLOCK_MAX_STR_LEN . ") NULL,
data text NULL
);" ); // int or FALSE
return $pdo;
}
public static function close_sqlite_db() {
if ( self::$pdo && ! is_wp_error( self::$pdo ) ) {
@self::$pdo->rollBack(); // `@` is just for the exception without valid transaction
self::$stm = NULL;
self::$pdo = NULL;
}
}
public static function reset_sqlite_db() {
require_once IP_GEO_BLOCK_PATH . 'classes/class-ip-geo-block-file.php';
$fs = IP_Geo_Block_FS::init( __FUNCTION__ );
if ( FALSE !== ( $files = $fs->dirlist( $dir = get_temp_dir() ) ) ) {
foreach ( array_keys( $files ) as $file ) {
if ( FALSE !== strpos( $file, IP_Geo_Block::PLUGIN_NAME ) ) {
$fs->delete( $dir . $file );
}
}
}
return TRUE;
}
/**
* Record the validation log
*
* This function record the user agent string and post data.
* The security policy for these data is as follows.
*
* 1. Record only utf8 under the condition that the site charset is utf8
* 2. Record by limiting the length of the string
* 3. Mask the password if it is authenticated
*
* @param string $hook type of log name
* @param array $validate validation results
* @param array $settings option settings
* @param boolean $record record logs (TRUE) or not
*/
public static function record_logs( $hook, $validate, $settings, $block = TRUE ) {
$record = $settings['validation'][ $hook ] ? apply_filters( IP_Geo_Block::PLUGIN_NAME . '-record-logs', (int)$settings['validation']['reclogs'], $hook, $validate ) : 0;
$record = ( 1 === $record && $block ) || // blocked
( 6 === $record && ( $block || IP_Geo_Block::is_blocked( IP_Geo_Block::validate_country( NULL, $validate, $settings ) ) ) ) || // blocked or qualified
( 2 === $record && ! $block ) || // passed
( 3 === $record && ! $validate['auth'] ) || // unauthenticated
( 4 === $record && $validate['auth'] ) || // authenticated
( 5 === $record ); // all
// get data
$agent = self::get_user_agent();
$heads = self::get_http_headers( $settings['anonymize'] );
$posts = self::get_post_data( $hook, $validate, $settings );
$method = $_SERVER['REQUEST_METHOD'] . '[' . $_SERVER['SERVER_PORT'] . ']:' . $_SERVER['REQUEST_URI'];
// mark if any uploaded files exist
if ( ! empty( $_FILES ) )
$validate['result'] .= '^';
// anonymize ip address
if ( $settings['anonymize'] )
$validate['ip'] = IP_Geo_Block_Util::anonymize_ip( $validate['ip'] );
if ( $record ) {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_LOGS;
// limit the number of rows
if (1):
// Can't start transaction on the assumption that the storage engine is innoDB.
// So there are some cases where logs are excessively deleted.
$count = (int)$wpdb->get_var( "SELECT count(*) FROM `$table`" );
$sql = $wpdb->prepare(
"DELETE FROM `$table` ORDER BY `No` ASC LIMIT %d",
max( 0, $count - (int)$settings['validation']['maxlogs'] + 1 )
) and $wpdb->query( $sql ) or self::error( __LINE__ );
else:
// This SQL slows down on MySQL 5.7.23 and keeps +2 extra rows on MySQL 5.0.67
// @see https://teratail.com/questions/14584
$sql = $wpdb->prepare(
"DELETE FROM `$table` WHERE NOT EXISTS(
SELECT * FROM (
SELECT * FROM `$table` t2 ORDER BY t2.time DESC LIMIT %d
) t3 WHERE t3.No = $table.No
)",
$settings['validation']['maxlogs'] - 1
) and $wpdb->query( $sql ) or self::error( __LINE__ );
endif;
// insert into DB
if ( 2 === self::cipher_mode_key() ) {
$sql = $wpdb->prepare(
"INSERT INTO `$table`
(`time`, `ip`, `asn`, `hook`, `auth`, `code`, `result`, `method`, `user_agent`, `headers`, `data`)
VALUES (%d, %s, %s, %s, %d, %s, %s, %s, %s, %s, %s)",
$_SERVER['REQUEST_TIME'],
self::encrypt_ip( $validate['ip'] ),
$validate['asn'],
$hook,
$validate['auth'],
$validate['code'],
$validate['result'],
$method,
$agent,
self::encrypt( $heads ),
$posts
) and $wpdb->query( $sql ) or self::error( __LINE__ );
} else {
$sql = $wpdb->prepare(
"INSERT INTO `$table`
(`time`, `ip`, `asn`, `hook`, `auth`, `code`, `result`, `method`, `user_agent`, `headers`, `data`)
VALUES (%d, AES_ENCRYPT(%s, %s), %s, %s, %d, %s, %s, %s, %s, AES_ENCRYPT(%s, %s), %s)",
$_SERVER['REQUEST_TIME'],
$validate['ip'],
self::$cipher['key'],
$validate['asn'],
$hook,
$validate['auth'],
$validate['code'],
$validate['result'],
$method,
$agent,
$heads,
self::$cipher['key'],
$posts
) and $wpdb->query( $sql ) or self::error( __LINE__ );
}
// backup logs to text files
if ( $dir = apply_filters( IP_Geo_Block::PLUGIN_NAME . '-backup-dir', $settings['validation']['backup'], $hook ) ) {
self::backup_logs( $hook, $validate, $method, $agent, $heads, $posts, $dir );
}
}
if ( IP_Geo_Block::get_live_log() ) {
// skip self command
global $pagenow;
if ( 'admin-ajax.php' === $pagenow && isset( $_POST['action'] ) && 'ip_geo_block' === $_POST['action'] && isset( $_POST['cmd'] ) && 0 === strpos( $_POST['cmd'], 'live-' ) )
return;
// database file not available
if ( is_wp_error( self::$pdo = self::open_sqlite_db( $id = get_current_blog_id(), $settings['live_update']['in_memory'] ) ) ) {
self::error( __LINE__, self::$pdo->get_error_message() );
return;
}
try {
self::$stm = self::$pdo->prepare( // possibly throw an PDOException
'INSERT INTO ' . self::TABLE_LOGS . ' (blog_id, time, ip, asn, hook, auth, code, result, method, user_agent, headers, data) ' .
'VALUES ' . ' ( ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?);'
); // example: https://php.net/manual/en/pdo.lobs.php
self::$stm->bindParam( 1, $id, PDO::PARAM_INT );
self::$stm->bindParam( 2, $_SERVER['REQUEST_TIME'], PDO::PARAM_INT );
self::$stm->bindParam( 3, $validate['ip'], PDO::PARAM_STR );
self::$stm->bindParam( 4, $validate['asn'], PDO::PARAM_STR );
self::$stm->bindParam( 5, $hook, PDO::PARAM_STR );
self::$stm->bindParam( 6, $validate['auth'], PDO::PARAM_INT );
self::$stm->bindParam( 7, $validate['code'], PDO::PARAM_STR );
self::$stm->bindParam( 8, $validate['result'], PDO::PARAM_STR );
self::$stm->bindParam( 9, $method, PDO::PARAM_STR );
self::$stm->bindParam( 10, $agent, PDO::PARAM_STR );
self::$stm->bindParam( 11, $heads, PDO::PARAM_STR );
self::$stm->bindParam( 12, $posts, PDO::PARAM_STR );
self::$pdo->beginTransaction(); // possibly throw an PDOException
self::$stm->execute(); // TRUE or FALSE
self::$pdo->commit(); // possibly throw an PDOException
self::$stm->closeCursor(); // TRUE or FALSE
}
catch ( PDOException $e ) {
@self::$pdo->rollBack(); // `@` is just for the exception without valid transaction
self::error( __LINE__, $e->getMessage() );
}
self::$stm = NULL; // explicitly close the connection
self::$pdo = NULL; // explicitly close the connection
}
}
/**
* Restore the live log
*
* @note need to get transient before calling this function
* @return array or WP_Error
*/
public static function restore_live_log( $hook, $settings ) {
if ( is_wp_error( self::$pdo = self::open_sqlite_db( $id = get_current_blog_id(), $settings['live_update']['in_memory'] ) ) )
return new WP_Error( 'Warn', self::$pdo->get_error_message() );
try {
self::$pdo->beginTransaction(); // possibly throw an PDOException
if ( self::$stm = self::$pdo->query( "SELECT No, hook, time, ip, code, result, asn, method, user_agent, headers, data FROM " . self::TABLE_LOGS . " WHERE blog_id = ${id};" ) ) {
$result = self::$stm->fetchAll( PDO::FETCH_NUM ); // array or FALSE
self::$pdo->exec( "DELETE FROM " . self::TABLE_LOGS . " WHERE blog_id = ${id};" ); // int or FALSE
}
self::$pdo->commit(); // possibly throw an PDOException
self::$stm->closeCursor(); // TRUE or FALSE
}
catch ( PDOException $e ) {
@self::$pdo->rollBack(); // `@` is just for the exception without valid transaction
$result = new WP_Error( 'Warn', __FILE__ . '(' . __LINE__ . ') ' . $e->getMessage() );
}
self::$stm = NULL; // explicitly close the connection
self::$pdo = NULL; // explicitly close the connection
return ! empty( $result ) ? $result : array();
}
/**
* Restore the validation log
*
* @param string $hook type of log name
* @return array log data
*/
public static function restore_logs( $hook = NULL, $upgrade = IP_GEO_BLOCK_CIPHER_MODE ) {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_LOGS;
$mode = self::cipher_mode_key( $upgrade );
if ( 2 === $mode ) { // openssl
$sql = "SELECT `No`, `hook`, `time`, `ip`, `code`, `result`, `asn`, `method`, `user_agent`, `headers`, `data` FROM `$table`";
} else { // mysql default
$sql = $wpdb->prepare(
"SELECT `No`, `hook`, `time`, `ip`, AES_DECRYPT(`ip`, %s), `code`, `result`, `asn`, `method`, `user_agent`, `headers`, AES_DECRYPT(`headers`, %s), `data` FROM `$table`",
self::$cipher['key'], self::$cipher['key']
);
}
if ( in_array( $hook, array( 'comment', 'login', 'admin', 'xmlrpc', 'public' ), TRUE ) )
$sql .= $wpdb->prepare( " WHERE `hook` = %s ORDER BY `time` DESC", $hook );
else
$sql .= " ORDER BY `time` DESC"; // " ORDER BY `hook`, `time` DESC";
$result = $sql ? $wpdb->get_results( $sql, ARRAY_N ) : array();
foreach ( $result as $key => $val ) {
if ( 2 === $mode ) {
$result[ $key ][3] = self::decrypt( $val[3] );
$result[ $key ][9] = self::decrypt( $val[9] );
} elseif ( ctype_print( $result[ $key ][3] ) ) {
array_splice( $result[ $key ], 4, 1 ); // remove encrypted `ip`
array_splice( $result[ $key ], 10, 1 ); // remove encrypted `headers`
} else {
array_splice( $result[ $key ], 3, 1 ); // keep decrypted `ip`
array_splice( $result[ $key ], 9, 1 ); // keep decrypted `headers`
}
}
return $result;
}
/**
* Search logs by specific IP address
*
*/
public static function search_logs( $ip, $settings ) {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_LOGS;
if ( $settings['anonymize'] )
$ip = IP_Geo_Block_Util::anonymize_ip( $ip );
$mode = self::cipher_mode_key();
if ( 2 === $mode ) { // openssl
$sql = $wpdb->prepare(
"SELECT `time`, `ip`, `asn`, `hook`, `auth`, `code`, `result`, `method`, `user_agent`, `headers`, `data` FROM `$table` WHERE `ip` = %s",
self::encrypt_ip( $ip )
) and $result = $wpdb->get_results( $sql, ARRAY_N ) or self::error( __LINE__ );
} else { // mysql default
$sql = $wpdb->prepare(
"SELECT `time`, `ip`, AES_DECRYPT(`ip`, %s), `asn`, `hook`, `auth`, `code`, `result`, `method`, `user_agent`, `headers`, AES_DECRYPT(`headers`, %s), `data` FROM `$table` WHERE `ip` = AES_ENCRYPT(%s, %s)",
self::$cipher['key'], self::$cipher['key'], $ip, self::$cipher['key']
) and $result = $wpdb->get_results( $sql, ARRAY_N ) or self::error( __LINE__ );
}
foreach ( empty( $result ) ? array() : $result as $key => $val ) {
if ( 2 === $mode ) {
$result[ $key ][1] = self::decrypt( $val[1] );
$result[ $key ][9] = self::decrypt( $val[9] );
} elseif ( ctype_print( $result[ $key ][2] ) ) {
array_splice( $result[ $key ], 3, 1 ); // remove encrypted `ip`
array_splice( $result[ $key ], 11, 1 ); // remove encrypted `headers`
} else {
array_splice( $result[ $key ], 2, 1 ); // keep decrypted `ip`
array_splice( $result[ $key ], 10, 1 ); // keep decrypted `headers`
}
$result[ $key ] = array_combine(
array( 'time', 'ip', 'asn', 'hook', 'auth', 'code', 'result', 'method', 'user_agent', 'headers', 'data' ),
$result[ $key ]
);
}
return $result;
}
/**
* Delete entries with the specific IP address
*
*/
public static function delete_logs_entry( $entry = array() ) {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_LOGS;
$mode = self::cipher_mode_key();
foreach ( array_unique( (array)$entry ) as $ip ) {
if ( 2 === $mode ) {
$sql = $wpdb->prepare( "DELETE FROM `$table` WHERE `ip` = %s OR `ip` = %s",
self::encrypt_ip( $ip ), $ip
) and $result = ( FALSE !== $wpdb->query( $sql ) ) or self::error( __LINE__ );
} else {
$sql = $wpdb->prepare( "DELETE FROM `$table` WHERE `ip` = AES_ENCRYPT(%s, %s) OR `ip` = %s",
$ip, self::$cipher['key'], $ip
) and $result = ( FALSE !== $wpdb->query( $sql ) ) or self::error( __LINE__ );
}
}
return isset( $result ) ? $result : FALSE;
}
/**
* Get logs for a specified duration in the past
*
*/
public static function get_recent_logs( $duration = YEAR_IN_SECONDS ) {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_LOGS;
$mode = self::cipher_mode_key();
if ( 2 === $mode ) {
$sql = $wpdb->prepare(
"SELECT `time`, `ip`, `asn`, `hook`, `code`, `method`, `data` FROM `$table` WHERE `time` > %d",
$_SERVER['REQUEST_TIME'] - $duration
) and $result = $wpdb->get_results( $sql, ARRAY_N ) or self::error( __LINE__ );
} else {
$sql = $wpdb->prepare(
"SELECT `time`, `ip`, AES_DECRYPT(`ip`, %s), `asn`, `hook`, `code`, `method`, `data` FROM `$table` WHERE `time` > %d",
self::$cipher['key'], $_SERVER['REQUEST_TIME'] - $duration
) and $result = $wpdb->get_results( $sql, ARRAY_N ) or self::error( __LINE__ );
}
foreach ( empty( $result ) ? array() : $result as $key => $val ) {
if ( 2 === $mode ) {
$result[ $key ][1] = self::decrypt( $val[1] );
} elseif ( ctype_print( $result[ $key ][1] ) ) {
array_splice( $result[ $key ], 2, 1 ); // remove encrypted `ip`
} else {
array_splice( $result[ $key ], 1, 1 ); // keep decrypted `ip`
}
$result[ $key ] = array_combine(
array( 'time', 'ip', 'asn', 'hook', 'code', 'method', 'data' ),
$result[ $key ]
);
}
return $result;
}
/**
* Search blocked requests
*
* @param string $key 'method' or 'data'
* @param string $search search string
*/
public static function search_blocked_logs( $key, $search ) {
global $wpdb;
$table = $wpdb->prefix . self::TABLE_LOGS;
self::cipher_mode_key();
$sql = $wpdb->prepare(
"SELECT `time`, `ip`, AES_DECRYPT(`ip`, %s), `asn`, `hook`, `code`, `method`, `data` FROM `$table` " .
"WHERE `result` NOT LIKE '%%pass%%' AND `" . $key . "` LIKE '%%%s%%'", self::$cipher['key'], $search
) and $result = $wpdb->get_results( $sql, ARRAY_N ) or self::error( __LINE__ );
foreach ( empty( $result ) ? array() : $result as $key => $val ) {
if ( ctype_print( $result[ $key ][1] ) )
array_splice( $result[ $key ], 2, 1 ); // remove encrypted `ip`
else
array_splice( $result[ $key ], 1, 1 ); // keep decrypted `ip`
$result[ $key ] = array_combine(
array( 'time', 'ip', 'asn', 'hook', 'code', 'method', 'data' ),
$result[ $key ]
);
}
return $result;
}
/**
* Update statistics.
*
*/
public static function update_stat( $hook, $validate, $settings ) {
// Restore statistics
$stat = self::restore_stat();
// Count provider
$provider = isset( $validate['provider'] ) ? $validate['provider'] : 'Cache'; // asign `Cache` if no provider is available
if ( empty( $stat['providers'][ $provider ] ) )
$stat['providers'][ $provider ] = array( 'count' => 0, 'time' => 0.0 );
$stat['providers'][ $provider ]['count']++; // undefined in auth_fail()
$stat['providers'][ $provider ]['time' ] += (float)( isset( $validate['time'] ) ? $validate['time'] : 0 );
// Blocked by type of IP address
if ( IP_Geo_Block::is_blocked( $validate['result'] ) ) {
if ( filter_var( $validate['ip'], FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 ) )
++$stat['IPv4'];
elseif ( filter_var( $validate['ip'], FILTER_VALIDATE_IP, FILTER_FLAG_IPV6 ) )
++$stat['IPv6'];
++$stat['blocked' ];
@++$stat['countries'][ $validate['code'] ];
@++$stat['daystats' ][ mktime( 0, 0, 0 ) ][ $hook ];
}
if ( count( $stat['daystats'] ) > max( 30, min( 365, (int)$settings['validation']['recdays'] ) ) ) {
reset( $stat['daystats'] ); // pointer to the top
unset( $stat['daystats'][ key( $stat['daystats'] ) ] ); // unset at the top
}