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

Copy
1<?php
2
3/**
4 * cURLを使用してFTPサーバーに接続し、SSL/TLSを無効にしてファイルリストを取得する関数です。
5 *
6 * CURLFTPSSL_NONE 定数は、cURLを通じてFTP接続を行う際に、
7 * SSL/TLS (暗号化) を全く使用しないことを明示的に指定するために使われます。
8 * これは、データ転送の安全性が不要、または他の理由でSSL/TLSを無効にする場合に利用されます。
9 *
10 * @param string $ftpHost FTPサーバーのホスト名またはIPアドレス
11 * @param string $ftpUser FTPユーザー名
12 * @param string $ftpPass FTPパスワード
13 * @param int $ftpPort FTPポート番号 (デフォルトは21)
14 * @return array|false ファイルリストの配列、または操作が失敗した場合はfalse
15 */
16function getFtpFileListWithoutSsl(string $ftpHost, string $ftpUser, string $ftpPass, int $ftpPort = 21): array|false
17{
18    // cURLセッションを初期化
19    $ch = curl_init();
20
21    // 接続先のFTP URLを設定
22    // ファイルリストを取得するため、対象ディレクトリ (ここではルート) を指定します。
23    curl_setopt($ch, CURLOPT_URL, "ftp://{$ftpHost}:{$ftpPort}/");
24
25    // FTPサーバーへの認証情報を設定
26    curl_setopt($ch, CURLOPT_USERPWD, "{$ftpUser}:{$ftpPass}");
27
28    // CURLFTPSSL_NONE を使用して、FTP接続でSSL/TLSを無効に設定
29    // CURLOPT_FTP_SSL オプションにこの定数を指定することで、暗号化なしの標準FTP接続を行います。
30    curl_setopt($ch, CURLOPT_FTP_SSL, CURLFTPSSL_NONE);
31
32    // cURLが実行結果を文字列として返すように設定
33    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
34
35    // FTPサーバーからのファイルリストのみを取得するように設定 (NLSTコマンドに相当)
36    curl_setopt($ch, CURLOPT_FTPLISTONLY, true);
37
38    // cURLリクエストを実行
39    $response = curl_exec($ch);
40
41    // cURL操作でエラーが発生した場合の処理
42    if (curl_errno($ch)) {
43        error_log('cURLエラー (' . curl_errno($ch) . '): ' . curl_error($ch));
44        curl_close($ch);
45        return false;
46    }
47
48    // cURLセッションを閉じる
49    curl_close($ch);
50
51    // レスポンスがfalseの場合 (通常はcurl_errnoで捕捉されるが念のため)
52    if ($response === false) {
53        return false;
54    }
55
56    // レスポンス文字列を改行で分割し、空行や余分な空白を除去してファイル名の配列を生成
57    $fileList = array_filter(explode("\n", trim($response)));
58
59    return $fileList;
60}
61
62// --- 使用例 ---
63// IMPORTANT: 実際のFTPサーバー情報に置き換えてください。
64// このコードは、指定されたホスト、ユーザー名、パスワードでFTPサーバーに接続を試みます。
65// セキュリティ上の理由から、本番環境でのクリアテキストパスワードの使用は避けてください。
66$ftpHost = 'your_ftp_host.example.com'; // 例: 'localhost' または FTPサーバーのIPアドレス
67$ftpUser = 'your_ftp_username';         // 例: 'testuser'
68$ftpPass = 'your_ftp_password';         // 例: 'testpassword'
69$ftpPort = 21;                          // 標準的なFTPポート
70
71echo "FTPサーバー {$ftpHost} にSSL/TLSなしで接続し、ファイルリストを取得します..." . PHP_EOL;
72
73$files = getFtpFileListWithoutSsl($ftpHost, $ftpUser, $ftpPass, $ftpPort);
74
75if ($files !== false) {
76    echo "ファイルリスト:" . PHP_EOL;
77    if (empty($files)) {
78        echo "  (ディレクトリは空です)" . PHP_EOL;
79    } else {
80        foreach ($files as $file) {
81            echo "- " . htmlspecialchars($file) . PHP_EOL; // 出力時にHTMLエスケープ
82        }
83    }
84} else {
85    echo "ファイルリストの取得に失敗しました。エラーログを確認してください。" . PHP_EOL;
86}

PHPのCURLFTPSSL_NONE定数は、cURL拡張機能を利用してFTPサーバーに接続する際に、SSL/TLSによる暗号化を全く使用しないことを明示的に指定するためのものです。これにより、データ転送の安全性が不要な場合や、特定のシステムとの連携でSSL/TLSがサポートされていない場合に、暗号化されていない標準的なFTP接続を確立できます。

提示されたサンプルコードでは、getFtpFileListWithoutSslという関数が定義されており、この定数を用いてFTPサーバーにSSL/TLSなしで接続し、そのディレクトリのファイルリストを取得する方法を示しています。この関数は、接続先のFTPサーバーのホスト名（$ftpHost）、ユーザー名（$ftpUser）、パスワード（$ftpPass）、およびポート番号（$ftpPort）を引数として受け取ります。処理が成功した場合はファイル名の配列を、失敗した場合はfalseを戻り値として返します。

コード内では、curl_setopt($ch, CURLOPT_FTP_SSL, CURLFTPSSL_NONE);という行で、cURLのオプションであるCURLOPT_FTP_SSLにCURLFTPSSL_NONEを指定しています。この設定により、cURLはFTP接続においてSSL/TLSによる暗号化を行わず、通常のFTPプロトコルで通信を行います。データが暗号化されないため、セキュリティが確保されない環境での利用は避けるべきです。

Copy
1<?php
2
3/**
4 * 指定されたURLからコンテンツを取得します。
5 * この関数は、cURLのSSL証明書検証オプションの利用方法を示します。
6 *
7 * @param string $url 取得する対象のURL。
8 * @return string|false 成功した場合はURLのコンテンツ、失敗した場合はfalseを返します。
9 */
10function getUrlContentWithoutSslVerification(string $url): string|false
11{
12    // cURLセッションを初期化します。
13    $ch = curl_init();
14
15    // cURLオプションを設定します。
16    // 取得するURLを設定します。
17    curl_setopt($ch, CURLOPT_URL, $url);
18
19    // 実行結果を文字列として返すように設定します。
20    // これを設定しない場合、curl_exec()は直接出力します。
21    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
22
23    // -----------------------------------------------------------
24    // キーワード「CURLOPT_SSL_VERIFYPEER」に関する設定
25    // -----------------------------------------------------------
26    // CURLOPT_SSL_VERIFYPEER は、SSL証明書が本物であるか、信頼できる認証局によって
27    // 署名されているかを確認するかどうかを決定します。
28    //
29    // 通常は `true` (検証する) に設定することを強く推奨します。
30    // `false` に設定すると、中間者攻撃(Man-in-the-middle attack)に対して脆弱になり、
31    // 通信が傍受されるリスクがあります。
32    // 特定のテスト環境や、自己署名証明書を使用している開発環境でのみ、
33    // 慎重な判断の上で `false` を使用することを検討してください。
34    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
35
36    // CURLOPT_SSL_VERIFYHOST は、証明書内のホスト名とリクエストされたホスト名が
37    // 一致するかどうかを検証します。
38    // `CURLOPT_SSL_VERIFYPEER` が `false` の場合、この設定は事実上無効になりますが、
39    // `0` (検証しない) または `2` (ホスト名を検証する) のいずれかを設定します。
40    // `CURLOPT_SSL_VERIFYPEER` を `false` に設定する場合は、通常 `0` を設定します。
41    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
42    // -----------------------------------------------------------
43
44    // cURLリクエストを実行し、結果を取得します。
45    $response = curl_exec($ch);
46
47    // cURL実行中にエラーが発生したかを確認します。
48    if (curl_errno($ch)) {
49        // エラーが発生した場合、エラーメッセージを出力し、falseを返します。
50        error_log('cURLエラー (' . curl_errno($ch) . '): ' . curl_error($ch));
51        $response = false;
52    }
53
54    // cURLセッションを閉じ、リソースを解放します。
55    curl_close($ch);
56
57    return $response;
58}
59
60// --- サンプルコードの実行例 ---
61// 実際にコンテンツを取得するURLを指定します。
62// （セキュリティ上のリスクを理解した上で使用してください。）
63$targetUrl = "https://www.example.com";
64
65echo "指定されたURLからコンテンツを取得します（SSL証明書検証は無効化）。\n";
66echo "URL: " . $targetUrl . "\n\n";
67
68// 関数を呼び出し、コンテンツを取得します。
69$content = getUrlContentWithoutSslVerification($targetUrl);
70
71if ($content !== false) {
72    echo "--- 取得したコンテンツの一部 (最初の200文字) ---\n";
73    echo substr($content, 0, 200) . "...\n";
74    echo "--------------------------------------------------\n";
75} else {
76    echo "コンテンツの取得に失敗しました。\n";
77}
78
79?>

このサンプルコードは、PHPのcURLライブラリを用いて、指定されたURLからコンテンツを取得するgetUrlContentWithoutSslVerification関数を定義しています。この関数は特に、SSL証明書の検証を意図的に無効にする方法を示しています。

関数はまずcurl_init()でcURLセッションを初期化し、curl_setopt()を用いて必要なオプションを設定します。CURLOPT_URLで取得対象のURLを設定し、CURLOPT_RETURNTRANSFERをtrueにすることで、取得したコンテンツが関数の戻り値として文字列で返されるようにします。

このコードの重要な点は、CURLOPT_SSL_VERIFYPEERをfalseに、CURLOPT_SSL_VERIFYHOSTを0に設定している部分です。CURLOPT_SSL_VERIFYPEERは、接続先のSSL証明書が信頼できる認証局によって署名されているかを確認するかどうかを制御します。falseに設定するとこの検証を行いません。CURLOPT_SSL_VERIFYHOSTは、証明書内のホスト名がリクエストされたホスト名と一致するかどうかを検証します。0に設定するとこの検証も行いません。これらの設定により、SSL証明書が不正である場合でも接続が成功しますが、これは中間者攻撃のリスクを高めるため、セキュリティ上の観点から通常は推奨されません。開発環境や特定のテスト目的でのみ慎重に利用を検討すべきです。

設定後、curl_exec()でリクエストを実行し、結果を取得します。curl_errno()でエラーが発生していないかを確認し、エラーがあればログに出力します。最後にcurl_close()でcURLセッションを閉じ、リソースを解放します。

この関数は引数として取得するURL（string $url）を受け取り、正常にコンテンツを取得できた場合はその内容を文字列として返します。何らかの理由で取得に失敗した場合はfalseを返します。