diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/releases/1.8.txt | 7 | ||||
| -rw-r--r-- | docs/topics/signing.txt | 10 |
2 files changed, 16 insertions, 1 deletions
diff --git a/docs/releases/1.8.txt b/docs/releases/1.8.txt index dc3b4211c8..5135151234 100644 --- a/docs/releases/1.8.txt +++ b/docs/releases/1.8.txt @@ -186,6 +186,13 @@ Cache * The ``incr()`` method of the ``django.core.cache.backends.locmem.LocMemCache`` backend is now thread-safe. +Cryptography +^^^^^^^^^^^^ + +* The ``max_age`` parameter of the + :meth:`django.core.signing.TimestampSigner.unsign` method now also accept a + :py:class:`datetime.timedelta` object. + Database backends ^^^^^^^^^^^^^^^^^ diff --git a/docs/topics/signing.txt b/docs/topics/signing.txt index 3092f297f0..18d963c41b 100644 --- a/docs/topics/signing.txt +++ b/docs/topics/signing.txt @@ -114,6 +114,7 @@ Verifying timestamped values timestamp to the value. This allows you to confirm that a signed value was created within a specified period of time:: + >>> from datetime import timedelta >>> from django.core.signing import TimestampSigner >>> signer = TimestampSigner() >>> value = signer.sign('hello') @@ -126,6 +127,8 @@ created within a specified period of time:: SignatureExpired: Signature age 15.5289158821 > 10 seconds >>> signer.unsign(value, max_age=20) 'hello' + >>> signer.unsign(value, max_age=timedelta(seconds=20)) + 'hello' .. class:: TimestampSigner(key=None, sep=':', salt=None) @@ -136,7 +139,12 @@ created within a specified period of time:: .. method:: unsign(value, max_age=None) Checks if ``value`` was signed less than ``max_age`` seconds ago, - otherwise raises ``SignatureExpired``. + otherwise raises ``SignatureExpired``. The ``max_age`` parameter can + accept an integer or a :py:class:`datetime.timedelta` object. + + .. versionchanged:: 1.8 + + Previously, the ``max_age`` parameter only accepted an integer. Protecting complex data structures ---------------------------------- |