device_management_service.h revision a1401311d1ab56c4ed0a474bd38c108f75cb0cd9
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#ifndef COMPONENTS_POLICY_CORE_COMMON_CLOUD_DEVICE_MANAGEMENT_SERVICE_H_ 6a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#define COMPONENTS_POLICY_CORE_COMMON_CLOUD_DEVICE_MANAGEMENT_SERVICE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <deque> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/callback.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/weak_ptr.h" 17a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "components/policy/core/common/cloud/cloud_policy_constants.h" 18a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "components/policy/policy_export.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/url_request/url_fetcher_delegate.h" 20a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "policy/proto/device_management_backend.pb.h" 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class URLRequestContextGetter; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace policy { 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DeviceManagementRequestJobImpl; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DeviceManagementService; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DeviceManagementRequestJob describes a request to send to the device 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// management service. Jobs are created by DeviceManagementService. They can be 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// canceled by deleting the object. 34a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)class POLICY_EXPORT DeviceManagementRequestJob { 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Describes the job type. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum JobType { 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_AUTO_ENROLLMENT, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_REGISTRATION, 40c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) TYPE_API_AUTH_CODE_FETCH, 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_POLICY_FETCH, 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_UNREGISTRATION, 43c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) TYPE_UPLOAD_CERTIFICATE, 44a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) TYPE_DEVICE_STATE_RETRIEVAL, 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef base::Callback< 48b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) void(DeviceManagementStatus, int, 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const enterprise_management::DeviceManagementResponse&)> Callback; 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) typedef base::Callback<void(DeviceManagementRequestJob*)> RetryCallback; 522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~DeviceManagementRequestJob(); 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Functions for configuring the job. These should only be called before 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Start()ing the job, but never afterwards. 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetGaiaToken(const std::string& gaia_token); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetOAuthToken(const std::string& oauth_token); 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetUserAffiliation(UserAffiliation user_affiliation); 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetDMToken(const std::string& dm_token); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetClientID(const std::string& client_id); 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enterprise_management::DeviceManagementRequest* GetRequest(); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // A job may automatically retry if it fails due to a temporary condition, or 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // due to proxy misconfigurations. If a |retry_callback| is set then it will 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // be invoked with the DeviceManagementRequestJob as an argument when that 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // happens, so that the job's owner can customize the retry request before 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // it's sent. 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void SetRetryCallback(const RetryCallback& retry_callback); 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts the job. |callback| will be invoked on completion. 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void Start(const Callback& callback); 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::vector<std::pair<std::string, std::string> > ParameterMap; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 774e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) DeviceManagementRequestJob(JobType type, 784e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) const std::string& agent_parameter, 794e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) const std::string& platform_parameter); 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Appends a parameter to |query_params|. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddParameter(const std::string& name, const std::string& value); 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Fires the job, to be filled in by implementations. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Run() = 0; 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ParameterMap query_params_; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string gaia_token_; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string dm_token_; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enterprise_management::DeviceManagementRequest request_; 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) RetryCallback retry_callback_; 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Callback callback_; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(DeviceManagementRequestJob); 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The device management service is responsible for everything related to 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// communication with the device management server. It creates the backends 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// objects that the device management policy provider and friends use to issue 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// requests. 103a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)class POLICY_EXPORT DeviceManagementService : public net::URLFetcherDelegate { 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 1054e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Obtains the parameters used to contact the server. 1064e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // This allows creating the DeviceManagementService early and getting these 1074e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // parameters later. Passing the parameters directly in the ctor isn't 1084e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // possible because some aren't ready during startup. http://crbug.com/302798 109a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) class POLICY_EXPORT Configuration { 1104e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) public: 1114e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) virtual ~Configuration() {} 1124e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 1134e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Server at which to contact the service. 1144e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) virtual std::string GetServerUrl() = 0; 1154e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 1164e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Agent reported in the "agent" query parameter. 1174e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) virtual std::string GetAgentParameter() = 0; 1184e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 1194e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // The platform reported in the "platform" query parameter. 1204e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) virtual std::string GetPlatformParameter() = 0; 1214e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) }; 1224e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 123a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) explicit DeviceManagementService(scoped_ptr<Configuration> configuration); 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~DeviceManagementService(); 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The ID of URLFetchers created by the DeviceManagementService. This can be 1272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // used by tests that use a TestURLFetcherFactory to get the pending fetchers 1282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // created by the DeviceManagementService. 1292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static const int kURLFetcherID; 1302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a new device management request job. Ownership is transferred to 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the caller. 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual DeviceManagementRequestJob* CreateJob( 134a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) DeviceManagementRequestJob::JobType type, 135a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) net::URLRequestContextGetter* request_context); 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Schedules a task to run |Initialize| after |delay_milliseconds| had passed. 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ScheduleInitialization(int64 delay_milliseconds); 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 140a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // Makes the service stop all requests. 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Shutdown(); 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 143a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // Gets the URL that the DMServer requests are sent to. 144a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) std::string GetServerUrl(); 145a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<const net::URLFetcher*, 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DeviceManagementRequestJobImpl*> JobFetcherMap; 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::deque<DeviceManagementRequestJobImpl*> JobQueue; 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class DeviceManagementRequestJobImpl; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // net::URLFetcherDelegate override. 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE; 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 156a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // Starts processing any queued jobs. 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Initialize(); 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts a job. 1602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void StartJob(DeviceManagementRequestJobImpl* job); 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Adds a job. Caller must make sure the job pointer stays valid until the job 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // completes or gets canceled via RemoveJob(). 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddJob(DeviceManagementRequestJobImpl* job); 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes a job. The job will be removed and won't receive a completion 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // callback. 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveJob(DeviceManagementRequestJobImpl* job); 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1704e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // A Configuration implementation that is used to obtain various parameters 1714e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // used to talk to the device management server. 1724e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) scoped_ptr<Configuration> configuration_; 1734e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The jobs we currently have in flight. 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) JobFetcherMap pending_jobs_; 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Jobs that are registered, but not started yet. 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) JobQueue queued_jobs_; 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this service is initialized, incoming requests get fired instantly. 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If it is not initialized, incoming requests are queued. 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool initialized_; 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Used to create tasks to run |Initialize| delayed on the UI thread. 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::WeakPtrFactory<DeviceManagementService> weak_ptr_factory_; 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(DeviceManagementService); 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace policy 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 192a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#endif // COMPONENTS_POLICY_CORE_COMMON_CLOUD_DEVICE_MANAGEMENT_SERVICE_H_ 193