/usr/share/pyshared/zope/session/http.py is in python-zope.session 3.9.4-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | ##############################################################################
#
# Copyright (c) 2004 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Session implementation using cookies
"""
import hmac
import logging
import random
import re
import string
import sys
import time
from cStringIO import StringIO
if sys.version_info[:2] >= (2, 5):
from hashlib import sha1
from email.utils import formatdate
else:
import sha as sha1
from email.Utils import formatdate
import zope.location
from persistent import Persistent
from zope import schema, component
from zope.interface import implements
from zope.publisher.interfaces.http import IHTTPRequest
from zope.publisher.interfaces.http import IHTTPApplicationRequest
from zope.i18nmessageid import ZopeMessageFactory as _
from zope.session.interfaces import IClientIdManager
from zope.schema.fieldproperty import FieldProperty
__docformat__ = 'restructuredtext'
cookieSafeTrans = string.maketrans("+/", "-.")
logger = logging.getLogger()
def digestEncode(s):
"""Encode SHA digest for cookie."""
return s.encode("base64")[:-2].translate(cookieSafeTrans)
class MissingClientIdException(Exception):
"""No ClientId found in Request"""
class ICookieClientIdManager(IClientIdManager):
"""Manages sessions using a cookie"""
namespace = schema.ASCIILine(
title=_('Cookie Name'),
description=_(
"Name of cookie used to maintain state. "
"Must be unique to the site domain name, and only contain "
"ASCII letters, digits and '_'"
),
required=True,
min_length=1,
max_length=30,
constraint=re.compile("^[\d\w_]+$").search,
)
cookieLifetime = schema.Int(
title=_('Cookie Lifetime'),
description=_(
"Number of seconds until the browser expires the cookie. "
"Leave blank expire the cookie when the browser is quit. "
"Set to 0 to never expire. "
),
min=0,
required=False,
default=None,
missing_value=None,
)
thirdparty = schema.Bool(
title=_('Third party cookie'),
description=_(
"Is a third party issuing the identification cookie? "
"Servers like Apache or Nginx have capabilities to issue "
"identification cookies too. If Third party cookies are "
"beeing used, Zope will never send a cookie back, just check "
"for them."
),
required=False,
default=False,
)
domain = schema.TextLine(
title=_('Effective domain'),
description=_(
"An identification cookie can be restricted to a specific domain "
"using this option. This option sets the ``domain`` attribute "
"for the cookie header. It is useful for setting one "
"identification cookie for multiple subdomains. So if this "
"option is set to ``.example.org``, the cookie will be available "
"for subdomains like ``yourname.example.org``. "
"Note that if you set this option to some domain, the identification "
"cookie won't be available for other domains, so, for example "
"you won't be able to login using the SessionCredentials plugin "
"via another domain."
),
required=False,
)
secure = schema.Bool(
title=_('Request Secure communication'),
required=False,
default=False,
)
postOnly = schema.Bool(
title=_('Only set cookie on POST requests'),
required=False,
default=False,
)
class CookieClientIdManager(zope.location.Location, Persistent):
"""Session utility implemented using cookies."""
implements(IClientIdManager, ICookieClientIdManager)
thirdparty = FieldProperty(ICookieClientIdManager['thirdparty'])
cookieLifetime = FieldProperty(ICookieClientIdManager['cookieLifetime'])
secure = FieldProperty(ICookieClientIdManager['secure'])
postOnly = FieldProperty(ICookieClientIdManager['postOnly'])
domain = FieldProperty(ICookieClientIdManager['domain'])
namespace = FieldProperty(ICookieClientIdManager['namespace'])
def __init__(self, namespace=None, secret=None):
"""Create the cookie-based cleint id manager
We can pass namespace (cookie name) and/or secret string
for generating client unique ids.
If we don't pass either of them, they will be generated
automatically, this is very handy when storing id manager
in the persistent database, so they are saved between
application restarts.
>>> manager1 = CookieClientIdManager()
>>> len(manager1.namespace) > 0
True
>>> len(manager1.secret) > 0
True
We can specify cookie name by hand.
>>> manager2 = CookieClientIdManager('service_cookie')
>>> manager2.namespace
'service_cookie'
If we want to use CookieClientIdManager object as a non-persistent
utility, we need to specify some constant secret, so it won't be
recreated on each application restart.
>>> manager3 = CookieClientIdManager(secret='some_secret')
>>> manager3.secret
'some_secret'
Of course, we can specify both cookie name and secret.
>>> manager4 = CookieClientIdManager('service_cookie', 'some_secret')
>>> manager4.namespace
'service_cookie'
>>> manager4.secret
'some_secret'
"""
if namespace is None:
namespace = "zope3_cs_%x" % (int(time.time()) - 1000000000)
if secret is None:
secret = '%.20f' % random.random()
else:
secret = str(secret)
self.namespace = namespace
self.secret = secret
def getClientId(self, request):
"""Get the client id
This creates one if necessary:
>>> from zope.publisher.http import HTTPRequest
>>> request = HTTPRequest(StringIO(''), {})
>>> bim = CookieClientIdManager()
>>> id = bim.getClientId(request)
>>> id == bim.getClientId(request)
True
The id is retained accross requests:
>>> request2 = HTTPRequest(StringIO(''), {})
>>> request2._cookies = dict(
... [(name, cookie['value'])
... for (name, cookie) in request.response._cookies.items()
... ])
>>> id == bim.getClientId(request2)
True
>>> bool(id)
True
Note that the return value of this function is a string, not
an IClientId. This is because this method is used to implement
the IClientId Adapter.
>>> type(id) == type('')
True
We don't set the client id unless we need to, so, for example,
the second response doesn't have cookies set:
>>> request2.response._cookies
{}
An exception to this is if the cookieLifetime is set to a
non-zero integer value, in which case we do set it on every
request, regardless of when it was last set:
>>> bim.cookieLifetime = 3600 # one hour
>>> id == bim.getClientId(request2)
True
>>> bool(request2.response._cookies)
True
If the postOnly attribute is set to a true value, then cookies
will only be set on POST requests.
>>> bim.postOnly = True
>>> request = HTTPRequest(StringIO(''), {})
>>> bim.getClientId(request)
Traceback (most recent call last):
...
MissingClientIdException
>>> print request.response.getCookie(bim.namespace)
None
>>> request = HTTPRequest(StringIO(''), {'REQUEST_METHOD': 'POST'})
>>> id = bim.getClientId(request)
>>> id == bim.getClientId(request)
True
>>> request.response.getCookie(bim.namespace) is not None
True
>>> bim.postOnly = False
It's also possible to use third-party cookies. E.g. Apache `mod_uid`
or Nginx `ngx_http_userid_module` are able to issue user tracking
cookies in front of Zope. In case thirdparty is activated Zope may
not set a cookie.
>>> bim.thirdparty = True
>>> request = HTTPRequest(StringIO(''), {})
>>> bim.getClientId(request)
Traceback (most recent call last):
...
MissingClientIdException
>>> print request.response.getCookie(bim.namespace)
None
"""
sid = self.getRequestId(request)
if sid is None:
if (self.thirdparty
or
(self.postOnly and not (request.method == 'POST'))
):
raise MissingClientIdException
else:
sid = self.generateUniqueId()
self.setRequestId(request, sid)
elif (not self.thirdparty) and self.cookieLifetime:
# If we have a finite cookie lifetime, then set the cookie
# on each request to avoid losing it.
self.setRequestId(request, sid)
return sid
def generateUniqueId(self):
"""Generate a new, random, unique id.
>>> bim = CookieClientIdManager()
>>> id1 = bim.generateUniqueId()
>>> id2 = bim.generateUniqueId()
>>> id1 != id2
True
"""
data = "%.20f%.20f%.20f" % (random.random(), time.time(), time.clock())
# BBB code for Python 2.4, inspired by the fallback in hmac
if hasattr(sha1, '__call__'):
digest = sha1(data).digest()
else:
digest = sha1.new(data).digest()
s = digestEncode(digest)
# we store a HMAC of the random value together with it, which makes
# our session ids unforgeable.
mac = hmac.new(self.secret, s, digestmod=sha1).digest()
return s + digestEncode(mac)
def getRequestId(self, request):
"""Return the browser id encoded in request as a string
Return None if an id is not set.
For example:
>>> from zope.publisher.http import HTTPRequest
>>> request = HTTPRequest(StringIO(''), {}, None)
>>> bim = CookieClientIdManager()
Because no cookie has been set, we get no id:
>>> bim.getRequestId(request) is None
True
We can set an id:
>>> id1 = bim.generateUniqueId()
>>> bim.setRequestId(request, id1)
And get it back:
>>> bim.getRequestId(request) == id1
True
When we set the request id, we also set a response cookie. We
can simulate getting this cookie back in a subsequent request:
>>> request2 = HTTPRequest(StringIO(''), {}, None)
>>> request2._cookies = dict(
... [(name, cookie['value'])
... for (name, cookie) in request.response._cookies.items()
... ])
And we get the same id back from the new request:
>>> bim.getRequestId(request) == bim.getRequestId(request2)
True
Test a corner case where Python 2.6 hmac module does not allow
unicode as input:
>>> id_uni = unicode(bim.generateUniqueId())
>>> bim.setRequestId(request, id_uni)
>>> bim.getRequestId(request) == id_uni
True
If another server is managing the ClientId cookies (Apache, Nginx)
we're returning their value without checking:
>>> bim.namespace = 'uid'
>>> bim.thirdparty = True
>>> request3 = HTTPRequest(StringIO(''), {}, None)
>>> request3._cookies = {'uid': 'AQAAf0Y4gjgAAAQ3AwMEAg=='}
>>> bim.getRequestId(request3)
'AQAAf0Y4gjgAAAQ3AwMEAg=='
"""
response_cookie = request.response.getCookie(self.namespace)
if response_cookie:
sid = response_cookie['value']
else:
request = IHTTPApplicationRequest(request)
sid = request.getCookies().get(self.namespace, None)
if self.thirdparty:
return sid
else:
# If there is an id set on the response, use that but
# don't trust it. We need to check the response in case
# there has already been a new session created during the
# course of this request.
if sid is None or len(sid) != 54:
return None
s, mac = sid[:27], sid[27:]
# call encode() on value s a workaround a bug where the hmac
# module only accepts str() types in Python 2.6
if (digestEncode(hmac.new(
self.secret, s.encode(), digestmod=sha1
).digest()) != mac):
return None
else:
return sid
def setRequestId(self, request, id):
"""Set cookie with id on request.
This sets the response cookie:
See the examples in getRequestId.
Note that the id is checked for validity. Setting an
invalid value is silently ignored:
>>> from zope.publisher.http import HTTPRequest
>>> request = HTTPRequest(StringIO(''), {}, None)
>>> bim = CookieClientIdManager()
>>> bim.getRequestId(request)
>>> bim.setRequestId(request, 'invalid id')
>>> bim.getRequestId(request)
For now, the cookie path is the application URL:
>>> cookie = request.response.getCookie(bim.namespace)
>>> cookie['path'] == request.getApplicationURL(path_only=True)
True
By default, session cookies don't expire:
>>> cookie.has_key('expires')
False
Expiry time of 0 means never (well - close enough)
>>> bim.cookieLifetime = 0
>>> request = HTTPRequest(StringIO(''), {}, None)
>>> bid = bim.getClientId(request)
>>> cookie = request.response.getCookie(bim.namespace)
>>> cookie['expires']
'Tue, 19 Jan 2038 00:00:00 GMT'
A non-zero value means to expire after than number of seconds:
>>> bim.cookieLifetime = 3600
>>> request = HTTPRequest(StringIO(''), {}, None)
>>> bid = bim.getClientId(request)
>>> cookie = request.response.getCookie(bim.namespace)
>>> import rfc822
>>> expires = time.mktime(rfc822.parsedate(cookie['expires']))
>>> expires > time.mktime(time.gmtime()) + 55*60
True
If another server in front of Zope (Apache, Nginx) is managing the
cookies we won't set any ClientId cookies:
>>> request = HTTPRequest(StringIO(''), {}, None)
>>> bim.thirdparty = True
>>> bim.setRequestId(request, '1234')
>>> cookie = request.response.getCookie(bim.namespace)
>>> cookie
If the secure attribute is set to a true value, then the
secure cookie option is included.
>>> bim.thirdparty = False
>>> bim.cookieLifetime = None
>>> request = HTTPRequest(StringIO(''), {}, None)
>>> bim.secure = True
>>> bim.setRequestId(request, '1234')
>>> print request.response.getCookie(bim.namespace)
{'path': '/', 'secure': True, 'value': '1234'}
If the domain is specified, it will be set as a cookie attribute.
>>> bim.domain = u'.example.org'
>>> bim.setRequestId(request, '1234')
>>> print request.response.getCookie(bim.namespace)
{'path': '/', 'domain': u'.example.org', 'secure': True, 'value': '1234'}
When the cookie is set, cache headers are added to the
response to try to prevent the cookie header from being cached:
>>> request.response.getHeader('Cache-Control')
'no-cache="Set-Cookie,Set-Cookie2"'
>>> request.response.getHeader('Pragma')
'no-cache'
>>> request.response.getHeader('Expires')
'Mon, 26 Jul 1997 05:00:00 GMT'
"""
# TODO: Currently, the path is the ApplicationURL. This is reasonable,
# and will be adequate for most purposes.
# A better path to use would be that of the folder that contains
# the site manager this service is registered within. However,
# that would be expensive to look up on each request, and would
# have to be altered to take virtual hosting into account.
# Seeing as this utility instance has a unique namespace for its
# cookie, using ApplicationURL shouldn't be a problem.
if self.thirdparty:
logger.warning('ClientIdManager is using thirdparty cookies, '
'ignoring setIdRequest call')
return
response = request.response
options = {}
if self.cookieLifetime is not None:
if self.cookieLifetime:
expires = formatdate(time.time() + self.cookieLifetime,
localtime=False, usegmt=True)
else:
expires = 'Tue, 19 Jan 2038 00:00:00 GMT'
options['expires'] = expires
if self.secure:
options['secure'] = True
if self.domain:
options['domain'] = self.domain
response.setCookie(
self.namespace, id,
path=request.getApplicationURL(path_only=True),
**options)
response.setHeader('Cache-Control', 'no-cache="Set-Cookie,Set-Cookie2"')
response.setHeader('Pragma', 'no-cache')
response.setHeader('Expires', 'Mon, 26 Jul 1997 05:00:00 GMT')
def notifyVirtualHostChanged(event):
"""Adjust cookie paths when IVirtualHostRequest information changes.
Given an event, this method should call a CookieClientIdManager's
setRequestId if a cookie is present in the response for that manager. To
demonstrate we create a dummy manager object and event:
>>> class DummyManager(object):
... implements(ICookieClientIdManager)
... namespace = 'foo'
... thirdparty = False
... request_id = None
... def setRequestId(self, request, id):
... self.request_id = id
...
>>> manager = DummyManager()
>>> component.provideUtility(manager, IClientIdManager)
>>> from zope.publisher.http import HTTPRequest
>>> class DummyEvent (object):
... request = HTTPRequest(StringIO(''), {}, None)
>>> event = DummyEvent()
With no cookies present, the manager should not be called:
>>> notifyVirtualHostChanged(event)
>>> manager.request_id is None
True
However, when a cookie *has* been set, the manager is called so it can
update the cookie if need be:
>>> event.request.response.setCookie('foo', 'bar')
>>> notifyVirtualHostChanged(event)
>>> manager.request_id
'bar'
If a server in front of Zope manages the ClientIds (Apache, Nginx), we
don't need to take care about the cookies
>>> manager2 = DummyManager()
>>> manager2.thirdparty = True
>>> event2 = DummyEvent()
However, when a cookie *has* been set, the manager is called so it can
update the cookie if need be:
>>> event2.request.response.setCookie('foo2', 'bar2')
>>> notifyVirtualHostChanged(event2)
>>> id = manager2.request_id
>>> id is None
True
Cleanup of the utility registration:
>>> import zope.component.testing
>>> zope.component.testing.tearDown()
"""
# the event sends us a IHTTPApplicationRequest, but we need a
# IHTTPRequest for the response attribute, and so does the cookie-
# manager.
request = IHTTPRequest(event.request, None)
if event.request is None:
return
for name, manager in component.getUtilitiesFor(IClientIdManager):
if manager and ICookieClientIdManager.providedBy(manager):
# Third party ClientId Managers need no modification at all
if not manager.thirdparty:
cookie = request.response.getCookie(manager.namespace)
if cookie:
manager.setRequestId(request, cookie['value'])
|