Audit.SignalR 27.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package Audit.SignalR --version 27.0.1                
NuGet\Install-Package Audit.SignalR -Version 27.0.1                
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="Audit.SignalR" Version="27.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Audit.SignalR --version 27.0.1                
#r "nuget: Audit.SignalR, 27.0.1"                
#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 Audit.SignalR as a Cake Addin
#addin nuget:?package=Audit.SignalR&version=27.0.1

// Install Audit.SignalR as a Cake Tool
#tool nuget:?package=Audit.SignalR&version=27.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

NuGet Status NuGet Count

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
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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
27.2.0 0 11/23/2024
27.1.1 1,174 10/28/2024
27.1.0 180 10/24/2024
27.0.3 1,267 9/25/2024
27.0.2 151 9/19/2024
27.0.1 508 9/4/2024
27.0.0 750 9/3/2024
26.0.1 377 8/22/2024
26.0.0 1,624 7/19/2024
25.0.7 998 7/4/2024
25.0.6 103 6/24/2024
25.0.5 110 6/18/2024
25.0.4 2,718 3/24/2024
25.0.3 152 3/13/2024
25.0.2 132 3/12/2024
25.0.1 143 2/28/2024
25.0.0 130 2/16/2024
24.0.1 140 2/12/2024
24.0.0 121 2/12/2024
23.0.0 3,538 12/14/2023
22.1.0 115 12/9/2023
22.0.2 1,568 12/1/2023
22.0.1 151 11/16/2023
22.0.0 119 11/14/2023
21.1.0 1,141 10/9/2023
21.0.4 1,314 9/15/2023
21.0.3 2,815 7/9/2023
21.0.2 177 7/6/2023
21.0.1 173 5/27/2023
21.0.0 915 4/15/2023
20.2.4 516 3/27/2023
20.2.3 426 3/17/2023
20.2.2 246 3/14/2023
20.2.1 236 3/11/2023
20.2.0 240 3/7/2023
20.1.6 271 2/23/2023
20.1.5 297 2/9/2023
20.1.4 347 1/28/2023
20.1.3 338 12/21/2022
20.1.2 330 12/14/2022
20.1.1 317 12/12/2022
20.1.0 350 12/4/2022
20.0.4 365 11/30/2022
20.0.3 684 10/28/2022
20.0.2 445 10/26/2022
20.0.1 491 10/21/2022
20.0.0 592 10/1/2022
19.4.1 567 9/10/2022
19.4.0 495 9/2/2022
19.3.0 506 8/23/2022
19.2.2 558 8/11/2022
19.2.1 524 8/6/2022
19.2.0 595 7/24/2022
19.1.4 518 5/23/2022
19.1.3 495 5/22/2022
19.1.2 472 5/18/2022
19.1.1 511 4/28/2022
19.1.0 505 4/10/2022
19.0.7 517 3/13/2022
19.0.6 548 3/7/2022
19.0.5 559 1/28/2022
19.0.4 538 1/23/2022
19.0.3 387 12/14/2021
19.0.2 373 12/11/2021
19.0.1 739 11/20/2021
19.0.0 382 11/11/2021
19.0.0-rc.net60.2 157 9/26/2021
19.0.0-rc.net60.1 204 9/16/2021
18.1.6 447 9/26/2021
18.1.5 418 9/7/2021
18.1.4 415 9/6/2021
18.1.3 2,905 8/19/2021
18.1.2 517 8/8/2021
18.1.1 440 8/5/2021
18.1.0 486 8/1/2021
18.0.1 486 7/30/2021
18.0.0 505 7/26/2021
17.0.8 463 7/7/2021
17.0.7 505 6/16/2021
17.0.6 467 6/5/2021
17.0.5 490 5/28/2021
17.0.4 474 5/4/2021
17.0.3 452 5/1/2021
17.0.2 472 4/22/2021
17.0.1 454 4/18/2021
17.0.0 512 3/26/2021
16.5.6 503 3/25/2021
16.5.5 447 3/23/2021
16.5.4 499 3/9/2021
16.5.3 467 2/26/2021
16.5.2 538 2/23/2021
16.5.1 476 2/21/2021
16.5.0 461 2/17/2021
16.4.5 464 2/15/2021
16.4.4 459 2/5/2021
16.4.3 461 1/27/2021
16.4.2 478 1/22/2021
16.4.1 520 1/21/2021
16.4.0 503 1/11/2021
16.3.3 512 1/8/2021
16.3.2 506 1/3/2021
16.3.1 526 12/31/2020
16.3.0 456 12/30/2020
16.2.1 501 12/27/2020
16.2.0 569 10/13/2020
16.1.5 571 10/4/2020
16.1.4 583 9/17/2020
16.1.3 689 9/13/2020
16.1.2 559 9/9/2020
16.1.1 579 9/3/2020
16.1.0 596 8/19/2020
16.0.3 626 8/15/2020
16.0.2 588 8/9/2020
16.0.1 672 8/8/2020
16.0.0 565 8/7/2020
15.3.0 633 7/23/2020
15.2.3 599 7/14/2020
15.2.2 1,023 5/19/2020
15.2.1 580 5/12/2020
15.2.0 620 5/9/2020
15.1.1 585 5/4/2020
15.1.0 630 4/13/2020
15.0.5 633 3/18/2020
15.0.4 598 2/28/2020
15.0.3 586 2/26/2020
15.0.2 776 1/20/2020
15.0.1 645 1/10/2020
15.0.0 638 12/17/2019
14.9.1 645 11/30/2019
14.9.0 631 11/29/2019
14.8.1 643 11/26/2019
14.8.0 636 11/20/2019
14.7.0 659 10/9/2019
14.6.6 656 10/8/2019
14.6.5 650 9/27/2019
14.6.4 651 9/21/2019
14.6.3 673 8/12/2019
14.6.2 713 8/3/2019
14.6.1 687 8/3/2019
14.6.0 659 7/26/2019
14.5.7 696 7/18/2019
14.5.6 692 7/10/2019
14.5.5 690 7/1/2019
14.5.4 695 6/17/2019
14.5.3 719 6/5/2019
14.5.2 697 5/30/2019
14.5.1 691 5/28/2019
14.5.0 710 5/24/2019
14.4.0 730 5/22/2019
14.3.4 743 5/14/2019
14.3.3 696 5/9/2019
14.3.2 742 4/30/2019
14.3.1 731 4/27/2019
14.3.0 755 4/24/2019
14.2.3 748 4/17/2019
14.2.2 718 4/10/2019
14.2.1 706 4/5/2019
14.2.0 712 3/16/2019
14.1.1 712 3/8/2019
14.1.0 820 2/11/2019
14.0.4 802 1/31/2019
14.0.3 828 1/22/2019
14.0.2 845 12/15/2018
14.0.1 864 11/29/2018
14.0.0 887 11/19/2018
13.3.0 898 11/16/2018
13.2.2 873 11/15/2018
13.2.1 875 11/13/2018
13.2.0 899 10/31/2018
13.1.5 889 10/31/2018
13.1.4 913 10/25/2018
13.1.3 902 10/18/2018
13.1.2 957 9/12/2018
13.1.1 956 9/11/2018
13.1.0 972 9/11/2018
13.0.0 983 8/29/2018
12.3.6 966 8/29/2018
12.3.5 983 8/22/2018
12.3.4 984 8/21/2018
12.3.3 25,740 8/21/2018
12.3.2 1,042 8/20/2018
12.3.1 1,054 8/20/2018
12.3.0 1,009 8/20/2018
12.2.2 1,042 8/15/2018
12.2.1 1,090 8/9/2018
12.2.0 1,016 8/8/2018
12.1.11 1,023 7/30/2018
12.1.10 979 7/20/2018
12.1.9 1,111 7/10/2018
12.1.8 1,141 7/2/2018
12.1.7 1,169 6/7/2018
12.1.6 1,055 6/4/2018
12.1.5 1,097 6/2/2018
12.1.4 1,045 5/25/2018
12.1.3 1,230 5/16/2018
12.1.2 1,097 5/15/2018
12.1.1 1,188 5/14/2018
12.1.0 1,120 5/9/2018
12.0.7 1,452 5/5/2018
12.0.6 1,191 5/4/2018
12.0.5 1,154 5/3/2018
12.0.4 1,229 4/30/2018
12.0.3 1,203 4/30/2018
12.0.2 1,118 4/27/2018
12.0.1 1,112 4/25/2018
12.0.0 1,055 4/22/2018
11.2.0 1,198 4/11/2018
11.1.0 1,119 4/8/2018
11.0.8 1,130 3/26/2018
11.0.7 1,115 3/20/2018
11.0.6 1,131 3/7/2018
11.0.5 1,075 2/22/2018
11.0.4 1,133 2/14/2018
11.0.3 1,165 2/12/2018
11.0.2 1,144 2/9/2018
11.0.1 1,066 1/29/2018
11.0.0 1,158 1/15/2018
10.0.3 1,080 12/29/2017
10.0.2 1,152 12/26/2017
10.0.1 1,230 12/18/2017
10.0.0 1,041 12/18/2017
9.3.0 1,178 12/17/2017
9.2.0 1,163 12/17/2017