H.Pipes.AccessControl
2.0.23
See the version list below for details.
dotnet add package H.Pipes.AccessControl --version 2.0.23
NuGet\Install-Package H.Pipes.AccessControl -Version 2.0.23
<PackageReference Include="H.Pipes.AccessControl" Version="2.0.23" />
paket add H.Pipes.AccessControl --version 2.0.23
#r "nuget: H.Pipes.AccessControl, 2.0.23"
// Install H.Pipes.AccessControl as a Cake Addin #addin nuget:?package=H.Pipes.AccessControl&version=2.0.23 // Install H.Pipes.AccessControl as a Cake Tool #tool nuget:?package=H.Pipes.AccessControl&version=2.0.23
Async Named Pipe Wrapper for .NET Standard 2.0
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(seeH.Pipes.AccessControl
nuget package) or more complex code to access using thePipeServer.PipeStreamInitializeAction
property
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);
P.S. To use the server inside the WinForms application, use Task.Run(). This creates a new thread for it.
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);
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
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
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.
It is based on this library, but provides an IPC implementation based on C# interfaces.
It supports remote method invocation, asynchronous methods, cancellation via CancellationToken
, events, and so on.
Contacts
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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 was computed. 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 is compatible. net462 was computed. 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. |
-
.NETFramework 4.6.1
- H.Pipes (>= 2.0.23)
- NamedPipeServerStream.NetFrameworkVersion (>= 1.0.10)
-
.NETStandard 2.0
- H.Pipes (>= 2.0.23)
- NamedPipeServerStream.NetFrameworkVersion (>= 1.0.10)
-
.NETStandard 2.1
- H.Pipes (>= 2.0.23)
- NamedPipeServerStream.NetFrameworkVersion (>= 1.0.10)
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 | 426 | 1/20/2024 |
2.1.0-dev.318 | 120 | 12/18/2023 |
2.0.59 | 24,398 | 12/8/2023 |
2.0.56 | 831 | 11/27/2023 |
2.0.53 | 8,410 | 7/24/2023 |
2.0.51 | 4,966 | 5/25/2023 |
2.0.47 | 4,982 | 2/27/2023 |
2.0.46 | 244 | 2/26/2023 |
2.0.45 | 4,471 | 2/2/2023 |
2.0.44 | 6,455 | 1/10/2023 |
2.0.43 | 684 | 1/5/2023 |
2.0.42 | 6,687 | 9/14/2022 |
2.0.41 | 892 | 9/9/2022 |
2.0.40 | 456 | 8/26/2022 |
2.0.39 | 410 | 8/26/2022 |
2.0.38 | 2,836 | 6/2/2022 |
2.0.37 | 1,330 | 4/21/2022 |
2.0.35 | 2,034 | 3/17/2022 |
2.0.34 | 533 | 3/12/2022 |
2.0.33 | 443 | 3/12/2022 |
2.0.32 | 453 | 3/12/2022 |
2.0.31 | 1,350 | 3/11/2022 |
2.0.30 | 444 | 3/11/2022 |
2.0.29 | 453 | 3/11/2022 |
2.0.26 | 453 | 3/7/2022 |
2.0.25 | 435 | 3/6/2022 |
2.0.23 | 2,098 | 12/21/2021 |
2.0.22 | 283 | 12/21/2021 |
2.0.21 | 287 | 12/20/2021 |
2.0.20 | 272 | 12/20/2021 |
2.0.19 | 282 | 12/20/2021 |
2.0.18 | 302 | 12/20/2021 |
2.0.17 | 305 | 12/20/2021 |
2.0.16 | 294 | 12/20/2021 |
2.0.15 | 289 | 12/20/2021 |
2.0.14 | 753 | 12/5/2021 |
2.0.13 | 296 | 12/5/2021 |
1.15.12 | 318 | 12/5/2021 |
1.15.11 | 1,050 | 11/29/2021 |
1.15.10 | 3,259 | 11/25/2021 |
1.15.9 | 3,603 | 11/25/2021 |
1.15.8 | 2,573 | 11/25/2021 |
1.15.7 | 2,552 | 11/25/2021 |
1.15.6 | 3,774 | 11/24/2021 |
1.15.4 | 5,705 | 11/24/2021 |
1.15.2 | 413 | 10/22/2021 |
1.15.1 | 335 | 10/22/2021 |
1.14.8 | 3,803 | 1/4/2021 |
1.14.7 | 3,189 | 12/15/2020 |
1.14.6 | 417 | 12/9/2020 |
1.14.5 | 410 | 12/9/2020 |
1.14.4 | 451 | 11/22/2020 |
1.14.2 | 383 | 11/22/2020 |
1.14.1.4 | 475 | 10/16/2020 |
1.14.1.3 | 1,746 | 10/13/2020 |
1.14.1.2 | 481 | 10/12/2020 |
1.14.1 | 457 | 10/8/2020 |
1.14.0 | 516 | 10/8/2020 |
1.13.4 | 533 | 10/8/2020 |
1.13.3 | 463 | 7/12/2020 |
1.13.2 | 493 | 7/12/2020 |
1.13.1 | 489 | 7/5/2020 |
1.13.0 | 515 | 5/20/2020 |
1.12.3.2 | 488 | 5/19/2020 |
1.12.3.1 | 493 | 4/23/2020 |
1.12.3 | 481 | 2/2/2020 |
1.12.2 | 517 | 2/1/2020 |
1.12.1 | 537 | 2/1/2020 |
1.0.12 | 527 | 1/29/2020 |
1.0.11 | 548 | 1/28/2020 |
1.0.10 | 488 | 1/28/2020 |
1.0.9 | 476 | 1/14/2020 |
1.0.8 | 487 | 1/14/2020 |
1.0.7.1 | 541 | 1/12/2020 |
1.0.7 | 616 | 1/12/2020 |
1.0.6.1 | 551 | 1/11/2020 |
1.0.6 | 636 | 1/10/2020 |
⭐ Last 10 features:
- feat: Added connection close if EnableEncryption fails. 2021-12-21
- feat: Added WaitExchangeAsync use example. 2021-12-20
- feat: Added Inferno PipeConnectionExtensions.WaitExchangeAsync extension. 2021-12-20
- feat: IPipeClient Connection/PipeName/ServerName now public properties. 2021-12-20
- feat: Updated README. 2021-12-20
- feat: Added ContinuousIntegrationBuild. 2021-12-20
- feat: Updated Microsoft.SourceLink.GitHub to 1.1.1. 2021-12-20
- feat: Added H.Formatters.Inferno EnableEncryption extensions. 2021-12-20
- feat: Added IFormatter to IPipeClient interface. 2021-12-20
- feat: Converted formatter Internal methods to protected. 2021-12-20
🐞 Last 10 bug fixes:
- fix: Fixed PipeClient.Connection set access. 2021-12-21
- fix: Fixed problem with multiple server encrypted connections. 2021-12-20
- fix: Fixed EnableEncryption client/server settings. 2021-12-20
- fix: Fixed Inferno KeyPair missing disposing. 2021-12-20
- fix: Fixed some Inferno KeyPair code. 2021-12-20
- fix: Converted Inferno KeyPair to internal class. 2021-12-20
- fix: Fixed Inferno namespaces. 2021-12-20
- fix: Fixed Inferno extensions memory leak. 2021-12-20
- fix: Deleted InfernoFormatter.SerializeAsyncIfPossible. 2021-12-20
- fix: Fixed some Inferno Formatter code. 2021-12-20