wlan_storage_constants/
constants.rs

1// Copyright 2020 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
5use serde::{Deserialize, Serialize};
6
7pub const NODE_SEPARATOR: &'static str = "#/@";
8pub const POLICY_STASH_PREFIX: &str = "config";
9/// The StashNode abstraction requires that writing to a StashNode is done as a named field,
10/// so we will store the network config's data under the POLICY_DATA_KEY.
11pub const POLICY_DATA_KEY: &str = "data";
12pub const POLICY_STORAGE_ID: &str = "saved_networks";
13
14pub type StashedSsid = Vec<u8>;
15
16/// The data that will be stored between reboots of a device. Used to convert the data between JSON
17/// and network config.
18#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
19pub struct PersistentData {
20    pub credential: Credential,
21    pub has_ever_connected: bool,
22}
23
24/// The network identifier is the SSID and security policy of the network, and it is used to
25/// distinguish networks. It mirrors the NetworkIdentifier in fidl_fuchsia_wlan_policy.
26#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
27pub struct NetworkIdentifier {
28    pub ssid: StashedSsid,
29    pub security_type: SecurityType,
30}
31
32/// The security type of a network connection. It mirrors the fidl_fuchsia_wlan_policy SecurityType
33#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
34pub enum SecurityType {
35    None,
36    Wep,
37    Wpa,
38    Wpa2,
39    Wpa3,
40}
41
42/// The credential of a network connection. It mirrors the fidl_fuchsia_wlan_policy Credential
43#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
44pub enum Credential {
45    None,
46    Password(Vec<u8>),
47    Psk(Vec<u8>),
48}
49
50/// To deserialize file data into a JSON with a file version and data, a wrapper is needed since
51/// the values of the hashmap must be consistent.
52#[derive(Serialize, Deserialize)]
53#[serde(untagged)]
54pub enum FileContent {
55    Version(u8),
56    Networks(Vec<PersistentStorageData>),
57}
58
59/// The data that will be stored between reboots of a device. Used to convert the data between JSON
60/// and network config.
61#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
62pub struct PersistentStorageData {
63    pub ssid: StashedSsid,
64    pub security_type: SecurityType,
65    pub credential: Credential,
66    #[serde(default = "has_ever_connected_default")]
67    pub has_ever_connected: bool,
68}
69
70/// Defines the default value of has_ever_connected in persisted data. This is used so that the
71/// config could be loaded even if this field is missing.
72fn has_ever_connected_default() -> bool {
73    false
74}
75
76impl PersistentStorageData {
77    /// Used when migrating persisted networks from deprecated stash to the new local storage format.
78    pub fn new_from_legacy_data(
79        id: NetworkIdentifier,
80        data: PersistentData,
81    ) -> PersistentStorageData {
82        PersistentStorageData {
83            ssid: id.ssid.clone(),
84            security_type: id.security_type,
85            credential: data.credential,
86            has_ever_connected: data.has_ever_connected,
87        }
88    }
89}
wlan_storage_constants/constants.rs

wlan_storage_constants/
constants.rs
