【PHP8.x】CURL_SSLVERSION_MAX_DEFAULT定数の使い方

Copy
1<?php
2
3/**
4 * Demonstrates the CURL_SSLVERSION_MAX_DEFAULT constant.
5 *
6 * This constant represents the maximum SSL/TLS protocol version that cURL
7 * will attempt to negotiate by default when CURLOPT_SSLVERSION is not
8 * explicitly set. It reflects the highest supported default version by cURL
9 * in its current build.
10 */
11function demonstrateCurlSslVersionMaxDefault(): void
12{
13    // Output the value of the constant for inspection.
14    echo "Value of CURL_SSLVERSION_MAX_DEFAULT: " . CURL_SSLVERSION_MAX_DEFAULT . PHP_EOL;
15    echo "This value is an internal representation of the highest SSL/TLS version" . PHP_EOL;
16    echo "cURL will try to use by default when connecting to a server." . PHP_EOL;
17    echo "It helps to understand cURL's default security posture regarding SSL/TLS protocols." . PHP_EOL;
18    echo PHP_EOL;
19
20    // Initialize a cURL session to demonstrate the context.
21    // We will make a simple request without explicitly setting CURLOPT_SSLVERSION.
22    // This allows cURL to use its default negotiation strategy, which is
23    // internally limited by CURL_SSLVERSION_MAX_DEFAULT.
24    $ch = curl_init('https://www.google.com/');
25
26    if ($ch === false) {
27        echo "Error: Failed to initialize cURL." . PHP_EOL;
28        return;
29    }
30
31    // Set options for a simple HEAD request to avoid downloading page content.
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Return the transfer as a string
33    curl_setopt($ch, CURLOPT_HEADER, false);       // Don't return headers
34    curl_setopt($ch, CURLOPT_NOBODY, true);        // Only fetch headers (HEAD request)
35    curl_setopt($ch, CURLOPT_TIMEOUT, 10);         // Set a timeout for the request
36
37    echo "Performing a cURL request to 'https://www.google.com/' without explicitly setting CURLOPT_SSLVERSION." . PHP_EOL;
38    echo "This operation relies on cURL's default SSL/TLS version negotiation," . PHP_EOL;
39    echo "which is internally capped by CURL_SSLVERSION_MAX_DEFAULT." . PHP_EOL;
40    echo PHP_EOL;
41
42    $response = curl_exec($ch);
43
44    if (curl_errno($ch)) {
45        echo "cURL Error: " . curl_error($ch) . PHP_EOL;
46    } else {
47        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
48        $protocol = curl_getinfo($ch, CURLINFO_PROTOCOL); // e.g., HTTP/2, HTTP/1.1
49
50        echo "cURL request completed successfully." . PHP_EOL;
51        echo "HTTP Status Code: " . $httpCode . PHP_EOL;
52        echo "Protocol Used: " . $protocol . PHP_EOL;
53        echo "Note: The exact SSL/TLS version negotiated is not directly available via simple getinfo." . PHP_EOL;
54        echo "However, the negotiation occurs within the bounds defined by cURL's defaults," . PHP_EOL;
55        echo "which are influenced by CURL_SSLVERSION_MAX_DEFAULT." . PHP_EOL;
56    }
57
58    // Close the cURL session.
59    curl_close($ch);
60}
61
62// Execute the demonstration function.
63demonstrateCurlSslVersionMaxDefault();
64
65?>

CURL_SSLVERSION_MAX_DEFAULTは、PHPのcURL拡張機能で利用できる定数です。この定数は、cURLがサーバーとSSL/TLS通信を行う際に、デフォルトで利用しようとするSSL/TLSプロトコルの最大バージョンを示します。具体的には、CURLOPT_SSLVERSIONオプションを明示的に設定しない場合に、cURLが通信時に採用するSSL/TLSバージョン交渉の上限を決定します。

サンプルコードでは、まずCURL_SSLVERSION_MAX_DEFAULT定数の具体的な値を出力し、それがcURLのデフォルトのセキュリティ設定、特にSSL/TLSプロトコルに関する姿勢を理解するのに役立つことを示しています。次に、CURLOPT_SSLVERSIONオプションをあえて設定せずに、GoogleへのcURLリクエストを実行しています。これにより、cURLが内部的にこの定数によって制限されるデフォルトのSSL/TLSバージョン交渉で通信を行う様子を間接的に示し、成功したHTTPステータスコードと使用されたプロトコルを出力しています。

この定数には引数がなく、また、何らかの値を戻すものでもありません。定数として直接その値を取得し、cURLがデフォルトでどの程度のセキュリティレベルのSSL/TLSプロトコルを使用するのかを把握するために利用します。システムのセキュリティ要件を検討する際の参考情報として活用できるでしょう。

Copy
1<?php
2
3/**
4 * 指定されたURLからデータを取得します。
5 * SSL証明書の検証を無効にし、SSLプロトコルバージョンはCURLに任せます。
6 *
7 * !!! 注意: CURLOPT_SSL_VERIFYPEER および CURLOPT_SSL_VERIFYHOST を false に設定すると、
8 * !!! セキュリティリスクが高まります。本番環境での使用は極力避け、
9 * !!! 開発環境や特定の内部システムでのみ、必要性を十分に理解した上で限定的に使用してください。
10 *
11 * @param string $url データを取得するターゲットURL
12 * @return string|null 取得したデータ、またはエラーの場合はnull
13 */
14function fetchDataWithIgnoredSsl(string $url): ?string
15{
16    // cURLセッションを初期化します。
17    $ch = curl_init();
18
19    if ($ch === false) {
20        echo "cURL初期化に失敗しました。\n";
21        return null;
22    }
23
24    // 取得対象のURLを設定します。
25    curl_setopt($ch, CURLOPT_URL, $url);
26
27    // 取得したデータを直接出力せず、戻り値として文字列で受け取るように設定します。
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29
30    // PHP 8ではCURL_SSLVERSION_MAX_DEFAULTが利用可能です。
31    // これはCURLライブラリがサポートする最新かつ最も安全なSSL/TLSプロトコルバージョンを自動的に選択します。
32    // 明示的に指定しない場合でも、多くの場合CURLのデフォルト動作と同じですが、
33    // ここではリファレンス情報に基づき、この定数を使用する例として含めます。
34    curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_MAX_DEFAULT);
35
36    // キーワード「ssl 無視」に対応するため、SSL証明書の検証を無効にします。
37    // これにより、自己署名証明書や期限切れの証明書を持つサイトでも接続が可能になります。
38    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // ピア（サーバー）の証明書検証を無効化
39    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // ホスト名の検証を無効化 (PHP 5.6以降ではCURLOPT_SSL_VERIFYPEERがfalseなら実質不要な場合が多い)
40
41    // cURLセッションを実行し、レスポンスを取得します。
42    $response = curl_exec($ch);
43
44    // cURLの実行中にエラーが発生したかを確認します。
45    if (curl_errno($ch)) {
46        echo 'cURL エラー: ' . curl_error($ch) . "\n";
47        $response = null; // エラー発生時はnullを返す
48    }
49
50    // cURLセッションを閉じ、リソースを解放します。
51    curl_close($ch);
52
53    return $response;
54}
55
56// --------------------------------------------------------------------------
57// サンプルコードの使用例
58// --------------------------------------------------------------------------
59
60// テスト用のURLを設定します。
61// 実際には、自己署名証明書を使用しているAPIエンドポイントなど、
62// SSL証明書検証を無視したい特定のHTTPS URLを指定してください。
63// 例: $targetUrl = 'https://self-signed-cert-example.com/api/data';
64$targetUrl = 'https://example.com/'; // 例として一般的なHTTPSサイトを使用
65
66echo "URL: '{$targetUrl}' からデータを取得します。\n";
67echo "注意: このコードはセキュリティリスクを高める可能性のあるSSL検証無視設定を含みます。\n\n";
68
69$data = fetchDataWithIgnoredSsl($targetUrl);
70
71if ($data !== null) {
72    echo "データ取得に成功しました。\n";
73    // 取得したデータの一部を表示します。
74    echo "取得データ（最初の200文字）:\n";
75    echo substr($data, 0, 200) . "...\n";
76} else {
77    echo "データ取得に失敗しました。\n";
78}
79

このサンプルコードは、PHPのcURL拡張機能を使って指定されたURLからデータを取得するfetchDataWithIgnoredSsl関数を解説しています。この関数は、取得したいURLを示す文字列型の$urlを引数に取ります。処理が成功した場合は取得したデータを文字列として返し、エラーが発生した場合はnullを返します。

関数内では、まずcURLセッションを初期化し、CURLOPT_URLでターゲットURLを設定しています。CURLOPT_RETURNTRANSFERをtrueにすることで、取得したデータを直接出力せず、関数の戻り値として受け取れるように設定しています。

PHP 8で利用可能なCURL_SSLVERSION_MAX_DEFAULTは、CURLOPT_SSLVERSIONオプションに設定することで、SSL/TLSプロトコルのバージョン選択をcURLライブラリに任せ、自動的に最新かつ最も安全なプロトコルが選択されるよう設定しています。これにより、プロトコルの互換性とセキュリティを両立させます。

また、キーワード「ssl 無視」に対応するため、CURLOPT_SSL_VERIFYPEERとCURLOPT_SSL_VERIFYHOSTをfalseに設定し、SSL証明書の検証を無効にしています。この設定により、自己署名証明書や期限切れの証明書を持つサイトへも接続可能になりますが、セキュリティリスクが大幅に高まりますので、本番環境での使用は極力避け、開発環境など限定的な状況で、その必要性を十分に理解した上で慎重に利用してください。

最後にcurl_execでリクエストを実行し、エラーが発生した場合はその情報を表示し、cURLセッションを閉じます。