Python日志记录：保护敏感信息

运维开发王义杰

发布于 2023-08-25 08:52:58

5350

发布于 2023-08-25 08:52:58

文章被收录于专栏：运维开发王义杰运维开发王义杰

在软件开发中，日志记录是一项至关重要的任务，它可以帮助我们了解程序运行的状态和定位问题。然而，有时候日志可能包括敏感信息，例如用户的密码、私钥等。这些信息如果被不当泄露，可能会带来严重的安全风险。本文将探讨在Python中记录日志时如何进行敏感信息的脱敏处理。

1. 脱敏概述

所谓脱敏，是指在不影响数据用途的前提下，对数据进行加工处理，隐藏数据中的敏感信息，防止敏感信息泄露。

2. 基础脱敏方法

在Python中，我们可以使用简单的字符串替换来实现基本的脱敏处理。

例如：

password = 'my-secret-password'
log_message = f'Connecting with password: {password}'
safe_log_message = log_message.replace(password, '****')
print(safe_log_message)  # 输出: Connecting with password: ****

3. 使用logging模块进行高级脱敏

Python的logging模块提供了强大的日志记录功能。我们可以通过创建自定义的日志过滤器来实现敏感信息的脱敏。

3.1 创建自定义过滤器

我们可以定义一个自定义的过滤器，专门用来脱敏敏感信息。

import logging

class SensitiveDataFilter(logging.Filter):
    def filter(self, record):
        record.msg = record.msg.replace('SENSITIVE', '****')
        return True

3.2 应用自定义过滤器

然后，我们可以将此过滤器添加到我们的日志记录器中。

logger = logging.getLogger('my_logger')
logger.addFilter(SensitiveDataFilter())

3.3 使用自定义过滤器记录日志

现在，任何包含"SENSITIVE"的日志消息都会自动被脱敏。

logger.warning('This message contains SENSITIVE data.')
# 输出: This message contains **** data.


4.使用占位符和参数化日志记录


直接替换特定字符串确实是一种非常有限的方法，并不适用于动态的、
非固定的敏感信息，比如密码。对于这种情况，
我们可以采用更灵活的方式来处理。
一种更好的方法是使用占位符来记录日志，
并且通过函数来处理敏感信息。
这样，我们可以完全控制哪些信息被写入日志，哪些信息被脱敏。


4.1 定义脱敏函数

我们可以定义一个函数来处理敏感信息的脱敏：
def mask_sensitive_data(message, *args):
    masked_args = ['****' if isinstance(arg, SensitiveData) else arg for arg in args]
    return message % tuple(masked_args)
这里的SensitiveData是你可以定义的一个包装类，用于标记敏感信息。



4.2 创建敏感信息包装类
class SensitiveInfo:
    def __init__(self, value):
        self._value = value

    def get_value(self):
        """返回敏感信息的原始值。此方法应谨慎使用，以确保信息的安全。"""
        return self._value

    def __str__(self):
        """当尝试将敏感信息转换为字符串时，返回一个脱敏的表示。"""
        return "****"

    def __repr__(self):
        """返回一个脱敏的表示，以便在日志、调试器等中使用。"""
        return "<SensitiveInfo: ****>"



4.3.记录日志
现在，我们可以使用占位符和mask_sensitive_data函数来记录日志，并保护敏感信息。
import logging

password = SensitiveData('my-secret-password')
username = 'user1'

log_message = 'Connecting with username: %s and password: %s'
safe_log_message = mask_sensitive_data(log_message, username, password)

logging.warning(safe_log_message)
# 输出: Connecting with username: user1 and password: ****


这样，我们可以动态地、在运行时处理敏感信息的脱敏，而不需要硬编码
特定的字符串。通过使用特定的包装类来标记敏感信息，你还可以更灵活地
控制哪些数据被视为敏感，以及如何处理它们。


6. 通过装饰器和变量名规则识别敏感信息
我们还可以定义装饰器来检查函数参数的名字，并根据特定的命名规则脱敏
敏感信息。
6.1 定义脱敏装饰器


from functools import wraps

def mask_sensitive(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        new_kwargs = {key: '****' if key.startswith('sensitive_') else value for key, value in kwargs.items()}
        return func(*args, **new_kwargs)
    return wrapper


这个装饰器会检查所有以sensitive_开头的关键字参数，并将它们的值替换
为脱敏的表示。

2. 应用装饰器
我们可以将此装饰器应用于任何需要脱敏的函数。
@mask_sensitive
def log_in(username, sensitive_password):
    print(f'Username: {username}')
    print(f'Password: {sensitive_password}')

log_in('user1', sensitive_password='my-secret-password')
# 输出: Username: user1
#      Password:

通过变量名规则识别敏感信息确实可能，但是这种方法的效果很大程度上
依赖于开发团队的一致性和纪律。所有涉及敏感信息的变量必须遵循特定
的命名规则，且所有开发人员都必须了解和遵循这些规则。