класс ActionDispatch::Session::CookieStore

Родитель:: ActionDispatch::Session::AbstractSecureStore

Этот хранилище сессий на основе файлов cookie является стандартным для Rails. Оно значительно быстрее, чем альтернативные варианты.

Сессии обычно содержат не более user_id и сообщений флэша; оба помещаются в пределы лимита размера файлов cookie в 4096 байт. Исключение CookieOverflow выбрасывается, если вы попытаетесь сохранить более 4096 байт данных.

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

Ваши файлы cookie будут зашифрованы с использованием ключа вашего приложения secret_key_base. Это идет дальше, чем подписанные файлы cookie, так как зашифрованные файлы cookie не могут быть изменены или прочитаны пользователями. Это значение по умолчанию начиная с Rails 4.

Настройте хранилище сессий в инициализаторе:

Rails.application.config.session_store :cookie_store, key: '_your_app_session'

В средах разработки и тестирования базовый ключ секретности вашего приложения генерируется Rails и хранится в временном файле в tmp/development_secret.txt. Во всех других средах он хранится зашифрованным в файле config/credentials.yml.enc.

Если ваше приложение не было обновлено до значений по умолчанию Rails 5.2, secret_key_base будет найден в старом файле config/secrets.yml.

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

Поскольку CookieStore расширяет Rack::Session::Abstract::Persisted, многие из описанных там параметров могут быть использованы для настройки генерируемого файла cookie сессии. Например:

Rails.application.config.session_store :cookie_store, expire_after: 14.days

установит срок действия файла cookie сессии в 14 дней после создания. Другие полезные параметры включают :key, :secure и :httponly.

Публичные методы класса

new(app, options = {}) Показать исходный код

# File actionpack/lib/action_dispatch/middleware/session/cookie_store.rb, line 59
def initialize(app, options = {})
  super(app, options.merge!(cookie_only: true))
end

Вызывает метод предка ActionDispatch::Session::Compatibility::new

Публичные методы экземпляра

delete_session(req, session_id, options) Показать исходный код

# File actionpack/lib/action_dispatch/middleware/session/cookie_store.rb, line 63
def delete_session(req, session_id, options)
  new_sid = generate_sid unless options[:drop]
  # Reset hash and Assign the new session id
  req.set_header("action_dispatch.request.unsigned_session_cookie", new_sid ? { "session_id" => new_sid.public_id } : {})
  new_sid
end

load_session(req) Показать исходный код

# File actionpack/lib/action_dispatch/middleware/session/cookie_store.rb, line 70
def load_session(req)
  stale_session_check! do
    data = unpacked_cookie_data(req)
    data = persistent_session_id!(data)
    [Rack::Session::SessionId.new(data["session_id"]), data]
  end
end