8 Auditing Administrative and Run-time Events

In Oracle Fusion Middleware, auditing refers to the process of collecting for review specific information related to administrative, authentication, and run-time events. Auditing can help you evaluate adherence to polices, user access controls, and risk management procedures. Auditing provides a measure of accountability and answers to the "who has done what and when" types of questions. Audit data can be used to create dashboards, compile historical data, and assess risks. Analyzing recorded audit data allows compliance officers to perform periodic reviews of compliance policies.

This chapter describes the administrative and run-time events that can be audited for Oracle Access Management services: Access Manager, Security Token Service, Identity Federation, and Mobile and Social. Configuring common auditing settings and validating your auditing configuration is the subject of this chapter. Analyzing and using audit data is outside the scope of this chapter.

Note:

There is nothing specific or separate related to auditing OpenSSO Agents, Mobile and Social, or Identity Context. Unless explicitly stated, information in this chapter is the same for Access Manager, Security Token Service, Identity Federation.

This chapter includes the following topics:

8.2 Introduction to Auditing

Many businesses must now be able to audit identity information and user access on applications and devices. Compliance audits help an enterprise conform with regulatory requirements—Sarbanes-Oxley or the Health Insurance Portability and Accountability Act (HIPAA) are two examples.

Oracle Access Management uses the Oracle Fusion Middleware Common Audit Framework to support auditing for a large number of user authentication and authorization run-time events, and administrative events (changes to the system). The Oracle Fusion Middleware Common Audit Framework provides uniform logging and exception handling and diagnostics for all audit events.

Auditing is based on configuration parameters set in the Oracle Access Management Console which enables data capture for a user or set of users. While auditing can be enabled or disabled, it is normally enabled in production environments. Auditing has minimal performance impact, and the information captured by auditing can be useful (even mission-critical). For details, see "About Oracle Access Management Auditing Configuration" and "Introduction to Auditing for Security Token Service".

Audit data can be written to either a single, centralized Oracle Database instance or to flat files known as bus-stop files.

Note:

The Oracle Fusion Middleware Common Audit Framework database audit store does not include Access Manager policy or session-data and is not configured through the Oracle Access Management Console.

The audit log file helps the audit Administrator track errors and diagnose problems if the audit framework is not working properly. See, "About the Audit Log and Data".

8.2.1 About Oracle Access Management Auditing Configuration

An Administrator controls certain auditing parameters using the Oracle Access Management Console. This auditing configuration is recorded in the file oam-config.xml. Additional auditing configuration is required through the Common Audit Framework.

Note:

Oracle recommends that you use only the Oracle Access Management Console or WebLogic Scripting Tool (WLST) commands for changes; do not edit oam-config.xml.

Event configuration (mapping events to levels) occurs in the component_events.xml. An audit record contains a sequence of items that can be configured to meet particular requirements.

Within the Oracle Access Management Console, you can set the maximum log file and log directory size. Audit policies (known as Filter Presets declare the types of events to be captured by the audit framework for particular components.

Audit policies cannot be configured using Fusion Middleware Control. Oracle Access Management does not use JPS infrastructure to configure the audit configuration. There are no WebLogic Scripting Tool (WLST) commands for auditing.

Note:

There is nothing specific or separate for OpenSSO Agents, Mobile and Social, or Identity Context. Unless explicitly stated, information in this chapter is the same for Access Manager, Security Token Service, Identity Federation.

8.2.2 About Audit Record Storage

Audit data can be written to either a single, centralized Oracle Database instance or to flat files known as bus-stop files.

By default, audit data is recorded to a file. However, Administrators can change the configuration to log audit data to a database. Although the formats differ, audit data content is identical in both the flat file and the database.

Audit Bus-stop: Local files containing audit data records before they are pushed to the audit data store. In the event that no audit data store is configured, audit data remains in these bus-stop files. The bus-stop files are simple text files that can be queried easily to look up specific audit events. When an audit data store is in place, the bus-stop acts as an intermediary between the component and the audit data store. The local files are periodically uploaded to the audit data store based on a configurable time interval.

Bus-stop files for Java components are located in:

$DOMAIN_HOME/servers/$SERVER_NAME/logs/auditlogs/OAM/audit.log 

Bus-stop files for system components are located in:

$ORACLE_INSTANCE/auditlogs/OAM/oam_server1/audit.log

Database Logging: Implements the Common Auditing Framework across a range of Oracle Fusion Middleware products. The benefit is audit-function commonality at the platform level.

Database Audit Store: In production environments, Oracle recommends using a database audit store to provide scalability and high-availability for the Common Audit Framework. Audit data is cumulative and grows over time. Ideally this is a database for only audit data; not used by other applications.

Note:

The preferred mode in production environments is writing audit records to a stand-alone RDBMS database for audit data only.

A key advantage of the audit data store is that audit data from multiple components can be correlated and combined in reports, for example, authentication failures in all Middleware components, instances and so on.

To switch to a database as the permanent store for your audit records, you must first use the Repository Creation Utility (RCU) to create a database schema for audit data. The RCU seeds that database store with the schema required to store audit records in a database. After the schema is created, configuring a database audit store involves:

  • Creating a data source that points to the audit schema you created

  • Configuring the audit store to point to the data source

Figure 8-1 provides a simplified view of the audit architecture with a supported database. The Oracle Fusion Middleware Audit Framework schema for audit log tables is provided by the Repository Creation Utility (RCU), which must be run before you can log information to the database.

Figure 8-1 Audit to Database Architecture

Audit to Database Architecture
Description of "Figure 8-1 Audit to Database Architecture"

An independent audit loader process reads the flat log file and inserts records in the log table of the Oracle database. The audit store allows Administrators to expose audit data with Oracle Business Intelligence Publisher using a variety of out-of-the-box reports.

8.2.3 About Audit Reports and Oracle Business Intelligence Publisher

Oracle Access Management integrates with Oracle Business Intelligence Publisher, which provides a pre-defined set of compliance reports. The data in the database audit store is exposed through pre-defined reports in Oracle Business Intelligence Publisher. These reports allow you to drill down the audit data based on various criteria, such as user name, time range, application type, and execution context identifier (ECID).

Out-of-the-box, there are several sample audit reports available with Oracle Access Management and accessible with Oracle Business Intelligence Publisher. You can also use Oracle Business Intelligence Publisher to create your own custom audit reports.

Oracle BI Enterprise Edition (Oracle BI EE) is a comprehensive set of enterprise business intelligence tools and infrastructure, including a scalable and efficient query and analysis server, an ad-hoc query and analysis tool, interactive dashboards, proactive intelligence and alerts, real-time predictive intelligence, and an enterprise reporting engine.Oracle BI EE is designed to bring greater business visibility and insight to a wide variety of users.

The components of Oracle Business Intelligence Enterprise Edition share a common service-oriented architecture, data access services, analytic and calculation infrastructure, metadata management services, semantic business model, security model and user preferences, and administration tools. Oracle Business Intelligence Enterprise Edition provides scalability and performance with data-source specific optimized analysis generation, optimized data access, advanced calculation, intelligent caching services, and clustering.

See Also:

Using Audit Analysis and Reporting in the Oracle Fusion Middleware Security Guide

For an overview of how to prepare Oracle BI EE for use with auditing reports for Oracle Access Management, see "Preparing Oracle Business Intelligence Publisher EE".

Oracle Business Intelligence Enterprise Edition reports contain enumerated fields, the data fields and labels of which are self- explanatory. Content of reports is described in Table 8-1 (taken from Knowledge Base Doc ID 1495333.1 on My Oracle Support.

Table 8-1 Oracle Business Intelligence Enterprise Edition Reports for OAM

Report Type Description

Account Management

User ID | Timestamp | Component/ Application Name | Event Details

Authentication_Statistics

Authentication_statistics

Failure | Userid | Number of Events

AuthenticationFromIPByUser

IP Address | Distinct User Count | Total Attempts | Users

AuthenticationPerIP

IP Address | Distinct Users | Total Number of Attempts

AuthenticationStatisticsPerServer

Server Instance Name | Success Count | Failure Count

Errors_and_Exceptions

All_Errors_and_Exceptions

User ID | Timestamp | Component/Application Name | Client IP Address | Message Event | Event Details

Authentication_Failures

User ID | Timestamp | Component/ Application Name | Client IP Address | Authentication Method | Message Event Details | Authorization_Failures

Users_Activities

Authentication_History

User ID | Timestamp | Component/ Application Name | Client IP Address | Authentication Method | Message Event Details | Authorization_Failures

Multiple_Logins_From_Same_IP

IP Address | Usernames Used


For more information, see the following topics:

8.2.4 About the Audit Log and Data

An audit log file helps the audit Administrator track errors and diagnose problems when the audit framework is not working properly. An audit log file records several fields including: Date, Time, Initiator, EventType, EventStatus, MessageText, ECID, RID ContextFields, SessionId, TargetComponentType, ApplicationName, and EventCategory to name a few.

See Also:

The topic on audit logs in the chapter on configuring and managing auditing in the Oracle Fusion Middleware Security Guide

8.3 Access Manager Events You Can Audit

This section provides the following topics:

8.3.1 Access Manager Administrative Events You Can Audit

Administrative events are those generated when the Oracle Access Management Console is used.

The Access Manager-specific administrative events that can be audited and the details captured in them are listed in Table 8-2. These event definitions and configurations are implemented as part of the audit service in Oracle Platform Security Services.

Note:

You control the amount and type of information that is logged by choosing a filter preset from the Audit Configuration section.

Auditable events for each filter preset are fixed in the read-only component_events.xml file. Editing or customizing this file is not supported.

Table 8-2 Access Manager Administrative Audit Events

Administrative Event Event Data Include

Oracle Access Management Console Login success/failure

  • User name

  • Remote IP

  • Roles

Authentication Policy Creation

  • Policy name

  • Authentication scheme details

  • Resource details

  • Policy type (authentication or authorization)

Authentication Policy Modification

  • Policy name

  • Authentication scheme details

  • Resource details

  • Policy type (authentication or authorization

  • Old Policy name

  • Old Authentication scheme details

  • Old Resource details

Authentication Policy Removal

  • Policy name

  • Authentication scheme details

  • Resource details

  • Policy type (authentication or authorization

Resource Creation

  • Resource name

  • URI

  • Operation

  • Resource type

Resource Modification

  • Resource name

  • URI

  • Operation

  • Resource type

  • Old Resource name

  • Old URI

  • Old Operation

Resource Removal

  • Resource name

  • URI

  • Operation

  • Resource type

Authentication Scheme Creation

  • Scheme name

  • Authentication modules

  • Level

Authentication Scheme Modification

  • Scheme name

  • Authentication modules

  • Level

  • Old Scheme name

  • Old Authentication modules

  • Old Level

Authentication Scheme Removal (Delete)

  • Scheme name

  • Authentication modules

  • Level

Response Creation

  • Response name

  • Response key

  • Data source

  • Response Type

Response Modification

  • Response name

  • Response key

  • Data source

  • Response Type

  • Old Response name

  • Old Response key

  • Old Data source

Response Removal (Delete)

  • Response name

  • Response key

  • Data source

  • Response Type

Partner Addition

  • Partner name

  • Partner ID

  • Partner URL

  • Logout URL

Partner Modification

  • Partner name

  • Partner ID

  • Partner URL

  • Logout URL

  • Old Partner name

  • Old Partner URL

  • Old Logout URL

Partner Removal

  • Partner name

  • Partner ID

  • Partner URL

  • Logout URL

Conditions creation

  • Condition Name

  • Condition type

  • Condition data

Conditions Modification

  • Condition Name

  • Condition type

  • Condition data

  • Old Condition name

  • Old Condition type

  • Old Condition data

Conditions Removal

  • Condition Name

  • Condition type

  • Condition data

Server Domain creation

  • Domain Name

Server Domain Modification

  • Domain Name

  • Old Domain Name

Server Domain Removal

  • Domain Name

Server configuration change

  • New details

  • Old details

  • Instance Name

  • Application Name

  • User Name

  • Remote ID

  • Roles

  • Date and time


8.3.2 Access Manager Run-time Events You Can Audit

Run-time events are those generated by some of the events the Access Manager component engines issue when interacting with one another.

The run-time events that can be audited, when they are issued, and the details captured in them are listed in Table 8-3. These event definitions and configurations are implemented as part of the audit service in Oracle Platform Security Services.

Note:

You control the amount and type of information that is logged by choosing a filter preset in the Audit Configuration.

Auditable events for each filter preset are fixed in the read-only component_events.xml file. Editing or customizing this file is not supported.

Table 8-3 Access Manager Run-time Audit Events

Run-time Event Issued When Event Details Include

Authentication Attempt

A user attempts to access a protected resource and the request arrives at the SSO server; this event might be followed by the events credential submit and authentication success or failure.

  • Remote IP

  • Resource ID

  • Partner ID

  • Resource ID

  • Authentication scheme ID

  • Authentication Policy ID

Authentication Success

A client submits credentials and credential validation is successful.

  • Remote IP

  • User Name

  • User DN

  • Resource ID

  • Authentication scheme ID

  • Authentication Policy ID

  • Partner ID

Authentication Failure

A client submits credentials and credential validation fails.

  • Remote IP

  • User Name

  • User DN

  • Resource ID

  • Authentication Scheme ID

  • Failure Error Code

  • Retry count

  • Authentication Policy ID

  • Partner ID

Session Creation

Authentication succeeds.

  • SSO Session ID

  • User Name

  • User DN

  • Remote IP

  • Resource ID

  • Authentication scheme ID

  • Authentication Policy ID

Session Destroy

Authentication succeeds.

  • SSO Session ID

  • User Name

  • User DN

  • Partner ID

Login success

A client finishes the login procedure and it is forwarded to the agent.

  • Remote IP

  • User Name

  • User DN

  • Authentication level

  • Resource ID

  • Authentication scheme ID

  • Authentication Policy ID

  • Partner ID

Login failure

A client fails to login; this event is issued only when all the retry authentication attempts allowed have failed or when the account is locked.

  • Remote IP

  • User Name

  • Authentication level

  • Resource ID

  • Authentication scheme ID

  • Authentication Policy ID

  • Partner ID

Logout success

A client finishes the logout procedure and is forwarded to the agent.

  • Remote IP

  • User DN

  • Authentication level

  • SSO Session ID

  • Partner ID

Logout failure

A client fails to logout.

  • Remote IP

  • User DN

  • SSO Session ID

  • Failure details

  • Partner ID

Credential Collection

A client is redirected to the credential collection page.

  • Remote IP

  • Resource Name

  • Resource ID

  • Authentication scheme ID

  • Authentication Policy ID

Credential Submit

A client submits credentials.

  • Remote IP

  • User Name

  • Resource ID

  • Authentication scheme ID

  • Authentication Policy ID

Authorization Success

A client has been authorized to access a resource.

  • Remote IP

  • User DN

  • Resource ID

  • Authorization Policy ID

Authorization Failure

A client has not been authorized to access a resource.

  • Remote IP

  • User DN

  • Resource ID

  • Authorization Policy ID

Server Start Up

The server starts up.

  • Date and time

  • Instance Name

  • Application Name

  • User Name

Server Shut Down

The server shuts down.

  • Date and time

  • Instance Name

  • Application Name

  • User Name


8.3.3 About Authentication Event Auditing

Auditing events during authentication can help Administrators scrutinize security weaknesses in their systems. Information about users requesting authentication or brute force attacks can be stored in the file system or in a back-end database.

The events that an Administrator can configure for auditing during authentication are:

  • Authentication success

  • Authentication failure

  • Create, modify, delete, or view Authentication Policy data

Information related to the user being authenticated include the following:

  • IP address

  • Browser type

  • User Login ID

  • Time of Access

Note:

Oracle recommends that you avoid auditing, logging, or tracing sensitive user attributes, such as user passwords.

8.4 Identity Federation Events You Can Audit

Identity Federation uses the Fusion Middleware Audit Framework for auditing. This section provides an overview of events that are audited, and how to configure auditing for Identity Federation.

The following data is part of each audit record, regardless of the event or event type that is audited:

  • timestamp - Date and time the audit event occurred

  • initiator - the initiator of the audit event (for some events this attribute may be empty)

  • ECID - the execution context ID

Fusion Middleware Audit Framework supports the following audit levels:

  • None

  • Low

  • Medium

  • Custom

This section lists the events that you can audit in different categories, and audit levels. Table 8-4 lists events categories and where these are described in this chapter.

Table 8-4 Categories of Audit Events for Identity Federation

Category Described in ...

Session Management

Session Management Events for Identity Federation

Protocol Flow

Protocol Flow Events for Identity Federation

Server Configuration

Server Configuration Events for Identity Federation

Security

Security Events for Identity Federation


See Also:

Oracle Fusion Middleware Administrator's Guide for Oracle Identity Federation chapter on "Diagnostics and Auditing" for greater detail

8.4.1 Session Management Events for Identity Federation

Session Management events for this Identity Federation release, include a subset of auditable events for the previous release. For attributes of each event, see "Session Management Events" in Oracle Fusion Middleware Administrator's Guide for Oracle Identity Federation.

Table 8-5 Identity Federation Session Management Events

Auditable Events Auditing Not Supported in This Release for ...

CreateUserSession –

Creation of a session after a successful login

CreateUserFederation –

Creation of a user federation between two remote servers

DeleteUserSession –

Deletion of a session after logout

UpdateUserFederation -

Updating the user federation between two remote servers

CreateActiveUserFederation –

Creation of an active federation after successful login

DeleteUserFederation –

Deletion of a user federation between two remote servers

CreateActiveUserFederation –

Creation of an active federation after successful login

 

DeleteActiveUserFederation -

Deletion of an active federation after logout

 

LocalAuthentication –

Authentication of a user at OIF

 

LocalLogout - Logout of a user at Identity Federation

 

8.4.2 Protocol Flow Events for Identity Federation

Protocol flow events for this Identity Federation release, include a subset of auditable events for the previous Identity Federation release. For attributes of each event, see "Protocol Flow Events" in Oracle Fusion Middleware Administrator's Guide for Oracle Identity Federation.

Table 8-6 Protocol Flow Events for Identity Federation

Auditable Events Auditing Not Supported in This Release for ...

IncomingMessage

Message being received by Identity Federation

AssertionCreation

Creation of an assertion by Identity Federation (Success only

OutgoingMessage

Message being sent by Identity Federation (Success only)

 

AssertionConsumption

Consumption of an assertion by Identity Federation (Success only)

 

8.4.3 Server Configuration Events for Identity Federation

Auditable Server configuration events for this Identity Federation release, include a subset of auditable events for the previous Identity Federation release. For attributes of each event, see "Server Configuration Events" in Oracle Fusion Middleware Administrator's Guide for Oracle Identity Federation.

Table 8-7 Server Configuration Identity Federation

Auditable Events Auditing Not Supported in This Release for ...

CreateConfigProperty

Adding a new configuration property (Success only)

SetDataStoreType

Changing the type of a data store (Success only)

ChangeConfigProperty

Changing the value of an existing configuration property (Success only)

ChangeDataStore

Setting of the federation data store (Success only)

DeleteConfigProperty

Deleting a configuration property (Success only)

 

CreatePeerProvider

Adding a new provider to the list of trusted providers (Success only)

 

UpdatePeerProvider

Updating the information on an existing provider in the list of trusted providers (Success only) PeerProviderID

 

DeletePeerProvider

Deleting a provider from the list of trusted providers (Success only)

 

LoadMetadata

Loading of metadata (Success only)

 

ChangeFederation

Changing of the trusted providers (Success only)

 

ChangeServerProperty

Changing of a server configuration property (Success only)

 

8.4.4 Security Events for Identity Federation

Auditable security events for this Identity Federation release, include all auditable events for the previous Identity Federation release. For attributes of each event, see "Security Events" in Oracle Fusion Middleware Administrator's Guide for Oracle Identity Federation.

Table 8-8 Security Events for Identity Federation

Auditable Events Auditing Not Supported in This Release for ...

CreateSignature

Creation of a digital signature by Identity Federation

n/a

VerifySignature

Verification of a digital signature by Identity Federation

 

EncryptData

Encryption of data by Identity Federation

 

DecryptData

Decryption of data by Identity Federation

 

8.5 Security Token Service Events You Can Audit

Security Token Service provides an independent audit configuration file, component_events.xml, that defines specific event types and events to audit.

This section provides the following topics:

8.5.1 About Audit Record Content Common to All Events

The following data is part of each audit record, regardless of the event or event type that is audited:

  • Date and time of event

  • IP address of the client initiating event

  • Client identity

  • Processing time for the event

8.5.2 Security Token Service Administrative Events You Can Audit

Security Token Service administrative events fall into several configuration management operations defined in component_events.xml. See details in Table 8-9.

Table 8-9 Security Token Service Configuration Management Operations

Security Token Service Configuration Operations Description

Common Attributes

  • OldSettings: The string representing the previous settings before the change was applied.

  • NewSettings: The string representing the new settings.

  • TemplateID: The ID of the Validation or Issuance Template being created or updated or deleted.

  • ProfileID: The ID of the Partner Profile being created or updated or deleted.

  • PartnerID: The ID of the Partner being created or updated or deleted.

  • SettingsID: The ID of the generic settings being created or updated or deleted.

Create Validation Template

Audit event recorded for the creation of a Validation Template referenced by CreateValidationTemplate.

Attributes:

  • TemplateID

  • NewSettings

Update Validation Template

Audit event recorded for the update of a Validation Template referenced by UpdateValidationTemplate.

Attributes:

  • TemplateID

  • OldSettings

  • NewSettings

Delete Validation Template

Audit event recorded for the delete event of a Validation Template referenced by DeleteValidationTemplate.

Attributes:

  • TemplateID

  • OldSettings

Create Issuance Template

Audit event recorded for the creation of an Issuance Template referenced by CreateIssuanceTemplate.

Attributes:

  • TemplateID

  • NewSettings

Update Issuance Template

Audit event recorded for the update of an Issuance Template referenced by UpdateIssuanceTemplate.

Attributes:

  • TemplateID

  • OldSettings

  • NewSettings

Delete Issuance Template

Audit event recorded for the delete event of an Issuance Template referenced by DeleteIssuanceTemplate.

Attributes:

  • TemplateID

  • OldSettings

Create Partner Profile

Audit event recorded for the creation of Partner Profile referenced by CreatePartnerProfile.

Attributes:

  • ProfileID

  • NewSettings

Update Partner Profile

Audit event recorded for the update of a Partner Profile referenced by UpdatePartnerProfile.

Attributes:

  • ProfileID

  • OldSettings

  • NewSettings

Delete Partner Profile

Audit event recorded for the delete event of Partner Profile referenced by DeletePartnerProfile.

Attributes:

  • ProfileID

  • OldSettings

Create Partner

Audit event recorded for the creation of Partner Profile referenced by CreatePartner.

Attributes:

  • PartnerID

  • NewSettings

Update Partner

Audit event recorded for the update of a Partner Profile referenced by UpdatePartner.

Attributes:

  • PartnerID

  • OldSettings

  • NewSettings

Delete Partner

Audit event recorded for the delete event of Partner Profile referenced by DeletePartner.

Attributes:

  • PartnerID

  • OldSettings

Generic Admin Creation

Audit event recorded for the generic create administrative operation referenced by GenericAdminCreation.

Attributes:

  • SettingsID

  • NewSettings

Generic Admin Update

Audit event recorded for the update of a generic update administrative operation referenced by GenericAdminUpdate.

Attributes:

  • SettingsID

  • OldSettings

  • NewSettings

Generic Admin Removal

Audit event recorded for generic delete administrative operation referenced by GenericAdminDeletion.

Attributes:

  • SettingsID

  • OldSettings


8.5.3 Security Token Service Run-time Events You Can Audit

Security Token Service-specific run-time events for token operations are defined in component_events.xml. See details in Table 8-10.

Table 8-10 Security Token Service-specific Run-time Events

Token Operations Description

Common Attributes

  • Requester: Who made the request by sending the RST

  • RelyingParty: The one for whom the token is created

  • UserID: End user identity

  • TokenType: Either SAML11, SAML20, Username, X.509, Kerberos, OAM or Custom

  • Token: The XML value of the token

  • TokenContext: The Context data passed for token operations

  • Message: The XML representation of the incoming or outgoing message

Incoming Message

Incoming RSTR message received by Security Token Service referenced by OutgoingMessage.

Attributes populated for this event, if available:

  • Requester

  • RelyingParty

  • Message

Outgoing Message

Outgoing RSTR message received by Security Token Service referenced by IncomingMessage.

Attributes populated for this event, if available:

  • Requester

  • RelyingParty

  • Message

Token Validation

Audit event for token validation in Security Token Service referenced by TokenValidation. The status attribute indicates whether or not the validation operation was successful.

Attributes populated for this event, if available:

  • Requester

  • RelyingParty

  • Token

  • TokenType

  • TokenContext

  • Status

Token Generation

Audit event for token generation in Security Token Service referenced by TokenGeneration.

Attributes populated for this event, if available:

  • Requester

  • RelyingParty

  • Token

  • TokenType

  • TokenContext

  • UserID

LDAP User Authentication

Audit event for local user authentication with the LDAP Directory referenced by LDAPUserAuthentication.

Attributes populated for this event, if available:

  • UserID

  • Status

Generic Runtime Operation

Audit event for a generic operation performed by Security Token Service referenced by GenericRuntimeOperation

Attributes populated for this event, if available:

  • OperationType: type of operation

  • OperationData: string representing context of the operation


8.6 Setting Up Auditing for Oracle Access Management

The following overview provides a list of the tasks that must be performed before you can perform auditing for Oracle Access Management.

Task overview: Configuring auditing

  1. Set up the audit data store, as described in "Setting Up the Audit Database Store".

  2. Set up publishing for audit reports, as described in "Preparing Oracle Business Intelligence Publisher EE".

  3. Edit the Audit Configuration in the Oracle Access Management Console, as described in:

  4. Confirm that auditing is working as desired; see: "Validating Auditing and Reports".

8.6.1 Setting Up the Audit Database Store

This topic provides an overview of the tasks required to create the audit database and extend the schema using the Repository Creation Utility (RCU). This task is required before you can audit events for Oracle Access Management if you choose a database store for audit data.

See Also:

Task overview: Creating the database audit store

  1. Create an audit database, version 11.1.0.7 or later, as described in he Oracle Fusion Middleware Application Security Guide.

  2. Run the Oracle Repository Creation Utility (RCU) against the database, as described in "Create the Audit Schema using RCU" in the Oracle Fusion Middleware Repository Creation Utility User's Guide.

  3. Set up audit data sources for the audit loader and configure it for the OAM Server as described in "Set Up Audit Data Sources" in the Oracle Fusion Middleware Application Security Guide:

    • Use the Java EE audit loader configuration for WebLogic Server.

    • Use the JNDI name of the data source jdbc/AuditDB that points to the database that was set up in step 2 above.

  4. In the service instance specified in the domain file (DOMAIN_HOME/config/fmwconfig/jps-config.xml), enable database auditing by changing the value of the property audit.loader.repositoryType to DB. For example:

    <serviceInstance name="audit" provider="audit.provider">
      <property name="audit.filterPreset" value="None"/>
      <property name="audit.maxDirSize" value ="0"/>
      <property name="audit.maxFileSize" value ="104857600"/>
      <property name="audit.loader.jndi" value="jdbc/AuditDB"/>
      <property name="audit.loader.interval" value="15" />
      <property name="audit.loader.repositoryType" value="DB" />
    </serviceInstance>
    
  5. Restart the WebLogic Server.

  6. Ensure that the audit loader is configured for the OAM Server and that it points to the proper database, as described in "Configure a Database Audit Store for Java Components" in the Oracle Fusion Middleware Application Security Guide.

  7. Maintain the bus-stop files, as described in "Tuning the Bus-stop Files" in the Oracle Fusion Middleware Application Security Guide.

8.6.2 Preparing Oracle Business Intelligence Publisher EE

You must prepare Oracle Business Intelligence Publisher Enterprise Edition (EE) for use with Oracle Access Management audit reports as outlined in the following procedure.

See Also:

  • Oracle Fusion Middleware Metadata Repository Builder's Guide for Oracle Business Intelligence Enterprise Edition

  • Oracle Fusion Middleware Developer's Guide for Oracle Business Intelligence Enterprise Edition

  • Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Enterprise Edition

Task overview: Prepare Oracle BI Publisher

  1. Install Oracle BI Publisher, as described in the Oracle Business Intelligence Enterprise Edition Installation and Upgrade Guide.

  2. Perform tasks as described in "Set Up Oracle Reports in Oracle Business Intelligence Publisher" in the Oracle Fusion Middleware Application Security Guide:

    • Unjar the AuditReportTemplate.jar into your Reports folder.

    • Set up the JNDI connection for the audit data source or the JDBC connection the audit database.

  3. Set up audit report templates, as described in the section "Set Up Audit Report Templates" of the Oracle Fusion Middleware Application Security Guide.

  4. Set up audit report filters, as described in the section "Set Up Audit Report Filters" of the Oracle Fusion Middleware Application Security Guide.

  5. View reports from the following path: Reports/Oracle_Fusion_Middleware_Audit reports.

8.6.3 About Auditing Configuration Using Oracle Access Management Console

Within Oracle Access Management, certain Audit Configuration settings are accessible as Common Settings under the System Configuration. These settings are not required when you audit to a database. Figure 8-2 shows the Audit Configuration section of the Common Settings page.

Figure 8-2 Common Settings: Auditing Configuration

Common Settings: Auditing Configuration
Description of "Figure 8-2 Common Settings: Auditing Configuration"

The Auditing section provides settings for the Log Directory, Filter Settings, and Audit Configuration Users.

Note:

The actual log directory cannot be configured using the Oracle Access Management Console. It is the default directory for the Common Audit Framework audit loader. Changing the directory impacts the audit loader and is not supported.

Table 8-11 describes the elements in the Audit Configuration page.

Table 8-11 Audit Configuration Elements

Elements Description

Maximum Directory Size

The maximum size, in MBs, of the directory that contains audit output files. For example, assuming that the maximum file size is 10, a value of 100 for this parameter implies that the directory allows a maximum of 10 files. Once the maximum directory size is reached, the audit logging stops.

For example, a value of 100 specifies a maximum of 10 files if the file size is 10 MB. If the size exceeds this, the creation of audit logs stops.

This is configured using the max.DirSize property described in the configuration filejps-config.xml. This property controls the maximum size of a bus-stop directory for Java components as described in the Oracle Fusion Middleware Application Security Guide.

Maximum File Size

The maximum size, in MBs, of an audit log file. Once the size of a file reaches the maxi mum size, a new log file is created. For example, specifying 10 directs file rotation when the file size reaches 10 MB.

This is configured using the max.fileSize property described in the configuration filejps-config.xml. This property controls the maximum size of a bus-stop file for Java components as described in the Oracle Fusion Middleware Application Security Guide.

Filter Enabled

Check this box to enable event filtering.

Filter Preset

Defines the amount and type of information that is logged when the filter is enabled. The default value is Low.

  • All: captures and records all auditable OAM events

  • Low: captures and records a specific set of auditable OAM events

  • Medium: captures and records events covered by the Low setting plus a number of other auditable OAM events

  • None: no OAM events are captured and recorded

Events for each filter preset are fixed in the read-only component_events.xml file. Editing or customizing this file is not supported for Oracle Access Management. Only items that are configured for auditing at the specified filter preset can be audited.

Users

Specifies the list of users whose actions are included only when the filter is enabled. All actions of the special users are audited regardless of the filter preset. Administrators can add, remove or edit special users from this table.


8.6.4 Adding, Viewing, or Editing Audit Settings

The Administrator controls the amount and type of information that is logged by choosing a filter preset from the Audit Configuration tab on the OAM Server Common Properties page. Auditable events for each filter preset are fixed in the read-only component_events.xml file. Editing or customizing this file is not supported.

The following procedure describes how to add, view, or edit OAM Server Common Audit Configuration settings. Individual audit policies cannot be configured using Fusion Middleware Control. Oracle Access Management does not use JPS infrastructure to configure the audit configuration. There are no WebLogic Scripting Tool (WLST) commands for auditing.

To view or edit auditing configuration in the Oracle Access Management Console

  1. From the Oracle Access Management Console System Configuration tab, Common Configuration section, double-click Common Settings in the navigation tree.

  2. In the Audit Configuration section, enter appropriate details for your environment (Table 8-11):

    • Maximum Log directory size

    • Maximum Log file size

    • Filter Enabled

    • Filter Preset (to define verbosity of audit data)

    • Users to include specific users from the audit by clicking the Add (+) button above the Users table and entering a value in the field.

  3. Click Apply to submit the Audit Configuration (or close the page without applying changes).

  4. Restart AdminServer and OAM Servers after changes are applied.

8.7 Validating Auditing and Reports

You can use the following procedure to test your run-time event auditing configuration.

Prerequisites

To validate your auditing configuration

  1. Authentication Event: Audit Console login success/failure as described here or any administrative event described in Table 8-2, "Access Manager Administrative Audit Events".

    1. Sign out of Oracle Access Management Console.

    2. Sign in to Oracle Access Management Console with invalid user (not Administrator) credentials.

    3. Sign in to Oracle Access Management Console using the proper Administrator credentials.

    4. Review Log File: Open the audit.log file and search for the last Administrative event entries:

      $DOMAIN_HOME/servers/$ADMINSERVER_NAME/logs/auditlogs/OAM/audit.log 
      
    5. Review Database Log:

      1. Perform tasks in "Setting Up the Audit Database Store".

      2. Generate an Authentication event as described in Step 1.

      3. Connect to the database and connecting to the database and reviews audit events under IAU_BASE table.

  2. Runtime Event: Audit Authorization success/failure as described here or any runtime event described in Table 8-3, "Access Manager Run-time Audit Events".

    1. In a browser window, enter the URL of a protected resource for which you are not authorized.

    2. Review Log File: Open the audit.log file and search for the last Administrative event entries:

      $$DOMAIN_HOME/servers/$ADMINSERVER_NAME/logs/auditlogs/OAM/audit.log 
      
    3. Review Database Log:

      1. Perform tasks in "Setting Up the Audit Database Store".

      2. Generate and Authentication event as described in Step 1.

      3. Connect to the database and connecting to the database and reviews audit events under IAU_BASE table.

  3. Audit Configuration Changes: See Also "Adding, Viewing, or Editing Audit Settings".

    1. From the Oracle Access Management Console, System Configuration tab, Common Configuration, modify Maximum Directory Size (MB) and Maximum File Size (MB) parameters.

    2. Repeat Steps here to confirm auditing is working.

  4. View Reports:

    1. Sign in to Oracle BI EE. For example:

      http://host:port/xmlpserver

      Here, host is the computer hosting Oracle BI Publisher; port is the listening port for BI Publisher; xmlpserver is the login page for BI Publisher.

    2. In Oracle BI Publisher Enterprise, locate the desired reports. For example:

      Click Shared Folders, click Oracle_Fusion_Middleware_Audit, click Component_Specific, click Oracle_Access_Manager, and then select the desired report, as shown:

      Oracle BI Publisher Reports Page
    3. Perform any analysis as desired, or edit your auditing configuration as needed.

      /Middleware_home/user_projects/domains/base_domain/servers/oam_server1/logs/ 
      auditlogs/OAM/
      
  5. Archive and manage audit logs according to your company policies.