H.Pipes.AccessControl 2.0.59

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package H.Pipes.AccessControl --version 2.0.59                
NuGet\Install-Package H.Pipes.AccessControl -Version 2.0.59                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="H.Pipes.AccessControl" Version="2.0.59" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add H.Pipes.AccessControl --version 2.0.59                
#r "nuget: H.Pipes.AccessControl, 2.0.59"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install H.Pipes.AccessControl as a Cake Addin
#addin nuget:?package=H.Pipes.AccessControl&version=2.0.59

// Install H.Pipes.AccessControl as a Cake Tool
#tool nuget:?package=H.Pipes.AccessControl&version=2.0.59                

Async Named Pipe Wrapper for .NET Standard 2.0

Language License Requirements Build Status

A simple, easy to use, strongly-typed, async wrapper around .NET named pipes.

Features

  • Create named pipe servers that can handle multiple client connections simultaneously.
  • Send strongly-typed messages between clients and servers: any serializable .NET object can be sent over a pipe and will be automatically serialized/deserialized, including cyclical references and complex object graphs.
  • Async
  • Requires .NET Standard 2.0
  • Supports large messages - up to 300 MiB.
  • Server restart automatically
  • Automatically wait for the release of the pipe for the server, if it is already in use
  • Automatically waiting for a server pipe creating when client connecting
  • Automatic reconnect with a given interval and at each client.WriteAsync, if necessary
  • Supports variable formatters, default - BinaryFormatter which uses System.Runtime.Serialization.BinaryFormatter inside
  • Also available ready formatters in separate nuget packages: H.Formatters.Newtonsoft.Json, H.Formatters.System.Text.Json and H.Formatters.Ceras
  • Supports PipeAccessRule's(see H.Pipes.AccessControl nuget package) or more complex code to access using the PipeServer.PipeStreamInitializeAction property

Nuget

NuGet NuGet NuGet NuGet NuGet

// All clients and servers that do not need support AccessControl.
Install-Package H.Pipes

// Servers that need support AccessControl.
Install-Package H.Pipes.AccessControl

// If you want to transfer any data that can be serialized/deserialized in json using Newtonsoft.Json.
Install-Package H.Formatters.Newtonsoft.Json

// If you want to transfer any data that can be serialized/deserialized in json using System.Text.Json.
Install-Package H.Formatters.System.Text.Json

// If you want to transfer any data that can be serialized/deserialized in binary using Ceras.
Install-Package H.Formatters.Ceras

Usage

Server:

await using var server = new PipeServer<MyMessage>(pipeName);
server.ClientConnected += async (o, args) =>
{
    Console.WriteLine($"Client {args.Connection.PipeName} is now connected!");

    await args.Connection.WriteAsync(new MyMessage
    {
        Text = "Welcome!"
    });
};
server.ClientDisconnected += (o, args) =>
{
    Console.WriteLine($"Client {args.Connection.PipeName} disconnected");
};
server.MessageReceived += (sender, args) =>
{
    Console.WriteLine($"Client {args.Connection.PipeName} says: {args.Message}");
};
server.ExceptionOccurred += (o, args) => OnExceptionOccurred(args.Exception);

await server.StartAsync();

await Task.Delay(Timeout.InfiniteTimeSpan);

Client:

await using var client = new PipeClient<MyMessage>(pipeName);
client.MessageReceived += (o, args) => Console.WriteLine("MessageReceived: " + args.Message);
client.Disconnected += (o, args) => Console.WriteLine("Disconnected from server");
client.Connected += (o, args) => Console.WriteLine("Connected to server");
client.ExceptionOccurred += (o, args) => OnExceptionOccurred(args.Exception);

await client.ConnectAsync();

await client.WriteAsync(new MyMessage
{
    Text = "Hello!",
});

await Task.Delay(Timeout.InfiniteTimeSpan);

Notes:

  • To use the server inside the WinForms/WPF/Other UI application, use Task.Run() or any alternative.
  • Be careful and call Dispose before closing the program/after the end of use. Pipes are system resources and you might have problems restarting the server if you don't properly clean up the resources.

Custom Formatters

Since BinaryFormatter is used by default, you should check out this article: https://docs.microsoft.com/en-us/dotnet/standard/serialization/binaryformatter-security-guide

Install-Package H.Formatters.Newtonsoft.Json
Install-Package H.Formatters.System.Text.Json
Install-Package H.Formatters.Ceras
using H.Formatters;

await using var server = new PipeServer<MyMessage>(pipeName, formatter: new NewtonsoftJsonFormatter());
await using var client = new PipeClient<MyMessage>(pipeName, formatter: new NewtonsoftJsonFormatter());

Access Control

⚠️ Note: this is only available for the Windows platform

Install-Package H.Pipes.AccessControl
using System.IO.Pipes;
using H.Pipes.AccessControl;

await using var server = new PipeServer<string>(pipeName);

// You can set PipeSecurity
var pipeSecurity = new PipeSecurity();
pipeSecurity.AddAccessRule(new PipeAccessRule(new SecurityIdentifier(WellKnownSidType.BuiltinUsersSid, null), PipeAccessRights.ReadWrite, AccessControlType.Allow));

server.SetPipeSecurity(pipeSecurity);

// or just add AccessRule's (Please be careful, the server will only consider AccessRules from the last call AddAccessRules())
server.AddAccessRules(new PipeAccessRule(new SecurityIdentifier(WellKnownSidType.BuiltinUsersSid, null), PipeAccessRights.ReadWrite, AccessControlType.Allow));

// or just
server.AllowUsersReadWrite();

Encryption

⚠️ Note: this is only available for the Windows platform

Install-Package H.Formatters.Inferno
using H.Formatters;

await using var server = new PipeServer<MyMessage>(pipeName, formatter: new SystemTextJsonFormatter());
server.EnableEncryption();

await using var client = new PipeClient<MyMessage>(pipeName, formatter: new SystemTextJsonFormatter());
client.EnableEncryption();

await client.ConnectAsync(source.Token).ConfigureAwait(false);
// Waits for key exchange.
await client.Connection!.WaitExchangeAsync();

server.ClientConnected += async (_, args) =>
{
    // Waits for key exchange.
    await args.Connection.WaitExchangeAsync();

    await args.Connection.WriteAsync(new MyMessage
    {
        Text = "Welcome!"
    }, source.Token).ConfigureAwait(false);
};

GetImpersonationUserName

server.ClientConnected += async (o, args) =>
{
    var name = args.Connection.GetImpersonationUserName();

    Console.WriteLine($"Client {name} is now connected!");
};

Inter-process communication

I recommend that you take a look at my other library if you plan on doing IPC. This is a SourceGenerator that will generate client and server code based on the presented interface.

Contacts

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on H.Pipes.AccessControl:

Package Downloads
H.Services.IpcService

Package Description

H.Ipc.Generator

C# Source Generator for Inter-Process Communication.

H.VpnService

C# high-level VPN library with implemented IPC

H.Ipc

Core library for Inter-Process Communication.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.0-dev.322 100 1/20/2024
2.1.0-dev.318 115 12/18/2023
2.0.59 18,131 12/8/2023
2.0.56 820 11/27/2023
2.0.53 8,036 7/24/2023
2.0.51 4,847 5/25/2023
2.0.47 4,762 2/27/2023
2.0.46 238 2/26/2023
2.0.45 4,096 2/2/2023
2.0.44 6,438 1/10/2023
2.0.43 676 1/5/2023
2.0.42 6,481 9/14/2022
2.0.41 873 9/9/2022
2.0.40 434 8/26/2022
2.0.39 386 8/26/2022
2.0.38 2,822 6/2/2022
2.0.37 1,317 4/21/2022
2.0.35 2,009 3/17/2022
2.0.34 512 3/12/2022
2.0.33 437 3/12/2022
2.0.32 431 3/12/2022
2.0.31 1,326 3/11/2022
2.0.30 432 3/11/2022
2.0.29 432 3/11/2022
2.0.26 446 3/7/2022
2.0.25 428 3/6/2022
2.0.23 2,071 12/21/2021
2.0.22 280 12/21/2021
2.0.21 281 12/20/2021
2.0.20 267 12/20/2021
2.0.19 276 12/20/2021
2.0.18 285 12/20/2021
2.0.17 287 12/20/2021
2.0.16 274 12/20/2021
2.0.15 272 12/20/2021
2.0.14 709 12/5/2021
2.0.13 279 12/5/2021
1.15.12 313 12/5/2021
1.15.11 1,031 11/29/2021
1.15.10 3,242 11/25/2021
1.15.9 3,584 11/25/2021
1.15.8 2,569 11/25/2021
1.15.7 2,547 11/25/2021
1.15.6 3,751 11/24/2021
1.15.4 5,687 11/24/2021
1.15.2 395 10/22/2021
1.15.1 311 10/22/2021
1.14.8 3,714 1/4/2021
1.14.7 3,065 12/15/2020
1.14.6 400 12/9/2020
1.14.5 391 12/9/2020
1.14.4 447 11/22/2020
1.14.2 380 11/22/2020
1.14.1.4 471 10/16/2020
1.14.1.3 1,722 10/13/2020
1.14.1.2 457 10/12/2020
1.14.1 453 10/8/2020
1.14.0 497 10/8/2020
1.13.4 511 10/8/2020
1.13.3 459 7/12/2020
1.13.2 488 7/12/2020
1.13.1 484 7/5/2020
1.13.0 497 5/20/2020
1.12.3.2 473 5/19/2020
1.12.3.1 474 4/23/2020
1.12.3 464 2/2/2020
1.12.2 508 2/1/2020
1.12.1 521 2/1/2020
1.0.12 507 1/29/2020
1.0.11 528 1/28/2020
1.0.10 471 1/28/2020
1.0.9 457 1/14/2020
1.0.8 469 1/14/2020
1.0.7.1 538 1/12/2020
1.0.7 599 1/12/2020
1.0.6.1 533 1/11/2020
1.0.6 615 1/10/2020

⭐ Last 10 features:
- feat: Added PipeServer.CreatePipeStreamForConnectionFunc. 2023-12-08
- feat: Use MessagePackFormatter by default on net8.0. 2023-11-27
- feat: Update to net8.0. 2023-11-27
- feat: Updated packages. 2023-07-24
- feat: Added PipeApplication.StartAsync(args). 2023-02-27
- feat: Added IPipeClient.CreatePipeStreamFunc. Closes #29. 2023-02-02
- feat: Added ability to set up CerasFormatter.InternalFormatter. 2023-01-10
- feat: To net7.0. Updated NuGet packages. 2023-01-05
- feat: Updated H.Pipes.AccessControl to use official net5/net6 PipeSecurity implementation. 2022-09-09
- feat: Added BinaryFormatter.InternalFormatter as public property. 2022-03-18

🐞 Last 10 bug fixes:
- fix: Fixed bug with PipeStream.ReadAsync on non windows systems. 2023-05-26
- fix: Now EventExtensions is internal class. 2023-02-26
- fix: Fixed Connection.Disconnected unhandled exception bug. 2022-09-14
- fix: Fixed SemaphoreSlim usage. Fixes #24. 2022-08-26
- fix: Fixes #24. 2022-08-26
- fix: Added IOException ignoring for FlushAsync/WaitForPipeDrain. 2022-06-02
- fix: Fixed missing PipeStreamReader read check. Refactored. 2022-04-21
- fix(AccessControl): Fixed NET461 library to use Net Framework NamedPipeServerStream ctor. 2022-03-11
- fix: Fixed ValidatePublicKey. 2022-03-07
- fix: Fixed PipeClient.Connection set access. 2021-12-21