v0.21

セッション

はじめに

http駆動のアプリケーションはステートレスであるためセッションは複数のリクエストにわたってユーザーに関する情報を保存する手段を提供します。dframeworkは基盤となるストレージドライバーに関係なくセッションデータを操作するためのエレガントでグローバルに利用可能なSessionファサードを提供します。

設定

すべてのセッション設定はconfig/session.jsでのみ定義されます。セッションドライバーはdriver(memory、database、またはstealth)によって決定されセッションクッキー名はcookie(デフォルトはsid)によって定義されます。

セッションの有効期間

セッションの有効期間はセッションが期限切れになるまでにアクティブな状態を維持する時間を決定します。lifetimeを使用して分単位で期間を設定できます(デフォルトは120分)。

1// config/session.js
2import { Env } from 'dframework';
3
4export default {
5 driver: Env.value('SESSION_DRIVER', 'memory'),
6 cookie: Env.value('SESSION_COOKIE', 'sid'),
7 lifetime: Env.value('SESSION_LIFETIME', 120),
8 domain: Env.value('SESSION_DOMAIN', null),
9 path: Env.value('SESSION_PATH', '/'),
10 same_site: Env.value('SESSION_SAME_SITE', 'Lax'),
11 http_only: Env.value('SESSION_HTTP_ONLY', true),
12 secure: Env.value('SESSION_SECURE', null),
13};

クッキーのオプション

config/session.jsでセッションクッキーのセキュリティ属性を設定できます。

セッションの操作

データの取得

セッションからアイテムを取得するにはグローバルのSessionファサードのgetメソッドを使用します。第2引数としてデフォルト値を渡すことができ指定されたキーが存在しない場合にその値が返されます。

1// retrieve a specific key
2const value = await Session.get('key');
3
4// retrieve a key with a default fallback
5const name = await Session.get('name', 'guest');

データの保存

セッションにデータを保存するにはsetメソッドを使用します。

1await Session.set('key', 'value');

データを恒久的に保存する必要がある場合(10年間の長期有効クッキーを使用)はpermanentメソッドを使用します。キーと値のペアまたはオブジェクトを渡すことができます。

1await Session.permanent('role', 'admin');
2await Session.permanent({ role: 'admin', accepted_terms: true });

フラッシュデータ

次のリクエストのためだけにアイテムをセッションに保存したい場合があります。その場合はflashメソッドを使用できます。このメソッドを使用して保存されたデータは即座に利用可能となりその直後のhttpリクエストの間保持された後自動的に削除されます。これは短命なステータスメッセージに非常に役立ちます。

1await Session.flash('status', 'profile updated successfully');

データの削除

セッションからデータの一部を削除するにはforgetメソッドを使用して特定のキーを渡します。引数なしでforgetを呼び出した場合セッション全体が破棄されクッキーが無効化されます。

1// forget a single key
2await Session.forget('key');
3
4// destroy the entire session
5await Session.forget();
6
7// remove all data from the current session including authentication data
8await Session.flush();
NOTE

`Session.flush()`は現在のセッションに保存されているすべてのデータ(認証情報やカスタムペイロードキーを含む)を削除しセッションを無効化します。セッションを維持したまま単一のキーを選択して削除するには`Session.forget(key)`を呼び出します。

セッションIDと再生成

アクティブなセッション識別子を取得したりカスタム識別子を設定したりするにはidメソッドを使用します。

1// retrieve the current session id
2const sessionId = Session.id();

ユーザー権限が変更された際(ログインやパスワードリセット時など)のセッション固定化攻撃を防ぐにはregenerateメソッドを使用します。デフォルトでは既存のセッションデータを保持したまま新しいセッションIDとクッキーを発行します。すべてのデータを消去して新しいセッションを発行するにはfalseを渡します。

1// regenerate session id while keeping existing session data
2await Session.regenerate();
3
4// regenerate session id and clear all existing session data
5await Session.regenerate(false);

セッションドライバー

dframeworkはセッションストレージの複雑さをシンプルなドライバーの背後に抽象化しています。

ステルスモード

dframeworkにはプライバシーとゼロステートアーキテクチャのために設計されたstealthセッションドライバーが含まれています。

ステルスモードが有効な場合(SESSION_DRIVER=stealth)セッションストレージはデータベースクエリゼロ、redisネットワーク往復ゼロ、サーバーメモリ消費ゼロで動作します。

1// config/session.js
2import { Env } from 'dframework';
3
4export default {
5 driver: Env.value('SESSION_DRIVER', 'stealth'),
6 cookie: Env.value('SESSION_COOKIE', 'sid'),
7 lifetime: Env.value('SESSION_LIFETIME', 120),
8 same_site: 'Lax',
9 http_only: true,
10 secure: null
11};

ステルスセッションの仕組み

セッションペイロード全体はアプリケーション秘密鍵(APP_KEY)を使用してaes 256 gcmでシリアライズおよび暗号化されます。結果として得られる暗号化トークン文字列がセッション識別子として機能し設定されたhttp onlyクッキーでブラウザに返送されます。

受信リクエスト時フレームワークはクッキーを復号します。クッキーが攻撃者によって改ざんまたは変更されている場合復号は安全に失敗しapp.debugが有効な場合にデバッグ警告をログに記録して空のゲストセッションを初期化します。

暗号化されたペイロードの内部には有効期限タイムスタンプが埋め込まれています。セッション状態を保存する際ドライバーは有効期限ウィンドウを自動的に更新するか将来の有効期限日(永続セッションなど)を保持します。期限切れのセッションはnullを返し破棄されます。

セッション全体がhttpクッキーヘッダー内に保存されるため保存するデータは最小限に抑える必要があります(webブラウザのクッキーサイズ制限内に安全に収めるため厳格に4kb未満にする必要があります)。ステルスモードはユーザー識別子、認証トークン、最小限の設定情報に最適ですが大きな配列やかさばるオブジェクトの保存には使用しないでください。

サーバー上にはセッション行もファイルも存在しないためマイグレーションするデータベーステーブルはなく定期的なガベージコレクションコマンドも不要です。