API Proposal: Add pipe creation extension methods that take an ACL

[JeremyKuhne]

Summary

Similar to #31095, we don't currently have a way to create a pipe with a given ACL in .NET Core. We can modify the ACL, but it would be more secure to have the proper ACL on the pipe from the start.

The Pipe ACL PipeSecurity is already exposed in the System.IO.Pipes assembly , we should add creation extension methods to the existing PipesAclExtensions.

Proposal

Add the following two creation methods to the existing PipesAclExtensions class in the System.IO.Pipes assembly:

namespace System.IO.Pipes
{
    public static class PipesAclExtensions
    {
        // Add
        public AnonymousPipeServerStream CreateAnonymousPipeServerStream(
            this PipeSecurity pipeSecurity
            PipeDirection direction,
            HandleInheritability inheritability,
            int bufferSize);

        public NamedPipeServerStream CreateNamedPipeServerStream(
            this PipeSecurity pipeSecurity
            string pipeName,
            PipeDirection direction,
            int maxNumberOfServerInstances,
            PipeTransmissionMode transmissionMode,
            PipeOptions options,
            int inBufferSize,
            int outBufferSize,
            HandleInheritability inheritability = HandleInheritability.None,
            PipeAccessRights additionalAccessRights = default);

        // Existing
        public static PipeSecurity GetAccessControl(this PipeStream stream);
        public static void SetAccessControl(this PipeStream stream, PipeSecurity pipeSecurity);
    }
}

Details

Since these are already in the same assembly as the modified types it should be pretty straight-forward to implement.

Related Issues

#31095 API Proposal: Add file and directory creation methods that take an ACL

CC: @danmosemsft, @ericstj, @terrajobst

[terrajobst]

Video

We should not make them extension methods. We should follow the other pattern and create new static types suffixed with Acl:

namespace System.IO.Pipes
{
    public static class AnonymousPipeServerStreamAcl
    {
        public static AnonymousPipeServerStream Create(
            PipeDirection direction,
            HandleInheritability inheritability,
            int bufferSize,
            PipeSecurity pipeSecurity);
    }

    public static class NamedPipeServerStreamAcl
    {
        public static NamedPipeServerStream Create(
            string pipeName,
            PipeDirection direction,
            int maxNumberOfServerInstances,
            PipeTransmissionMode transmissionMode,
            PipeOptions options,
            int inBufferSize,
            int outBufferSize,
            PipeSecurity pipeSecurity,
            HandleInheritability inheritability = HandleInheritability.None,
            PipeAccessRights additionalAccessRights = default);
    }
}

[TonyValenti]

Definitely excited to see the work on this. Really looking forward to it being completed!

[carlossanlop]

Fixed with #317

[TonyValenti]

I'm super excited the work on this has been complete! Do you have an ETA on a release date?

[carlossanlop]

@TonyValenti it's targeted for 5.0. You can always consume a nightly build or a preview to test these new APIs.

[watfordgnf]

I don't see this for Anonymous pipes, was that intentional?