xml-sec 0.1.14

Pure Rust XML Security: XMLDSig, XMLEnc, C14N. Drop-in replacement for libxmlsec1.
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

//! XML Encryption (XMLEnc).
//!
//! Implements [XML Encryption Syntax and Processing](https://www.w3.org/TR/xmlenc-core1/).
//!
//! `EncryptedDataBuilder` encrypts opaque bytes, XML elements, XML content, or
//! a selected node in a caller-owned document. It supports direct AES content
//! keys and generated session keys wrapped independently for one or more
//! RSA-OAEP or AES-KW recipients. The reciprocal decrypt APIs accept the same
//! inline `CipherValue` profile.
//!
//! External `CipherReference` resources, RSA PKCS#1 v1.5 key transport, and
//! unauthenticated legacy ciphers are intentionally outside this profile.
#![doc = include_str!("../../docs/xmlenc.md")]

use roxmltree::Node;

mod decrypt;
mod encrypt;
mod parse;
mod types;

pub use decrypt::{
    DecryptContext, DecryptionKeyResolver, DocumentDecryptionOptions, KekDecryptor,
    KeyCandidateBudget, PrivateKeyDecryptor, SymmetricKeyDecryptor, decrypt, decrypt_data,
    decrypt_document, decrypt_document_with_options,
};
pub use encrypt::{
    EncryptedDataBuilder, validate_key_transport_recipient, validate_rsa_recipient_key,
};
pub use parse::{
    parse_encrypted_data, parse_encrypted_data_node_with_policy,
    parse_encrypted_data_template_node_with_policy,
};
pub use types::{
    CipherData, DataEncryptionAlgorithm, DecryptedContent, DocumentEncryptionOptions,
    EncryptedData, EncryptedDataType, EncryptedKey, EncryptionMethod, EncryptionRecipient,
    EncryptionResult, KeyTransportAlgorithm, KeyWrapAlgorithm, OaepDigestAlgorithm, ReferenceList,
    ReplacementMode, RsaOaepParameters, XmlEncError,
};

fn map_document_error(
    error: crate::document::XmlDocumentError,
    settings: crate::document::DocumentParseSettings,
) -> XmlEncError {
    match error.into_policy_violation(settings) {
        Ok(error) => XmlEncError::Policy(error),
        Err(crate::document::XmlDocumentError::Parse(error)) => XmlEncError::XmlParse(error),
        Err(crate::document::XmlDocumentError::ProjectedNodeLimit { maximum }) => {
            crate::policy::PolicyViolation::ResourceLimit {
                resource: crate::policy::resource_name::XML_NODES,
                maximum,
                actual: maximum.saturating_add(1),
            }
            .into()
        }
        Err(error) => XmlEncError::Document(error),
    }
}

fn has_single_element_with_boundary_trivia(parent: Node<'_, '_>) -> bool {
    let mut element_count = 0;
    for node in parent.children() {
        if node.is_element() {
            element_count += 1;
            if element_count > 1 {
                return false;
            }
        } else if node.is_comment() {
            continue;
        } else if node.is_text() {
            // XML permits boundary whitespace around a document element; processing
            // instructions and every other node kind are unsafe replacement payloads.
            if !node.text().is_some_and(|text| {
                text.chars()
                    .all(|character| matches!(character, ' ' | '\t' | '\n' | '\r'))
            }) {
                return false;
            }
        } else {
            return false;
        }
    }
    element_count == 1
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::document::{DocumentParseSettings, XmlDocumentError};

    #[test]
    fn document_errors_have_one_xmlenc_policy_mapping() {
        // Borrowed parsing and owned mutation must expose identical typed
        // resource failures rather than depending on their entry-point mapper.
        let settings = DocumentParseSettings::new_with_depth(false, 8, 3, 128);
        assert!(matches!(
            map_document_error(
                XmlDocumentError::DocumentTooDeep {
                    maximum: 3,
                    actual: 4,
                },
                settings,
            ),
            XmlEncError::Policy(crate::policy::PolicyViolation::ResourceLimit {
                resource: crate::policy::resource_name::XML_DEPTH,
                maximum: 3,
                actual: 4,
            })
        ));
        assert!(matches!(
            map_document_error(
                XmlDocumentError::ProjectedNodeLimit { maximum: 8 },
                settings,
            ),
            XmlEncError::Policy(crate::policy::PolicyViolation::ResourceLimit {
                resource: crate::policy::resource_name::XML_NODES,
                maximum: 8,
                actual: 9,
            })
        ));
    }
}