Defines C-Style ProtectionDescriptorBuilder interface. More...

#include "mip_cc/protection_descriptor_cc.h"

Include dependency graph for protection_descriptor_builder_cc.h:

Typedefs
typedef mip_cc_handle *	mip_cc_protection_descriptor_builder

Enumerations
enum	mip_cc_protection_license_type { MIP_PROTECTION_LICENSE_TYPE_DO_NOT_FORWARD = 0 , MIP_PROTECTION_LICENSE_TYPE_ENCRYPT_ONLY = 1 }

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_CreateProtectionDescriptorBuilderFromUserRights(const mip_cc_user_rights *userRights
	Creates a protection descriptor whose access permissions are defined by users and rights.

	MIP_CC_API (void) MIP_CC_ReleaseProtectionDescriptorBuilder(mip_cc_protection_descriptor_builder protectionDescriptorBuilder)
	Release resources associated with a protection descriptor builder.

Variables
const char const int64_t const mip_cc_user_rights *	additionalUsersAndRights

const char const int64_t const mip_cc_user_rights const int64_t	additionalUsersAndRightsCount

bool	allowOfflineAccess

const mip_cc_dictionary	appData

int64_t	contentValidUntil

const char *	description

const char *	doubleKeyUrl

const int64_t mip_cc_protection_descriptor_builder mip_cc_error *	errorInfo

const char *	labelId

const char *	name

mip_cc_protection_descriptor *	protectionDescriptor

const int64_t mip_cc_protection_descriptor_builder *	protectionDescriptorBuilder

const int64_t	serializedTemplateSize

const char const char *	tenantId

const char *	uri

const int64_t	userRightsCount

const int64_t	userRolesCount

const char **	usersWithDefaultRights

const char const int64_t	usersWithDefaultRightsCount

Detailed Description

Defines C-Style ProtectionDescriptorBuilder interface.

Definition in file protection_descriptor_builder_cc.h.

Typedef Documentation

◆ mip_cc_protection_descriptor_builder

typedef mip_cc_handle* mip_cc_protection_descriptor_builder

Definition at line 38 of file protection_descriptor_builder_cc.h.

Enumeration Type Documentation

◆ mip_cc_protection_license_type

enum mip_cc_protection_license_type

Enumerator
MIP_PROTECTION_LICENSE_TYPE_DO_NOT_FORWARD	Defines a Do Not Forward License.
MIP_PROTECTION_LICENSE_TYPE_ENCRYPT_ONLY	Defines an Encrypt Only License.

Definition at line 40 of file protection_descriptor_builder_cc.h.

             {
  MIP_PROTECTION_LICENSE_TYPE_DO_NOT_FORWARD = 0, /**< Defines a Do Not Forward License */
  MIP_PROTECTION_LICENSE_TYPE_ENCRYPT_ONLY = 1,   /**< Defines an Encrypt Only License */
} mip_cc_protection_license_type;

Function Documentation

◆ MIP_CC_API() [1/2]

MIP_CC_API ( mip_cc_result ) const

Creates a protection descriptor whose access permissions are defined by users and rights.

Sets the label information for UDP protection.

Sets a double key url for custom protection.

Sets the signed application data for the protection.

Sets the encrypted application data for the protection.

Sets the protection referrer email address.

Sets if protection policy allows offline content access or not.

Sets protection expiration time (in seconds since epoch)

Set the description of the protection.

Set the name of the protection.

Build a protection descriptor from the protection descriptor builder.

Creates a Protection Descriptor Builder whose access permissions are defined by the protection template.

Creates a ProtectionDescriptorBuilder for a license type with the specified users.

Creates a protection descriptor builder based on an existing protection descriptor.

Creates a protection descriptor builder whose access permissions are defined by an RMS template.

Creates a protection descriptor builder whose access permissions are defined by users and roles.

Parameters

userRights	Groups of users and their rights
userRightsCount	Number of user/rights groups
protectionDescriptorBuilder	[Output] Newly-created protection descriptor builder instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

userRoles	Groups of users and their roles
userRolesCount	Number of user/roles groups
protectionDescriptorBuilder	[Output] Newly-created protection descriptor builder instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

templateId	Template ID in GUID format
protectionDescriptorBuilder	[Output] Newly-created protection descriptor builder instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptor	The protection descriptor to base this builder on
protectionDescriptorBuilder	[Output] Newly-created protection descriptor builder instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

licenseType	The license type to create this Protection Descriptor Builder for
usersWithDefaultRights	Collection of users to add to the license with default rights for the specific type
usersWithDefaultRightsCount	Number of users in the usersWithDefaultRights array
additionalUsersAndRights	Optional additional collection of users-to-rights mappings
additionalUsersAndRightsCount	Number of users in the additionalUsersAndRights array
protectionDescriptorBuilder	[Output] Newly-created protection descriptor builder instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

serializedTemplate	Protection template
serializedTemplateSize	Size of the serialized template
protectionDescriptorBuilder	[Output] Newly-created protection descriptor builder instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptorBuilder	Protection descriptor builder
protectionDescriptor	[Output] Newly-created protection descriptor instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptorBuilder	Protection descriptor builder
name	Protection name
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptorBuilder	Protection descriptor builder
description	Protection description
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
contentValidUntil	Content expiration time (in seconds since epoch)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptorBuilder	Protection descriptor builder
allowOfflineAccess	If policy allows offline content access or not
errorInfo	[Output] (Optional) Failure info if operation result is error
protectionDescriptorBuilder	Protection descriptor builder
uri	Address to referrer unauthenticated users to
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptorBuilder	Protection descriptor builder
appData	Application-specific data to encrypt
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptorBuilder	Protection descriptor builder
appData	Application-specific data for unencrypted section
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptorBuilder	Protection descriptor builder
doubleKeyUrl	Double key url
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

protectionDescriptorBuilder	Protection descriptor builder
labelId	Label ID
tenantId	Tenant ID
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

◆ MIP_CC_API() [2/2]

MIP_CC_API ( void )

Release resources associated with a protection descriptor builder.

Parameters

protectionDescriptorBuilder Protection descriptor builder to be released

Variable Documentation

◆ additionalUsersAndRights

const char const int64_t const mip_cc_user_rights* additionalUsersAndRights

Definition at line 122 of file protection_descriptor_builder_cc.h.

◆ additionalUsersAndRightsCount

const char const int64_t const mip_cc_user_rights const int64_t additionalUsersAndRightsCount

Definition at line 123 of file protection_descriptor_builder_cc.h.

◆ allowOfflineAccess

const int64_t const char const char const char const time_t const bool allowOfflineAccess

Definition at line 210 of file protection_descriptor_builder_cc.h.

◆ appData

const mip_cc_dictionary appData

Definition at line 238 of file protection_descriptor_builder_cc.h.

◆ contentValidUntil

int64_t * contentValidUntil

Definition at line 196 of file protection_descriptor_builder_cc.h.

◆ description

const int64_t const char const char * description

Definition at line 182 of file protection_descriptor_builder_cc.h.

◆ doubleKeyUrl

const char* doubleKeyUrl

Definition at line 266 of file protection_descriptor_builder_cc.h.

◆ errorInfo

const char const char mip_cc_error* errorInfo

Definition at line 59 of file protection_descriptor_builder_cc.h.

◆ labelId

const char* labelId

Definition at line 281 of file protection_descriptor_builder_cc.h.

◆ name

const int64_t const char * name

Definition at line 168 of file protection_descriptor_builder_cc.h.

◆ protectionDescriptor

const int64_t const char const char const char const time_t const bool const mip_cc_dictionary const mip_cc_dictionary mip_cc_protection_descriptor * protectionDescriptor

Definition at line 154 of file protection_descriptor_builder_cc.h.