EventWaitHandleSecurity Class

Represents the Windows access control security applied to a named system wait handle. This class cannot be inherited.

Namespace:  System.Security.AccessControl
Assembly:  mscorlib (in mscorlib.dll)

public sealed class EventWaitHandleSecurity : NativeObjectSecurity

The EventWaitHandleSecurity type exposes the following members.

  NameDescription
Public methodEventWaitHandleSecurityInitializes a new instance of the EventWaitHandleSecurity class with default values.
Top

  NameDescription
Public propertyAccessRightTypeGets the enumeration type that the EventWaitHandleSecurity class uses to represent access rights. (Overrides ObjectSecurity.AccessRightType.)
Public propertyAccessRuleTypeGets the type that the EventWaitHandleSecurity class uses to represent access rules. (Overrides ObjectSecurity.AccessRuleType.)
Public propertyAreAccessRulesCanonicalGets a Boolean value that specifies whether the access rules associated with this ObjectSecurity object are in canonical order. (Inherited from ObjectSecurity.)
Public propertyAreAccessRulesProtectedGets a Boolean value that specifies whether the Discretionary Access Control List (DACL) associated with this ObjectSecurity object is protected. (Inherited from ObjectSecurity.)
Public propertyAreAuditRulesCanonicalGets a Boolean value that specifies whether the audit rules associated with this ObjectSecurity object are in canonical order. (Inherited from ObjectSecurity.)
Public propertyAreAuditRulesProtectedGets a Boolean value that specifies whether the System Access Control List (SACL) associated with this ObjectSecurity object is protected. (Inherited from ObjectSecurity.)
Public propertyAuditRuleTypeGets the type that the EventWaitHandleSecurity class uses to represent audit rules. (Overrides ObjectSecurity.AuditRuleType.)
Top

  NameDescription
Public methodAccessRuleFactoryCreates a new access control rule for the specified user, with the specified access rights, access control, and flags. (Overrides ObjectSecurity.AccessRuleFactory(IdentityReference, Int32, Boolean, InheritanceFlags, PropagationFlags, AccessControlType).)
Public methodAddAccessRuleSearches for a matching access control rule with which the new rule can be merged. If none are found, adds the new rule.
Public methodAddAuditRuleSearches for an audit rule with which the new rule can be merged. If none are found, adds the new rule.
Public methodAuditRuleFactoryCreates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. (Overrides ObjectSecurity.AuditRuleFactory(IdentityReference, Int32, Boolean, InheritanceFlags, PropagationFlags, AuditFlags).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetAccessRulesGets a collection of the access rules associated with the specified security identifier. (Inherited from CommonObjectSecurity.)
Public methodGetAuditRulesGets a collection of the audit rules associated with the specified security identifier. (Inherited from CommonObjectSecurity.)
Public methodGetGroupGets the primary group associated with the specified owner. (Inherited from ObjectSecurity.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetOwnerGets the owner associated with the specified primary group. (Inherited from ObjectSecurity.)
Public methodGetSecurityDescriptorBinaryFormReturns an array of byte values that represents the security descriptor information for this ObjectSecurity object. (Inherited from ObjectSecurity.)
Public methodGetSecurityDescriptorSddlFormReturns the Security Descriptor Definition Language (SDDL) representation of the specified sections of the security descriptor associated with this ObjectSecurity object. (Inherited from ObjectSecurity.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodModifyAccessRuleApplies the specified modification to the Discretionary Access Control List (DACL) associated with this ObjectSecurity object. (Inherited from ObjectSecurity.)
Public methodModifyAuditRuleApplies the specified modification to the System Access Control List (SACL) associated with this ObjectSecurity object. (Inherited from ObjectSecurity.)
Public methodPurgeAccessRulesRemoves all access rules associated with the specified IdentityReference. (Inherited from ObjectSecurity.)
Public methodPurgeAuditRulesRemoves all audit rules associated with the specified IdentityReference. (Inherited from ObjectSecurity.)
Public methodRemoveAccessRuleSearches for an access control rule with the same user and AccessControlType (allow or deny) as the specified access rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it.
Public methodRemoveAccessRuleAllSearches for all access control rules with the same user and AccessControlType (allow or deny) as the specified rule and, if found, removes them.
Public methodRemoveAccessRuleSpecificSearches for an access control rule that exactly matches the specified rule and, if found, removes it.
Public methodRemoveAuditRuleSearches for an audit rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it.
Public methodRemoveAuditRuleAllSearches for all audit rules with the same user as the specified rule and, if found, removes them.
Public methodRemoveAuditRuleSpecificSearches for an audit rule that exactly matches the specified rule and, if found, removes it.
Public methodResetAccessRuleRemoves all access control rules with the same user as the specified rule, regardless of AccessControlType, and then adds the specified rule.
Public methodSetAccessRuleRemoves all access control rules with the same user and AccessControlType (allow or deny) as the specified rule, and then adds the specified rule.
Public methodSetAccessRuleProtectionSets or removes protection of the access rules associated with this ObjectSecurity object. Protected access rules cannot be modified by parent objects through inheritance. (Inherited from ObjectSecurity.)
Public methodSetAuditRuleRemoves all audit rules with the same user as the specified rule, regardless of the AuditFlags value, and then adds the specified rule.
Public methodSetAuditRuleProtectionSets or removes protection of the audit rules associated with this ObjectSecurity object. Protected audit rules cannot be modified by parent objects through inheritance. (Inherited from ObjectSecurity.)
Public methodSetGroupSets the primary group for the security descriptor associated with this ObjectSecurity object. (Inherited from ObjectSecurity.)
Public methodSetOwnerSets the owner for the security descriptor associated with this ObjectSecurity object. (Inherited from ObjectSecurity.)
Public methodSetSecurityDescriptorBinaryForm(Byte[])Sets the security descriptor for this ObjectSecurity object from the specified array of byte values. (Inherited from ObjectSecurity.)
Public methodSetSecurityDescriptorBinaryForm(Byte[], AccessControlSections)Sets the specified sections of the security descriptor for this ObjectSecurity object from the specified array of byte values. (Inherited from ObjectSecurity.)
Public methodSetSecurityDescriptorSddlForm(String)Sets the security descriptor for this ObjectSecurity object from the specified Security Descriptor Definition Language (SDDL) string. (Inherited from ObjectSecurity.)
Public methodSetSecurityDescriptorSddlForm(String, AccessControlSections)Sets the specified sections of the security descriptor for this ObjectSecurity object from the specified Security Descriptor Definition Language (SDDL) string. (Inherited from ObjectSecurity.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

An EventWaitHandleSecurity object specifies access rights for a named system wait handle, and also specifies the way access attempts are audited. Access rights to the wait handle are expressed as rules, with each access rule represented by an EventWaitHandleAccessRule object. Each auditing rule is represented by an EventWaitHandleAuditRule object.

This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. An EventWaitHandleAccessRule or EventWaitHandleAuditRule object might represent more than one ACE.

NoteNote

An EventWaitHandle object can represent a local wait handle or a named system wait handle. Windows access control security is meaningful only for named system wait handles.

The EventWaitHandleSecurity, EventWaitHandleAccessRule, and EventWaitHandleAuditRule classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors:

  • Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new EventWaitHandleSecurity object always starts with an empty DACL, which denies all access for all users.

  • Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. EventWaitHandleSecurity objects maintain the correct order internally.

  • Manipulating security descriptor flags, which should be under resource manager control only.

  • Creating invalid combinations of ACE flags.

  • Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules.

  • Inserting meaningless ACEs into ACLs.

The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following:

  • Low-level tasks that are normally performed by the resource manager.

  • Adding or removing access control entries in ways that do not maintain the canonical ordering.

To modify Windows access control security for a named wait handle, use the EventWaitHandle.GetAccessControl method to get the EventWaitHandleSecurity object. Modify the security object by adding and removing rules, and then use the EventWaitHandle.SetAccessControl method to reattach it.

Important noteImportant

Changes you make to an EventWaitHandleSecurity object do not affect the access levels of the named wait handle until you call the EventWaitHandle.SetAccessControl method to assign the altered security object to the named wait handle.

To copy access control security from one wait handle to another, use the EventWaitHandle.GetAccessControl method to get an EventWaitHandleSecurity object representing the access and audit rules for the first wait handle, and then use the EventWaitHandle.SetAccessControl method, or a constructor that accepts an EventWaitHandleSecurity object, to assign those rules to the second wait handle.

Users with an investment in the security descriptor definition language (SDDL) can use the SetSecurityDescriptorSddlForm method to set access rules for a named wait handle, and the GetSecurityDescriptorSddlForm method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development.

The following code example demonstrates the separation between Allow rules and Deny rules, and shows the combination of rights in compatible rules. The example creates an EventWaitHandleSecurity object, adds rules that allow and deny various rights for the current user, and displays the resulting pair of rules. The example then allows new rights for the current user and displays the result, showing that the new rights are merged with the existing Allow rule.

NoteNote

This example does not attach the security object to a EventWaitHandle object. Examples that attach security objects can be found in EventWaitHandle.GetAccessControl and EventWaitHandle.SetAccessControl.

using System;
using System.Threading;
using System.Security.AccessControl;
using System.Security.Principal;

public class Example
{
    public static void Main()
    {
        // Create a string representing the current user. 
        string user = Environment.UserDomainName + "\\" + 
            Environment.UserName;

        // Create a security object that grants no access.
        EventWaitHandleSecurity mSec = new EventWaitHandleSecurity();

        // Add a rule that grants the current user the  
        // right to wait on or signal the event.
        EventWaitHandleAccessRule rule = new EventWaitHandleAccessRule(user, 
            EventWaitHandleRights.Synchronize | EventWaitHandleRights.Modify, 
            AccessControlType.Allow);
        mSec.AddAccessRule(rule);

        // Add a rule that denies the current user the  
        // right to change permissions on the event.
        rule = new EventWaitHandleAccessRule(user, 
            EventWaitHandleRights.ChangePermissions, 
            AccessControlType.Deny);
        mSec.AddAccessRule(rule);

        // Display the rules in the security object.
        ShowSecurity(mSec);

        // Add a rule that allows the current user the  
        // right to read permissions on the event. This rule 
        // is merged with the existing Allow rule.
        rule = new EventWaitHandleAccessRule(user, 
            EventWaitHandleRights.ReadPermissions, 
            AccessControlType.Allow);
        mSec.AddAccessRule(rule);

        ShowSecurity(mSec);
    }

    private static void ShowSecurity(EventWaitHandleSecurity security)
    {
        Console.WriteLine("\r\nCurrent access rules:\r\n");

        foreach(EventWaitHandleAccessRule ar in 
            security.GetAccessRules(true, true, typeof(NTAccount)))
        {
            Console.WriteLine("        User: {0}", ar.IdentityReference);
            Console.WriteLine("        Type: {0}", ar.AccessControlType);
            Console.WriteLine("      Rights: {0}", ar.EventWaitHandleRights);
            Console.WriteLine();
        }
    }
}

/*This code example produces output similar to following:

Current access rules:

        User: TestDomain\TestUser
        Type: Deny
      Rights: ChangePermissions

        User: TestDomain\TestUser
        Type: Allow
      Rights: Modify, Synchronize


Current access rules:

        User: TestDomain\TestUser
        Type: Deny
      Rights: ChangePermissions

        User: TestDomain\TestUser
        Type: Allow
      Rights: Modify, ReadPermissions, Synchronize
 */

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft