unifly-api 0.9.0

Async Rust client, reactive data layer, and domain model for UniFi controller APIs
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287

use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

fn default_enabled() -> bool {
    true
}

fn default_purpose() -> String {
    "site-vpn".into()
}

fn default_remote_access_purpose() -> String {
    "remote-user-vpn".into()
}

fn default_vpn_client_purpose() -> String {
    "vpn-client".into()
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateSiteToSiteVpnRequest {
    pub name: String,
    pub vpn_type: String,
    #[serde(default = "default_purpose")]
    pub purpose: String,
    #[serde(default = "default_enabled")]
    pub enabled: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub remote_site_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub x_ipsec_pre_shared_key: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_peer_ip: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_dynamic_routing: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_separate_ikev2_networks: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_tunnel_ip_enabled: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_tunnel_ip: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_key_exchange: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_remote_identifier_enabled: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_remote_identifier: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_local_identifier_enabled: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_local_identifier: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_pfs: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_ike_encryption: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_ike_hash: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_ike_dh_group: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_dh_group: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_ike_lifetime: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_esp_encryption: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_esp_hash: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_esp_dh_group: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_esp_lifetime: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_interface: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipsec_local_ip: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub remote_vpn_dynamic_subnets_enabled: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub x_openvpn_shared_secret_key: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub openvpn_local_address: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub openvpn_local_port: Option<u16>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub openvpn_encryption_cipher: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub openvpn_remote_host: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub openvpn_remote_address: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub openvpn_remote_port: Option<u16>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub openvpn_mode: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub interface_mtu_enabled: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub interface_mtu: Option<u16>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mss_clamp: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mss_clamp_mss: Option<u16>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub route_distance: Option<u32>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub remote_vpn_subnets: Vec<String>,
    #[serde(default, flatten)]
    pub extra: BTreeMap<String, Value>,
}

pub type UpdateSiteToSiteVpnRequest = CreateSiteToSiteVpnRequest;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateRemoteAccessVpnServerRequest {
    pub name: String,
    pub vpn_type: String,
    #[serde(default = "default_remote_access_purpose")]
    pub purpose: String,
    #[serde(default = "default_enabled")]
    pub enabled: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub setting_preference: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub l2tp_allow_weak_ciphers: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub require_mschapv2: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub exposed_to_site_vpn: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dhcpd_wins_enabled: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dhcpd_wins_1: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dhcpd_wins_2: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dhcpd_dns_enabled: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dhcpd_dns_1: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dhcpd_dns_2: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub local_port: Option<u16>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub x_wireguard_private_key: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub vpn_client_configuration_remote_ip_override_enabled: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub vpn_client_configuration_remote_ip_override: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub x_ipsec_pre_shared_key: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub radiusprofile_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ip_subnet: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ipv6_subnet: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dhcpd_start: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dhcpd_stop: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub wireguard_interface: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub wireguard_interface_binding_mode_ip_version: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub l2tp_interface: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub openvpn_interface: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub wireguard_local_wan_ip: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub l2tp_local_wan_ip: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub openvpn_local_wan_ip: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub vpn_binding_mode: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub interface_mtu_enabled: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub interface_mtu: Option<u16>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mss_clamp: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mss_clamp_mss: Option<u16>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mss_clamp_ipv6: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mss_clamp_mss_ipv6: Option<u16>,
    #[serde(default, flatten)]
    pub extra: BTreeMap<String, Value>,
}

pub type UpdateRemoteAccessVpnServerRequest = CreateRemoteAccessVpnServerRequest;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateVpnClientProfileRequest {
    pub name: String,
    pub vpn_type: String,
    #[serde(default = "default_vpn_client_purpose")]
    pub purpose: String,
    #[serde(default = "default_enabled")]
    pub enabled: bool,
    #[serde(default, flatten)]
    pub extra: BTreeMap<String, Value>,
}

pub type UpdateVpnClientProfileRequest = CreateVpnClientProfileRequest;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateWireGuardPeerRequest {
    pub name: String,
    pub interface_ip: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub interface_ipv6: Option<String>,
    pub public_key: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub allowed_ips: Vec<String>,
    #[serde(default)]
    pub preshared_key: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub private_key: Option<String>,
    #[serde(default, flatten)]
    pub extra: BTreeMap<String, Value>,
}

pub type UpdateWireGuardPeerRequest = CreateWireGuardPeerRequest;

#[cfg(test)]
mod tests {
    use super::{
        CreateRemoteAccessVpnServerRequest, CreateSiteToSiteVpnRequest,
        CreateVpnClientProfileRequest, CreateWireGuardPeerRequest,
    };

    #[test]
    fn site_to_site_request_defaults_purpose_and_enabled() {
        let request: CreateSiteToSiteVpnRequest = serde_json::from_value(serde_json::json!({
            "name": "Branch Tunnel",
            "vpn_type": "ipsec-vpn"
        }))
        .expect("request should deserialize");

        assert_eq!(request.purpose, "site-vpn");
        assert!(request.enabled);
    }

    #[test]
    fn remote_access_request_defaults_purpose_and_enabled() {
        let request: CreateRemoteAccessVpnServerRequest =
            serde_json::from_value(serde_json::json!({
                "name": "WireGuard Remote Access",
                "vpn_type": "wireguard"
            }))
            .expect("request should deserialize");

        assert_eq!(request.purpose, "remote-user-vpn");
        assert!(request.enabled);
    }

    #[test]
    fn vpn_client_profile_request_defaults_purpose_and_enabled() {
        let request: CreateVpnClientProfileRequest = serde_json::from_value(serde_json::json!({
            "name": "Branch Client",
            "vpn_type": "openvpn-client"
        }))
        .expect("request should deserialize");

        assert_eq!(request.purpose, "vpn-client");
        assert!(request.enabled);
    }

    #[test]
    fn wireguard_peer_request_preserves_empty_preshared_key() {
        let request: CreateWireGuardPeerRequest = serde_json::from_value(serde_json::json!({
            "name": "Laptop",
            "interface_ip": "192.168.42.2",
            "public_key": "pubkey",
            "allowed_ips": []
        }))
        .expect("request should deserialize");

        assert_eq!(request.preshared_key, "");
        assert!(request.allowed_ips.is_empty());
        assert!(request.private_key.is_none());
    }
}