20.22. Cookie
— HTTP state management¶
Note
The Cookie
module has been renamed to http.cookies
in Python
3. The 2to3 tool will automatically adapt imports when converting
your sources to Python 3.
Source code: Lib/Cookie.py
The Cookie
module defines classes for abstracting the concept of
cookies, an HTTP state management mechanism. It supports both simple string-only
cookies, and provides an abstraction for having any serializable data-type as
cookie value.
Auparavant, le module appliquait strictement les règles d’analyse décrites dans les spécifications RFC 2109 et RFC 2068. Entre temps, il a été découvert que Internet Explorer 3.0 ne suit pas les règles liées aux caractères précisées dans ces spécifications. De plus, plusieurs navigateurs et serveurs dans leur versions récentes ont assoupli les règles d’analyse quant à la gestion des témoins. En conséquence, les règles d’analyse utilisées sont un peu moins strictes que les spécifications initiales.
The character set, string.ascii_letters
, string.digits
and
!#$%&'*+-.^_`|~
denote the set of valid characters allowed by this module
in Cookie name (as key
).
Note
Quand un témoin invalide est rencontré, l’exception CookieError
est levée. Si les données du témoin proviennent d’un navigateur il faut impérativement gérer les données invalides en attrapant CookieError
.
-
exception
Cookie.
CookieError
¶ Exception levée pour cause d’incompatibilité avec la RFC 2109. Exemples : attributs incorrects, en-tête
Set-Cookie
incorrect, etc.
-
class
Cookie.
BaseCookie
([input])¶ Cette classe définit un dictionnaire dont les clés sont des chaines de caractères et dont les valeurs sont des instances de
Morsel
. Notez qu’à l’assignation d’une valeur à une clé, la valeur est transformée enMorsel
contenant la clé et la valeur.Si l’argument input est donné, il est passé à la méthode
load()
.
-
class
Cookie.
SimpleCookie
([input])¶ This class derives from
BaseCookie
and overridesvalue_decode()
andvalue_encode()
to be the identity andstr()
respectively.
-
class
Cookie.
SerialCookie
([input])¶ This class derives from
BaseCookie
and overridesvalue_decode()
andvalue_encode()
to be thepickle.loads()
andpickle.dumps()
.Obsolète depuis la version 2.3: Reading pickled values from untrusted cookie data is a huge security hole, as pickle strings can be crafted to cause arbitrary code to execute on your server. It is supported for backwards compatibility only, and may eventually go away.
-
class
Cookie.
SmartCookie
([input])¶ This class derives from
BaseCookie
. It overridesvalue_decode()
to bepickle.loads()
if it is a valid pickle, and otherwise the value itself. It overridesvalue_encode()
to bepickle.dumps()
unless it is a string, in which case it returns the value itself.Obsolète depuis la version 2.3: The same security warning from
SerialCookie
applies here.
A further security note is warranted. For backwards compatibility, the
Cookie
module exports a class named Cookie
which is
just an alias for SmartCookie
. This is probably a mistake and will
likely be removed in a future version. You should not use the
Cookie
class in your applications, for the same reason why
you should not use the SerialCookie
class.
Voir aussi
20.22.1. Objets Cookie¶
-
BaseCookie.
value_decode
(val)¶ Return a decoded value from a string representation. Return value can be any type. This method does nothing in
BaseCookie
— it exists so it can be overridden.
-
BaseCookie.
value_encode
(val)¶ Return an encoded value. val can be any type, but return value must be a string. This method does nothing in
BaseCookie
— it exists so it can be overridden.Généralement, les méthodes
value_encode()
etvalue_decode()
doivent être inverses l’une de l’autre, c’est-à-dire qu’en envoyant la sortie de l’un dans l’entrée de l’autre la valeur finale doit être égale à la valeur initiale.
-
BaseCookie.
output
([attrs[, header[, sep]]])¶ Renvoie une représentation textuelle compatible avec les en-têtes HTTP. attrs et *header sont envoyés à la méthode
output()
de chaque classeMorsel
. sep est le séparateur à utiliser pour joindre les valeurs d’en-têtes. Sa valeur par défaut est'\r\n'
(CRLF).Modifié dans la version 2.5: The default separator has been changed from
'\n'
to match the cookie specification.
20.22.2. Objets Morsel¶
-
class
Cookie.
Morsel
¶ Abstraction de paire clé / valeur, accompagnée d’attributs provenant de la spécification RFC 2109.
Les objets Morsel sont des objets compatibles dictionnaire, dont l’ensemble des clés est fixe et égal aux attributs RFC 2109 valides, qui sont
expires
path
comment
domain
max-age
secure
version
httponly
L’attribut
httponly
spécifie que le témoin transféré dans les requêtes HTTP n’est pas accessible par le biais de JavaScript. Il s’agit d’une contremesure à certaines attaques de scripts inter-sites (XSS).The keys are case-insensitive.
Nouveau dans la version 2.6: The
httponly
attribute was added.
-
Morsel.
value
¶ La valeur du témoin.
-
Morsel.
coded_value
¶ La valeur codée du témoin. C’est celle qui doit être transférée.
-
Morsel.
key
¶ Le nom du témoin.
-
Morsel.
set
(key, value, coded_value)¶ Assigne les attributs key, value et coded_value.
-
Morsel.
output
([attrs[, header]])¶ Renvoie une représentation textuelle du Morsel compatible avec les en-têtes HTTP. Par défaut, tous les attributs sont inclus, à moins que attrs ne soit renseigné. Dans ce cas la valeur doit être une liste d’attributs à utiliser. Par défaut, header a la valeur
"Set-Cookie:"
.
20.22.3. Exemple¶
The following example demonstrates how to use the Cookie
module.
>>> import Cookie
>>> C = Cookie.SimpleCookie()
>>> C["fig"] = "newton"
>>> C["sugar"] = "wafer"
>>> print C # generate HTTP headers
Set-Cookie: fig=newton
Set-Cookie: sugar=wafer
>>> print C.output() # same thing
Set-Cookie: fig=newton
Set-Cookie: sugar=wafer
>>> C = Cookie.SimpleCookie()
>>> C["rocky"] = "road"
>>> C["rocky"]["path"] = "/cookie"
>>> print C.output(header="Cookie:")
Cookie: rocky=road; Path=/cookie
>>> print C.output(attrs=[], header="Cookie:")
Cookie: rocky=road
>>> C = Cookie.SimpleCookie()
>>> C.load("chips=ahoy; vienna=finger") # load from a string (HTTP header)
>>> print C
Set-Cookie: chips=ahoy
Set-Cookie: vienna=finger
>>> C = Cookie.SimpleCookie()
>>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')
>>> print C
Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"
>>> C = Cookie.SimpleCookie()
>>> C["oreo"] = "doublestuff"
>>> C["oreo"]["path"] = "/"
>>> print C
Set-Cookie: oreo=doublestuff; Path=/
>>> C["twix"] = "none for you"
>>> C["twix"].value
'none for you'
>>> C = Cookie.SimpleCookie()
>>> C["number"] = 7 # equivalent to C["number"] = str(7)
>>> C["string"] = "seven"
>>> C["number"].value
'7'
>>> C["string"].value
'seven'
>>> print C
Set-Cookie: number=7
Set-Cookie: string=seven
>>> # SerialCookie and SmartCookie are deprecated
>>> # using it can cause security loopholes in your code.
>>> C = Cookie.SerialCookie()
>>> C["number"] = 7
>>> C["string"] = "seven"
>>> C["number"].value
7
>>> C["string"].value
'seven'
>>> print C
Set-Cookie: number="I7\012."
Set-Cookie: string="S'seven'\012p1\012."
>>> C = Cookie.SmartCookie()
>>> C["number"] = 7
>>> C["string"] = "seven"
>>> C["number"].value
7
>>> C["string"].value
'seven'
>>> print C
Set-Cookie: number="I7\012."
Set-Cookie: string=seven