Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(245)

Side by Side Diff: components/wifi_sync/wifi_credential.h

Issue 2463463004: [Sync] Rename wifi_sync to sync_wifi. (Closed)
Patch Set: Created 4 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 // Copyright 2014 The Chromium 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 #ifndef COMPONENTS_WIFI_SYNC_WIFI_CREDENTIAL_H_
6 #define COMPONENTS_WIFI_SYNC_WIFI_CREDENTIAL_H_
7
8 #include <stdint.h>
9
10 #include <memory>
11 #include <set>
12 #include <string>
13 #include <vector>
14
15 #include "components/wifi_sync/wifi_security_class.h"
16
17 namespace base {
18 class DictionaryValue;
19 }
20
21 namespace wifi_sync {
22
23 // A container to hold the information required to locate and connect
24 // to a WiFi network.
25 class WifiCredential final { // final because the class is copyable
26 public:
27 // Per IEEE 802.11-2012 (Sec 8.4.2.2), the only requirement on SSIDs
28 // is that they are between 0 and 32 bytes in length
29 // (inclusive). There are no restrictions on the values of those
30 // bytes. The SSID is not, e.g., required to be encoded as UTF-8.
31 using SsidBytes = std::vector<uint8_t>;
32 using CredentialSet = std::set<
33 WifiCredential,
34 bool(*)(const WifiCredential&a, const WifiCredential& b)>;
35
36 WifiCredential(const WifiCredential& other);
37 ~WifiCredential();
38
39 // Creates a WifiCredential with the given |ssid|, |security_class|,
40 // and |passphrase|. No assumptions are made about the input
41 // encoding of |ssid|. |passphrase|, however, must be valid
42 // UTF-8. Returns NULL if the parameters are invalid.
43 static std::unique_ptr<WifiCredential> Create(
44 const SsidBytes& ssid,
45 WifiSecurityClass security_class,
46 const std::string& passphrase);
47
48 const SsidBytes& ssid() const { return ssid_; }
49 WifiSecurityClass security_class() const { return security_class_; }
50 const std::string& passphrase() const { return passphrase_; }
51
52 // Returns a dictionary which represents this WifiCredential as ONC
53 // properties. The resulting dictionary can be used, e.g, to
54 // configure a new network using
55 // chromeos::NetworkConfigurationHandler::CreateConfiguration. Due
56 // to limitations in ONC, this operation fails if ssid() is not
57 // valid UTF-8. In case of failure, returns a scoped_ptr with value
58 // nullptr.
59 std::unique_ptr<base::DictionaryValue> ToOncProperties() const;
60
61 // Returns a string representation of the credential, for debugging
62 // purposes. The string will not include the credential's passphrase.
63 std::string ToString() const;
64
65 // Returns true if credential |a| comes before credential |b|.
66 static bool IsLessThan(const WifiCredential& a, const WifiCredential& b);
67
68 // Returns an empty set of WifiCredentials, with the IsLessThan
69 // ordering function plumbed in.
70 static CredentialSet MakeSet();
71
72 // Returns |ssid| as an SsidBytes instance. This convenience
73 // function simplifies some tests, which need to instantiate
74 // SsidBytes from string literals.
75 static SsidBytes MakeSsidBytesForTest(const std::string& ssid);
76
77 private:
78 // Constructs a credential with the given |ssid|, |security_class|,
79 // and |passphrase|.
80 WifiCredential(const SsidBytes& ssid,
81 WifiSecurityClass security_class,
82 const std::string& passphrase);
83
84 // The WiFi network's SSID.
85 const SsidBytes ssid_;
86 // The WiFi network's security class (e.g. WEP, PSK).
87 const WifiSecurityClass security_class_;
88 // The passphrase for connecting to the network.
89 const std::string passphrase_;
90 };
91
92 } // namespace wifi_sync
93
94 #endif // COMPONENTS_WIFI_SYNC_WIFI_CREDENTIAL_H_
OLDNEW
« no previous file with comments | « components/wifi_sync/wifi_config_delegate_chromeos_unittest.cc ('k') | components/wifi_sync/wifi_credential.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698