【PHP8.x】setcookie関数の使い方

Copy
1<?php
2
3/**
4 * SameSite属性を含むHTTPクッキーを設定する関数。
5 *
6 * システムエンジニアを目指す初心者向けに、PHPのsetcookie関数を使用して
7 * SameSite属性を含むセキュアなクッキーを設定する方法を示します。
8 * SameSite属性は、クロスサイトリクエストフォージェリ (CSRF) 攻撃からの保護に役立ちます。
9 *
10 * @param string $name クッキーの名前
11 * @param string $value クッキーの値
12 * @return bool クッキーの設定が成功した場合はtrue、それ以外はfalse
13 */
14function setSecureSameSiteCookie(string $name, string $value): bool
15{
16    // クッキーの有効期限を設定 (例: 現在時刻から1時間後)
17    $expire = time() + (60 * 60);
18
19    // PHP 7.3 以降では、setcookie関数に連想配列でオプションを指定できます。
20    $options = [
21        'expires'  => $expire,           // クッキーの有効期限 (Unixタイムスタンプ)
22        'path'     => '/',               // クッキーが有効なパス (通常はサイト全体を示す '/')
23        'domain'   => '',                // クッキーが有効なドメイン (空にすると現在のドメインに自動設定)
24        'secure'   => true,              // HTTPS接続時のみクッキーを送信する (本番環境では 'true' を強く推奨)
25        'httponly' => true,              // JavaScriptからクッキーにアクセスできないようにする (XSS対策)
26        'samesite' => 'Lax',             // SameSite属性を設定 ('Lax', 'Strict', 'None' のいずれか)
27                                         // 'Lax': ユーザーがナビゲートする際のいくつかのクロスサイトリクエストでクッキーを送信
28                                         // 'Strict': 同一サイトリクエスト時のみクッキーを送信
29                                         // 'None': クロスサイトリクエストでもクッキーを送信するが、'secure'がtrueであること必須
30    ];
31
32    // setcookie関数でクッキーを設定
33    // setcookieはHTTPヘッダーを送信するため、この関数が呼び出される前に
34    // いかなる出力もあってはなりません。
35    $cookieSet = setcookie($name, $value, $options);
36
37    // クッキー設定の結果を出力（デバッグ用）
38    if ($cookieSet) {
39        echo "クッキー '{$name}' が正常に設定されました。<br>";
40        echo "値: '{$value}'<br>";
41        echo "SameSite属性: '{$options['samesite']}'<br>";
42        echo "Secure: " . ($options['secure'] ? 'true' : 'false') . "<br>";
43    } else {
44        // 通常、このエラーはsetcookieがHTTPヘッダー送信後に呼び出された場合に発生します。
45        echo "エラー: クッキー '{$name}' の設定に失敗しました。ヘッダーが既に送信されている可能性があります。<br>";
46    }
47
48    return $cookieSet;
49}
50
51// === サンプルコードの実行 ===
52// setcookie関数はHTTPヘッダーを送信するため、スクリプトの実行開始時に呼び出す必要があります。
53// 既に何らかの出力が行われている場合、クッキーは設定されません。
54if (headers_sent($file, $line)) {
55    echo "警告: ヘッダーが既に {$file} の {$line} 行目で送信されているため、クッキーを設定できませんでした。<br>";
56} else {
57    // 例1: ユーザーセッションIDをSameSite=Laxで設定
58    setSecureSameSiteCookie('user_session_id', 'a1b2c3d4e5f6');
59
60    echo "<br>";
61
62    // 例2: 言語設定をSameSite=Laxで設定
63    setSecureSameSiteCookie('preferred_language', 'en');
64}
65
66// 注意: 設定されたクッキーは、次のリクエストから $_COOKIE スーパーグローバル変数でアクセス可能になります。
67// 例えば、このページをブラウザでリロードすると、$_COOKIE['user_session_id'] などが利用可能になります。
68// var_dump($_COOKIE); // この行は、現在のリクエストで受信したクッキーを表示します。
69                    // 設定したクッキーがすぐには表示されないことに注意してください。
70?>

PHPのsetcookie関数は、ウェブブラウザに情報を一時的に保存する「クッキー」を設定するために使用されます。この関数は、ユーザーの状態を維持したり、設定を記憶したりする際に非常に重要です。

setcookie関数は、設定したいクッキーの名前と値を指定するのが基本です。PHP 7.3以降では、セキュリティや動作に関する詳細なオプションを連想配列として第3引数に渡すことができます。例えば、expiresで有効期限、pathでクッキーが有効なパス、domainで有効なドメインを指定します。

特に重要なオプションとして、secureをtrueに設定するとHTTPS接続時のみクッキーが送信され、httponlyをtrueに設定するとJavaScriptからのアクセスが制限され、クロスサイトスクリプティング（XSS）攻撃の対策となります。

さらに、クロスサイトリクエストフォージェリ（CSRF）攻撃から保護するためのsamesite属性も設定できます。samesiteにはLax、Strict、Noneのいずれかを指定し、クッキーを送信する条件を制御します。Laxは一般的な利用で推奨され、ユーザーがサイト間を移動する際の安全性を保ちます。Strictは同一サイトからのリクエストのみを許可し、Noneはクロスサイトリクエストでも許可しますが、secure属性が必須です。

この関数はクッキーの設定が成功した場合はtrue、失敗した場合はfalseを論理値として返します。setcookieはHTTPヘッダーを送信する性質上、この関数が呼び出される前にいかなる出力も行ってはならない点に注意が必要です。設定されたクッキーは、次のHTTPリクエストから$_COOKIEスーパーグローバル変数を通じてアクセスできるようになります。

Copy
1<?php
2
3/**
4 * クッキーを設定し、有効期限を指定するサンプルコード
5 *
6 * このスクリプトは、ブラウザに「user_preference」という名前のクッキーを設定します。
7 * クッキーの値は「dark_mode」で、有効期限は現在の時刻から1時間後です。
8 *
9 * setcookie()関数は、HTTPレスポンスヘッダーの一部としてクッキー情報を送信します。
10 * このため、setcookie()関数は、いかなるHTML出力やecho文よりも前に呼び出す必要があります。
11 */
12
13// クッキーの名前と値を定義
14$cookie_name = "user_preference";
15$cookie_value = "dark_mode";
16
17// 有効期限をUNIXタイムスタンプで計算
18// time() は現在のUNIXタイムスタンプを返します。
19// 60秒 * 60分 = 3600秒 (1時間)
20$expiration_time = time() + (60 * 60); // 現在時刻から1時間後に有効期限切れ
21
22// setcookie()関数を使ってクッキーを設定
23// 引数: 名前, 値, 有効期限, パス, ドメイン, セキュア, HTTP Only
24$cookie_set_success = setcookie(
25    $cookie_name,       // クッキーの名前
26    $cookie_value,      // クッキーの値
27    $expiration_time,   // 有効期限 (UNIXタイムスタンプ)。この例では1時間後。
28    '/',                // クッキーが有効なサーバーパス。'/'はドメイン全体で有効。
29    '',                 // クッキーが有効なドメイン。空欄は現在のドメイン。
30    false,              // セキュア: trueにするとHTTPS接続でのみ送信される。初心者向けにfalse。
31    true                // HTTP Only: trueにするとJavaScriptからのアクセスを禁止し、セキュリティを高める。
32);
33
34// クッキーの設定結果を表示
35if ($cookie_set_success) {
36    echo "<h1>クッキーの設定が成功しました！</h1>";
37    echo "<p>以下のクッキーがブラウザに設定されました。</p>";
38    echo "<ul>";
39    echo "<li><strong>名前:</strong> '{$cookie_name}'</li>";
40    echo "<li><strong>値:</strong> '{$cookie_value}'</li>";
41    echo "<li><strong>有効期限:</strong> " . date('Y-m-d H:i:s', $expiration_time) . " (現在時刻から1時間後)</li>";
42    echo "<li><strong>パス:</strong> /</li>";
43    echo "<li><strong>HTTP Only:</strong> はい</li>";
44    echo "</ul>";
45    echo "<p>ブラウザの開発者ツール（F12キーで開くことが多い）の「アプリケーション」または「ストレージ」タブから、クッキーを確認できます。</p>";
46    echo "<p>このページをリロードすると、ブラウザが設定されたクッキーをサーバーに送信します。</p>";
47} else {
48    echo "<h1>クッキーの設定に失敗しました。</h1>";
49    echo "<p>原因として、すでに何らかの出力が行われている可能性があります。</p>";
50}
51
52?>

PHPのsetcookie関数は、ウェブブラウザにクッキー（Cookie）を設定するために使用されます。クッキーは、ユーザーのブラウザに少量の情報を保存し、次回アクセス時にその情報を利用できるようにする仕組みです。この関数は、HTTPレスポンスヘッダーの一部としてクッキー情報を送信するため、HTML出力やecho文など、コンテンツの出力よりも前に呼び出す必要があります。

引数$nameでクッキーの名前、$valueでその値を指定します。最も重要な機能の一つが有効期限の設定で、$expires_or_options引数にUNIXタイムスタンプ形式で指定します。サンプルコードではtime()関数で現在時刻を取得し、それに秒数を加算することで「現在時刻から1時間後」という有効期限を設定しています。これにより、指定した時間が経過するとブラウザからクッキーが自動的に削除されます。

また、$pathでクッキーが有効なパスを、$domainで有効なドメインを指定できます。$secureをtrueにするとHTTPS接続でのみクッキーが送信され、$httponlyをtrueにするとJavaScriptからのクッキーアクセスを禁止し、セキュリティを高めることができます。

setcookie関数は、クッキーの設定に成功した場合はtrueを、失敗した場合はfalseをブール値で返します。この戻り値を確認することで、クッキーが正しく設定されたかどうかの判定が可能です。このようにsetcookie関数は、ユーザーの状態を管理する上で重要な役割を果たします。