protection_descriptor_cc.h File Reference

Defines C-Style ProtectionDescriptor interface. More...

#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"

Go to the source code of this file.

Classes
struct	mip_cc_user_rights
	A group of users and the rights associated with them. More...
struct	mip_cc_user_roles
	A group of users and the roles associated with them. More...

Typedefs
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

Enumerations
enum	mip_cc_protection_type { MIP_PROTECTION_TYPE_TEMPLATE_BASED = 0 , MIP_PROTECTION_TYPE_CUSTOM = 1 }
	A description of whether protection is defined by a template or ad-hoc. More...

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_CreateProtectionDescriptorFromTemplate(const char *templateId
	Creates a protection descriptor whose access permissions are defined by an RMS template.
	MIP_CC_API (void) MIP_CC_ReleaseProtectionDescriptor(mip_cc_protection_descriptor protectionDescriptor)
	Release resources associated with a protection descriptor.

Variables
const mip_cc_dictionary	signedAppData
const mip_cc_dictionary mip_cc_protection_descriptor *	protectionDescriptor
const mip_cc_dictionary mip_cc_protection_descriptor mip_cc_error *	errorInfo
const int64_t	userRightsCount
const int64_t const char *	name
const int64_t const char const char *	description
const int64_t const char const char const char *	referrer
const int64_t const char const char const char const time_t *	contentValidUntil
const int64_t const char const char const char const time_t const bool	allowOfflineAccess
const int64_t const char const char const char const time_t const bool const mip_cc_dictionary	encryptedAppData
const int64_t	userRolesCount
mip_cc_protection_type *	protectionType
int64_t *	ownerSize
char *	ownerBuffer
char const int64_t	ownerBufferSize
char const int64_t int64_t *	actualOwnerSize
int64_t *	nameSize
char *	nameBuffer
char const int64_t	nameBufferSize
char const int64_t int64_t *	actualNameSize
int64_t *	descriptionSize
char *	descriptionBuffer
char const int64_t	descriptionBufferSize
char const int64_t int64_t *	actualDescriptionSize
mip_cc_guid *	templateId
mip_cc_guid *	labelId
mip_cc_guid *	contentId
bool *	doesContentExpire
bool *	doesAllowOfflineAccess
int64_t *	referrerSize
char *	referrerBuffer
char const int64_t	referrerBufferSize
char const int64_t int64_t *	actualReferrerSize
int64_t *	urlSize
char *	urlBuffer
char const int64_t	urlBufferSize
char const int64_t int64_t *	actualUrlSize
mip_cc_user_rights_result *	userRights
mip_cc_user_roles_result *	userRoles
mip_cc_dynamic_watermark *	dynamicWatermark
const char *	supplementalInfoKey
const char int64_t *	supplementalInfoSize
const char char *	supplementalInfoBuffer
const char char const int64_t	supplementalInfoBufferSize
const char char const int64_t int64_t *	actualsupplementalInfoSize

Detailed Description

Defines C-Style ProtectionDescriptor interface.

Typedef Documentation

mip_cc_protection_descriptor

typedef mip_cc_handle* mip_cc_protection_descriptor

mip_cc_user_rights_result

typedef mip_cc_handle* mip_cc_user_rights_result

mip_cc_user_roles_result

typedef mip_cc_handle* mip_cc_user_roles_result

Enumeration Type Documentation

mip_cc_protection_type

enum mip_cc_protection_type

A description of whether protection is defined by a template or ad-hoc.

Enumerator
MIP_PROTECTION_TYPE_TEMPLATE_BASED	Based on an RMS template
MIP_PROTECTION_TYPE_CUSTOM	Custom, ad-hoc protection

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

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

Gets a value from the supplemental info dictionary.

Gets size of buffer required to store a specific supplemental info value.

Gets the dynamic watermark.

Gets List of users-to-roles mappings.

Gets list of users-to-rights mappings.

Gets double key URL.

Gets size of buffer required to store double key URL.

Gets encrypted application data.

Gets signed application data.

Gets protection referrer.

Gets size of buffer required to store referrer.

Gets whether or not offline access is allowed.

Gets protection expiration time (in seconds since epoch)

Gets whether or not content has an expiration time or not.

Gets content ID.

Gets label ID.

Gets template ID.

Gets protection description.

Gets size of buffer required to store description.

Gets protection name.

Gets size of buffer required to store name.

Gets protection owner.

Gets size of buffer required to store owner.

Gets type of protection, whether it is defined by an RMS template or not.

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

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

Parameters

templateId	Template ID
signedAppData	App-specific data (cleartext) that is signed into the publishing license
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

userRights	Groups of users and their rights
userRightsCount	Number of user/rights groups
name	Protection name
referrer	Referrer address (a URI displayable to a user that provides information on how to gain access)
contentValidUntil	Protection expiration time
allowOfflineAccess	Determines whether a license to consume content can be cached locally
encryptedAppData	App-specific data (cleartext) that is encrypted into the publishing license
signedAppData	App-specific data (cleartext) that is signed into the publishing license
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

userRoles	Groups of users and their roles
userRolesCount	Number of user/roles groups
name	Protection policy name
referrer	Referrer address (a URI displayable to a user that provides information on how to gain access)
contentValidUntil	Protection expiration time
allowOfflineAccess	Determines whether a license to consume content can be cached locally
encryptedAppData	App-specific data (cleartext) that is encrypted into the publishing license
signedAppData	App-specific data (cleartext) that is signed into the publishing license
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

protectionDescriptor	Descriptor associated with protected content
protectionType	[Output] Protection type
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
ownerSize	[Output] Size of buffer to hold owner (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
ownerBuffer	[Output] Buffer the owner will be copied into.
ownerBufferSize	Size (in number of chars) of the ownerBuffer.
actualOwnerSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If ownerBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualOwnerSize will be set to the minimum required buffer size.

Parameters

protectionDescriptor	Descriptor associated with protected content
nameSize	[Output] Size of buffer to hold name (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
nameBuffer	[Output] Buffer the name will be copied into.
nameBufferSize	Size (in number of chars) of the nameBuffer.
actualNameSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If nameBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualNameSize will be set to the minimum required buffer size.

Parameters

protectionDescriptor	Descriptor associated with protected content
descriptionSize	[Output] Size of buffer to hold description (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
descriptionBuffer	[Output] Buffer the description will be copied into.
descriptionBufferSize	Size (in number of chars) of the descriptionBuffer.
actualDescriptionSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If descriptionBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualDescriptionSize will be set to the minimum required buffer size.

Parameters

protectionDescriptor	Descriptor associated with protected content
templateId	[Output] Template ID associated with protection
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
labelId	[Output] Label ID associated with protection
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
contentId	[Output] Content ID associated with protection
errorInfo	[Output] (Optional) Failure info if operation result is error

Note

Publishing licenses will have this identifier surrounded by curly braces "{}". Those braces are removed from the value stored in contentId

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
doesContentExpire	[Output] Whether or not content expires
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	[Output] 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

protectionDescriptor	Descriptor associated with protected content
doesAllowOfflineAccess	[Output] Whether or not offline access is allowed
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
referrerSize	[Output] Size of buffer to hold referrer (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
referrerBuffer	[Output] Buffer the referrer will be copied into.
referrerBufferSize	Size (in number of chars) of the referrerBuffer.
actualReferrerSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If referrerBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualReferrerSize will be set to the minimum required buffer size.

Parameters

protectionDescriptor	Descriptor associated with protected content
signedAppData	[Output] Dictionary of key value pairs that are signed as part of publishing license. It is the caller's responsibility to release this dictionary with MIP_CC_ReleaseDictionary
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
encryptedAppData	[Output] Dictionary of key value pairs that are encrypted as part of publishing license. It is the caller's responsibility to release this dictionary with MIP_CC_ReleaseDictionary
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
url	[Output] Size of buffer to hold double key URL (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
urlBuffer	[Output] Buffer the url will be copied into.
urlBufferSize	Size (in number of chars) of the urlBuffer.
actualUrlSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If urlBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualUrlSize will be set to the minimum required buffer size.

Parameters

protectionDescriptor	Descriptor associated with protected content
userRights	[Output] List of users-to-rights mappings. It is the caller's responsibility to release this list with MIP_CC_ReleaseUserRightsResult
userRightsCount	[Output] Number of user/rights groups
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

The value of the UserRights property will be empty if the current user doesn't have access to this information (that is, if the user does not have the VIEWRIGHTSDATA right or is not the owner of the content).

Parameters

protectionDescriptor	Descriptor associated with protected content
userRoles	[Output] Gets List of users-to-roles mappings. It is the caller's responsibility to release this list with MIP_CC_ReleaseUserRolesResult
userRolesCount	[Output] Number of user/roles groups
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	The protection descriptor from which to retrieve the dynamic watermark
dynamicWatermark	[Output] The retrieved dynamic watermark (null if not present)
errorInfo	[Output] (Optional) Failure info if operation results is failure

Returns

Result code indicating success or failure

Note

The returned 'dynamicWatermark' (mip_cc_dynamic_watermark*) must be freed by calling MIP_CC_ReleaseDynamicWatermark

Parameters

protectionDescriptor	Descriptor associated with protected content
supplementalInfoKey	[Input] The key to the data searched for.
supplementalInfoSize	[Output] Size of buffer to hold the supplemental info value (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

protectionDescriptor	Descriptor associated with protected content
supplementalInfoKey	[Input] The key to the data searched for.
supplementalInfoBuffer	[Output] Buffer the value will be copied into.
supplementalInfoBufferSize	Size (in number of chars) of the supplementalInfoBuffer.
actualsupplementalInfoSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If supplementalInfoBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualsupplementalInfoSize will be set to the minimum required buffer size.

MIP_CC_API() [2/2]

MIP_CC_API

(

void

)

Release resources associated with a protection descriptor.

Parameters

protectionDescriptor

Protection descriptor to be released

Variable Documentation

actualDescriptionSize

char const int64_t int64_t* actualDescriptionSize

actualNameSize

char const int64_t int64_t* actualNameSize

actualOwnerSize

char const int64_t int64_t* actualOwnerSize

actualReferrerSize

char const int64_t int64_t* actualReferrerSize

actualsupplementalInfoSize

const char char const int64_t int64_t* actualsupplementalInfoSize

actualUrlSize

char const int64_t int64_t* actualUrlSize

allowOfflineAccess

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

contentId

mip_cc_guid* contentId

contentValidUntil

int64_t* contentValidUntil

description

const int64_t const char const char* description

descriptionBuffer

char* descriptionBuffer

descriptionBufferSize

char const int64_t descriptionBufferSize

descriptionSize

int64_t* descriptionSize

doesAllowOfflineAccess

bool* doesAllowOfflineAccess

doesContentExpire

bool* doesContentExpire

dynamicWatermark

mip_cc_dynamic_watermark* dynamicWatermark

encryptedAppData

mip_cc_dictionary * encryptedAppData

errorInfo

const char char const int64_t int64_t mip_cc_error* errorInfo

labelId

mip_cc_guid* labelId

name

const int64_t const char* name

nameBuffer

char* nameBuffer

nameBufferSize

char const int64_t nameBufferSize

nameSize

int64_t* nameSize

ownerBuffer

char* ownerBuffer

ownerBufferSize

char const int64_t ownerBufferSize

ownerSize

int64_t* ownerSize

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

protectionType

mip_cc_protection_type* protectionType

referrer

const int64_t const char const char const char * referrer

referrerBuffer

char* referrerBuffer

referrerBufferSize

char const int64_t referrerBufferSize

referrerSize

int64_t* referrerSize

signedAppData

mip_cc_dictionary * signedAppData

supplementalInfoBuffer

const char char* supplementalInfoBuffer

supplementalInfoBufferSize

const char char const int64_t supplementalInfoBufferSize

supplementalInfoKey

const char * supplementalInfoKey

supplementalInfoSize

const char int64_t* supplementalInfoSize

templateId

mip_cc_guid* templateId

urlBuffer

char* urlBuffer

urlBufferSize

char const int64_t urlBufferSize

urlSize

int64_t* urlSize

userRights

mip_cc_user_rights_result* userRights

userRightsCount

mip_cc_user_rights_result int64_t* userRightsCount

userRoles

mip_cc_user_roles_result* userRoles

userRolesCount

mip_cc_user_roles_result int64_t* userRolesCount