HttpRequest.get_signed_cookie(key, default=RAISE_ERROR, salt='', max_age=None)
[source]
Returns a cookie value for a signed cookie, or raises a django.core.signing.BadSignature
exception if the signature is no longer valid. If you provide the default
argument the exception will be suppressed and that default value will be returned instead.
The optional salt
argument can be used to provide extra protection against brute force attacks on your secret key. If supplied, the max_age
argument will be checked against the signed timestamp attached to the cookie value to ensure the cookie is not older than max_age
seconds.
For example:
>>> request.get_signed_cookie('name') 'Tony' >>> request.get_signed_cookie('name', salt='name-salt') 'Tony' # assuming cookie was set using the same salt >>> request.get_signed_cookie('non-existing-cookie') ... KeyError: 'non-existing-cookie' >>> request.get_signed_cookie('non-existing-cookie', False) False >>> request.get_signed_cookie('cookie-that-was-tampered-with') ... BadSignature: ... >>> request.get_signed_cookie('name', max_age=60) ... SignatureExpired: Signature age 1677.3839159 > 60 seconds >>> request.get_signed_cookie('name', False, max_age=60) False
See cryptographic signing for more information.
Please login to continue.