qubit-sanitize 0.2.0

Reusable field and structured object sanitization utilities for Rust
Documentation 
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! Tests for [`SensitiveFields`](qubit_sanitize::SensitiveFields).

use qubit_sanitize::{
    SensitiveFieldPreset,
    SensitiveFields,
    SensitivityLevel,
    canonicalize_field_name,
};

#[test]
fn test_canonicalize_field_name_normalizes_common_separators() {
    assert_eq!(canonicalize_field_name(" access_token "), "accesstoken");
    assert_eq!(canonicalize_field_name("access-token"), "accesstoken");
    assert_eq!(canonicalize_field_name("access.token"), "accesstoken");
    assert_eq!(canonicalize_field_name("access Token"), "accesstoken");
    assert_eq!(canonicalize_field_name("accessToken"), "accesstoken");
}

#[test]
fn test_sensitive_fields_default_contains_common_secret_fields() {
    let fields = SensitiveFields::default();

    assert_eq!(fields.level_for("password"), Some(SensitivityLevel::Secret));
    assert_eq!(
        fields.level_for("access-token"),
        Some(SensitivityLevel::High)
    );
    assert_eq!(
        fields.level_for("authorization"),
        Some(SensitivityLevel::High)
    );
}

#[test]
fn test_sensitive_fields_insert_adds_custom_field() {
    let mut fields = SensitiveFields::new();
    fields.insert("license_key", SensitivityLevel::Medium);

    assert_eq!(
        fields.level_for("license-key"),
        Some(SensitivityLevel::Medium),
    );
}

#[test]
fn test_sensitive_fields_ignores_empty_field_name() {
    let mut fields = SensitiveFields::new();
    fields.insert(" -_. ", SensitivityLevel::Secret);

    assert!(fields.is_empty());
}

#[test]
fn test_sensitive_fields_contains_len_and_is_empty_track_entries() {
    let mut fields = SensitiveFields::new();

    assert!(fields.is_empty());
    assert_eq!(fields.len(), 0);
    assert!(!fields.contains("api-key"));

    fields.insert("api-key", SensitivityLevel::High);

    assert!(!fields.is_empty());
    assert_eq!(fields.len(), 1);
    assert!(fields.contains("api_key"));
}

#[test]
fn test_sensitive_fields_extend_adds_multiple_custom_fields() {
    let mut fields = SensitiveFields::new();

    fields.extend(["first_secret", "second_secret"], SensitivityLevel::Secret);

    assert_eq!(
        fields.level_for("first-secret"),
        Some(SensitivityLevel::Secret),
    );
    assert_eq!(
        fields.level_for("second.secret"),
        Some(SensitivityLevel::Secret),
    );
}

#[test]
fn test_sensitive_fields_extend_preset_adds_related_names() {
    let mut fields = SensitiveFields::new();
    fields.extend_preset(SensitiveFieldPreset::Http);

    assert_eq!(fields.level_for("set_cookie"), Some(SensitivityLevel::High));
    assert_eq!(
        fields.level_for("proxy-authorization"),
        Some(SensitivityLevel::High),
    );
}

#[test]
fn test_sensitive_fields_extend_preset_covers_all_groups() {
    let mut fields = SensitiveFields::new();

    fields.extend_preset(SensitiveFieldPreset::Credentials);
    fields.extend_preset(SensitiveFieldPreset::AuthTokens);
    fields.extend_preset(SensitiveFieldPreset::Session);

    assert_eq!(
        fields.level_for("client-secret"),
        Some(SensitivityLevel::Secret),
    );
    assert_eq!(
        fields.level_for("refresh-token"),
        Some(SensitivityLevel::High),
    );
    assert_eq!(fields.level_for("jwt-token"), Some(SensitivityLevel::High));
    assert_eq!(
        fields.level_for("session-id"),
        Some(SensitivityLevel::Medium)
    );
    assert_eq!(
        fields.level_for("session-token"),
        Some(SensitivityLevel::High),
    );
}

#[test]
fn test_sensitive_fields_iter_returns_canonical_names() {
    let mut fields = SensitiveFields::new();
    fields.insert("api-key", SensitivityLevel::High);

    let entries = fields.iter().collect::<Vec<_>>();

    assert_eq!(entries, vec![("apikey", SensitivityLevel::High)]);
}