Ñò
ô†³Kc @ s' d Z d d k Z d d k Z d d k Z d d k Z d d k Z y d d k l Z Wn e j
o d d k Z n Xd d k
l Z d „ Z e
e i d d e ƒ i ƒ ƒ Z e e
e e i ƒ ƒ ƒ Z d% d& d' d( g Z g Z e D] \ Z Z e e e f që [ Z e i ƒ e d „ Z d „ Z d e f d „ ƒ YZ d i g Z e d d ƒ D] Z e e e ƒ q\[ ƒ Z! d „ Z" d e# f d „ ƒ YZ$ d e% f d „ ƒ YZ& d e# f d „ ƒ YZ' e' Z( d d) d d d! d" „ Z* d d d g Z+ d# e, j o# d d k- Z- e- i. d$ e- i/ ƒ n d S(* s
Cookie "Saved" Authentication
This authentication middleware saves the current REMOTE_USER,
REMOTE_SESSION, and any other environment variables specified in a
cookie so that it can be retrieved during the next request without
requiring re-authentication. This uses a session cookie on the client
side (so it goes away when the user closes their window) and does
server-side expiration.
Following is a very simple example where a form is presented asking for
a user name (no actual checking), and dummy session identifier (perhaps
corresponding to a database session id) is stored in the cookie.
::
>>> from paste.httpserver import serve
>>> from paste.fileapp import DataApp
>>> from paste.httpexceptions import *
>>> from paste.auth.cookie import AuthCookieHandler
>>> from paste.wsgilib import parse_querystring
>>> def testapp(environ, start_response):
... user = dict(parse_querystring(environ)).get('user','')
... if user:
... environ['REMOTE_USER'] = user
... environ['REMOTE_SESSION'] = 'a-session-id'
... if environ.get('REMOTE_USER'):
... page = 'Welcome %s (%s)'
... page %= (environ['REMOTE_USER'], environ['REMOTE_SESSION'])
... else:
... page = ('')
... return DataApp(page, content_type="text/html")(
... environ, start_response)
>>> serve(AuthCookieHandler(testapp))
serving on...
iÿÿÿÿN( t sha1( t get_cookiesc C s t i d t i | ƒ ƒ S( Ns
%Y%m%d%H%M( t timet strftimet gmtime( t value( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyt make_time5 s t xs \s \x5ct "s \x22t =s \x3dt ;s \x3bc C s t d „ | t | ƒ ƒ S( Nc S s | \ } } | i | | ƒ S( ( t replace( t at .1t bt c( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyt A s ( t reducet str( t st sublist( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyt encode@ s c C s
t | t ƒ S( ( R t _decode( R ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyR B s t CookieTooLargec B s e Z d „ Z RS( c C s# t i d ƒ | | _ | | _ d S( Ns* Signed cookie exceeds maximum size of 4096( t RuntimeErrort __init__t contentt cookie( t selfR R ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyR E s
( t __name__t
__module__R ( ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyR D s t i iÿ c C s d i t i t d ƒ ƒ S( s returns a 64 byte secret R i@ ( t joint randomt samplet
_all_chars( ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyt
new_secretK s t AuthCookieSignerc B s2 e Z d Z d d d d „ Z d „ Z d „ Z RS( s
save/restore ``environ`` entries via digially signed cookie
This class converts content into a timed and digitally signed
cookie, as well as having the facility to reverse this procedure.
If the cookie, after the content is encoded and signed exceeds the
maximum length (4096), then CookieTooLarge exception is raised.
The timeout of the cookie is handled on the server side for a few
reasons. First, if a 'Expires' directive is added to a cookie, then
the cookie becomes persistent (lasting even after the browser window
has closed). Second, the user's clock may be wrong (perhaps
intentionally). The timeout is specified in minutes; and expiration
date returned is rounded to one second.
Constructor Arguments:
``secret``
This is a secret key if you want to syncronize your keys so
that the cookie will be good across a cluster of computers.
It is recommended via the HMAC specification (RFC 2104) that
the secret key be 64 bytes since this is the block size of
the hashing. If you do not provide a secret key, a random
one is generated each time you create the handler; this
should be sufficient for most cases.
``timeout``
This is the time (in minutes) from which the cookie is set
to expire. Note that on each request a new (replacement)
cookie is sent, hence this is effectively a session timeout
parameter for your entire cluster. If you do not provide a
timeout, it is set at 30 minutes.
``maxlen``
This is the maximum size of the *signed* cookie; hence the
actual content signed will be somewhat less. If the cookie
goes over this size, a ``CookieTooLarge`` exception is
raised so that unexpected handling of cookies on the client
side are avoided. By default this is set at 4k (4096 bytes),
which is the standard cookie size limit.
c C s[ | p d | _ t | t ƒ o t d | ƒ ‚ n | p d | _ | p t ƒ | _ d S( Ni s5 Timeout must be a number (minutes), not a string (%r)i ( t timeoutt
isinstancet
basestringt
ValueErrort maxlenR$ t secret( R R+ R& R* ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyR } s c C s¯ t i t i | i | t ƒ i ƒ t t i ƒ d | i ƒ | ƒ } | i
d d ƒ i
d d ƒ } | i
d d ƒ i
d d ƒ } t | ƒ | i j o t
| | ƒ ‚ n | S( sÈ
Sign the content returning a valid cookie (that does not
need to be escaped and quoted). The expiration of this
cookie is handled server-side in the auth() function.
i< t /t _R t ~s
R s
( t base64t encodestringt hmact newR+ R t digestR R R& R t lenR* R ( R R R ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyt sign† s 6
c C sŸ t i | i d d ƒ i d d ƒ ƒ } | t } | t t !} | t } | t i | i | t ƒ i ƒ j o. t
| ƒ t
t t i ƒ ƒ ƒ j o | Sn d S( s…
Authenticate the cooke using the signature, verify that it
has not expired; and return the cookie's content
R- R, R. R N(
R/ t decodestringR t _signature_sizet _header_sizeR1 R2 R+ R R3 t intR R ( R R t decodet signaturet expiresR ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyt auth– s !
%%N( R R t __doc__t NoneR R5 R= ( ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyR% O s - t AuthCookieEnvironc B s e Z d Z d „ Z d „ Z RS( sH
a list of environment keys to be saved via cookie
An instance of this object, found at ``environ['paste.auth.cookie']``
lists the `environ` keys that were restored from or will be added
to the digially signed cookie. This object can be accessed from an
`environ` variable by using this module's name.
c C s t i | | ƒ | | _ d S( N( t listR t handler( R RB t scanlist( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyR · s c C s, | | j o d St i | t | ƒ ƒ d S( N( RA t appendR ( R R ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyRD º s
( R R R> R RD ( ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyR@ ® s t AuthCookieHandlerc B sJ e Z d Z d Z d Z e Z e Z d d d d d d d „ Z
d „ Z RS( sÏ
the actual handler that should be put in your middleware stack
This middleware uses cookies to stash-away a previously authenticated
user (and perhaps other variables) so that re-authentication is not
needed. This does not implement sessions; and therefore N servers
can be syncronized to accept the same saved authentication if they
all use the same cookie_name and secret.
By default, this handler scans the `environ` for the REMOTE_USER
and REMOTE_SESSION key; if found, it is stored. It can be
configured to scan other `environ` keys as well -- but be careful
not to exceed 2-3k (so that the encoded and signed cookie does not
exceed 4k). You can ask it to handle other environment variables
by doing:
``environ['paste.auth.cookie'].append('your.environ.variable')``
Constructor Arguments:
``application``
This is the wrapped application which will have access to
the ``environ['REMOTE_USER']`` restored by this middleware.
``cookie_name``
The name of the cookie used to store this content, by default
it is ``PASTE_AUTH_COOKIE``.
``scanlist``
This is the initial set of ``environ`` keys to
save/restore to the signed cookie. By default is consists
only of ``REMOTE_USER`` and ``REMOTE_SESSION``; any tuple
or list of environment keys will work. However, be
careful, as the total saved size is limited to around 3k.
``signer``
This is the signer object used to create the actual cookie
values, by default, it is ``AuthCookieSigner`` and is passed
the remaining arguments to this function: ``secret``,
``timeout``, and ``maxlen``.
At this time, each cookie is individually signed. To store more
than the 4k of data; it is possible to sub-class this object to
provide different ``environ_name`` and ``cookie_name``
s paste.auth.cookiet PASTE_AUTH_COOKIEc C sY | p | i | | | ƒ } n | | _ | p d | _ | | _ | p | i | _ d S( Nt REMOTE_USERt REMOTE_SESSION( RG RH ( t signer_classt signerRC t applicationt cookie_name( R RK RL RC RJ R+ R& R* ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyR ÷ s c
sj ˆ i ˆ j o t d ƒ ‚ n ˆ i ˆ ˆ i ƒ } t ˆ ƒ } | i ˆ i ƒ oà ˆ i i | ˆ i i ƒ } | oœ x™ | i
d ƒ D]„ } | i
d ƒ \ } } t | ƒ } | | j o | i | ƒ n | ˆ j o q‡ n t | ƒ ˆ | RP RL R% RI R@ R[ R? R Rb ( ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyRE ¿ s 2RF RG RH i i c C sß t | t ƒ o | i ƒ } n | d j o | i d ƒ o | d } n y t | ƒ } Wn# t j
o t d | ƒ ‚ n Xy t | ƒ } Wn# t j
o t d | ƒ ‚ n Xt | d | d | d | d | d | ƒS( sá
This middleware uses cookies to stash-away a previously
authenticated user (and perhaps other variables) so that
re-authentication is not needed. This does not implement
sessions; and therefore N servers can be syncronized to accept the
same saved authentication if they all use the same cookie_name and
secret.
By default, this handler scans the `environ` for the REMOTE_USER
and REMOTE_SESSION key; if found, it is stored. It can be
configured to scan other `environ` keys as well -- but be careful
not to exceed 2-3k (so that the encoded and signed cookie does not
exceed 4k). You can ask it to handle other environment variables
by doing:
``environ['paste.auth.cookie'].append('your.environ.variable')``
Configuration:
``cookie_name``
The name of the cookie used to store this content, by
default it is ``PASTE_AUTH_COOKIE``.
``scanlist``
This is the initial set of ``environ`` keys to
save/restore to the signed cookie. By default is consists
only of ``REMOTE_USER`` and ``REMOTE_SESSION``; any
space-separated list of environment keys will work.
However, be careful, as the total saved size is limited to
around 3k.
``secret``
The secret that will be used to sign the cookies. If you
don't provide one (and none is set globally) then a random
secret will be created. Each time the server is restarted
a new secret will then be created and all cookies will
become invalid! This can be any string value.
``timeout``
The time to keep the cookie, expressed in minutes. This
is handled server-side, so a new cookie with a new timeout
is added to every response.
``maxlen``
The maximum length of the cookie that is sent (default 4k,
which is a typical browser maximum)
R+ s' Bad value for timeout (must be int): %rs& Bad value for maxlen (must be int): %rRL RC R& R* N( R' R( R] R? RO R9 R) RE ( t appt global_confRL RC R+ R& R* ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyt make_auth_cookie7 s" > t __main__t optionflags( s \s \x5c( R s \x22( R s \x3d( R
s \x3b( s REMOTE_USERs REMOTE_SESSION(0 R> R1 R/ R! R R^ t hashlibR t ImportErrort shat
paste.requestR R R4 R2 R3 R7 R8 t _encodet _[1]RU RV R t reverseR R: R R R t _[2]t rangeR t chrR# R$ t objectR% RA R@ RE t
middlewareR? Re t __all__R t doctestt testmodt ELLIPSIS( ( ( s5 /usr/lib/python2.6/site-packages/paste/auth/cookie.pyt * s> < ! -
9 _u H