Использование сессий ¶

Активация сессий ¶

Сеансы реализуются через компонент промежуточного программного обеспечения .

Чтобы включить функцию сеансов, сделайте следующее:

• Убедитесь, что параметр MIDDLEWARE содержит 'django.contrib.sessions.middleware.SessionMiddleware' . Файл settings.py создается по умолчанию активным .django-admin startproject SessionMiddleware

Если вы не хотите использовать сеансы, вы можете удалить строку SessionMiddleware in MIDDLEWARE и line 'django.contrib.sessions' of INSTALLED_APPS . Это сэкономит Django немного работы.

Настройка механизма сеанса ¶

По умолчанию Django хранит сеансы в базе данных (с шаблоном django.contrib.sessions.models.Session ). Хотя это может быть удобно, в некоторых конфигурациях быстрее хранить данные сеанса в другом месте; поэтому можно настроить Django для хранения данных сеанса в файловой системе или в кеше.

Использование сессий в представлениях ¶

Когда SessionMiddleware он активен, каждый объект HttpRequest , первый параметр любой функции представления Django, имеет атрибут, session который является объектом типа словаря.

Вы можете читать и писать в него request.session в любое время, когда вам будет удобно. Вы можете изменить его несколько раз.

класс backends.base.SessionBase¶

Это базовый класс для всех объектов сеанса. Он имеет следующие стандартные словарные методы:

__getitem__( ключ ) ¶

Пример:

__setitem__( ключ , значение ) ¶

Пример: request.session['fav_color'] = 'blue'

__delitem__( ключ ) ¶

Пример: . Если указанный ключ еще не находится в объекте сеанса, создается исключение .del request.session['fav_color'] KeyError

__contains__( ключ ) ¶

Пример: 'fav_color' in request.session

get( ключ , по умолчанию = Нет ) ¶

Пример: fav_color = request.session.get('fav_color', 'red')

pop( ключ , по умолчанию = __ not_given ) ¶

Пример: fav_color = request.session.pop('fav_color', 'blue')

keys() ¶

items() ¶

setdefault() ¶

clear() ¶

Также есть следующие методы:

flush() ¶

Удаляет данные для текущего сеанса и удаляет файл cookie сеанса. Это полезно для обеспечения того, чтобы данные предыдущего сеанса больше не могли воспроизводиться браузером пользователя (например, он это делает django.contrib.auth.logout() ).

set_test_cookie() ¶

Создает тестовый файл cookie, чтобы определить, поддерживает ли браузер пользователя файлы cookie. Из-за того, как работают файлы cookie, вы не сможете определить это до следующего запроса пользователя. См. Раздел Создание тестовых файлов cookie ниже для получения дополнительной информации.

test_cookie_worked() ¶

Возвращает True или False , в зависимости от того, принял ли браузер пользователя тестовый файл cookie или нет. Из-за того, как работают файлы cookie, вы должны были вызвать set_test_cookie() предыдущий запрос страницы. См. Раздел Создание тестовых файлов cookie ниже для получения дополнительной информации.

delete_test_cookie() ¶

Удалите тестовый файл cookie. Используется для уборки позади вас.

get_session_cookie_age() ¶

Новое в Django 3.0.

Возвращает возраст файлов cookie сеанса в секундах. По умолчанию это SESSION_COOKIE_AGE .

set_expiry( значение ) ¶

Определяет, как долго истекает сеанс. Можно передать несколько разных значений:

• Если value - целое число, сеанс завершится по истечении указанного количества секунд бездействия. Например, при вызове request.session.set_expiry(300) сеанс истечет через 5 минут.
• Если value это объект datetime или timedelta , сеанс истечет в указанную дату и время. Обратите внимание, что значения datetime и timedelta сериализуемы, только если вы используете сериализацию PickleSerializer .
• Если value это 0 , куки сессии пользователя истекает , когда пользователь закрывает свой веб - браузер.
• Если value есть None , то сессия вновь опирается на глобальную политику истечения срока действия сеанса.

Чтение сеанса не считается занятием с точки зрения истечения срока действия. Срок действия сеанса исчисляется с момента последнего изменения сеанса.

get_expiry_age() ¶

Возвращает количество секунд, оставшихся до истечения сеанса. Для сеансов без определенного срока действия (или сеансов, срок действия которых истекает при закрытии браузера) это значение будет равно SESSION_COOKIE_AGE .

Эта функция принимает два необязательных именованных параметра:

• modification : последняя модификация сеанса как объект datetime . По умолчанию это текущее время.
• expiry : информация об истечении срока действия сеанса, например объект datetime , значение int (в секундах) или None . По умолчанию это значение равно значению, сохраненному в сеансе set_expiry() , если применимо, в противном случае None .

get_expiry_date() ¶

Возвращает дату окончания сеанса. Для сеансов без определенного тайм-аута (или тех, которые истекают при закрытии браузера), это значение будет равно SESSION_COOKIE_AGE секундам с этого момента .

Эта функция принимает те же параметры ключевого слова, что и get_expiry_age() .

get_expire_at_browser_close() ¶

Возвращает True или в False зависимости от того, истекает ли срок действия cookie сеанса пользователя при закрытии веб-браузера пользователя или нет.

clear_expired() ¶

Удаляет просроченные сеансы из хранилища сеансов. Этот метод класса вызывается clearsessions .

cycle_key() ¶

Создает новый ключ сеанса с сохранением данных текущего сеанса. django.contrib.auth.login() вызывает этот метод для борьбы с атаками фиксации сеанса.

def post_comment(request, new_comment):
    if request.session.get('has_commented', False):
        return HttpResponse("You've already commented.")
    c = comments.Comment(comment=new_comment)
    c.save()
    request.session['has_commented'] = True
    return HttpResponse('Thanks for your comment!')

def login(request):
    m = Member.objects.get(username=request.POST['username'])
    if m.password == request.POST['password']:
        request.session['member_id'] = m.id
        return HttpResponse("You're logged in.")
    else:
        return HttpResponse("Your username and password didn't match.")

def logout(request):
    try:
        del request.session['member_id']
    except KeyError:
        pass
    return HttpResponse("You're logged out.")

Создание тестовых файлов cookie ¶

Для удобства Django предоставляет способ проверить, принимает ли браузер пользователя файлы cookie. Вызов метода set_test_cookie() из request.session в представлении, а затем вызвать test_cookie_worked() в одном из следующих представлений, но не в том же виде вызова.

Это странное разделение между set_test_cookie() и test_cookie_worked() необходимо из-за того, как работают файлы cookie. Когда вы устанавливаете файл cookie, на самом деле невозможно узнать, принял ли его браузер до получения следующего запроса браузера.

Рекомендуется использовать delete_test_cookie() для уборки позади вас. Сделайте это, убедившись, что тестовый файл cookie работает.

Вот пример типичного использования:

from django.http import HttpResponse
from django.shortcuts import render

def login(request):
    if request.method == 'POST':
        if request.session.test_cookie_worked():
            request.session.delete_test_cookie()
            return HttpResponse("You're logged in.")
        else:
            return HttpResponse("Please enable cookies and try again.")
    request.session.set_test_cookie()
    return render(request, 'foo/login_form.html')

Использование сессий вне представлений ¶

>>> from importlib import import_module
>>> from django.conf import settings
>>> SessionStore = import_module(settings.SESSION_ENGINE).SessionStore

Доступен API для управления данными сеанса вне представлений:

>>> from django.contrib.sessions.backends.db import SessionStore
>>> s = SessionStore()
>>> # stored as seconds since epoch since datetimes are not serializable in JSON.
>>> s['last_login'] = 1376587691
>>> s.create()
>>> s.session_key
'2b1189a188b44ad18c35e113ac6ceead'
>>> s = SessionStore(session_key='2b1189a188b44ad18c35e113ac6ceead')
>>> s['last_login']
1376587691

SessionStore.create() предназначен для создания нового сеанса (то есть такого, который не отвечает за хранение сеанса и с session_key=None ). save() предназначен для записи существующего сеанса (то есть того, который отвечает за хранение сеанса). Также можно вызвать save() новый сеанс, но с небольшим риском создания сеансового ключа, который конфликтует с другим. create() вызывает save() и зацикливается, пока session_key не будет произведен неиспользованный ключ .

Если вы используете движок django.contrib.sessions.backends.db , каждый сеанс представляет собой обычную модель Django. Модель Session определена в django/contrib/sessions/models.py . Поскольку это обычная модель, вы можете получить доступ к сеансам, используя обычный API базы данных Django:

>>> from django.contrib.sessions.models import Session
>>> s = Session.objects.get(pk='2b1189a188b44ad18c35e113ac6ceead')
>>> s.expire_date
datetime.datetime(2005, 8, 20, 13, 35, 12)

Обратите внимание, что вам нужно будет позвонить, get_decoded() чтобы получить словарь сеанса. Это необходимо, потому что словарь хранится в закодированном формате:

>>> s.session_data
'KGRwMQpTJ19hdXRoX3VzZXJfaWQnCnAyCkkxCnMuMTExY2ZjODI2Yj...'
>>> s.get_decoded()
{'user_id': 42}

Запись сеансов ¶

По умолчанию Django сохраняет сеанс в базе данных только тогда, когда сеанс был изменен, то есть по крайней мере одно из значений в его словаре было установлено или удалено:

# Session is modified.
request.session['foo'] = 'bar'

# Session is modified.
del request.session['foo']

# Session is modified.
request.session['foo'] = {}

# Gotcha: Session is NOT modified, because this alters
# request.session['foo'] instead of request.session.
request.session['foo']['bar'] = 'baz'

В последнем случае приведенного выше примера мы можем явно сообщить объекту сеанса, что он был изменен, установив его атрибут modified :

request.session.modified = True

Чтобы изменить это поведение по умолчанию, установите для параметра SESSION_SAVE_EVERY_REQUEST значение True . В этом случае Django сохраняет сеанс в базе данных при каждом запросе.

Обратите внимание, что файл cookie сеанса отправляется только после создания или изменения сеанса. Если SESSION_SAVE_EVERY_REQUEST применимо True , cookie сеанса будет отправляться для каждого запроса.

Аналогичным образом, часть expires файла cookie сеанса обновляется каждый раз при отправке файла cookie сеанса.

Сеанс не сохраняется, если код состояния ответа 500.

Истечение или сохранение сеанса ¶

Этот параметр SESSION_EXPIRE_AT_BROWSER_CLOSE позволяет вам контролировать тип сеансов, используемых инфраструктурой сеансов: сеансы, срок действия которых истекает при закрытии браузера, или постоянные сеансы.

По умолчанию SESSION_EXPIRE_AT_BROWSER_CLOSE установлено значение False , что означает, что файлы cookie сеанса будут храниться в браузерах пользователей в течение периода SESSION_COOKIE_AGE . Используется, когда вы не хотите, чтобы пользователям приходилось входить в систему каждый раз, когда они открывают свой браузер.

Если SESSION_EXPIRE_AT_BROWSER_CLOSE установлено значение True , Django использует файлы cookie, срок действия которых истекает при закрытии браузера. Используется, когда вы хотите, чтобы пользователи входили в систему каждый раз, когда они открывают свой браузер.

Этот параметр является глобальным по умолчанию и может быть переопределен на уровне отдельного сеанса путем явного вызова метода set_expiry() из , request.session как описано выше в Использование сессий в соображениях .

Очистка хранилища сеансов ¶

По мере того, как все больше пользователей создают новые сеансы на вашем веб-сайте, данные о сеансах накапливаются в вашем хранилище сеансов. Если вы используете движок в качестве базы данных, таблица базы данных django_session увеличивается. Если вы используете файловый движок, количество файлов во временном каталоге будет постоянно увеличиваться.

Чтобы разобраться в этой проблеме, давайте посмотрим, что происходит с движком в базе данных. Когда пользователь входит в систему, Django добавляет запись в таблицу django_session . Он обновляет эту запись при изменении данных сеанса. Если пользователь явно выходит из системы, Django очищает запись. Но если пользователь этого не сделает , запись никогда не будет стерта. Принцип тот же, что и для файлового движка.

Django не предоставляет автоматической системы удаления просроченных сессий. Таким образом, вы должны делать это через определенные промежутки времени. Django предоставляет команды управления очистки для этой цели: clearsessions . Рекомендуется запускать эту команду регулярно, например, в ежедневном задании cron.

Обратите внимание, что механизм на основе кеша не подвержен этой проблеме, поскольку кеши автоматически удаляют устаревшие данные. То же самое и с движком на основе файлов cookie, поскольку данные сеанса хранятся в браузерах пользователей.

Настройки ¶

Некоторые настройки Django позволяют контролировать поведение сессий:

• SESSION_CACHE_ALIAS
• SESSION_COOKIE_AGE
• SESSION_COOKIE_DOMAIN
• SESSION_COOKIE_HTTPONLY
• SESSION_COOKIE_NAME
• SESSION_COOKIE_PATH
• SESSION_COOKIE_SAMESITE
• SESSION_COOKIE_SECURE
• SESSION_ENGINE
• SESSION_EXPIRE_AT_BROWSER_CLOSE
• SESSION_FILE_PATH
• SESSION_SAVE_EVERY_REQUEST
• SESSION_SERIALIZER

Безопасность сеанса ¶

Поддомены сайта могут устанавливать файлы cookie для клиента, действительные для всего домена. Это делает возможными атаки фиксации сеанса, если файлы cookie могут быть созданы субдоменами, которые не находятся под контролем доверенных лиц.

Например, злоумышленник может войти в систему good.example.com и получить действительный сеанс для своей учетной записи. Если злоумышленник находится под контролем bad.example.com , он может использовать его, чтобы отправить вам свой сеансовый ключ, поскольку поддомен имеет право устанавливать файлы cookie для *.example.com . При посещении good.example.com вы войдете в систему под учетной записью злоумышленника и сможете непреднамеренно ввести конфиденциальные личные данные (например, данные кредитной карты), сохраненные в учетной записи злоумышленника.

Другая возможная атака возникает в случае, если для good.example.com параметра установлено SESSION_COOKIE_DOMAIN значение "example.com" , что может привести к отправке файлов cookie сеанса в bad.example.com .

Технические детали ¶

• Словарь сеанса принимает любые данные, сериализуемые с json помощью, JSONSerializer или любой объект Python, сериализуемый с pickle помощью PickleSerializer . См. pickle Дополнительную информацию в документации модуля .
• Данные сеанса хранятся в именованной таблице базы данных django_session .
• Django отправляет cookie только при необходимости. Если вы не укажете данные сеанса, cookie сеанса не будет отправлен.

Расширение движков сессий на основе баз данных ¶

Создание настраиваемого механизма сеанса, управляемого базой данных, на основе тех, что включены в Django (т.е. db и cached_db ), может быть выполнено путем наследования AbstractBaseSession от одного из классов. SessionStore ,

AbstractBaseSession и BaseSessionManager их можно импортировать из django.contrib.sessions.base_session файлов, чтобы их можно было импортировать без включения django.contrib.sessions в INSTALLED_APPS .

класс base_session.AbstractBaseSession¶

Базовая абстрактная модель сеанса.

session_key¶

Первичный ключ. Само поле может содержать до 40 символов. Текущая реализация генерирует 32-символьную строку (случайную последовательность строчных цифр и букв ASCII).

session_data¶

Строка, содержащая закодированный и сериализованный словарь сеанса.

expire_date¶

Дата / время, указывающие дату окончания сеанса.

Сессии, срок действия которых истек, больше не доступны для пользователей; они могут оставаться в базе данных до запуска административной команды clearsessions .

classmethodget_session_store_class () ¶

Возвращает класс хранения сеанса для использования с этим шаблоном сеанса.

get_decoded() ¶

Возвращает декодированные данные сеанса.

Декодирование выполняется классом хранения сеанса.

Вы также можете настроить диспетчер моделей, унаследовав от BaseSessionManager :

класс base_session.BaseSessionManager¶

encode( session_dict ) ¶

Возвращает указанный словарь сеанса в виде закодированной и сериализованной строки.

Кодирование выполняется классом хранения сеанса, связанным с классом шаблона.

save( session_key , session_dict , expire_date ) ¶

Сохраните данные сеанса, соответствующие указанному ключу сеанса, или удалите сеанс, если данные пусты.

Настройка классов SessionStore выполняется путем перегрузки методов и свойств, описанных ниже:

класс backends.db.SessionStore¶

Реализация хранилища сессий на базе базы данных.

classmethodget_model_class () ¶

Переопределите этот метод, чтобы при необходимости возвращать настраиваемый шаблон сеанса.

create_model_instance( данные ) ¶

Возвращает новый экземпляр объекта шаблона сеанса, который представляет текущее состояние сеанса.

Переопределив этот метод, вы можете изменить данные шаблона сеанса до их сохранения в базе данных.

класс backends.cached_db.SessionStore¶

Реализация хранилища сеансов на основе базы данных и кеша.

cache_key_prefix¶

Префикс, добавляемый к ключу сеанса для построения цепочки ключей кеша.

from django.contrib.sessions.backends.db import SessionStore as DBStore
from django.contrib.sessions.base_session import AbstractBaseSession
from django.db import models

class CustomSession(AbstractBaseSession):
    account_id = models.IntegerField(null=True, db_index=True)

    @classmethod
    def get_session_store_class(cls):
        return SessionStore

class SessionStore(DBStore):
    @classmethod
    def get_model_class(cls):
        return CustomSession

    def create_model_instance(self, data):
        obj = super().create_model_instance(data)
        try:
            account_id = int(data.get('_auth_user_id'))
        except (ValueError, TypeError):
            account_id = None
        obj.account_id = account_id
        return obj

class SessionStore(CachedDBStore):
    cache_key_prefix = 'mysessions.custom_cached_db_backend'

    # ...

Идентификаторы сеанса в URL ¶

Инфраструктура сеансов Django полностью основана на файлах cookie. Он не использует систему идентификаторов сеансов в URL-адресах, как это делает PHP. Это добровольное концептуальное решение. Этот метод искажает URL-адреса и делает ваш сайт уязвимым для кражи идентификатора сеанса через заголовок «Referer».