WebSuccessAuditEvent Class
Provides information about successful security events.
Assembly: System.Web (in System.Web.dll)
'Declaration <AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _ <AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _ Public Class WebSuccessAuditEvent _ Inherits WebAuditEvent 'Usage Dim instance As WebSuccessAuditEvent
ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. The System.Web.Management namespace contains the health event types responsible for packaging application health-status data and the provider types responsible for processing this data. It also contains supporting types that help during the management of health events.
The WebSuccessAuditEvent class is used when a successful security-related operation occurs. An example of this is a successful URL authorization for a Web request.
The following list describes the features for which events of type WebSuccessAuditEvent are raised by ASP.NET:
File Authorization. Successful conditions are audited. File authorization is only attempted by ASP.NET when a Windows Identity is associated with the request. The related event audit code is AuditFileAuthorizationSuccess.
URL Authorization. It signifies access of a URL resource for which authorization is granted. Successful conditions are audited. The related event audit code is AuditUrlAuthorizationSuccess.
Other security conditions. The following is a list of the related event codes:
When a WebSuccessAuditEvent is raised, ASP.NET health monitoring increments the related Audit Success Events Raised performance counter and then checks the healthMonitoring configuration to determine whether any providers subscribe to the event. If providers subscribe to the event, ASP.NET dispatches the event to them for processing.
Note: |
|---|
To view the Audit Success Event Raised performance counter in System Monitor (PerfMon), in the Add Counters window select ASP.NET from the Performance object drop-down list, select the Audit Success Event Raised performance counter, and click the Add button. For more information, see Monitoring ASP.NET Application Performance. |
Because success audits represent an expected condition, you may not want to subscribe to them. You can subscribe to them in order to provide access auditing for the site.
Note: |
|---|
In most cases you will be able to use the ASP.NET health-monitoring types as implemented, and you will control the health-monitoring system by specifying values in the healthMonitoring configuration section. You can also derive from the health-monitoring types to create your own custom events and providers. For an example of deriving from the WebSuccessAuditEvent class, see the example provided in this topic. |
The following code example shows how to derive from the WebSuccessAuditEvent class to create a custom audit event.
Imports System Imports System.Text Imports System.Web Imports System.Web.Management ' Implements a custom WebSuccessAuditEvent class. Public Class SampleWebSuccessAuditEvent Inherits System.Web.Management.WebSuccessAuditEvent Private customCreatedMsg, customRaisedMsg As String ' Invoked in case of events identified only by their event code. Public Sub New(ByVal msg As String, _ ByVal eventSource As Object, ByVal eventCode As Integer) MyBase.New(msg, eventSource, eventCode) ' Perform custom initialization. customCreatedMsg = String.Format("Event created at: {0}", _ DateTime.Now.TimeOfDay.ToString()) End Sub 'New ' Invoked in case of events identified by their event code.and ' event detailed code. Public Sub New(ByVal msg As String, ByVal eventSource As Object, _ ByVal eventCode As Integer, ByVal detailedCode As Integer) MyBase.New(msg, EventSource, eventCode, detailedCode) ' Perform custom initialization. customCreatedMsg = String.Format("Event created at: {0}", _ DateTime.Now.TimeOfDay.ToString()) End Sub 'New ' Raises the SampleWebSuccessAuditEvent. Public Overrides Sub Raise() ' Perform custom processing. customRaisedMsg = String.Format("Event raised at: {0}", _ DateTime.Now.TimeOfDay.ToString()) ' Raise the event. WebBaseEvent.Raise(Me) End Sub 'Raise ' Obtains the current thread information. Public Function GetRequestInformation() As WebRequestInformation ' No customization allowed. Return RequestInformation End Function 'GetRequestInformation 'Formats Web request event information. 'This method is invoked indirectly by the provider using one of the 'overloaded ToString methods. Public Overrides Sub FormatCustomEventDetails(ByVal formatter _ As WebEventFormatter) MyBase.FormatCustomEventDetails(formatter) ' Add custom data. formatter.AppendLine("") formatter.IndentationLevel += 1 formatter.AppendLine("**SampleWebSuccessAuditEvent Start **") formatter.AppendLine(String.Format("Request path: {0}", _ RequestInformation.RequestPath)) formatter.AppendLine(String.Format("Request Url: {0}", _ RequestInformation.RequestUrl)) ' Display custom event timing. formatter.AppendLine(customCreatedMsg) formatter.AppendLine(customRaisedMsg) formatter.AppendLine("** SampleWebSuccessAuditEvent End **") formatter.IndentationLevel -= 1 End Sub 'FormatCustomEventDetails End Class 'SampleWebSuccessAuditEvent
The following example is an excerpt of the configuration file that enables ASP.NET health monitoring to use the event.
<healthMonitoring
..enabled="true"
..heartBeatInterval="0">
<providers>
<add name="EventLogProvider"
type="System.Web.Management.EventLogWebEventProvider,
System.Web,Version=2.0.3600.0,Culture=neutral,
PublicKeyToken=b03f5f7f11d50a3a"/>
</providers>
<eventMappings>
<add name="SampleWebSuccessAuditEvent"
type="SamplesAspNet.SampleWebSuccessAuditEvent,
websuccessauditevent,Version=1.0.1663.31140,
Culture=neutral,
PublicKeyToken=0d1fa0f69d94de96,
processorArchitecture=MSIL"/>
</eventMappings>
<rules>
<add name="Custom Failure Audit Default"
eventName=" SampleWebFailureAuditEvent "
provider="EventLogProvider"
profile="Default"/>
</rules>
</healthMonitoring>
- AspNetHostingPermission
for operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.
- AspNetHostingPermission
for operating in a hosted environment. Demand value: InheritanceDemand; Permission value: Minimal.
System.Web.Management.WebBaseEvent
System.Web.Management.WebManagementEvent
System.Web.Management.WebAuditEvent
System.Web.Management.WebSuccessAuditEvent
System.Web.Management.WebAuthenticationSuccessAuditEvent
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note: