Audit.SignalR
24.0.1
See the version list below for details.
dotnet add package Audit.SignalR --version 24.0.1
NuGet\Install-Package Audit.SignalR -Version 24.0.1
<PackageReference Include="Audit.SignalR" Version="24.0.1" />
paket add Audit.SignalR --version 24.0.1
#r "nuget: Audit.SignalR, 24.0.1"
// Install Audit.SignalR as a Cake Addin #addin nuget:?package=Audit.SignalR&version=24.0.1 // Install Audit.SignalR as a Cake Tool #tool nuget:?package=Audit.SignalR&version=24.0.1
Audit.SignalR
SignalR Auditing Extension for Audit.NET library.
Automatically generates Audit Logs for ASP.NET SignalR or Asp Net Core SignalR invokations.
Audit.SignalR provides a configurable Hub Pipeline Module/Filter that intercepts the hub processing to generate an audit trail.
It generate logs for the following events:
Event Name | Description | ASP.NET SignalR | ASP.NET Core SignalR |
---|---|---|---|
Connect | Client is connecting to the server | ✅ | ✅ |
Disconnect | Client disconnect from the server | ✅ | ✅ |
Incoming | Client invoking server-side method | ✅ | ✅ |
Reconnect | Client reconnecting to the server | ✅ | ❌ |
Outgoing | Server invoking client-side method | ✅ | ❌ |
Error | An error has occurred | ✅ | ❌ |
Install
NuGet Package
To install the package run the following command on the Package Manager Console:
PM> Install-Package Audit.SignalR
SignalR Version
This library supports:
Usage - ASP.NET SignalR
On your ASP.NET startup logic, call the extension method AddAuditModule()
defined on namespace Microsoft.AspNet.SignalR.GlobalHost.HubPipeline
, to setup the audit pipeline. This must be called before IAppBuilder.MapSignalR()
.
This method provides a fluent API to configure the audit module.
For example:
using Audit.SignalR;
using Microsoft.AspNet.SignalR;
//...
public class Startup
{
public void Configuration(IAppBuilder app)
{
GlobalHost.HubPipeline.AddAuditModule(config => config
.IncludeHeaders()
.Filters(f => f
.IncludeOutgoingEvent(og => og.HubName == "myHub")
.IncludeReconnectEvent(false));
app.MapSignalR();
}
}
This will create an AuditPipelineModule
(that inherits from HubPipelineModule)
and will add it to the hub pipeline.
Alternatively, you can create an instance of the module and add it to the pipeline, with the exact same effect:
using Audit.SignalR;
using Microsoft.AspNet.SignalR;
//...
var module = new AuditPipelineModule()
{
IncludeHeaders = true,
ReconnectEventsFilter = _ => false,
OutgoingEventsFilter = og => og.HubName == "myHub"
};
GlobalHost.HubPipeline.AddModule(module);
Or create the module using the factory method AuditPipelineModule.Create()
that provides the fluent API for the configuration:
var module = AuditPipelineModule.Create(config => config
.IncludeHeaders()
...
);
GlobalHost.HubPipeline.AddModule(module);
Usage - ASP.NET Core SignalR
On your ASP.NET Core startup logic, call the extension method AddAuditFilter()
defined on namespace Audit.SignalR
when adding the SignalR service.
This method provides a fluent API to configure the audit filter.
For example:
using Audit.SignalR;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddSignalR(c =>
{
c.AddAuditFilter(cfg => cfg
.IncludeHeaders()
.IncludeQueryString()
.Filters(f => f
.IncludeIncomingEvent(true)
.IncludeConnectEvent(false)
.IncludeDisconnectEvent(false))
);
});
This will create an Audit HubFilter
and add it to the hub pipeline.
Configuration
Settings
The following settings can be configured on the module/filter:
- AuditEventType: To indicate the event type to use on the audit event. (Default is the event name). Can contain the following placeholders:
- {event}: replaced with the SignalR event name (Connect, Reconnect, Disconnect, Incoming, Outgoing, Error).
- IncludeHeaders: To indicate if the audit should include the request headers (Valid for events Connect, Reconnect, Disconnect, Incoming and Error). Default is false.
- IncludeQueryString: To indicate if the audit should include the request Query String (Valid for events Connect, Reconnect, Disconnect, Incoming and Error). Default is false.
- AuditDisabled: Set to true to disable the audit log generation (bypass). Default is false.
- CreationPolicy: To indicate the event creation policy to use. Default is NULL to use the globally configured creation policy.
- AuditDataProvider: To indicate the Audit Data Provider to use. Default is NULL to use the globally configured data provider.
Filter settings
The module allows to configure filtering of events. By default it will log all the events.
- IncomingEventsFilter: Allows to filter Incoming events (invoking server-side methods) with a custom function that given the incoming event info, returns true if the event should be logged and false otherwise.
- OutgoingEventsFilter: Allows to filter Outgoing events (invoking client-side methods).
- ConnectEventsFilter: Allows to filter Connect events.
- DisconnectEventsFilter: Allows to filter Disconnect events.
- ReconnectEventsFilter: Allows to filter Reconnect events.
- ErrorEventsFilter: Allows to filter Error events.
Extension Methods
You can access the current Audit Scope
for the incoming event inside server-side methods, by calling the Hub extension method GetIncomingAuditScope()
/ GetAuditScope()
,
for example:
public class MyHub : Hub
{
public int Send(string name, string message)
{
var scope = this.GetAuditScope();
if (someCondition)
{
scope.Discard()
}
else
{
scope.SetCustomField("UserType", user.UserType);
}
//...
}
The SignalR specific event information on the AuditScope can be accessed as follows:
var scope = this.GetIncomingAuditScope();
var signalrEventIncoming = scope.Event.GetSignalrEvent<SignalrEventIncoming>();
Event Output
To configure the output persistence mechanism please see Configuration and Data Providers sections.
Output
Audit.SignalR output includes:
- Execution time and duration (when applicable)
- Environment information such as user, machine, domain and locale.
- ConnectionId
- Hub name, Method name and Arguments
- Exception details
- HTTP request details (optional)
Output details
The following tables describes the Audit.SignalR output fields per event type:
Field Name | Type | Description |
---|---|---|
EventType | SignalrEventType | "Connect" |
ConnectionId | string | The connection ID |
Headers | Dictionary<string, string> | The HTTP headers of the associated request (when IncludeHeaders is set to true) |
QueryString | Dictionary<string, string> | The query string of the associated request (when IncludeQueryString is set to true) |
LocalPath | string | The local path |
IdentityName | string | The identity name associated |
Field Name | Type | Description |
---|---|---|
EventType | SignalrEventType | "Disconnect" |
ConnectionId | string | The connection ID |
Headers | Dictionary<string, string> | The HTTP headers of the associated request (when IncludeHeaders is set to true) |
QueryString | Dictionary<string, string> | The query string of the associated request (when IncludeQueryString is set to true) |
LocalPath | string | The local path |
IdentityName | string | The identity name associated |
StopCalled | boolean | Set to true if the client explicitly closed the connection |
Field Name | Type | Description |
---|---|---|
EventType | SignalrEventType | "Incoming" |
ConnectionId | string | The connection ID |
Headers | Dictionary<string, string> | The HTTP headers of the associated request (when IncludeHeaders is set to true) |
QueryString | Dictionary<string, string> | The query string of the associated request (when IncludeQueryString is set to true) |
LocalPath | string | The local path |
IdentityName | string | The identity name associated |
HubName | string | The hub name |
HubType | string | The hub type name |
MethodName | string | The name of the invoked method |
Args | List<Object> | The arguments passed in the invokation |
Result | Object | The invoked method return value |
Exception | string | Exception information when the hub method fails |
Field Name | Type | Description |
---|---|---|
EventType | SignalrEventType | "Outgoing" |
HubName | string | The hub name |
Signal | string | The signal (ConnectionId, hub type name or hub type name + "." + group name) belonging to clients that receive the method invocation |
MethodName | string | The invoked method name |
Args | List<Object> | The arguments passed in the invokation |
SignalrEventError : SignalrEventConnect
Field Name | Type | Description |
---|---|---|
EventType | SignalrEventType | "Error" |
ConnectionId | string | The connection ID |
Headers | Dictionary<string, string> | The HTTP headers of the associated request (when IncludeHeaders is set to true) |
QueryString | Dictionary<string, string> | The query string of the associated request (when IncludeQueryString is set to true) |
LocalPath | string | The local path |
IdentityName | string | The identity name associated |
HubName | string | The hub name |
HubType | string | The hub type name |
Exception | string | Detailed information about the exception |
MethodName | string | The name of the invoked method |
Args | List<Object> | The arguments passed in the invokation |
Customization
Custom fields
You can add extra information as custom fields to the events by calling the method AddAuditCustomField
on your Hub
. For example:
public class MyHub : Hub
{
public int Send(string name, string message)
{
this.AddCustomField("User", user);
}
Another way to customize the output is by using global custom actions, please see custom actions for more information.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | 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 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 Framework | net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
.NETFramework 4.6.2
- Audit.NET (>= 24.0.1)
- Microsoft.AspNet.SignalR.Core (>= 2.4.3)
-
net7.0
- Audit.NET (>= 24.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
26.0.1 | 236 | 8/22/2024 |
26.0.0 | 1,443 | 7/19/2024 |
25.0.7 | 975 | 7/4/2024 |
25.0.6 | 84 | 6/24/2024 |
25.0.5 | 91 | 6/18/2024 |
25.0.4 | 2,699 | 3/24/2024 |
25.0.3 | 128 | 3/13/2024 |
25.0.2 | 108 | 3/12/2024 |
25.0.1 | 125 | 2/28/2024 |
25.0.0 | 113 | 2/16/2024 |
24.0.1 | 121 | 2/12/2024 |
24.0.0 | 98 | 2/12/2024 |
23.0.0 | 3,503 | 12/14/2023 |
22.1.0 | 108 | 12/9/2023 |
22.0.2 | 1,563 | 12/1/2023 |
22.0.1 | 128 | 11/16/2023 |
22.0.0 | 87 | 11/14/2023 |
21.1.0 | 1,118 | 10/9/2023 |
21.0.4 | 1,292 | 9/15/2023 |
21.0.3 | 2,653 | 7/9/2023 |
21.0.2 | 159 | 7/6/2023 |
21.0.1 | 154 | 5/27/2023 |
21.0.0 | 897 | 4/15/2023 |
20.2.4 | 496 | 3/27/2023 |
20.2.3 | 407 | 3/17/2023 |
20.2.2 | 230 | 3/14/2023 |
20.2.1 | 220 | 3/11/2023 |
20.2.0 | 222 | 3/7/2023 |
20.1.6 | 252 | 2/23/2023 |
20.1.5 | 274 | 2/9/2023 |
20.1.4 | 329 | 1/28/2023 |
20.1.3 | 319 | 12/21/2022 |
20.1.2 | 311 | 12/14/2022 |
20.1.1 | 299 | 12/12/2022 |
20.1.0 | 345 | 12/4/2022 |
20.0.4 | 348 | 11/30/2022 |
20.0.3 | 664 | 10/28/2022 |
20.0.2 | 429 | 10/26/2022 |
20.0.1 | 470 | 10/21/2022 |
20.0.0 | 569 | 10/1/2022 |
19.4.1 | 549 | 9/10/2022 |
19.4.0 | 477 | 9/2/2022 |
19.3.0 | 483 | 8/23/2022 |
19.2.2 | 534 | 8/11/2022 |
19.2.1 | 501 | 8/6/2022 |
19.2.0 | 579 | 7/24/2022 |
19.1.4 | 500 | 5/23/2022 |
19.1.3 | 474 | 5/22/2022 |
19.1.2 | 455 | 5/18/2022 |
19.1.1 | 491 | 4/28/2022 |
19.1.0 | 481 | 4/10/2022 |
19.0.7 | 498 | 3/13/2022 |
19.0.6 | 530 | 3/7/2022 |
19.0.5 | 540 | 1/28/2022 |
19.0.4 | 517 | 1/23/2022 |
19.0.3 | 368 | 12/14/2021 |
19.0.2 | 355 | 12/11/2021 |
19.0.1 | 721 | 11/20/2021 |
19.0.0 | 361 | 11/11/2021 |
19.0.0-rc.net60.2 | 151 | 9/26/2021 |
19.0.0-rc.net60.1 | 198 | 9/16/2021 |
18.1.6 | 425 | 9/26/2021 |
18.1.5 | 402 | 9/7/2021 |
18.1.4 | 398 | 9/6/2021 |
18.1.3 | 2,888 | 8/19/2021 |
18.1.2 | 499 | 8/8/2021 |
18.1.1 | 420 | 8/5/2021 |
18.1.0 | 471 | 8/1/2021 |
18.0.1 | 466 | 7/30/2021 |
18.0.0 | 479 | 7/26/2021 |
17.0.8 | 447 | 7/7/2021 |
17.0.7 | 485 | 6/16/2021 |
17.0.6 | 449 | 6/5/2021 |
17.0.5 | 473 | 5/28/2021 |
17.0.4 | 455 | 5/4/2021 |
17.0.3 | 432 | 5/1/2021 |
17.0.2 | 450 | 4/22/2021 |
17.0.1 | 439 | 4/18/2021 |
17.0.0 | 493 | 3/26/2021 |
16.5.6 | 483 | 3/25/2021 |
16.5.5 | 431 | 3/23/2021 |
16.5.4 | 482 | 3/9/2021 |
16.5.3 | 449 | 2/26/2021 |
16.5.2 | 497 | 2/23/2021 |
16.5.1 | 457 | 2/21/2021 |
16.5.0 | 441 | 2/17/2021 |
16.4.5 | 444 | 2/15/2021 |
16.4.4 | 442 | 2/5/2021 |
16.4.3 | 440 | 1/27/2021 |
16.4.2 | 457 | 1/22/2021 |
16.4.1 | 503 | 1/21/2021 |
16.4.0 | 481 | 1/11/2021 |
16.3.3 | 491 | 1/8/2021 |
16.3.2 | 488 | 1/3/2021 |
16.3.1 | 507 | 12/31/2020 |
16.3.0 | 435 | 12/30/2020 |
16.2.1 | 482 | 12/27/2020 |
16.2.0 | 549 | 10/13/2020 |
16.1.5 | 553 | 10/4/2020 |
16.1.4 | 565 | 9/17/2020 |
16.1.3 | 673 | 9/13/2020 |
16.1.2 | 542 | 9/9/2020 |
16.1.1 | 562 | 9/3/2020 |
16.1.0 | 575 | 8/19/2020 |
16.0.3 | 604 | 8/15/2020 |
16.0.2 | 571 | 8/9/2020 |
16.0.1 | 653 | 8/8/2020 |
16.0.0 | 549 | 8/7/2020 |
15.3.0 | 615 | 7/23/2020 |
15.2.3 | 580 | 7/14/2020 |
15.2.2 | 1,000 | 5/19/2020 |
15.2.1 | 562 | 5/12/2020 |
15.2.0 | 602 | 5/9/2020 |
15.1.1 | 562 | 5/4/2020 |
15.1.0 | 611 | 4/13/2020 |
15.0.5 | 615 | 3/18/2020 |
15.0.4 | 581 | 2/28/2020 |
15.0.3 | 570 | 2/26/2020 |
15.0.2 | 754 | 1/20/2020 |
15.0.1 | 625 | 1/10/2020 |
15.0.0 | 621 | 12/17/2019 |
14.9.1 | 626 | 11/30/2019 |
14.9.0 | 614 | 11/29/2019 |
14.8.1 | 625 | 11/26/2019 |
14.8.0 | 617 | 11/20/2019 |
14.7.0 | 641 | 10/9/2019 |
14.6.6 | 636 | 10/8/2019 |
14.6.5 | 632 | 9/27/2019 |
14.6.4 | 630 | 9/21/2019 |
14.6.3 | 651 | 8/12/2019 |
14.6.2 | 695 | 8/3/2019 |
14.6.1 | 665 | 8/3/2019 |
14.6.0 | 641 | 7/26/2019 |
14.5.7 | 680 | 7/18/2019 |
14.5.6 | 674 | 7/10/2019 |
14.5.5 | 668 | 7/1/2019 |
14.5.4 | 676 | 6/17/2019 |
14.5.3 | 699 | 6/5/2019 |
14.5.2 | 678 | 5/30/2019 |
14.5.1 | 669 | 5/28/2019 |
14.5.0 | 690 | 5/24/2019 |
14.4.0 | 712 | 5/22/2019 |
14.3.4 | 724 | 5/14/2019 |
14.3.3 | 677 | 5/9/2019 |
14.3.2 | 727 | 4/30/2019 |
14.3.1 | 714 | 4/27/2019 |
14.3.0 | 735 | 4/24/2019 |
14.2.3 | 730 | 4/17/2019 |
14.2.2 | 701 | 4/10/2019 |
14.2.1 | 688 | 4/5/2019 |
14.2.0 | 692 | 3/16/2019 |
14.1.1 | 693 | 3/8/2019 |
14.1.0 | 802 | 2/11/2019 |
14.0.4 | 784 | 1/31/2019 |
14.0.3 | 810 | 1/22/2019 |
14.0.2 | 823 | 12/15/2018 |
14.0.1 | 844 | 11/29/2018 |
14.0.0 | 866 | 11/19/2018 |
13.3.0 | 879 | 11/16/2018 |
13.2.2 | 857 | 11/15/2018 |
13.2.1 | 860 | 11/13/2018 |
13.2.0 | 879 | 10/31/2018 |
13.1.5 | 873 | 10/31/2018 |
13.1.4 | 896 | 10/25/2018 |
13.1.3 | 884 | 10/18/2018 |
13.1.2 | 939 | 9/12/2018 |
13.1.1 | 936 | 9/11/2018 |
13.1.0 | 950 | 9/11/2018 |
13.0.0 | 961 | 8/29/2018 |
12.3.6 | 947 | 8/29/2018 |
12.3.5 | 960 | 8/22/2018 |
12.3.4 | 965 | 8/21/2018 |
12.3.3 | 25,721 | 8/21/2018 |
12.3.2 | 1,021 | 8/20/2018 |
12.3.1 | 1,036 | 8/20/2018 |
12.3.0 | 990 | 8/20/2018 |
12.2.2 | 1,021 | 8/15/2018 |
12.2.1 | 1,070 | 8/9/2018 |
12.2.0 | 998 | 8/8/2018 |
12.1.11 | 1,005 | 7/30/2018 |
12.1.10 | 960 | 7/20/2018 |
12.1.9 | 1,089 | 7/10/2018 |
12.1.8 | 1,122 | 7/2/2018 |
12.1.7 | 1,149 | 6/7/2018 |
12.1.6 | 1,039 | 6/4/2018 |
12.1.5 | 1,074 | 6/2/2018 |
12.1.4 | 1,026 | 5/25/2018 |
12.1.3 | 1,211 | 5/16/2018 |
12.1.2 | 1,076 | 5/15/2018 |
12.1.1 | 1,167 | 5/14/2018 |
12.1.0 | 1,097 | 5/9/2018 |
12.0.7 | 1,430 | 5/5/2018 |
12.0.6 | 1,172 | 5/4/2018 |
12.0.5 | 1,129 | 5/3/2018 |
12.0.4 | 1,209 | 4/30/2018 |
12.0.3 | 1,186 | 4/30/2018 |
12.0.2 | 1,097 | 4/27/2018 |
12.0.1 | 1,090 | 4/25/2018 |
12.0.0 | 1,036 | 4/22/2018 |
11.2.0 | 1,176 | 4/11/2018 |
11.1.0 | 1,097 | 4/8/2018 |
11.0.8 | 1,108 | 3/26/2018 |
11.0.7 | 1,095 | 3/20/2018 |
11.0.6 | 1,110 | 3/7/2018 |
11.0.5 | 1,058 | 2/22/2018 |
11.0.4 | 1,112 | 2/14/2018 |
11.0.3 | 1,145 | 2/12/2018 |
11.0.2 | 1,125 | 2/9/2018 |
11.0.1 | 1,046 | 1/29/2018 |
11.0.0 | 1,138 | 1/15/2018 |
10.0.3 | 1,063 | 12/29/2017 |
10.0.2 | 1,130 | 12/26/2017 |
10.0.1 | 1,210 | 12/18/2017 |
10.0.0 | 1,022 | 12/18/2017 |
9.3.0 | 1,159 | 12/17/2017 |
9.2.0 | 1,142 | 12/17/2017 |