protection_descriptor_builder.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_BUILDER_H_
#define API_MIP_PROTECTION_DESCRIPTOR_BUILDER_H_
 
#include <map>
 
#include "mip/mip_export.h"
#include "mip/mip_namespace.h"
#include "mip/protection_descriptor.h"
#include "mip/user_rights.h"
#include "mip/user_roles.h"
 
MIP_NAMESPACE_BEGIN
 
class ProtectionDescriptorBuilder {
public:
    enum class LicenseType {
      DoNotForward = 0,
      EncryptOnly
    };
    
  MIP_API static std::shared_ptr<ProtectionDescriptorBuilder> CreateFromUserRights(
      const std::vector<UserRights>& usersAndRights);
 
  MIP_API static std::shared_ptr<ProtectionDescriptorBuilder> CreateFromUserRoles(
      const std::vector<UserRoles>& usersAndRoles);
 
  MIP_API static std::shared_ptr<ProtectionDescriptorBuilder> CreateFromTemplate(const std::string& templateId);
 
  MIP_API static std::shared_ptr<ProtectionDescriptorBuilder> CreateFromSerializedTemplate(
    const std::vector<uint8_t>& serializedTemplate);
 
  MIP_API static std::shared_ptr<ProtectionDescriptorBuilder> CreateFromProtectionDescriptor(const ProtectionDescriptor& protectionDescriptor);
 
  MIP_API static std::shared_ptr<ProtectionDescriptorBuilder> CreateFromLicenseType(
      LicenseType licenseType,
      const std::vector<std::string>& usersWithDefaultRights,
      const std::vector<UserRights>& additionalUsersAndRights);
 
  MIP_API virtual std::shared_ptr<ProtectionDescriptor> Build() = 0;
 
  virtual void SetName(const std::string& value) = 0;
 
  virtual void SetDescription(const std::string& value) = 0;
 
  virtual void SetContentValidUntil(const std::chrono::time_point<std::chrono::system_clock>& value) = 0;
 
  virtual void SetAllowOfflineAccess(bool value) = 0;
 
  virtual void SetReferrer(const std::string& uri) = 0;
 
  virtual void SetEncryptedAppData(const std::map<std::string, std::string>& value) = 0;
 
  virtual void SetSignedAppData(const std::map<std::string, std::string>& value) = 0;
 
  virtual void SetDoubleKeyUrl(const std::string& doubleKeyUrl) = 0;
 
  virtual void SetLabelInfo(const LabelInfo& labelId) = 0;
 
  virtual ~ProtectionDescriptorBuilder() {}
protected:
  ProtectionDescriptorBuilder() {}
};
 
MIP_NAMESPACE_END
 
#endif //API_MIP_PROTECTION_DESCRIPTOR_BUILDER_H_