google_apis/gaia/gaia_auth_util.h

   1 // Copyright (c) 2012 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 GOOGLE_APIS_GAIA_GAIA_AUTH_UTIL_H_
   6 #define GOOGLE_APIS_GAIA_GAIA_AUTH_UTIL_H_
   7
   8 #include <string>
   9 #include <utility>
  10 #include <vector>
  11
  12 class GURL;
  13
  14 namespace gaia {
  15
  16 struct ListedAccount {
  17   // The account's ID, as per Chrome, will be determined in the
  18   // CookieManagerService.
  19   std::string id;
  20   std::string email;
  21   std::string gaia_id;
  22   std::string raw_email;
  23   bool valid;
  24
  25   ListedAccount();
  26   ~ListedAccount();
  27   bool operator==(const ListedAccount& other) const;
  28 };
  29
  30 // Perform basic canonicalization of |email_address|, taking into account that
  31 // gmail does not consider '.' or caps inside a username to matter.
  32 std::string CanonicalizeEmail(const std::string& email_address);
  33
  34 // Returns the canonical form of the given domain.
  35 std::string CanonicalizeDomain(const std::string& domain);
  36
  37 // Sanitize emails. Currently, it only ensures all emails have a domain by
  38 // adding gmail.com if no domain is present.
  39 std::string SanitizeEmail(const std::string& email_address);
  40
  41 // Returns true if the two specified email addresses are the same.  Both
  42 // addresses are first sanitized and then canonicalized before comparing.
  43 bool AreEmailsSame(const std::string& email1, const std::string& email2);
  44
  45 // Extract the domain part from the canonical form of the given email.
  46 std::string ExtractDomainName(const std::string& email);
  47
  48 bool IsGaiaSignonRealm(const GURL& url);
  49
  50 // Parses JSON data returned by /ListAccounts call, returning a vector of
  51 // email/valid pairs.  An email addresses is considered valid if a passive
  52 // login would succeed (i.e. the user does not need to reauthenticate).
  53 // If there an error parsing the JSON, then false is returned.
  54 bool ParseListAccountsData(
  55     const std::string& data, std::vector<ListedAccount>* accounts);
  56
  57 }  // namespace gaia
  58
  59 #endif  // GOOGLE_APIS_GAIA_GAIA_AUTH_UTIL_H_