Audit.WCF 27.0.3

dotnet add package Audit.WCF --version 27.0.3                
NuGet\Install-Package Audit.WCF -Version 27.0.3                
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.WCF" Version="27.0.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Audit.WCF --version 27.0.3                
#r "nuget: Audit.WCF, 27.0.3"                
#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.WCF as a Cake Addin
#addin nuget:?package=Audit.WCF&version=27.0.3

// Install Audit.WCF as a Cake Tool
#tool nuget:?package=Audit.WCF&version=27.0.3                

Audit.WCF

WCF Audit Extension for Audit.NET library.

Generate Audit Logs for Windows Communication Foundation (WCF) service calls.

Audit.Wcf provides the server-side infrastructure to log interactions with WCF services. It records detailed information of the service method calls.

If you are looking for client-side audit, please check the Audit.WCF.Client library.

Install

NuGet Package

To install the package run the following command on the Package Manager Console:

PM> Install-Package Audit.Wcf

NuGet Status NuGet Count

Usage

Decorate your WCF service class or methods with the Audit.WCF.AuditBehavior attribute.

For example:

[AuditBehavior(EventType = "{contract}.{operation}")]
public class OrderService : IOrderService
{
  public async Task<GetOrderResponse> GetOrder(GetOrderRequest request)
  {
    ...
  }
}

You can also decorate the specific methods you want to audit, for example:

public class OrderService : IOrderService
{
  [AuditBehavior]
  public async Task<GetOrderResponse> GetOrder(GetOrderRequest request)
  {
    ...
  }
}

If you can't (or do not want) to change the service code, you can also enable the audit mechanism by adding the AuditBehavior extension to your service host configuration file.

For example:

<configuration>
  <system.serviceModel>
    ...
    <extensions>
      <behaviorExtensions>
	      <add name="auditBehavior" type="Audit.WCF.AuditBehavior, Audit.WCF" />
      </behaviorExtensions>
    </extensions>

    <behaviors>
      <serviceBehaviors>
	      <behavior>
	        <auditBehavior eventType="{contract}.{operation}" />
	      </behavior>
      </serviceBehaviors>
    </behaviors>
    ...
  </system.serviceModel>
</configuration>

Configuration

The AuditBehavior attribute or extension can be configured with the following properties:

  • EventTypeName: A string that identifies the event type. Can contain the following placeholders:
    • {contract}: Replaced with the contract name (service interface name)
    • {operation}: Replaces with the operation name (service method name)
  • AuditDataProvider: Allows to set a specific audit data provider. By default the globally configured data provider is used. See Audit.NET Data Providers section for more information.
  • AuditScopeFactory: Allows to set a specific audit scope factory. By default the globally configured AuditScopeFactory is used.

To globally configure the output persistence mechanism, use the Audit.Core.Configuration class. For more details please see Event Output Configuration.

For example:

Audit.Core.Configuration.Setup()
	.UseFileLogProvider(config => config.Directory(@"C:\Logs"));

This should be done prior to the AuditScope creation, i.e. during application startup.

If you want to configure an Audit Data Provider per service instance, you can add a public instance property named AuditDataProvider to your service class and make it return the provider you want, for example:

[AuditBehavior]
public class OrderService : IOrderService
{
    public AuditDataProvider AuditDataProvider
    {
        get
        {
            return new Audit.Core.Providers.FileDataProvider()
            {
                DirectoryPath = @"C:\Logs"
            };
        }
    }
}

The library will automatically detect the property and use the given data provider for that service instance.

You can do the same with the AuditScopeFactory property to provide a custom IAuditScopeFactory instance.


## Output

`Audit.Wcf` output includes:

- Execution time and duration
- Environment information such as user, machine, domain and locale.
- Authenticated username (identity name)
- Client IP address
- Contract and Operation details
- Method parameters (in and out)
- Response object
- Faults and Exceptions details
- [Comments and Custom Fields](#custom-fields-and-comments) provided

With this information, you can not just know who did the operation, but also measure performance, observe exceptions thrown or get statistics about usage of your WCF service.

## Output details

The following table describes the `Audit.Wcf` output fields:

- ### [AuditWcfEvent](https://github.com/thepirat000/Audit.NET/blob/master/src/Audit.WCF/AuditWcfEvent.cs)

Describes an audited WCF event

| Field Name | Type | Description | 
| ------------ | ---------------- |  -------------- |
| ContractName | string | Name of the contract (service interface) |
| OperationName | string | Name of the operation (service method) |
| InstanceQualifiedName | string | Assembly qualified type name of the service instance |
| IsAsync | boolean | Indicates if the operation is asynchronous |
| MethodSignature | string | Signature of the audited method |
| Action | string | Action absolute address |
| ReplyAction | string |Reply action absolute address |
| IdentityName | string | Name of the current identity (username) |
| ClientAddress | string | Client address (IP) |
| HostAddress | string | Serice host address |
| Success | boolean | Indicates if the operation completed succesfully |
| Fault | [AuditWcfEventFault](#AuditWcfEventFault) | Fault details when the operation fails |
| Result | Object | The result object value |
| InputParameters | Array of [AuditWcfEventElement](#AuditWcfEventElement) | Input parameters object values |
| OutputParameters | Array of [AuditWcfEventElement](#AuditWcfEventElement) | Output parameters object values |

- ### [AuditWcfEventFault](https://github.com/thepirat000/Audit.NET/blob/master/src/Audit.WCF/AuditWcfEventFault.cs)

Describes a WCF fault/exception

| Field Name | Type | Description | 
| ------------ | ---------------- |  -------------- |
| FaultType | string | Fault type (Exception / Fault) |
| Exception | string | Exception details |
| FaultCode | string | The fault code |
| FaultAction | string | The fault action name |
| FaultReason | string | The fault reason |
| FaultDetails | [AuditWcfEventElement](#AuditWcfEventElement) | The detail object related to the fault |

- ### [AuditWcfEventElement](https://github.com/thepirat000/Audit.NET/blob/master/src/Audit.WCF/AuditWcfEventElement.cs)

Describes an element/object related to the WCF audit event.

| Field Name | Type | Description | 
| ------------ | ---------------- |  -------------- |
| Type | string | The object type name |
| Value | Object | The object value |

## Customization

You can access the `AuditScope` object for customization from the audited methods, by the static property `Audit.WCF.AuditBehavior.CurrentAuditScope`. 

For example:
```c#
using Audit.WCF;

[AuditBehavior]
public class OrderService : IOrderService
{
    public GetOrderResponse GetOrder(GetOrderRequest request)
    {
        AuditBehavior.CurrentAuditScope.Comment("some comment");
        AuditBehavior.CurrentAuditScope.SetCustomField("User", MySession.CurrentUser);
        ...
    }
}

See Audit.NET documentation about Custom Field and Comments for more information.

Output Sample

{
	"EventType": "IOrderService.GetOrder",
	"Environment": {
		"UserName": "Federico",
		"MachineName": "HP",
		"DomainName": "HP",
		"CallingMethodName": "WCF_IIS.IOrderService.GetData()",
		"AssemblyName": "WCF_IIS, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
		"Exception": null,
		"Culture": "en-GB"
	},
	"StartDate": "2016-09-13T01:31:58.6843094-05:00",
	"EndDate": "2016-09-13T01:31:58.6858324-05:00",
	"Duration": 2,
	"WcfEvent": {
		"ContractName": "IOrderService",
		"OperationName": "GetOrder",
		"InstanceQualifiedName": "WCF_IIS.OrderService, WCF_IIS, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
		"MethodSignature": "WCF_IIS.GetOrderResponse GetOrder(WCF_IIS.GetOrderRequest)",
		"Action": "http://tempuri.org/IOrderService/GetOrder",
		"ReplyAction": "http://tempuri.org/IOrderService/GetOrderResponse",
		"ClientAddress": "::1",
		"HostAddress": "http://localhost:8733/Design_Time_Addresses/WCF_IIS/OrderService/",
		"InputParameters": [{
			"Type": "GetOrderRequest",
			"Value": {
				"OrderId": 123
			}
		}],
		"Success": true,
		"Result": {
			"Type": "GetOrderResponse",
			"Value": {
				"Success": true,
				"Errors": null,
				"Order": {
					"OrderId": 123,
					"CustomerName": "customer",
					"Total": 10.0
				}
			}
		},
		"OutputParameters": []
	}
}
Product Compatible and additional computed target framework versions.
.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.0.3 68 9/25/2024
27.0.2 87 9/19/2024
27.0.1 93 9/4/2024
27.0.0 94 9/3/2024
26.0.1 126 8/22/2024
26.0.0 98 7/19/2024
25.0.7 129 7/4/2024
25.0.6 96 6/24/2024
25.0.5 100 6/18/2024
25.0.4 172 3/24/2024
25.0.3 198 3/13/2024
25.0.2 173 3/12/2024
25.0.1 201 2/28/2024
25.0.0 225 2/16/2024
24.0.1 273 2/12/2024
24.0.0 244 2/12/2024
23.0.0 513 12/14/2023
22.1.0 447 12/9/2023
22.0.2 454 12/1/2023
22.0.1 474 11/16/2023
22.0.0 463 11/14/2023
21.1.0 526 10/9/2023
21.0.4 559 9/15/2023
21.0.3 732 7/9/2023
21.0.2 674 7/6/2023
21.0.1 746 5/27/2023
21.0.0 776 4/15/2023
20.2.4 845 3/27/2023
20.2.3 784 3/17/2023
20.2.2 826 3/14/2023
20.2.1 806 3/11/2023
20.2.0 821 3/7/2023
20.1.6 834 2/23/2023
20.1.5 860 2/9/2023
20.1.4 860 1/28/2023
20.1.3 892 12/21/2022
20.1.2 940 12/14/2022
20.1.1 937 12/12/2022
20.1.0 917 12/4/2022
20.0.4 994 11/30/2022
20.0.3 1,045 10/28/2022
20.0.2 1,008 10/26/2022
20.0.1 1,046 10/21/2022
20.0.0 1,080 10/1/2022
19.4.1 1,114 9/10/2022
19.4.0 1,094 9/2/2022
19.3.0 1,067 8/23/2022
19.2.2 1,045 8/11/2022
19.2.1 1,107 8/6/2022
19.2.0 1,084 7/24/2022
19.1.4 1,325 5/23/2022
19.1.3 1,114 5/22/2022
19.1.2 1,194 5/18/2022
19.1.1 1,191 4/28/2022
19.1.0 1,121 4/10/2022
19.0.7 1,183 3/13/2022
19.0.6 1,179 3/7/2022
19.0.5 1,232 1/28/2022
19.0.4 1,185 1/23/2022
19.0.3 1,066 12/14/2021
19.0.2 1,055 12/11/2021
19.0.1 1,407 11/20/2021
19.0.0 1,107 11/11/2021
19.0.0-rc.net60.2 157 9/26/2021
19.0.0-rc.net60.1 207 9/16/2021
18.1.6 1,164 9/26/2021
18.1.5 2,317 9/7/2021
18.1.4 1,101 9/6/2021
18.1.3 1,111 8/19/2021
18.1.2 1,168 8/8/2021
18.1.1 1,173 8/5/2021
18.1.0 1,247 8/1/2021
18.0.1 1,176 7/30/2021
18.0.0 1,170 7/26/2021
17.0.8 1,158 7/7/2021
17.0.7 1,149 6/16/2021
17.0.6 1,112 6/5/2021
17.0.5 1,157 5/28/2021
17.0.4 1,216 5/4/2021
17.0.3 1,203 5/1/2021
17.0.2 1,139 4/22/2021
17.0.1 1,135 4/18/2021
17.0.0 1,156 3/26/2021
16.5.6 1,141 3/25/2021
16.5.5 1,114 3/23/2021
16.5.4 1,153 3/9/2021
16.5.3 1,179 2/26/2021
16.5.2 1,160 2/23/2021
16.5.1 1,149 2/21/2021
16.5.0 1,150 2/17/2021
16.4.5 1,173 2/15/2021
16.4.4 1,153 2/5/2021
16.4.3 1,106 1/27/2021
16.4.2 1,162 1/22/2021
16.4.1 1,144 1/21/2021
16.4.0 1,161 1/11/2021
16.3.3 1,170 1/8/2021
16.3.2 1,183 1/3/2021
16.3.1 1,225 12/31/2020
16.3.0 1,149 12/30/2020
16.2.1 1,200 12/27/2020
16.2.0 1,451 10/13/2020
16.1.5 1,288 10/4/2020
16.1.4 1,280 9/17/2020
16.1.3 1,314 9/13/2020
16.1.2 1,200 9/9/2020
16.1.1 1,230 9/3/2020
16.1.0 1,233 8/19/2020
16.0.3 1,263 8/15/2020
16.0.2 1,217 8/9/2020
16.0.1 1,326 8/8/2020
16.0.0 1,226 8/7/2020
15.3.0 2,130 7/23/2020
15.2.3 1,324 7/14/2020
15.2.2 1,315 5/19/2020
15.2.1 1,269 5/12/2020
15.2.0 1,299 5/9/2020
15.1.1 1,361 5/4/2020
15.1.0 1,389 4/13/2020
15.0.5 1,270 3/18/2020
15.0.4 1,298 2/28/2020
15.0.3 1,292 2/26/2020
15.0.2 1,382 1/20/2020
15.0.1 1,327 1/10/2020
15.0.0 1,355 12/17/2019
14.9.1 1,343 11/30/2019
14.9.0 1,276 11/29/2019
14.8.1 1,308 11/26/2019
14.8.0 1,315 11/20/2019
14.7.0 1,761 10/9/2019
14.6.6 1,260 10/8/2019
14.6.5 1,286 9/27/2019
14.6.4 1,358 9/21/2019
14.6.3 1,728 8/12/2019
14.6.2 1,377 8/3/2019
14.6.1 1,408 8/3/2019
14.6.0 1,383 7/26/2019
14.5.7 1,403 7/18/2019
14.5.6 1,349 7/10/2019
14.5.5 1,366 7/1/2019
14.5.4 1,429 6/17/2019
14.5.3 1,410 6/5/2019
14.5.2 1,382 5/30/2019
14.5.1 1,376 5/28/2019
14.5.0 1,502 5/24/2019
14.4.0 1,452 5/22/2019
14.3.4 1,394 5/14/2019
14.3.3 1,332 5/9/2019
14.3.2 1,557 4/30/2019
14.3.1 1,387 4/27/2019
14.3.0 1,444 4/24/2019
14.2.3 1,458 4/17/2019
14.2.2 1,408 4/10/2019
14.2.1 1,414 4/5/2019
14.2.0 1,445 3/16/2019
14.1.1 1,464 3/8/2019
14.1.0 1,562 2/11/2019
14.0.4 1,563 1/31/2019
14.0.3 1,499 1/22/2019
14.0.2 1,653 12/15/2018
14.0.1 1,563 11/29/2018
14.0.0 1,548 11/19/2018
13.3.0 1,621 11/16/2018
13.2.2 1,574 11/15/2018
13.2.1 1,493 11/13/2018
13.2.0 1,548 10/31/2018
13.1.5 1,499 10/31/2018
13.1.4 1,538 10/25/2018
13.1.3 1,575 10/18/2018
13.1.2 1,708 9/12/2018
13.1.1 1,613 9/11/2018
13.1.0 1,627 9/11/2018
13.0.0 1,617 8/29/2018
12.3.6 1,565 8/29/2018
12.3.5 1,608 8/22/2018
12.3.4 1,670 8/21/2018
12.3.3 26,386 8/21/2018
12.3.2 1,629 8/20/2018
12.3.1 1,664 8/20/2018
12.3.0 1,633 8/20/2018
12.2.2 1,671 8/15/2018
12.2.1 1,724 8/9/2018
12.2.0 1,648 8/8/2018
12.1.11 1,633 7/30/2018
12.1.10 1,703 7/20/2018
12.1.9 1,827 7/10/2018
12.1.8 2,774 7/2/2018
12.1.7 1,816 6/7/2018
12.1.6 1,738 6/4/2018
12.1.5 1,786 6/2/2018
12.1.4 1,735 5/25/2018
12.1.3 2,121 5/16/2018
12.1.2 1,764 5/15/2018
12.1.1 1,891 5/14/2018
12.1.0 1,824 5/9/2018
12.0.7 1,868 5/5/2018
12.0.6 1,726 5/4/2018
12.0.5 1,822 5/3/2018
12.0.4 1,885 4/30/2018
12.0.3 1,860 4/30/2018
12.0.2 1,862 4/27/2018
12.0.1 1,846 4/25/2018
12.0.0 1,737 4/22/2018
11.2.0 1,918 4/11/2018
11.1.0 1,764 4/8/2018
11.0.8 1,833 3/26/2018
11.0.7 1,713 3/20/2018
11.0.6 1,858 3/7/2018
11.0.5 2,008 2/22/2018
11.0.4 1,847 2/14/2018
11.0.3 1,823 2/12/2018
11.0.2 1,831 2/9/2018
11.0.1 1,771 1/29/2018
11.0.0 1,811 1/15/2018
10.0.3 1,823 12/29/2017
10.0.2 1,710 12/26/2017
10.0.1 1,838 12/18/2017
10.0.0 1,745 12/18/2017
9.3.0 1,817 12/17/2017
9.2.0 1,805 12/17/2017
9.1.3 1,833 12/5/2017
9.1.2 1,716 11/27/2017
9.1.1 1,793 11/21/2017
9.1.0 1,707 11/21/2017
9.0.1 1,686 11/11/2017
9.0.0 1,695 11/10/2017
8.7.0 1,721 11/9/2017
8.6.0 1,674 11/9/2017
8.5.0 1,707 10/3/2017
8.4.0 1,753 10/3/2017
8.3.1 2,012 9/8/2017
8.3.0 1,753 9/8/2017
8.2.0 1,731 9/4/2017
8.1.0 1,798 8/22/2017
8.0.0 1,838 8/19/2017
7.1.3 1,724 8/14/2017
7.1.2 1,728 8/2/2017
7.1.1 1,671 7/26/2017
7.1.0 1,733 7/5/2017
7.0.9 1,689 6/28/2017
7.0.8 1,807 6/19/2017
7.0.6 1,757 4/7/2017
7.0.5 1,693 3/21/2017
7.0.4 1,723 3/21/2017
7.0.3 1,711 3/20/2017
7.0.2 1,715 3/13/2017
7.0.0 1,786 3/1/2017
6.2.0 1,790 2/25/2017
6.1.0 1,805 2/14/2017
6.0.0 1,844 2/9/2017
5.3.0 1,744 2/5/2017
5.2.0 1,684 1/26/2017
5.1.0 1,700 1/19/2017
5.0.0 1,728 1/7/2017
4.11.0 1,787 1/5/2017
4.10.0 1,785 12/31/2016
4.9.0 1,706 12/26/2016
4.8.0 3,442 12/17/2016
4.7.0 1,819 12/8/2016
4.6.5 1,744 12/4/2016
4.6.4 1,731 11/25/2016
4.6.2 3,415 11/18/2016
4.6.1 1,794 11/15/2016
4.6.0 1,722 11/11/2016
4.5.9 3,660 11/2/2016
4.5.8 1,880 11/2/2016
4.5.7 3,557 10/26/2016
4.5.6 1,780 10/6/2016
4.5.5 1,773 10/3/2016
4.5.4 1,724 10/2/2016
4.5.3 1,754 9/30/2016
4.5.2 3,508 9/28/2016
4.5.1 3,452 9/28/2016
4.5.0 3,391 9/28/2016
4.4.0 3,534 9/23/2016
4.3.0 1,870 9/22/2016
4.2.0 2,019 9/19/2016
4.1.1 1,769 9/13/2016
4.1.0 1,774 9/13/2016