components/wifi_sync/wifi_credential.h

   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 <set>
  11 #include <string>
  12 #include <vector>
  13
  14 #include "base/memory/scoped_ptr.h"
  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();
  37
  38   // Creates a WifiCredential with the given |ssid|, |security_class|,
  39   // and |passphrase|. No assumptions are made about the input
  40   // encoding of |ssid|. |passphrase|, however, must be valid
  41   // UTF-8. Returns NULL if the parameters are invalid.
  42   static scoped_ptr<WifiCredential> Create(
  43       const SsidBytes& ssid,
  44       WifiSecurityClass security_class,
  45       const std::string& passphrase);
  46
  47   const SsidBytes& ssid() const { return ssid_; }
  48   WifiSecurityClass security_class() const { return security_class_; }
  49   const std::string& passphrase() const { return passphrase_; }
  50
  51   // Returns a dictionary which represents this WifiCredential as ONC
  52   // properties. The resulting dictionary can be used, e.g, to
  53   // configure a new network using
  54   // chromeos::NetworkConfigurationHandler::CreateConfiguration. Due
  55   // to limitations in ONC, this operation fails if ssid() is not
  56   // valid UTF-8. In case of failure, returns a scoped_ptr with value
  57   // nullptr.
  58   scoped_ptr<base::DictionaryValue> ToOncProperties() const;
  59
  60   // Returns a string representation of the credential, for debugging
  61   // purposes. The string will not include the credential's passphrase.
  62   std::string ToString() const;
  63
  64   // Returns true if credential |a| comes before credential |b|.
  65   static bool IsLessThan(const WifiCredential& a, const WifiCredential& b);
  66
  67   // Returns an empty set of WifiCredentials, with the IsLessThan
  68   // ordering function plumbed in.
  69   static CredentialSet MakeSet();
  70
  71   // Returns |ssid| as an SsidBytes instance. This convenience
  72   // function simplifies some tests, which need to instantiate
  73   // SsidBytes from string literals.
  74   static SsidBytes MakeSsidBytesForTest(const std::string& ssid);
  75
  76  private:
  77   // Constructs a credential with the given |ssid|, |security_class|,
  78   // and |passphrase|.
  79   WifiCredential(const SsidBytes& ssid,
  80                  WifiSecurityClass security_class,
  81                  const std::string& passphrase);
  82
  83   // The WiFi network's SSID.
  84   const SsidBytes ssid_;
  85   // The WiFi network's security class (e.g. WEP, PSK).
  86   const WifiSecurityClass security_class_;
  87   // The passphrase for connecting to the network.
  88   const std::string passphrase_;
  89 };
  90
  91 }  // namespace wifi_sync
  92
  93 #endif  // COMPONENTS_WIFI_SYNC_WIFI_CREDENTIAL_H_