Add client side protobuf fields for reporting status with policy requests.

chrome/browser/policy/proto/device_management_backend.proto

 // Copyright (c) 2011 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.
 
 syntax = "proto2";
 
 option optimize_for = LITE_RUNTIME;
 
 package enterprise_management;
 
@@ skipping 11 matching lines @@
   enum Type {
     TT   = 0;       // Register for TT release.
     USER = 1;       // Register for user polices.
     DEVICE = 2;     // Register for device policies.
   }
   // NOTE: we also use this field to detect client version.  If this
   // field is missing, then the request comes from TT.  We will remove
   // Chrome OS TT support once it is over.
   optional Type type = 2 [default = TT];
 
-  // Machine hardware id, such as MEID, Mac adress.
+  // Machine hardware id, such as serial number.
   // This field is required if register type == DEVICE.
   optional string machine_id = 3;
 
   // Machine model name, such as "ZGA", "Cr-48", "Nexus One".  If the
   // model name is not available, client SHOULD send generic name like
   // "Android", or "Chrome OS".
   optional string machine_model = 4;
 }
 
 // Response from server to device register request.
@@ skipping 47 matching lines @@
     SHA1_RSA = 1;
   }
   optional SignatureType signature_type = 3 [default = NONE];
 
   // The version number of the public key that is currently stored
   // on the client. This should be the last number the server had
   // supplied as new_public_key_version in PolicyData.
   // This field is unspecified if the client does not yet have a
   // public key.
   optional int32 public_key_version = 4;
+
+  // Machine hardware id, such as serial number.
+  // This field is should be set only if the serial number for the device is
+  // missing from the server, as indicated by the valid_serial_number_missing
+  // field in the last policy fetch response.
+  optional string machine_id = 5;
 }
 
 // This message is included in serialized form in PolicyFetchResponse
 // below.  It may also be signed, with the signature being created for
 // the serialized form.
 message PolicyData {
   // See PolicyFetchRequest.policy_type.
   optional string policy_type = 1;
 
-  // [timestamp] is milli seconds since Epoch in UTC timezone. It is
+  // [timestamp] is milliseconds since Epoch in UTC timezone. It is
   // included here so that the time at which the server issued this
   // response cannot be faked (as protection against replay attacks).
   // It is the timestamp generated by DMServer, NOT the time admin
   // last updated the policy or anything like that.
   optional int64 timestamp = 2;
 
   // The DM token that was used by the client in the HTTP POST header
   // for authenticating the request. It is included here again so that
   // the client can verify that the response is meant for him (and not
   // issued by a replay or man-in-the-middle attack).
@@ skipping 29 matching lines @@
   // Indicates which state this association with DMServer is in. This can be
   // used to tell the client that it is not receiving policy even though the
   // registration with the server is kept active.
   enum AssociationState {
     // Association is active and policy is pushed.
     ACTIVE = 0;
     // Association is alive, but the corresponding domain is not managed.
     UNMANAGED = 1;
   }
   optional AssociationState state = 9 [default = ACTIVE];
+
+  // Indicates if the the server cannot find a valid serial number for the
+  // device.  If this flag is set, the device should send the valid serial
+  // number with a device policy fetch request.  Note that this only
+  // applies to device policy.
+  optional bool valid_serial_number_missing = 10;
 }
 
 message PolicyFetchResponse {
   // Since a single policy request may ask for multiple policies, we
   // provide separate error code for each individual policy fetch.
 
   // We will use standard HTTP Status Code as error code.
-  optional int32  error_code = 1;
+  optional int32 error_code = 1;
 
   // Human readable error message for customer support purpose.
   optional string error_message = 2;
 
   // This is a serialized |PolicyData| protobuf (defined above).
   optional bytes policy_data = 3;
 
   // Signature of the policy data above.
   optional bytes policy_data_signature = 4;
 
@@ skipping 21 matching lines @@
   // request multiple policies for better performance.
   repeated PolicyFetchRequest request = 3;
 }
 
 // Response from server to device for reading policies.
 message DevicePolicyResponse {
   // The policy fetch response.
   repeated PolicyFetchResponse response = 3;
 }
 
+message TimePeriod {
+  // [timestamp] is milli seconds since Epoch in UTC timezone.
+  optional int64 start_timestamp = 1;
+  optional int64 end_timestamp = 2;
+}
+
+// This captures launch events for one app/extension or other installments.
+message InstallableLaunch {
+  optional string install_id = 1;
+
+  // Time duration where this report covers. These are required
+  // and the record will be ignored if not set.
+  optional TimePeriod duration = 2;
+
+  // Client will send at most 50 timestamps to DM. All the rest
+  // launch activities will be summed into the total count.
+  // We will distribute the count evenly among the time span when
+  // doing time based aggregation.
+  repeated int64 timestamp = 3;
+  optional int64 total_count = 4;
+}
+
+// Report device level status.
+message DeviceStatusReportRequest {
+  optional string os_version = 1;
+  optional string firmware_version = 2;
+
+  // "Validated", "Dev". Same as verified mode.
+  // If the mode is unknown, this field should not be set.
+  optional string boot_mode = 3;
+
+  // Device active times collection since last report rpc call.
+  repeated TimePeriod active_time = 4;
+}
+
+// Report session (a user on one device) level status.
+message SessionStatusReportRequest {
+  // Installed apps for this user on this device.
+  repeated string installed_app_id = 1;
+
+  // Installed extensions for this user on this device.
+  repeated string installed_extension_id = 2;
+
+  // One stat per app for top 30 apps.
+  repeated InstallableLaunch app_launch_stat = 3;
+}
+
+// Response from DMServer to update devices' status.
+// It is possible that status report fails but policy request succeed.  In such
+// case, the DeviceStatusReportResponse will contain an error code and the
+// device should re-send status report data in the next policy request.  The
+// device should re-send report data if policy request fails, even if
+// DeviceStatusReportResponse contains no error code.
+message DeviceStatusReportResponse {
+  optional int32 error_code = 1;
+
+  // Human readable error message for customer support purpose.
+  optional string error_message = 2;
+}
+
+// Response from DMServer to update user devices' status.
+// It is possible that status report fails but policy request succeed.  In such
+// case, the SessionStatusReportResponse will contain an error code and the
+// device should re-send status report data in the next policy request.  The
+// device should re-send report data if policy request fails, even if
+// SessionStatusReportResponse contains no error code.
+message SessionStatusReportResponse {
+  optional int32 error_code = 1;
+
+  // Human readable error message for customer support purpose.
+  optional string error_message = 2;
+}
+
 // Request from the DMAgent on the device to the DMServer.  This is
 // container for all requests from device to server.  The overall HTTP
 // request MUST be in the following format:
 //
 // * HTTP method is POST
 // * Data mime type is application/x-protobuffer
 // * HTTP parameters are (all required, all case sensitive):
-//   * request: MUST BE one of register/unregister/policy/ping
+//   * request: MUST BE one of register/unregister/policy/ping/status
 //   * devicetype: MUST BE "1" for Android or "2" for Chrome OS.
 //   * apptype: MUST BE Android or Chrome.
 //   * deviceid: MUST BE no more than 64-char in [\x21-\x7E].
 //   * agent: MUST BE no more than 64-char long.
 // * HTTP Authorization header MUST be in the following formats:
 //   * For register and ping requests
 //     Authorization: GoogleLogin auth=<auth cookie for Mobile Sync>
 //
-//   * For unregister and policy requests
+//   * For unregister, policy and status requests
 //      Authorization: GoogleDMToken token=<dm token from register>
 //
 //   * OAuth is NOT supported yet.
+//
+// DeviceManagementRequest should only contain one request which matches the
+// HTTP query parameter - request, as listed below. Other requests within the
+// container will be ignored.
+//   ping: policy_request
+//   register: register_request
+//   unregister: unregister_request
+//   policy: policy_request
+//   status: status_report_request
+//
+//
 message DeviceManagementRequest {
   // Register request.
   optional DeviceRegisterRequest register_request = 1;
 
   // Unregister request.
   optional DeviceUnregisterRequest unregister_request = 2;
 
   // Policy request.
   optional DevicePolicyRequest policy_request = 3;

[Joao da Silva, 2011/11/16 15:20:31]

The StatusReportRequests are missing here.

[Patrick Dubroy, 2011/11/16 15:44:41]

Whoops! Good catch. Fixed.

 }
 
 // Response from server to device.
 //
 // The server uses the following numbers as HTTP status codes
 // to report top-level errors.
 //
 // 200 OK: valid response is returned to client.
 // 400 Bad Request: invalid argument.
 // 401 Unauthorized: invalid auth cookie or DM token.
@@ skipping 10 matching lines @@
   optional string error_message = 2;
 
   // Register response
   optional DeviceRegisterResponse register_response = 3;
 
   // Unregister response
   optional DeviceUnregisterResponse unregister_response = 4;
 
   // Policy response.
   optional DevicePolicyResponse policy_response = 5;
+
+  // Device status report response.
+  optional DeviceStatusReportResponse device_status_report_response = 6;
+
+  // Session status report response.
+  optional SessionStatusReportResponse session_status_report_response = 7;
 }