Django は、匿名のセッションをフルサポートしています。このセッションフレームワークを使えば、任意のデータを、サイトの訪問者ごとに保存し、取得することができます。データはサーバー側に保存され、クッキーの送受信によって抽象化します。クッキーには、データそのものではなくセッション ID が書かれています ( クッキーベースのバックエンド を使用しない限り)。
\nセッションは、 ミドルウェア の1つを使って実装されています。
\nセッションの機能を有効にするには、次のように設定を行います。
\nMIDDLEWARE 設定を編集し 'django.contrib.sessions.middleware.SessionMiddleware' を含むようにする。 django-admin startproject で作られるデフォルトの settings.py は SessionMiddleware が有効化されています。
セッションを使いたくない場合は、 MIDDLEWARE 内の SessionMiddleware 行と INSTALLED_APPS 内の 'django.contrib.sessions' を削除しても構いません。これで、オーバーヘッドが少しだけ短縮されます。
デフォルトでは、Django はセッションを、(django.contrib.sessions.models.Session モデルを用いて) データベースに保存します。これは便利ですが、セットアップによってはセッションのデータを他の場所においたほうが高速化できる場合があります。そのため、Django はセッションデータをファイルシステムやキャッシュに保存するように設定することができます。
データベースを使った (database-backed) セッションを使いたい場合には、設定ファイルの INSTALLED_APPS に 'django.contrib.sessions' を追加する必要があります。
一度インストールの設定をすれば、manage.py migrate を実行することで、セッションデータを保存する1つのデータベーステーブルをインストールできます。
よいパフォーマンスを発揮するには、キャッシュを使ったセッションバックエンドを利用した方が良いかもしれません。
\nDjango のキャッシュシステムを使ってセッションデータを保存するには、まず初めに、キャッシュの設定を済ませておく必要があります。詳しくは、 キャッシュのドキュメンテーション を読んでください。
\n\n設定ファイルの CACHES で複数のキャッシュを定義している場合、Django はデフォルトのキャッシュを使用します。他のキャッシュを使用するには、SESSION_CACHE_ALIAS を使用したいキャッシュの名前に変更します。
一度キャッシュが設定されると、データベース ベースのキャッシュ(database-backed cache) か非永続キャッシュ (non-persistent cache) のどちらかを選択する必要があります。
\nThe cached database backend (cached_db) uses a write-through cache --\nsession writes are applied to both the cache and the database. Session reads\nuse the cache, or the database if the data has been evicted from the cache. To\nuse this backend, set SESSION_ENGINE to\n"django.contrib.sessions.backends.cached_db", and follow the configuration\ninstructions for the using database-backed sessions.
The cache backend (cache) stores session data only in your cache. This is\nfaster because it avoids database persistence, but you will have to consider\nwhat happens when cache data is evicted. Eviction can occur if the cache fills\nup or the cache server is restarted, and it will mean session data is lost,\nincluding logging out users. To use this backend, set SESSION_ENGINE\nto "django.contrib.sessions.backends.cache".
The cache backend can be made persistent by using a persistent cache, such as\nRedis with appropriate configuration. But unless your cache is definitely\nconfigured for sufficient persistence, opt for the cached database backend.\nThis avoids edge cases caused by unreliable data storage in production.
\nファイルを使ったセッションを使用するには、SESSION_ENGINE を "django.contrib.sessions.backends.file" に設定します。
Django がセッションファイルを保存する場所を設定したい場合には、SESSION_FILE_PATH を設定します (出力先のデフォルト値は、tempfile.gettempdir()、普通は /tmp になっています)。ウェブサーバが設定した場所の読み書きの権限を持っていることを確認しておいてください。
SessionMiddleware を有効にすれば、それぞれの HttpRequest オブジェクト――Django のビュー関数に渡される最初の引数――は、ディクショナリライクなオブジェクトの session 属性を持つようになります。
この request.session には、ビューの好きな場所で、何度でも、読み書きを行うことができます。
このオブジェクトは、すべてのセッションオブジェクトのベースクラスとなっているので、以下に挙げるような基本的なディクショナリのメソッドを持っています。
\n例: fav_color = request.session['fav_color']
例: request.session['fav_color'] = 'blue'
例: del request.session['fav_color'] 与えられた key がセッション内にない場合には、KeyError 例外を起こします。
例: 'fav_color' in request.session
例: fav_color = request.session.get('fav_color', 'red')
例: fav_color = request.session.pop('fav_color', 'blue')
また、次のようなメソッドも利用できます。
\nセッションから現在のセッションデータを削除し、セッションクッキーを削除します。このメソッドは、前回のセッションデータがユーザのブラウザから再びアクセスされないようにするためなどに使います (たとえば、django.contrib.auth.logout() がこの関数を呼びます)。
ユーザのブラウザがクッキーをサポートしているかどうか判定するために、テスト用のクッキーをセットします。クッキーの動作原理により、ユーザが次のページへのリクエストを行わないとこのテストは行えません。詳しい情報については、下の Setting test cookies を読んでください。
\nユーザのブラウザがテストクッキーを正しく保存したかどうかに応じて、True または False を返します。クッキーの動作原理により、あらかじめ別のページのリクエストとして set_test_cookie() を呼び出しておく必要があります。詳しい情報については、下の Setting test cookies を読んでください。
テストクッキーを削除します。クッキーをきれいにしておくために使ってください。
\nSESSION_COOKIE_AGE の設定値を返す。これはカスタム セッション バックエンドで上書きできる。
セッションの有効期限を設定します。以下に挙げるようなさまざまな値を与えることができます。
\nもし value が整数なら、与えられた秒数だけ活動がなかった時にセッションを破棄します。たとえば、request.session.set_expiry(300) と呼び出せば、5分後にセッションを破棄するように設定できます。
If value is a datetime or timedelta object, the session\nwill expire at that specific date/time.
If value is 0, the user's session cookie will expire\nwhen the user's web browser is closed.
もし value が None ならば、セッションはグローバルなセッション有効期限ポリシーにしたがって扱われます。
セッションの読み込みを行っても、有効期限は延長されません。セッションの有効期限は、セッションが最後に*修正された*時点を基に計算されます。
\nこのセッションの有効期限までの残りの秒数を返します。カスタムの有効期限を持たない (または、ブラウザを閉じた時とセットした) セッションの場合、この値は SESSION_COOKIE_AGE と等しいです。
この関数は 2 つの省略可能なキーワード引数を取ることができます。
\nmodification: セッションを最後に修正した時刻を datetime オブジェクトとして与える。デフォルトは現在の時刻。
expiry: セッションの有効期限の情報を datetime オブジェクト、int (秒数で)、または None として与えます。デフォルトの値は、もしあれば、セッションに保存されている set_expiry() で得られる値、なければ None です。
このセッションが破棄される日付を返します。カスタムの有効期限を持たない (または、ブラウザを閉じた時とセットした) セッションに対しては、現在時刻から SESSION_COOKIE_AGE の秒数までの日付に等しいです。
This function accepts the same keyword arguments as\nget_expiry_age(), and similar notes on usage apply.
Returns either True or False, depending on whether the user's\nsession cookie will expire when the user's web browser is closed.
保存されているセッションから、有効期限が切れているものを削除します。このクラスメソッドは、clearsessions から呼び出されます。
現在のセッションデータを保持したまま、新しいセッションキーを作成します。django.contrib.auth.login() は、このメソッドを呼び出すことで、過去のセッションを継続できるようにしています。
デフォルトでは、Django はセッションデータを JSON を用いてシリアライズします。設定ファイルの SESSION_SERIALIZER に設定すれば、セッションをシリアライズするフォーマットをカスカムできます。 自作のシリアライザを書く に書いた注意書きの通り、JSON によるシリアライズを強く推奨します。 クッキーバックエンドを利用している場合は特に です。
For example, here's an attack scenario if you use pickle to serialize\nsession data. If you're using the signed cookie session backend and SECRET_KEY (or any key of\nSECRET_KEY_FALLBACKS) is known by an attacker (there isn't an\ninherent vulnerability in Django that would cause it to leak), the attacker\ncould insert a string into their session which, when unpickled, executes\narbitrary code on the server. The technique for doing so is simple and easily\navailable on the internet. Although the cookie session storage signs the\ncookie-stored data to prevent tampering, a SECRET_KEY leak\nimmediately escalates to a remote code execution vulnerability.
django.core.signing の JSON シリアライザのラッパーです。基本的なデータ型だけがシリアライズ可能です。
In addition, as JSON supports only string keys, note that using non-string\nkeys in request.session won't work as expected:
>>> # initial assignment\n>>> request.session[0] = "bar"\n>>> # subsequent requests following serialization & deserialization\n>>> # of session data\n>>> request.session[0] # KeyError\n>>> request.session["0"]\n'bar'\nSimilarly, data that can't be encoded in JSON, such as non-UTF8 bytes like\n'\\xd9' (which raises UnicodeDecodeError), can't be stored.
JSON によるシリアライズの制限について詳しくは、自作のシリアライザを書く セクションを読んでください。
\nSupports arbitrary Python objects, but, as described above, can lead to a\nremote code execution vulnerability if SECRET_KEY or any key of\nSECRET_KEY_FALLBACKS becomes known by an attacker.
Note that the JSONSerializer\ncannot handle arbitrary Python data types. As is often the case, there is a\ntrade-off between convenience and security. If you wish to store more advanced\ndata types including datetime and Decimal in JSON backed sessions, you\nwill need to write a custom serializer (or convert such values to a JSON\nserializable object before storing them in request.session). While\nserializing these values is often straightforward\n(DjangoJSONEncoder may be helpful),\nwriting a decoder that can reliably get back the same thing that you put in is\nmore fragile. For example, you run the risk of returning a datetime that\nwas actually a string that just happened to be in the same format chosen for\ndatetimes).
シリアライザのクラスは、必ず次の2つのメソッドを実装しなければなりません。セッションデータのディクショナリをシリアライズする dumps(self, obj) と、それをデシリアライズする loads(self, data) の2つです。
Python の普通の文字列を、request.session におけるディクショナリのキーとして使うこと。これは慣習のためというよりも、確実で高速にするためのルールです。
セッションのディクショナリのキーで、アンダースコアで始まるキーは、Django が内部で使用するために予約されているものと考えること。
request.session を新しいオブジェクトで上書きせず、その属性にアクセスしたり、値をセットしたりしないこと。Python のディクショナリのように扱うこと。
次の簡単なビューは、ユーザがコメントを投稿した後で、has_commented 変数を True に設定します。こうすることで、同じユーザが2回以上コメントできないようにすることができます。
def post_comment(request, new_comment):\n if request.session.get("has_commented", False):\n return HttpResponse("You've already commented.")\n c = comments.Comment(comment=new_comment)\n c.save()\n request.session["has_commented"] = True\n return HttpResponse("Thanks for your comment!")\n次の次の簡単なビューでは、サイトの「メンバー (member)」にログインする手続きを行います。
\ndef login(request):\n m = Member.objects.get(username=request.POST["username"])\n if m.check_password(request.POST["password"]):\n request.session["member_id"] = m.id\n return HttpResponse("You're logged in.")\n else:\n return HttpResponse("Your username and password didn't match.")\nそして、次の例では、上の login() に対応するメンバーのログアウト処理を行います。
def logout(request):\n try:\n del request.session["member_id"]\n except KeyError:\n pass\n return HttpResponse("You're logged out.")\nふつう実際に使われる django.contrib.auth.logout() 関数では、データの意図しない漏洩を防ぐために、この例より少し複雑な処理、request.session の flush() メソッドを呼び出すなどの処理を行っています。ここで挙げた例は、単にセッションオブジェクトの振る舞いをデモンストレーションすることが目的なので、完全ではない logout() を実装しました。
An API is available to manipulate session data outside of a view:
\n>>> from django.contrib.sessions.backends.db import SessionStore\n>>> s = SessionStore()\n>>> # stored as seconds since epoch since datetimes are not serializable in JSON.\n>>> s["last_login"] = 1376587691\n>>> s.create()\n>>> s.session_key\n'2b1189a188b44ad18c35e113ac6ceead'\n>>> s = SessionStore(session_key="2b1189a188b44ad18c35e113ac6ceead")\n>>> s["last_login"]\n1376587691\nSessionStore.create() is designed to create a new session (i.e. one not\nloaded from the session store and with session_key=None). save() is\ndesigned to save an existing session (i.e. one loaded from the session store).\nCalling save() on a new session may also work but has a small chance of\ngenerating a session_key that collides with an existing one. create()\ncalls save() and loops until an unused session_key is generated.
If you're using the django.contrib.sessions.backends.db backend, each\nsession is a normal Django model. The Session model is defined in\ndjango/contrib/sessions/models.py. Because it's a normal model, you can\naccess sessions using the normal Django database API:
>>> from django.contrib.sessions.models import Session\n>>> s = Session.objects.get(pk="2b1189a188b44ad18c35e113ac6ceead")\n>>> s.expire_date\ndatetime.datetime(2005, 8, 20, 13, 35, 12)\nNote that you'll need to call\nget_decoded() to get the session\ndictionary. This is necessary because the dictionary is stored in an encoded\nformat:
>>> s.session_data\n'KGRwMQpTJ19hdXRoX3VzZXJfaWQnCnAyCkkxCnMuMTExY2ZjODI2Yj...'\n>>> s.get_decoded()\n{'user_id': 42}\nデフォルトでは、Django がセッションデータベースへデータを保存するのは、セッションが修正された時だけ、つまり、ディクショナリ直下の値が代入または削除された時だけです。
\n# Session is modified.\nrequest.session["foo"] = "bar"\n\n# Session is modified.\ndel request.session["foo"]\n\n# Session is modified.\nrequest.session["foo"] = {}\n\n# Gotcha: Session is NOT modified, because this alters\n# request.session['foo'] instead of request.session.\nrequest.session["foo"]["bar"] = "baz"\n上の例の場合、セッションオブジェクトに修正したことを明示的に伝えるためには、modified 属性を設定すれば良いです。
request.session.modified = True\nこのデフォルトの動作を変更するには、設定ファイルの SESSION_SAVE_EVERY_REQUEST を True に設定します。True に設定すると、Django は1リクエストごとに、セッションをデータベースに保存してくれるようになります。
セッションクッキーが送信されるのは、セッションの作成及び修正時のみであることに注意してください。SESSION_SAVE_EVERY_REQUEST を True に設定すると、各リクエストごとにセッションクッキーが送信されるようになります。
同時に、セッションクッキーの expires 部分も、セッションクッキーが送信されるごとに更新されます。
レスポンスステータスコードが 500 の時には、セッションは保存されません。
\nSESSION_EXPIRE_AT_BROWSER_CLOSE 設定を使うと、セッションフレームワークが、ブラウザ起動中のみ有効なセッションと永続的なセッションのどちらを使うか設定できます。
デフォルトでは、SESSION_EXPIRE_AT_BROWSER_CLOSE は False にセットされていて、セッションクッキーは SESSION_COOKIE_AGE の期間ユーザのブラウザに保持されます。これにより、ユーザはブラウザを開くたびにログインし直さずに済みます。
SESSION_EXPIRE_AT_BROWSER_CLOSE を True に設定すると、Django はブラウザ起動中のみ有効なクッキーを使用します。このクッキーは、ブラウザを閉じた瞬間に破棄されます。ユーザがブラウザを開くたびにログインするようにしたい場合には、この設定を利用してください。
この設定はグローバルなデフォルトですが、1セッションごとのレベルで設定を上書きすることができます。その場合には、上の using sessions in views で書いたようにして、request.session の set_expiry() メソッドを呼び出してください。
ユーザがウェブサイトで新しいセッションを作成した時、セッションデータはセッションストアに溜め込まれます。データベースのバックエンドを使っている場合には、django_session データベーステーブルが増大し、ファイルバックエンドを使っている場合には、一時ディレクトリのファイル数が増えてゆくでしょう。
この問題を理解するには、データベースバックエンドで起きていることを考えてみてください。ユーザがログインすると、Django は django_session データベースのテーブルに1行を追加します。Django はセッションのデータが変更されるたびに、この行を更新します。ユーザが手動でログアウトすると、Django はこの行を削除します。しかし、ユーザがログアウト*しなかった*場合には、この行は決して削除されません。同様のプロセスが、ファイルバックエンドの場合にも発生します。
Django は、有効期限の切れたセッションを自動的に削除する機能を提供*しません*。したがって、定期的に有効期限の切れたセッションを削除する仕事は、開発者の手に委ねられています。Django はこの目的のために、クリーンナップ用の管理コマンド clearsessions を用意しています。たとえば、cron の毎日のジョブに追加するなどの方法で、定期的にこのコマンドを実行することが推奨されています。
キャッシュバックエンドの場合はこの問題が発生しないことに注意してください。キャッシュの場合、不要なデータは自動的に削除されるようになっているからです。しかし、クッキーバックエンドの場合はそうではありません。セッションデータはユーザのブラウザに保存されるからです。
\n以下の Django の設定 を使うと、セッションの振る舞いをコントロールすることができます。
\n\nサイトのサブドメインからは、クライアントに対して、ドメイン全体に対するクッキーを設定することができます。信頼できるユーザに管理されていないサブドメインから送られたクッキーを許可している場合、この方法で session fixation 攻撃が可能になってしまいます。
\nFor example, an attacker could log into good.example.com and get a valid\nsession for their account. If the attacker has control over bad.example.com,\nthey can use it to send their session key to you since a subdomain is permitted\nto set cookies on *.example.com. When you visit good.example.com,\nyou'll be logged in as the attacker and might inadvertently enter your\nsensitive personal data (e.g. credit card info) into the attacker's account.
Another possible attack would be if good.example.com sets its\nSESSION_COOKIE_DOMAIN to "example.com" which would cause\nsession cookies from that site to be sent to bad.example.com.
The session dictionary accepts any json serializable value when using\nJSONSerializer.
セッションデータは、データベースの django_session という名前のテーブルに保存されます。
Django は必要なときにだけクッキーを送信します。新しくセッションデータを設定しなければ、Django はセッションクッキーを送信しません。
SessionStore オブジェクトLink to this heading#Django が内部でセッションを操作する時は、対応するセッションエンジンの session store オブジェクトを使用します。慣習により、session store オブジェクトは SessionStore と名付けられていて、SESSION_ENGINE で指定したモジュール内に置かれています。
Django で利用可能なすべての SessionStore クラスは、SessionBase を継承していて、以下のデータを操作するメソッドを実装しています。
exists()
create()
save()
delete()
load()
独自のセッションエンジンを作ったり、既存のものをカスタマイズするには、SessionBase か既存の SessionStore クラスを継承した新しいクラスを作る必要があるでしょう。
You can extend the session engines, but doing so with database-backed session\nengines generally requires some extra effort (see the next section for\ndetails).
\nDjango に含まれるデータベースを使ったセッションエンジン (具体的に言えば、db と cached_db) をカスタマイズするには、AbstractBaseSession とともに SessionStore クラスを継承する必要があるかもしれません。
AbstractBaseSession と BaseSessionManager は、INSTALLED_APPS に django.contrib.sessions を追加しなくても、django.contrib.sessions.base_session からインポートすることができます。
ベースとなる抽象的なセッションのモデルです。
\nプライマリーキーです。フィールド自体は40文字までの文字列を格納できますが、現在の実装では、32文字の文字列 (数字と小文字のASCII文字のランダムな列) を生成します。
\nエンコード・シリアライズされた、セッションディクショナリーを含む文字列です。
\nセッションの有効期限を表す datetime オブジェクトです。
\n有効期限が切れたセッションをユーザが利用することはできませんが、clearsessions 管理コマンドを実行するまでは、ふつうはデータベースに保存されています。
セッションモデルで使用するセッションストアクラスを返します。
\nデコードしたセッションデータを返します。
\nデコードは、セッションストアのクラスで実行されます。
\nBaseSessionManager のサブクラスを作ることで、モデルマネージャをカスタマイズすることもできます。
与えられたセッションディクショナリを、シリアライズ・エンコードした文字列として返します。
\nエンコードは、モデルクラスに関連付けられたセッションストアのクラスで実行されます。
\n与えられたセッションキーに対するセッションデータを保存します。データが空の場合には、セッションを削除します。
\nSessionStore クラスのカスタマイズは、以下に挙げるメソッドやプロパティをオーバーライドすることで行えます。
データベースを使ったセッションストアを実装しています。
\nカスタマイズしたセッションモデルを返す必要がある場合には、このメソッドをオーバーライドします。
\n現在のセッションの状態を表す、セッションモデルオブジェクトの新しいインスタンスを返します。
\nこのメソッドをオーバーライドすると、セッションモデルのデータをデータベースへ保存する前に修正することができます。
\nキャッシュデータベースを使ったセッションストアを実装しています。
\nキャッシュのキー文字列を作るためにセッションキーに追加するプリフィックスです。
\nThe example below shows a custom database-backed session engine that includes\nan additional database column to store an account ID (thus providing an option\nto query the database for all active sessions for an account):
\nfrom django.contrib.sessions.backends.db import SessionStore as DBStore\nfrom django.contrib.sessions.base_session import AbstractBaseSession\nfrom django.db import models\n\n\nclass CustomSession(AbstractBaseSession):\n account_id = models.IntegerField(null=True, db_index=True)\n\n @classmethod\n def get_session_store_class(cls):\n return SessionStore\n\n\nclass SessionStore(DBStore):\n @classmethod\n def get_model_class(cls):\n return CustomSession\n\n def create_model_instance(self, data):\n obj = super().create_model_instance(data)\n try:\n account_id = int(data.get("_auth_user_id"))\n except (ValueError, TypeError):\n account_id = None\n obj.account_id = account_id\n return obj\nIf you are migrating from the Django's built-in cached_db session store to\na custom one based on cached_db, you should override the cache key prefix\nin order to prevent a namespace clash:
class SessionStore(CachedDBStore):\n cache_key_prefix = "mysessions.custom_cached_db_backend"\n\n # ...\nThe Django sessions framework is entirely, and solely, cookie-based. It does\nnot fall back to putting session IDs in URLs as a last resort, as PHP does.\nThis is an intentional design decision. Not only does that behavior make URLs\nugly, it makes your site vulnerable to session-ID theft via the "Referer"\nheader.
\n