Class: ActionDispatch::Cookies::SignedCookieJar

Inherits:

CookieJar

• Object
• CookieJar
• ActionDispatch::Cookies::SignedCookieJar

show all

Defined in:

actionpack/lib/action_dispatch/middleware/cookies.rb

Overview

Constant Summary

MAX_COOKIE_SIZE =

4096

SECRET_MIN_LENGTH =

Cookies can typically store 4096 bytes. Characters

30

Constants inherited from CookieJar

CookieJar::DOMAIN_REGEXP

Instance Method Summary (collapse)

• - (Object) [](name)
• - (Object) []=(key, options)
• - (SignedCookieJar) initialize(parent_jar, secret) constructor

  A new instance of SignedCookieJar.

• - (Object) method_missing(method, *arguments, &block)

Methods inherited from CookieJar

build, #clear, #delete, #each, #handle_options, #key?, #permanent, #recycle!, #signed, #update, #write

Methods included from Enumerable

#as_json, #each_with_object, #exclude?, #group_by, #index_by, #many?, #sum

281
282
283
284
285

# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 281

def initialize(parent_jar, secret)
  ensure_secret_secure(secret)
  @parent_jar = parent_jar
  @verifier   = ActiveSupport::MessageVerifier.new(secret)
end

307
308
309

# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 307

def method_missing(method, *arguments, &block)
  @parent_jar.send(method, *arguments, &block)
end

287
288
289
290
291
292
293

# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 287

def [](name)
  if signed_message = @parent_jar[name]
    @verifier.verify(signed_message)
  end
rescue ActiveSupport::MessageVerifier::InvalidSignature
  nil
end

295
296
297
298
299
300
301
302
303
304
305

# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 295

def []=(key, options)
  if options.is_a?(Hash)
    options.symbolize_keys!
    options[:value] = @verifier.generate(options[:value])
  else
    options = { :value => @verifier.generate(options) }
  end

  raise CookieOverflow if options[:value].size > MAX_COOKIE_SIZE
  @parent_jar[key] = options
end