flask库中sessions.py的使用小结

from flask import flask, session

app = flask(__name__)
app.secret_key = 'your-secret-key-here'  # 必须设置，否则 session 无法工作

from flask import flask, session, request, redirect, url_for

app = flask(__name__)
app.secret_key = 'your-secret-key'

@app.route('/login')
def login():
    session['username'] = 'admin'  # 存储 session
    session['logged_in'] = true    # session 可以存储任意可序列化的数据
    return "logged in!"

@app.route('/dashboard')
def dashboard():
    if session.get('logged_in'):
        return f"welcome, {session['username']}!"
    else:
        return redirect(url_for('login'))

@app.route('/logout')
def logout():
    session.pop('username', none)  # 移除 session 中的某个键
    session.clear()                # 清空整个 session
    return "logged out!"

from datetime import timedelta

app.config['permanent_session_lifetime'] = timedelta(days=7)  # 7天后过期

@app.route('/login')
def login():
    session.permanent = true  # 启用持久 session
    session['username'] = 'admin'
    return "logged in (persistent)!"

{
    "username": "admin",
    "_fresh": true,
    "_id": "abc123...",
    "_permanent": true
}

from flask_session import session  # 需要安装 flask-session

app.config['session_type'] = 'redis'  # 可选 redis, memcached, filesystem 等
app.config['session_permanent'] = true
app.config['session_use_signer'] = true  # 是否签名 cookie
app.config['session_key_prefix'] = 'myapp:'  # redis 键前缀

session(app)  # 替换默认的 session 实现

app.config.update(
    session_cookie_name='my_session',       # cookie 名称
    session_cookie_httponly=true,          # 禁止 javascript 访问
    session_cookie_secure=true,            # 仅 https 传输
    session_cookie_samesite='lax',         # 防 csrf（strict/lax/none）
    session_cookie_partitioned=true,       # 跨站 cookie 隔离（chips）
)

app.secret_key = 'your-secret-key' # 必须设置

session.permanent = true
app.config['permanent_session_lifetime'] = timedelta(days=30)

@app.route('/clear_session')
def clear_session():
    session.clear()  # 清空 session
    return "session cleared!"

from __future__ import annotations

import collections.abc as c
import hashlib
import typing as t
from collections.abc import mutablemapping
from datetime import datetime
from datetime import timezone

from itsdangerous import badsignature
from itsdangerous import urlsafetimedserializer
from werkzeug.datastructures import callbackdict

from .json.tag import taggedjsonserializer

if t.type_checking:  # pragma: no cover
    import typing_extensions as te

    from .app import flask
    from .wrappers import request
    from .wrappers import response


class sessionmixin(mutablemapping[str, t.any]):
    """expands a basic dictionary with session attributes."""

    @property
    def permanent(self) -> bool:
        """this reflects the ``'_permanent'`` key in the dict."""
        return self.get("_permanent", false)

    @permanent.setter
    def permanent(self, value: bool) -> none:
        self["_permanent"] = bool(value)

    #: some implementations can detect whether a session is newly
    #: created, but that is not guaranteed. use with caution. the mixin
    # default is hard-coded ``false``.
    new = false

    #: some implementations can detect changes to the session and set
    #: this when that happens. the mixin default is hard coded to
    #: ``true``.
    modified = true

    #: some implementations can detect when session data is read or
    #: written and set this when that happens. the mixin default is hard
    #: coded to ``true``.
    accessed = true


class securecookiesession(callbackdict[str, t.any], sessionmixin):
    """base class for sessions based on signed cookies.

    this session backend will set the :attr:`modified` and
    :attr:`accessed` attributes. it cannot reliably track whether a
    session is new (vs. empty), so :attr:`new` remains hard coded to
    ``false``.
    """

    #: when data is changed, this is set to ``true``. only the session
    #: dictionary itself is tracked; if the session contains mutable
    #: data (for example a nested dict) then this must be set to
    #: ``true`` manually when modifying that data. the session cookie
    #: will only be written to the response if this is ``true``.
    modified = false

    #: when data is read or written, this is set to ``true``. used by
    # :class:`.securecookiesessioninterface` to add a ``vary: cookie``
    #: header, which allows caching proxies to cache different pages for
    #: different users.
    accessed = false

    def __init__(
        self,
        initial: c.mapping[str, t.any] | c.iterable[tuple[str, t.any]] | none = none,
    ) -> none:
        def on_update(self: te.self) -> none:
            self.modified = true
            self.accessed = true

        super().__init__(initial, on_update)

    def __getitem__(self, key: str) -> t.any:
        self.accessed = true
        return super().__getitem__(key)

    def get(self, key: str, default: t.any = none) -> t.any:
        self.accessed = true
        return super().get(key, default)

    def setdefault(self, key: str, default: t.any = none) -> t.any:
        self.accessed = true
        return super().setdefault(key, default)


class nullsession(securecookiesession):
    """class used to generate nicer error messages if sessions are not
    available.  will still allow read-only access to the empty session
    but fail on setting.
    """

    def _fail(self, *args: t.any, **kwargs: t.any) -> t.noreturn:
        raise runtimeerror(
            "the session is unavailable because no secret "
            "key was set.  set the secret_key on the "
            "application to something unique and secret."
        )

    __setitem__ = __delitem__ = clear = pop = popitem = update = setdefault = _fail  # noqa: b950
    del _fail


class sessioninterface:
    """the basic interface you have to implement in order to replace the
    default session interface which uses werkzeug's securecookie
    implementation.  the only methods you have to implement are
    :meth:`open_session` and :meth:`save_session`, the others have
    useful defaults which you don't need to change.

    the session object returned by the :meth:`open_session` method has to
    provide a dictionary like interface plus the properties and methods
    from the :class:`sessionmixin`.  we recommend just subclassing a dict
    and adding that mixin::

        class session(dict, sessionmixin):
            pass

    if :meth:`open_session` returns ``none`` flask will call into
    :meth:`make_null_session` to create a session that acts as replacement
    if the session support cannot work because some requirement is not
    fulfilled.  the default :class:`nullsession` class that is created
    will complain that the secret key was not set.

    to replace the session interface on an application all you have to do
    is to assign :attr:`flask.flask.session_interface`::

        app = flask(__name__)
        app.session_interface = mysessioninterface()

    multiple requests with the same session may be sent and handled
    concurrently. when implementing a new session interface, consider
    whether reads or writes to the backing store must be synchronized.
    there is no guarantee on the order in which the session for each
    request is opened or saved, it will occur in the order that requests
    begin and end processing.

    .. versionadded:: 0.8
    """

    #: :meth:`make_null_session` will look here for the class that should
    #: be created when a null session is requested.  likewise the
    #: :meth:`is_null_session` method will perform a typecheck against
    #: this type.
    null_session_class = nullsession

    #: a flag that indicates if the session interface is pickle based.
    #: this can be used by flask extensions to make a decision in regards
    #: to how to deal with the session object.
    #:
    #: .. versionadded:: 0.10
    pickle_based = false

    def make_null_session(self, app: flask) -> nullsession:
        """creates a null session which acts as a replacement object if the
        real session support could not be loaded due to a configuration
        error.  this mainly aids the user experience because the job of the
        null session is to still support lookup without complaining but
        modifications are answered with a helpful error message of what
        failed.

        this creates an instance of :attr:`null_session_class` by default.
        """
        return self.null_session_class()

    def is_null_session(self, obj: object) -> bool:
        """checks if a given object is a null session.  null sessions are
        not asked to be saved.

        this checks if the object is an instance of :attr:`null_session_class`
        by default.
        """
        return isinstance(obj, self.null_session_class)

    def get_cookie_name(self, app: flask) -> str:
        """the name of the session cookie. uses``app.config["session_cookie_name"]``."""
        return app.config["session_cookie_name"]  # type: ignore[no-any-return]

    def get_cookie_domain(self, app: flask) -> str | none:
        """the value of the ``domain`` parameter on the session cookie. if not set,
        browsers will only send the cookie to the exact domain it was set from.
        otherwise, they will send it to any subdomain of the given value as well.

        uses the :data:`session_cookie_domain` config.

        .. versionchanged:: 2.3
            not set by default, does not fall back to ``server_name``.
        """
        return app.config["session_cookie_domain"]  # type: ignore[no-any-return]

    def get_cookie_path(self, app: flask) -> str:
        """returns the path for which the cookie should be valid.  the
        default implementation uses the value from the ``session_cookie_path``
        config var if it's set, and falls back to ``application_root`` or
        uses ``/`` if it's ``none``.
        """
        return app.config["session_cookie_path"] or app.config["application_root"]  # type: ignore[no-any-return]

    def get_cookie_httponly(self, app: flask) -> bool:
        """returns true if the session cookie should be httponly.  this
        currently just returns the value of the ``session_cookie_httponly``
        config var.
        """
        return app.config["session_cookie_httponly"]  # type: ignore[no-any-return]

    def get_cookie_secure(self, app: flask) -> bool:
        """returns true if the cookie should be secure.  this currently
        just returns the value of the ``session_cookie_secure`` setting.
        """
        return app.config["session_cookie_secure"]  # type: ignore[no-any-return]

    def get_cookie_samesite(self, app: flask) -> str | none:
        """return ``'strict'`` or ``'lax'`` if the cookie should use the
        ``samesite`` attribute. this currently just returns the value of
        the :data:`session_cookie_samesite` setting.
        """
        return app.config["session_cookie_samesite"]  # type: ignore[no-any-return]

    def get_cookie_partitioned(self, app: flask) -> bool:
        """returns true if the cookie should be partitioned. by default, uses
        the value of :data:`session_cookie_partitioned`.

        .. versionadded:: 3.1
        """
        return app.config["session_cookie_partitioned"]  # type: ignore[no-any-return]

    def get_expiration_time(self, app: flask, session: sessionmixin) -> datetime | none:
        """a helper method that returns an expiration date for the session
        or ``none`` if the session is linked to the browser session.  the
        default implementation returns now + the permanent session
        lifetime configured on the application.
        """
        if session.permanent:
            return datetime.now(timezone.utc) + app.permanent_session_lifetime
        return none

    def should_set_cookie(self, app: flask, session: sessionmixin) -> bool:
        """used by session backends to determine if a ``set-cookie`` header
        should be set for this session cookie for this response. if the session
        has been modified, the cookie is set. if the session is permanent and
        the ``session_refresh_each_request`` config is true, the cookie is
        always set.

        this check is usually skipped if the session was deleted.

        .. versionadded:: 0.11
        """

        return session.modified or (
            session.permanent and app.config["session_refresh_each_request"]
        )

    def open_session(self, app: flask, request: request) -> sessionmixin | none:
        """this is called at the beginning of each request, after
        pushing the request context, before matching the url.

        this must return an object which implements a dictionary-like
        interface as well as the :class:`sessionmixin` interface.

        this will return ``none`` to indicate that loading failed in
        some way that is not immediately an error. the request
        context will fall back to using :meth:`make_null_session`
        in this case.
        """
        raise notimplementederror()

    def save_session(
        self, app: flask, session: sessionmixin, response: response
    ) -> none:
        """this is called at the end of each request, after generating
        a response, before removing the request context. it is skipped
        if :meth:`is_null_session` returns ``true``.
        """
        raise notimplementederror()


session_json_serializer = taggedjsonserializer()


def _lazy_sha1(string: bytes = b"") -> t.any:
    """don't access ``hashlib.sha1`` until runtime. fips builds may not include
    sha-1, in which case the import and use as a default would fail before the
    developer can configure something else.
    """
    return hashlib.sha1(string)


class securecookiesessioninterface(sessioninterface):
    """the default session interface that stores sessions in signed cookies
    through the :mod:`itsdangerous` module.
    """

    #: the salt that should be applied on top of the secret key for the
    #: signing of cookie based sessions.
    salt = "cookie-session"
    #: the hash function to use for the signature.  the default is sha1
    digest_method = staticmethod(_lazy_sha1)
    #: the name of the itsdangerous supported key derivation.  the default
    #: is hmac.
    key_derivation = "hmac"
    #: a python serializer for the payload.  the default is a compact
    #: json derived serializer with support for some extra python types
    #: such as datetime objects or tuples.
    serializer = session_json_serializer
    session_class = securecookiesession

    def get_signing_serializer(self, app: flask) -> urlsafetimedserializer | none:
        if not app.secret_key:
            return none

        keys: list[str | bytes] = []

        if fallbacks := app.config["secret_key_fallbacks"]:
            keys.extend(fallbacks)

        keys.append(app.secret_key)  # itsdangerous expects current key at top
        return urlsafetimedserializer(
            keys,  # type: ignore[arg-type]
            salt=self.salt,
            serializer=self.serializer,
            signer_kwargs={
                "key_derivation": self.key_derivation,
                "digest_method": self.digest_method,
            },
        )

    def open_session(self, app: flask, request: request) -> securecookiesession | none:
        s = self.get_signing_serializer(app)
        if s is none:
            return none
        val = request.cookies.get(self.get_cookie_name(app))
        if not val:
            return self.session_class()
        max_age = int(app.permanent_session_lifetime.total_seconds())
        try:
            data = s.loads(val, max_age=max_age)
            return self.session_class(data)
        except badsignature:
            return self.session_class()

    def save_session(
        self, app: flask, session: sessionmixin, response: response
    ) -> none:
        name = self.get_cookie_name(app)
        domain = self.get_cookie_domain(app)
        path = self.get_cookie_path(app)
        secure = self.get_cookie_secure(app)
        partitioned = self.get_cookie_partitioned(app)
        samesite = self.get_cookie_samesite(app)
        httponly = self.get_cookie_httponly(app)

        # add a "vary: cookie" header if the session was accessed at all.
        if session.accessed:
            response.vary.add("cookie")

        # if the session is modified to be empty, remove the cookie.
        # if the session is empty, return without setting the cookie.
        if not session:
            if session.modified:
                response.delete_cookie(
                    name,
                    domain=domain,
                    path=path,
                    secure=secure,
                    partitioned=partitioned,
                    samesite=samesite,
                    httponly=httponly,
                )
                response.vary.add("cookie")

            return

        if not self.should_set_cookie(app, session):
            return

        expires = self.get_expiration_time(app, session)
        val = self.get_signing_serializer(app).dumps(dict(session))  # type: ignore[union-attr]
        response.set_cookie(
            name,
            val,
            expires=expires,
            httponly=httponly,
            domain=domain,
            path=path,
            secure=secure,
            partitioned=partitioned,
            samesite=samesite,
        )
        response.vary.add("cookie")

app.config.update(
    secret_key="your-secret-key",
    session_cookie_name="my_session",
    session_cookie_secure=true,
    session_cookie_samesite="lax",
    permanent_session_lifetime=timedelta(days=7),
)