Skip to content

Unify SECURITY_ATTRIBUTES code across the codebase #125709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamsitnik merged 8 commits into from
Mar 18, 2026
+38 −82
Merged

Unify SECURITY_ATTRIBUTES code across the codebase #125709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9c1c033
Initial plan
Copilot Mar 18, 2026
51a9274
Unify SECURITY_ATTRIBUTES code from FileSystemAclExtensions and SafeF…
Copilot Mar 18, 2026
a3650af
Address review feedback: use Create(bool) factory, apply to all SECUR…
Copilot Mar 18, 2026
3062a33
Add Create(void* lpSecurityDescriptor) overload, fold lpSecurityDescr…
Copilot Mar 18, 2026
c4e787a
Delete GetSecAttrs helper from MemoryMappedFile.Windows.cs, inline Cr…
Copilot Mar 18, 2026
b74209c
Rename lpSecurityDescriptor param to securityDescriptor; remove unnec…
Copilot Mar 18, 2026
11f93bc
Fix IDE0059: remove unnecessary = default initialization of securityA…
Copilot Mar 18, 2026
0a96772
Apply suggestions from code review
adamsitnik Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion src/libraries/Common/src/Interop/Windows/Kernel32/Interop.SECURITY_ATTRIBUTES.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Runtime.InteropServices;

internal static partial class Interop
Expand All @@ -14,6 +13,26 @@ internal struct SECURITY_ATTRIBUTES
internal uint nLength;
internal unsafe void* lpSecurityDescriptor;
internal BOOL bInheritHandle;

internal static unsafe SECURITY_ATTRIBUTES Create() =>
new SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(SECURITY_ATTRIBUTES)
};

internal static unsafe SECURITY_ATTRIBUTES Create(void* securityDescriptor) =>
new SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(SECURITY_ATTRIBUTES),
lpSecurityDescriptor = securityDescriptor
};

internal static unsafe SECURITY_ATTRIBUTES Create(bool inheritable) =>
new SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(SECURITY_ATTRIBUTES),
bInheritHandle = inheritable ? BOOL.TRUE : BOOL.FALSE
};
}
}
}
6 changes: 1 addition & 5 deletions src/libraries/Common/src/System/IO/FileSystem.DirectoryCreation.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,7 @@ public static unsafe void CreateDirectory(string fullPath, byte[]? securityDescr

fixed (byte* pSecurityDescriptor = securityDescriptor)
{
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = new Interop.Kernel32.SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES),
lpSecurityDescriptor = pSecurityDescriptor
};
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = Interop.Kernel32.SECURITY_ATTRIBUTES.Create(pSecurityDescriptor);

while (stackDir.Count > 0)
{
Expand Down
10 changes: 1 addition & 9 deletions src/libraries/Microsoft.Win32.Registry/src/Microsoft/Win32/RegistryKey.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,19 +215,11 @@ public unsafe RegistryKey CreateSubKey(string subkey, RegistryKeyPermissionCheck
}
}

Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = default;
byte[]? securityDescriptor = registrySecurity?.GetSecurityDescriptorBinaryForm();

fixed (void* pSecurityDescriptor = securityDescriptor)
{
if (pSecurityDescriptor is not null)
{
secAttrs = new()
{
nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES),
lpSecurityDescriptor = pSecurityDescriptor
};
}
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = Interop.Kernel32.SECURITY_ATTRIBUTES.Create(pSecurityDescriptor);

// By default, the new key will be writable.
int ret = Interop.Advapi32.RegCreateKeyEx(_hkey,
Expand Down
6 changes: 1 addition & 5 deletions src/libraries/System.IO.FileSystem.AccessControl/src/System/IO/FileSystemAclExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,11 +269,7 @@ private static unsafe SafeFileHandle CreateFileHandle(string fullPath, FileMode

SafeFileHandle handle;

var secAttrs = new Interop.Kernel32.SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES),
bInheritHandle = ((share & FileShare.Inheritable) != 0) ? Interop.BOOL.TRUE : Interop.BOOL.FALSE,
};
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = Interop.Kernel32.SECURITY_ATTRIBUTES.Create((share & FileShare.Inheritable) != 0);

if (security != null)
{
Expand Down
22 changes: 3 additions & 19 deletions ...s/System.IO.MemoryMappedFiles/src/System/IO/MemoryMappedFiles/MemoryMappedFile.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ private static SafeMemoryMappedFileHandle CreateCore(
{
Debug.Assert(fileHandle is null || fileSize >= 0);

Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = GetSecAttrs(inheritability);
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = Interop.Kernel32.SECURITY_ATTRIBUTES.Create((inheritability & HandleInheritability.Inheritable) != 0);

if (fileHandle != null)
if (fileHandle is not null)
{
VerifyMemoryMappedFileAccess(access, capacity, fileSize);
}
Expand Down Expand Up @@ -107,7 +107,7 @@ private static SafeMemoryMappedFileHandle CreateOrOpenCore(
Debug.Assert(access != MemoryMappedFileAccess.Write, "Callers requesting write access shouldn't try to create a mmf");

SafeMemoryMappedFileHandle? handle = null;
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = GetSecAttrs(inheritability);
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = Interop.Kernel32.SECURITY_ATTRIBUTES.Create((inheritability & HandleInheritability.Inheritable) != 0);

int waitRetries = 14; //((2^13)-1)*10ms == approximately 1.4mins
int waitSleep = 0;
Expand Down Expand Up @@ -249,21 +249,5 @@ private static SafeMemoryMappedFileHandle OpenCore(
}
return handle;
}

/// <summary>
/// Helper method used to extract the native binary security descriptor from the MemoryMappedFileSecurity
/// type. If pinningHandle is not null, caller must free it AFTER the call to CreateFile has returned.
/// </summary>
private static unsafe Interop.Kernel32.SECURITY_ATTRIBUTES GetSecAttrs(HandleInheritability inheritability)
{
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = default(Interop.Kernel32.SECURITY_ATTRIBUTES);
if ((inheritability & HandleInheritability.Inheritable) != 0)
{
secAttrs = default;
secAttrs.nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES);
secAttrs.bInheritHandle = Interop.BOOL.TRUE;
}
return secAttrs;
}
}
}
12 changes: 2 additions & 10 deletions src/libraries/System.IO.Pipes/src/System/IO/Pipes/PipeStream.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,16 +581,8 @@ public virtual PipeTransmissionMode ReadMode
}
}

internal static unsafe Interop.Kernel32.SECURITY_ATTRIBUTES GetSecAttrs(HandleInheritability inheritability)
{
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = new Interop.Kernel32.SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES),
bInheritHandle = ((inheritability & HandleInheritability.Inheritable) != 0) ? Interop.BOOL.TRUE : Interop.BOOL.FALSE
};

return secAttrs;
}
internal static Interop.Kernel32.SECURITY_ATTRIBUTES GetSecAttrs(HandleInheritability inheritability) =>
Interop.Kernel32.SECURITY_ATTRIBUTES.Create((inheritability & HandleInheritability.Inheritable) != 0);

internal static unsafe Interop.Kernel32.SECURITY_ATTRIBUTES GetSecAttrs(HandleInheritability inheritability, PipeSecurity? pipeSecurity, ref GCHandle pinningHandle)
{
Expand Down
10 changes: 1 addition & 9 deletions ...ibraries/System.Private.CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,7 @@ internal static SafeFileHandle Open(string fullPath, FileMode mode, FileAccess a

private static unsafe SafeFileHandle CreateFile(string fullPath, FileMode mode, FileAccess access, FileShare share, FileOptions options)
{
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = default;
if ((share & FileShare.Inheritable) != 0)
{
secAttrs = new Interop.Kernel32.SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES),
bInheritHandle = Interop.BOOL.TRUE
};
}
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = Interop.Kernel32.SECURITY_ATTRIBUTES.Create((share & FileShare.Inheritable) != 0);

int fAccess =
((access & FileAccess.Read) == FileAccess.Read ? Interop.Kernel32.GenericOperations.GENERIC_READ : 0) |
Expand Down
5 changes: 2 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/Threading/EventWaitHandle.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,14 @@ private unsafe void CreateEventCore(
SafeWaitHandle handle;
int errorCode;
Thread.CurrentUserSecurityDescriptorInfo securityDescriptorInfo = default;
Interop.Kernel32.SECURITY_ATTRIBUTES securityAttributes = default;
Interop.Kernel32.SECURITY_ATTRIBUTES securityAttributes;
if (!string.IsNullOrEmpty(name) && options.WasSpecified)
{
name = options.GetNameWithSessionPrefix(name);
if (options.CurrentUserOnly)
{
securityDescriptorInfo = new(CurrentUserOnlyAceRights);
securityAttributes.nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES);
securityAttributes.lpSecurityDescriptor = (void*)securityDescriptorInfo.SecurityDescriptor;
securityAttributes = Interop.Kernel32.SECURITY_ATTRIBUTES.Create((void*)securityDescriptorInfo.SecurityDescriptor);
securityAttributesPtr = &securityAttributes;
}
}
Expand Down
5 changes: 2 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/Threading/Mutex.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,15 @@ private unsafe void CreateMutexCore(
out bool createdNew)
{
Thread.CurrentUserSecurityDescriptorInfo securityDescriptorInfo = default;
Interop.Kernel32.SECURITY_ATTRIBUTES securityAttributes = default;
Interop.Kernel32.SECURITY_ATTRIBUTES securityAttributes;
Interop.Kernel32.SECURITY_ATTRIBUTES* securityAttributesPtr = null;
if (!string.IsNullOrEmpty(name) && options.WasSpecified)
{
name = options.GetNameWithSessionPrefix(name);
if (options.CurrentUserOnly)
{
securityDescriptorInfo = new(CurrentUserOnlyAceRights);
securityAttributes.nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES);
securityAttributes.lpSecurityDescriptor = (void*)securityDescriptorInfo.SecurityDescriptor;
securityAttributes = Interop.Kernel32.SECURITY_ATTRIBUTES.Create((void*)securityDescriptorInfo.SecurityDescriptor);
securityAttributesPtr = &securityAttributes;
}
}
Expand Down
5 changes: 2 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/Threading/Semaphore.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,14 @@ private unsafe void CreateSemaphoreCore(
SafeWaitHandle myHandle;
int errorCode;
Thread.CurrentUserSecurityDescriptorInfo securityDescriptorInfo = default;
Interop.Kernel32.SECURITY_ATTRIBUTES securityAttributes = default;
Interop.Kernel32.SECURITY_ATTRIBUTES securityAttributes;
if (!string.IsNullOrEmpty(name) && options.WasSpecified)
{
name = options.GetNameWithSessionPrefix(name);
if (options.CurrentUserOnly)
{
securityDescriptorInfo = new(CurrentUserOnlyAceRights);
securityAttributes.nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES);
securityAttributes.lpSecurityDescriptor = (void*)securityDescriptorInfo.SecurityDescriptor;
securityAttributes = Interop.Kernel32.SECURITY_ATTRIBUTES.Create((void*)securityDescriptorInfo.SecurityDescriptor);
securityAttributesPtr = &securityAttributes;
}
}
Expand Down
6 changes: 1 addition & 5 deletions src/libraries/System.Threading.AccessControl/src/System/Threading/EventWaitHandleAcl.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,7 @@ public static unsafe EventWaitHandle Create(bool initialState, EventResetMode mo

fixed (byte* pSecurityDescriptor = eventSecurity.GetSecurityDescriptorBinaryForm())
{
var secAttrs = new Interop.Kernel32.SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES),
lpSecurityDescriptor = pSecurityDescriptor
};
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = Interop.Kernel32.SECURITY_ATTRIBUTES.Create(pSecurityDescriptor);

SafeWaitHandle handle = Interop.Kernel32.CreateEventEx(
(IntPtr)(&secAttrs),
Expand Down
6 changes: 1 addition & 5 deletions src/libraries/System.Threading.AccessControl/src/System/Threading/MutexAcl.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,7 @@ public static unsafe Mutex Create(bool initiallyOwned, string? name, out bool cr

fixed (byte* pSecurityDescriptor = mutexSecurity.GetSecurityDescriptorBinaryForm())
{
var secAttrs = new Interop.Kernel32.SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES),
lpSecurityDescriptor = pSecurityDescriptor
};
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = Interop.Kernel32.SECURITY_ATTRIBUTES.Create(pSecurityDescriptor);

SafeWaitHandle handle = Interop.Kernel32.CreateMutexEx(
(IntPtr)(&secAttrs),
Expand Down
6 changes: 1 addition & 5 deletions src/libraries/System.Threading.AccessControl/src/System/Threading/SemaphoreAcl.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,7 @@ public static unsafe Semaphore Create(int initialCount, int maximumCount, string

fixed (byte* pSecurityDescriptor = semaphoreSecurity.GetSecurityDescriptorBinaryForm())
{
var secAttrs = new Interop.Kernel32.SECURITY_ATTRIBUTES
{
nLength = (uint)sizeof(Interop.Kernel32.SECURITY_ATTRIBUTES),
lpSecurityDescriptor = pSecurityDescriptor
};
Interop.Kernel32.SECURITY_ATTRIBUTES secAttrs = Interop.Kernel32.SECURITY_ATTRIBUTES.Create(pSecurityDescriptor);

SafeWaitHandle handle = Interop.Kernel32.CreateSemaphoreEx(
(IntPtr)(&secAttrs),
Expand Down
Loading