Skip to main content

is_secret_key

Function is_secret_key 

Source
pub fn is_secret_key(key: &str) -> bool
Expand description

Whether a config key may hold a secret. Errs toward redacting: a false positive only hides a value in an error message, a false negative leaks it.

Configuration errors and the CLI reports share this rule, so it may only ever widen: removing a key pattern would start printing values that earlier releases hid.

Args: key: A configuration key, query parameter or field name.

Returns: true when values stored under key must be redacted.