wifi_sync: add ability to convert WifiCredential to onc properties

components/wifi_sync/wifi_credential.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "components/wifi_sync/wifi_credential.h"
 
 #include <limits>
 #include <string>

[erikwright (departed), 2015/01/08 19:27:07]

not required (included in header)

[mukesh agrawal, 2015/01/09 02:00:18]

Done.

Also removed limits, since it's also unnecessary. (I probably should have
removed it when I removed the numeric_limits check in ToString.)

 
+#include "base/i18n/streaming_utf8_validator.h"
 #include "base/logging.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/stringprintf.h"
+#include "base/values.h"
+#include "components/onc/onc_constants.h"
+#include "components/wifi_sync/wifi_security_class.h"

[erikwright (departed), 2015/01/08 19:27:07]

not required (included in header)

[mukesh agrawal, 2015/01/09 02:00:18]

Done.

 
 namespace wifi_sync {
 
 WifiCredential::WifiCredential(
     const std::vector<unsigned char>& ssid,
     WifiSecurityClass security_class,
     const std::string& passphrase)
     : ssid_(ssid),
       security_class_(security_class),
       passphrase_(passphrase) {
 }
 
 WifiCredential::~WifiCredential() {
 }
 
+bool WifiCredential::ToOncProperties(base::DictionaryValue* onc_properties)
+    const {
+  const std::string ssid_utf8(ssid().begin(), ssid().end());
+  if (!base::StreamingUtf8Validator::Validate(ssid_utf8)) {
+    LOG(ERROR) << "SSID is not valid UTF-8";
+    return false;
+  }
+
+  std::string onc_security;
+  if (!WifiSecurityClassToOncSecurityString(security_class(), &onc_security)) {

[erikwright (departed), 2015/01/08 19:27:07]

Assuming that security_class() is not ..._INVALID this method should definitely
succeed. I assume there is no reason that WifiCredential should ever be
constructed with ..._INVALID.

My preferred approach if there is no legitimate reason to have a WifiCredential
that is invalid would be:

(1) make the constructor private (not the copy constructor/assignment operators)
(2) disallow default constructor
(3) define public method "static scoped_ptr<WifiCredential> Create(ssid,
security_class, passphrase);" which returns a WifiCredential instance iff the
parameters are valid.

[mukesh agrawal, 2015/01/09 02:00:18]

Done.

I've left in the check that the SecurityClass conversion succeeded, but changed
it from LOG(ERROR) to NOTREACHED(). Let me know if it would make more sense to
remove the check.

[erikwright (departed), 2015/01/09 14:58:20]

The NOTREACHED is good, but I would remove the NULL return. Once you deal with
the ONC/UTF-8 thing it would seem appropriate for this method to always return a
valid object.

+    LOG(ERROR) << "Error converting SecurityClass with value "
+               << security_class();
+    return false;
+  }
+
+  onc_properties->Set(onc::toplevel_config::kType,
+                      new base::StringValue(onc::network_type::kWiFi));
+  // TODO(quiche): Switch to the HexSSID property, once ONC fully supports it.
+  onc_properties->Set(onc::network_config::WifiProperty(onc::wifi::kSSID),
+                      new base::StringValue(ssid_utf8));
+  onc_properties->Set(onc::network_config::WifiProperty(onc::wifi::kSecurity),
+                      new base::StringValue(onc_security));
+  if (WifiSecurityClassSupportsPassphrases(security_class())) {
+    onc_properties->Set(
+        onc::network_config::WifiProperty(onc::wifi::kPassphrase),
+        new base::StringValue(passphrase()));
+  }
+  return true;
+}
+
 std::string WifiCredential::ToString() const {
   return base::StringPrintf(
       "[SSID (hex): %s, SecurityClass: %d]",
       base::HexEncode(&ssid_.front(), ssid_.size()).c_str(),
       security_class_);  // Passphrase deliberately omitted.
 }
 
 // static
 bool WifiCredential::IsLessThan(
     const WifiCredential& a, const WifiCredential& b) {
   return a.ssid_ < b.ssid_ ||
       a.security_class_< b.security_class_ ||
       a.passphrase_ < b.passphrase_;
 }
 
 // static
 WifiCredential::CredentialSet WifiCredential::MakeSet() {
   return CredentialSet(WifiCredential::IsLessThan);
 }
 
+// static
+WifiCredential::SsidBytes WifiCredential::MakeSsidBytes(
+    const std::string& ssid) {
+  return SsidBytes(ssid.begin(), ssid.end());
+}
+
 }  // namespace wifi_sync