Merges to android Pi release (part 4)

These are a set of CLs merged from the wv cdm repo to the android repo.

* Correct RELEASE_ALL_USAGE_INFO_ERRORs

  Author: Rahul Frias <rfrias@google.com>

  [ Merge of http://go/wvgerrit/28742 ]

  RELEASE_ALL_USAGE_INFO_ERROR_4 and 5 were introduced and made use of in
  http://go/wvgerrit/24022 (branch: oc-dev). The error code definitions
  were merged over in http://go/wvgerrit/24602.

  When http://go/wvgerrit/24622 from cdm_partners_3.2 was merged to master
  (http://go/wvgerrit/27723) there was conflict in error codes. The error
  codes were adjusted to RELEASE_ALL_USAGE_INFO_ERROR_3 and 4
  and were made use of.

  To avoid renaming the errors between oc-dev and master, new errors
  RELEASE_ALL_USAGE_INFO_ERROR_6 and 7 have been added to handle the
  scenarios noted in the merge from cdm_partner_3.2. The other
  errors have been reverted back to RELEASE_ALL_USAGE_INFO_ERROR_4 and 5.
  They will be used when http://go/wvgerrit/24602 is merged.

* Address compilation issues

  Author: Rahul Frias <rfrias@google.com>

  [ Merge of http://go/wvgerrit/28740 ]

  These changes enable compilation of most of the cdm code on android
  expect for OEMCrypto unit tests (b/62739406) on wv master.

* Add property for binary/base64 provisioning msgs.

  Author: Gene Morgan <gmorgan@google.com>

  [ Merge of http://go/wvgerrit/28074 ]

  Property is "provisioning_messages_are_binary". Its default setting is
  false in the CE CDM, but it can be overridden by integrators.

  Added section to integration guide that discusses Provisioning Server
  message formats and the new property.

  Link: https://docs.google.com/document/d/1cBVbhgrajLpDe2W3_vzLzUqzpdDt73chvm4_sZlZlS8/edit#heading=h.hgxw53ddw7jo

BUG: 71650075
Test: Not currently passing. Will be addressed in a subsequent
      commit in the chain.

Change-Id: I9168193819974d1ff65d9a94dbd762e45ecc43ca

libwvdrmengine/cdm/core/include/cdm_session.h

@@ -24,6 +24,7 @@ namespace wvcdm {
 class CdmClientPropertySet;
 class ServiceCertificate;
 class WvCdmEventListener;
+class UsageTableHeader;
 
 class CdmSession {
  public:
@@ -42,7 +43,7 @@ class CdmSession {
   virtual CdmResponseType RestoreOfflineSession(
       const CdmKeySetId& key_set_id, const CdmLicenseType license_type);
   virtual CdmResponseType RestoreUsageSession(
-      const CdmKeyMessage& key_request, const CdmKeyResponse& key_response);
+      const DeviceFiles::CdmUsageData& usage_data);
 
   virtual const CdmSessionId& session_id() { return session_id_; }
   virtual const CdmKeySetId& key_set_id() { return key_set_id_; }
@@ -86,6 +87,9 @@ class CdmSession {
   // ReleaseKey() - Accept response and release key.
   virtual CdmResponseType ReleaseKey(const CdmKeyResponse& key_response);
 
+  virtual CdmResponseType DeleteUsageEntry(
+      const DeviceFiles::CdmUsageData& usage_data);
+
   virtual bool IsKeyLoaded(const KeyId& key_id);
   virtual int64_t GetDurationRemaining();
 
@@ -104,7 +108,8 @@ class CdmSession {
   // Delete usage information for the list of tokens, |provider_session_tokens|.
   virtual CdmResponseType DeleteMultipleUsageInformation(
       const std::vector<std::string>& provider_session_tokens);
-  virtual CdmResponseType UpdateUsageInformation();
+  virtual CdmResponseType UpdateUsageTableInformation();
+  virtual CdmResponseType UpdateUsageEntryInformation();
 
   virtual bool is_initial_usage_update() { return is_initial_usage_update_; }
   virtual bool is_usage_update_needed() { return is_usage_update_needed_; }
@@ -118,6 +123,9 @@ class CdmSession {
   virtual bool is_temporary() { return is_temporary_; }
   virtual bool license_received() { return license_received_; }
 
+  virtual CdmUsageSupportType get_usage_support_type()
+      { return usage_support_type_; }
+
   // ReleaseCrypto() - Closes the underlying crypto session but leaves this
   // object alive. It is invalid to call any method that requires a crypto
   // session after calling this. Since calling this renders this object mostly
@@ -170,6 +178,8 @@ class CdmSession {
   CdmResponseType StoreLicense();
   bool StoreLicense(DeviceFiles::LicenseState state);
 
+  bool UpdateUsageInfo();
+
   // These setters are for testing only. Takes ownership of the pointers.
   void set_license_parser(CdmLicense* license_parser);
   void set_crypto_session(CryptoSession* crypto_session);
@@ -203,11 +213,18 @@ class CdmSession {
   SecurityLevel requested_security_level_;
   CdmAppParameterMap app_parameters_;
 
-  // decryption and usage flags
+  // decryption flags
   bool is_initial_decryption_;
   bool has_decrypted_since_last_report_;  // ... last report to policy engine.
+
+  // Usage related flags and data
   bool is_initial_usage_update_;
   bool is_usage_update_needed_;
+  CdmUsageSupportType usage_support_type_;
+  UsageTableHeader* usage_table_header_;
+  uint32_t usage_entry_number_;
+  CdmUsageEntry usage_entry_;
+  std::string usage_provider_session_token_;
 
   // information useful for offline and usage scenarios
   CdmKeyMessage key_request_;

libwvdrmengine/cdm/core/include/crypto_session.h

@@ -93,7 +93,7 @@ class CryptoSession {
 
   // Usage related methods
   virtual bool UsageInformationSupport(bool* has_support);
-  virtual CdmResponseType UpdateUsageInformation();
+  virtual CdmResponseType UpdateUsageInformation();  // only for OEMCrypto v9-12
   virtual CdmResponseType DeactivateUsageInformation(
       const std::string& provider_session_token);
   virtual CdmResponseType GenerateUsageReport(

libwvdrmengine/cdm/core/include/device_files.h

@@ -154,9 +154,15 @@ class DeviceFiles {
   virtual bool ListUsageInfoFiles(std::vector<std::string>* usage_file_names);
   virtual bool RetrieveUsageInfo(const std::string& usage_info_file_name,
                                  std::vector<CdmUsageData>* usage_data);
+  virtual bool RetrieveUsageInfo(const std::string& usage_info_file_name,
+                                 const std::string& provider_session_token,
+                                 CdmUsageData* usage_data);
   // This method overwrites rather than appends data to the usage file
   virtual bool StoreUsageInfo(const std::string& usage_info_file_name,
                               const std::vector<CdmUsageData>& usage_data);
+  virtual bool UpdateUsageInfo(const std::string& usage_info_file_name,
+                               const std::string& provider_session_token,
+                               const CdmUsageData& usage_data);
 
   virtual bool StoreHlsAttributes(const std::string& key_set_id,
                                   const CdmHlsMethod method,

libwvdrmengine/cdm/core/include/license.h

@@ -62,6 +62,10 @@ class CdmLicense {
     return is_offline_;
   }
 
+  static bool ExtractProviderSessionToken(
+      const CdmKeyResponse& license_response,
+      std::string* provider_session_token);
+
  private:
 
   CdmResponseType HandleKeyErrorResponse(

libwvdrmengine/cdm/core/include/properties.h

@@ -40,6 +40,12 @@ class Properties {
   static inline bool use_certificates_as_identification() {
     return use_certificates_as_identification_;
   }
+  static inline bool provisioning_messages_are_binary() {
+    return provisioning_messages_are_binary_;
+  }
+  static void set_provisioning_messages_are_binary(bool flag) {
+    provisioning_messages_are_binary_ = flag;
+  }
   static inline bool security_level_path_backward_compatibility_support() {
     return security_level_path_backward_compatibility_support_;
   }
@@ -111,6 +117,7 @@ class Properties {
   static bool oem_crypto_use_userspace_buffers_;
   static bool use_certificates_as_identification_;
   static bool security_level_path_backward_compatibility_support_;
+  static bool provisioning_messages_are_binary_;
   static scoped_ptr<CdmClientPropertySetMap> session_property_set_;
 
   CORE_DISALLOW_COPY_AND_ASSIGN(Properties);

libwvdrmengine/cdm/core/include/usage_table_header.h

@@ -7,48 +7,36 @@
 #include <vector>
 
 #include "device_files.h"
-#include "file_store.h"
 #include "lock.h"
-#include "metrics_collections.h"
+#include "metrics_group.h"
 #include "scoped_ptr.h"
+#include "timer_metric.h"
 #include "wv_cdm_types.h"
 
 namespace wvcdm {
 
+class FileSystem;
 class CryptoSession;
 
-// Offline licenses/secure stops may be securely tracked using usage
-// tables (OEMCrypto v9-12) or usage table headers+usage entries
-// (OEMCrypto v13+). This class assists with the latter, synchronizing
-// access to usage table header and associated data-structures and controlling
-// when they are read in or written out to non-secure persistent storage.
-//
-// Each OEMCrypto (for each security level) will maintain its own usage table
-// header. Each license will have an associated usage entry that is also
-// stored in persistent memory and is noted in the usage table header.
-// Usage entry information will be verified when licenses are loaded.
-//
-// OEMCrypto for each security level have their own usage table
-// headers. They are loaded on initialization and written out periodically.
-// The lifecycle of this class is tied to when OEMCrypto is
-// initialized/terminated.
-//
-// Sessions and licenses are however handled by CdmSession and so most
-// calls to maniplate the usage table header related to usage entries
-// are by CdmSession.
-//
+// The UsageTableHeader class is a singleton that CDM sessions will share.
+// A separate object will be created for each security level.
+// The class synchronizes access to usage table header and associated
+// data-structures and controls when they are read in or written out to
+// non-secure persistent storage.
 // Upgrades from a fixed size usage table (supported by previous
 // versions of the OEMCrypto API v9-12) are handled by this class.
-// |usage_entry| and |usage_entry_number|s need to be saved in the license
+// |usage_entry| and |usage_entry_number| need to be saved in the license
 // and usage info records by the caller.
 class UsageTableHeader {
  public:
-  UsageTableHeader();
-  virtual ~UsageTableHeader() {}
-
+  // This methods instantiates or retrieves a usage table header singleton of
+  // appropriate security level as specified by the |crypto_session|
+  // object.
   // |crypto_session| is used to create or load a usage master table and
   // not cached beyound this call.
-  bool Init(CdmSecurityLevel security_level, CryptoSession* crypto_session);
+  static UsageTableHeader* GetInstance(FileSystem* file_system,
+                                       CryptoSession* crypto_session_);
+  virtual ~UsageTableHeader() {}
 
   // |persistent_license| false indicates usage info record
   CdmResponseType AddEntry(CryptoSession* crypto_session,
@@ -65,69 +53,56 @@ class UsageTableHeader {
   // The licenses or usage info records specified by |usage_entry_number|
   // should not be in use by any open CryptoSession objects when calls
   // to DeleteEntry and MoveEntry are made.
-  CdmResponseType DeleteEntry(uint32_t usage_entry_number, DeviceFiles* handle,
-                              metrics::CryptoMetrics* metrics);
+  CdmResponseType DeleteEntry(uint32_t usage_entry_number);
+  CdmResponseType MoveEntry(uint32_t from_usage_entry_number,
+                            const CdmUsageEntry& from_usage_entry,
+                            uint32_t to_usage_entry_number);
 
  private:
-  CdmResponseType MoveEntry(uint32_t from /* usage entry number */,
-                            const CdmUsageEntry& from_usage_entry,
-                            uint32_t to /* usage entry number */,
-                            DeviceFiles* handle,
-                            metrics::CryptoMetrics* metrics);
+  UsageTableHeader(FileSystem* file_system, CryptoSession* crypto_session,
+                   CdmSecurityLevel security_level);
 
-  CdmResponseType GetEntry(uint32_t usage_entry_number, DeviceFiles* handle,
+  CdmResponseType GetEntry(uint32_t usage_entry_number,
                            CdmUsageEntry* usage_entry);
-  CdmResponseType StoreEntry(uint32_t usage_entry_number, DeviceFiles* handle,
+  CdmResponseType StoreEntry(uint32_t usage_entry_number,
                              const CdmUsageEntry& usage_entry);
 
-  CdmResponseType Shrink(metrics::CryptoMetrics* metrics,
-                         uint32_t number_of_usage_entries_to_delete);
+  bool DeleteLastEntry();
 
-  CdmResponseType UpgradeFromUsageTable(DeviceFiles* handle,
-                                        metrics::CryptoMetrics* metrics);
-  bool UpgradeLicensesFromUsageTable(DeviceFiles* handle,
-                                     metrics::CryptoMetrics* metrics);
-  bool UpgradeUsageInfoFromUsageTable(DeviceFiles* handle,
-                                      metrics::CryptoMetrics* metrics);
+  CdmResponseType UpgradeFromUsageTable();
+
+  // Indicates whether one of more license/usage records failed to be upgraded.
+  bool UpgradeLicensesFromUsageTable();
+  bool UpgradeUsageInfoFromUsageTable();
 
   virtual bool is_inited() { return is_inited_; }
 
-  virtual bool CreateDummyOldUsageEntry(CryptoSession* crypto_session);
+  SecurityLevel GetSecurityLevel() {
+    return security_level_ == kSecurityLevelL3 ? kLevel3 : kLevelDefault;
+  }
+
+  static UsageTableHeader* usage_table_header_l1_;
+  static UsageTableHeader* usage_table_header_l3_;
 
-  // This handle and file system is only to be used when accessing
-  // usage_table_header. Usage entries should use the file system provided
-  // by CdmSession.
   scoped_ptr<DeviceFiles> file_handle_;
-  scoped_ptr<FileSystem> file_system_;
   CdmSecurityLevel security_level_;
-  SecurityLevel requested_security_level_;
 
   CdmUsageTableHeader usage_table_header_;
   std::vector<CdmUsageEntryInfo> usage_entry_info_;
 
+  metrics::MetricsGroup metrics_;
+  metrics::TimerMetric life_span_;
+
   // Lock to ensure that a single object is created for each security level
   // and data member to represent whether an object has been correctly
   // initialized.
   bool is_inited_;
+  static Lock initialization_lock_;
 
   // Synchonizes access to the Usage Table Header and bookkeeping
   // data-structures
   Lock usage_table_header_lock_;
 
-  // Test related declarations
-  friend class UsageTableHeaderTest;
-
-  // These setters are for testing only. Takes ownership of the pointers.
-  void SetDeviceFiles(DeviceFiles* device_files) {
-    file_handle_.reset(device_files);
-  }
-  void SetCryptoSession(CryptoSession* crypto_session) {
-    test_crypto_session_.reset(crypto_session);
-  }
-
-  // Test related data members
-  scoped_ptr<CryptoSession> test_crypto_session_;
-
   CORE_DISALLOW_COPY_AND_ASSIGN(UsageTableHeader);
 };
 

libwvdrmengine/cdm/core/include/wv_cdm_types.h

@@ -285,15 +285,15 @@ enum CdmResponseType {
   INVALID_USAGE_ENTRY_NUMBER_MODIFICATION, /* 240 */
   USAGE_INVALID_NEW_ENTRY,
   USAGE_INVALID_PARAMETERS_1,
-  USAGE_RETRIEVE_LICENSE_FAILED,
-  USAGE_RETRIEVE_USAGE_INFO_FAILED,
-  USAGE_RETRIEVE_INVALID_STORAGE_TYPE, /* 245 */
+  USAGE_GET_ENTRY_RETRIEVE_LICENSE_FAILED,
+  USAGE_GET_ENTRY_RETRIEVE_USAGE_INFO_FAILED,
+  USAGE_GET_ENTRY_RETRIEVE_INVALID_STORAGE_TYPE, /* 245 */
   USAGE_ENTRY_NUMBER_MISMATCH,
   USAGE_STORE_LICENSE_FAILED,
   USAGE_STORE_USAGE_INFO_FAILED,
   USAGE_INVALID_LOAD_ENTRY,
-  RELEASE_ALL_USAGE_INFO_ERROR_3, /* 250 */
-  RELEASE_ALL_USAGE_INFO_ERROR_4,
+  RELEASE_ALL_USAGE_INFO_ERROR_4, /* 250 */
+  RELEASE_ALL_USAGE_INFO_ERROR_5,
   RELEASE_USAGE_INFO_FAILED,
   INCORRECT_USAGE_SUPPORT_TYPE_1,
   INCORRECT_USAGE_SUPPORT_TYPE_2,
@@ -314,6 +314,11 @@ enum CdmResponseType {
   PARSE_RESPONSE_ERROR_2,
   PARSE_RESPONSE_ERROR_3, /* 270 */
   PARSE_RESPONSE_ERROR_4,
+  USAGE_STORE_ENTRY_RETRIEVE_LICENSE_FAILED,
+  USAGE_STORE_ENTRY_RETRIEVE_USAGE_INFO_FAILED,
+  USAGE_STORE_ENTRY_RETRIEVE_INVALID_STORAGE_TYPE,
+  RELEASE_ALL_USAGE_INFO_ERROR_6, /* 275 */
+  RELEASE_ALL_USAGE_INFO_ERROR_7,
 };
 
 enum CdmKeyStatus {