protection_descriptor_cc.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_CC_H_
#define API_MIP_PROTECTION_DESCRIPTOR_CC_H_
 
#include <time.h>
 
#include "mip_cc/common_types_cc.h"
#include "mip_cc/dictionary_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/result_cc.h"
#include "mip_cc/string_list_cc.h"
#include "mip_cc/dynamic_watermark_cc.h"
 
typedef mip_cc_handle* mip_cc_protection_descriptor;
typedef mip_cc_handle* mip_cc_user_rights_result;
typedef mip_cc_handle* mip_cc_user_roles_result;
 
typedef enum {
  MIP_PROTECTION_TYPE_TEMPLATE_BASED = 0, 
  MIP_PROTECTION_TYPE_CUSTOM = 1,         
  MIP_PROTECTION_TYPE_DYNAMIC = 2,        
} mip_cc_protection_type;
 
typedef struct {
  const char** users;  
  int64_t usersCount;  
  const char** rights; 
  int64_t rightsCount; 
} mip_cc_user_rights;
 
typedef struct {
  const char** users;  
  int64_t usersCount;  
  const char** roles; 
  int64_t rolesCount; 
} mip_cc_user_roles;
 
MIP_CC_API(mip_cc_result) MIP_CC_CreateProtectionDescriptorFromTemplate(
    const char* templateId,
    const mip_cc_dictionary signedAppData,
    mip_cc_protection_descriptor* protectionDescriptor,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_CreateProtectionDescriptorFromUserRights(
    const mip_cc_user_rights* userRights,
    const int64_t userRightsCount,
    const char* name,
    const char* description,
    const char* referrer,
    const time_t* contentValidUntil,
    const bool allowOfflineAccess,
    const mip_cc_dictionary encryptedAppData,
    const mip_cc_dictionary signedAppData,
    mip_cc_protection_descriptor* protectionDescriptor,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_CreateProtectionDescriptorFromUserRoles(
    const mip_cc_user_roles* userRoles,
    const int64_t userRolesCount,
    const char* name,
    const char* description,
    const char* referrer,
    const time_t* contentValidUntil,
    const bool allowOfflineAccess,
    const mip_cc_dictionary encryptedAppData,
    const mip_cc_dictionary signedAppData,
    mip_cc_protection_descriptor* protectionDescriptor,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetProtectionType(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_protection_type* protectionType,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetOwnerSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* ownerSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetOwner(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* ownerBuffer,
    const int64_t ownerBufferSize,
    int64_t* actualOwnerSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetNameSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* nameSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetName(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetDescriptionSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* descriptionSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetDescription(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* descriptionBuffer,
    const int64_t descriptionBufferSize,
    int64_t* actualDescriptionSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetTemplateId(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_guid* templateId,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetLabelId(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_guid* labelId,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetContentId(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_guid* contentId,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_DoesContentExpire(
    const mip_cc_protection_descriptor protectionDescriptor,
    bool* doesContentExpire,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetContentValidUntil(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* contentValidUntil,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_DoesAllowOfflineAccess(
    const mip_cc_protection_descriptor protectionDescriptor,
    bool* doesAllowOfflineAccess,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_DoesLicenseExpire(
    const mip_cc_protection_descriptor protectionDescriptor,
    bool* doesLicenseExpire,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetLicenseValidUntil(
    const mip_cc_protection_descriptor protectionDescriptor,
    time_t* licenseValidUntil,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetReferrerSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* referrerSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetReferrer(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* referrerBuffer,
    const int64_t referrerBufferSize,
    int64_t* actualReferrerSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetSignedAppData(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_dictionary* signedAppData,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetEncryptedAppData(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_dictionary* encryptedAppData,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetDoubleKeyUrlSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* urlSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetDoubleKeyUrl(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* urlBuffer,
    const int64_t urlBufferSize,
    int64_t* actualUrlSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetUserRights(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_user_rights_result* userRights,
    int64_t* userRightsCount,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetUserRoles(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_user_roles_result* userRoles,
    int64_t* userRolesCount,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetDynamicWatermark( 
    const mip_cc_protection_descriptor protectionDescriptor, 
    mip_cc_dynamic_watermark* dynamicWatermark, 
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetSupplementalInfoSize(
    const mip_cc_protection_descriptor descriptor,
    const char* supplementalInfoKey,
    int64_t* supplementalInfoSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionDescriptor_GetSupplementalInfo(
    const mip_cc_protection_descriptor protectionDescriptor,
    const char* supplementalInfoKey,
    char* supplementalInfoBuffer,
    const int64_t supplementalInfoBufferSize,
    int64_t* actualsupplementalInfoSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(void) MIP_CC_ReleaseProtectionDescriptor(mip_cc_protection_descriptor protectionDescriptor);
 
#endif // API_MIP_PROTECTION_DESCRIPTOR_CC_H_