-
Notifications
You must be signed in to change notification settings - Fork 5
/
wpvulnerability-general.php
1557 lines (1290 loc) · 55.2 KB
/
wpvulnerability-general.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
/**
* General functions
*
* @package WPVulnerability
*
* @version 2.0.0
*/
defined( 'ABSPATH' ) || die( 'No script kiddies please!' );
/**
* Checks and validates user capabilities for managing vulnerability settings in a WordPress environment.
*
* This function verifies if the current user has the appropriate permissions to manage network settings
* in a multisite installation or manage options in a single site installation. It is designed to be used
* in the context of a plugin or theme that interacts with WordPress vulnerability settings.
*
* @since 3.0.0
*
* @return bool Returns false if the current user does not have the required capabilities, true otherwise.
*/
function wpvulnerability_capabilities() {
$user = wp_get_current_user();
if ( is_multisite() && is_super_admin( $user->ID ) && ( is_network_admin() || is_main_site() ) ) {
// In a WordPress Multisite, the user must be SuperAdmin.
return true;
} elseif ( ! is_multisite() && is_admin() ) {
// In a WordPress simple, the user must be Admin.
return true;
}
return false;
}
/**
* Checks if the `shell_exec` function can be used.
*
* This function verifies if the `shell_exec` function is not disabled in the server's
* configuration and is able to execute a basic shell command. It also checks for
* safe mode, which is relevant for older PHP versions before 5.4.
*
* @since 3.4.0
*
* @return bool True if `shell_exec` is available and working, false otherwise.
*/
function wpvulnerability_can_shell_exec() {
// Check if `shell_exec` is disabled.
if ( in_array( 'shell_exec', array_map( 'trim', explode( ',', ini_get( 'disable_functions' ) ) ), true ) ) {
return false;
}
// Try to execute a simple command to confirm functionality.
$test = @shell_exec( 'echo test' ); // phpcs:ignore
// If the command execution failed or returned null, shell_exec is not working.
if ( null === $test ) {
return false;
}
return true;
}
/**
* Sanitize a version string.
*
* This function removes any leading or trailing whitespace from the version string
* and strips out any non-alphanumeric characters except for hyphens, underscores, and dots.
*
* @version 2.0.0
*
* @param string $version The version string to sanitize.
*
* @return string The sanitized version string.
*/
function wpvulnerability_sanitize_version( $version ) {
// Remove any leading/trailing whitespace.
$version = trim( $version );
// Strip out any non-alphanumeric characters except for hyphens, underscores, and dots.
$version = preg_replace( '/[^a-zA-Z0-9_\-.]+/', '', $version );
return $version;
}
/**
* Sanitize a PHP version string to ensure it follows the standard format.
*
* This function checks the input version string against a regular expression
* to match the standard PHP versioning format (major.minor[.patch]).
* It returns the matched version if it conforms to the expected format,
* otherwise, it returns the original input version.
*
* @since 3.1.0 Introduced.
*
* @param string $version The PHP version string to sanitize.
* @return string The sanitized version string, if it matches the standard format; otherwise, the original version string.
*/
function wpvulnerability_sanitize_version_php( $version ) {
// Sanitize the version string using the base sanitizer.
$version = wpvulnerability_sanitize_version( $version );
// Validate format (major.minor[.patch]) and sanitize.
if ( preg_match( '/^(\d+\.\d+(\.\d+)?)/', $version, $match ) ) {
if ( isset( $match[0] ) ) {
return trim( $match[0] );
}
}
return $version;
}
/**
* Sanitize an Apache HTTPD version string to ensure it follows the standard format.
*
* This function checks the input version string against a regular expression
* to match the standard Apache versioning format (major.minor[.patch]).
* It returns the matched version if it conforms to the expected format,
* otherwise, it returns the original input version.
*
* @since 3.2.0 Introduced.
*
* @param string $version The Apache version string to sanitize.
* @return string The sanitized version string, if it matches the standard format; otherwise, the original version string.
*/
function wpvulnerability_sanitize_version_apache( $version ) {
// Sanitize the version string using the base sanitizer.
$version = wpvulnerability_sanitize_version( $version );
// Validate format (major.minor[.patch]) and sanitize.
if ( preg_match( '/^(\d+\.\d+(\.\d+)?)/', $version, $match ) ) {
if ( isset( $match[0] ) ) {
return trim( $match[0] );
}
}
return $version;
}
/**
* Sanitize an nginx version string to ensure it follows the standard format.
*
* This function checks the input version string against a regular expression
* to match the standard nginx versioning format (major.minor[.patch]).
* It returns the matched version if it conforms to the expected format,
* otherwise, it returns the original input version.
*
* @since 3.2.0 Introduced.
*
* @param string $version The nginx version string to sanitize.
* @return string The sanitized version string, if it matches the standard format; otherwise, the original version string.
*/
function wpvulnerability_sanitize_version_nginx( $version ) {
// Sanitize the version string using the base sanitizer.
$version = wpvulnerability_sanitize_version( $version );
// Validate format (major.minor[.patch]) and sanitize.
if ( preg_match( '/^(\d+\.\d+(\.\d+)?)/', $version, $match ) ) {
if ( isset( $match[0] ) ) {
return trim( $match[0] );
}
}
return $version;
}
/**
* Detects the web server software and version from the SERVER_SOFTWARE server variable.
*
* This function attempts to identify the web server software (e.g., Apache, nginx) and its version
* based on the 'SERVER_SOFTWARE' environment variable provided by the server. It uses regular expressions
* to parse the web server name and version. The function also sanitizes the detected version number
* to a standard format (major.minor.patch).
*
* @since 3.2.0 Introduced.
*
* @return array Returns an associative array with three keys:
* 'id' => A short, lowercase identifier for the web server (e.g., 'apache', 'nginx'),
* 'name' => A more readable name for the web server (e.g., 'Apache HTTPD', 'nginx'),
* 'version' => The detected version of the web server, sanitized to a standard format.
*/
function wpvulnerability_detect_webserver() {
// Initialize an array to hold the web server information.
$webserver = array(
'id' => null,
'name' => null,
'version' => null,
);
// Check if the SERVER_SOFTWARE variable is set.
if ( isset( $_SERVER['SERVER_SOFTWARE'] ) ) {
// Trim any leading or trailing whitespace from the server software string.
$webserver_software = trim( wp_kses( wp_unslash( $_SERVER['SERVER_SOFTWARE'] ), 'strip' ) );
// Use regular expressions to extract the web server name and version.
if ( preg_match( '/^(\w+)\/?([^\s]*)/', $webserver_software, $matches ) ) {
// Check and assign the web server name if available.
if ( isset( $matches[1] ) && trim( (string) $matches[1] ) ) {
$webserver['name'] = trim( $matches[1] );
}
// Check and assign the web server version if available.
if ( isset( $matches[2] ) && trim( (string) $matches[2] ) ) {
$webserver['version'] = trim( $matches[2] );
}
}
}
// Normalize and set the web server ID based on the detected name.
if ( isset( $webserver['name'] ) && $webserver['name'] ) {
switch ( trim( strtolower( $webserver['name'] ) ) ) {
case 'httpd':
case 'apache':
$webserver['id'] = 'apache';
$webserver['name'] = 'Apache HTTPD'; // Provide a more readable name.
break;
case 'nginx':
$webserver['id'] = 'nginx'; // 'nginx' is both the ID and the readable name.
$webserver['name'] = 'nginx'; // Provide a more readable name.
break;
// Additional web servers can be added here.
}
}
// If the version is not detected, try to get it from the OS.
if ( empty( $webserver['version'] ) && wpvulnerability_can_shell_exec() ) {
if ( 'apache' === $webserver['id'] ) {
$apache_version = shell_exec( 'apache2 -v 2>&1' ); // phpcs:ignore
if ( empty( $apache_version ) ) {
$apache_version = shell_exec( 'httpd -v 2>&1' ); // phpcs:ignore
}
if ( preg_match( '/Apache\/([\d.]+)/', $apache_version, $version_matches ) ) {
$webserver['version'] = $version_matches[1];
}
} elseif ( 'nginx' === $webserver['id'] ) {
// Try to get Nginx version from the OS.
$nginx_version = shell_exec( 'nginx -v 2>&1' ); // phpcs:ignore
if ( preg_match( '/nginx\/([\d.]+)/', $nginx_version, $version_matches ) ) {
$webserver['version'] = $version_matches[1];
}
if ( empty( $nginx_version ) ) {
$angie_version = shell_exec( 'angie -v 2>&1' ); // phpcs:ignore
if ( preg_match( '/angie\/([\d.]+)/', $angie_version, $version_matches ) ) {
$webserver['version'] = $version_matches[1];
}
}
}
}
// Sanitize and validate the web server version format.
if ( isset( $webserver['version'] ) && $webserver['version'] ) {
// Sanitize the version number to ensure it's in a 'major.minor.patch' format.
$version = wpvulnerability_sanitize_version( $webserver['version'] );
// Validate and format the version number.
if ( preg_match( '/^(\d+\.\d+(\.\d+)?)/', $version, $match ) ) {
if ( isset( $match[0] ) ) {
$webserver['version'] = trim( $match[0] );
}
}
}
// Return the detected web server information.
return $webserver;
}
/**
* Sanitize a MariaDB version string to ensure it follows the standard format.
*
* This function checks the input version string against a regular expression
* to match the standard MariaDB versioning format (major.minor[.patch]).
* It returns the matched version if it conforms to the expected format;
* otherwise, it returns the original input version.
*
* @since 3.4.0
*
* @param string $version The MariaDB version string to sanitize.
* @return string The sanitized version string if it matches the standard format; otherwise, the original version string.
*/
function wpvulnerability_sanitize_version_mariadb( $version ) {
// Sanitize the version string using the base sanitizer.
$version = wpvulnerability_sanitize_version( $version );
// Validate and extract the version format (major.minor[.patch]).
if ( preg_match( '/^\d+\.\d+(\.\d+)?/', $version, $match ) ) {
if ( isset( $match[0] ) ) {
return trim( $match[0] );
}
}
return $version;
}
/**
* Sanitize a MySQL version string to ensure it follows the standard format.
*
* This function checks the input version string against a regular expression
* to match the standard MySQL versioning format (major.minor[.patch]).
* It returns the matched version if it conforms to the expected format;
* otherwise, it returns the original input version.
*
* @since 3.4.0
*
* @param string $version The MySQL version string to sanitize.
* @return string The sanitized version string if it matches the standard format; otherwise, the original version string.
*/
function wpvulnerability_sanitize_version_mysql( $version ) {
// Sanitize the version string using the base sanitizer.
$version = wpvulnerability_sanitize_version( $version );
// Validate and extract the version format (major.minor[.patch]).
if ( preg_match( '/^\d+\.\d+(\.\d+)?/', $version, $match ) ) {
if ( isset( $match[0] ) ) {
return trim( $match[0] );
}
}
return $version;
}
/**
* Detect the SQL server software and version from the database server.
*
* This function identifies the SQL server software (e.g., MariaDB, MySQL) and its version
* by querying the database using the 'SHOW VARIABLES' command. It parses the server name
* and version using the results and sanitizes the detected version number to a standard format (major.minor.patch).
*
* @since 3.4.0
*
* @return array Returns an associative array with three keys:
* 'id' => A short, lowercase identifier for the SQL server (e.g., 'mariadb', 'mysql'),
* 'name' => A more readable name for the SQL server (e.g., 'MariaDB', 'MySQL'),
* 'version' => The detected version of the SQL server, sanitized to a standard format.
*/
function wpvulnerability_detect_sqlserver() {
// Initialize an array to hold the SQL server information.
$sqlserver = array(
'id' => null,
'name' => null,
'version' => null,
);
$possible_version = null;
$possible_database = null;
global $wpdb;
// Query to get the database server type (version_comment).
// IGNORE REASON: this is not a usual query to WordPress but to the system.
$results = $wpdb->get_results( $wpdb->prepare( 'SHOW VARIABLES LIKE %s', 'version_comment' ) ); // phpcs:ignore
if ( $wpdb->last_error ) {
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
do_action( 'wpdb_last_error', $wpdb->last_error );
}
}
// Process the results to determine the database type.
if ( ! empty( $results ) && isset( $results[0]->Value ) ) {
$possible_database = trim( $results[0]->Value );
}
// Query to get the database server version.
// IGNORE REASON: this is not a usual query to WordPress but to the system.
$results = $wpdb->get_results( $wpdb->prepare( 'SHOW VARIABLES LIKE %s', 'version' ) ); // phpcs:ignore
if ( $wpdb->last_error ) {
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
do_action( 'wpdb_last_error', $wpdb->last_error );
}
}
// Process the results to determine the database version.
if ( ! empty( $results ) && isset( $results[0]->Value ) ) {
$possible_version = trim( $results[0]->Value );
}
// Determine the database type and set the appropriate values in the array.
if ( isset( $possible_database ) && $possible_database ) {
if ( false !== stripos( $possible_database, 'mariadb' ) ) {
$sqlserver['id'] = 'mariadb';
$sqlserver['name'] = 'MariaDB';
} elseif ( false !== stripos( $possible_database, 'mysql' ) ) {
$sqlserver['id'] = 'mysql';
$sqlserver['name'] = 'MySQL';
}
}
// Sanitize and set the version if it was detected.
if ( isset( $possible_version ) && $possible_version && $sqlserver['id'] ) {
if ( 'mariadb' === $sqlserver['id'] ) {
$sqlserver['version'] = wpvulnerability_sanitize_version_mariadb( $possible_version );
} elseif ( 'mysql' === $sqlserver['id'] ) {
$sqlserver['version'] = wpvulnerability_sanitize_version_mysql( $possible_version );
}
}
// Return the detected SQL server information.
return $sqlserver;
}
/**
* Returns a human-readable HTML entity for the given comparison operator.
*
* This function takes a comparison operator in string format and returns
* its corresponding HTML entity for better readability in web contexts.
*
* @version 2.0.0
*
* @param string $op The operator string to prettify.
*
* @return string The pretty operator HTML string.
*/
function wpvulnerability_pretty_operator( $op ) {
switch ( trim( strtolower( $op ) ) ) {
// Less than.
case 'lt':
return '< ';
// Less than or equal to.
case 'le':
return '≤ ';
// Greater than.
case 'gt':
return '> ';
// Greater than or equal to.
case 'ge':
return '≥ ';
// Equal to.
case 'eq':
return '= ';
// Not equal to.
case 'ne':
return '≠ ';
// Return the original operator if it's not recognized.
default:
return $op;
}
}
/**
* Returns a human-readable severity level.
*
* This function takes a severity string and returns a human-readable
* severity level, localized for translation.
*
* @version 2.0.0
*
* @param string $severity The severity string to prettify.
*
* @return string The human-readable severity string.
*/
function wpvulnerability_severity( $severity ) {
switch ( trim( strtolower( $severity ) ) ) {
// No severity.
case 'n':
/* translators: Severity: None */
return __( 'None', 'wpvulnerability' );
// Low severity.
case 'l':
/* translators: Severity: Low */
return __( 'Low', 'wpvulnerability' );
// Medium severity.
case 'm':
/* translators: Severity: Medium */
return __( 'Medium', 'wpvulnerability' );
// High severity.
case 'h':
/* translators: Severity: High */
return __( 'High', 'wpvulnerability' );
// Critical severity.
case 'c':
/* translators: Severity: Critical */
return __( 'Critical', 'wpvulnerability' );
// Return the original severity if it's not recognized.
default:
return $severity;
}
}
/**
* Retrieves vulnerabilities information from the API.
*
* This function fetches vulnerability information based on the provided type and slug.
* It supports caching to minimize API requests and improve performance.
*
* @version 2.0.0
*
* @param string $type The type of vulnerability. Can be 'core', 'plugin' or 'theme'.
* @param string $slug The slug of the plugin or theme. For core vulnerabilities, it is the version string.
* @param int $cache Optional. Whether to use cache. Default is 1 (true).
*
* @return array|bool An array with the vulnerability information or false if there's an error.
*/
function wpvulnerability_get( $type, $slug = '', $cache = 1 ) {
$vulnerability_data = null;
// Validate vulnerability type.
switch ( trim( strtolower( $type ) ) ) {
case 'core':
$type = 'core';
break;
case 'plugin':
$type = 'plugin';
break;
case 'theme':
$type = 'theme';
break;
default:
wp_die( 'Unknown vulnerability type sent.' );
break;
}
// Validate slug for plugin or theme.
if ( 'plugin' === $type || 'theme' === $type ) {
if ( empty( sanitize_title( $slug ) ) ) {
return false;
}
// Validate slug for core.
} elseif ( 'core' === $type ) {
if ( ! wpvulnerability_sanitize_version( $slug ) ) {
return false;
}
}
// Cache key.
$key = 'wpvulnerability_' . $type . '_' . $slug;
if ( $cache ) {
if ( is_multisite() ) {
$vulnerability_data = get_site_transient( $key );
} else {
$vulnerability_data = get_transient( $key );
}
}
// If not cached, get the updated data.
if ( empty( $vulnerability_data ) ) {
$url = WPVULNERABILITY_API_HOST . $type . '/' . $slug . '/';
$response = wp_remote_get( $url, array( 'timeout' => 2500 ) );
if ( ! is_wp_error( $response ) ) {
$body = wp_remote_retrieve_body( $response );
if ( is_multisite() ) {
set_site_transient( $key, $body, HOUR_IN_SECONDS * WPVULNERABILITY_CACHE_HOURS );
$vulnerability_data = get_site_transient( $key );
} else {
set_transient( $key, $body, HOUR_IN_SECONDS * WPVULNERABILITY_CACHE_HOURS );
$vulnerability_data = get_transient( $key );
}
}
}
return json_decode( $vulnerability_data, true );
}
/**
* Retrieve vulnerabilities for a specific version of WordPress Core.
*
* This function fetches vulnerability information for a given version of WordPress Core.
* If no version is provided, it retrieves vulnerabilities for the currently installed version.
* It supports caching to minimize API requests and improve performance.
*
* @since 2.0.0
*
* @param string|null $version The version number of WordPress Core. If null, retrieves for the installed version.
* @param int $cache Optional. Whether to use cache. Default is 1 (true).
*
* @return array|false Array of vulnerabilities, or false on error.
*/
function wpvulnerability_get_core( $version = null, $cache = 1 ) {
// Sanitize the version number.
if ( ! wpvulnerability_sanitize_version( $version ) ) {
$version = null;
}
// If version number is null, retrieve for the installed version.
if ( is_null( $version ) ) {
$version = get_bloginfo( 'version' );
}
// Get vulnerabilities from API.
$response = wpvulnerability_get( 'core', $version, $cache );
// Check for errors.
if ( ( isset( $response['error'] ) && $response['error'] ) || empty( $response['data']['vulnerability'] ) ) {
return false;
}
// Process vulnerabilities and return as an array.
$vulnerability = array();
foreach ( $response['data']['vulnerability'] as $v ) {
// Set vulnerability name if available.
$name = null;
if ( isset( $v['name'] ) ) {
$name = $v['name'];
}
// Set vulnerability link if available.
$link = null;
if ( isset( $v['link'] ) ) {
$link = $v['link'];
}
$vulnerability[] = array(
'name' => wp_kses( (string) $name, 'strip' ),
'link' => esc_url_raw( (string) $link ),
'source' => $v['source'],
'impact' => $v['impact'],
);
}
return $vulnerability;
}
/**
* Retrieves vulnerabilities for a specified plugin, optionally returning general plugin data.
*
* This function sanitizes the plugin slug and verifies the version number before querying the vulnerability API.
* If `$data` is set to 1, it returns general information about the plugin instead of vulnerabilities.
* The function returns an array of vulnerabilities or plugin data based on the `$data` parameter, or `false`
* if no vulnerabilities are found or the version number is invalid and `$data` is not set.
*
* @since 2.0.0 Introduced.
*
* @param string $slug The slug of the plugin to check for vulnerabilities.
* @param string $version The version of the plugin to check. The function may return `false` if this is invalid and `$data` is not set.
* @param int $data Optional. Set to 1 to return general plugin data instead of vulnerabilities. Default 0 (return vulnerabilities).
* @param int $cache Optional. Whether to use cache. Default is 1 (true).
*
* @return array|false An array of vulnerabilities or plugin data if `$data` is set to 1, or `false` if no vulnerabilities are found or the version number is invalid and `$data` is not set.
*/
function wpvulnerability_get_plugin( $slug, $version, $data = 0, $cache = 1 ) {
// Sanitize the plugin slug.
$slug = sanitize_title( $slug );
// If the version number is invalid, return false.
if ( ! wpvulnerability_sanitize_version( $version ) && ! $data ) {
return false;
}
// Get the response from the vulnerability API.
$response = wpvulnerability_get( 'plugin', $slug, $cache );
// Create an empty array to store the vulnerabilities.
$vulnerability = array();
if ( 1 === $data ) {
if ( isset( $response['data'] ) ) {
$vulnerability = array(
'name' => wp_kses( (string) $response['data']['name'], 'strip' ),
'link' => esc_url( (string) $response['data']['link'] ),
'latest' => number_format( (int) $response['data']['latest'], 0, '.', '' ),
'closed' => number_format( (int) $response['data']['closed'], 0, '.', '' ),
);
}
} else {
// If there are no vulnerabilities, return false.
if ( ( isset( $response['error'] ) && $response['error'] ) || empty( $response['data']['vulnerability'] ) ) {
return false;
}
// Loop through each vulnerability and check if it affects the specified version of the plugin.
foreach ( $response['data']['vulnerability'] as $v ) {
// If the vulnerability has minimum and maximum versions, check if the specified version falls within that range.
if ( isset( $v['operator']['min_operator'] ) && $v['operator']['min_operator'] && isset( $v['operator']['max_operator'] ) && $v['operator']['max_operator'] ) {
if ( version_compare( $version, $v['operator']['min_version'], $v['operator']['min_operator'] ) && version_compare( $version, $v['operator']['max_version'], $v['operator']['max_operator'] ) ) {
// Add the vulnerability to the array.
$vulnerability[] = array(
'name' => wp_kses( (string) $v['name'], 'strip' ),
'description' => wp_kses_post( (string) $v['description'] ),
'versions' => wp_kses( wpvulnerability_pretty_operator( $v['operator']['min_operator'] ) . $v['operator']['min_version'] . ' - ' . wpvulnerability_pretty_operator( $v['operator']['max_operator'] ) . $v['operator']['max_version'], 'strip' ),
'version' => wp_kses( (string) $v['operator']['min_version'], 'strip' ),
'unfixed' => (int) $v['operator']['unfixed'],
'closed' => (int) $v['operator']['closed'],
'source' => $v['source'],
'impact' => $v['impact'],
);
}
// If the vulnerability has only a maximum version, check if the specified version is below that version.
} elseif ( isset( $v['operator']['max_operator'] ) && $v['operator']['max_operator'] ) {
if ( version_compare( $version, $v['operator']['max_version'], $v['operator']['max_operator'] ) ) {
// Add the vulnerability to the list.
$vulnerability[] = array(
'name' => wp_kses( (string) $v['name'], 'strip' ),
'description' => wp_kses_post( (string) $v['description'] ),
'versions' => wp_kses( wpvulnerability_pretty_operator( $v['operator']['max_operator'] ) . $v['operator']['max_version'], 'strip' ),
'version' => wp_kses( (string) $v['operator']['max_version'], 'strip' ),
'unfixed' => (int) $v['operator']['unfixed'],
'closed' => (int) $v['operator']['closed'],
'source' => $v['source'],
'impact' => $v['impact'],
);
}
// If the vulnerability has only a minimum version, check if the specified version is above that version.
} elseif ( isset( $v['operator']['min_operator'] ) && $v['operator']['min_operator'] ) {
if ( version_compare( $version, $v['operator']['min_version'], $v['operator']['min_operator'] ) ) {
// Add the vulnerability to the list.
$vulnerability[] = array(
'name' => wp_kses( (string) $v['name'], 'strip' ),
'description' => wp_kses_post( (string) $v['description'] ),
'versions' => wp_kses( wpvulnerability_pretty_operator( $v['operator']['min_operator'] ) . $v['operator']['min_version'], 'strip' ),
'version' => wp_kses( (string) $v['operator']['min_version'], 'strip' ),
'unfixed' => (int) $v['operator']['unfixed'],
'closed' => (int) $v['operator']['closed'],
'source' => $v['source'],
'impact' => $v['impact'],
);
}
}
}
}
return $vulnerability;
}
/**
* Get vulnerabilities for a specific theme.
*
* This function retrieves and sanitizes the theme slug and version before querying the vulnerability API.
* It returns an array of vulnerabilities if any are found, or false if there are none.
*
* @since 2.0.0
*
* @param string $slug Slug of the theme.
* @param string $version Version of the theme.
* @param int $cache Optional. Whether to use cache. Default is 1 (true).
*
* @return array|false Returns an array of vulnerabilities, or false if there are none.
*/
function wpvulnerability_get_theme( $slug, $version, $cache = 1 ) {
// Sanitize the theme slug.
$slug = sanitize_title( $slug );
// Validate the version number.
if ( ! wpvulnerability_sanitize_version( $version ) ) {
return false;
}
// Get the response from the vulnerability API.
$response = wpvulnerability_get( 'theme', $slug, $cache );
// Create an empty array to store the vulnerabilities.
$vulnerability = array();
// If there are no vulnerabilities, return false.
if ( ( isset( $response['error'] ) && $response['error'] ) || empty( $response['data']['vulnerability'] ) ) {
return false;
}
// Process each vulnerability.
foreach ( $response['data']['vulnerability'] as $v ) {
// Check if the version falls within the min and max operator range.
if ( isset( $v['operator']['min_operator'] ) && $v['operator']['min_operator'] && isset( $v['operator']['max_operator'] ) && $v['operator']['max_operator'] ) {
if ( version_compare( $version, $v['operator']['min_version'], $v['operator']['min_operator'] ) && version_compare( $version, $v['operator']['max_version'], $v['operator']['max_operator'] ) ) {
// Add the vulnerability to the list.
$vulnerability[] = array(
'name' => wp_kses( (string) $v['name'], 'strip' ),
'description' => wp_kses_post( (string) $v['description'] ),
'versions' => wp_kses( wpvulnerability_pretty_operator( $v['operator']['min_operator'] ) . $v['operator']['min_version'] . ' - ' . wpvulnerability_pretty_operator( $v['operator']['max_operator'] ) . $v['operator']['max_version'], 'strip' ),
'version' => wp_kses( (string) $v['operator']['min_version'], 'strip' ),
'unfixed' => (int) $v['operator']['unfixed'],
'closed' => (int) $v['operator']['closed'],
'source' => $v['source'],
'impact' => $v['impact'],
);
}
// Check if the version is below the max operator.
} elseif ( isset( $v['operator']['max_operator'] ) && $v['operator']['max_operator'] ) {
if ( version_compare( $version, $v['operator']['max_version'], $v['operator']['max_operator'] ) ) {
// Add the vulnerability to the list.
$vulnerability[] = array(
'name' => wp_kses( (string) $v['name'], 'strip' ),
'description' => wp_kses_post( (string) $v['description'] ),
'versions' => wp_kses( wpvulnerability_pretty_operator( $v['operator']['max_operator'] ) . $v['operator']['max_version'], 'strip' ),
'version' => wp_kses( (string) $v['operator']['max_version'], 'strip' ),
'unfixed' => (int) $v['operator']['unfixed'],
'closed' => (int) $v['operator']['closed'],
'source' => $v['source'],
'impact' => $v['impact'],
);
}
// Check if the version is above the min operator.
} elseif ( isset( $v['operator']['min_operator'] ) && $v['operator']['min_operator'] ) {
if ( version_compare( $version, $v['operator']['min_version'], $v['operator']['min_operator'] ) ) {
// Add the vulnerability to the list.
$vulnerability[] = array(
'name' => wp_kses( (string) $v['name'], 'strip' ),
'description' => wp_kses_post( (string) $v['description'] ),
'versions' => wp_kses( wpvulnerability_pretty_operator( $v['operator']['min_operator'] ) . $v['operator']['min_version'], 'strip' ),
'version' => wp_kses( (string) $v['operator']['min_version'], 'strip' ),
'unfixed' => (int) $v['operator']['unfixed'],
'closed' => (int) $v['operator']['closed'],
'source' => $v['source'],
'impact' => $v['impact'],
);
}
}
}
return $vulnerability;
}
/**
* Get statistics
*
* Returns an array with statistical information about vulnerabilities and their respective products.
*
* @since 2.0.0
*
* @param int $cache Optional. Whether to use cache. Default is 1 (true).
*
* @return array|false Returns an array with the statistical information if successful, false otherwise.
*/
function wpvulnerability_get_statistics( $cache = 1 ) {
$vulnerability = null;
$key = 'wpvulnerability_stats';
// Get cached statistics if available.
if ( $cache ) {
if ( is_multisite() ) {
$vulnerability = get_site_transient( $key );
} else {
$vulnerability = get_transient( $key );
}
}
// If cached statistics are not available, retrieve them from the API and store them in cache.
if ( empty( $vulnerability ) ) {
$url = WPVULNERABILITY_API_HOST;
$response = wp_remote_get( $url, array( 'timeout' => 2500 ) );
if ( ! is_wp_error( $response ) ) {
$body = wp_remote_retrieve_body( $response );
if ( is_multisite() ) {
set_site_transient( $key, $body, HOUR_IN_SECONDS * 24 );
$vulnerability = get_site_transient( $key );
} else {
set_transient( $key, $body, HOUR_IN_SECONDS * 24 );
$vulnerability = get_transient( $key );
}
}
}
// If the response does not contain statistics, return false.
$response = json_decode( $vulnerability, true );
if ( ! isset( $response['stats'] ) ) {
return false;
}
$sponsors = array();
if ( isset( $response['behindtheproject']['sponsors'] ) && count( $response['behindtheproject']['sponsors'] ) ) {
foreach ( $response['behindtheproject']['sponsors'] as $s ) {
$sponsors[] = $s;
unset( $s );
}
}
$contributors = array();
if ( isset( $response['behindtheproject']['contributors'] ) && count( $response['behindtheproject']['contributors'] ) ) {
foreach ( $response['behindtheproject']['contributors'] as $s ) {
$contributors[] = $s;
unset( $s );
}
}
// Return an array with statistical information.
return array(
'core' => array(
'versions' => (int) $response['stats']['products']['core'],
),
'plugins' => array(
'products' => (int) $response['stats']['products']['plugins'],
'vulnerabilities' => (int) $response['stats']['plugins'],
),
'themes' => array(
'products' => (int) $response['stats']['products']['themes'],
'vulnerabilities' => (int) $response['stats']['themes'],
),
'php' => array(
'vulnerabilities' => (int) $response['stats']['php'],
),
'apache' => array(
'vulnerabilities' => (int) $response['stats']['apache'],
),
'nginx' => array(
'vulnerabilities' => (int) $response['stats']['nginx'],
),
'mariadb' => array(
'vulnerabilities' => (int) $response['stats']['mariadb'],
),
'mysql' => array(
'vulnerabilities' => (int) $response['stats']['mysql'],
),
'sponsors' => $sponsors,
'contributors' => $contributors,
'updated' => array(
'unixepoch' => (int) $response['updated'],
'datetime' => gmdate( 'Y-m-d H:i:s', (int) $response['updated'] ),
'iso8601' => gmdate( 'c', (int) $response['updated'] ),
'rfc2822' => gmdate( 'r', (int) $response['updated'] ),
),
);
}
/**
* Retrieves the latest vulnerability statistics.
*
* This function calls the wpvulnerability API to get fresh statistics related to vulnerabilities
* and returns the updated information.
*
* @since 3.4.0
*
* @return array The updated vulnerability statistics.
*/
function wpvulnerability_get_fresh_statistics() {
$statistics_api_response = wpvulnerability_get_statistics();
return $statistics_api_response;
}
/**
* Retrieves and caches the latest vulnerability statistics.
*
* This function retrieves the most recent vulnerability statistics, caches the data,
* and returns the information as a JSON-encoded array. The cache expiration timestamp is also updated.
*
* @since 3.4.0
*
* @return string JSON-encoded array containing the vulnerability statistics.
*/
function wpvulnerability_statistics_get() {
// Retrieve fresh statistics.
$statistics = wpvulnerability_get_fresh_statistics();
// Cache the statistics data and the timestamp for cache expiration.
if ( is_multisite() ) {
update_site_option( 'wpvulnerability-statistics', wp_json_encode( $statistics ) );
update_site_option( 'wpvulnerability-statistics-cache', wp_json_encode( number_format( time() + ( 3600 * WPVULNERABILITY_CACHE_HOURS ), 0, '.', '' ) ) );
} else {