This documentation is archived and is not being maintained.

ServiceSecurityAuditBehavior Class

Specifies the audit behavior of security events. In general, the security events consist of authentication events such as transport, message or negotiate authentication and authorization event. For more information, seeServiceAuthorizationManager.


Namespace:  System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public sealed class ServiceSecurityAuditBehavior : IServiceBehavior

The ServiceSecurityAuditBehavior type exposes the following members.

Public methodServiceSecurityAuditBehaviorInitializes a new instance of the ServiceSecurityAuditBehavior class.

Public propertyAuditLogLocationGets or sets the location where secure-related event logs are written.
Public propertyMessageAuthenticationAuditLevelGets or sets the type of authentication events to audit at the message level.
Public propertyServiceAuthorizationAuditLevelGets or sets the type of authorization events to audit at the service level.
Public propertySuppressAuditFailureGets or sets a value that indicates whether failure to audit affects the application.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Explicit interface implemetationPrivate methodIServiceBehavior.AddBindingParametersPasses custom data to binding elements to support the contract implementation.
Explicit interface implemetationPrivate methodIServiceBehavior.ApplyDispatchBehaviorProvides the ability to change run-time property values or insert custom extension objects such as error handlers, message or parameter interceptors, security extensions, and other custom extension objects.
Explicit interface implemetationPrivate methodIServiceBehavior.ValidateNot implemented.

The ServiceSecurityAuditBehavior class is used to audit authentication events. When auditing is enabled, either successful or failed authentication attempts (or both) can be audited. The events are written to one of three event logs: application, security, or the default log for the operating system version. The event logs can all be viewed using the Windows Event viewer.

Use this class to specify which event log is written to, as well as kinds of authentication events to write. You can also specify whether to suppress audit failures by setting the SuppressAuditFailure property to false (the default is true).

For more information about auditing security events for applications, see Auditing Security Events.

To specify audit behavior in configuration, use the <serviceSecurityAudit> element.

The following code creates an instance of the ServiceHost class and adds a new ServiceSecurityAuditBehavior to its collection of behaviors.

public static void Main()
    // Get base address from appsettings in configuration.
    Uri baseAddress = new Uri(ConfigurationManager.

    // Create a ServiceHost for the CalculatorService type 
    // and provide the base address.
    using (ServiceHost serviceHost = new 
        ServiceHost(typeof(CalculatorService), baseAddress))
        // Create a new auditing behavior and set the log location.
        ServiceSecurityAuditBehavior newAudit = 
            new ServiceSecurityAuditBehavior();
        newAudit.AuditLogLocation = 
        newAudit.MessageAuthenticationAuditLevel = 
        newAudit.ServiceAuthorizationAuditLevel = 
        newAudit.SuppressAuditFailure = false;
        // Remove the old behavior and add the new.
        // Open the ServiceHostBase to create listeners 
        // and start listening for messages.

        // The service can now be accessed.
        Console.WriteLine("The service is ready.");
        Console.WriteLine("Press <ENTER> to terminate service.");

        // Close the ServiceHostBase to shutdown the service.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.