protection_descriptor.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) Microsoft Corporation.
 * All rights reserved.
 *
 * This code is licensed under the MIT License.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files(the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions :
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */
#ifndef API_MIP_PROTECTION_DESCRIPTOR_H_
#define API_MIP_PROTECTION_DESCRIPTOR_H_
 
#include <chrono>
#include <map>
#include <memory>
#include <string>
 
#include "mip/mip_namespace.h"
#include "mip/user_rights.h"
#include "mip/user_roles.h"
#include "mip/dynamic_watermark.h"
 
MIP_NAMESPACE_BEGIN
 
enum class ProtectionType {
  TemplateBased = 0, 
  Custom = 1, 
};
 
struct LabelInfo {
  LabelInfo(const std::string& _labelId, const std::string& _tenantId) {
    labelId = _labelId;
    tenantId = _tenantId;
  }
  std::string labelId;
  std::string tenantId;
};
 
class ProtectionDescriptor {
public:
 
  virtual ProtectionType GetProtectionType() const = 0;
 
  virtual std::string GetOwner() const = 0;
 
  virtual std::string GetName() const = 0;
 
  virtual std::string GetDescription() const = 0;
 
  virtual std::string GetTemplateId() const = 0;
 
  virtual LabelInfo GetLabelInfo() const = 0;
 
  virtual std::string GetLabelId() const = 0;
 
  virtual std::string GetContentId() const = 0;
 
  virtual std::vector<UserRights> GetUserRights() const = 0;
 
  virtual std::vector<UserRoles> GetUserRoles() const = 0;
 
  virtual bool DoesContentExpire() const = 0;
 
  virtual std::chrono::time_point<std::chrono::system_clock> GetContentValidUntil() const = 0;
 
  virtual bool DoesAllowOfflineAccess() const = 0;
 
  virtual std::string GetReferrer() const = 0;
 
  virtual std::map<std::string, std::string> GetEncryptedAppData() const = 0;
 
  virtual std::map<std::string, std::string> GetSignedAppData() const = 0;
 
  virtual std::string GetDoubleKeyUrl() const = 0;
 
  virtual std::shared_ptr<const std::vector<uint8_t>> GetSerializedTemplate() const = 0;
 
  virtual std::shared_ptr<const DynamicWatermark> GetDynamicWatermark() const = 0;
 
  virtual std::string GetSupplementalInfo(const std::string& dataNeeded) const = 0;
 
  virtual ~ProtectionDescriptor() {}
protected:
  ProtectionDescriptor() {}
};
 
MIP_NAMESPACE_END
 
#endif //API_MIP_PROTECTION_DESCRIPTOR_H_