A file containing the FlightingFeature definition. More...

#include <map>
#include "mip/mip_namespace.h"

Include dependency graph for flighting_feature.h:

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

Enumerations
enum	FlightingFeature : unsigned int { ServiceDiscovery = 0 , AuthInfoCache = 1 , LinuxEncryptedCache = 2 , SingleDomainName = 3 , PolicyAuth = 4 , UrlRedirectCache = 5 , PreLicensing = 6 , DoubleKey = 7 , VariablePolicyTtl = 8 , VariableTextMarking = 9 , OptimizePdfMemory = 10 , RemoveDeletedLabelMd = 11 , EnforceMinimumTls12 = 12 , MatchCloudType = 13 , EnableAuditAndTelemetryForSovereignClouds = 14 , EnableActionIdForV0Metadata = 15 , PowerBiCustomSettings = 16 , KeyStoreBasedOnStoragePath = 17 , EventDateTimeTokenUseUtc = 18 , CrossTenantUserCert = 19 , EncryptedDatabaseIntegrityChecking = 20 , EnableFipsValidatedCryptography = 21 , RemoveParentMetadataWhenChildLabelRemoved = 22 , UseCbcForOfficeFileEncryption = 23 , EncryptedAppDataTemplateOnline = 24 , UseMsipcCompatability = 25 , PreLicenseValidityCheck = 26 , DynamicWatermarkingEnabled = 27 , MockDynamicWatermarkingResponseEnabled = 28 , UseRapidJson = 29 , EnforceMinimumTls13 = 30 , IgnoreEmptyMsipLabelNameParseError = 31 , EnableEngineSettingsTelemetry = 32 , EnableMP4Files = 33 , PrioritizeHtmlInMsgs = 34 , EnableExtendedErrors = 35 , LoadCrossTenantUserCertOffline = 36 }
	Defines new features by name. More...

Functions
const std::map< FlightingFeature, bool > &	GetDefaultFeatureSettings ()
	Gets whether or not a feature is enabled by default.

Detailed Description

A file containing the FlightingFeature definition.

Definition in file flighting_feature.h.

Enumeration Type Documentation

◆ FlightingFeature

enum FlightingFeature : unsigned int

Defines new features by name.

Enumerator
ServiceDiscovery	Rely on separate HTTP call to determine RMS service endpoints
AuthInfoCache	Cache OAuth2 challenges per domain/tenant to reduce unnecessary 401 responses. Disable for apps/services that manage their own HTTP auth (like SPO, Edge)
LinuxEncryptedCache	Enable encrypted caching for Linux platforms (Please read the prerequisites for this feature)
SingleDomainName	Enable single company name for dns lookup. e.g. https://corprights
PolicyAuth	Enable automatic HTTP authentication for requests sent to Policy service. Disable for apps/services that manage their own HTTP auth (like SPO, Edge)
UrlRedirectCache	Cache URL redirects to reduce number of HTTP operations
PreLicensing	Enable pre license api check
DoubleKey	Enable double key protection feature to use a customer key to encrypt with
VariablePolicyTtl	Enable variable policy time to live, disabling reverts to infinite policy
VariableTextMarking	Enable variable text marking
OptimizePdfMemory	Enable Optimize PDF Memory Creator in protect and unprotect PDF files
RemoveDeletedLabelMd	Enable removing delete label's meta data
EnforceMinimumTls12	Enforce TLS 1.2 or above for non-ADRMS HTTPS connections
MatchCloudType	Reserved
EnableAuditAndTelemetryForSovereignClouds	Enable telemetry and audit events for sovereign clouds
EnableActionIdForV0Metadata	Write ActionID metadata for content using version 0
PowerBiCustomSettings	Whether or not to add power bi settings to custom settings
KeyStoreBasedOnStoragePath	Whether or not to use storage path in keystore
EventDateTimeTokenUseUtc	Whether to replace ${Event.DateTime} with a UTC timestamp
CrossTenantUserCert	Whether or not to pass up query parameters to /clientlicensorcertificates to support cross tenant scenarios
EncryptedDatabaseIntegrityChecking	Enable database integrity checking
EnableFipsValidatedCryptography	Enable the use of the FIPS-validated Windows CNG APIs instead of OpenSSL on Windows platforms
RemoveParentMetadataWhenChildLabelRemoved	When removing a child label, clear any parent metadata of the removed label that may be present.
UseCbcForOfficeFileEncryption	Office file format uses CBC protection.
EncryptedAppDataTemplateOnline	Enable online publishing for encrypted app data for templates.
UseMsipcCompatability	Modify certain outputs to match MSIPC formatting
PreLicenseValidityCheck	Check prelicense for validity time.
DynamicWatermarkingEnabled	Enable support for dynamic watermarking.
MockDynamicWatermarkingResponseEnabled	Enable support to return a fixed dynamic watermarking format string.
UseRapidJson	Use RapidJson for json parsing.
EnforceMinimumTls13	Enforce TLS 1.3 or above for non-ADRMS HTTPS connections. Do not enable this feature until all internal services support the TLS 1.3 security protocol, as enabling it prematurely may cause application malfunctions.
IgnoreEmptyMsipLabelNameParseError	Ignore empty label name parse error, enabled by default.
EnableEngineSettingsTelemetry	Enable support to Add telemetry status for engine settings.
EnableMP4Files	Enable support for MP4 files.
PrioritizeHtmlInMsgs	Prioritize HTML body over RTF body in msg files.
EnableExtendedErrors	Whether or not parsing extendedErrorInfo is enabled. C++ Default to on, C default to false due to potential memory leaking in error handle of mip_cc_error struct.
LoadCrossTenantUserCertOffline	Whether or not to load cross tenant user cert when doing offline republishing.

Definition at line 45 of file flighting_feature.h.

                      : unsigned int {
  ServiceDiscovery                            = 0,  /**< Rely on separate HTTP call to determine RMS service endpoints */
  AuthInfoCache                               = 1,  /**< Cache OAuth2 challenges per domain/tenant to reduce unnecessary 401 responses. Disable for apps/services that manage their own HTTP auth (like SPO, Edge) */
  LinuxEncryptedCache                         = 2,  /**< Enable encrypted caching for Linux platforms (Please read the prerequisites for this feature) */
  SingleDomainName                            = 3,  /**< Enable single company name for dns lookup. e.g. https://corprights */
  PolicyAuth                                  = 4,  /**< Enable automatic HTTP authentication for requests sent to Policy service. Disable for apps/services that manage their own HTTP auth (like SPO, Edge) */
  UrlRedirectCache                            = 5,  /**< Cache URL redirects to reduce number of HTTP operations */
  PreLicensing                                = 6,  /**< Enable pre license api check */
  DoubleKey                                   = 7,  /**< Enable double key protection feature to use a customer key to encrypt with */
  VariablePolicyTtl                           = 8,  /**< Enable variable policy time to live, disabling reverts to infinite policy*/
  VariableTextMarking                         = 9,  /**< Enable variable text marking*/
  OptimizePdfMemory                           = 10, /**< Enable Optimize PDF Memory Creator in protect and unprotect PDF files */
  RemoveDeletedLabelMd                        = 11, /**< Enable removing delete label's meta data */
  EnforceMinimumTls12                         = 12, /**< Enforce TLS 1.2 or above for non-ADRMS HTTPS connections */
  MatchCloudType                              = 13, /**< Reserved */
  EnableAuditAndTelemetryForSovereignClouds   = 14, /**< Enable telemetry and audit events for sovereign clouds */
  EnableActionIdForV0Metadata                 = 15, /**< Write ActionID metadata for content using version 0 */
  PowerBiCustomSettings                       = 16, /**< Whether or not to add power bi settings to custom settings */
  KeyStoreBasedOnStoragePath                  = 17, /**< Whether or not to use storage path in keystore */
  EventDateTimeTokenUseUtc                    = 18, /**< Whether to replace ${Event.DateTime} with a UTC timestamp */
  CrossTenantUserCert                         = 19, /**< Whether or not to pass up query parameters to /clientlicensorcertificates to support cross tenant scenarios */
  EncryptedDatabaseIntegrityChecking          = 20, /**< Enable database integrity checking */
  EnableFipsValidatedCryptography             = 21, /**< Enable the use of the FIPS-validated Windows CNG APIs instead of OpenSSL on Windows platforms */
  RemoveParentMetadataWhenChildLabelRemoved   = 22, /**< When removing a child label, clear any parent metadata of the removed label that may be present. */
  UseCbcForOfficeFileEncryption               = 23, /**< Office file format uses CBC protection. */
  EncryptedAppDataTemplateOnline              = 24, /**< Enable online publishing for encrypted app data for templates. */
  UseMsipcCompatability                       = 25, /**< Modify certain outputs to match MSIPC formatting */
  PreLicenseValidityCheck                     = 26, /**< Check prelicense for validity time. */
  DynamicWatermarkingEnabled                  = 27, /**< Enable support for dynamic watermarking. */
  MockDynamicWatermarkingResponseEnabled      = 28, /**< Enable support to return a fixed dynamic watermarking format string. */
  UseRapidJson                                = 29, /**< Use RapidJson for json parsing. */
  EnforceMinimumTls13                         = 30, /**< Enforce TLS 1.3 or above for non-ADRMS HTTPS connections. Do not enable this feature until all internal services support the TLS 1.3 security protocol, as enabling it prematurely may cause application malfunctions. */
  IgnoreEmptyMsipLabelNameParseError          = 31, /**< Ignore empty label name parse error, enabled by default. */
  EnableEngineSettingsTelemetry               = 32, /**< Enable support to Add telemetry status for engine settings. */
  EnableMP4Files                              = 33, /**< Enable support for MP4 files. */
  PrioritizeHtmlInMsgs                        = 34, /**< Prioritize HTML body over RTF body in msg files. */
  EnableExtendedErrors                        = 35, /**< Whether or not parsing extendedErrorInfo is enabled. C++ Default to on, C default to false due to potential memory leaking in error handle of mip_cc_error struct. */
  LoadCrossTenantUserCertOffline              = 36, /**< Whether or not to load cross tenant user cert when doing offline republishing. */
};

Function Documentation

◆ GetDefaultFeatureSettings()

const std::map< FlightingFeature, bool > & GetDefaultFeatureSettings ( )

inline

Gets whether or not a feature is enabled by default.

Returns: Default state of flighting features

Definition at line 90 of file flighting_feature.h.

                                                                         {
  static std::map<FlightingFeature, bool> kDefaultFeatureSettings = {
    // Feature name                             Default value
    { FlightingFeature::ServiceDiscovery,                           false },
    { FlightingFeature::AuthInfoCache,                              true  },
    { FlightingFeature::LinuxEncryptedCache,                        false },
    { FlightingFeature::SingleDomainName,                           true  },
    { FlightingFeature::PolicyAuth,                                 true  },
    { FlightingFeature::UrlRedirectCache,                           true  },
    { FlightingFeature::PreLicensing,                               true  },
    { FlightingFeature::DoubleKey,                                  false },
    { FlightingFeature::VariablePolicyTtl,                          true  },
    { FlightingFeature::VariableTextMarking,                        true  },
    { FlightingFeature::OptimizePdfMemory,                          true  },
    { FlightingFeature::RemoveDeletedLabelMd,                       true  },
    { FlightingFeature::EnforceMinimumTls12,                        true  },
    { FlightingFeature::MatchCloudType,                             false },
    { FlightingFeature::EnableAuditAndTelemetryForSovereignClouds,  false },
    { FlightingFeature::EnableActionIdForV0Metadata,                true  },
    { FlightingFeature::PowerBiCustomSettings,                      true  },
    { FlightingFeature::KeyStoreBasedOnStoragePath,                 true  },
    { FlightingFeature::EventDateTimeTokenUseUtc,                   false },
    { FlightingFeature::CrossTenantUserCert,                        true  },
    { FlightingFeature::EncryptedDatabaseIntegrityChecking,         true  },
    { FlightingFeature::EnableFipsValidatedCryptography,            false },
    { FlightingFeature::RemoveParentMetadataWhenChildLabelRemoved,  false },
    { FlightingFeature::UseCbcForOfficeFileEncryption,              true  },
    { FlightingFeature::EncryptedAppDataTemplateOnline,             false },
    { FlightingFeature::UseMsipcCompatability,                      false },
    { FlightingFeature::PreLicenseValidityCheck,                    true  },
    { FlightingFeature::DynamicWatermarkingEnabled,                 false },
    { FlightingFeature::MockDynamicWatermarkingResponseEnabled,     false },
    { FlightingFeature::UseRapidJson,                               false },
    { FlightingFeature::EnforceMinimumTls13,                        false },
    { FlightingFeature::IgnoreEmptyMsipLabelNameParseError,         true  },
    { FlightingFeature::EnableEngineSettingsTelemetry,              true  },
    { FlightingFeature::EnableMP4Files,                             false },
    { FlightingFeature::PrioritizeHtmlInMsgs,                       false },
    { FlightingFeature::EnableExtendedErrors,                       true  },
    { FlightingFeature::LoadCrossTenantUserCertOffline,             true  },
  };
  return kDefaultFeatureSettings;
}

References AuthInfoCache, CrossTenantUserCert, DoubleKey, DynamicWatermarkingEnabled, EnableActionIdForV0Metadata, EnableAuditAndTelemetryForSovereignClouds, EnableEngineSettingsTelemetry, EnableExtendedErrors, EnableFipsValidatedCryptography, EnableMP4Files, EncryptedAppDataTemplateOnline, EncryptedDatabaseIntegrityChecking, EnforceMinimumTls12, EnforceMinimumTls13, EventDateTimeTokenUseUtc, IgnoreEmptyMsipLabelNameParseError, KeyStoreBasedOnStoragePath, LinuxEncryptedCache, LoadCrossTenantUserCertOffline, MatchCloudType, MockDynamicWatermarkingResponseEnabled, OptimizePdfMemory, PolicyAuth, PowerBiCustomSettings, PreLicenseValidityCheck, PreLicensing, PrioritizeHtmlInMsgs, RemoveDeletedLabelMd, RemoveParentMetadataWhenChildLabelRemoved, ServiceDiscovery, SingleDomainName, UrlRedirectCache, UseCbcForOfficeFileEncryption, UseMsipcCompatability, UseRapidJson, VariablePolicyTtl, and VariableTextMarking.

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ FlightingFeature

Function Documentation

◆ GetDefaultFeatureSettings()