MDL-55404 core_upgrade: Add libcurl environment checks
[moodle.git] / lib / classes / upgrade / util.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * PayPal enrolment plugin utility class.
19  *
20  * @package    core
21  * @copyright  2016 Cameron Ball <cameron@cameron1729.xyz>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core\upgrade;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Core upgrade utility class.
31  *
32  * @package   core
33  * @copyright 2016 Cameron Ball <cameron@cameron1729.xyz>
34  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 final class util {
38     /**
39      * Gets the minimum version of a SSL/TLS library required for TLS 1.2 support.
40      *
41      * @param  string $sslflavour The SSL/TLS library
42      * @return string|false The version string if it exists. False otherwise
43      */
44     private static function get_min_ssl_lib_version_for_tls12($sslflavour) {
45         // Min versions for TLS 1.2.
46         $versionmatrix = [
47             'OpenSSL' => '1.0.1c',
48             'GnuTLS' => '1.7.1',
49             'NSS' => '3.15.1', // This number is usually followed by something like "Basic ECC".
50             'CyaSSL' => '1.1.0',
51             'wolfSSL' => '1.1.0',
52             'PolarSSL' => '1.2.0',
53             'WinSSL' => '*', // Does not specify a version but needs Windows >= 7.
54             'SecureTransport' => '*' // Does not specify a version but needs iOS >= 5.0 or OS X >= 10.8.0.
55         ];
57         return isset($versionmatrix[$sslflavour]) ? $versionmatrix[$sslflavour] : false;
58     }
60     /**
61      * Validates PHP/cURL extension for use with SSL/TLS.
62      *
63      * @param  array $curlinfo array of cURL information as returned by curl_version()
64      * @param  int   $zts 0 or 1 as defined by PHP_ZTS
65      * @return bool
66      */
67     public static function validate_php_curl_tls(array $curlinfo, $zts) {
68         if (empty($curlinfo['ssl_version'])) {
69             return false;
70         }
72         $flavour = explode('/', $curlinfo['ssl_version'])[0];
73         // In threadsafe mode the only valid choices are OpenSSL and GnuTLS.
74         if ($zts === 1 && $flavour != 'OpenSSL' && $flavour !== 'GnuTLS') {
75             return false;
76         }
78         return true;
79     }
81     /**
82      * Tests if the system is capable of using TLS 1.2 for requests.
83      *
84      * @param  array  $curlinfo array of cURL information as returned by curl_version()
85      * @param  string $uname server uname
86      * @return bool
87      */
88     public static function can_use_tls12(array $curlinfo, $uname) {
89         if ($curlinfo['version_number'] < 467456 || !defined('CURL_SSLVERSION_TLSv1_2')) {
90             return false;
91         }
93         $sslversion = explode('/', $curlinfo['ssl_version']);
94         // NSS has a space in the version number 😦.
95         $flavour = explode(' ', $sslversion[0])[0];
96         $version = count($sslversion) == 2 ? $sslversion[1] : null;
98         $minversion = self::get_min_ssl_lib_version_for_tls12($flavour);
99         if (!$minversion) {
100             return false;
101         }
103         // Special case (see $versionmatrix above).
104         if ($flavour == 'WinSSL') {
105             return $uname >= '6.1';
106         }
108         // Special case (see $versionmatrix above).
109         if ($flavour == 'SecureTransport') {
110             return $uname >= '10.8.0';
111         }
113         return $version >= $minversion;
114     }