Ñò
ìÿÒXc
@ sz d d k Z d d k Z d d k Z d d k Z d d k l Z d d k l Z d d k l
Z
d e f d „ ƒ YZ d S( iÿÿÿÿN( t urlparse( t timegm( t log_mgrt Cookiec B sº e Z d Z d e f d „ ƒ YZ d e f d „ ƒ YZ e i d ƒ Z e i d e i ƒ Z
h d d 6d d 6d d
6d d 6d d 6d
d
6Z e d „ ƒ Z
e d# d „ ƒ Z e d „ ƒ Z e d „ ƒ Z e d# d „ ƒ Z e d# d „ ƒ Z d# d# d# d# d# d# d# d „ Z e d „ ƒ Z e i d „ ƒ Z e d „ ƒ Z e i d „ ƒ Z e d „ ƒ Z e i d „ ƒ Z d „ Z d „ Z d „ Z d „ Z d „ Z d „ Z d! „ Z d" „ Z! RS($ só
A Cookie object has the following attributes:
key
The name of the cookie
value
The value of the cookie
A Cookie also supports these predefined optional attributes. If an
optional attribute is not set on the cookie it's value is None.
domain
Restrict cookie usage to this domain
path
Restrict cookie usage to this path or below
expires
Cookie is invalid after this UTC timestamp
max_age
Cookie is invalid this many seconds in the future.
Has precedence over the expires attribute.
secure
Cookie should only be returned on secure (i.e. SSL/TLS)
connections.
httponly
Cookie is intended only for HTTP communication, it can
never be utilized in any other context (e.g. browser
Javascript).
See the documentation of get_expiration() for an explanation of
how the expires and max-age attributes interact as well as the
role of the timestamp attribute. Expiration values are stored as
datetime objects for easy manipulation and comparision.
There are two ways to instantiate a Cookie object. Either directly
via the constructor or by calling the class function parse() which
returns a list of Cookie objects found in a string.
To create a cookie to sent to a client:
Example:
cookie = Cookie('session', session_id,
domain=my_domain, path=mypath,
httpOnly=True, secure=True, expires=expiration)
headers.append(('Set-Cookie', str(cookie)))
To receive cookies from a request:
Example:
cookies = Cookie.parse(response.getheader('Set-Cookie'), request_url)
t Expiredc B s e Z RS( ( t __name__t
__module__( ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyR s t URLMismatchc B s e Z RS( ( R R ( ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyR „ s s ;\s*s@ ^\s*([a-zA-Z0-9\!\#\$\%\&\'\*\+\-\.\^\_\`\|\~]+)\s*=\s*(.*?)\s*$t domaint patht max_ages max-aget expirest securet httponlyc C s t | i ƒ ƒ S( sg
Timestamps (timestamp & expires) are stored as datetime
objects in UTC. It's non-obvious how to convert a naive UTC
datetime into a unix time value (seconds since the epoch
UTC). That functionality is oddly missing from the datetime
and time modules. This utility provides that missing
functionality.
( R t utctimetuple( t clst dt( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt datetime_to_time– s c C s[ | i ƒ } | d j o# | i ƒ d j o t d ƒ ‚ n t i i | i | ƒ d t ƒS( sO
Given a datetime object in UTC generate RFC 1123 date string.
g s timezone is not UTCt usegmtN( t utcoffsett Nonet
total_secondst
ValueErrort emailt utilst
formatdateR t True( R R R ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt datetime_to_string£ s c C sd | i ƒ } y& t i t i i | ƒ d d !Œ } Wn+ t j
o } t d | | f ƒ ‚ n X| S( s_
Parse a RFC 822, RFC 1123 date string, return a datetime naive object in UTC.
i i s) unable to parse expires datetime '%s': %s( t stript datetimeR R t parsedatet ExceptionR ( R t sR t e( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt parse_datetimeµ s &c C sY | i ƒ } | p d S| i d ƒ p d S| i d ƒ d j o d S| | i d ƒ S( s+
Given a URL path, possibly empty, return a path consisting
only of directory components. The URL path must end with a
trailing slash for the last path element to be considered a
directory. Also the URL path must begin with a slash. Empty
input returns '/'.
Examples:
'' -> '/'
'/' -> '/'
'foo' -> '/'
'foo/' -> '/'
'/foo -> '/'
'/foo/' -> '/foo'
'/foo/bar' -> '/foo'
'/foo/bar/' -> '/foo/bar'
t /i ( t lowert
startswitht countt rindex( R t url_path( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt normalize_url_pathÇ s c C sØ g } t i i | ƒ } d } x}| D]u} t i i | ƒ } | oo | i d ƒ } | i d ƒ } | d d j o6 | d d j o | d d !} q© t d | ƒ ‚ n t }
n | } t } t }
| i
ƒ t i j } | d j o" |
o | o t | | ƒ } q% | oM |
oF | o> | d j o | i | ƒ n | i
| ƒ t | | ƒ } q% | o | o | i | | ƒ q% | o t d | ƒ ‚ q% q% W| o/ | d j o | i | ƒ n | i
| ƒ n | S( sí
Given a string containing one or more cookies (the
HTTP_COOKIES environment variable typically contains multiple
cookies) parse the string and return a list of Cookie objects
found in the string.
i i i t "iÿÿÿÿs unterminated quote in '%s's unknown cookie token '%s'N( R t field_ret splitR t
kv_pair_ret searcht groupR R t FalseR$ t attrst normalizet appendt _Cookie__set_attr( R t
cookie_stringt request_urlt cookiest fieldst cookiet fieldt matcht keyt valuet kv_pairt is_attribute( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt parseé sD
c C sb d } | i | ƒ } x( | D] } | i | j o
| } q q W| d j o | i | ƒ n | S( s$
A cookie string may contain multiple cookies, parse the cookie
string and return the last cookie in the string matching the
cookie name or None if not found.
This is basically a utility wrapper around the parse() class
method which iterates over what parse() returns looking for
the specific cookie.
When cookie_name appears more than once the last instance is
returned rather than the first because the ordering sequence
makes the last instance the current value.
N( R R@ R< R2 ( R R5 t cookie_nameR6 t
target_cookieR7 R9 ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt get_named_cookie_from_stringE s
c
C se t i | t ƒ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _
| | _ d S( N( R t
get_loggerR R< R= R R R
R R R
t timestamp(
t selfR< R= R R R
R R R
RE ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt __init__a s c C s | i S( sŸ
The UTC moment at which cookie was received for purposes of
computing the expiration given a Max-Age offset. The
expiration will be timestamp + max_age. The timestamp value
will aways be a datetime object.
By default the timestamp will be the moment the Cookie object
is created as this often corresponds to the moment the cookie
is received (the intent of the Max-Age attribute). But becuase
it's sometimes desirable to force a specific moment for
purposes of computing the expiration from the Max-Age the
Cookie timestamp can be updated.
Setting a value of None causes the timestamp to be set to the
current UTC time (now). You may also assign with a numeric
UNIX timestamp (seconds since the epoch UTC) or a formatted time
sting, in all cases the value will be converted to a datetime
object.
( t
_timestamp( RF ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyRE p s c C s¬ | d j o
d | _ n t | t i ƒ o
| | _ no t | t t t f ƒ o t i i | ƒ | _ n= t | t ƒ o t i
| ƒ | _ n t d | i i
ƒ ‚ d S( NsD value must be datetime, int, long, float, basestring or None, not %s( R RH t
isinstanceR t intt longt floatt utcfromtimestampt
basestringR R" t TypeErrort __class__R ( RF R= ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyRE ‡ s
c C s | i S( sH
The expiration timestamp (in UTC) as a datetime object for the
cookie, or None if not set.
You may assign a value of None, a datetime object, a numeric
UNIX timestamp (seconds since the epoch UTC) or formatted time
string (the latter two will be converted to a datetime object.
( t _expires( RF ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyR • s
c C s¬ | d j o
d | _ n t | t i ƒ o
| | _ no t | t t t f ƒ o t i i | ƒ | _ n= t | t ƒ o t i
| ƒ | _ n t d | i i
ƒ ‚ d S( NsD value must be datetime, int, long, float, basestring or None, not %s( R RQ RI R RJ RK RL RM RN R R" RO RP R ( RF R= ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyR ¡ s
c C s | i S( sq
The lifetime duration of the cookie. Computed as an offset
from the cookie's timestamp.
( t _max_age( RF ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyR
¯ s c C sW | d j o
d | _ n: y t | ƒ | _ Wn# t j
o t d | ƒ ‚ n Xd S( Ns- Max-Age value '%s' not convertable to integer( R RR RJ R R ( RF R= ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyR
· s
c C sP t i i | i ƒ d ƒ } | d j o t d | ƒ ‚ n t | | | ƒ d S( s?
Sets one of the predefined cookie attributes.
s unknown cookie attribute '%s'N( R R1 t getR$ R R t setattr( RF t nameR= t attr_name( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt
__set_attrÁ s
c C s g } | i d | i | i f ƒ | i d j o | i d | i ƒ n | i d j o | i d | i ƒ n | i d j o | i d | i ƒ n | i d j o! | i d t i | i ƒ ƒ n | i
o | i d ƒ n | i o | i d ƒ n d i | ƒ S( Ns %s=%ss Domain=%ss Path=%ss
Max-Age=%ss
Expires=%st Securet HttpOnlys ; (
R3 R< R= R R R R
R R R R R
t join( RF t
components( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt __str__Ê s !
c C sG | i d j o | i t i d | i ƒ S| i d j o | i Sd S( s/
Return the effective expiration of the cookie as a datetime
object or None if no expiration is defined. Expiration may be
defined either by the "Expires" timestamp attribute or the
"Max-Age" duration attribute. If both are set "Max-Age" takes
precedence. If neither is set the cookie has no expiration and
None will be returned.
"Max-Age" specifies the number of seconds in the future from when the
cookie is received until it expires. Effectively it means
adding "Max-Age" seconds to a timestamp to arrive at an
expiration. By default the timestamp used to mark the arrival
of the cookie is set to the moment the cookie object is
created. However sometimes it is desirable to adjust the
received timestamp to something other than the moment of
object creation, therefore you can explicitly set the arrival
timestamp used in the "Max-Age" calculation.
"Expires" specifies an explicit timestamp.
If "Max-Age" is set a datetime object is returned which is the
sum of the arrival timestamp and "Max-Age".
If "Expires" is set a datetime object is returned matching the
timestamp specified as the "Expires" value.
If neither is set None is returned.
t secondsN( R
R RE R t timedeltaR ( RF ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt get_expirationã s
c C s | i ƒ | _ d | _ | i S( s
An expiration may be specified either with an explicit
timestamp in the "Expires" attribute or via an offset
specified witht the "Max-Age" attribute. The "Max-Age"
attribute has precedence over "Expires" if both are
specified.
This method normalizes the expiration of the cookie such that
only a "Expires" attribute remains after consideration of the
"Max-Age" attribute. This is useful when storing the cookie
for future reference.
N( R_ R R R
( RF ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt normalize_expiration s c C sn t i | ƒ \ } } } } } } | i d j o | i ƒ | _ n | i d j o | i | ƒ | _ n d S( s¥
If cookie domain and path attributes are not specified then
they assume defaults from the request url the cookie was
received from.
N( R R R R$ R R) ( RF t urlt schemeR R t paramst queryt fragment( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt set_defaults_from_url s
!c C s | i | ƒ | i ƒ d S( s‘
Missing cookie attributes will receive default values derived
from the request URL. The expiration value is normalized.
N( Rf R` ( RF Ra ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyR2 + s
c C s d | i | i f S( s‘
Return a string with just the key and value (no attributes).
This is appropriate for including in a HTTP Cookie header.
s %s=%s;( R< R= ( RF ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt http_cookie4 s c
s d „ } ‡ f d † } ˆ i } t i | ƒ \ } } } } } }
ˆ i ƒ } | d
j oF t i i ƒ } | | j o& t i d | ˆ i | ƒ f ƒ ‚ q¡ n | | ˆ i ƒ p# t i
d | ˆ i | f ƒ ‚ n | | ˆ i ƒ p# t i
d | ˆ i | f ƒ ‚ n | i ƒ } ˆ i
o. | d j o t i
d | | f ƒ ‚ qQn ˆ i o. | d j o t i
d | | f ƒ ‚ q‰n t S(
s¬
Tests to see if a cookie should be returned when a request is
sent to a specific URL.
* The request url's host must match the cookie's doman
otherwise raises Cookie.URLMismatch.
* The path in the request url must contain the cookie's path
otherwise raises Cookie.URLMismatch.
* If the cookie defines an expiration date then the current
time must be less or equal to the cookie's expiration
timestamp. Will raise Cookie.Expired if a defined expiration
is not valid.
If the test fails Cookie.Expired or Cookie.URLMismatch will be raised,
otherwise True is returned.
c S s d d k l } y | | ƒ Wn t j
o
} t SX| d j o t S| i ƒ } | i ƒ } | | j o t S| i | ƒ o | i d ƒ o t Sn t S( s~
Compute domain component and perform test per
RFC 6265, Section 5.1.3. "Domain Matching"
iÿÿÿÿ( t validate_domain_namet .N( t ipalib.utilRh R R0 R R R$ t endswithR% ( t
url_domaint
cookie_domainRh R! ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt domain_validP s
c s˜ | d j o t S| i ƒ } ˆ i | ƒ } | | j o t S| oN | i | ƒ o> | i d ƒ o t S| t | ƒ } | i d ƒ o t Sn t S( s
Compute path component and perform test per
RFC 6265, Section 5.1.4. "Paths and Path-Match"
R# N( R R R$ R) R% Rk t lenR0 ( R( t cookie_patht request_patht tail( RF ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt
path_validm s
s! cookie named '%s'; expired at %s'sB cookie named '%s'; it's domain '%s' does not match URL domain '%s'sD cookie named '%s'; it's path '%s' does not contain the URL path '%s't httpt httpssD cookie named '%s'; is restricted to HTTP but it's URL scheme is '%s'sP cookie named '%s'; is restricted to secure transport but it's URL scheme is '%s'N( Rt Ru ( Ru ( R< R R_ R R t utcnowR R R R R R R$ R
R R (
RF Ra Rn Rs RA t
url_schemeRl R( t
url_paramst url_queryt url_fragmentt cookie_expirationt now( ( RF s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt http_return_ok; s6 !
N(" R R t __doc__R R R t ret compileR+ t
IGNORECASER- R1 t classmethodR R R R" R) R@ RC RG t propertyRE t setterR R
R4 R\ R_ R` Rf R2 Rg R} ( ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyR I sH 6
"[
& (
R t timeR t email.utilsR t urllib2R t calendarR t ipapython.ipa_log_managerR t objectR ( ( ( s4 /usr/lib/python2.6/site-packages/ipapython/cookie.pyt s /