singbox-driver 0.68.4

Engine driver for the sing-box core: control API, configuration codec and process supervision.
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

//! Pure sing-box JSON document inspection.

use lurker_core_contract::identity::EngineId;
use lurker_core_contract::profile_document::{DocumentDiagnosticSnapshot, DocumentValidation};
use lurker_core_contract::profile_document_identity::{ProfileFormatId, ProfileSchemaVersion};
use lurker_core_ports::error::PortError;
use lurker_core_ports::profile_document_codec::{
    ProfileDocumentCodecPort, ProfileDocumentCodecScope,
};

/// The native format identifier of the sing-box JSON profile document.
pub const PROFILE_FORMAT: &str = "sing-box-json";
/// The schema version of the sing-box JSON profile document.
pub const PROFILE_SCHEMA_VERSION: u32 = 1;

/// The neutral sing-box JSON document codec.
#[derive(Clone, Copy, Debug, Default)]
pub struct SingBoxProfileDocumentCodec;

impl ProfileDocumentCodecPort for SingBoxProfileDocumentCodec {
    fn scope(&self) -> ProfileDocumentCodecScope {
        ProfileDocumentCodecScope {
            engine_id: EngineId::sing_box(),
            format_id: ProfileFormatId::new(PROFILE_FORMAT)
                .expect("static sing-box format ID is valid"),
            schema_version: ProfileSchemaVersion::new(PROFILE_SCHEMA_VERSION)
                .expect("sing-box schema version is positive"),
        }
    }

    fn inspect(&self, raw_bytes: &[u8]) -> Result<DocumentValidation, PortError> {
        let value: serde_json::Value = match serde_json::from_slice(raw_bytes) {
            Ok(value) => value,
            Err(error) => {
                return Ok(DocumentValidation::Invalid {
                    diagnostics: vec![DocumentDiagnosticSnapshot {
                        line: Some(error.line()),
                        column: Some(error.column()),
                        message: "invalid sing-box JSON syntax".to_owned(),
                    }],
                });
            }
        };

        if value.is_object() {
            Ok(DocumentValidation::Valid)
        } else {
            Ok(DocumentValidation::Invalid {
                diagnostics: vec![DocumentDiagnosticSnapshot {
                    line: None,
                    column: None,
                    message: "sing-box configuration root must be a JSON object".to_owned(),
                }],
            })
        }
    }
}

#[cfg(test)]
#[path = "profile_document_codec_tests.rs"]
mod tests;