common_types.h File Reference

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

#include <cstring>
#include <exception>
#include <map>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
#include "mip/mip_namespace.h"

Include dependency graph for common_types.h:

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

Go to the source code of this file.

Classes
struct	ApplicationInfo
	A struct that includes application specific information. More...
class	AsyncControl
	Class used to cancel async operation. More...
class	AuthDelegate
	Delegate for auth related operations. More...
class	ConsentDelegate
	Delegate for consent related operations. More...
class	Identity
	Abstraction for identity. More...
class	AuthDelegate::OAuth2Challenge
	a class that contains all the information required from the calling application in order to generate an oauth2 token. More...
class	AuthDelegate::OAuth2Token
	A class containing access token info provided by an application. More...
struct	UniqueIdsAndContentFormats

Typedefs
typedef std::map< mip::Classifier, UniqueIdsAndContentFormats >	ClassifierUniqueIdsAndContentFormats
typedef LabelFilterType	FunctionalityFilterType
	Name change within the cpp workspace to imply the filters has greater scope than just label behavior.

Enumerations
enum class	ActionSource : unsigned int {   MANUAL ,   AUTOMATIC ,   RECOMMENDED ,   DEFAULT }
	defines what triggered the SetLabel event More...
enum class	AssignmentMethod : unsigned int {   STANDARD = 0 ,   PRIVILEGED = 1 ,   AUTO = 2 }
	The assignment method of the label on the document. More...
enum class	CacheStorageType : unsigned int {   InMemory = 0 ,   OnDisk = 1 ,   OnDiskEncrypted = 2 }
	Storage type for the caches. More...
enum class	Classifier : unsigned int {   SensitiveInformation = 0 ,   MachineLearning = 1 ,   ExtendedSensitiveInformation = 2 }
	The type of classification the application should be running on the data to determine autolabeling status. More...
enum class	Cloud {   Unknown = 0 ,   Custom = 1 ,   Test = 2 ,   Commercial = 3 ,   Germany = 4 ,   US_DoD = 5 ,   US_GCC = 6 ,   US_GCC_High = 7 ,   US_Sec = 8 ,   US_Nat = 9 ,   China_01 = 10 }
	Azure cloud identifier. More...
enum class	Consent : unsigned int {   AcceptAlways ,   Accept ,   Reject }
	A user's response when consent is requested to connect to a service endpoint. More...
enum class	ContentMarkAlignment : unsigned int {   LEFT = 0 ,   RIGHT = 1 ,   CENTER = 2 }
	Alignment for content marks (content header or content footer). More...
enum class	DataBoundary {   Default = 0 ,   North_America = 1 ,   European_Union = 2 ,   Europe_MiddleEast_Africa = 3 ,   Asia = 4 }
	Diagnostic region identifier. More...
enum class	DataState : unsigned int {   REST ,   MOTION ,   USE }
	Defines what state of the data is the application acting upon. More...
enum class	FeatureId : unsigned int { EncryptOnly }
	Defines new features by name. More...
enum	LabelFilterType : unsigned int {   None = 0 ,   CustomProtection = 1 << 0 ,   TemplateProtection = 1 << 1 ,   DoNotForwardProtection = 1 << 2 ,   AdhocProtection = 1 << 3 ,   HyokProtection = 1 << 4 ,   PredefinedTemplateProtection = 1 << 5 ,   DoubleKeyProtection = 1 << 6 ,   DoubleKeyUserDefinedProtection = 1 << 7 ,   EncryptOnlyProtection = 1 << 8 ,   SensitiveInformationClassifier = 1 << 9 ,   MachineLearningClassifier = 1 << 10 ,   ExtendedSensitiveInformationClassifier = 1 << 11 }
	Label filter types, optional set of properties that can be used to filter labels or label behavior when calling list sensitivity labels or autoclassifying data. More...
enum class	PFileExtensionBehavior {   Default = 0 ,   PFileSuffix = 1 ,   PPrefix = 2 }
	Describes PFile extensions behavior. More...
enum class	VariableTextMarkingType : unsigned int {   Default = 0 ,   PassThrough = 1 ,   None = 2 }
	various dynamic fields can be set into the text message of the application Some known: ${Item.Label} ${Item.Name} ${Item.Location} ${User.Name} ${User.PrincipalName} ${Event.DateTime} Others are still not defined: The sdk will replace them with correct values using these control flags. More...
enum class	WatermarkLayout : unsigned int {   HORIZONTAL = 0 ,   DIAGONAL = 1 }
	Layout for watermarks. More...
enum class	Workload : unsigned int {   Office = 0 ,   Purview = 1 }
	The workload the application is working on, used primary to check for consent. More...

Functions
static std::string	GetActionSourceString (ActionSource actionSource)
	Get the action source name.
std::string	GetAssignmentMethodString (AssignmentMethod method)
	Converts AssignmentMethod enum to a string description.
constexpr const char *	GetCustomSettingExportPolicyFileName ()
	Name of the setting to explicitly specify file path to export SCC policy data to.
constexpr const char *	GetCustomSettingLabelCustomPropertiesSyncEnabled ()
	Name of the setting that allows to enable label by custom properties and custom properties by label features.
constexpr const char *	GetCustomSettingPolicyDataFile ()
	Name of the setting to explicitly specify policy data file path.
constexpr const char *	GetCustomSettingPolicyDataName ()
	Name of the setting to explicitly specify policy data.
constexpr const char *	GetCustomSettingPolicyTtlDays ()
	Name of the setting that enables overriding policy ttl in days be default it will be 30 days.
constexpr const char *	GetCustomSettingSensitivityPolicyTtlDays ()
	Name of the setting that enables overriding sensitivity policy ttl in days be default it will be 30 days.
constexpr const char *	GetCustomSettingSensitivityTypesDataFile ()
	Name of the setting to explicitly specify sensitivity types data file path.
constexpr const char *	GetCustomSettingSensitivityTypesDataName ()
	Name of the setting to explicitly specify sensitivity data.
static std::string	GetDataStateString (DataState state)
	Get the content state name.
const std::string &	GetEmailContentFormat ()
const std::string &	GetFileContentFormat ()
const std::string &	GetMemoryDatabasePath ()
const std::string &	GetSqliteExtension ()
FunctionalityFilterType	operator& (FunctionalityFilterType firstFilter, FunctionalityFilterType secondFilter)
FunctionalityFilterType	operator| (FunctionalityFilterType firstFilter, FunctionalityFilterType secondFilter)
FunctionalityFilterType	operator~ (FunctionalityFilterType filter)

Detailed Description

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

Definition in file common_types.h.

Typedef Documentation

ClassifierUniqueIdsAndContentFormats

typedef std::map<mip::Classifier, UniqueIdsAndContentFormats> ClassifierUniqueIdsAndContentFormats

Definition at line 220 of file common_types.h.

FunctionalityFilterType

typedef LabelFilterType FunctionalityFilterType

Name change within the cpp workspace to imply the filters has greater scope than just label behavior.

Avoided changing name fully to prevent breaking on client operations.

Definition at line 134 of file common_types.h.

Enumeration Type Documentation

ActionSource

enum class ActionSource : unsigned int

strong

defines what triggered the SetLabel event

Enumerator
MANUAL	Selected manually by user.
AUTOMATIC	Set by policy conditions.
RECOMMENDED	Set by user after label was recommended by policy conditions.
DEFAULT	Set by default in policy.

Definition at line 84 of file common_types.h.

                        : unsigned int {
  MANUAL, /**< Selected manually by user */
  AUTOMATIC, /**< Set by policy conditions */
  RECOMMENDED, /**< Set by user after label was recommended by policy conditions */
  DEFAULT /**< Set by default in policy */
};

AssignmentMethod

enum class AssignmentMethod : unsigned int

strong

The assignment method of the label on the document.

Whether the Assignment of the label was done automatically, standard or as a privileged operation (The equivalent to an administrator operation).

Enumerator
STANDARD	Label assignment method is standard.
PRIVILEGED	Label assignment method is privileged.
AUTO	Label assignment method is automatic.

Definition at line 75 of file common_types.h.

                            : unsigned int {
  STANDARD = 0, /**< Label assignment method is standard */
  PRIVILEGED = 1, /**< Label assignment method is privileged */
  AUTO = 2, /**< Label assignment method is automatic */
};

CacheStorageType

enum class CacheStorageType : unsigned int

strong

Storage type for the caches.

Enumerator
InMemory	In Memory storage.
OnDisk	On Disk storage.
OnDiskEncrypted	On Disk storage with internal encryption (if supported by the platform)

Definition at line 706 of file common_types.h.

                            : unsigned int {
  InMemory = 0, /**< In Memory storage */
  OnDisk = 1, /**< On Disk storage */
  OnDiskEncrypted = 2 /**< On Disk storage with internal encryption (if supported by the platform) */
};

Classifier

enum class Classifier : unsigned int

strong

The type of classification the application should be running on the data to determine autolabeling status.

Enumerator
SensitiveInformation
MachineLearning
ExtendedSensitiveInformation

Definition at line 201 of file common_types.h.

                      : unsigned int {
  SensitiveInformation          = 0,  // Classifier based on specific content (credit cards); Uses Microsoft Classification Engine
  MachineLearning               = 1,  // Classifier based on Machine Learning recognition (offensive language)
  ExtendedSensitiveInformation  = 2,  // Classifier based on specific content (credit cards); Does not use Microsoft Classification Engine
};

Cloud

enum class Cloud

strong

Azure cloud identifier.

Enumerator
Unknown	Cloud not specified or URL not recognized as an Azure cloud.
Custom	Custom cloud: endpoint base URL manually specified by application.
Test	Test cloud.
Commercial	Global commercial cloud.
Germany	Germany sovereign cloud.
US_DoD	US sovereign cloud (DoD)
US_GCC	US sovereign cloud (GCC)
US_GCC_High	US sovereign cloud (GCC-High)
US_Sec	US sovereign cloud (Sec)
US_Nat	US sovereign cloud (Nat)
China_01	China sovereign cloud.

Definition at line 724 of file common_types.h.

                 {
  Unknown = 0,                     /**< Cloud not specified or URL not recognized as an Azure cloud */
  Custom = 1,                      /**< Custom cloud: endpoint base URL manually specified by application */
  Test = 2,                        /**< Test cloud */
  Commercial = 3,                  /**< Global commercial cloud */
  Germany = 4,                     /**< Germany sovereign cloud */
  US_DoD = 5,                      /**< US sovereign cloud (DoD) */
  US_GCC = 6,                      /**< US sovereign cloud (GCC) */
  US_GCC_High = 7,                 /**< US sovereign cloud (GCC-High) */
  US_Sec = 8,                      /**< US sovereign cloud (Sec) */
  US_Nat = 9,                      /**< US sovereign cloud (Nat) */
  China_01 = 10,                   /**< China sovereign cloud */
};

Consent

enum class Consent : unsigned int

strong

A user's response when consent is requested to connect to a service endpoint.

Enumerator
AcceptAlways	Consent, and remember this decision.
Accept	Consent, just one time.
Reject	Do not consent.

Definition at line 484 of file common_types.h.

                   : unsigned int {
  AcceptAlways, /**< Consent, and remember this decision */
  Accept,       /**< Consent, just one time */
  Reject        /**< Do not consent */
};

ContentMarkAlignment

enum class ContentMarkAlignment : unsigned int

strong

Alignment for content marks (content header or content footer).

Enumerator
LEFT	Content marking is aligned to the left.
RIGHT	Content marking is aligned to the right.
CENTER	Content marking is centered.

Definition at line 65 of file common_types.h.

                                : unsigned int {
  LEFT = 0, /**< Content marking is aligned to the left */
  RIGHT = 1, /**< Content marking is aligned to the right */
  CENTER = 2, /**< Content marking is centered */
};

DataBoundary

enum class DataBoundary

strong

Diagnostic region identifier.

Enumerator
Default	Region is not specified.
North_America	North America region.
European_Union	European Union region.
Europe_MiddleEast_Africa	Europe, Middle East & Africa region.
Asia	Asia region.

Definition at line 741 of file common_types.h.

                        {
  Default = 0,                     /**< Region is not specified */
  North_America = 1,               /**< North America region */
  European_Union = 2,              /**< European Union region */
  Europe_MiddleEast_Africa = 3,    /**< Europe, Middle East & Africa region */
  Asia = 4,                        /**< Asia region */
};

DataState

enum class DataState : unsigned int

strong

Defines what state of the data is the application acting upon.

Enumerator
REST	Inactive data stored physically in databases/file/warehouses.
MOTION	Data traversing a network or temporarily residing in computer memory to be read or updated.
USE	Active data under constant change stored physically in databases/file/warehouses etc.

Definition at line 94 of file common_types.h.

                     : unsigned int {
  REST, /**< Inactive data stored physically in databases/file/warehouses */
  MOTION, /**< Data traversing a network or temporarily residing in computer memory to be read or updated */
  USE, /**< Active data under constant change stored physically in databases/file/warehouses etc */
};

FeatureId

enum class FeatureId : unsigned int

strong

Defines new features by name.

Enumerator
EncryptOnly	Check if server supports EncryptOnly feature.

Definition at line 151 of file common_types.h.

                     : unsigned int {
  EncryptOnly, /**< Check if server supports EncryptOnly feature */
};

LabelFilterType

enum LabelFilterType : unsigned int

Label filter types, optional set of properties that can be used to filter labels or label behavior when calling list sensitivity labels or autoclassifying data.

Enumerator
None	Disable default labeling filtration.
CustomProtection	Filter labels that may result in custom protection.
TemplateProtection	Filter labels that may result in template protection.
DoNotForwardProtection	Filter labels that may result in do not forward.
AdhocProtection	Filter labels that may result in adhoc protection.
HyokProtection	Filter labels that may result in hyok protection.
PredefinedTemplateProtection	Filter labels that may result in predefined template protection.
DoubleKeyProtection	Filter labels that may result in protection that requires double key, can be template, adhoc, dnf. This filter removes support for all double key labels
DoubleKeyUserDefinedProtection	Filter labels that may result in protection that requires double key adhoc and dnf. This filter removes support for double key adhoc labels. It is more selective than DoubleKeyProtection filter which removes all support
EncryptOnlyProtection	Filter labels that may result in encrypt only.
SensitiveInformationClassifier	Classifier based on Sensitive Information Detection (e.g. Credit card number or SSN) uses the Microsoft Classification Engine (MCE)
MachineLearningClassifier	Classifier based on Machine Learning (e.g. Offensive Language)
ExtendedSensitiveInformationClassifier	Classifier based on Sensitive Information Detection (e.g. Credit card number or SSN) does not use MCE

Definition at line 114 of file common_types.h.

                     : unsigned int {
  None                                    = 0,       /**< Disable default labeling filtration */
  CustomProtection                        = 1 << 0,  /**< Filter labels that may result in custom protection*/
  TemplateProtection                      = 1 << 1,  /**< Filter labels that may result in template protection */
  DoNotForwardProtection                  = 1 << 2,  /**< Filter labels that may result in do not forward */
  AdhocProtection                         = 1 << 3,  /**< Filter labels that may result in adhoc protection */
  HyokProtection                          = 1 << 4,  /**< Filter labels that may result in hyok protection */
  PredefinedTemplateProtection            = 1 << 5,  /**< Filter labels that may result in predefined template protection */
  DoubleKeyProtection                     = 1 << 6,  /**< Filter labels that may result in protection that requires double key, can be template, adhoc, dnf.  This filter removes support for all double key labels*/
  DoubleKeyUserDefinedProtection          = 1 << 7,  /**< Filter labels that may result in protection that requires double key adhoc and dnf.  This filter removes support for double key adhoc labels.  It is more selective than DoubleKeyProtection filter which removes all support*/
  EncryptOnlyProtection                   = 1 << 8,  /**< Filter labels that may result in encrypt only */
  SensitiveInformationClassifier          = 1 << 9,  /**< Classifier based on Sensitive Information Detection (e.g. Credit card number or SSN) uses the Microsoft Classification Engine (MCE) */
  MachineLearningClassifier               = 1 << 10, /**< Classifier based on Machine Learning (e.g. Offensive Language) */
  ExtendedSensitiveInformationClassifier  = 1 << 11, /**< Classifier based on Sensitive Information Detection (e.g. Credit card number or SSN) does not use MCE */
};

PFileExtensionBehavior

enum class PFileExtensionBehavior

strong

Describes PFile extensions behavior.

Enumerator
Default	Extensions will become as SDK default behavior
PFileSuffix	Extensions will become <EXT>.PFILE.
PPrefix	Extensions will become P<EXT>

Definition at line 715 of file common_types.h.

                                  {
  Default = 0,     /**< Extensions will become as SDK default behavior  */
  PFileSuffix = 1, /**< Extensions will become <EXT>.PFILE */
  PPrefix = 2,     /**< Extensions will become P<EXT> */
};

VariableTextMarkingType

enum class VariableTextMarkingType : unsigned int

strong

various dynamic fields can be set into the text message of the application Some known: ${Item.Label} ${Item.Name} ${Item.Location} ${User.Name} ${User.PrincipalName} ${Event.DateTime} Others are still not defined: The sdk will replace them with correct values using these control flags.

Enumerator
Default	Known markings are converted unknown marking are removed.
PassThrough	Known markings are converted unknown marking are passed through.
None	All markings are passed through.

Definition at line 167 of file common_types.h.

                                   : unsigned int {
  Default = 0, /**< Known markings are converted unknown marking are removed */
  PassThrough = 1, /**< Known markings are converted unknown marking are passed through */
  None = 2, /**< All markings are passed through */
};

WatermarkLayout

enum class WatermarkLayout : unsigned int

strong

Layout for watermarks.

Enumerator
HORIZONTAL	Watermark layout is horizontal.
DIAGONAL	Watermark layout is diagonal.

Definition at line 57 of file common_types.h.

                           : unsigned int {
  HORIZONTAL = 0, /**< Watermark layout is horizontal */
  DIAGONAL = 1, /**< Watermark layout is diagonal */
};

Workload

enum class Workload : unsigned int

strong

The workload the application is working on, used primary to check for consent.

Enumerator
Office
Purview

Definition at line 210 of file common_types.h.

                    : unsigned int {
  Office                = 0,  // Office type workloads, which include File and Email content types.
  Purview               = 1,  // Purview type workloads, which includes File, Email and SchematizedData content types.
};

Function Documentation

GetActionSourceString()

static std::string GetActionSourceString ( ActionSource actionSource )

inlinestatic

Get the action source name.

Parameters

actionSource

The action source.

Returns

a string representation of the action source.

Definition at line 239 of file common_types.h.

                                                                         {
  static std::string kMethodArray[] = { "Manual", "Automatic", "Recommended", "Default" };
  return kMethodArray[static_cast<int>(actionSource)];
}

GetAssignmentMethodString()

std::string GetAssignmentMethodString ( AssignmentMethod method )

inline

Converts AssignmentMethod enum to a string description.

Parameters

method

an assignment method.

Returns

a string description of the assignment method.

Definition at line 228 of file common_types.h.

                                                                    {
  static std::string kMethodArray[] = { "Standard", "Privileged", "Auto" };
  return kMethodArray[static_cast<int>(method)];
}

GetCustomSettingExportPolicyFileName()

const char * GetCustomSettingExportPolicyFileName ( )

inlineconstexpr

Name of the setting to explicitly specify file path to export SCC policy data to.

Returns

the custom settings key.

Definition at line 542 of file common_types.h.

                                                                    {
  return "export_policy_file";
}

GetCustomSettingLabelCustomPropertiesSyncEnabled()

const char * GetCustomSettingLabelCustomPropertiesSyncEnabled ( )

inlineconstexpr

Name of the setting that allows to enable label by custom properties and custom properties by label features.

Returns

the custom settings key.

Definition at line 574 of file common_types.h.

                                                                                {
  return "label_custom_properties_sync_enabled";
}

GetCustomSettingPolicyDataFile()

const char * GetCustomSettingPolicyDataFile ( )

inlineconstexpr

Name of the setting to explicitly specify policy data file path.

Returns

the custom settings key.

Definition at line 558 of file common_types.h.

                                                              {
  return "policy_file";
}

GetCustomSettingPolicyDataName()

const char * GetCustomSettingPolicyDataName ( )

inlineconstexpr

Name of the setting to explicitly specify policy data.

Returns

the custom settings key.

Definition at line 534 of file common_types.h.

                                                              {
  return "policy_data";
}

GetCustomSettingPolicyTtlDays()

const char * GetCustomSettingPolicyTtlDays ( )

inlineconstexpr

Name of the setting that enables overriding policy ttl in days be default it will be 30 days.

Values should be set as string integers i < 0 means infinite time to live.

Returns

the custom settings key.

Definition at line 583 of file common_types.h.

                                                             {
  return "PolicyTtlDays";
}

GetCustomSettingSensitivityPolicyTtlDays()

const char * GetCustomSettingSensitivityPolicyTtlDays ( )

inlineconstexpr

Name of the setting that enables overriding sensitivity policy ttl in days be default it will be 30 days.

Values should be set as string integers i < 0 means infinite time to live.

Returns

the custom settings key.

Definition at line 592 of file common_types.h.

                                                                        {
  return "SensitivityPolicyTtlDays";
}

GetCustomSettingSensitivityTypesDataFile()

const char * GetCustomSettingSensitivityTypesDataFile ( )

inlineconstexpr

Name of the setting to explicitly specify sensitivity types data file path.

Returns

the custom settings key.

Definition at line 566 of file common_types.h.

                                                                        {
  return "sensitivity_types_file";
}

GetCustomSettingSensitivityTypesDataName()

const char * GetCustomSettingSensitivityTypesDataName ( )

inlineconstexpr

Name of the setting to explicitly specify sensitivity data.

Returns

the custom settings key.

Definition at line 550 of file common_types.h.

                                                                        {
  return "sensitivity_types_data";
}

GetDataStateString()

static std::string GetDataStateString ( DataState state )

inlinestatic

Get the content state name.

Parameters

actionSource

The state of the content being worked upon.

Returns

a string representation of the content state.

Definition at line 250 of file common_types.h.

                                                            {
  static std::string kMethodArray[] = { "Rest", "Motion", "Use" };
  return kMethodArray[static_cast<int>(state)];
}

GetEmailContentFormat()

const std::string & GetEmailContentFormat ( )

inline

Definition at line 105 of file common_types.h.

                                                {
  static const std::string emailContentFormat = "email";
  return emailContentFormat;
}

GetFileContentFormat()

const std::string & GetFileContentFormat ( )

inline

Definition at line 100 of file common_types.h.

                                               {
  static const std::string fileContentFormat = "file";
  return fileContentFormat;
}

GetMemoryDatabasePath()

const std::string & GetMemoryDatabasePath ( )

inline

Definition at line 262 of file common_types.h.

                                                {
  static const std::string memoryPath = ":memory:";
  return memoryPath;
}

GetSqliteExtension()

const std::string & GetSqliteExtension ( )

inline

Definition at line 256 of file common_types.h.

                                             {
  static const std::string sqliteExtension = ".sqlite3";
  return sqliteExtension;
}

operator&()

FunctionalityFilterType operator& ( FunctionalityFilterType firstFilter, FunctionalityFilterType secondFilter )

inline

Definition at line 140 of file common_types.h.

                                                                                                                    {
  return static_cast<FunctionalityFilterType>(static_cast<int>(firstFilter) & static_cast<int>(secondFilter));
}

operator|()

FunctionalityFilterType operator| ( FunctionalityFilterType firstFilter, FunctionalityFilterType secondFilter )

inline

Definition at line 136 of file common_types.h.

                                                                                                                    {
  return static_cast<FunctionalityFilterType>(static_cast<int>(firstFilter) | static_cast<int>(secondFilter));
}

operator~()

FunctionalityFilterType operator~ ( FunctionalityFilterType filter )

inline

Definition at line 144 of file common_types.h.

                                                                         {
  return static_cast<FunctionalityFilterType>(~(static_cast<int>(filter)));
}