PipeSecurity Class

Reference

Definition

Namespace:: System.IO.Pipes

Assembly:: System.IO.Pipes.AccessControl.dll

Assembly:: System.Core.dll

Package:: System.IO.Pipes.AccessControl v5.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the access control and audit security for a pipe.

public ref class PipeSecurity : System::Security::AccessControl::NativeObjectSecurity

public class PipeSecurity : System.Security.AccessControl.NativeObjectSecurity

type PipeSecurity = class
    inherit NativeObjectSecurity

Public Class PipeSecurity
Inherits NativeObjectSecurity

Inheritance: Object

ObjectSecurity

CommonObjectSecurity

NativeObjectSecurity
PipeSecurity

Remarks

The PipeSecurity class specifies the access rights for a pipe and how access attempts are audited. This class represents access and audit rights as a set of rules. Each access rule is represented by a PipeAccessRule object, while each audit rule is represented by a PipeAuditRule object.

The PipeSecurity class is an abstraction of the underlying Microsoft Windows file security system. In this system, each pipe has a discretionary access control list (DACL), which controls access to the pipe, and a system access control list (SACL), which specifies the access control attempts that are audited. The PipeAccessRule and PipeAuditRule classes are abstractions of the access control entries (ACEs) that comprise DACLs and SACLs.

The PipeSecurity class hides many of the details of DACLs and SACLs; you do not have to worry about ACE ordering or null DACLS.

Use the PipeSecurity class to retrieve, add, or change the access rules that represent the DACL and SACL of a pipe.

To persist new or changed access or audit rules to a pipe, use the SetAccessControl method. To retrieve access or audit rules from an existing file, use the GetAccessControl method.

Constructors

PipeSecurity()

Initializes a new instance of the PipeSecurity class.

Properties

AccessRightType	Gets the Type of the securable object that is associated with the current PipeSecurity object.
AccessRulesModified	Gets or sets a Boolean value that specifies whether the access rules associated with this ObjectSecurity object have been modified. (Inherited from ObjectSecurity)
AccessRuleType	Gets the Type of the object that is associated with the access rules of the current PipeSecurity object.
AreAccessRulesCanonical	Gets a Boolean value that specifies whether the access rules associated with this ObjectSecurity object are in canonical order. (Inherited from ObjectSecurity)
AreAccessRulesProtected	Gets a Boolean value that specifies whether the Discretionary Access Control List (DACL) associated with this ObjectSecurity object is protected. (Inherited from ObjectSecurity)
AreAuditRulesCanonical	Gets a Boolean value that specifies whether the audit rules associated with this ObjectSecurity object are in canonical order. (Inherited from ObjectSecurity)
AreAuditRulesProtected	Gets a Boolean value that specifies whether the System Access Control List (SACL) associated with this ObjectSecurity object is protected. (Inherited from ObjectSecurity)
AuditRulesModified	Gets or sets a Boolean value that specifies whether the audit rules associated with this ObjectSecurity object have been modified. (Inherited from ObjectSecurity)
AuditRuleType	Gets the Type object associated with the audit rules of the current PipeSecurity object.
GroupModified	Gets or sets a Boolean value that specifies whether the group associated with the securable object has been modified. (Inherited from ObjectSecurity)
IsContainer	Gets a Boolean value that specifies whether this ObjectSecurity object is a container object. (Inherited from ObjectSecurity)
IsDS	Gets a Boolean value that specifies whether this ObjectSecurity object is a directory object. (Inherited from ObjectSecurity)
OwnerModified	Gets or sets a Boolean value that specifies whether the owner of the securable object has been modified. (Inherited from ObjectSecurity)
SecurityDescriptor	Gets the security descriptor for this instance. (Inherited from ObjectSecurity)

Methods

AccessRuleFactory(IdentityReference, Int32, Boolean, InheritanceFlags, PropagationFlags, AccessControlType)	Initializes a new instance of the AccessRule class with the specified values.
AddAccessRule(AccessRule)	Adds the specified access rule to the Discretionary Access Control List (DACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
AddAccessRule(PipeAccessRule)	Adds an access rule to the Discretionary Access Control List (DACL) that is associated with the current PipeSecurity object.
AddAuditRule(AuditRule)	Adds the specified audit rule to the System Access Control List (SACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
AddAuditRule(PipeAuditRule)	Adds an audit rule to the System Access Control List (SACL) that is associated with the current PipeSecurity object.
AuditRuleFactory(IdentityReference, Int32, Boolean, InheritanceFlags, PropagationFlags, AuditFlags)	Initializes a new instance of the AuditRule class with the specified values.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetAccessRules(Boolean, Boolean, Type)	Gets a collection of the access rules associated with the specified security identifier. (Inherited from CommonObjectSecurity)
GetAuditRules(Boolean, Boolean, Type)	Gets a collection of the audit rules associated with the specified security identifier. (Inherited from CommonObjectSecurity)
GetGroup(Type)	Gets the primary group associated with the specified owner. (Inherited from ObjectSecurity)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetOwner(Type)	Gets the owner associated with the specified primary group. (Inherited from ObjectSecurity)
GetSecurityDescriptorBinaryForm()	Returns an array of byte values that represents the security descriptor information for this ObjectSecurity object. (Inherited from ObjectSecurity)
GetSecurityDescriptorSddlForm(AccessControlSections)	Returns the Security Descriptor Definition Language (SDDL) representation of the specified sections of the security descriptor associated with this ObjectSecurity object. (Inherited from ObjectSecurity)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ModifyAccess(AccessControlModification, AccessRule, Boolean)	Applies the specified modification to the Discretionary Access Control List (DACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
ModifyAccessRule(AccessControlModification, AccessRule, Boolean)	Applies the specified modification to the Discretionary Access Control List (DACL) associated with this ObjectSecurity object. (Inherited from ObjectSecurity)
ModifyAudit(AccessControlModification, AuditRule, Boolean)	Applies the specified modification to the System Access Control List (SACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
ModifyAuditRule(AccessControlModification, AuditRule, Boolean)	Applies the specified modification to the System Access Control List (SACL) associated with this ObjectSecurity object. (Inherited from ObjectSecurity)
Persist(Boolean, String, AccessControlSections)	Saves the specified sections of the security descriptor associated with this ObjectSecurity object to permanent storage. We recommend that the values of the `includeSections` parameters passed to the constructor and persist methods be identical. (Inherited from ObjectSecurity)
Persist(SafeHandle, AccessControlSections, Object)	Saves the specified sections of the security descriptor associated with this NativeObjectSecurity object to permanent storage. We recommend that the values of the `includeSections` parameters passed to the constructor and persist methods be identical. (Inherited from NativeObjectSecurity)
Persist(SafeHandle, AccessControlSections)	Saves the specified sections of the security descriptor associated with this NativeObjectSecurity object to permanent storage. We recommend.persist that the values of the `includeSections` parameters passed to the constructor and persist methods be identical. (Inherited from NativeObjectSecurity)
Persist(SafeHandle)	Saves the specified sections of the security descriptor that is associated with the current PipeSecurity object to permanent storage.
Persist(String, AccessControlSections, Object)	Saves the specified sections of the security descriptor associated with this NativeObjectSecurity object to permanent storage. We recommend that the values of the `includeSections` parameters passed to the constructor and persist methods be identical. (Inherited from NativeObjectSecurity)
Persist(String, AccessControlSections)	Saves the specified sections of the security descriptor associated with this NativeObjectSecurity object to permanent storage. We recommend that the values of the `includeSections` parameters passed to the constructor and persist methods be identical. (Inherited from NativeObjectSecurity)
Persist(String)	Saves the specified sections of the security descriptor that is associated with the current PipeSecurity object to permanent storage.
PurgeAccessRules(IdentityReference)	Removes all access rules associated with the specified IdentityReference. (Inherited from ObjectSecurity)
PurgeAuditRules(IdentityReference)	Removes all audit rules associated with the specified IdentityReference. (Inherited from ObjectSecurity)
ReadLock()	Locks this ObjectSecurity object for read access. (Inherited from ObjectSecurity)
ReadUnlock()	Unlocks this ObjectSecurity object for read access. (Inherited from ObjectSecurity)
RemoveAccessRule(AccessRule)	Removes access rules that contain the same security identifier and access mask as the specified access rule from the Discretionary Access Control List (DACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
RemoveAccessRule(PipeAccessRule)	Removes an access rule from the Discretionary Access Control List (DACL) that is associated with the current PipeSecurity object.
RemoveAccessRuleAll(AccessRule)	Removes all access rules that have the same security identifier as the specified access rule from the Discretionary Access Control List (DACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
RemoveAccessRuleSpecific(AccessRule)	Removes all access rules that exactly match the specified access rule from the Discretionary Access Control List (DACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
RemoveAccessRuleSpecific(PipeAccessRule)	Removes the specified access rule from the Discretionary Access Control List (DACL) that is associated with the current PipeSecurity object.
RemoveAuditRule(AuditRule)	Removes audit rules that contain the same security identifier and access mask as the specified audit rule from the System Access Control List (SACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
RemoveAuditRule(PipeAuditRule)	Removes an audit rule from the System Access Control List (SACL) that is associated with the current PipeSecurity object.
RemoveAuditRuleAll(AuditRule)	Removes all audit rules that have the same security identifier as the specified audit rule from the System Access Control List (SACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
RemoveAuditRuleAll(PipeAuditRule)	Removes all audit rules that have the same security identifier as the specified audit rule from the System Access Control List (SACL) that is associated with the current PipeSecurity object.
RemoveAuditRuleSpecific(AuditRule)	Removes all audit rules that exactly match the specified audit rule from the System Access Control List (SACL) associated with this CommonObjectSecurity object. (Inherited from CommonObjectSecurity)
RemoveAuditRuleSpecific(PipeAuditRule)	Removes the specified audit rule from the System Access Control List (SACL) that is associated with the current PipeSecurity object.
ResetAccessRule(AccessRule)	Removes all access rules in the Discretionary Access Control List (DACL) associated with this CommonObjectSecurity object and then adds the specified access rule. (Inherited from CommonObjectSecurity)
ResetAccessRule(PipeAccessRule)	Removes all access rules in the Discretionary Access Control List (DACL) that is associated with the current PipeSecurity object and then adds the specified access rule.
SetAccessRule(AccessRule)	Removes all access rules that contain the same security identifier and qualifier as the specified access rule in the Discretionary Access Control List (DACL) associated with this CommonObjectSecurity object and then adds the specified access rule. (Inherited from CommonObjectSecurity)
SetAccessRule(PipeAccessRule)	Sets an access rule in the Discretionary Access Control List (DACL) that is associated with the current PipeSecurity object.
SetAccessRuleProtection(Boolean, Boolean)	Sets 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)
SetAuditRule(AuditRule)	Removes all audit rules that contain the same security identifier and qualifier as the specified audit rule in the System Access Control List (SACL) associated with this CommonObjectSecurity object and then adds the specified audit rule. (Inherited from CommonObjectSecurity)
SetAuditRule(PipeAuditRule)	Sets an audit rule in the System Access Control List (SACL) that is associated with the current PipeSecurity object.
SetAuditRuleProtection(Boolean, Boolean)	Sets 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)
SetGroup(IdentityReference)	Sets the primary group for the security descriptor associated with this ObjectSecurity object. (Inherited from ObjectSecurity)
SetOwner(IdentityReference)	Sets the owner for the security descriptor associated with this ObjectSecurity object. (Inherited from ObjectSecurity)
SetSecurityDescriptorBinaryForm(Byte[], AccessControlSections)	Sets the specified sections of the security descriptor for this ObjectSecurity object from the specified array of byte values. (Inherited from ObjectSecurity)
SetSecurityDescriptorBinaryForm(Byte[])	Sets the security descriptor for this ObjectSecurity object from the specified array of byte values. (Inherited from ObjectSecurity)
SetSecurityDescriptorSddlForm(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)
SetSecurityDescriptorSddlForm(String)	Sets the security descriptor for this ObjectSecurity object from the specified Security Descriptor Definition Language (SDDL) string. (Inherited from ObjectSecurity)
ToString()	Returns a string that represents the current object. (Inherited from Object)
WriteLock()	Locks this ObjectSecurity object for write access. (Inherited from ObjectSecurity)
WriteUnlock()	Unlocks this ObjectSecurity object for write access. (Inherited from ObjectSecurity)

Applies to

Del via