Context
in package
FinalYes
Présentation d'un contexte (ENV, requête…) pour les logs et le debug, en masquant les valeurs sensibles (mots de passe, jetons, clés d'API…)
Table of Contents
Constants
- MASK = '***'
- SENSITIVE_KEYS = ['pass', 'password', 'passwd', 'pwd', 'htpass', 'low_sec', 'alea_actuel', 'alea_futur', 'ldap_password', 'backup_cles', 'jeton', 'secret', 'token', 'api_key', 'apikey', 'authorization', 'php_auth_pw']
- SENSITIVE_SEGMENTS = '/(^|[_-])(pass(word|wd)?|pwd|secret|token|jeton|api[_-]?key|private[_-]?key|credentials?)($|[_-])/i'
Methods
- isSensitiveKey() : bool
- Indique si une clé de contexte désigne une valeur à ne pas divulguer
- mask() : array<string|int, mixed>
- Remplace récursivement les valeurs des clés sensibles par self::MASK
- maskUrl() : string
- Masque les valeurs des paramètres sensibles de la query string d'une URL
- summary() : string
- Aperçu succinct d'un contexte sur une ligne, valeurs sensibles masquées
- format() : string
Constants
MASK
public
mixed
MASK
= '***'
SENSITIVE_KEYS
private
mixed
SENSITIVE_KEYS
= ['pass', 'password', 'passwd', 'pwd', 'htpass', 'low_sec', 'alea_actuel', 'alea_futur', 'ldap_password', 'backup_cles', 'jeton', 'secret', 'token', 'api_key', 'apikey', 'authorization', 'php_auth_pw']
SENSITIVE_SEGMENTS
private
mixed
SENSITIVE_SEGMENTS
= '/(^|[_-])(pass(word|wd)?|pwd|secret|token|jeton|api[_-]?key|private[_-]?key|credentials?)($|[_-])/i'
Methods
isSensitiveKey()
Indique si une clé de contexte désigne une valeur à ne pas divulguer
public
static isSensitiveKey(int|string $key) : bool
Parameters
- $key : int|string
Return values
boolmask()
Remplace récursivement les valeurs des clés sensibles par self::MASK
public
static mask(array<string|int, mixed> $context) : array<string|int, mixed>
Les valeurs vides sont conservées : savoir qu'un champ a été soumis vide reste utile.
Parameters
- $context : array<string|int, mixed>
Return values
array<string|int, mixed>maskUrl()
Masque les valeurs des paramètres sensibles de la query string d'une URL
public
static maskUrl(string $url) : string
Parameters
- $url : string
Return values
stringsummary()
Aperçu succinct d'un contexte sur une ligne, valeurs sensibles masquées
public
static summary(array<string|int, mixed> $context[, int $depth = 1 ][, int $max_items = 0 ]) : string
Parameters
- $context : array<string|int, mixed>
- $depth : int = 1
- $max_items : int = 0
Tags
Return values
stringformat()
private
static format(array<string|int, mixed> $context, int $depth, int $max_items) : string
Parameters
- $context : array<string|int, mixed>
- $depth : int
- $max_items : int