加密签名

web应用安全的黄金法则是，永远不要相信来自不可信来源的数据。有时通过不可信的媒介来传递数据会非常方便。密码签名后的值可以通过不受信任的途径传递，这样是安全的，因为任何篡改都会检测的到。

Django提供了用于签名的底层API，以及用于设置和读取被签名cookie的上层API，它们是web应用中最常使用的签名工具之一。

你可能会发现，签名对于以下事情非常有用：

  • 生成用于“重置我的账户”的URL，并发送给丢失密码的用户。
  • 确保储存在隐藏表单字段的数据不被篡改，
  • 生成一次性的秘密URL，用于暂时性允许访问受保护的资源，例如用户付费的下载文件。

保护 SECRET_KEY

当你使用 startproject创建新的Django项目时，自动生成的 settings.py文件会得到一个随机的SECRET_KEY值。这个值是保护签名数据的密钥 — 它至关重要，你必须妥善保管，否则攻击者会使用它来生成自己的签名值。

使用底层 API

Django的签名方法存放于django.core.signing模块。首先创建一个 Signer 的实例来对一个值签名：

  1. >>> from django.core.signing import Signer
  2. >>> signer = Signer()
  3. >>> value = signer.sign('My string')
  4. >>> value
  5. 'My string:GdMGD6HNQ_qdgxYP8yBZAdAIV1w'

这个签名会附加到字符串末尾，跟在冒号后面。你可以使用unsign方法来获取原始的值：

  1. >>> original = signer.unsign(value)
  2. >>> original
  3. 'My string'

如果签名或者值以任何方式改变，会抛出django.core.signing.BadSignature 异常：

  1. >>> from django.core import signing
  2. >>> value += 'm'
  3. >>> try:
  4. ...    original = signer.unsign(value)
  5. ... except signing.BadSignature:
  6. ...    print("Tampering detected!")

通常，Signer类使用SECRET_KEY设置来生成签名。你可以通过向Signer构造器传递一个不同的密钥来使用它：

  1. >>> signer = Signer('my-other-secret')
  2. >>> value = signer.sign('My string')
  3. >>> value
  4. 'My string:EkfQJafvGyiofrdGnuthdxImIJw'

class Signer(key=None, sep=':', salt=None)[source]

返回一个signer，它使用key 来生成签名，并且使用sep来分割值。sep 不能是 [URL安全的base64字母表(http://tools.ietf.org/html/rfc4648#section-5)]中的字符。字母表含有数字、字母、连字符和下划线。

使用salt参数

如果你不希望对每个特定的字符串都生成一个相同的签名哈希值，你可以在Signer类中使用可选的salt 参数。使用salt参数会同时用它和SECRET_KEY初始化签名哈希函数：

  1. >>> signer = Signer()
  2. >>> signer.sign('My string')
  3. 'My string:GdMGD6HNQ_qdgxYP8yBZAdAIV1w'
  4. >>> signer = Signer(salt='extra')
  5. >>> signer.sign('My string')
  6. 'My string:Ee7vGi-ING6n02gkcJ-QLHg6vFw'
  7. >>> signer.unsign('My string:Ee7vGi-ING6n02gkcJ-QLHg6vFw')
  8. 'My string'

以这种方法使用salt会把不同的签名放在不同的命名空间中。来自于单一命名空间（一个特定的salt值）的签名不能用于在不同的命名空间中验证相同的纯文本字符串。不同的命名空间使用不同的salt设置。这是为了防止攻击者使用在一个地方的代码中生成的签名后的字符串，作为使用不同salt来生成（和验证）签名的另一处代码的输入。

不像你的SECRET_KEY，你的salt参数可以不用保密。

验证带有时间戳的值

TimestampSigner是 Signer的子类，它向值附加一个签名后的时间戳。这可以让你确认一个签名后的值是否在特定时间段之内被创建：

  1. >>> from datetime import timedelta
  2. >>> from django.core.signing import TimestampSigner
  3. >>> signer = TimestampSigner()
  4. >>> value = signer.sign('hello')
  5. >>> value
  6. 'hello:1NMg5H:oPVuCqlJWmChm1rA2lyTUtelC-c'
  7. >>> signer.unsign(value)
  8. 'hello'
  9. >>> signer.unsign(value, max_age=10)
  10. ...
  11. SignatureExpired: Signature age 15.5289158821 > 10 seconds
  12. >>> signer.unsign(value, max_age=20)
  13. 'hello'
  14. >>> signer.unsign(value, max_age=timedelta(seconds=20))
  15. 'hello'

class TimestampSigner(key=None, sep=':', salt=None)[source]

sign(value)[source]

签名value，并且附加当前的时间戳。

unsign(value, max_age=None)[source]

检查value是否在少于max_age 秒之前被签名，如果不是则抛出SignatureExpired异常。max_age 参数接受一个整数或者datetime.timedelta对象。

  1. Changed in Django 1.8:
  3. 在此之前， max_age参数只接受整数。

保护复杂的数据结构

如果你希望保护一个列表、元组或字典，你可以使用签名模块的dumps 和 loads 函数来实现。它们模仿了Python的pickle模块，但是在背后使用了JSON序列化。JSON可以确保即使你的SECRET_KEY被盗取，攻击者并不能利用pickle的格式来执行任意的命令：

  1. >>> from django.core import signing
  2. >>> value = signing.dumps({"foo": "bar"})
  3. >>> value
  4. 'eyJmb28iOiJiYXIifQ:1NMg1b:zGcDE4-TCkaeGzLeW9UQwZesciI'
  5. >>> signing.loads(value)
  6. {'foo': 'bar'}

由于JSON的本质（列表和元组之间没有原生的区别），如果你传进来一个元组，你会从signing.loads(object)得到一个列表：

  1. >>> from django.core import signing
  2. >>> value = signing.dumps(('a','b','c'))
  3. >>> signing.loads(value)
  4. ['a', 'b', 'c']

dumps(obj, key=None, salt='django.core.signing', compress=False)[source]

返回URL安全，sha1签名的base64压缩的JSON字符串。序列化的对象使用TimestampSigner来签名。

loads(string, key=None, salt='django.core.signing', max_age=None)[source]

dumps()的反转，如果签名失败则抛出BadSignature异常。如果提供了max_age则会检查它（以秒为单位）。

译者：Django 文档协作翻译小组，原文：Cryptographic signing。

本文以 CC BY-NC-SA 3.0 协议发布，转载请保留作者署名和文章出处。

Django 文档协作翻译小组人手紧缺，有兴趣的朋友可以加入我们，完全公益性质。交流群：467338606。