components/proximity_auth/proximity_auth_client.h

   1 // Copyright 2015 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_PROXIMITY_AUTH_PROXIMITY_AUTH_CLIENT_H_
   6 #define COMPONENTS_PROXIMITY_AUTH_PROXIMITY_AUTH_CLIENT_H_
   7
   8 #include <string>
   9
  10 #include "base/memory/scoped_ptr.h"
  11 #include "components/proximity_auth/cryptauth/proto/cryptauth_api.pb.h"
  12 #include "components/proximity_auth/screenlock_state.h"
  13
  14 class PrefService;
  15
  16 namespace proximity_auth {
  17
  18 class CryptAuthClientFactory;
  19 class CryptAuthDeviceManager;
  20 class CryptAuthEnrollmentManager;
  21 class SecureMessageDelegate;
  22
  23 // An interface that needs to be supplied to the Proximity Auth component by its
  24 // embedder. There should be one |ProximityAuthClient| per
  25 // |content::BrowserContext|.
  26 class ProximityAuthClient {
  27  public:
  28   virtual ~ProximityAuthClient() {}
  29
  30   // Returns the authenticated username.
  31   virtual std::string GetAuthenticatedUsername() const = 0;
  32
  33   // Updates the user pod on the signin or lock screen to reflect the provided
  34   // screenlock state.
  35   virtual void UpdateScreenlockState(ScreenlockState state) = 0;
  36
  37   // Finalizes an unlock attempt initiated by the user. If |success| is true,
  38   // the screen is unlocked; otherwise, the auth attempt is rejected. An auth
  39   // attempt must be in progress before calling this function.
  40   virtual void FinalizeUnlock(bool success) = 0;
  41
  42   // Finalizes a sign-in attempt initiated by the user. If |success| is true,
  43   // the user is signed in; otherwise, the auth attempt is rejected. An auth
  44   // attempt must be in progress before calling this function.
  45   virtual void FinalizeSignin(const std::string& secret) = 0;
  46
  47   // Returns the PrefService used by the profile.
  48   virtual PrefService* GetPrefService() = 0;
  49
  50   // Returns the SecureMessageDelegate used by the system.
  51   virtual scoped_ptr<SecureMessageDelegate> CreateSecureMessageDelegate() = 0;
  52
  53   // Constructs the CryptAuthClientFactory that can be used for API requests.
  54   virtual scoped_ptr<CryptAuthClientFactory> CreateCryptAuthClientFactory() = 0;
  55
  56   // Constructs the DeviceClassifier message that is sent to CryptAuth for all
  57   // API requests.
  58   virtual cryptauth::DeviceClassifier GetDeviceClassifier() = 0;
  59
  60   // Returns the account id of the user.
  61   virtual std::string GetAccountId() = 0;
  62
  63   virtual proximity_auth::CryptAuthEnrollmentManager*
  64   GetCryptAuthEnrollmentManager() = 0;
  65
  66   virtual proximity_auth::CryptAuthDeviceManager*
  67   GetCryptAuthDeviceManager() = 0;
  68 };
  69
  70 }  // namespace proximity_auth
  71
  72 #endif  // COMPONENTS_PROXIMITY_AUTH_PROXIMITY_AUTH_CLIENT_H_