cookies_test.rb 46.0 KB
Newer Older
1 2
# frozen_string_literal: true

3 4 5 6
require "abstract_unit"
require "openssl"
require "active_support/key_generator"
require "active_support/message_verifier"
D
Initial  
David Heinemeier Hansson 已提交
7

8 9 10 11
class CookieJarTest < ActiveSupport::TestCase
  attr_reader :request

  def setup
E
eileencodes 已提交
12
    @request = ActionDispatch::Request.empty
13 14 15 16
  end

  def test_fetch
    x = Object.new
17 18 19
    assert_not request.cookie_jar.key?("zzzzzz")
    assert_equal x, request.cookie_jar.fetch("zzzzzz", x)
    assert_not request.cookie_jar.key?("zzzzzz")
20 21 22 23
  end

  def test_fetch_exists
    x = Object.new
24 25
    request.cookie_jar["foo"] = "bar"
    assert_equal "bar", request.cookie_jar.fetch("foo", x)
26 27 28 29
  end

  def test_fetch_block
    x = Object.new
30 31
    assert_not request.cookie_jar.key?("zzzzzz")
    assert_equal x, request.cookie_jar.fetch("zzzzzz") { x }
32 33 34
  end

  def test_key_is_to_s
35 36
    request.cookie_jar["foo"] = "bar"
    assert_equal "bar", request.cookie_jar.fetch(:foo)
37 38 39 40 41 42 43 44 45
  end

  def test_fetch_type_error
    assert_raises(KeyError) do
      request.cookie_jar.fetch(:omglolwut)
    end
  end

  def test_each
46
    request.cookie_jar["foo"] = :bar
47
    list = []
48
    request.cookie_jar.each do |k, v|
49 50 51
      list << [k, v]
    end

52
    assert_equal [["foo", :bar]], list
53 54 55
  end

  def test_enumerable
56
    request.cookie_jar["foo"] = :bar
57
    actual = request.cookie_jar.map { |k, v| [k.to_s, v.to_s] }
58
    assert_equal [["foo", "bar"]], actual
59 60 61 62 63 64 65 66 67 68 69 70 71 72
  end

  def test_key_methods
    assert !request.cookie_jar.key?(:foo)
    assert !request.cookie_jar.has_key?("foo")

    request.cookie_jar[:foo] = :bar
    assert request.cookie_jar.key?(:foo)
    assert request.cookie_jar.has_key?("foo")
  end

  def test_write_doesnt_set_a_nil_header
    headers = {}
    request.cookie_jar.write(headers)
73
    assert_not_includes headers, "Set-Cookie"
74 75 76
  end
end

77
class CookiesTest < ActionController::TestCase
78 79 80 81 82 83 84 85 86 87
  class CustomSerializer
    def self.load(value)
      value.to_s + " and loaded"
    end

    def self.dump(value)
      value.to_s + " was dumped"
    end
  end

D
Initial  
David Heinemeier Hansson 已提交
88
  class TestController < ActionController::Base
89 90
    def authenticate
      cookies["user_name"] = "david"
J
Jeremy Kemper 已提交
91
      head :ok
92 93
    end

94 95
    def set_with_with_escapable_characters
      cookies["that & guy"] = "foo & bar => baz"
J
Jeremy Kemper 已提交
96
      head :ok
97 98
    end

99
    def authenticate_for_fourteen_days
100
      cookies["user_name"] = { "value" => "david", "expires" => Time.utc(2005, 10, 10, 5) }
J
Jeremy Kemper 已提交
101
      head :ok
102 103
    end

104
    def authenticate_for_fourteen_days_with_symbols
105
      cookies[:user_name] = { value: "david", expires: Time.utc(2005, 10, 10, 5) }
J
Jeremy Kemper 已提交
106
      head :ok
107 108
    end

109
    def set_multiple_cookies
110
      cookies["user_name"] = { "value" => "david", "expires" => Time.utc(2005, 10, 10, 5) }
111
      cookies["login"]     = "XJ-122"
J
Jeremy Kemper 已提交
112
      head :ok
113
    end
J
Joshua Peek 已提交
114

115
    def access_frozen_cookies
J
Jeremy Kemper 已提交
116
      cookies["will"] = "work"
J
Jeremy Kemper 已提交
117
      head :ok
118 119
    end

120 121
    def logout
      cookies.delete("user_name")
J
Jeremy Kemper 已提交
122
      head :ok
123 124
    end

125 126
    alias delete_cookie logout

127
    def delete_cookie_with_path
128
      cookies.delete("user_name", path: "/beaten")
J
Jeremy Kemper 已提交
129
      head :ok
130 131
    end

132
    def authenticate_with_http_only
133
      cookies["user_name"] = { value: "david", httponly: true }
J
Jeremy Kemper 已提交
134
      head :ok
135
    end
136

137
    def authenticate_with_secure
138
      cookies["user_name"] = { value: "david", secure: true }
139 140
      head :ok
    end
141 142 143 144 145

    def set_permanent_cookie
      cookies.permanent[:user_name] = "Jamie"
      head :ok
    end
J
Joshua Peek 已提交
146

147 148 149 150
    def set_signed_cookie
      cookies.signed[:user_id] = 45
      head :ok
    end
J
Joshua Peek 已提交
151

152 153 154 155 156
    def get_signed_cookie
      cookies.signed[:user_id]
      head :ok
    end

157
    def set_encrypted_cookie
158
      cookies.encrypted[:foo] = "bar"
159 160 161
      head :ok
    end

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
    class JSONWrapper
      def initialize(obj)
        @obj = obj
      end

      def as_json(options = nil)
        "wrapped: #{@obj.as_json(options)}"
      end
    end

    def set_wrapped_signed_cookie
      cookies.signed[:user_id] = JSONWrapper.new(45)
      head :ok
    end

177
    def set_wrapped_encrypted_cookie
178
      cookies.encrypted[:foo] = JSONWrapper.new("bar")
179 180 181
      head :ok
    end

182 183 184 185 186
    def get_encrypted_cookie
      cookies.encrypted[:foo]
      head :ok
    end

187
    def set_invalid_encrypted_cookie
188
      cookies[:invalid_cookie] = "invalid--9170e00a57cfc27083363b5c75b835e477bd90cf"
189 190 191
      head :ok
    end

192
    def raise_data_overflow
193
      cookies.signed[:foo] = "bye!" * 1024
194 195 196 197 198 199 200 201 202
      head :ok
    end

    def tampered_cookies
      cookies[:tampered] = "BAh7BjoIZm9vIghiYXI%3D--123456780"
      cookies.signed[:tampered]
      head :ok
    end

203 204 205 206
    def set_permanent_signed_cookie
      cookies.permanent.signed[:remember_me] = 100
      head :ok
    end
207 208 209

    def delete_and_set_cookie
      cookies.delete :user_name
210
      cookies[:user_name] = { value: "david", expires: Time.utc(2005, 10, 10, 5) }
211 212
      head :ok
    end
213 214

    def set_cookie_with_domain
215
      cookies[:user_name] = { value: "rizwanreza", domain: :all }
216 217 218
      head :ok
    end

219
    def set_cookie_with_domain_all_as_string
220
      cookies[:user_name] = { value: "rizwanreza", domain: "all" }
221 222 223
      head :ok
    end

224
    def delete_cookie_with_domain
225
      cookies.delete(:user_name, domain: :all)
226 227
      head :ok
    end
228

229
    def delete_cookie_with_domain_all_as_string
230
      cookies.delete(:user_name, domain: "all")
231 232 233
      head :ok
    end

234
    def set_cookie_with_domain_and_tld
235
      cookies[:user_name] = { value: "rizwanreza", domain: :all, tld_length: 2 }
236 237 238 239
      head :ok
    end

    def delete_cookie_with_domain_and_tld
240
      cookies.delete(:user_name, domain: :all, tld_length: 2)
241 242 243
      head :ok
    end

244
    def set_cookie_with_domains
245
      cookies[:user_name] = { value: "rizwanreza", domain: %w(example1.com example2.com .example3.com) }
246 247 248 249
      head :ok
    end

    def delete_cookie_with_domains
250
      cookies.delete(:user_name, domain: %w(example1.com example2.com .example3.com))
251 252 253
      head :ok
    end

254 255 256 257 258 259
    def symbol_key
      cookies[:user_name] = "david"
      head :ok
    end

    def string_key
260
      cookies["user_name"] = "dhh"
261 262
      head :ok
    end
263 264 265 266 267 268 269

    def symbol_key_mock
      cookies[:user_name] = "david" if cookies[:user_name] == "andrew"
      head :ok
    end

    def string_key_mock
270
      cookies["user_name"] = "david" if cookies["user_name"] == "andrew"
271 272 273 274 275 276
      head :ok
    end

    def noop
      head :ok
    end
277 278 279 280

    def encrypted_cookie
      cookies.encrypted["foo"]
    end
281 282 283 284 285

    def cookie_expires_in_two_hours
      cookies[:user_name] = { value: "assain", expires: 2.hours }
      head :ok
    end
D
Initial  
David Heinemeier Hansson 已提交
286 287
  end

288
  tests TestController
D
Initial  
David Heinemeier Hansson 已提交
289

290
  SALT = "b3c631c314c0bbca50c1b2843150fe33"
291

292
  def setup
293
    super
A
Aaron Patterson 已提交
294

295
    @request.env["action_dispatch.key_generator"] = ActiveSupport::KeyGenerator.new(SALT, iterations: 2)
A
Aaron Patterson 已提交
296

297
    @request.env["action_dispatch.signed_cookie_salt"] =
298
      @request.env["action_dispatch.authenticated_encrypted_cookie_salt"] = SALT
A
Aaron Patterson 已提交
299

300
    @request.host = "www.nextangle.com"
301 302
  end

D
Initial  
David Heinemeier Hansson 已提交
303
  def test_setting_cookie
304
    get :authenticate
J
Jeremy Kemper 已提交
305
    assert_cookie_header "user_name=david; path=/"
306
    assert_equal({ "user_name" => "david" }, @response.cookies)
D
Initial  
David Heinemeier Hansson 已提交
307 308
  end

309
  def test_setting_the_same_value_to_cookie
310
    request.cookies[:user_name] = "david"
311
    get :authenticate
312
    assert_predicate response.cookies, :empty?
313 314 315
  end

  def test_setting_the_same_value_to_permanent_cookie
316
    request.cookies[:user_name] = "Jamie"
317
    get :set_permanent_cookie
318
    assert_equal({ "user_name" => "Jamie" }, response.cookies)
319 320
  end

321 322
  def test_setting_with_escapable_characters
    get :set_with_with_escapable_characters
J
Jeremy Kemper 已提交
323
    assert_cookie_header "that+%26+guy=foo+%26+bar+%3D%3E+baz; path=/"
324
    assert_equal({ "that & guy" => "foo & bar => baz" }, @response.cookies)
325 326
  end

327
  def test_setting_cookie_for_fourteen_days
328
    get :authenticate_for_fourteen_days
329
    assert_cookie_header "user_name=david; path=/; expires=Mon, 10 Oct 2005 05:00:00 -0000"
330
    assert_equal({ "user_name" => "david" }, @response.cookies)
331
  end
332

333
  def test_setting_cookie_for_fourteen_days_with_symbols
P
Pratik Naik 已提交
334
    get :authenticate_for_fourteen_days_with_symbols
335
    assert_cookie_header "user_name=david; path=/; expires=Mon, 10 Oct 2005 05:00:00 -0000"
336
    assert_equal({ "user_name" => "david" }, @response.cookies)
337 338
  end

339 340
  def test_setting_cookie_with_http_only
    get :authenticate_with_http_only
J
Jeremy Kemper 已提交
341
    assert_cookie_header "user_name=david; path=/; HttpOnly"
342
    assert_equal({ "user_name" => "david" }, @response.cookies)
343
  end
344

345
  def test_setting_cookie_with_secure
346
    @request.env["HTTPS"] = "on"
347 348
    get :authenticate_with_secure
    assert_cookie_header "user_name=david; path=/; secure"
349
    assert_equal({ "user_name" => "david" }, @response.cookies)
350
  end
351

L
lest 已提交
352
  def test_setting_cookie_with_secure_when_always_write_cookie_is_true
353
    old_cookie, @request.cookie_jar.always_write_cookie = @request.cookie_jar.always_write_cookie, true
354 355
    get :authenticate_with_secure
    assert_cookie_header "user_name=david; path=/; secure"
356
    assert_equal({ "user_name" => "david" }, @response.cookies)
357 358
  ensure
    @request.cookie_jar.always_write_cookie = old_cookie
359 360 361 362 363
  end

  def test_not_setting_cookie_with_secure
    get :authenticate_with_secure
    assert_not_cookie_header "user_name=david; path=/; secure"
364
    assert_not_equal({ "user_name" => "david" }, @response.cookies)
365 366
  end

367
  def test_multiple_cookies
368 369
    get :set_multiple_cookies
    assert_equal 2, @response.cookies.size
370
    assert_cookie_header "user_name=david; path=/; expires=Mon, 10 Oct 2005 05:00:00 -0000\nlogin=XJ-122; path=/"
371
    assert_equal({ "login" => "XJ-122", "user_name" => "david" }, @response.cookies)
372
  end
373

374
  def test_setting_test_cookie
375 376
    assert_nothing_raised { get :access_frozen_cookies }
  end
J
Joshua Peek 已提交
377

378
  def test_expiring_cookie
379
    request.cookies[:user_name] = "Joe"
380
    get :logout
381
    assert_cookie_header "user_name=; path=/; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
382
    assert_equal({ "user_name" => nil }, @response.cookies)
383
  end
J
Joshua Peek 已提交
384

385
  def test_delete_cookie_with_path
386
    request.cookies[:user_name] = "Joe"
387
    get :delete_cookie_with_path
388
    assert_cookie_header "user_name=; path=/beaten; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
389
  end
J
Jeremy Kemper 已提交
390

391 392 393
  def test_delete_unexisting_cookie
    request.cookies.clear
    get :delete_cookie
394
    assert_predicate @response.cookies, :empty?
395 396
  end

397
  def test_deleted_cookie_predicate
398
    cookies[:user_name] = "Joe"
399 400 401 402 403 404
    cookies.delete("user_name")
    assert cookies.deleted?("user_name")
    assert_equal false, cookies.deleted?("another")
  end

  def test_deleted_cookie_predicate_with_mismatching_options
405
    cookies[:user_name] = "Joe"
406 407
    cookies.delete("user_name", path: "/path")
    assert_equal false, cookies.deleted?("user_name", path: "/different")
408 409
  end

410
  def test_cookies_persist_throughout_request
Y
Yehuda Katz 已提交
411
    response = get :authenticate
412
    assert_match(/user_name=david/, response.headers["Set-Cookie"])
413
  end
414

415
  def test_set_permanent_cookie
416
    get :set_permanent_cookie
417 418
    assert_match(/Jamie/, @response.headers["Set-Cookie"])
    assert_match(%r(#{20.years.from_now.utc.year}), @response.headers["Set-Cookie"])
419
  end
J
Joshua Peek 已提交
420

421 422
  def test_read_permanent_cookie
    get :set_permanent_cookie
423
    assert_equal "Jamie", @controller.send(:cookies).permanent[:user_name]
424 425
  end

426 427 428 429 430 431 432 433 434 435
  def test_signed_cookie_using_default_digest
    get :set_signed_cookie
    cookies = @controller.send :cookies
    assert_not_equal 45, cookies[:user_id]
    assert_equal 45, cookies.signed[:user_id]

    key_generator = @request.env["action_dispatch.key_generator"]
    signed_cookie_salt = @request.env["action_dispatch.signed_cookie_salt"]
    secret = key_generator.generate_key(signed_cookie_salt)

436
    verifier = ActiveSupport::MessageVerifier.new(secret, serializer: Marshal, digest: "SHA1")
437 438 439 440
    assert_equal verifier.generate(45), cookies[:user_id]
  end

  def test_signed_cookie_using_custom_digest
441
    @request.env["action_dispatch.cookies_digest"] = "SHA256"
442 443 444 445 446 447 448 449 450
    get :set_signed_cookie
    cookies = @controller.send :cookies
    assert_not_equal 45, cookies[:user_id]
    assert_equal 45, cookies.signed[:user_id]

    key_generator = @request.env["action_dispatch.key_generator"]
    signed_cookie_salt = @request.env["action_dispatch.signed_cookie_salt"]
    secret = key_generator.generate_key(signed_cookie_salt)

451
    verifier = ActiveSupport::MessageVerifier.new(secret, serializer: Marshal, digest: "SHA256")
452 453 454
    assert_equal verifier.generate(45), cookies[:user_id]
  end

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
  def test_signed_cookie_using_default_serializer
    get :set_signed_cookie
    cookies = @controller.send :cookies
    assert_not_equal 45, cookies[:user_id]
    assert_equal 45, cookies.signed[:user_id]
  end

  def test_signed_cookie_using_marshal_serializer
    @request.env["action_dispatch.cookies_serializer"] = :marshal
    get :set_signed_cookie
    cookies = @controller.send :cookies
    assert_not_equal 45, cookies[:user_id]
    assert_equal 45, cookies.signed[:user_id]
  end

  def test_signed_cookie_using_json_serializer
    @request.env["action_dispatch.cookies_serializer"] = :json
    get :set_signed_cookie
    cookies = @controller.send :cookies
    assert_not_equal 45, cookies[:user_id]
    assert_equal 45, cookies.signed[:user_id]
  end

478 479 480 481
  def test_wrapped_signed_cookie_using_json_serializer
    @request.env["action_dispatch.cookies_serializer"] = :json
    get :set_wrapped_signed_cookie
    cookies = @controller.send :cookies
482 483
    assert_not_equal "wrapped: 45", cookies[:user_id]
    assert_equal "wrapped: 45", cookies.signed[:user_id]
484 485
  end

486 487 488 489
  def test_signed_cookie_using_custom_serializer
    @request.env["action_dispatch.cookies_serializer"] = CustomSerializer
    get :set_signed_cookie
    assert_not_equal 45, cookies[:user_id]
490
    assert_equal "45 was dumped and loaded", cookies.signed[:user_id]
491 492
  end

493
  def test_signed_cookie_using_hybrid_serializer_can_migrate_marshal_dumped_value_to_json
494 495 496 497 498
    @request.env["action_dispatch.cookies_serializer"] = :hybrid

    key_generator = @request.env["action_dispatch.key_generator"]
    signed_cookie_salt = @request.env["action_dispatch.signed_cookie_salt"]
    secret = key_generator.generate_key(signed_cookie_salt)
499 500 501

    marshal_value = ActiveSupport::MessageVerifier.new(secret, serializer: Marshal).generate(45)
    @request.headers["Cookie"] = "user_id=#{marshal_value}"
502 503 504 505 506 507

    get :get_signed_cookie

    cookies = @controller.send :cookies
    assert_not_equal 45, cookies[:user_id]
    assert_equal 45, cookies.signed[:user_id]
508

509
    verifier = ActiveSupport::MessageVerifier.new(secret, serializer: JSON)
510
    assert_equal 45, verifier.verify(@response.cookies["user_id"])
511 512 513 514 515 516 517 518
  end

  def test_signed_cookie_using_hybrid_serializer_can_read_from_json_dumped_value
    @request.env["action_dispatch.cookies_serializer"] = :hybrid

    key_generator = @request.env["action_dispatch.key_generator"]
    signed_cookie_salt = @request.env["action_dispatch.signed_cookie_salt"]
    secret = key_generator.generate_key(signed_cookie_salt)
519 520
    json_value = ActiveSupport::MessageVerifier.new(secret, serializer: JSON).generate(45)
    @request.headers["Cookie"] = "user_id=#{json_value}"
521 522 523 524 525 526

    get :get_signed_cookie

    cookies = @controller.send :cookies
    assert_not_equal 45, cookies[:user_id]
    assert_equal 45, cookies.signed[:user_id]
527 528

    assert_nil @response.cookies["user_id"]
529 530
  end

M
Melissa Xie 已提交
531
  def test_accessing_nonexistent_signed_cookie_should_not_raise_an_invalid_signature
532
    get :set_signed_cookie
A
Abhishek Jain 已提交
533
    assert_nil @controller.send(:cookies).signed[:non_existent_attribute]
534 535
  end

536
  def test_encrypted_cookie_using_default_serializer
537 538
    get :set_encrypted_cookie
    cookies = @controller.send :cookies
539
    assert_not_equal "bar", cookies[:foo]
540
    assert_nil cookies.signed[:foo]
541
    assert_equal "bar", cookies.encrypted[:foo]
542 543
  end

544 545
  def test_encrypted_cookie_using_marshal_serializer
    @request.env["action_dispatch.cookies_serializer"] = :marshal
546
    get :set_encrypted_cookie
547
    cookies = @controller.send :cookies
548
    assert_not_equal "bar", cookies[:foo]
549
    assert_nil cookies.signed[:foo]
550
    assert_equal "bar", cookies.encrypted[:foo]
551 552 553
  end

  def test_encrypted_cookie_using_json_serializer
554
    @request.env["action_dispatch.cookies_serializer"] = :json
555 556
    get :set_encrypted_cookie
    cookies = @controller.send :cookies
557
    assert_not_equal "bar", cookies[:foo]
558
    assert_nil cookies.signed[:foo]
559
    assert_equal "bar", cookies.encrypted[:foo]
560 561
  end

562 563 564 565
  def test_wrapped_encrypted_cookie_using_json_serializer
    @request.env["action_dispatch.cookies_serializer"] = :json
    get :set_wrapped_encrypted_cookie
    cookies = @controller.send :cookies
566
    assert_not_equal "wrapped: bar", cookies[:foo]
567
    assert_nil cookies.signed[:foo]
568
    assert_equal "wrapped: bar", cookies.encrypted[:foo]
569 570
  end

571 572 573
  def test_encrypted_cookie_using_custom_serializer
    @request.env["action_dispatch.cookies_serializer"] = CustomSerializer
    get :set_encrypted_cookie
574 575
    assert_not_equal "bar", cookies.encrypted[:foo]
    assert_equal "bar was dumped and loaded", cookies.encrypted[:foo]
576 577
  end

578
  def test_encrypted_cookie_using_hybrid_serializer_can_migrate_marshal_dumped_value_to_json
579 580
    @request.env["action_dispatch.cookies_serializer"] = :hybrid

581 582 583 584
    cipher = "aes-256-gcm"
    salt = @request.env["action_dispatch.authenticated_encrypted_cookie_salt"]
    secret = @request.env["action_dispatch.key_generator"].generate_key(salt)[0, ActiveSupport::MessageEncryptor.key_len(cipher)]
    encryptor = ActiveSupport::MessageEncryptor.new(secret, cipher: cipher, serializer: Marshal)
585

586 587
    marshal_value = encryptor.encrypt_and_sign("bar")
    @request.headers["Cookie"] = "foo=#{::Rack::Utils.escape marshal_value}"
588 589 590 591

    get :get_encrypted_cookie

    cookies = @controller.send :cookies
592 593
    assert_not_equal "bar", cookies[:foo]
    assert_equal "bar", cookies.encrypted[:foo]
594

595 596 597
    json_encryptor = ActiveSupport::MessageEncryptor.new(secret, cipher: cipher, serializer: JSON)
    assert_not_nil @response.cookies["foo"]
    assert_equal "bar", json_encryptor.decrypt_and_verify(@response.cookies["foo"])
598 599
  end

G
Godfrey Chan 已提交
600
  def test_encrypted_cookie_using_hybrid_serializer_can_read_from_json_dumped_value
601 602
    @request.env["action_dispatch.cookies_serializer"] = :hybrid

603 604 605 606
    cipher = "aes-256-gcm"
    salt = @request.env["action_dispatch.authenticated_encrypted_cookie_salt"]
    secret = @request.env["action_dispatch.key_generator"].generate_key(salt)[0, ActiveSupport::MessageEncryptor.key_len(cipher)]
    encryptor = ActiveSupport::MessageEncryptor.new(secret, cipher: cipher, serializer: JSON)
607

608 609
    json_value = encryptor.encrypt_and_sign("bar")
    @request.headers["Cookie"] = "foo=#{::Rack::Utils.escape json_value}"
V
Vipul A M 已提交
610 611 612 613 614 615

    get :get_encrypted_cookie

    cookies = @controller.send :cookies
    assert_not_equal "bar", cookies[:foo]
    assert_equal "bar", cookies.encrypted[:foo]
616

V
Vipul A M 已提交
617 618 619
    assert_nil @response.cookies["foo"]
  end

M
Melissa Xie 已提交
620
  def test_accessing_nonexistent_encrypted_cookie_should_not_raise_invalid_message
621
    get :set_encrypted_cookie
A
Abhishek Jain 已提交
622
    assert_nil @controller.send(:cookies).encrypted[:non_existent_attribute]
623 624 625 626 627
  end

  def test_setting_invalid_encrypted_cookie_should_return_nil_when_accessing_it
    get :set_invalid_encrypted_cookie
    assert_nil @controller.send(:cookies).encrypted[:invalid_cookie]
628 629
  end

630 631
  def test_permanent_signed_cookie
    get :set_permanent_signed_cookie
632
    assert_match(%r(#{20.years.from_now.utc.year}), @response.headers["Set-Cookie"])
633 634 635
    assert_equal 100, @controller.send(:cookies).signed[:remember_me]
  end

636
  def test_delete_and_set_cookie
637
    request.cookies[:user_name] = "Joe"
638
    get :delete_and_set_cookie
639
    assert_cookie_header "user_name=david; path=/; expires=Mon, 10 Oct 2005 05:00:00 -0000"
640
    assert_equal({ "user_name" => "david" }, @response.cookies)
641
  end
J
Joshua Peek 已提交
642

643 644 645 646 647 648 649 650 651 652 653 654 655
  def test_raise_data_overflow
    assert_raise(ActionDispatch::Cookies::CookieOverflow) do
      get :raise_data_overflow
    end
  end

  def test_tampered_cookies
    assert_nothing_raised do
      get :tampered_cookies
      assert_response :success
    end
  end

656 657 658 659 660 661 662 663 664
  def test_cookie_jar_mutated_by_request_persists_on_future_requests
    get :authenticate
    cookie_jar = @request.cookie_jar
    cookie_jar.signed[:user_id] = 123
    assert_equal ["user_name", "user_id"], @request.cookie_jar.instance_variable_get(:@cookies).keys
    get :get_signed_cookie
    assert_equal ["user_name", "user_id"], @request.cookie_jar.instance_variable_get(:@cookies).keys
  end

665 666
  def test_raises_argument_error_if_missing_secret
    assert_raise(ArgumentError, nil.inspect) {
667
      @request.env["action_dispatch.key_generator"] = ActiveSupport::LegacyKeyGenerator.new(nil)
668 669 670
      get :set_signed_cookie
    }

671
    assert_raise(ArgumentError, "".inspect) {
672
      @request.env["action_dispatch.key_generator"] = ActiveSupport::LegacyKeyGenerator.new("")
673 674 675 676 677 678
      get :set_signed_cookie
    }
  end

  def test_raises_argument_error_if_secret_is_probably_insecure
    assert_raise(ArgumentError, "password".inspect) {
679
      @request.env["action_dispatch.key_generator"] = ActiveSupport::LegacyKeyGenerator.new("password")
680 681 682 683
      get :set_signed_cookie
    }

    assert_raise(ArgumentError, "secret".inspect) {
684
      @request.env["action_dispatch.key_generator"] = ActiveSupport::LegacyKeyGenerator.new("secret")
685 686 687 688
      get :set_signed_cookie
    }

    assert_raise(ArgumentError, "12345678901234567890123456789".inspect) {
689
      @request.env["action_dispatch.key_generator"] = ActiveSupport::LegacyKeyGenerator.new("12345678901234567890123456789")
690 691 692 693
      get :set_signed_cookie
    }
  end

694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
  def test_signed_uses_signed_cookie_jar_if_only_secret_token_is_set
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = nil
    get :set_signed_cookie
    assert_kind_of ActionDispatch::Cookies::SignedCookieJar, cookies.signed
  end

  def test_signed_uses_signed_cookie_jar_if_only_secret_key_base_is_set
    @request.env["action_dispatch.secret_token"] = nil
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"
    get :set_signed_cookie
    assert_kind_of ActionDispatch::Cookies::SignedCookieJar, cookies.signed
  end

  def test_signed_uses_upgrade_legacy_signed_cookie_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"
    get :set_signed_cookie
    assert_kind_of ActionDispatch::Cookies::UpgradeLegacySignedCookieJar, cookies.signed
  end

715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
  def test_signed_or_encrypted_uses_signed_cookie_jar_if_only_secret_token_is_set
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = nil
    get :get_encrypted_cookie
    assert_kind_of ActionDispatch::Cookies::SignedCookieJar, cookies.signed_or_encrypted
  end

  def test_signed_or_encrypted_uses_encrypted_cookie_jar_if_only_secret_key_base_is_set
    @request.env["action_dispatch.secret_token"] = nil
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"
    get :get_encrypted_cookie
    assert_kind_of ActionDispatch::Cookies::EncryptedCookieJar, cookies.signed_or_encrypted
  end

  def test_signed_or_encrypted_uses_upgrade_legacy_encrypted_cookie_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"
    get :get_encrypted_cookie
    assert_kind_of ActionDispatch::Cookies::UpgradeLegacyEncryptedCookieJar, cookies.signed_or_encrypted
  end

  def test_encrypted_uses_encrypted_cookie_jar_if_only_secret_key_base_is_set
    @request.env["action_dispatch.secret_token"] = nil
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"
    get :get_encrypted_cookie
    assert_kind_of ActionDispatch::Cookies::EncryptedCookieJar, cookies.encrypted
  end

  def test_encrypted_uses_upgrade_legacy_encrypted_cookie_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"
    get :get_encrypted_cookie
    assert_kind_of ActionDispatch::Cookies::UpgradeLegacyEncryptedCookieJar, cookies.encrypted
  end

  def test_legacy_signed_cookie_is_read_and_transparently_upgraded_by_signed_cookie_jar_if_both_secret_token_and_secret_key_base_are_set
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

    legacy_value = ActiveSupport::MessageVerifier.new("b3c631c314c0bbca50c1b2843150fe33").generate(45)

    @request.headers["Cookie"] = "user_id=#{legacy_value}"
    get :get_signed_cookie

    assert_equal 45, @controller.send(:cookies).signed[:user_id]

    key_generator = @request.env["action_dispatch.key_generator"]
    secret = key_generator.generate_key(@request.env["action_dispatch.signed_cookie_salt"])
    verifier = ActiveSupport::MessageVerifier.new(secret)
    assert_equal 45, verifier.verify(@response.cookies["user_id"])
  end

767 768 769 770 771 772
  def test_legacy_signed_cookie_is_read_and_transparently_encrypted_by_encrypted_cookie_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"
    @request.env["action_dispatch.encrypted_cookie_salt"] = "4433796b79d99a7735553e316522acee"
    @request.env["action_dispatch.encrypted_signed_cookie_salt"] = "00646eb40062e1b1deff205a27cd30f9"

773
    legacy_value = ActiveSupport::MessageVerifier.new("b3c631c314c0bbca50c1b2843150fe33").generate("bar")
774 775 776 777

    @request.headers["Cookie"] = "foo=#{legacy_value}"
    get :get_encrypted_cookie

778
    assert_equal "bar", @controller.send(:cookies).encrypted[:foo]
779

780 781 782 783
    cipher = "aes-256-gcm"
    salt = @request.env["action_dispatch.authenticated_encrypted_cookie_salt"]
    secret = @request.env["action_dispatch.key_generator"].generate_key(salt)[0, ActiveSupport::MessageEncryptor.key_len(cipher)]
    encryptor = ActiveSupport::MessageEncryptor.new(secret, cipher: cipher, serializer: Marshal)
784
    assert_equal "bar", encryptor.decrypt_and_verify(@response.cookies["foo"])
785 786
  end

787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
  def test_legacy_json_signed_cookie_is_read_and_transparently_upgraded_by_signed_json_cookie_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.cookies_serializer"] = :json
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

    legacy_value = ActiveSupport::MessageVerifier.new("b3c631c314c0bbca50c1b2843150fe33", serializer: JSON).generate(45)

    @request.headers["Cookie"] = "user_id=#{legacy_value}"
    get :get_signed_cookie

    assert_equal 45, @controller.send(:cookies).signed[:user_id]

    key_generator = @request.env["action_dispatch.key_generator"]
    secret = key_generator.generate_key(@request.env["action_dispatch.signed_cookie_salt"])
    verifier = ActiveSupport::MessageVerifier.new(secret, serializer: JSON)
    assert_equal 45, verifier.verify(@response.cookies["user_id"])
  end

  def test_legacy_json_signed_cookie_is_read_and_transparently_encrypted_by_encrypted_json_cookie_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.cookies_serializer"] = :json
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

810
    legacy_value = ActiveSupport::MessageVerifier.new("b3c631c314c0bbca50c1b2843150fe33", serializer: JSON).generate("bar")
811 812 813 814

    @request.headers["Cookie"] = "foo=#{legacy_value}"
    get :get_encrypted_cookie

815
    assert_equal "bar", @controller.send(:cookies).encrypted[:foo]
816

817 818 819 820
    cipher = "aes-256-gcm"
    salt = @request.env["action_dispatch.authenticated_encrypted_cookie_salt"]
    secret = @request.env["action_dispatch.key_generator"].generate_key(salt)[0, ActiveSupport::MessageEncryptor.key_len(cipher)]
    encryptor = ActiveSupport::MessageEncryptor.new(secret, cipher: cipher, serializer: JSON)
821
    assert_equal "bar", encryptor.decrypt_and_verify(@response.cookies["foo"])
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
  end

  def test_legacy_json_signed_cookie_is_read_and_transparently_upgraded_by_signed_json_hybrid_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.cookies_serializer"] = :hybrid
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

    legacy_value = ActiveSupport::MessageVerifier.new("b3c631c314c0bbca50c1b2843150fe33", serializer: JSON).generate(45)

    @request.headers["Cookie"] = "user_id=#{legacy_value}"
    get :get_signed_cookie

    assert_equal 45, @controller.send(:cookies).signed[:user_id]

    key_generator = @request.env["action_dispatch.key_generator"]
    secret = key_generator.generate_key(@request.env["action_dispatch.signed_cookie_salt"])
    verifier = ActiveSupport::MessageVerifier.new(secret, serializer: JSON)
    assert_equal 45, verifier.verify(@response.cookies["user_id"])
  end

  def test_legacy_json_signed_cookie_is_read_and_transparently_encrypted_by_encrypted_hybrid_cookie_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.cookies_serializer"] = :hybrid
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

847
    legacy_value = ActiveSupport::MessageVerifier.new("b3c631c314c0bbca50c1b2843150fe33", serializer: JSON).generate("bar")
848 849 850 851

    @request.headers["Cookie"] = "foo=#{legacy_value}"
    get :get_encrypted_cookie

852
    assert_equal "bar", @controller.send(:cookies).encrypted[:foo]
853

854 855 856 857
    cipher = "aes-256-gcm"
    salt = @request.env["action_dispatch.authenticated_encrypted_cookie_salt"]
    secret = @request.env["action_dispatch.key_generator"].generate_key(salt)[0, ActiveSupport::MessageEncryptor.key_len(cipher)]
    encryptor = ActiveSupport::MessageEncryptor.new(secret, cipher: cipher, serializer: JSON)
858
    assert_equal "bar", encryptor.decrypt_and_verify(@response.cookies["foo"])
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
  end

  def test_legacy_marshal_signed_cookie_is_read_and_transparently_upgraded_by_signed_json_hybrid_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.cookies_serializer"] = :hybrid
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

    legacy_value = ActiveSupport::MessageVerifier.new("b3c631c314c0bbca50c1b2843150fe33").generate(45)

    @request.headers["Cookie"] = "user_id=#{legacy_value}"
    get :get_signed_cookie

    assert_equal 45, @controller.send(:cookies).signed[:user_id]

    key_generator = @request.env["action_dispatch.key_generator"]
    secret = key_generator.generate_key(@request.env["action_dispatch.signed_cookie_salt"])
    verifier = ActiveSupport::MessageVerifier.new(secret, serializer: JSON)
    assert_equal 45, verifier.verify(@response.cookies["user_id"])
  end

  def test_legacy_marshal_signed_cookie_is_read_and_transparently_encrypted_by_encrypted_hybrid_cookie_jar_if_both_secret_token_and_secret_key_base_are_set
    @request.env["action_dispatch.cookies_serializer"] = :hybrid
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

884
    legacy_value = ActiveSupport::MessageVerifier.new("b3c631c314c0bbca50c1b2843150fe33").generate("bar")
885 886 887 888

    @request.headers["Cookie"] = "foo=#{legacy_value}"
    get :get_encrypted_cookie

889
    assert_equal "bar", @controller.send(:cookies).encrypted[:foo]
890

891 892 893 894
    cipher = "aes-256-gcm"
    salt = @request.env["action_dispatch.authenticated_encrypted_cookie_salt"]
    secret = @request.env["action_dispatch.key_generator"].generate_key(salt)[0, ActiveSupport::MessageEncryptor.key_len(cipher)]
    encryptor = ActiveSupport::MessageEncryptor.new(secret, cipher: cipher, serializer: JSON)
895
    assert_equal "bar", encryptor.decrypt_and_verify(@response.cookies["foo"])
896 897
  end

898
  def test_legacy_signed_cookie_is_treated_as_nil_by_signed_cookie_jar_if_tampered
899 900 901 902 903 904
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

    @request.headers["Cookie"] = "user_id=45"
    get :get_signed_cookie

905 906
    assert_nil @controller.send(:cookies).signed[:user_id]
    assert_nil @response.cookies["user_id"]
907 908
  end

909 910 911 912 913 914 915
  def test_legacy_signed_cookie_is_treated_as_nil_by_encrypted_cookie_jar_if_tampered
    @request.env["action_dispatch.secret_token"] = "b3c631c314c0bbca50c1b2843150fe33"
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

    @request.headers["Cookie"] = "foo=baz"
    get :get_encrypted_cookie

916 917
    assert_nil @controller.send(:cookies).encrypted[:foo]
    assert_nil @response.cookies["foo"]
918 919
  end

920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
  def test_legacy_hmac_aes_cbc_encrypted_marshal_cookie_is_upgraded_to_authenticated_encrypted_cookie
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

    @request.env["action_dispatch.encrypted_cookie_salt"] =
      @request.env["action_dispatch.encrypted_signed_cookie_salt"] = SALT

    key_generator = @request.env["action_dispatch.key_generator"]
    encrypted_cookie_salt = @request.env["action_dispatch.encrypted_cookie_salt"]
    encrypted_signed_cookie_salt = @request.env["action_dispatch.encrypted_signed_cookie_salt"]
    secret = key_generator.generate_key(encrypted_cookie_salt)
    sign_secret = key_generator.generate_key(encrypted_signed_cookie_salt)
    marshal_value = ActiveSupport::MessageEncryptor.new(secret[0, ActiveSupport::MessageEncryptor.key_len], sign_secret, serializer: Marshal).encrypt_and_sign("bar")

    @request.headers["Cookie"] = "foo=#{marshal_value}"

    get :get_encrypted_cookie

    cookies = @controller.send :cookies
    assert_not_equal "bar", cookies[:foo]
    assert_equal "bar", cookies.encrypted[:foo]

    aead_cipher = "aes-256-gcm"
    aead_salt = @request.env["action_dispatch.authenticated_encrypted_cookie_salt"]
    aead_secret = key_generator.generate_key(aead_salt)[0, ActiveSupport::MessageEncryptor.key_len(aead_cipher)]
    aead_encryptor = ActiveSupport::MessageEncryptor.new(aead_secret, cipher: aead_cipher, serializer: Marshal)

    assert_equal "bar", aead_encryptor.decrypt_and_verify(@response.cookies["foo"])
  end

  def test_legacy_hmac_aes_cbc_encrypted_json_cookie_is_upgraded_to_authenticated_encrypted_cookie
    @request.env["action_dispatch.cookies_serializer"] = :json
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

    @request.env["action_dispatch.encrypted_cookie_salt"] =
      @request.env["action_dispatch.encrypted_signed_cookie_salt"] = SALT

    key_generator = @request.env["action_dispatch.key_generator"]
    encrypted_cookie_salt = @request.env["action_dispatch.encrypted_cookie_salt"]
    encrypted_signed_cookie_salt = @request.env["action_dispatch.encrypted_signed_cookie_salt"]
    secret = key_generator.generate_key(encrypted_cookie_salt)
    sign_secret = key_generator.generate_key(encrypted_signed_cookie_salt)
    marshal_value = ActiveSupport::MessageEncryptor.new(secret[0, ActiveSupport::MessageEncryptor.key_len], sign_secret, serializer: JSON).encrypt_and_sign("bar")

    @request.headers["Cookie"] = "foo=#{marshal_value}"

    get :get_encrypted_cookie

    cookies = @controller.send :cookies
    assert_not_equal "bar", cookies[:foo]
    assert_equal "bar", cookies.encrypted[:foo]

    aead_cipher = "aes-256-gcm"
    aead_salt = @request.env["action_dispatch.authenticated_encrypted_cookie_salt"]
    aead_secret = key_generator.generate_key(aead_salt)[0, ActiveSupport::MessageEncryptor.key_len(aead_cipher)]
    aead_encryptor = ActiveSupport::MessageEncryptor.new(aead_secret, cipher: aead_cipher, serializer: JSON)

    assert_equal "bar", aead_encryptor.decrypt_and_verify(@response.cookies["foo"])
  end

  def test_legacy_hmac_aes_cbc_encrypted_cookie_using_64_byte_key_is_upgraded_to_authenticated_encrypted_cookie
    @request.env["action_dispatch.secret_key_base"] = "c3b95688f35581fad38df788add315ff"

    @request.env["action_dispatch.encrypted_cookie_salt"] =
      @request.env["action_dispatch.encrypted_signed_cookie_salt"] = SALT

    # Cookie generated with 64 bytes secret
    message = ["566d4e75536d686e633246564e6b493062557079626c566d51574d30515430394c53315665564a694e4563786555744f57537454576b396a5a31566a626e52525054303d2d2d34663234333330623130623261306163363562316266323335396164666364613564643134623131"].pack("H*")
    @request.headers["Cookie"] = "foo=#{message}"

    get :get_encrypted_cookie

    cookies = @controller.send :cookies
    assert_not_equal "bar", cookies[:foo]
    assert_equal "bar", cookies.encrypted[:foo]
    cipher = "aes-256-gcm"

    salt = @request.env["action_dispatch.authenticated_encrypted_cookie_salt"]
    secret = @request.env["action_dispatch.key_generator"].generate_key(salt)[0, ActiveSupport::MessageEncryptor.key_len(cipher)]
    encryptor = ActiveSupport::MessageEncryptor.new(secret, cipher: cipher, serializer: Marshal)

    assert_equal "bar", encryptor.decrypt_and_verify(@response.cookies["foo"])
  end

1003 1004 1005 1006 1007 1008
  def test_cookie_with_all_domain_option
    get :set_cookie_with_domain
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.nextangle.com; path=/"
  end

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
  def test_cookie_with_all_domain_option_using_a_non_standard_tld
    @request.host = "two.subdomains.nextangle.local"
    get :set_cookie_with_domain
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.nextangle.local; path=/"
  end

  def test_cookie_with_all_domain_option_using_australian_style_tld
    @request.host = "nextangle.com.au"
    get :set_cookie_with_domain
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.nextangle.com.au; path=/"
  end

  def test_cookie_with_all_domain_option_using_uk_style_tld
    @request.host = "nextangle.co.uk"
    get :set_cookie_with_domain
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.nextangle.co.uk; path=/"
  end

  def test_cookie_with_all_domain_option_using_host_with_port
    @request.host = "nextangle.local:3000"
    get :set_cookie_with_domain
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.nextangle.local; path=/"
  end

1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
  def test_cookie_with_all_domain_option_using_localhost
    @request.host = "localhost"
    get :set_cookie_with_domain
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; path=/"
  end

  def test_cookie_with_all_domain_option_using_ipv4_address
    @request.host = "192.168.1.1"
    get :set_cookie_with_domain
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; path=/"
  end

  def test_cookie_with_all_domain_option_using_ipv6_address
    @request.host = "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
    get :set_cookie_with_domain
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; path=/"
  end

1058
  def test_deleting_cookie_with_all_domain_option
1059
    request.cookies[:user_name] = "Joe"
1060 1061
    get :delete_cookie_with_domain
    assert_response :success
1062
    assert_cookie_header "user_name=; domain=.nextangle.com; path=/; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
1063 1064
  end

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
  def test_cookie_with_all_domain_option_and_tld_length
    get :set_cookie_with_domain_and_tld
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.nextangle.com; path=/"
  end

  def test_cookie_with_all_domain_option_using_a_non_standard_tld_and_tld_length
    @request.host = "two.subdomains.nextangle.local"
    get :set_cookie_with_domain_and_tld
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.nextangle.local; path=/"
  end

1078 1079 1080 1081 1082 1083 1084
  def test_cookie_with_all_domain_option_using_a_non_standard_2_letter_tld
    @request.host = "admin.lvh.me"
    get :set_cookie_with_domain_and_tld
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.lvh.me; path=/"
  end

1085 1086 1087 1088 1089 1090 1091 1092
  def test_cookie_with_all_domain_option_using_host_with_port_and_tld_length
    @request.host = "nextangle.local:3000"
    get :set_cookie_with_domain_and_tld
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.nextangle.local; path=/"
  end

  def test_deleting_cookie_with_all_domain_option_and_tld_length
1093
    request.cookies[:user_name] = "Joe"
1094 1095
    get :delete_cookie_with_domain_and_tld
    assert_response :success
1096
    assert_cookie_header "user_name=; domain=.nextangle.com; path=/; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
1097 1098
  end

1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
  def test_cookie_with_several_preset_domains_using_one_of_these_domains
    @request.host = "example1.com"
    get :set_cookie_with_domains
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=example1.com; path=/"
  end

  def test_cookie_with_several_preset_domains_using_other_domain
    @request.host = "other-domain.com"
    get :set_cookie_with_domains
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; path=/"
  end

  def test_cookie_with_several_preset_domains_using_shared_domain
    @request.host = "example3.com"
    get :set_cookie_with_domains
    assert_response :success
    assert_cookie_header "user_name=rizwanreza; domain=.example3.com; path=/"
  end

  def test_deletings_cookie_with_several_preset_domains_using_one_of_these_domains
    @request.host = "example2.com"
1122
    request.cookies[:user_name] = "Joe"
1123 1124
    get :delete_cookie_with_domains
    assert_response :success
1125
    assert_cookie_header "user_name=; domain=example2.com; path=/; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
1126 1127 1128 1129
  end

  def test_deletings_cookie_with_several_preset_domains_using_other_domain
    @request.host = "other-domain.com"
1130
    request.cookies[:user_name] = "Joe"
1131 1132
    get :delete_cookie_with_domains
    assert_response :success
1133
    assert_cookie_header "user_name=; path=/; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
1134 1135
  end

1136
  def test_cookies_hash_is_indifferent_access
1137 1138
    get :symbol_key
    assert_equal "david", cookies[:user_name]
1139
    assert_equal "david", cookies["user_name"]
1140 1141
    get :string_key
    assert_equal "dhh", cookies[:user_name]
1142
    assert_equal "dhh", cookies["user_name"]
1143 1144
  end

1145
  def test_setting_request_cookies_is_indifferent_access
1146 1147
    cookies.clear
    cookies[:user_name] = "andrew"
1148
    get :string_key_mock
1149
    assert_equal "david", cookies["user_name"]
1150

1151
    cookies.clear
1152
    cookies["user_name"] = "andrew"
1153
    get :symbol_key_mock
1154
    assert_equal "david", cookies[:user_name]
1155 1156 1157 1158
  end

  def test_cookies_retained_across_requests
    get :symbol_key
1159
    assert_cookie_header "user_name=david; path=/"
1160 1161 1162
    assert_equal "david", cookies[:user_name]

    get :noop
1163
    assert_not_includes @response.headers, "Set-Cookie"
1164 1165 1166
    assert_equal "david", cookies[:user_name]

    get :noop
1167
    assert_not_includes @response.headers, "Set-Cookie"
1168 1169 1170 1171 1172 1173 1174
    assert_equal "david", cookies[:user_name]
  end

  def test_cookies_can_be_cleared
    get :symbol_key
    assert_equal "david", cookies[:user_name]

1175
    cookies.clear
1176 1177 1178 1179 1180 1181 1182
    get :noop
    assert_nil cookies[:user_name]

    get :symbol_key
    assert_equal "david", cookies[:user_name]
  end

1183
  def test_can_set_http_cookie_header
1184
    @request.env["HTTP_COOKIE"] = "user_name=david"
1185
    get :noop
1186 1187
    assert_equal "david", cookies["user_name"]
    assert_equal "david", cookies[:user_name]
1188 1189

    get :noop
1190 1191
    assert_equal "david", cookies["user_name"]
    assert_equal "david", cookies[:user_name]
1192

1193
    @request.env["HTTP_COOKIE"] = "user_name=andrew"
1194
    get :noop
1195 1196
    assert_equal "andrew", cookies["user_name"]
    assert_equal "andrew", cookies[:user_name]
1197 1198 1199
  end

  def test_can_set_request_cookies
1200
    @request.cookies["user_name"] = "david"
1201
    get :noop
1202 1203
    assert_equal "david", cookies["user_name"]
    assert_equal "david", cookies[:user_name]
1204 1205

    get :noop
1206 1207
    assert_equal "david", cookies["user_name"]
    assert_equal "david", cookies[:user_name]
1208

1209
    @request.cookies[:user_name] = "andrew"
1210
    get :noop
1211 1212
    assert_equal "andrew", cookies["user_name"]
    assert_equal "andrew", cookies[:user_name]
1213 1214 1215
  end

  def test_cookies_precedence_over_http_cookie
1216
    @request.env["HTTP_COOKIE"] = "user_name=andrew"
1217
    get :authenticate
1218 1219
    assert_equal "david", cookies["user_name"]
    assert_equal "david", cookies[:user_name]
1220 1221

    get :noop
1222 1223
    assert_equal "david", cookies["user_name"]
    assert_equal "david", cookies[:user_name]
1224 1225 1226
  end

  def test_cookies_precedence_over_request_cookies
1227
    @request.cookies["user_name"] = "andrew"
1228
    get :authenticate
1229 1230
    assert_equal "david", cookies["user_name"]
    assert_equal "david", cookies[:user_name]
1231

1232
    get :noop
1233 1234
    assert_equal "david", cookies["user_name"]
    assert_equal "david", cookies[:user_name]
1235 1236
  end

1237 1238 1239 1240 1241 1242
  def test_cookies_are_not_cleared
    cookies.encrypted["foo"] = "bar"
    get :noop
    assert_equal "bar", @controller.encrypted_cookie
  end

1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
  def test_signed_cookie_with_expires_set_relatively
    cookies.signed[:user_name] = { value: "assain", expires: 2.hours }

    travel 1.hour
    assert_equal "assain", cookies.signed[:user_name]

    travel 2.hours
    assert_nil cookies.signed[:user_name]
  end

  def test_encrypted_cookie_with_expires_set_relatively
    cookies.encrypted[:user_name] = { value: "assain", expires: 2.hours }

    travel 1.hour
    assert_equal "assain", cookies.encrypted[:user_name]

    travel 2.hours
    assert_nil cookies.encrypted[:user_name]
  end

  def test_vanilla_cookie_with_expires_set_relatively
    travel_to Time.utc(2017, 8, 15) do
      get :cookie_expires_in_two_hours
      assert_cookie_header "user_name=assain; path=/; expires=Tue, 15 Aug 2017 02:00:00 -0000"
    end
  end

J
Jeremy Kemper 已提交
1270 1271 1272 1273
  private
    def assert_cookie_header(expected)
      header = @response.headers["Set-Cookie"]
      if header.respond_to?(:to_str)
1274
        assert_equal expected.split("\n").sort, header.split("\n").sort
J
Jeremy Kemper 已提交
1275 1276 1277 1278
      else
        assert_equal expected.split("\n"), header
      end
    end
1279 1280 1281 1282 1283 1284 1285 1286 1287

    def assert_not_cookie_header(expected)
      header = @response.headers["Set-Cookie"]
      if header.respond_to?(:to_str)
        assert_not_equal expected.split("\n").sort, header.split("\n").sort
      else
        assert_not_equal expected.split("\n"), header
      end
    end
1288
end