wlan_sme/
lib.rs

Help
1// Copyright 2018 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5// Turn on additional lints that could lead to unexpected crashes in production code
6#![warn(clippy::indexing_slicing)]
7#![cfg_attr(test, allow(clippy::indexing_slicing))]
8#![warn(clippy::unwrap_used)]
9#![cfg_attr(test, allow(clippy::unwrap_used))]
10#![warn(clippy::expect_used)]
11#![cfg_attr(test, allow(clippy::expect_used))]
12#![warn(clippy::unreachable)]
13#![cfg_attr(test, allow(clippy::unreachable))]
14#![warn(clippy::unimplemented)]
15#![cfg_attr(test, allow(clippy::unimplemented))]
16
17pub mod ap;
18pub mod client;
19pub mod serve;
20#[cfg(test)]
21pub mod test_utils;
22
23use fidl_fuchsia_wlan_mlme::{self as fidl_mlme, MlmeEvent};
24use futures::channel::mpsc;
25use thiserror::Error;
26use wlan_common::sink::UnboundedSink;
27use wlan_common::timer;
28use {fidl_fuchsia_wlan_common as fidl_common, fidl_fuchsia_wlan_stats as fidl_stats};
29
30#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Ord, PartialOrd)]
31pub struct Config {
32    pub wep_supported: bool,
33    pub wpa1_supported: bool,
34}
35
36impl Config {
37    pub fn with_wep(mut self) -> Self {
38        self.wep_supported = true;
39        self
40    }
41
42    pub fn with_wpa1(mut self) -> Self {
43        self.wpa1_supported = true;
44        self
45    }
46}
47
48#[derive(Debug)]
49pub enum MlmeRequest {
50    Scan(fidl_mlme::ScanRequest),
51    AuthResponse(fidl_mlme::AuthenticateResponse),
52    AssocResponse(fidl_mlme::AssociateResponse),
53    Connect(fidl_mlme::ConnectRequest),
54    Reconnect(fidl_mlme::ReconnectRequest),
55    Roam(fidl_mlme::RoamRequest),
56    Deauthenticate(fidl_mlme::DeauthenticateRequest),
57    Disassociate(fidl_mlme::DisassociateRequest),
58    Eapol(fidl_mlme::EapolRequest),
59    SetKeys(fidl_mlme::SetKeysRequest),
60    SetCtrlPort(fidl_mlme::SetControlledPortRequest),
61    Start(fidl_mlme::StartRequest),
62    Stop(fidl_mlme::StopRequest),
63    GetIfaceStats(responder::Responder<fidl_mlme::GetIfaceStatsResponse>),
64    GetIfaceHistogramStats(responder::Responder<fidl_mlme::GetIfaceHistogramStatsResponse>),
65    ListMinstrelPeers(responder::Responder<fidl_mlme::MinstrelListResponse>),
66    GetMinstrelStats(
67        fidl_mlme::MinstrelStatsRequest,
68        responder::Responder<fidl_mlme::MinstrelStatsResponse>,
69    ),
70    SaeHandshakeResp(fidl_mlme::SaeHandshakeResponse),
71    SaeFrameTx(fidl_mlme::SaeFrame),
72    WmmStatusReq,
73    FinalizeAssociation(fidl_mlme::NegotiatedCapabilities),
74    QueryDeviceInfo(responder::Responder<fidl_mlme::DeviceInfo>),
75    QueryMacSublayerSupport(responder::Responder<fidl_common::MacSublayerSupport>),
76    QuerySecuritySupport(responder::Responder<fidl_common::SecuritySupport>),
77    QuerySpectrumManagementSupport(responder::Responder<fidl_common::SpectrumManagementSupport>),
78    QueryTelemetrySupport(responder::Responder<Result<fidl_stats::TelemetrySupport, i32>>),
79}
80
81impl MlmeRequest {
82    pub fn name(&self) -> &'static str {
83        match self {
84            Self::Scan(_) => "Scan",
85            Self::AuthResponse(_) => "AuthResponse",
86            Self::AssocResponse(_) => "AssocResponse",
87            Self::Connect(_) => "Connect",
88            Self::Reconnect(_) => "Reconnect",
89            Self::Roam(_) => "Roam",
90            Self::Deauthenticate(_) => "Deauthenticate",
91            Self::Disassociate(_) => "Disassociate",
92            Self::Eapol(_) => "Eapol",
93            Self::SetKeys(_) => "SetKeys",
94            Self::SetCtrlPort(_) => "SetCtrlPort",
95            Self::Start(_) => "Start",
96            Self::Stop(_) => "Stop",
97            Self::GetIfaceStats(_) => "GetIfaceStats",
98            Self::GetIfaceHistogramStats(_) => "GetIfaceHistogramStats",
99            Self::ListMinstrelPeers(_) => "ListMinstrelPeers",
100            Self::GetMinstrelStats(_, _) => "GetMinstrelStats",
101            Self::SaeHandshakeResp(_) => "SaeHandshakeResp",
102            Self::SaeFrameTx(_) => "SaeFrameTx",
103            Self::WmmStatusReq => "WmmStatusReq",
104            Self::FinalizeAssociation(_) => "FinalizeAssociation",
105            Self::QueryDeviceInfo(_) => "QueryDeviceInfo",
106            Self::QueryMacSublayerSupport(_) => "QueryMacSublayerSupport",
107            Self::QuerySecuritySupport(_) => "QuerySecuritySupport",
108            Self::QuerySpectrumManagementSupport(_) => "QuerySpectrumManagementSupport",
109            Self::QueryTelemetrySupport(_) => "QueryTelemetrySupport",
110        }
111    }
112}
113
114pub trait Station {
115    type Event;
116
117    fn on_mlme_event(&mut self, event: fidl_mlme::MlmeEvent);
118    fn on_timeout(&mut self, timed_event: timer::Event<Self::Event>);
119}
120
121pub type MlmeStream = mpsc::UnboundedReceiver<MlmeRequest>;
122pub type MlmeEventStream = mpsc::UnboundedReceiver<MlmeEvent>;
123pub type MlmeSink = UnboundedSink<MlmeRequest>;
124pub type MlmeEventSink = UnboundedSink<MlmeEvent>;
125
126pub mod responder {
127    use futures::channel::oneshot;
128
129    #[derive(Debug)]
130    pub struct Responder<T>(oneshot::Sender<T>);
131
132    impl<T> Responder<T> {
133        pub fn new() -> (Self, oneshot::Receiver<T>) {
134            let (sender, receiver) = oneshot::channel();
135            (Responder(sender), receiver)
136        }
137
138        pub fn respond(self, result: T) {
139            #[allow(
140                clippy::unnecessary_lazy_evaluations,
141                reason = "mass allow for https://fxbug.dev/381896734"
142            )]
143            self.0.send(result).unwrap_or_else(|_| ());
144        }
145    }
146}
147
148/// Safely log MlmeEvents without printing private information.
149fn mlme_event_name(event: &MlmeEvent) -> &str {
150    match event {
151        MlmeEvent::OnScanResult { .. } => "OnScanResult",
152        MlmeEvent::OnScanEnd { .. } => "OnScanEnd",
153        MlmeEvent::ConnectConf { .. } => "ConnectConf",
154        MlmeEvent::RoamConf { .. } => "RoamConf",
155        MlmeEvent::RoamStartInd { .. } => "RoamStartInd",
156        MlmeEvent::RoamResultInd { .. } => "RoamResultInd",
157        MlmeEvent::AuthenticateInd { .. } => "AuthenticateInd",
158        MlmeEvent::DeauthenticateConf { .. } => "DeauthenticateConf",
159        MlmeEvent::DeauthenticateInd { .. } => "DeauthenticateInd",
160        MlmeEvent::AssociateInd { .. } => "AssociateInd",
161        MlmeEvent::DisassociateConf { .. } => "DisassociateConf",
162        MlmeEvent::DisassociateInd { .. } => "DisassociateInd",
163        MlmeEvent::SetKeysConf { .. } => "SetKeysConf",
164        MlmeEvent::StartConf { .. } => "StartConf",
165        MlmeEvent::StopConf { .. } => "StopConf",
166        MlmeEvent::EapolConf { .. } => "EapolConf",
167        MlmeEvent::SignalReport { .. } => "SignalReport",
168        MlmeEvent::EapolInd { .. } => "EapolInd",
169        MlmeEvent::RelayCapturedFrame { .. } => "RelayCapturedFrame",
170        MlmeEvent::OnChannelSwitched { .. } => "OnChannelSwitched",
171        MlmeEvent::OnPmkAvailable { .. } => "OnPmkAvailable",
172        MlmeEvent::OnSaeHandshakeInd { .. } => "OnSaeHandshakeInd",
173        MlmeEvent::OnSaeFrameRx { .. } => "OnSaeFrameRx",
174        MlmeEvent::OnWmmStatusResp { .. } => "OnWmmStatusResp",
175    }
176}
177
178#[derive(Debug, Error)]
179pub enum Error {
180    #[error("scan end while not scanning")]
181    ScanEndNotScanning,
182    #[error("scan end with wrong txn id")]
183    ScanEndWrongTxnId,
184    #[error("scan result while not scanning")]
185    ScanResultNotScanning,
186    #[error("scan result with wrong txn id")]
187    ScanResultWrongTxnId,
188}
wlan_sme/lib.rs

wlan_sme/
lib.rs
