qubit-redact 0.5.0

Rule-driven redaction for fields, diagnostics, HTTP data, and Rust domain objects
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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Batch-only HTTP redaction.

use http::HeaderMap;
use http::HeaderValue;

use super::BodyCapture;
use super::http_redaction_writer::admit_body_input;
use super::http_redaction_writer::admit_body_structure;
use super::http_redaction_writer::admit_url_structure;
use super::http_redaction_writer::collect_admitted_headers;
use crate::runtime::BatchSession;
use crate::runtime::RedactionHandle;
use crate::runtime::runtime_session::RuntimeSession;

/// Redacts one URL as a batch item.
pub(crate) fn redact_url(session: &mut BatchSession, value: &str) -> RedactionHandle {
    if session.is_output_exhausted() {
        return session.stage_exhausted_handle();
    }
    if !session.admit_format_node(1) {
        return session.stage_accounted_text(String::new());
    }
    let input_was_empty = value.is_empty();
    let value = session.admit_input_prefix(value);
    if value.is_empty() && !input_was_empty {
        return session.stage_accounted_text(String::new());
    }
    if !admit_url_structure(session, value) {
        return session.stage_accounted_text("<truncated>");
    }
    let result =
        super::redaction::redact_url_str_with_policy(session.policy(), value, session.remaining_output_bytes());
    session.stage_rendered_operation(result.into_operation())
}

/// Redacts headers as a batch item.
pub(crate) fn redact_headers(session: &mut BatchSession, headers: &HeaderMap) -> RedactionHandle {
    let Some(headers) = collect_admitted_headers(session, headers) else {
        return if session.is_output_exhausted() {
            session.stage_exhausted_handle()
        } else {
            session.stage_accounted_text(String::new())
        };
    };
    let result =
        super::redaction::redact_headers_with_policy(session.policy(), &headers, session.remaining_output_bytes());
    session.stage_rendered_operation(result.into_operation())
}

/// Redacts a captured body with a parsed Content-Type as a batch item.
pub(crate) fn redact_body(
    session: &mut BatchSession,
    capture: BodyCapture<'_>,
    content_type: Option<&HeaderValue>,
) -> RedactionHandle {
    if session.is_output_exhausted() {
        return session.stage_exhausted_handle();
    }
    if !admit_body_input(session, capture, content_type.map(|value| value.as_bytes().len())) {
        return session.stage_accounted_text(String::new());
    }
    let Some(admitted) = admit_body_structure(session, capture, content_type.map(|value| value.as_bytes())) else {
        return session.stage_accounted_text("<truncated>");
    };
    let remaining = session.remaining_output_bytes();
    let result = super::redaction::redact_admitted_body_with_policy(
        session.policy(),
        capture,
        content_type,
        admitted,
        remaining,
    );
    session.stage_rendered_operation(result.into_operation())
}

/// Redacts a captured body with textual Content-Type as a batch item.
pub(crate) fn redact_body_with_content_type_text(
    session: &mut BatchSession,
    capture: BodyCapture<'_>,
    content_type: Option<&str>,
) -> RedactionHandle {
    if session.is_output_exhausted() {
        return session.stage_exhausted_handle();
    }
    if !admit_body_input(session, capture, content_type.map(str::len)) {
        return session.stage_accounted_text(String::new());
    }
    let Some(admitted) = admit_body_structure(session, capture, content_type.map(str::as_bytes)) else {
        return session.stage_accounted_text("<truncated>");
    };
    let remaining = session.remaining_output_bytes();
    let result = super::redaction::redact_admitted_body_with_content_type_text_with_policy(
        session.policy(),
        capture,
        content_type,
        admitted,
        remaining,
    );
    session.stage_rendered_operation(result.into_operation())
}