summaryrefslogtreecommitdiff
path: root/pyvyos/utils/json.py
blob: 6d9a7c0206ea7e1c8fb03080d913b133df916b2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
"""JSON utilities with security (redaction) support."""

import json
from typing import Any, Dict, List


def redact_key(data: Dict[str, Any], keys: List[str] = None) -> Dict[str, Any]:
    """
    Redact sensitive keys from a dictionary.
    
    Args:
        data: Dictionary to redact
        keys: List of keys to redact (default: ["key", "apikey", "password"])
    
    Returns:
        Copy of data with specified keys redacted as "***REDACTED***"
    """
    if keys is None:
        keys = ["key", "apikey", "password"]
    
    if not isinstance(data, dict):
        return data
    
    redacted = data.copy()
    for key in keys:
        if key in redacted:
            redacted[key] = "***REDACTED***"
    
    return redacted


def safe_dumps(obj: Any, redact_keys: List[str] = None) -> str:
    """
    Safely serialize object to JSON with key redaction.
    
    Args:
        obj: Object to serialize
        redact_keys: Keys to redact if obj is a dict
    
    Returns:
        JSON string with sensitive data redacted
    """
    if isinstance(obj, dict):
        obj = redact_key(obj, redact_keys)
    
    return json.dumps(obj, default=str)