テンプレートフィルターで秘密情報を守れ！ Django views.debug.SafeExceptionReporterFilter.cleansed_substitute の使い方

django.views.debug.SafeExceptionReporterFilter.cleansed_substitute は、Django のデバッグ機能で利用されるテンプレートフィルターです。

役割

このフィルターは、エラー発生時に表示されるテンプレート内の敏感な情報をマスクするために使用されます。具体的には、以下の役割を担います。

• 設定ファイルやリクエストメタ情報など、特定のキーに関連付けられた値をマスクします。
• パスワードやクレジットカード番号など、sensitive_variables デコレータで指定された変数をマスクします。

仕組み

cleansed_substitute は、テンプレート内で {% cleansed %} タグと組み合わせて使用されます。このタグ内に置かれた文字列は、以下の規則に基づいてマスク処理されます。

• 設定ファイルとリクエストメタ情報:
  • hidden_settings 属性で指定されたキーに一致する値は、マスク文字 (****) に置き換えられます。
• sensitive_variables デコレータで指定された変数:
  • 変数値は、マスク文字 (****) に置き換えられます。

例

以下の例は、cleansed_substitute フィルターの使用方法を示しています。

{% load debug %}

{% cleansed %}
パスワード: {{ user.password }}
クレジットカード番号: {{ user.credit_card_number }}
{% endcleansed %}

この例では、user.password と user.credit_card_number は sensitive_variables デコレータで指定されているため、マスク文字 (****) に置き換えられて表示されます。

補足

• cleansed_substitute フィルターは、デバッグ環境でのみ使用されます。
• マスク処理の詳細は、hidden_settings と sensitive_variables の設定を参照してください。
• テンプレート内で直接敏感な情報を表示することは避けてください。

Django views.debug.SafeExceptionReporterFilter.cleansed_substitute サンプルコード

設定ファイルとリクエストメタ情報のマスク

# settings.py

DEBUG = True

HIDDEN_SETTINGS = [
    'SECRET_KEY',
    'DATABASE_PASSWORD',
]

SENSITIVE_VARIABLES = [
    'password',
    'credit_card_number',
]

{% load debug %}

{% cleansed %}
設定ファイル:
    SECRET_KEY: {{ settings.SECRET_KEY }}
    DATABASE_PASSWORD: {{ settings.DATABASE_PASSWORD }}

リクエストメタ情報:
    REMOTE_ADDR: {{ request.META['REMOTE_ADDR'] }}
    HTTP_USER_AGENT: {{ request.META['HTTP_USER_AGENT'] }}
{% endcleansed %}

設定ファイル:
    SECRET_KEY: ****
    DATABASE_PASSWORD: ****

リクエストメタ情報:
    REMOTE_ADDR: ****
    HTTP_USER_AGENT: ****

パスワードとクレジットカード番号のマスク

# views.py

@sensitive_variables('password', 'credit_card_number')
def my_view(request):
    user = User.objects.get(username='user1')
    return render(request, 'my_template.html', {'user': user})

{% load debug %}

{% cleansed %}
ユーザー情報:
    名前: {{ user.name }}
    パスワード: {{ user.password }}
    クレジットカード番号: {{ user.credit_card_number }}
{% endcleansed %}

出力例

ユーザー情報:
    名前: John Doe
    パスワード: ****
    クレジットカード番号: ****

その他のサンプル

• テンプレート内で変数を直接マスクする:

{% load debug %}

パスワード: {{ user.password|cleansed }}
クレジットカード番号: {{ user.credit_card_number|cleansed }}

• マスク文字をカスタマイズする:

# settings.py

DEBUG = True

CLEANSED_SUBSTITUTION = '***'

出力例

パスワード: ***
クレジットカード番号: ***

• マスク対象のキーを動的に設定する:

# views.py

def my_view(request):
    hidden_settings = ['SECRET_KEY']
    if request.user.is_superuser:
        hidden_settings.append('DATABASE_PASSWORD')

    return render(request, 'my_template.html', {'hidden_settings': hidden_settings})

{% load debug %}

{% for key in hidden_settings %}
    {{ key }}: {{ settings.{{ key }}|cleansed }}
{% endfor %}

Django で敏感な情報をマスクする他の方法

テンプレート内で直接マスクする

テンプレート内で {{ variable|safe }} タグを使用することで、変数をエンティティに変換し、ブラウザで直接表示されないようにすることができます。

パスワード: {{ user.password|safe }}
クレジットカード番号: {{ user.credit_card_number|safe }}

注意: この方法は、JavaScript などのクライアントサイドスクリプトで情報が読み取られる可能性があるため、完全な安全性が保証されないことに注意してください。

独自のテンプレートフィルターを作成することで、マスク処理のロジックを自由にカスタマイズすることができます。

from django.template import Library

register = Library()

@register.filter
def my_cleansed(value):
    # マスク処理のロジック
    return masked_value

パスワード: {{ user.password|my_cleansed }}
クレジットカード番号: {{ user.credit_card_number|my_cleansed }}

モデルシリアライザーを使用する

django.forms.model_to_dict や django_rest_framework などのライブラリを使用して、モデルデータをシリアライズする際に敏感な情報を除外することができます。

from django.forms import model_to_dict

data = model_to_dict(user, exclude=['password', 'credit_card_number'])

カスタムミドルウェアを作成する

リクエスト処理の途中で敏感な情報をマスクするカスタムミドルウェアを作成することができます。

from django.utils.deprecation import MiddlewareMixin

class MyMiddleware(MiddlewareMixin):
    def process_request(self, request):
        # マスク処理のロジック
        return request

環境変数を使用する

敏感な情報を環境変数に格納し、コード内で直接参照しないようにすることができます。

# .env

SECRET_KEY=my-secret-key
DATABASE_PASSWORD=my-database-password

# settings.py

SECRET_KEY = os.environ['SECRET_KEY']
DATABASE_PASSWORD = os.environ['DATABASE_PASSWORD']

これらの方法のいずれを選択するかは、具体的な要件とセキュリティレベルに応じて決定する必要があります。