MacroSecurityProcessor Class

Class providing general macro security parameters processing.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroSecurityProcessor

Namespace: CMS.MacroEngine
Assembly: CMS.MacroEngine (in CMS.MacroEngine.dll) Version: 12.0.0

Syntax

public static class MacroSecurityProcessor

The MacroSecurityProcessor type exposes the following members.

Fields

	Name	Description
Public field Static member	RegExpComplexMacro	Defines a regular expression that detects a complex macro (in case it is matched)

Methods

	Name	Description
Public method Static member	AddMacroSecurityParams	Adds |(hash) and |(user) security parameters to given expression.
Public method Static member	AddSecurityParameters	Adds security parameters to every macro.
Public method Static member	CheckMacroIntegrity	Checks the integrity against given user.
Public method Static member	CheckSecurity	Checks the security of the accessed object.
Public method Static member	IsSimpleMacro	Returns true if the macro is simple and does not need signing.
Public method Static member	RefreshSecurityParameters(DataSet, MacroIdentityOption)	Recreates all the macros signatures according to new specified salt in all string columns of each row of the given DataSet (modifies the DataSet). Keeps the owners of the macros untouched (verifies the integrity against old salt).
Public method Static member	RefreshSecurityParameters(BaseInfo, MacroIdentityOption, Boolean, String)	Loops through all text columns of given info and signs ALL macros (even already signed) with specified identity option.
Public method Static member	RefreshSecurityParameters(BaseInfo, String, String, Boolean)	Loops through all text columns of given info and recreates all the macros signatures according to new specified salt. Keeps the owners of the macros untouched (verifies the integrity against old salt).
Public method Static member	RemoveMacroSecurityParams(String, MacroIdentityOption)	Removes |(hash) and |(user) or |(identity) security parameters from given expression.
Public method Static member	RemoveMacroSecurityParams(String, MacroIdentityOption, String)	Removes |(hash) and |(user) or |(identity) security parameters from given expression.
Public method Static member	RemoveSecurityParameters(String, Boolean, IDictionary<String, MacroIdentityOption>)	Removes security parameters from all macros.
Public method Static member	RemoveSecurityParameters(String, Boolean, IDictionary<String, MacroIdentityOption>, Boolean)	Removes security parameters from all macros.
Public method Static member	RemoveSecurityParametersAndAnonymize	Marks all macros int the text as anonymous.

Events

	Name	Description
Public event Static member	OnCheckObjectPermissions	Event which is called whenever the security check on object is requested. It's called after the standard check is processed and the result can be overriden with this handler.