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
// Copyright 2020 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use {
    anyhow::{format_err, Context as _, Error},
    fidl_fuchsia_wlan_common::WlanMacRole,
    fidl_fuchsia_wlan_device_service::{
        CreateIfaceRequest, DestroyIfaceRequest, DeviceMonitorProxy, QueryIfaceResponse,
    },
    fuchsia_zircon as zx,
    ieee80211::{MacAddr, MacAddrBytes},
};

pub mod ap;
pub mod client;

// Helper methods for calling wlan_service fidl methods
pub async fn get_iface_list(monitor_proxy: &DeviceMonitorProxy) -> Result<Vec<u16>, Error> {
    monitor_proxy.list_ifaces().await.context("Error getting iface list")
}

/// Returns the first iface id with the requested role
///
/// # Arguments: 2
/// * `monitor_proxy`: a DeviceMonitorProxy
/// * 'role' : requested WlanMacRole (client or ap)
pub async fn get_first_iface(
    monitor_proxy: &DeviceMonitorProxy,
    role: WlanMacRole,
) -> Result<u16, Error> {
    let wlan_iface_ids =
        get_iface_list(monitor_proxy).await.context("Connect: failed to get wlan iface list")?;

    if wlan_iface_ids.len() == 0 {
        return Err(format_err!("No wlan interface found"));
    }
    tracing::info!("Found {} wlan iface entries", wlan_iface_ids.len());
    for iface_id in wlan_iface_ids {
        let iface_info = query_iface(monitor_proxy, iface_id).await?;

        if iface_info.role == role {
            return Ok(iface_id);
        }
    }
    Err(format_err!("interface with role {:?} not found", role))
}
/// Returns the list of Phy IDs for this system.
///
/// # Arguments
/// * `monitor_proxy`: a DeviceMonitorProxy
pub async fn get_phy_list(monitor_proxy: &DeviceMonitorProxy) -> Result<Vec<u16>, Error> {
    let phys = monitor_proxy.list_phys().await.context("Error getting phy list")?;
    Ok(phys)
}

pub async fn create_iface(
    monitor_proxy: &DeviceMonitorProxy,
    phy_id: u16,
    role: WlanMacRole,
    sta_addr: MacAddr,
) -> Result<u16, Error> {
    let req = CreateIfaceRequest { phy_id, role, sta_addr: sta_addr.to_array() };

    let response = monitor_proxy.create_iface(&req).await.context("Error creating iface")?;

    zx::Status::ok(response.0)
        .map_err(|e| return anyhow::anyhow!("Create iface returned non-OK status: {}", e))?;

    match response.1.clone() {
        Some(resp) => {
            let iface_id = resp.iface_id;
            tracing::info!("Created iface {:?}", iface_id);
            Ok(iface_id)
        }
        None => Err(format_err!("No iface id returned")),
    }
}

pub async fn destroy_iface(monitor_proxy: &DeviceMonitorProxy, iface_id: u16) -> Result<(), Error> {
    let req = DestroyIfaceRequest { iface_id };

    let response = monitor_proxy.destroy_iface(&req).await.context("Error destroying iface")?;
    zx::Status::ok(response).context("Destroy iface returned non-OK status")?;
    Ok(tracing::info!("Destroyed iface {:?}", iface_id))
}

async fn query_iface(
    monitor_proxy: &DeviceMonitorProxy,
    iface_id: u16,
) -> Result<QueryIfaceResponse, Error> {
    monitor_proxy
        .query_iface(iface_id)
        .await
        .context("Error querying iface")?
        .map_err(|e| format_err!("query_iface {} failed: {}", iface_id, zx::Status::from_raw(e)))
}

pub async fn get_wlan_sta_addr(
    monitor_proxy: &DeviceMonitorProxy,
    iface_id: u16,
) -> Result<[u8; 6], Error> {
    let iface_info = query_iface(monitor_proxy, iface_id).await?;
    Ok(iface_info.sta_addr)
}

#[cfg(test)]
mod tests {
    use {
        super::*,
        fidl_fuchsia_wlan_common::WlanMacRole,
        fidl_fuchsia_wlan_device_service::{
            CreateIfaceResponse, DeviceMonitorMarker, DeviceMonitorRequest,
            DeviceMonitorRequestStream,
        },
        fuchsia_async::TestExecutor,
        futures::{task::Poll, StreamExt},
        std::pin::pin,
        wlan_common::assert_variant,
    };

    pub(crate) fn setup_fake_service<M: fidl::endpoints::ProtocolMarker>(
    ) -> (fuchsia_async::TestExecutor, M::Proxy, M::RequestStream) {
        let exec = fuchsia_async::TestExecutor::new();
        let (proxy, server) = fidl::endpoints::create_proxy::<M>().expect("creating proxy");
        (exec, proxy, server.into_stream().expect("creating stream"))
    }

    fn fake_iface_query_response(
        sta_addr: [u8; 6],
        role: fidl_fuchsia_wlan_common::WlanMacRole,
    ) -> QueryIfaceResponse {
        QueryIfaceResponse { role, id: 0, phy_id: 0, phy_assigned_id: 0, sta_addr }
    }

    pub fn respond_to_query_iface_list_request(
        exec: &mut TestExecutor,
        req_stream: &mut DeviceMonitorRequestStream,
        ifaces: Vec<u16>,
    ) {
        let req = exec.run_until_stalled(&mut req_stream.next());
        let responder = assert_variant !(
            req,
            Poll::Ready(Some(Ok(DeviceMonitorRequest::ListIfaces{responder})))
            => responder);
        responder.send(&ifaces[..]).expect("fake query iface list response: send failed")
    }

    pub fn respond_to_query_iface_request(
        exec: &mut TestExecutor,
        req_stream: &mut DeviceMonitorRequestStream,
        role: fidl_fuchsia_wlan_common::WlanMacRole,
        fake_mac_addr: Option<[u8; 6]>,
    ) {
        let req = exec.run_until_stalled(&mut req_stream.next());
        let responder = assert_variant !(
            req,
            Poll::Ready(Some(Ok(DeviceMonitorRequest::QueryIface{iface_id : _, responder})))
            => responder);
        if let Some(mac) = fake_mac_addr {
            let response = fake_iface_query_response(mac, role);
            responder.send(Ok(&response)).expect("sending fake response with mac address");
        } else {
            responder
                .send(Err(fuchsia_zircon::sys::ZX_ERR_NOT_FOUND))
                .expect("sending fake response with none")
        }
    }

    pub fn respond_to_create_iface_request(
        exec: &mut TestExecutor,
        req_stream: &mut DeviceMonitorRequestStream,
        fake_status: i32,
        fake_iface_id: u16,
    ) {
        let req = exec.run_until_stalled(&mut req_stream.next());
        let responder = assert_variant !(
            req,
            Poll::Ready(Some(Ok(DeviceMonitorRequest::CreateIface{req : _, responder})))
            => responder);

        let response = CreateIfaceResponse { iface_id: fake_iface_id };
        responder.send(fake_status, Some(&response)).expect("sending fake response with iface id");
    }

    #[test]
    fn test_get_wlan_sta_addr_ok() {
        let (mut exec, proxy, mut req_stream) = setup_fake_service::<DeviceMonitorMarker>();
        let mac_addr_fut = get_wlan_sta_addr(&proxy, 0);
        let mut mac_addr_fut = pin!(mac_addr_fut);

        assert_variant!(exec.run_until_stalled(&mut mac_addr_fut), Poll::Pending);

        respond_to_query_iface_request(
            &mut exec,
            &mut req_stream,
            WlanMacRole::Client,
            Some([1, 2, 3, 4, 5, 6]),
        );

        let mac_addr = exec.run_singlethreaded(&mut mac_addr_fut).expect("should get a mac addr");
        assert_eq!(mac_addr, [1, 2, 3, 4, 5, 6]);
    }

    #[test]
    fn test_get_wlan_sta_addr_not_found() {
        let (mut exec, proxy, mut req_stream) = setup_fake_service::<DeviceMonitorMarker>();
        let mac_addr_fut = get_wlan_sta_addr(&proxy, 0);
        let mut mac_addr_fut = pin!(mac_addr_fut);

        assert_variant!(exec.run_until_stalled(&mut mac_addr_fut), Poll::Pending);

        respond_to_query_iface_request(&mut exec, &mut req_stream, WlanMacRole::Client, None);

        let err = exec.run_singlethreaded(&mut mac_addr_fut).expect_err("should be an error");
        assert!(format!("{}", err).contains("NOT_FOUND"));
    }

    #[test]
    fn test_get_wlan_sta_addr_service_interrupted() {
        let (mut exec, proxy, req_stream) = setup_fake_service::<DeviceMonitorMarker>();
        let mac_addr_fut = get_wlan_sta_addr(&proxy, 0);
        let mut mac_addr_fut = pin!(mac_addr_fut);

        assert_variant!(exec.run_until_stalled(&mut mac_addr_fut), Poll::Pending);

        // Simulate service not being available by closing the channel
        std::mem::drop(req_stream);

        let err = exec.run_singlethreaded(&mut mac_addr_fut).expect_err("should be an error");
        assert!(format!("{}", err).contains("Error querying iface"));
    }

    #[test]
    fn test_create_iface_ok() {
        let (mut exec, proxy, mut req_stream) = setup_fake_service::<DeviceMonitorMarker>();
        let iface_id_fut = create_iface(&proxy, 0, WlanMacRole::Client, [0, 0, 0, 0, 0, 0].into());

        let mut iface_id_fut = pin!(iface_id_fut);

        assert_variant!(exec.run_until_stalled(&mut iface_id_fut), Poll::Pending);
        respond_to_create_iface_request(&mut exec, &mut req_stream, zx::sys::ZX_OK, 15);

        let iface_id = exec.run_singlethreaded(&mut iface_id_fut).expect("should get an iface id");

        assert_eq!(iface_id, 15);
    }

    #[test]
    fn test_create_iface_internal_err() {
        let (mut exec, proxy, mut req_stream) = setup_fake_service::<DeviceMonitorMarker>();
        let iface_id_fut = create_iface(&proxy, 0, WlanMacRole::Client, [0, 0, 0, 0, 0, 0].into());

        let mut iface_id_fut = pin!(iface_id_fut);

        assert_variant!(exec.run_until_stalled(&mut iface_id_fut), Poll::Pending);
        respond_to_create_iface_request(&mut exec, &mut req_stream, zx::sys::ZX_ERR_INTERNAL, 15);

        let err = exec.run_singlethreaded(&mut iface_id_fut).expect_err("Should get an error");
        assert!(format!("{}", err).contains("INTERNAL"));
    }
}