3 []3@sdZddlZddlZddlZddlmZddlmZddl m Z ddl m Z ddl m Z dd l m Z dd l mZdd lmZdd lmZdd lmZddlmZddlmZejdeddGdddeZGdddeZdS)a werkzeug.contrib.securecookie ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This module implements a cookie that is not alterable from the client because it adds a checksum the server checks for. You can use it as session replacement if all you have is a user id or something to mark a logged in user. Keep in mind that the data is still readable from the client as a normal cookie is. However you don't have to store and flush the sessions you have at the server. Example usage: >>> from werkzeug.contrib.securecookie import SecureCookie >>> x = SecureCookie({"foo": 42, "baz": (1, 2, 3)}, "deadbeef") Dumping into a string so that one can store it in a cookie: >>> value = x.serialize() Loading from that string again: >>> x = SecureCookie.unserialize(value, "deadbeef") >>> x["baz"] (1, 2, 3) If someone modifies the cookie and the checksum is wrong the unserialize method will fail silently and return a new empty `SecureCookie` object. Keep in mind that the values will be visible in the cookie so do not store data in a cookie you don't want the user to see. Application Integration ======================= If you are using the werkzeug request objects you could integrate the secure cookie into your application like this:: from werkzeug.utils import cached_property from werkzeug.wrappers import BaseRequest from werkzeug.contrib.securecookie import SecureCookie # don't use this key but a different one; you could just use # os.urandom(20) to get something random SECRET_KEY = '\xfa\xdd\xb8z\xae\xe0}4\x8b\xea' class Request(BaseRequest): @cached_property def client_session(self): data = self.cookies.get('session_data') if not data: return SecureCookie(secret_key=SECRET_KEY) return SecureCookie.unserialize(data, SECRET_KEY) def application(environ, start_response): request = Request(environ) # get a response object here response = ... if request.client_session.should_save: session_data = request.client_session.serialize() response.set_cookie('session_data', session_data, httponly=True) return response(environ, start_response) A less verbose integration can be achieved by using shorthand methods:: class Request(BaseRequest): @cached_property def client_session(self): return SecureCookie.load_cookie(self, secret_key=COOKIE_SECRET) def application(environ, start_response): request = Request(environ) # get a response object here response = ... request.client_session.save_cookie(response) return response(environ, start_response) :copyright: 2007 Pallets :license: BSD-3-Clause N)sha1)new)time) iteritems) text_type)to_bytes) to_native) _date_to_unix)ModificationTrackingDict) safe_str_cmp)url_quote_plus)url_unquote_plusz'werkzeug.contrib.securecookie' is deprecated as of version 0.15 and will be removed in version 1.0. It has moved to https://github.com/pallets/secure-cookie.) stacklevelc@seZdZdZdS) UnquoteErrorz6Internal exception used to signal failures on quoting.N)__name__ __module__ __qualname____doc__rrA/tmp/pip-build-w1as9q70/Werkzeug/werkzeug/contrib/securecookie.pyrusrc @seZdZdZeeZeZdZ dddZ ddZ e dd Z ed d Zed d ZdddZeddZedddZdddZdS) SecureCookieaRepresents a secure cookie. You can subclass this class and provide an alternative mac method. The import thing is that the mac method is a function with a similar interface to the hashlib. Required methods are update() and digest(). Example usage: >>> x = SecureCookie({"foo": 42, "baz": (1, 2, 3)}, "deadbeef") >>> x["foo"] 42 >>> x["baz"] (1, 2, 3) >>> x["blafasel"] = 23 >>> x.should_save True :param data: the initial data. Either a dict, list of tuples or `None`. :param secret_key: the secret key. If not set `None` or not specified it has to be set before :meth:`serialize` is called. :param new: The initial value of the `new` flag. TNcCsJtj||p f|dk r"t|d}||_||_|jtkrFtjddddS)Nzutf-8zThe default 'SecureCookie.serialization_method' will change from pickle to json in version 1.0. To upgrade existing tokens, override 'unquote' to try pickle if json fails.r)r) r __init__r secret_keyrserialization_methodpicklewarningswarn)selfdatarrrrrrs  zSecureCookie.__init__cCs"d|jjtj||jrdndfS)Nz <%s %s%s>*) __class__rdict__repr__ should_save)rrrrr$szSecureCookie.__repr__cCs|jS)zTrue if the session should be saved. By default this is only true for :attr:`modified` cookies, not :attr:`new`. )modified)rrrrr%szSecureCookie.should_savecCs>|jdk r|jj|}|jr:djtjt|djj}|S)zQuote the value for the cookie. This can be any object supported by :attr:`serialization_method`. :param value: the value to quote. Nutf8) rdumps quote_base64joinbase64 b64encoder splitlinesstrip)clsvaluerrrquotes   zSecureCookie.quotec CsJy*|jrtj|}|jdk r(|jj|}|Stk rDtYnXdS)zUnquote the value for the cookie. If unquoting does not work a :exc:`UnquoteError` is raised. :param value: the value to unquote. N)r*r, b64decoderloads Exceptionr)r0r1rrrunquotes   zSecureCookie.unquotecCs|jdkrtd|r"t||d<g}t|jd|j}xRt|jD]B\}}|jdt||j |j dfj d|j d|d qDWdj tj|jjd j |gS) a{Serialize the secure cookie into a string. If expires is provided, the session will be automatically invalidated after expiration when you unseralize it. This provides better protection against session cookie theft. :param expires: an optional expiration date for the cookie (a :class:`datetime.datetime` object) Nzno secret key defined_expiresz%s=%sascii|?&)r RuntimeErrorr hmac hash_methodsorteditemsappendr r2decodeencodeupdater+r,r-digestr/)rexpiresresultmackeyr1rrr serializes  zSecureCookie.serializec Cst|tr|jdd}t|tr,|jdd}y|jdd\}}Wnttfk r^f}YnFXi}t|d|j}xv|jdD]h}|jd|d|krd}P|jdd\}} t |j d }y t |}Wnt k rYnX| ||<q~Wyt j|} Wntk rd}} YnX|dk rt| |jry*x$t|D]\}} |j| ||<q>WWntk rvf}Yn(Xd |krt|d krf}n|d =nf}|||d S) zLoad the secure cookie from a serialized string. :param string: the cookie value to unserialize. :param secret_key: the secret key used to serialize the cookie. :return: a new :class:`SecureCookie`. zutf-8replacer;r:Nr<r9=r8r7F) isinstancerrEsplit ValueError IndexErrorr?r@rFrrDr UnicodeErrorr,r3 TypeErrorr rGrr6rr) r0stringrZ base64_hashrrBrJitemrKr1Z client_hashrrr unserializesL         zSecureCookie.unserializesessioncCs&|jj|}|s||dS|j||S)aLoads a :class:`SecureCookie` from a cookie in request. If the cookie is not set, a new :class:`SecureCookie` instanced is returned. :param request: a request object that has a `cookies` attribute which is a dict of all cookie values. :param key: the name of the cookie. :param secret_key: the secret key used to unquote the cookie. Always provide the value even though it has no default! )r)cookiesgetrW)r0requestrKrrrrr load_cookie5s  zSecureCookie.load_cookie/Fc Cs6| s |jr2|j|p|} |j|| |||||| ddS)a=Saves the SecureCookie in a cookie on response object. All parameters that are not described here are forwarded directly to :meth:`~BaseResponse.set_cookie`. :param response: a response object that has a :meth:`~BaseResponse.set_cookie` method. :param key: the name of the cookie. :param session_expires: the expiration date of the secure cookie stored information. If this is not provided the cookie `expires` date is used instead. )rHmax_agepathdomainsecurehttponlyN)r%rL set_cookie) rresponserKrHZsession_expiresr^r_r`rarbforcerrrr save_cookieGs zSecureCookie.save_cookie)NNT)N)rXN) rXNNNr]NNFF)rrrr staticmethod _default_hashr@rrr*rr$propertyr% classmethodr2r6rLrWr\rfrrrrrys,      7 r)rr,rrhashlibrrhr?rr_compatrrrr Z _internalr Zcontrib.sessionsr securityr urlsr rrDeprecationWarningr5rrrrrrZs*