android/libwvdrmengine/cdm/core/include/device_files.h

// Copyright 2013 Google Inc. All Rights Reserved.
//
#ifndef WVCDM_CORE_DEVICE_FILES_H_
#define WVCDM_CORE_DEVICE_FILES_H_

#include "wv_cdm_types.h"

#if defined(UNIT_TEST)
#include <gtest/gtest_prod.h>
#endif

namespace wvcdm {

class File;

class DeviceFiles {
 public:
  typedef enum {
    kLicenseStateActive,
    kLicenseStateReleasing,
    kLicenseStateUnknown,
  } LicenseState;

  DeviceFiles(): file_(NULL), security_level_(kSecurityLevelUninitialized),
                 initialized_(false), test_file_(false) {}
  virtual ~DeviceFiles();

  virtual bool Init(CdmSecurityLevel security_level);

  virtual bool StoreCertificate(const std::string& certificate,
                                const std::string& wrapped_private_key);
  virtual bool RetrieveCertificate(std::string* certificate,
                                   std::string* wrapped_private_key);

  virtual bool StoreLicense(const std::string& key_set_id,
                            const LicenseState state,
                            const CdmInitData& pssh_data,
                            const CdmKeyMessage& key_request,
                            const CdmKeyResponse& key_response,
                            const CdmKeyMessage& key_renewal_request,
                            const CdmKeyResponse& key_renewal_response,
                            const std::string& release_server_url);
  virtual bool RetrieveLicense(const std::string& key_set_id,
                               LicenseState* state,
                               CdmInitData* pssh_data,
                               CdmKeyMessage* key_request,
                               CdmKeyResponse* key_response,
                               CdmKeyMessage* key_renewal_request,
                               CdmKeyResponse* key_renewal_response,
                               std::string* release_server_url);
  virtual bool DeleteLicense(const std::string& key_set_id);
  virtual bool DeleteAllFiles();
  virtual bool DeleteAllLicenses();
  virtual bool LicenseExists(const std::string& key_set_id);

  virtual bool StoreUsageInfo(const std::string& provider_session_token,
                              const CdmKeyMessage& key_request,
                              const CdmKeyResponse& key_response);
  virtual bool DeleteUsageInfo(const std::string& provider_session_token);
  virtual bool DeleteUsageInfo();
  virtual bool RetrieveUsageInfo(
      std::vector<std::pair<CdmKeyMessage, CdmKeyResponse> >* usage_info);

 private:
  bool StoreFile(const char* name, const std::string& serialized_file);
  bool RetrieveFile(const char* name, std::string* serialized_file);

  // Certificate and offline licenses are now stored in security
  // level specific directories. In an earlier version they were
  // stored in a common directory and need to be copied over.
  virtual void SecurityLevelPathBackwardCompatibility();

  // For testing only:
  static std::string GetCertificateFileName();
  static std::string GetLicenseFileNameExtension();
  static std::string GetUsageInfoFileName();
  void SetTestFile(File* file);
#if defined(UNIT_TEST)
  FRIEND_TEST(DeviceFilesSecurityLevelTest, SecurityLevel);
  FRIEND_TEST(DeviceFilesStoreTest, StoreCertificate);
  FRIEND_TEST(DeviceFilesStoreTest, StoreLicense);
  FRIEND_TEST(DeviceFilesTest, DeleteLicense);
  FRIEND_TEST(DeviceFilesTest, ReadCertificate);
  FRIEND_TEST(DeviceFilesTest, RetrieveLicenses);
  FRIEND_TEST(DeviceFilesTest, SecurityLevelPathBackwardCompatibility);
  FRIEND_TEST(DeviceFilesTest, StoreLicenses);
  FRIEND_TEST(DeviceFilesTest, UpdateLicenseState);
  FRIEND_TEST(DeviceFilesUsageInfoTest, Delete);
  FRIEND_TEST(DeviceFilesUsageInfoTest, Read);
  FRIEND_TEST(DeviceFilesUsageInfoTest, Store);
  FRIEND_TEST(WvCdmRequestLicenseTest, UnprovisionTest);
  FRIEND_TEST(WvCdmRequestLicenseTest, ForceL3Test);
  FRIEND_TEST(WvCdmUsageInfoTest, DISABLED_UsageInfo);
#endif

  File* file_;
  CdmSecurityLevel security_level_;
  bool initialized_;

  bool test_file_;

  CORE_DISALLOW_COPY_AND_ASSIGN(DeviceFiles);
};

}  // namespace wvcdm

#endif  // WVCDM_CORE_DEVICE_FILES_H_