【PHP8.x】CURLINFO_SSL_VERIFYRESULT定数の使い方
CURLINFO_SSL_VERIFYRESULT定数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
CURLINFO_SSL_VERIFYRESULT定数は、PHPのcURL拡張機能において、SSL/TLS証明書の検証結果を表す定数です。この定数は、ウェブサイトやAPIなどとのセキュアな通信、特にHTTPS通信を行う際に、接続先のサーバーが提示するSSL証明書が正当であるかをシステムが検証した結果を取得するために使用されます。
具体的には、curl_getinfo()関数にCURLINFO_SSL_VERIFYRESULT定数を引数として渡すことで、直前に行われたcURL転送におけるSSL証明書検証の最終的な結果コードを取得できます。取得される結果コードが0の場合、SSL証明書の検証は成功し、通信相手のサーバーが信頼できるものであると判断されたことを意味します。一方で、0以外の値が返された場合は、検証が失敗したか、何らかの問題が発生したことを示しており、その値は特定のエラーコードに対応します。
システム開発において、外部サービスとの安全なデータ送受信を確立する際、SSL証明書の検証は極めて重要なセキュリティ対策の一つです。この定数を利用することで、プログラムからSSL証明書の検証状況を詳細に把握し、検証が失敗した場合に適切なエラー処理やログ記録を行うことが可能になります。これにより、アプリケーションのセキュリティと信頼性を高める上で、この定数は重要な役割を担っています。
構文(syntax)
1<?php 2 3$ch = curl_init(); 4curl_setopt($ch, CURLOPT_URL, "https://www.example.com"); 5curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 6 7curl_exec($ch); 8 9// CURLINFO_SSL_VERIFYRESULT 定数を使用して、直前のSSL検証の結果を取得します。 10// 検証が成功した場合は 0 が返され、失敗した場合はエラーコードが返されます。 11$sslVerificationResult = curl_getinfo($ch, CURLINFO_SSL_VERIFYRESULT); 12 13curl_close($ch); 14 15?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
戻り値なし
戻り値はありません
サンプルコード
PHP cURL: SSL検証とレスポンスコード取得
1<?php 2 3/** 4 * 指定されたURLへのcURLリクエストを実行し、SSL証明書の検証結果とHTTPレスポンスコードを表示します。 5 * 6 * この関数は、システムエンジニアを目指す初心者向けに、cURLを使った基本的なHTTPS通信と、 7 * その際のSSL証明書検証結果(CURLINFO_SSL_VERIFYRESULT)およびHTTPレスポンスコード 8 * (CURLINFO_RESPONSE_CODE、キーワードに関連)の取得方法を示します。 9 * 10 * @param string $url リクエストを送信するURL。HTTPSが推奨されます。 11 * @return void 12 */ 13function fetchCurlInfo(string $url): void 14{ 15 // cURLセッションを初期化します。 16 $ch = curl_init(); 17 18 if ($ch === false) { 19 echo "cURLの初期化に失敗しました。\n"; 20 return; 21 } 22 23 // cURLオプションを設定します。 24 // リクエスト先のURLを設定します。 25 curl_setopt($ch, CURLOPT_URL, $url); 26 // 実行結果を文字列として返すように設定します(ブラウザに直接出力しない)。 27 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 28 // HTTPリダイレクトを自動的に追跡するように設定します。 29 curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); 30 // SSL証明書の検証を有効にします。HTTPS通信のセキュリティ確保に重要です。 31 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true); 32 // ホスト名の検証を有効にします。証明書のコモンネーム(CN)がホスト名と一致するか確認します。 33 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2); // PHP 5.x以前は1、PHP 7.x以降は2が推奨されます。 34 35 // cURLリクエストを実行します。 36 $response = curl_exec($ch); 37 38 if ($response === false) { 39 // エラーが発生した場合、エラーメッセージを表示します。 40 echo "cURLリクエストの実行中にエラーが発生しました: " . curl_error($ch) . "\n"; 41 } else { 42 // cURLから情報を取得します。 43 // CURLINFO_SSL_VERIFYRESULT: SSL証明書の検証結果を取得します。 44 // 0は検証成功を意味し、それ以外の値はエラーコードを示します。 45 $sslVerifyResult = curl_getinfo($ch, CURLINFO_SSL_VERIFYRESULT); 46 47 // CURLINFO_RESPONSE_CODE: HTTPレスポンスコード(例: 200 OK, 404 Not Found)を取得します。 48 $httpResponseCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE); 49 50 echo "対象URL: " . $url . "\n"; 51 echo "--------------------------------------------------\n"; 52 echo "SSL証明書検証結果 (CURLINFO_SSL_VERIFYRESULT): " . $sslVerifyResult . "\n"; 53 if ($sslVerifyResult === 0) { 54 echo " (0 はSSL証明書の検証成功を意味します。)\n"; 55 } else { 56 echo " (0 以外はSSL証明書の検証失敗を意味します。)\n"; 57 } 58 echo "HTTPレスポンスコード (CURLINFO_RESPONSE_CODE): " . $httpResponseCode . "\n"; 59 echo "--------------------------------------------------\n"; 60 // 必要であれば、レスポンス内容の一部を表示することも可能です。 61 // echo "レスポンスの抜粋:\n" . substr($response, 0, 200) . "...\n"; 62 } 63 64 // cURLセッションを閉じ、リソースを解放します。 65 curl_close($ch); 66} 67 68// この関数を呼び出して、サンプルとしてGoogleのURLで動作を確認します。 69// 実際にこのコードを実行して、出力される情報を見てみましょう。 70fetchCurlInfo("https://www.google.com"); 71 72// 例として、意図的にSSL検証エラーを発生させる可能性のあるサイトや、存在しないURLを試すこともできます。 73// ただし、これらのURLは常に安定しているわけではありません。 74// fetchCurlInfo("https://expired.badssl.com/"); // 有効期限切れのSSL証明書を持つサイト 75// fetchCurlInfo("https://untrusted-root.badssl.com/"); // 信頼されていないルート証明書を持つサイト 76// fetchCurlInfo("https://example.com/nonexistent-page"); // 存在しないページ(404エラーになるはず) 77 78?>
このサンプルコードは、PHPのcURL拡張機能を用いて、ウェブサイトへのHTTPSリクエストを実行し、その際のSSL証明書検証結果とHTTPレスポンスコードを確認する方法を、システムエンジニアを目指す初心者向けに示しています。
fetchCurlInfo関数は、引数として指定された$urlに対し、cURLセッションを初期化し、各種オプションを設定後にリクエストを実行します。特に重要なのは、CURLOPT_SSL_VERIFYPEERとCURLOPT_SSL_VERIFYHOSTを有効にすることで、通信先のSSL証明書が信頼できるものか、また証明書のホスト名がリクエスト先のURLと一致するかを厳密に検証している点です。
リクエスト実行後、curl_getinfo()関数を利用して、PHP 8で利用可能なCURLINFO_SSL_VERIFYRESULT定数によりSSL証明書の検証結果を取得します。この値が0であれば検証成功を意味し、それ以外の値は検証失敗のエラーコードを示します。また、キーワードにも含まれるCURLINFO_RESPONSE_CODE定数を使用することで、HTTPレスポンスコード(例: 200 OKや404 Not Found)を取得し、リクエストが正常に処理されたか、またはどのような問題が発生したかを判断できます。
このfetchCurlInfo関数は、引数$urlとしてリクエスト先のURLを受け取り、処理結果を直接画面に出力するため、具体的な戻り値はvoidです。これにより、安全なHTTPS通信の基本と、その通信結果から得られる重要な情報を効率的に取得し、セキュリティやリクエストの成否を判断する手法を学ぶことができます。
cURL通信では、まずcurl_init()とcurl_exec()の戻り値を必ず確認し、失敗時にはcurl_error()関数で詳細なエラー情報を取得して対応することが重要です。特にCURLOPT_SSL_VERIFYPEERとCURLOPT_SSL_VERIFYHOSTの設定は、通信のセキュリティを保つために非常に重要ですので、安易に無効化すると中間者攻撃などのセキュリティリスクが高まることに注意してください。CURLINFO_SSL_VERIFYRESULTの値は、0がSSL証明書検証の成功を意味し、それ以外の数値はエラーを示します。この特殊な意味を正確に理解して処理に利用してください。また、CURLINFO_RESPONSE_CODEはHTTPステータスコードを表し、ウェブサーバーからの応答状態を判断するのに役立ちます。処理の最後には、必ずcurl_close()でリソースを解放することを忘れないでください。
PHP cURL: HTTPコードとSSL検証結果を取得する
1<?php 2 3/** 4 * 指定されたURLからウェブサーバー情報を取得します。 5 * 6 * システムエンジニアを目指す初心者向けに、cURLを使った基本的なHTTPリクエストと 7 * 重要な情報の取得方法を示します。 8 * 9 * @param string $url 情報を取得するターゲットURL。 10 * @return array|false 取得した情報を含む連想配列、またはエラー時にfalse。 11 * 返される情報にはHTTPステータスコードとSSL検証結果が含まれます。 12 */ 13function getWebServerInfo(string $url) 14{ 15 // cURLセッションを初期化します。 16 $ch = curl_init($url); 17 18 // cURLセッションの初期化に失敗した場合はエラーをログに記録し、falseを返します。 19 if ($ch === false) { 20 error_log("cURLセッションの初期化に失敗しました。URL: " . $url); 21 return false; 22 } 23 24 // サーバーからの応答を直接出力せず、文字列として取得するように設定します。 25 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 26 // HTTPリダイレクト(例: 301, 302ステータス)を自動的に追跡するように設定します。 27 curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); 28 // SSL証明書の検証を有効にします。これにより、CURLINFO_SSL_VERIFYRESULT の値が意味を持ちます。 29 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true); 30 // ホスト名の検証を有効にします。これもSSL検証の一部です。 31 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2); 32 33 // cURLセッションを実行し、ウェブサーバーからの応答を取得します。 34 $response = curl_exec($ch); 35 36 // cURLリクエスト中にエラーが発生したか確認します。 37 if (curl_errno($ch)) { 38 $error_message = curl_error($ch); 39 error_log("cURLリクエストエラー発生: " . $error_message . " (URL: " . $url . ")"); 40 curl_close($ch); 41 return false; 42 } 43 44 // HTTPステータスコードを取得します。 45 // 例: 200 (OK), 404 (Not Found), 500 (Internal Server Error) など。 46 // これはキーワード (CURLINFO_HTTP_CODE) に最も関連性の高い情報です。 47 $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); 48 49 // SSL証明書検証の結果を取得します。 50 // 0 は検証成功、0以外の値はエラーを示します。 51 // これはリファレンス情報 (CURLINFO_SSL_VERIFYRESULT) に記載されている定数です。 52 $sslVerifyResult = curl_getinfo($ch, CURLINFO_SSL_VERIFYRESULT); 53 54 // cURLセッションを閉じ、リソースを解放します。 55 curl_close($ch); 56 57 // 取得した情報を連想配列として返します。 58 return [ 59 'http_code' => $httpCode, 60 'ssl_verify_result' => $sslVerifyResult, 61 'response_body_length' => strlen((string)$response), // 取得した応答ボディの長さを追加 62 ]; 63} 64 65// --- サンプル使用例 --- 66$targetUrl = "https://www.php.net/"; 67 68echo "ターゲットURL: " . $targetUrl . "\n"; 69 70$info = getWebServerInfo($targetUrl); 71 72if ($info !== false) { 73 echo "HTTPステータスコード: " . $info['http_code'] . "\n"; 74 echo "SSL検証結果 (0=成功, 0以外=失敗): " . $info['ssl_verify_result'] . "\n"; 75 echo "応答ボディの長さ: " . $info['response_body_length'] . " バイト\n"; 76 77 // HTTPステータスコードに基づいて簡単なメッセージを表示します。 78 if ($info['http_code'] >= 200 && $info['http_code'] < 300) { 79 echo "HTTPステータス: リクエストは成功しました。\n"; 80 } elseif ($info['http_code'] >= 300 && $info['http_code'] < 400) { 81 echo "HTTPステータス: リダイレクトが発生しました。\n"; 82 } elseif ($info['http_code'] >= 400 && $info['http_code'] < 500) { 83 echo "HTTPステータス: クライアントエラーが発生しました。\n"; 84 } elseif ($info['http_code'] >= 500 && $info['http_code'] < 600) { 85 echo "HTTPステータス: サーバーエラーが発生しました。\n"; 86 } else { 87 echo "HTTPステータス: 不明なコードです。\n"; 88 } 89 90 // SSL検証結果に基づいてメッセージを表示します。 91 if ($info['ssl_verify_result'] === 0) { 92 echo "SSL検証: 成功しました。安全な接続です。\n"; 93 } else { 94 echo "SSL検証: 失敗しました。セキュリティ上の懸念がある可能性があります。\n"; 95 } 96} else { 97 echo "ウェブサーバー情報の取得に失敗しました。ログを確認してください。\n"; 98} 99 100?>
このサンプルコードは、PHPのcURL拡張機能を使って指定されたURLからウェブサーバー情報を取得する方法を、システムエンジニアを目指す初心者向けに示しています。getWebServerInfo関数は引数にターゲットURL(文字列)を受け取り、ウェブサーバーのHTTPステータスコードとSSL検証結果を含む連想配列を返します。エラーが発生した場合はfalseを返します。
関数内では、まずcurl_initでcURLセッションを初期化し、curl_setoptで応答を文字列として取得したり、HTTPリダイレクトを自動で追跡したりする設定を行います。特に、CURLOPT_SSL_VERIFYPEERとCURLOPT_SSL_VERIFYHOSTを有効にすることで、SSL証明書の検証が正しく行われるようにしています。
curl_execでHTTPリクエストを実行した後、curl_getinfo関数を使って重要な情報を取得します。CURLINFO_HTTP_CODEは、ウェブサーバーからの応答を示すHTTPステータスコード(例:200 OK、404 Not Foundなど)を取得するために使われます。これはリクエストが成功したか、エラーが発生したかなどを判断するのに役立ちます。また、CURLINFO_SSL_VERIFYRESULTは、SSL証明書の検証が成功したか(0)、失敗したか(0以外)の結果を取得します。これにより、接続の安全性をプログラムで確認できます。
最後にcurl_closeでcURLセッションを閉じ、取得した情報を返します。サンプル使用例では、返された情報に基づいて、HTTPステータスやSSL検証の結果に応じたメッセージを表示しており、これによりウェブサイトの接続状況やセキュリティ状態を簡単に把握できます。
このコードは、ウェブサーバー通信のセキュリティとエラーハンドリングが重要であることを示しています。特にCURLOPT_SSL_VERIFYPEERとCURLOPT_SSL_VERIFYHOSTの設定を有効にしないと、CURLINFO_SSL_VERIFYRESULTが正確な結果を示さず、セキュリティリスクとなります。本番環境ではこれらを必ず有効にしてください。また、curl_errno()とcurl_error()を用いてcURLのエラーを常に捕捉し、適切に処理することが不可欠です。処理後はcurl_close()でリソースを解放する習慣をつけましょう。HTTPステータスコードとSSL検証結果は、通信の成否と安全性を判断する重要な指標です。