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
// Legacy API client (station) endpoints
//
// Client management via stat/sta (read) and cmd/stamgr (commands).
// Covers listing, blocking, kicking, forgetting, and guest authorization.
use serde_json::json;
use tracing::debug;
use crate::error::Error;
use crate::legacy::client::LegacyClient;
use crate::legacy::models::{LegacyClientEntry, LegacyUserEntry};
impl LegacyClient {
/// List all currently connected clients (stations).
///
/// `GET /api/s/{site}/stat/sta`
pub async fn list_clients(&self) -> Result<Vec<LegacyClientEntry>, Error> {
let url = self.site_url("stat/sta");
debug!("listing connected clients");
self.get(url).await
}
/// Block a client by MAC address.
///
/// `POST /api/s/{site}/cmd/stamgr` with `{"cmd": "block-sta", "mac": "..."}`
pub async fn block_client(&self, mac: &str) -> Result<(), Error> {
let url = self.site_url("cmd/stamgr");
debug!(mac, "blocking client");
let _: Vec<serde_json::Value> = self
.post(
url,
&json!({
"cmd": "block-sta",
"mac": mac,
}),
)
.await?;
Ok(())
}
/// Unblock a client by MAC address.
///
/// `POST /api/s/{site}/cmd/stamgr` with `{"cmd": "unblock-sta", "mac": "..."}`
pub async fn unblock_client(&self, mac: &str) -> Result<(), Error> {
let url = self.site_url("cmd/stamgr");
debug!(mac, "unblocking client");
let _: Vec<serde_json::Value> = self
.post(
url,
&json!({
"cmd": "unblock-sta",
"mac": mac,
}),
)
.await?;
Ok(())
}
/// Disconnect (kick) a client.
///
/// `POST /api/s/{site}/cmd/stamgr` with `{"cmd": "kick-sta", "mac": "..."}`
pub async fn kick_client(&self, mac: &str) -> Result<(), Error> {
let url = self.site_url("cmd/stamgr");
debug!(mac, "kicking client");
let _: Vec<serde_json::Value> = self
.post(
url,
&json!({
"cmd": "kick-sta",
"mac": mac,
}),
)
.await?;
Ok(())
}
/// Forget (permanently remove) a client by MAC address.
///
/// `POST /api/s/{site}/cmd/stamgr` with `{"cmd": "forget-sta", "macs": [...]}`
pub async fn forget_client(&self, mac: &str) -> Result<(), Error> {
let url = self.site_url("cmd/stamgr");
debug!(mac, "forgetting client");
let _: Vec<serde_json::Value> = self
.post(
url,
&json!({
"cmd": "forget-sta",
"macs": [mac],
}),
)
.await?;
Ok(())
}
/// Authorize a guest client on the hotspot portal.
///
/// `POST /api/s/{site}/cmd/stamgr` with guest authorization parameters.
///
/// - `mac`: Client MAC address
/// - `minutes`: Authorization duration in minutes
/// - `up_kbps`: Optional upload bandwidth limit (Kbps)
/// - `down_kbps`: Optional download bandwidth limit (Kbps)
/// - `quota_mb`: Optional data transfer quota (MB)
pub async fn authorize_guest(
&self,
mac: &str,
minutes: u32,
up_kbps: Option<u32>,
down_kbps: Option<u32>,
quota_mb: Option<u32>,
) -> Result<(), Error> {
let url = self.site_url("cmd/stamgr");
debug!(mac, minutes, "authorizing guest");
let mut body = json!({
"cmd": "authorize-guest",
"mac": mac,
"minutes": minutes,
});
let obj = body
.as_object_mut()
.expect("json! macro always produces an object");
if let Some(up) = up_kbps {
obj.insert("up".into(), json!(up));
}
if let Some(down) = down_kbps {
obj.insert("down".into(), json!(down));
}
if let Some(quota) = quota_mb {
obj.insert("bytes".into(), json!(quota));
}
let _: Vec<serde_json::Value> = self.post(url, &body).await?;
Ok(())
}
/// Revoke guest authorization for a client.
///
/// `POST /api/s/{site}/cmd/stamgr` with `{"cmd": "unauthorize-guest", "mac": "..."}`
pub async fn unauthorize_guest(&self, mac: &str) -> Result<(), Error> {
let url = self.site_url("cmd/stamgr");
debug!(mac, "revoking guest authorization");
let _: Vec<serde_json::Value> = self
.post(
url,
&json!({
"cmd": "unauthorize-guest",
"mac": mac,
}),
)
.await?;
Ok(())
}
// ── DHCP reservation (rest/user) ──────────────────────────────
/// List all known users (includes offline clients with reservations).
///
/// `GET /api/s/{site}/rest/user`
pub async fn list_users(&self) -> Result<Vec<LegacyUserEntry>, Error> {
let url = self.site_url("rest/user");
debug!("listing known users");
self.get(url).await
}
/// Set a fixed IP (DHCP reservation) for a client.
///
/// Looks up the client in `rest/user` by MAC. If already known, PUTs an
/// update; otherwise POSTs a new user entry.
pub async fn set_client_fixed_ip(
&self,
mac: &str,
ip: &str,
network_id: &str,
) -> Result<(), Error> {
debug!(mac, ip, network_id, "setting client fixed IP");
let users = self.list_users().await?;
let normalized_mac = mac.to_lowercase();
let existing = users
.iter()
.find(|u| u.mac.to_lowercase() == normalized_mac);
if let Some(user) = existing {
// Update existing user entry
let url = self.site_url(&format!("rest/user/{}", user.id));
let _: Vec<serde_json::Value> = self
.put(
url,
&json!({
"use_fixedip": true,
"fixed_ip": ip,
"network_id": network_id,
}),
)
.await?;
} else {
// Create new user entry
let url = self.site_url("rest/user");
let _: Vec<serde_json::Value> = self
.post(
url,
&json!({
"mac": normalized_mac,
"use_fixedip": true,
"fixed_ip": ip,
"network_id": network_id,
}),
)
.await?;
}
Ok(())
}
/// Remove a fixed IP (DHCP reservation) from a client.
///
/// If `network_id` is provided, only the reservation on that network
/// is removed. Otherwise all reservations for the MAC are cleared.
pub async fn remove_client_fixed_ip(
&self,
mac: &str,
network_id: Option<&str>,
) -> Result<(), Error> {
debug!(mac, ?network_id, "removing client fixed IP");
let users = self.list_users().await?;
let normalized_mac = mac.to_lowercase();
let matches: Vec<&LegacyUserEntry> = users
.iter()
.filter(|u| {
u.mac.to_lowercase() == normalized_mac
&& network_id.is_none_or(|nid| u.network_id.as_deref() == Some(nid))
})
.collect();
if matches.is_empty() {
return Err(Error::LegacyApi {
message: if let Some(nid) = network_id {
format!("no reservation for MAC {mac} on network {nid}")
} else {
format!("no known user with MAC {mac}")
},
});
}
for user in matches {
let url = self.site_url(&format!("rest/user/{}", user.id));
let _: Vec<serde_json::Value> = self
.put(
url,
&json!({
"use_fixedip": false,
}),
)
.await?;
}
Ok(())
}
}