Add a Custom Audit Adapter

An audit adapter (or multiple adapters) can be added to or replace the existing ActivID AS audit management.

Note:
  • ActivID AS does not access audit data generated by custom adapters and, therefore, audit records will not be included in search or reporting operations.
  • If you have multiple server nodes, you must install/deploy the audit adapter on each node.
  • At least one instance should be added for the audit adapter to be invoked.
  • Each audit adapter can have multiple instances, and with different parameter values.
  • To enable or disable the default build-in auditing feature on a node, you need to edit the AUDIT_ENABLED setting. This does not disable custom audit adapters.

  1. To create the audit adapter, the ac-4tress-core.jar file (located in the <ACTIVID_HOME>/ActivID_AS/lib folder) needs to be included in the classpath for compilation and runtime.

    2. For further information about developing new adapters, refer to the ActivID AS SDK documentation or contact HID Global Technical Support.

    Important: The custom .jar files must not use existing ActivID AS java package namespaces (that is, the same package used in two different jars – one signed and one unsigned) as the conflict will cause a deployment failure.

  2. Customize the ActivID Authentication Services application WAR/EAR to include the custom audit adapter binary (.jar file):

    1. As root, create a folder called custom under <ACTIVID_HOME>/ActivID_RPM/ac-4tress-srv.
    2. In the new custom folder, create the folder tree corresponding for the new adapter file.

      3. For example, <ACTIVID_HOME>/ActivID_RPM/ac-4tress-srv/custom/lib/

      Important: Do not modify the original file/folder structure of the ActivID AS application EAR/WAR delivery. For further information about customizing the EAR/WAR files, see Customize the ActivID AS WAR/EAR Files .
    3. Add the new audit adapter binary file (for example, dummyaudit.jar).
    4. As root, regenerate the ActivID AS application WAR/EAR files using the following command:
      5. <ACTIVID_HOME>/ActivID_AS/bin/updateSoftware.sh -g
    5. As the application server administrator, deploy the new ActivID AS application WAR/EAR file.
  3. Update the ActivID AS server configuration file, <ACTIVID_HOME>/ActivID_AS/applications/resources/srv/activid_server.properties, with the new adapter:
    1. Locate the #ADAPTER_TYPE_AUDIT: template ADPTR.AUDIT.adptr%nb entry.
    2. Add a line using the next available adapter number for the adapter template (for the first audit adapter, use adptr1) and then the Java implementation class name of your adapter (in the following example, com.test.dummyauditadapter):
    ADPTR.AUDIT.adptr1=com.test.dummyauditadapter

    For further information about adapter definitions, see Adding Adapter Definitions .

  4. Restart the server.
  5. To add an adapter instance, log on to the ActivID Management Console and go to the Configuration tab and, under Environment, select Adapters.
    1. Click Add.

    2. Enter the main information for the adapter:
      • Name – mandatory and should be unique for ease of administration.
      • Description – a user-friendly description of the adapter (optional).
      • Adapter Type – select Audit to send notifications of audit events.
      • Adapter Category – select Dummy Audit Adapter as the definition of the adapter.
    3. Define the Parameters for the adapter.

  1. Click Save to apply the adapter configuration.

For further information, see Configure Adapters.