zlayer-overlay 0.10.80

Encrypted overlay networking for containers using boringtun userspace WireGuard
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

//! Error types for overlay network operations

use std::net::IpAddr;
use thiserror::Error;

/// Errors that can occur during overlay network operations
#[derive(Debug, Error)]
pub enum OverlayError {
    /// Overlay transport not available
    #[error("Overlay transport not available: {0}")]
    TransportNotAvailable(String),

    /// Transport command execution failed
    #[error("Transport command failed: {0}")]
    TransportCommand(String),

    /// Boringtun device error
    #[error("Boringtun device error: {0}")]
    BoringtunDevice(String),

    /// Invalid CIDR notation
    #[error("Invalid CIDR notation: {0}")]
    InvalidCidr(String),

    /// No available IPs in the configured CIDR range
    #[error("No available IP addresses in CIDR range")]
    NoAvailableIps,

    /// IP address already allocated
    #[error("IP address {0} is already allocated")]
    IpAlreadyAllocated(IpAddr),

    /// IP address not in CIDR range
    #[error("IP address {0} is not within CIDR range {1}")]
    IpNotInRange(IpAddr, String),

    /// Interface already exists
    #[error("Overlay interface '{0}' already exists")]
    InterfaceExists(String),

    /// Interface not found
    #[error("Overlay interface '{0}' not found")]
    InterfaceNotFound(String),

    /// Peer not found
    #[error("Peer with public key '{0}' not found")]
    PeerNotFound(String),

    /// Peer is unreachable
    #[error("Peer at {ip} is unreachable: {reason}")]
    PeerUnreachable { ip: IpAddr, reason: String },

    /// Configuration file error
    #[error("Configuration error: {0}")]
    Config(String),

    /// IO error
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    /// JSON serialization/deserialization error
    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),

    /// Already initialized
    #[error("Overlay network already initialized at {0}")]
    AlreadyInitialized(String),

    /// Not initialized
    #[error("Overlay network not initialized. Run init_leader or join first")]
    NotInitialized,

    /// Permission denied
    #[error("Permission denied: {0}. This operation typically requires root privileges")]
    PermissionDenied(String),

    /// Timeout waiting for operation
    #[error("Operation timed out: {0}")]
    Timeout(String),

    /// Invalid key format
    #[error("Invalid key format: {0}")]
    InvalidKey(String),

    /// Network configuration error
    #[error("Network configuration error: {0}")]
    NetworkConfig(String),

    /// DNS error
    #[error("DNS error: {0}")]
    Dns(String),

    /// STUN discovery failed
    #[error("STUN discovery failed: {0}")]
    StunDiscovery(String),

    /// Hole punch failed for a specific peer
    #[error("Hole punch failed for peer {peer}: {reason}")]
    HolePunchFailed { peer: String, reason: String },

    /// TURN relay error
    #[error("TURN relay error: {0}")]
    TurnRelay(String),

    /// NAT traversal exhausted all candidates
    #[error("NAT traversal failed for peer {peer}: exhausted all candidates")]
    NatTraversalFailed { peer: String },

    /// No STUN servers configured
    #[error("No STUN servers configured")]
    NoStunServers,
}

/// Result type alias for overlay operations
pub type Result<T> = std::result::Result<T, OverlayError>;