使用 Django 自定义 Field 加密数据

作者:赖铭

导语:出于安全考虑,一些敏感信息是需要加密存入数据库的。这样即使被黑客脱库,也能最大限度的避免损失。

数据加密并不是难事,各种现成的加密库可以轻松实现高强度的加密。对于加密标准的选择,根据实际场景需要,在《IDC开发运维安全标准》 4.1算法标准 中选择合适算法即可。

在实际开发中,我是在业务现成逻辑代码已经大体完成时接手,被要求将部分字段加密处理的。因此,我希望加密逻辑对业务逻辑完全不可见,做到不需要修改任何业务逻辑代码,即可接入数据加密。

要做到对业务逻辑不可见,就需要在字段入库和出库时,自动进行加密和解密。Django的自定义Field提供的一些接口,可以在数据出库后、数据入库前,做一些特定的操作。如:DatetimeField,就是使用了这些接口,做到了可以直接使用python的datetime进行操作,免去了与数据库类型转换的工作。

下面这个例子,选择的是AES对称加密算法,对CharField进行加密处理。

class AESCharField(models.CharField):
"""
    在数据库中AES256加密的 CharField
    - 兼容未加密数据,加密后字符串会带上
    """

    def __init__(self, *args, **kwargs):
"""
        初始化
        :param prefix: 加密串前缀
        """
        if 'prefix' in kwargs:
self.prefix = kwargs['prefix']
del kwargs['prefix']
else:
self.prefix = "aes_str:::"

        self.cipher = AESCipher(settings.SECRET_KEY)
super(AESCharField, self).__init__(*args, **kwargs)

def deconstruct(self):
        name, path, args, kwargs = super(AESCharField, self).deconstruct()
if self.prefix != "aes_str:::":
            kwargs['prefix'] = self.prefix
return name, path, args, kwargs

def from_db_value(self, value, expression, connection, context):
"""
        出库后解密数据
        """
        if value is None:
return value
if value.startswith(self.prefix):
            value = value[len(self.prefix):]
            value = self.cipher.decrypt(value)

return value

def to_python(self, value):
"""
        反序列化和Form clean()时调用,解密数据
        """
        if value is None:
return value
elif value.startswith(self.prefix):
            value = value[len(self.prefix):]
            value = self.cipher.decrypt(value)

return value

def get_prep_value(self, value):
"""
        入库前加密数据
        """
        if isinstance(value, str) or isinstance(value, unicode):
            value = self.cipher.encrypt(value)
            value = self.prefix+value
elif value is not None:
raise TypeError(str(value)+" is not a valid value for AESCharField")

return value
  1. init中使用秘钥生成加密器,用于后面的加密,这里的秘钥是写在django settings中的。
  2. prefix是标志加密后字符串的前缀,用于区分加密前和加密后数据。为了兼容已有旧数据的情况。
  3. from_db_value是数据库返回值后,调用的函数。在此函数中,进行数据解密,需要处理None的情况。
  4. get_prep_value是数据入库前调用的函数。在此函数中,加密数据,加上前缀。需要判断None的情况。
  5. to_python是需要在反序列化和Form表单clean()时使用的,可能遇上加密后数据,也可能遇上未加密数据和None,需要注意判断。
  6. 这里兼容了存在旧数据的情况,因此需要使用startwith判断前缀是否匹配。

WARNING:

  1. AES加密算法,如果设置随机的向量iv,哪怕加密相同的明文,每次加密产生的密文也是不相同的,因此无法对加密后字段进行数据库查询操作,业务代码需要注意。如果需要实现数据库查询,需要固定向量iv,并且实现get_prep_lookup方法。
  2. 这里的写法兼容了可能存在的旧数据,如果不对这些旧数据进行操作,这些旧数据将保持明文状态。如果需要加密旧数据,只需要进行一次取值+存入操作,即可将旧数据加密。
  3. 注意max_length的设置。加密后的密文长度,会与明文有所出入,需要根据所选加密算法和前缀进行计算。 该例子只提供了基本的加解密功能,展示了如何编写Django的自定义Model Field,用途不仅仅是加密。如果需要更加复杂的功能,参照官方文档:https://docs.djangoproject.com/en/1.11/howto/custom-model-fields/

下面附上可以直接拿来使用的代码

使用说明

  1. 安装依赖six,pycrypto
  2. 将CharField直接换成AESCharField。
  3. 密文比明文长,注意修改max_length。AESCipher的predict_length(length)可以计算加密后的长度,最后要加上密文前缀的长度,默认前缀aes_str:::长度为10。即:AESCipher.predict_length(old_max_length)+len(prefix)
  4. 密文前缀默认为aes_str:::,可以通过添加参数prefix修改设置。class TestModel(models.Model): field1 = AESCharField("field1", max_length=100, prefix="orz:::")
  5. 使用的是Django的SECRET_KEY作为密钥,做了一次sha256。
  6. 由于兼容明文旧记录,旧记录至少需要一次保存操作,才能将明文替换为密文。如果需要立刻加密,可以通过脚本逐条保存一遍,注意避免与用户并发操作导致数据一致性问题。
  7. 使用随机向量iv的AES加密算法,加密后的数据无法进行查询,保证业务中没有以字段作为查询条件的语句,如果需要实现数据库查询,需要固定向量iv,并且实现get_prep_lookup方法。。
  8. 老版本Django使用south做同步,需要配置AESCharField的路径。具体可以参考south文档https://south.readthedocs.io/en/latest/customfields.html#custom-fieldsfrom south.modelsinspector import add_introspection_rules add_introspection_rules([], ["^mywebsite1_3\.aes\.AESCharField"]) # 示例

原创声明,本文系作者授权云+社区-专栏发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

编辑于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Java架构师历程

solr

Solr它是一种开放源码的、基于 Lucene Java 的搜索服务器,易于加入到 Web 应用程序中。Solr 提供了层面搜索(就是统计)、命中醒目显示并且支...

792
来自专栏知了

ijst:基于反射的 C++ JSON 反序列化库

ijst (iJsonStruct) 一个是 C++ Json 序列化/反序列化库:

1344
来自专栏阮一峰的网络日志

Firebug控制台详解

Firebug是网页开发的利器,能够极大地提升工作效率。 但是,它不太容易上手。我曾经翻译过一篇《Firebug入门指南》,介绍了一些基本用法。今天,继续介绍它...

34012
来自专栏技术博文

经典加密解密函数

<?php /** * 加密解密函数 * @param string $string 明文 或 密文 * @param string $oper...

27710
来自专栏一个爱瞎折腾的程序猿

看了180分钟的视频,写了半天的代码

清晨,日常打开B站,被首页此视频的标题所吸引,虽一看就是标题党,但还是没能抑制住好奇心。 视频共计60*3分钟,学习到了很多东西。其中后半部分有许多正三观的见...

702
来自专栏Golang语言社区

从web图片裁剪出发:了解H5中的Blob

刚开始做前端的时候,有个功能卡住我了,就是裁剪并上传头像。当时两个方案摆在我面前,一个是flash,我不会。另一个是通过iframe上传图片,然后再上传坐标由后...

4107
来自专栏佳爷的后花媛

前端面试题整理

两栏布局是主内容区为主,左(右)侧有一栏,(将侧边区块<aside>域浮动,<aside>浮动后覆盖绿色<main>, 再将<main> overflow:au...

892
来自专栏听雨堂

C#实现微信AES-128-CBC加密数据的解密

小程序登录时,获得用户的信息,只是昵称,无法用作ID。而有用的数据,都加密着,腾讯给出了解密的方法: 加密数据解密算法 接口如果涉及敏感数据(如wx.getUs...

2349
来自专栏JackieZheng

告别set和get,两大利器轻松搞定model转换

场景一:一般我们遇到需要新建model,常规做法就是创建一个类,老老实实的定义好model中的所有属性,一般来说属性对应的set方法和get方法都是少不了的,有...

583
来自专栏程序你好

CSharp每日代码示例:使用iTextSharp创建PDF文件

531

扫码关注云+社区