Settings used to create a ProtectionHandler to protect new content. More...

#include <src/api/mip/protection/protection_handler.h>

Inheritance diagram for ProtectionHandler::PublishingSettings:

Collaboration diagram for ProtectionHandler::PublishingSettings:

Public Member Functions
std::string	GetApplicationScenarioId () const
	Gets the scenario Id provided by the application which is used to correlation with the server.

const std::vector< std::pair< std::string, std::string > > &	GetCustomSettings () const
	Get the custom settings, used for feature gating and testing.

const std::string &	GetDelegatedUserEmail () const
	Gets the delegated user.

bool	GetIsAuditedExtractionAllowed () const
	Gets whether or not non-MIP-aware applications are allowed to open protected content.

bool	GetIsDeprecatedAlgorithmPreferred () const
	Gets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.

bool	GetIsOfflineOnly () const
	Gets whether or not ProtectionEngine operation allows for online HTTP operations.

std::shared_ptr< PublishingUseLicenseRequest >	GetPreLicenseRequest () const
	Gets the pre-license request.

const std::string &	GetPreLicenseUserEmail () const
	Gets the pre-license user.

std::shared_ptr< ProtectionDescriptor >	GetProtectionDescriptor () const

std::shared_ptr< ProtectionHandler >	GetProtectionHandlerForRepublish () const
	Gets protection handler for republishing scenario.

const std::vector< uint8_t > &	GetPublishingLicenseForRepublish () const
	Gets the serialized republishing license.

bool	GetRegenerateContentKey () const
	Gets whether or not the content key and ID should be regenerated during republishing.

bool	GetRepairLabelIdAllowed () const
	Gets whether or not label id can be added to publishing license on republish.

bool	IsPublishingFormatJson () const
	Gets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).

	PublishingSettings (const std::shared_ptr< ProtectionDescriptor > &protectionDescriptor)
	PublishingSettings constructor for enforcing protection on content.

	PublishingSettings (const std::shared_ptr< ProtectionDescriptor > &protectionDescriptor, const std::shared_ptr< ProtectionHandler > &protectionHandler)
	PublishingSettings constructor for offline republishing.

	PublishingSettings (const std::shared_ptr< ProtectionDescriptor > &protectionDescriptor, const std::vector< uint8_t > &serializedPublishingLicense)
	PublishingSettings constructor for online republishing.

void	SetApplicationScenarioId (std::string applicationScenarioId)
	Sets the scenario Id provided by the application.

void	SetCustomSettings (const std::vector< std::pair< std::string, std::string > > &customSettings)
	Set the custom settings, used for feature gating and testing.

void	SetDelegatedUserEmail (const std::string &delegatedUserEmail)
	Sets the delegated user.

void	SetIsAuditedExtractionAllowed (bool isAuditedExtractionAllowed)
	Sets whether or not non-MIP-aware applications are allowed to open protected content.

void	SetIsDeprecatedAlgorithmPreferred (bool isDeprecatedAlgorithmPreferred)
	Sets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.

virtual void	SetIsOfflineOnly (bool isOfflineOnly)
	Sets whether or not ProtectionEngine operation allows for online HTTP operations.

void	SetPreLicenseUserEmail (const std::string &preLicenseUserEmail)
	Sets pre-license user.

void	SetPublishingFormatJson (bool isPublishingFormatJson)
	Sets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).

void	SetRegenerateContentKey (bool regenerateContentKey)
	Sets whether or not the content key and ID should be regenerated during republishing.

void	SetRepairLabelIdAllowed (bool repairAllowed)
	Sets whether or not label id can be added to publishing license on republish.

void	SetRequestPreLicense (std::shared_ptr< PublishingUseLicenseRequest > publishingUseLicenseRequest)
	Setting this will cause the publishing request to include a pre-license.

Detailed Description

Settings used to create a ProtectionHandler to protect new content.

Definition at line 228 of file protection_handler.h.

Constructor & Destructor Documentation

◆ PublishingSettings() [1/3]

ProtectionHandler::PublishingSettings::PublishingSettings ( const std::shared_ptr< ProtectionDescriptor > & protectionDescriptor )

inline

PublishingSettings constructor for enforcing protection on content.

Parameters

protectionDescriptor Protection details

Definition at line 235 of file protection_handler.h.

        : mProtectionDescriptor(protectionDescriptor),
          mIsAuditedExtractionAllowed(false),
          mIsDeprecatedAlgorithmPreferred(false),
          mIsPublishingFormatJson(false),
          mRepairLabelIdAllowed(false),
          mRegenerateContentKey(false) {}

◆ PublishingSettings() [2/3]

ProtectionHandler::PublishingSettings::PublishingSettings	(	const std::shared_ptr< ProtectionDescriptor > &	protectionDescriptor,
		const std::vector< uint8_t > &	serializedPublishingLicense )

inline

PublishingSettings constructor for online republishing.

Parameters

protectionDescriptor	New protection details
serializedPublishingLicense	Original protection license

Definition at line 249 of file protection_handler.h.

        : mProtectionDescriptor(protectionDescriptor),
          mRepublishingLicense(serializedPublishingLicense),
          mIsAuditedExtractionAllowed(false),
          mIsDeprecatedAlgorithmPreferred(false),
          mIsPublishingFormatJson(false),
          mRepairLabelIdAllowed(false),
          mRegenerateContentKey(false) {}

◆ PublishingSettings() [3/3]

ProtectionHandler::PublishingSettings::PublishingSettings	(	const std::shared_ptr< ProtectionDescriptor > &	protectionDescriptor,
		const std::shared_ptr< ProtectionHandler > &	protectionHandler )

inline

PublishingSettings constructor for offline republishing.

Parameters

protectionDescriptor	New protection details
protectionHandler	Original protection handler

Definition at line 266 of file protection_handler.h.

        : mProtectionDescriptor(protectionDescriptor),
          mProtectionHandler(protectionHandler),
          mIsAuditedExtractionAllowed(false),
          mIsDeprecatedAlgorithmPreferred(false),
          mIsPublishingFormatJson(false),
          mRepairLabelIdAllowed(false),
          mRegenerateContentKey(false) {}

Member Function Documentation

◆ GetApplicationScenarioId()

std::string ProtectionCommonSettings::GetApplicationScenarioId ( ) const

inlineinherited

Gets the scenario Id provided by the application which is used to correlation with the server.

Returns: Application scenario Id

Definition at line 57 of file protection_common_settings.h.

                                             {
    return mApplicationScenarioId;
  }

◆ GetCustomSettings()

const std::vector< std::pair< std::string, std::string > > & ProtectionCommonSettings::GetCustomSettings ( ) const

inlineinherited

Get the custom settings, used for feature gating and testing.

Returns: List of name/value pairs.

Definition at line 108 of file protection_common_settings.h.

                                                                            {
    return mCustomSettings;
  }

◆ GetDelegatedUserEmail()

const std::string & ProtectionHandler::PublishingSettings::GetDelegatedUserEmail ( ) const

inline

Gets the delegated user.

Returns: Delegated user

Note: A delegated user is specified when the authenticating user/application is acting on behalf of another user

Definition at line 332 of file protection_handler.h.

332{ return mDelegatedUserEmail; }

◆ GetIsAuditedExtractionAllowed()

bool ProtectionHandler::PublishingSettings::GetIsAuditedExtractionAllowed ( ) const

inline

Gets whether or not non-MIP-aware applications are allowed to open protected content.

Returns: If non-MIP-aware applications are allowed to open protected content

Definition at line 289 of file protection_handler.h.

289{ return mIsAuditedExtractionAllowed; }

◆ GetIsDeprecatedAlgorithmPreferred()

bool ProtectionHandler::PublishingSettings::GetIsDeprecatedAlgorithmPreferred ( ) const

inline

Gets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.

Returns: If deprecated crypto algorithm is preferred

Definition at line 305 of file protection_handler.h.

305{ return mIsDeprecatedAlgorithmPreferred; }

◆ GetIsOfflineOnly()

bool ProtectionCommonSettings::GetIsOfflineOnly ( ) const

inlineinherited

Gets whether or not ProtectionEngine operation allows for online HTTP operations.

Returns: True if HTTP operations are disallowed, else false

Note: If this returns true, operation will only succeed if necessary content has already been cached. A mip::NetworkError will be thrown if needed info is not found. Consumption - content has already been previously decrypted and its unexpired license is cached. Protection - unexpired templates have been cached and user cert is loaded Others - undefined

Definition at line 79 of file protection_common_settings.h.

79{ return mIsOfflineOnly; }

◆ GetPreLicenseRequest()

std::shared_ptr< PublishingUseLicenseRequest > ProtectionHandler::PublishingSettings::GetPreLicenseRequest ( ) const

inline

Gets the pre-license request.

Returns: Pre-license request

Definition at line 421 of file protection_handler.h.

                                                                            {
      return mPublishingUseLicenseRequest;
    }

◆ GetPreLicenseUserEmail()

const std::string & ProtectionHandler::PublishingSettings::GetPreLicenseUserEmail ( ) const

inline

Gets the pre-license user.

Returns: Pre-license user

Definition at line 392 of file protection_handler.h.

                                                    {
      static std::string empty;
      return mPublishingUseLicenseRequest != nullptr ? mPublishingUseLicenseRequest->GetDelegatedUserEmail() : empty; }

◆ GetProtectionDescriptor()

std::shared_ptr< ProtectionDescriptor > ProtectionHandler::PublishingSettings::GetProtectionDescriptor ( ) const

inline

Definition at line 277 of file protection_handler.h.

277{ return mProtectionDescriptor; }

◆ GetProtectionHandlerForRepublish()

std::shared_ptr< ProtectionHandler > ProtectionHandler::PublishingSettings::GetProtectionHandlerForRepublish ( ) const

inline

Gets protection handler for republishing scenario.

Definition at line 282 of file protection_handler.h.

282{ return mProtectionHandler; }

◆ GetPublishingLicenseForRepublish()

const std::vector< uint8_t > & ProtectionHandler::PublishingSettings::GetPublishingLicenseForRepublish ( ) const

inline

Gets the serialized republishing license.

Returns: The serialized republishing license

Definition at line 401 of file protection_handler.h.

                                                                       {
      return mRepublishingLicense;
    }

◆ GetRegenerateContentKey()

bool ProtectionHandler::PublishingSettings::GetRegenerateContentKey ( ) const

inline

Gets whether or not the content key and ID should be regenerated during republishing.

Returns: True if the content key and ID should be regenerated. False otherwise.

Definition at line 356 of file protection_handler.h.

356{ return mRegenerateContentKey; }

◆ GetRepairLabelIdAllowed()

bool ProtectionHandler::PublishingSettings::GetRepairLabelIdAllowed ( ) const

inline

Gets whether or not label id can be added to publishing license on republish.

Returns: True if label info data in protection descriptor can be added to publishing license

Note: This will only take effect if offline protection is used for republishing.

Definition at line 432 of file protection_handler.h.

432{ return mRepairLabelIdAllowed; }

◆ IsPublishingFormatJson()

bool ProtectionHandler::PublishingSettings::IsPublishingFormatJson ( ) const

inline

Gets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).

Returns: true if is set to json format output.

Definition at line 340 of file protection_handler.h.

340{ return mIsPublishingFormatJson; }

◆ SetApplicationScenarioId()

void ProtectionCommonSettings::SetApplicationScenarioId ( std::string applicationScenarioId )

inlineinherited

Sets the scenario Id provided by the application.

Parameters

The	application scenario Id

Definition at line 66 of file protection_common_settings.h.

66{ mApplicationScenarioId = applicationScenarioId; }

◆ SetCustomSettings()

void ProtectionCommonSettings::SetCustomSettings ( const std::vector< std::pair< std::string, std::string > > & customSettings )

inlineinherited

Set the custom settings, used for feature gating and testing.

Parameters

customSettings List of name/value pairs.

Definition at line 99 of file protection_common_settings.h.

                                                                                         {
    mCustomSettings = customSettings;
  }

◆ SetDelegatedUserEmail()

void ProtectionHandler::PublishingSettings::SetDelegatedUserEmail ( const std::string & delegatedUserEmail )

inline

Sets the delegated user.

Parameters

delegatedUserEmail the delegation email.

Note: A delegated user is specified when the authenticating user/application is acting on behalf of another user

Definition at line 323 of file protection_handler.h.

323{ mDelegatedUserEmail = delegatedUserEmail; }

◆ SetIsAuditedExtractionAllowed()

void ProtectionHandler::PublishingSettings::SetIsAuditedExtractionAllowed ( bool isAuditedExtractionAllowed )

inline

Sets whether or not non-MIP-aware applications are allowed to open protected content.

Parameters

isAuditedExtractionAllowed If non-MIP-aware applications are allowed to open protected content

Definition at line 296 of file protection_handler.h.

                                                                        {
      mIsAuditedExtractionAllowed = isAuditedExtractionAllowed;
    }

◆ SetIsDeprecatedAlgorithmPreferred()

void ProtectionHandler::PublishingSettings::SetIsDeprecatedAlgorithmPreferred ( bool isDeprecatedAlgorithmPreferred )

inline

Sets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.

Parameters

isDeprecatedAlgorithmPreferred if deprectated crypto algorithm is preferred

Definition at line 312 of file protection_handler.h.

                                                                                {
      mIsDeprecatedAlgorithmPreferred = isDeprecatedAlgorithmPreferred;
    }

◆ SetIsOfflineOnly()

virtual void ProtectionCommonSettings::SetIsOfflineOnly ( bool isOfflineOnly )

inlinevirtualinherited

Sets whether or not ProtectionEngine operation allows for online HTTP operations.

Parameters

isOfflineOnly True if HTTP operations are disallowed, else false

Note: If this is set to true, operation will only succeed if necessary content has already been cached. A mip::NetworkError will be thrown if needed info is not found. Consumption - content has already been previously decrypted and its unexpired license is cached. Protection - unexpired templates have been cached and user cert is loaded Others - undefined

Definition at line 92 of file protection_common_settings.h.

92{ mIsOfflineOnly = isOfflineOnly; }

◆ SetPreLicenseUserEmail()

void ProtectionHandler::PublishingSettings::SetPreLicenseUserEmail ( const std::string & preLicenseUserEmail )

inline

Sets pre-license user.

Parameters

preLicenseUserEmail Pre-license user

Note: If no pre-license user is specified, a pre-license will not be obtained

Definition at line 377 of file protection_handler.h.

                                                                      {
      if(mPublishingUseLicenseRequest == nullptr) {
        mPublishingUseLicenseRequest = PublishingUseLicenseRequest::CreatePublishingUseLicenseRequest();
      }
      mPublishingUseLicenseRequest->SetDelegatedUserEmail(preLicenseUserEmail);
    }

References PublishingUseLicenseRequest::CreatePublishingUseLicenseRequest().

◆ SetPublishingFormatJson()

void ProtectionHandler::PublishingSettings::SetPublishingFormatJson ( bool isPublishingFormatJson )

inline

Sets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).

Parameters

isPublishingFormatJson if json format is enabled.

Definition at line 347 of file protection_handler.h.

                                                              {
      mIsPublishingFormatJson = isPublishingFormatJson;
    }

◆ SetRegenerateContentKey()

void ProtectionHandler::PublishingSettings::SetRegenerateContentKey ( bool regenerateContentKey )

inline

Sets whether or not the content key and ID should be regenerated during republishing.

Parameters

regenerateContentKey If the content key and ID should be regenerated.

Definition at line 363 of file protection_handler.h.

                                                            {
      mRegenerateContentKey = regenerateContentKey;
    }

◆ SetRepairLabelIdAllowed()

void ProtectionHandler::PublishingSettings::SetRepairLabelIdAllowed ( bool repairAllowed )

inline

Sets whether or not label id can be added to publishing license on republish.

Parameters

repairAllowed if label info data in protection descriptor can be added to publishing license

Note: This will only take effect if offline protection is used for republishing. Should only be used to add a label to adhoc protection that is missing it.

Definition at line 442 of file protection_handler.h.

                                                     {
      mRepairLabelIdAllowed = repairAllowed;
    }

◆ SetRequestPreLicense()

void ProtectionHandler::PublishingSettings::SetRequestPreLicense ( std::shared_ptr< PublishingUseLicenseRequest > publishingUseLicenseRequest )

inline

Setting this will cause the publishing request to include a pre-license.

Parameters

publishingUseLicenseRequest The pre-license request

Note: If no pre-license request is specified, a pre-license will not be obtained

Definition at line 412 of file protection_handler.h.

                                                                                                      {
      mPublishingUseLicenseRequest = publishingUseLicenseRequest;
    }

The documentation for this class was generated from the following file:

src/api/mip/protection/protection_handler.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PublishingSettings() [1/3]

◆ PublishingSettings() [2/3]

◆ PublishingSettings() [3/3]

Member Function Documentation

◆ GetApplicationScenarioId()

◆ GetCustomSettings()

◆ GetDelegatedUserEmail()

◆ GetIsAuditedExtractionAllowed()

◆ GetIsDeprecatedAlgorithmPreferred()

◆ GetIsOfflineOnly()

◆ GetPreLicenseRequest()

◆ GetPreLicenseUserEmail()

◆ GetProtectionDescriptor()

◆ GetProtectionHandlerForRepublish()

◆ GetPublishingLicenseForRepublish()

◆ GetRegenerateContentKey()

◆ GetRepairLabelIdAllowed()

◆ IsPublishingFormatJson()

◆ SetApplicationScenarioId()

◆ SetCustomSettings()

◆ SetDelegatedUserEmail()

◆ SetIsAuditedExtractionAllowed()

◆ SetIsDeprecatedAlgorithmPreferred()

◆ SetIsOfflineOnly()

◆ SetPreLicenseUserEmail()

◆ SetPublishingFormatJson()

◆ SetRegenerateContentKey()

◆ SetRepairLabelIdAllowed()

◆ SetRequestPreLicense()