1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
|
import base64
import json
import pickle
import unittest
from pyramid import testing
class SharedCookieSessionTests:
def test_ctor_no_cookie(self):
request = testing.DummyRequest()
session = self._makeOne(request)
self.assertEqual(dict(session), {})
def test_instance_conforms(self):
from zope.interface.verify import verifyObject
from pyramid.interfaces import ISession
request = testing.DummyRequest()
session = self._makeOne(request)
verifyObject(ISession, session)
def test_ctor_with_cookie_still_valid(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time(), 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request)
self.assertEqual(dict(session), {'state': 1})
def test_ctor_with_cookie_expired(self):
request = testing.DummyRequest()
cookieval = self._serialize((0, 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request)
self.assertEqual(dict(session), {})
def test_ctor_with_bad_cookie_cannot_deserialize(self):
request = testing.DummyRequest()
request.cookies['session'] = 'abc'
session = self._makeOne(request)
self.assertEqual(dict(session), {})
def test_ctor_with_bad_cookie_not_tuple(self):
request = testing.DummyRequest()
cookieval = self._serialize('abc')
request.cookies['session'] = cookieval
session = self._makeOne(request)
self.assertEqual(dict(session), {})
def test_timeout(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time() - 5, 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, timeout=1)
self.assertEqual(dict(session), {})
def test_timeout_never(self):
import time
request = testing.DummyRequest()
LONG_TIME = 31536000
cookieval = self._serialize((time.time() + LONG_TIME, 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, timeout=None)
self.assertEqual(dict(session), {'state': 1})
def test_timeout_str(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time() - 5, 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, timeout='1')
self.assertEqual(dict(session), {})
def test_timeout_invalid(self):
request = testing.DummyRequest()
self.assertRaises(
ValueError, self._makeOne, request, timeout='Invalid value'
)
def test_changed(self):
request = testing.DummyRequest()
session = self._makeOne(request)
self.assertEqual(session.changed(), None)
self.assertTrue(session._dirty)
def test_invalidate(self):
request = testing.DummyRequest()
session = self._makeOne(request)
session['a'] = 1
self.assertEqual(session.invalidate(), None)
self.assertFalse('a' in session)
def test_reissue_triggered(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time() - 2, 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request)
self.assertEqual(session['state'], 1)
self.assertTrue(session._dirty)
def test__set_cookie_on_exception(self):
request = testing.DummyRequest()
request.exception = True
session = self._makeOne(request)
session._cookie_on_exception = False
response = DummyResponse()
self.assertEqual(session._set_cookie(response), False)
def test__set_cookie_on_exception_no_request_exception(self):
import webob
request = testing.DummyRequest()
request.exception = None
session = self._makeOne(request)
session._cookie_on_exception = False
response = webob.Response()
self.assertEqual(session._set_cookie(response), True)
self.assertEqual(response.headerlist[-1][0], 'Set-Cookie')
def test__set_cookie_cookieval_too_long(self):
request = testing.DummyRequest()
session = self._makeOne(request)
session['abc'] = 'x' * 100000
response = DummyResponse()
self.assertRaises(ValueError, session._set_cookie, response)
def test__set_cookie_real_webob_response(self):
import webob
request = testing.DummyRequest()
session = self._makeOne(request)
session['abc'] = 'x'
response = webob.Response()
self.assertEqual(session._set_cookie(response), True)
self.assertEqual(response.headerlist[-1][0], 'Set-Cookie')
def test__set_cookie_options(self):
from pyramid.response import Response
request = testing.DummyRequest()
request.exception = None
session = self._makeOne(
request,
cookie_name='abc',
path='/foo',
domain='localhost',
secure=True,
httponly=True,
)
session['abc'] = 'x'
response = Response()
self.assertEqual(session._set_cookie(response), True)
cookieval = response.headerlist[-1][1]
val, domain, path, secure, httponly, samesite = [
x.strip() for x in cookieval.split(';')
]
self.assertTrue(val.startswith('abc='))
self.assertEqual(domain, 'Domain=localhost')
self.assertEqual(path, 'Path=/foo')
self.assertEqual(secure, 'secure')
self.assertEqual(httponly, 'HttpOnly')
self.assertEqual(samesite, 'SameSite=Lax')
def test_flash_default(self):
request = testing.DummyRequest()
session = self._makeOne(request)
session.flash('msg1')
session.flash('msg2')
self.assertEqual(session['_f_'], ['msg1', 'msg2'])
def test_flash_allow_duplicate_false(self):
request = testing.DummyRequest()
session = self._makeOne(request)
session.flash('msg1')
session.flash('msg1', allow_duplicate=False)
self.assertEqual(session['_f_'], ['msg1'])
def test_flash_allow_duplicate_true_and_msg_not_in_storage(self):
request = testing.DummyRequest()
session = self._makeOne(request)
session.flash('msg1', allow_duplicate=True)
self.assertEqual(session['_f_'], ['msg1'])
def test_flash_allow_duplicate_false_and_msg_not_in_storage(self):
request = testing.DummyRequest()
session = self._makeOne(request)
session.flash('msg1', allow_duplicate=False)
self.assertEqual(session['_f_'], ['msg1'])
def test_flash_mixed(self):
request = testing.DummyRequest()
session = self._makeOne(request)
session.flash('warn1', 'warn')
session.flash('warn2', 'warn')
session.flash('err1', 'error')
session.flash('err2', 'error')
self.assertEqual(session['_f_warn'], ['warn1', 'warn2'])
def test_pop_flash_default_queue(self):
request = testing.DummyRequest()
session = self._makeOne(request)
queue = ['one', 'two']
session['_f_'] = queue
result = session.pop_flash()
self.assertEqual(result, queue)
self.assertEqual(session.get('_f_'), None)
def test_pop_flash_nodefault_queue(self):
request = testing.DummyRequest()
session = self._makeOne(request)
queue = ['one', 'two']
session['_f_error'] = queue
result = session.pop_flash('error')
self.assertEqual(result, queue)
self.assertEqual(session.get('_f_error'), None)
def test_peek_flash_default_queue(self):
request = testing.DummyRequest()
session = self._makeOne(request)
queue = ['one', 'two']
session['_f_'] = queue
result = session.peek_flash()
self.assertEqual(result, queue)
self.assertEqual(session.get('_f_'), queue)
def test_peek_flash_nodefault_queue(self):
request = testing.DummyRequest()
session = self._makeOne(request)
queue = ['one', 'two']
session['_f_error'] = queue
result = session.peek_flash('error')
self.assertEqual(result, queue)
self.assertEqual(session.get('_f_error'), queue)
def test_new_csrf_token(self):
request = testing.DummyRequest()
session = self._makeOne(request)
token = session.new_csrf_token()
self.assertEqual(token, session['_csrft_'])
def test_get_csrf_token(self):
request = testing.DummyRequest()
session = self._makeOne(request)
session['_csrft_'] = 'token'
token = session.get_csrf_token()
self.assertEqual(token, 'token')
self.assertTrue('_csrft_' in session)
def test_get_csrf_token_new(self):
request = testing.DummyRequest()
session = self._makeOne(request)
token = session.get_csrf_token()
self.assertTrue(token)
self.assertTrue('_csrft_' in session)
def test_no_set_cookie_with_exception(self):
import webob
request = testing.DummyRequest()
request.exception = True
session = self._makeOne(request, set_on_exception=False)
session['a'] = 1
callbacks = request.response_callbacks
self.assertEqual(len(callbacks), 1)
response = webob.Response()
result = callbacks[0](request, response)
self.assertEqual(result, None)
self.assertFalse('Set-Cookie' in dict(response.headerlist))
def test_set_cookie_with_exception(self):
import webob
request = testing.DummyRequest()
request.exception = True
session = self._makeOne(request)
session['a'] = 1
callbacks = request.response_callbacks
self.assertEqual(len(callbacks), 1)
response = webob.Response()
result = callbacks[0](request, response)
self.assertEqual(result, None)
self.assertTrue('Set-Cookie' in dict(response.headerlist))
def test_cookie_is_set(self):
import webob
request = testing.DummyRequest()
session = self._makeOne(request)
session['a'] = 1
callbacks = request.response_callbacks
self.assertEqual(len(callbacks), 1)
response = webob.Response()
result = callbacks[0](request, response)
self.assertEqual(result, None)
self.assertTrue('Set-Cookie' in dict(response.headerlist))
class TestBaseCookieSession(SharedCookieSessionTests, unittest.TestCase):
def _makeOne(self, request, **kw):
from pyramid.session import BaseCookieSessionFactory
serializer = DummySerializer()
return BaseCookieSessionFactory(serializer, **kw)(request)
def _serialize(self, value):
return base64.b64encode(json.dumps(value).encode('utf-8'))
def test_reissue_not_triggered(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time(), 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, reissue_time=1)
self.assertEqual(session['state'], 1)
self.assertFalse(session._dirty)
def test_reissue_never(self):
request = testing.DummyRequest()
cookieval = self._serialize((0, 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, reissue_time=None, timeout=None)
self.assertEqual(session['state'], 1)
self.assertFalse(session._dirty)
def test_reissue_str_triggered(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time() - 2, 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, reissue_time='0')
self.assertEqual(session['state'], 1)
self.assertTrue(session._dirty)
def test_reissue_invalid(self):
request = testing.DummyRequest()
self.assertRaises(
ValueError, self._makeOne, request, reissue_time='invalid value'
)
def test_cookie_max_age_invalid(self):
request = testing.DummyRequest()
self.assertRaises(
ValueError, self._makeOne, request, max_age='invalid value'
)
class TestSignedCookieSession(SharedCookieSessionTests, unittest.TestCase):
def _makeOne(self, request, **kw):
from pyramid.session import SignedCookieSessionFactory
kw.setdefault('secret', 'secret')
return SignedCookieSessionFactory(**kw)(request)
def _serialize(self, value, salt=b'pyramid.session.', hashalg='sha512'):
import base64
import hashlib
import hmac
import json
digestmod = lambda: hashlib.new(hashalg)
cstruct = json.dumps(value).encode('utf-8')
sig = hmac.new(salt + b'secret', cstruct, digestmod).digest()
return base64.urlsafe_b64encode(sig + cstruct).rstrip(b'=')
def test_reissue_not_triggered(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time(), 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, reissue_time=1)
self.assertEqual(session['state'], 1)
self.assertFalse(session._dirty)
def test_reissue_never(self):
request = testing.DummyRequest()
cookieval = self._serialize((0, 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, reissue_time=None, timeout=None)
self.assertEqual(session['state'], 1)
self.assertFalse(session._dirty)
def test_reissue_str_triggered(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time() - 2, 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, reissue_time='0')
self.assertEqual(session['state'], 1)
self.assertTrue(session._dirty)
def test_reissue_invalid(self):
request = testing.DummyRequest()
self.assertRaises(
ValueError, self._makeOne, request, reissue_time='invalid value'
)
def test_cookie_max_age_invalid(self):
request = testing.DummyRequest()
self.assertRaises(
ValueError, self._makeOne, request, max_age='invalid value'
)
def test_custom_salt(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time(), 0, {'state': 1}), salt=b'f.')
request.cookies['session'] = cookieval
session = self._makeOne(request, salt=b'f.')
self.assertEqual(session['state'], 1)
def test_salt_mismatch(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time(), 0, {'state': 1}), salt=b'f.')
request.cookies['session'] = cookieval
session = self._makeOne(request, salt=b'g.')
self.assertEqual(session, {})
def test_custom_hashalg(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize(
(time.time(), 0, {'state': 1}), hashalg='sha1'
)
request.cookies['session'] = cookieval
session = self._makeOne(request, hashalg='sha1')
self.assertEqual(session['state'], 1)
def test_hashalg_mismatch(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize(
(time.time(), 0, {'state': 1}), hashalg='sha1'
)
request.cookies['session'] = cookieval
session = self._makeOne(request, hashalg='sha256')
self.assertEqual(session, {})
def test_secret_mismatch(self):
import time
request = testing.DummyRequest()
cookieval = self._serialize((time.time(), 0, {'state': 1}))
request.cookies['session'] = cookieval
session = self._makeOne(request, secret='evilsecret')
self.assertEqual(session, {})
def test_custom_serializer(self):
import base64
from hashlib import sha512
import hmac
import time
request = testing.DummyRequest()
serializer = DummySerializer()
cstruct = serializer.dumps((time.time(), 0, {'state': 1}))
sig = hmac.new(b'pyramid.session.secret', cstruct, sha512).digest()
cookieval = base64.urlsafe_b64encode(sig + cstruct).rstrip(b'=')
request.cookies['session'] = cookieval
session = self._makeOne(request, serializer=serializer)
self.assertEqual(session['state'], 1)
def test_invalid_data_size(self):
import base64
from hashlib import sha512
request = testing.DummyRequest()
num_bytes = sha512().digest_size - 1
cookieval = base64.b64encode(b' ' * num_bytes)
request.cookies['session'] = cookieval
session = self._makeOne(request)
self.assertEqual(session, {})
def test_very_long_key(self):
verylongkey = b'a' * 1024
import webob
request = testing.DummyRequest()
session = self._makeOne(request, secret=verylongkey)
session['a'] = 1
callbacks = request.response_callbacks
self.assertEqual(len(callbacks), 1)
response = webob.Response()
try:
result = callbacks[0](request, response)
except TypeError: # pragma: no cover
self.fail('HMAC failed to initialize due to key length.')
self.assertEqual(result, None)
self.assertTrue('Set-Cookie' in dict(response.headerlist))
class Test_manage_accessed(unittest.TestCase):
def _makeOne(self, wrapped):
from pyramid.session import manage_accessed
return manage_accessed(wrapped)
def test_accessed_set(self):
request = testing.DummyRequest()
session = DummySessionFactory(request)
session.renewed = 0
wrapper = self._makeOne(session.__class__.get)
wrapper(session, 'a')
self.assertNotEqual(session.accessed, None)
self.assertTrue(session._dirty)
def test_accessed_without_renew(self):
import time
request = testing.DummyRequest()
session = DummySessionFactory(request)
session._reissue_time = 5
session.renewed = time.time()
wrapper = self._makeOne(session.__class__.get)
wrapper(session, 'a')
self.assertNotEqual(session.accessed, None)
self.assertFalse(session._dirty)
def test_already_dirty(self):
request = testing.DummyRequest()
session = DummySessionFactory(request)
session.renewed = 0
session._dirty = True
session['a'] = 1
wrapper = self._makeOne(session.__class__.get)
self.assertEqual(wrapper.__doc__, session.get.__doc__)
result = wrapper(session, 'a')
self.assertEqual(result, 1)
callbacks = request.response_callbacks
if callbacks is not None:
self.assertEqual(len(callbacks), 0)
class Test_manage_changed(unittest.TestCase):
def _makeOne(self, wrapped):
from pyramid.session import manage_changed
return manage_changed(wrapped)
def test_it(self):
request = testing.DummyRequest()
session = DummySessionFactory(request)
wrapper = self._makeOne(session.__class__.__setitem__)
wrapper(session, 'a', 1)
self.assertNotEqual(session.accessed, None)
self.assertTrue(session._dirty)
class TestPickleSerializer(unittest.TestCase):
"""
.. deprecated:: 2.0
"""
def _makeOne(self):
from pyramid.session import PickleSerializer
return PickleSerializer()
def test_loads(self):
# generated from dumping Dummy() using protocol=2
cstruct = b'\x80\x02ctests.test_session\nDummy\nq\x00)\x81q\x01.'
serializer = self._makeOne()
result = serializer.loads(cstruct)
self.assertIsInstance(result, Dummy)
def test_loads_raises_ValueError_on_invalid_data(self):
cstruct = b'not pickled'
serializer = self._makeOne()
self.assertRaises(ValueError, serializer.loads, cstruct)
def test_loads_raises_ValueError_on_bad_import(self):
# generated from dumping an object that cannot be found anymore, eg:
# class Foo: pass
# print(pickle.dumps(Foo()))
cstruct = b'(i__main__\nFoo\np0\n(dp1\nb.'
serializer = self._makeOne()
self.assertRaises(ValueError, serializer.loads, cstruct)
def test_dumps(self):
obj = Dummy()
serializer = self._makeOne()
result = serializer.dumps(obj)
expected_result = pickle.dumps(obj, protocol=pickle.HIGHEST_PROTOCOL)
self.assertEqual(result, expected_result)
self.assertIsInstance(result, bytes)
class Dummy:
pass
class DummySerializer:
def dumps(self, value):
return base64.b64encode(json.dumps(value).encode('utf-8'))
def loads(self, value):
return json.loads(base64.b64decode(value).decode('utf-8'))
class DummySessionFactory(dict):
_dirty = False
_cookie_name = 'session'
_cookie_max_age = None
_cookie_path = '/'
_cookie_domain = None
_cookie_secure = False
_cookie_httponly = False
_timeout = 1200
_reissue_time = 0
def __init__(self, request):
self.request = request
dict.__init__(self, {})
def changed(self):
self._dirty = True
class DummyResponse:
def __init__(self):
self.headerlist = []
|