synapse-waf 0.9.0

High-performance WAF and reverse proxy with embedded intelligence — built on Cloudflare Pingora
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

//! Tunnel protocol types for Signal Horizon tunnel client.

use serde::{Deserialize, Serialize};

/// Connection state for the tunnel client.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum ConnectionState {
    Disconnected,
    Connecting,
    Authenticating,
    Connected,
    Reconnecting,
    Error,
}

/// Supported tunnel channels.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum TunnelChannel {
    Shell,
    Logs,
    Diag,
    Control,
    Files,
    Update,
}

impl TunnelChannel {
    pub const ALL: [TunnelChannel; 6] = [
        TunnelChannel::Shell,
        TunnelChannel::Logs,
        TunnelChannel::Diag,
        TunnelChannel::Control,
        TunnelChannel::Files,
        TunnelChannel::Update,
    ];

    pub const fn as_str(self) -> &'static str {
        match self {
            TunnelChannel::Shell => "shell",
            TunnelChannel::Logs => "logs",
            TunnelChannel::Diag => "diag",
            TunnelChannel::Control => "control",
            TunnelChannel::Files => "files",
            TunnelChannel::Update => "update",
        }
    }
}

/// Metadata included during tunnel authentication.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct TunnelAuthMetadata {
    pub hostname: Option<String>,
    pub version: Option<String>,
    pub platform: Option<String>,
}

/// Authentication payload for the tunnel client.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TunnelAuthPayload {
    #[serde(rename = "sensorId")]
    pub sensor_id: String,
    #[serde(rename = "apiKey")]
    pub api_key: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub capabilities: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metadata: Option<TunnelAuthMetadata>,
}

/// Tunnel authentication message.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TunnelAuthMessage {
    #[serde(rename = "type")]
    pub message_type: String,
    pub payload: TunnelAuthPayload,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timestamp: Option<String>,
}

/// Envelope for channel-based messages.
#[derive(Debug, Clone)]
pub struct TunnelEnvelope {
    pub channel: TunnelChannel,
    pub session_id: Option<String>,
    pub sequence_id: Option<u64>,
    pub timestamp: Option<i64>,
    pub raw: serde_json::Value,
}

/// Legacy tunnel message structure.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LegacyTunnelMessage {
    #[serde(rename = "type")]
    pub message_type: String,
    #[serde(default, rename = "sessionId")]
    pub session_id: Option<String>,
    #[serde(default, rename = "requestId")]
    pub request_id: Option<String>,
    #[serde(default)]
    pub payload: serde_json::Value,
    #[serde(default)]
    pub timestamp: Option<String>,
}