mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-04-01 12:06:43 +00:00
Code Issues 32 Releases Wiki Activity

Refs #27468 -- Updated django.core.signing docstring.

Browse Source 
Follow up to 71c4fb7beb8e3293243140e4bd74e53989196440.
This commit is contained in:
Matthias Kestenholz 2022-02-17 10:01:41 +01:00 committed by GitHub
parent 1e2e1be02b
commit a94ae4cb11
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
django/core/signing.py
View File

@ -8,16 +8,16 @@ The format used looks like this:
There are two components here, separated by a ':'. The first component is a There are two components here, separated by a ':'. The first component is a
URLsafe base64 encoded JSON of the object passed to dumps(). The second URLsafe base64 encoded JSON of the object passed to dumps(). The second
component is a base64 encoded hmac/SHA1 hash of "$first_component:$secret" component is a base64 encoded hmac/SHA-256 hash of "$first_component:$secret"
signing.loads(s) checks the signature and returns the deserialized object. signing.loads(s) checks the signature and returns the deserialized object.
If the signature fails, a BadSignature exception is raised. If the signature fails, a BadSignature exception is raised.
>>> signing.loads("ImhlbGxvIg:1QaUZC:YIye-ze3TTx7gtSv422nZA4sgmk") >>> signing.loads("ImhlbGxvIg:1QaUZC:YIye-ze3TTx7gtSv422nZA4sgmk")
'hello' 'hello'
>>> signing.loads("ImhlbGxvIg:1QaUZC:YIye-ze3TTx7gtSv422nZA4sgmk-modified") >>> signing.loads("ImhlbGxvIg:1QaUZC:YIye-ze3TTx7gtSv42-modified")
... ...
BadSignature: Signature failed: ImhlbGxvIg:1QaUZC:YIye-ze3TTx7gtSv422nZA4sgmk-modified BadSignature: Signature "ImhlbGxvIg:1QaUZC:YIye-ze3TTx7gtSv42-modified" does not match
You can optionally compress the JSON prior to base64 encoding it to save You can optionally compress the JSON prior to base64 encoding it to save
space, using the compress=True argument. This checks if compression actually space, using the compress=True argument. This checks if compression actually