common_types_cc.h File Reference

A file Containing the common types used by the upe, file and protection modules. More...

#include <stdint.h>
#include "mip_cc/mip_macros_cc.h"

Include dependency graph for common_types_cc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	mip_cc_guid
	GUID. More...
struct	mip_cc_handle
	Opaque handle to MIP object. More...

Enumerations
enum	mip_cc_cache_storage_type {   MIP_CACHE_STORAGE_TYPE_IN_MEMORY = 0 ,   MIP_CACHE_STORAGE_TYPE_ON_DISK = 1 ,   MIP_CACHE_STORAGE_TYPE_ON_DISK_ENCRYPTED = 2 }
	Storage type for caches. More...
enum	mip_cc_cloud {   MIP_CLOUD_UNKNOWN = 0 ,   MIP_CLOUD_CUSTOM = 1 ,   MIP_CLOUD_TEST = 2 ,   MIP_CLOUD_COMMERCIAL = 3 ,   MIP_CLOUD_GERMANY = 4 ,   MIP_CLOUD_US_DOD = 5 ,   MIP_CLOUD_US_GCC = 6 ,   MIP_CLOUD_US_GCC_HIGH = 7 ,   MIP_CLOUD_US_SEC = 8 ,   MIP_CLOUD_US_NAT = 9 ,   MIP_CLOUD_CHINA_01 = 10 }
enum	mip_cc_content_format {   MIP_CONTENT_FORMAT_DEFAULT = 0 ,   MIP_CONTENT_FORMAT_EMAIL = 1 }
	Content format. More...
enum	mip_cc_content_mark_alignment {   MIP_CONTENT_MARK_ALIGNMENT_LEFT = 0 ,   MIP_CONTENT_MARK_ALIGNMENT_RIGHT = 1 ,   MIP_CONTENT_MARK_ALIGNMENT_CENTER = 2 }
	Alignment for content marks (content header or content footer) More...
enum	mip_cc_label_assignment_method {   MIP_LABEL_ASSIGNMENT_METHOD_STANDARD = 0 ,   MIP_LABEL_ASSIGNMENT_METHOD_PRIVILEGED = 1 ,   MIP_LABEL_ASSIGNMENT_METHOD_AUTO = 2 }
	Describes how a new label is being applied. More...
enum	mip_cc_label_filter {   MIP_LABEL_FILTER_NONE = 0 ,   MIP_LABEL_FILTER_CUSTOM_PROTECTION = 1 << 0 ,   MIP_LABEL_FILTER_TEMPLATE_PROTECTION = 1 << 1 ,   MIP_LABEL_FILTER_DO_NOT_FORWARD_PROTECTION = 1 << 2 ,   MIP_LABEL_FILTER_ADHOC_PROTECTION = 1 << 3 ,   MIP_LABEL_FILTER_HYOK_PROTECTION = 1 << 4 ,   MIP_LABEL_FILTER_PREDEFINED_TEMPLATE_PROTECTION = 1 << 5 ,   MIP_LABEL_FILTER_DOUBLE_KEY_PROTECTION = 1 << 6 ,   MIP_LABEL_FILTER_DOUBLE_KEY_USER_DEFINED_PROTECTION = 1 << 7 ,   MIP_LABEL_FILTER_ENCRYPT_ONLY_PROTECTION = 1 << 8 }
enum	mip_cc_metadata_version_format {   MIP_METADATA_VERSION_FORMAT_DEFAULT = 0 ,   MIP_METADATA_VERSION_FORMAT_ONE_LABEL_PER_TENANT = 1 }
enum	mip_cc_watermark_layout {   MIP_WATERMARK_LAYOUT_HORIZONTAL = 0 ,   MIP_WATERMARK_LAYOUT_DIAGONAL = 1 }
	Layout for watermarks. More...
enum	mip_cc_workload {   MIP_WORKLOAD_OFFICE = 0 ,   MIP_WORKLOAD_PURVIEW = 1 }

Detailed Description

A file Containing the common types used by the upe, file and protection modules.

Definition in file common_types_cc.h.

Enumeration Type Documentation

mip_cc_cache_storage_type

enum mip_cc_cache_storage_type

Storage type for caches.

Enumerator
MIP_CACHE_STORAGE_TYPE_IN_MEMORY	In-memory storage.
MIP_CACHE_STORAGE_TYPE_ON_DISK	On-disk storage.
MIP_CACHE_STORAGE_TYPE_ON_DISK_ENCRYPTED	On-disk storage with encryption (if supported by the platform)

Definition at line 59 of file common_types_cc.h.

             {
  MIP_CACHE_STORAGE_TYPE_IN_MEMORY = 0,        /**< In-memory storage */
  MIP_CACHE_STORAGE_TYPE_ON_DISK = 1,          /**< On-disk storage */
  MIP_CACHE_STORAGE_TYPE_ON_DISK_ENCRYPTED = 2 /**< On-disk storage with encryption (if supported by the platform) */
} mip_cc_cache_storage_type;

mip_cc_cloud

enum mip_cc_cloud

Enumerator
MIP_CLOUD_UNKNOWN	Cloud not specified or URL not recognized as an Azure cloud.
MIP_CLOUD_CUSTOM	Custom cloud: endpoint base URL manually specified by application.
MIP_CLOUD_TEST	Test cloud.
MIP_CLOUD_COMMERCIAL	Global commercial cloud.
MIP_CLOUD_GERMANY	Germany sovereign cloud.
MIP_CLOUD_US_DOD	US sovereign cloud (DoD)
MIP_CLOUD_US_GCC	US sovereign cloud (GCC)
MIP_CLOUD_US_GCC_HIGH	US sovereign cloud (GCC-High)
MIP_CLOUD_US_SEC	US sovereign cloud (Sec)
MIP_CLOUD_US_NAT	US sovereign cloud (Nat)
MIP_CLOUD_CHINA_01	China sovereign cloud.

Definition at line 112 of file common_types_cc.h.

             {
  MIP_CLOUD_UNKNOWN     = 0, /**< Cloud not specified or URL not recognized as an Azure cloud */
  MIP_CLOUD_CUSTOM      = 1, /**< Custom cloud: endpoint base URL manually specified by application */
  MIP_CLOUD_TEST        = 2, /**< Test cloud */
  MIP_CLOUD_COMMERCIAL  = 3, /**< Global commercial cloud */
  MIP_CLOUD_GERMANY     = 4, /**< Germany sovereign cloud */
  MIP_CLOUD_US_DOD      = 5, /**< US sovereign cloud (DoD) */
  MIP_CLOUD_US_GCC      = 6, /**< US sovereign cloud (GCC) */
  MIP_CLOUD_US_GCC_HIGH = 7, /**< US sovereign cloud (GCC-High) */
  MIP_CLOUD_US_SEC      = 8, /**< US sovereign cloud (Sec) */
  MIP_CLOUD_US_NAT      = 9, /**< US sovereign cloud (Nat) */
  MIP_CLOUD_CHINA_01    = 10, /**< China sovereign cloud */
} mip_cc_cloud;

mip_cc_content_format

enum mip_cc_content_format

Content format.

Enumerator
MIP_CONTENT_FORMAT_DEFAULT	Standard file format.
MIP_CONTENT_FORMAT_EMAIL	Email.

Definition at line 68 of file common_types_cc.h.

             {
  MIP_CONTENT_FORMAT_DEFAULT = 0, /**< Standard file format */
  MIP_CONTENT_FORMAT_EMAIL = 1,   /**< Email */
} mip_cc_content_format;

mip_cc_content_mark_alignment

enum mip_cc_content_mark_alignment

Alignment for content marks (content header or content footer)

Enumerator
MIP_CONTENT_MARK_ALIGNMENT_LEFT	Content marking is aligned to the left.
MIP_CONTENT_MARK_ALIGNMENT_RIGHT	Content marking is aligned to the right.
MIP_CONTENT_MARK_ALIGNMENT_CENTER	Content marking is centered.

Definition at line 85 of file common_types_cc.h.

             {
  MIP_CONTENT_MARK_ALIGNMENT_LEFT = 0,   /**< Content marking is aligned to the left */
  MIP_CONTENT_MARK_ALIGNMENT_RIGHT = 1,  /**< Content marking is aligned to the right */
  MIP_CONTENT_MARK_ALIGNMENT_CENTER = 2, /**< Content marking is centered */
} mip_cc_content_mark_alignment;

mip_cc_label_assignment_method

enum mip_cc_label_assignment_method

Describes how a new label is being applied.

Enumerator
MIP_LABEL_ASSIGNMENT_METHOD_STANDARD	Standard label assignments will not override a previous privileged assignment.
MIP_LABEL_ASSIGNMENT_METHOD_PRIVILEGED	A privileged label assignment will not be overridden by future standard assignments.
MIP_LABEL_ASSIGNMENT_METHOD_AUTO	Reserved. Do not use.

Definition at line 76 of file common_types_cc.h.

             {
  MIP_LABEL_ASSIGNMENT_METHOD_STANDARD = 0,   /**< Standard label assignments will not override a previous privileged assignment. */
  MIP_LABEL_ASSIGNMENT_METHOD_PRIVILEGED = 1, /**< A privileged label assignment will not be overridden by future standard assignments. */
  MIP_LABEL_ASSIGNMENT_METHOD_AUTO = 2,       /**< Reserved. Do not use. */
} mip_cc_label_assignment_method;

mip_cc_label_filter

enum mip_cc_label_filter

Enumerator
MIP_LABEL_FILTER_NONE	Disable default labeling filtration.
MIP_LABEL_FILTER_CUSTOM_PROTECTION	Filter labels that may result in custom protection.
MIP_LABEL_FILTER_TEMPLATE_PROTECTION	Filter labels that may result in template protection.
MIP_LABEL_FILTER_DO_NOT_FORWARD_PROTECTION	Filter labels that may result in do not forward.
MIP_LABEL_FILTER_ADHOC_PROTECTION	Filter labels that may result in adhoc protection.
MIP_LABEL_FILTER_HYOK_PROTECTION	Filter labels that may result in hyok protection.
MIP_LABEL_FILTER_PREDEFINED_TEMPLATE_PROTECTION	Filter labels that may result in predefined template protection.
MIP_LABEL_FILTER_DOUBLE_KEY_PROTECTION	Filter labels that may result in protection that requires double key template.
MIP_LABEL_FILTER_DOUBLE_KEY_USER_DEFINED_PROTECTION	Filter labels that may result in protection that requires double key adhoc and dnf.
MIP_LABEL_FILTER_ENCRYPT_ONLY_PROTECTION	Filter labels that may result in encrypt only protection.

Definition at line 99 of file common_types_cc.h.

             {
  MIP_LABEL_FILTER_NONE                           = 0,      /**< Disable default labeling filtration */
  MIP_LABEL_FILTER_CUSTOM_PROTECTION              = 1 << 0, /**< Filter labels that may result in custom protection*/
  MIP_LABEL_FILTER_TEMPLATE_PROTECTION            = 1 << 1, /**< Filter labels that may result in template protection */
  MIP_LABEL_FILTER_DO_NOT_FORWARD_PROTECTION      = 1 << 2, /**< Filter labels that may result in do not forward*/
  MIP_LABEL_FILTER_ADHOC_PROTECTION               = 1 << 3, /**< Filter labels that may result in adhoc protection */
  MIP_LABEL_FILTER_HYOK_PROTECTION                = 1 << 4, /**< Filter labels that may result in hyok protection */
  MIP_LABEL_FILTER_PREDEFINED_TEMPLATE_PROTECTION = 1 << 5, /**< Filter labels that may result in predefined template protection */
  MIP_LABEL_FILTER_DOUBLE_KEY_PROTECTION          = 1 << 6, /**< Filter labels that may result in protection that requires double key template*/
  MIP_LABEL_FILTER_DOUBLE_KEY_USER_DEFINED_PROTECTION       = 1 << 7, /**< Filter labels that may result in protection that requires double key adhoc and dnf*/
  MIP_LABEL_FILTER_ENCRYPT_ONLY_PROTECTION        = 1 << 8, /**< Filter labels that may result in encrypt only protection */
} mip_cc_label_filter;

mip_cc_metadata_version_format

enum mip_cc_metadata_version_format

Enumerator
MIP_METADATA_VERSION_FORMAT_DEFAULT	Metadata is ordered based upon label id.
MIP_METADATA_VERSION_FORMAT_ONE_LABEL_PER_TENANT	Metadata is ordered based upon site-id.

Definition at line 126 of file common_types_cc.h.

             {
  MIP_METADATA_VERSION_FORMAT_DEFAULT = 0,                /**< Metadata is ordered based upon label id */
  MIP_METADATA_VERSION_FORMAT_ONE_LABEL_PER_TENANT = 1,   /**< Metadata is ordered based upon site-id */
} mip_cc_metadata_version_format;

mip_cc_watermark_layout

enum mip_cc_watermark_layout

Layout for watermarks.

Enumerator
MIP_WATERMARK_LAYOUT_HORIZONTAL	Watermark layout is horizontal.
MIP_WATERMARK_LAYOUT_DIAGONAL	Watermark layout is diagonal.

Definition at line 94 of file common_types_cc.h.

             {
  MIP_WATERMARK_LAYOUT_HORIZONTAL = 0, /**< Watermark layout is horizontal */
  MIP_WATERMARK_LAYOUT_DIAGONAL = 1,   /**< Watermark layout is diagonal */
} mip_cc_watermark_layout;

mip_cc_workload

enum mip_cc_workload

Enumerator
MIP_WORKLOAD_OFFICE	Disable default labeling filtration.
MIP_WORKLOAD_PURVIEW	Filter labels that may result in custom protection.

Definition at line 131 of file common_types_cc.h.

             {
  MIP_WORKLOAD_OFFICE  = 0, /**< Disable default labeling filtration */
  MIP_WORKLOAD_PURVIEW = 1, /**< Filter labels that may result in custom protection*/
} mip_cc_workload;