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
108
109
110
111
112
113
114

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Admitted JSON and NDJSON body rendering.

use super::HttpPolicyExecutor;
use crate::formats::http::BodyRenderReason;
use crate::formats::http::BodyRenderStatus;
use crate::formats::http::internal::ParsedBody;
use crate::formats::http::internal::json;
use crate::formats::http::internal::markers;

impl HttpPolicyExecutor<'_> {
    /// Redacts one admitted JSON tree without parsing its source again.
    #[must_use]
    pub(super) fn redact_json_value(
        &self,
        bounded: &[u8],
        value: &mut serde_json::Value,
        truncated: bool,
        output_limit: usize,
    ) -> ParsedBody {
        if truncated {
            return ParsedBody::new(
                markers::INVALID_OR_TRUNCATED_JSON.to_string(),
                BodyRenderStatus::Redacted(BodyRenderReason::InvalidOrTruncatedJson),
                false,
            );
        }
        // Root arrays may contain unkeyed pass-through scalars. When their
        // complete source representation cannot fit, do not attempt to retain
        // a partial array whose omitted element boundary would be ambiguous.
        if matches!(value, serde_json::Value::Array(_)) && bounded.len() > output_limit {
            return ParsedBody::new(markers::TRUNCATED.to_string(), BodyRenderStatus::Structured, true);
        }
        let passed = json::redact(
            &self.body_field_redactor(),
            value,
            self.policy.unkeyed_json_value_policy(),
        );
        match json::serialize_bounded(value, output_limit) {
            Some((text, rendered_truncated)) => ParsedBody::new(
                text,
                if passed {
                    BodyRenderStatus::PassedThrough
                } else {
                    BodyRenderStatus::Structured
                },
                rendered_truncated,
            ),
            None => Self::invalid_json_body(),
        }
    }

    /// Creates the fail-closed result for syntactically invalid JSON.
    #[must_use]
    pub(super) fn invalid_json_body() -> ParsedBody {
        ParsedBody::new(
            markers::INVALID_JSON.to_string(),
            BodyRenderStatus::Redacted(BodyRenderReason::InvalidJson),
            false,
        )
    }

    /// Redacts admitted NDJSON values without parsing their source lines again.
    #[must_use]
    pub(super) fn redact_ndjson_values(
        &self,
        lines: &mut [Option<serde_json::Value>],
        trailing_newline: bool,
        truncated: bool,
        output_limit: usize,
    ) -> ParsedBody {
        if truncated {
            return ParsedBody::new(
                markers::INVALID_OR_TRUNCATED_NDJSON.to_string(),
                BodyRenderStatus::Redacted(BodyRenderReason::InvalidOrTruncatedNdjson),
                false,
            );
        }
        match json::redact_ndjson_values(
            &self.body_field_redactor(),
            lines,
            trailing_newline,
            self.policy.unkeyed_json_value_policy(),
            output_limit,
        ) {
            Some((output, passed, rendered_truncated)) => ParsedBody::new(
                output,
                if passed {
                    BodyRenderStatus::PassedThrough
                } else {
                    BodyRenderStatus::Structured
                },
                rendered_truncated,
            ),
            None => Self::invalid_ndjson_body(),
        }
    }

    /// Creates the fail-closed result for syntactically invalid NDJSON.
    #[must_use]
    pub(super) fn invalid_ndjson_body() -> ParsedBody {
        ParsedBody::new(
            markers::INVALID_NDJSON.to_string(),
            BodyRenderStatus::Redacted(BodyRenderReason::InvalidNdjson),
            false,
        )
    }
}