如何从 Sentry 错误报告中过滤敏感的 Django POST 参数?

How do I filter sensitive Django POST parameters out of Sentry error reports?

提问人:Steven D. 提问时间:5/22/2014 更新时间:5/31/2014 访问量:2747

问:

引用 Django 文档

@sensitive_post_parameters('pass_word', 'credit_card_number')
def record_user_profile(request):
    UserProfile.create(user=request.user,
                       password=request.POST['pass_word'],
                       credit_card=request.POST['credit_card_number'],
                       name=request.POST['name'])

在上面的示例中,pass_word 和 credit_card_number POST 参数的值将被隐藏,并在错误报告中的请求表示形式中替换为星号 (******),而 name 参数的值将被公开。

要在错误报告中系统地隐藏请求的所有 POST 参数,请不要向sensitive_post_parameters装饰器提供任何参数:

@sensitive_post_parameters()
def my_view(request):
    ...

作为测试,我将以下代码添加到我的 Django 1.6 应用程序中:

views.py:

@sensitive_post_parameters('sensitive')
def sensitive(request):
    if request.method == 'POST':
        raise IntegrityError(unicode(timezone.now()))
    return render(request, 'sensitive-test.html',
          {'form': forms.SensitiveParamForm()})

forms.py:

class SensitiveParamForm(forms.Form):
    not_sensitive = forms.CharField(max_length=255)
    sensitive = forms.CharField(max_length=255)

当我通过 提交此表单时,我可以看到两个字段(包括 )的值在 Sentry 报告中清晰如天。POSTsensitive

我在这里做错了什么?我正在使用 Django 1.6 和 Raven 3.5.2。

提前感谢您的帮助!

Django Heroku 错误报告 哨兵 敏感数据

评论

0赞 toabi 5/22/2014
另外,何时设置为 False?DEBUG
0赞 Steven D. 5/23/2014
是的,它应该设置为 。我的设置文件中的确切行如下: DEBUG = (os.environ.get('DJANGO_DEBUG_MODE', 'off') == 'on') 目前,在 Heroku 环境中,DJANGO_DEBUG_MODE = 关闭False

答:

7赞 Steven D. 5/31/2014 #1

事实证明,这源于 Django 本身的一个错误!

如果尚未更改文件中的DEFAULT_EXCEPTION_REPORTER_FILTER,则会获得 SafeExceptionReporterFilter 的默认筛选器。settings

如果您使用了sensitive_post_parameters装饰器,这将导致您的调用get_post_parameters方法:SafeExceptionReporterFilter

 def get_post_parameters(self, request):
        """
        Replaces the values of POST parameters marked as sensitive with
        stars (*********).
        """
        if request is None:
            return {}
        else:
            sensitive_post_parameters = getattr(request, 'sensitive_post_parameters', [])
            if self.is_active(request) and sensitive_post_parameters:
                cleansed = request.POST.copy()
                if sensitive_post_parameters == '__ALL__':
                    # Cleanse all parameters.
                    for k, v in cleansed.items():
                        cleansed[k] = CLEANSED_SUBSTITUTE
                    return cleansed
                else:
                    # Cleanse only the specified parameters.
                    for param in sensitive_post_parameters:
                        if param in cleansed:
                            cleansed[param] = CLEANSED_SUBSTITUTE
                    return cleansed
            else:
                return request.POST

上面的问题是,虽然它会正确返回一个敏感参数设置为 ()...它不会以任何方式改变 request.bodyQuerySetPOSTCLEANSED_SUBSTITUTE'********************'

在使用 Raven/Sentry for Django 时,这是一个问题,因为事实证明,Raven 第一次尝试从以下位置获取请求参数的get_data_from_request方法:DjangoClientPOSTrequest.body

def get_data_from_request(self, request):

  [snip]

    if request.method != 'GET':
        try:
            data = request.body
        except Exception:
            try:
                data = request.raw_post_data
            except Exception:
                # assume we had a partial read.
                try:
                    data = request.POST or '<unavailable>'
                except Exception:
                    data = '<unavailable>'
    else:
        data = None

 [snip]

最快的修复方法只是涉及子类化并手动将其输出替换为由以下人员生成的清理结果:DjangoClientQuerySetSafeExceptionReporterFilter

from django.views.debug import SafeExceptionReporterFilter
from raven.contrib.django.client import DjangoClient


class SafeDjangoClient(DjangoClient):

  def get_data_from_request(self, request):
    request.POST = SafeExceptionReporterFilter().get_post_parameters(request)
    result = super(SafeDjangoClient, self).get_data_from_request(request)
    result['sentry.interfaces.Http']['data'] = request.POST
    return result