protection_engine_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_PROTECTION_ENGINE_CC_H_
#define API_MIP_PROTECTION_PROTECTION_ENGINE_CC_H_
 
#include <stdint.h>
 
#include "mip_cc/application_info_cc.h"
#include "mip_cc/auth_callback_cc.h"
#include "mip_cc/common_types_cc.h"
#include "mip_cc/consent_callback_cc.h"
#include "mip_cc/dictionary_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/mip_macros_cc.h"
#include "mip_cc/protection/delegation_license_cc.h"
#include "mip_cc/protection/license_info_cc.h"
#include "mip_cc/protection/protection_handler_cc.h"
#include "mip_cc/protection/template_descriptor_cc.h"
#include "mip_cc/result_cc.h"
#include "mip_cc/string_list_cc.h"
 
typedef mip_cc_handle* mip_cc_protection_engine;
typedef mip_cc_handle* mip_cc_protection_engine_settings;
 
MIP_CC_API(void) MIP_CC_ReleaseProtectionEngine(mip_cc_protection_engine engine);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_CreateProtectionHandlerForPublishing(
    const mip_cc_protection_engine engine,
    const mip_cc_protection_handler_publishing_settings settings,
    const void* context,
    mip_cc_protection_handler* handler,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_CreateProtectionHandlerForConsumption(
  const mip_cc_protection_engine engine,
  const mip_cc_protection_handler_consumption_settings settings,
  const void* context,
  mip_cc_protection_handler* handler,
  mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_GetEngineIdSize(
    const mip_cc_protection_engine engine,
    int64_t* idSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_GetEngineId(
    const mip_cc_protection_engine engine,
    char* idBuffer,
    const int64_t idBufferSize,
    int64_t* actualIdSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_GetTemplatesSize(
    const mip_cc_protection_engine engine,
    const void* context,
    int64_t* templatesSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_GetTemplates(
    const mip_cc_protection_engine engine,
    const void* context,
    mip_cc_template_descriptor* templateDescriptors,
    const int64_t templateBufferSize,
    int64_t* actualTemplatesSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_GetRightsForLabelId(
    const mip_cc_protection_engine engine,
    const void* context,
    const char* documentId,
    const char* labelId,
    const char* ownerEmail,
    const char* delegatedUserEmail,
    mip_cc_string_list* rights,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_GetLicenseInfoForLabelId(
    const mip_cc_protection_engine engine,
    const void* context,
    const char* documentId,
    const char* labelId,
    const char* ownerEmail,
    const char* delegatedUserEmail,
    mip_cc_license_info* licenseInfo,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_GetClientDataSize(
    const mip_cc_protection_engine engine,
    int64_t* clientDataSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_GetClientData(
    const mip_cc_protection_engine engine,
    char* clientDataBuffer,
    const int64_t clientDataBufferSize,
    int64_t* actualClientDataSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngine_GetDelegationLicenses(
    const mip_cc_protection_engine engine,
    const mip_cc_delegation_license_settings settings,
    const void* context,
    mip_cc_delegation_licenses* delegationLicenses,
    mip_cc_error* errorInfo);
 
MIP_CC_DEPRECATED_API(mip_cc_result) MIP_CC_CreateProtectionEngineSettingsWithIdentity(
    const mip_cc_identity* identity,
    const char* clientData,
    const char* locale,
    mip_cc_protection_engine_settings* engineSettings,
    mip_cc_error* errorInfo);
 
MIP_CC_DEPRECATED_API(mip_cc_result) MIP_CC_CreateProtectionEngineSettingsWithEngineId(
    const char* engineId,
    const mip_cc_identity* identity,
    const char* clientData,
    const char* locale,
    mip_cc_protection_engine_settings* engineSettings,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_CreateProtectionEngineSettingsWithIdentityAndAuthCallback(
    const mip_cc_identity* identity,
    const mip_cc_auth_callback authCallback,
    const char* clientData,
    const char* locale,
    mip_cc_protection_engine_settings* engineSettings,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_CreateProtectionEngineSettingsWithEngineIdAndAuthCallback(
    const char* engineId,
    const mip_cc_identity* identity,
    const mip_cc_auth_callback authCallback,
    const char* clientData,
    const char* locale,
    mip_cc_protection_engine_settings* engineSettings,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_SetClientData(
    const mip_cc_protection_engine_settings engineSettings,
    const char* clientData,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_SetCustomSettings(
    const mip_cc_protection_engine_settings engineSettings,
    const mip_cc_dictionary customSettings,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_SetSessionId(
    const mip_cc_protection_engine_settings engineSettings,
    const char* sessionId,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_SetCloud(
    const mip_cc_protection_engine_settings engineSettings,
    const mip_cc_cloud cloud,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_SetCloudEndpointBaseUrl(
    const mip_cc_protection_engine_settings engineSettings,
    const char* cloudEndpointBaseUrl,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_SetUnderlyingApplicationId(
    const mip_cc_protection_engine_settings engineSettings,
    const char* underlyingApplicationId,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_SetAllowCloudServiceOnly(
    const mip_cc_protection_engine_settings engineSettings,
    bool allowCloudServiceOnly,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_SetTemplateRefreshArgs(
    const mip_cc_protection_engine_settings engineSettings,
    int templateRefreshIntervalHours,
    int templateBatchingSize,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_AddRmsCapability(
    const mip_cc_protection_engine_settings engineSettings,
    const char* capability,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_RemoveRmsCapability( 
    const mip_cc_protection_engine_settings engineSettings,
    const char* capability,
    bool* removed,
    mip_cc_error* errorInfo);
 
MIP_CC_API(mip_cc_result) MIP_CC_ProtectionEngineSettings_GetRmsCapability(
    const mip_cc_protection_engine_settings engineSettings,
    mip_cc_string_list* capabilities,
    mip_cc_error* errorInfo);
 
MIP_CC_API(void) MIP_CC_ReleaseProtectionEngineSettings(mip_cc_protection_engine_settings engineSettings);
 
#endif // API_MIP_PROTECTION_PROTECTION_ENGINE_CC_H_