Configure the BeyondTrust Remote Support SIEM Tool Plugin
Once the plugin has been deployed as described in BeyondTrust Remote Support Middleware Engine Installation and Configuration, the plugin can then be configured and tested.
To begin configuration, launch the Middleware Administration Tool and click the clipboard icon next to the plugin name.
The first portion of the plugin configuration provides the necessary settings for communication between the plugin and the BeyondTrust Appliance. The configuration sections include:
- Plugin Configuration Name: Any desired value. Because multiple configurations can be created for a single plugin, allowing different environments to be targeted, provide a descriptive name to indicate how this plugin is to be used.
- Appliance Id: This can be left as Default or can be given a custom name. This value must match the value configured on the outbound event URL in the BeyondTrust Appliance. If outbound events are not being used, this value is still required, but any value may be used.
- BeyondTrust Appliance Host Name: The hostname of the BeyondTrust Appliance. Do not include
https://or other URL elements.
- BeyondTrust Integration API OAuth Client ID: When using API accounts in BeyondTrust Remote Support 16.2.1 or newer, this field should contain the Client ID of the OAuth account.
- BeyondTrust Integration API OAuth Client Secret: When using API Accounts available in BeyondTrust Remote Support 16.2.1 or newer, this field should contain the client Secret of the OAuth account.
- BeyondTrust Integration API User Name: The username of the API service account created on the BeyondTrust Appliance.
- BeyondTrust Integration API Password: The password of the above user.
- Locale Used for BeyondTrust API Calls: This value directs the BeyondTrust Appliance to return session data in the specified language.
- Disabled: Enable or disable this plugin configuration.
- Allow Invalid Certificates: Leave unchecked unless there is a specific need to allow. If enabled, invalid SSL certificates are allowed in calls performed by the plugin. This would allow, for example, self-signed certificates. This is not recommended in production environments.
- Use Non-TLS Connections: Leave unchecked unless it is the specific goal to use non-secure connections to the BeyondTrust Appliance. If checked, TLS communication is disabled altogether. If non-TLS connections are allowed, HTTP access must be enabled on the BeyondTrust /login > Management > API Configuration page. Using non-secure connections is discouraged.
When using OAuth authentication, TLS cannot be disabled.
- Outbound Events Types: Specify which events the plugin processes when received by the middleware engine. Keep in mind that any event types selected here must also be configured to be sent in BeyondTrust. The middleware engine receives any events configured to be sent in BeyondTrust but passes them off to the plugin only if the corresponding event type is selected in this section.
- Support Session End
- Polling Event Types: If network constraints limit connectivity between the BeyondTrust Appliance and the middleware engine such that outbound events cannot be used, an alternative is to use polling. The middleware engine regularly polls the BeyondTrust Appliance for any sessions that have ended since the last session was processed. At this time, only the Support Session End event type is supported.
- Polling Interval: Enter only if polling is used. This determines how often the middleware engine polls the BeyondTrust Appliance for sessions that have ended.
- Retry Attempt Limit: Enter the number of retries that can be attempted if the plugin fails to process an event.
- Retry Outbound Event Types: Specify which outbound events the plugin retries if it fails to process the event.
- Retry Polling Event Types: Specify which polling events the plugin retries if it fails to process the event.
SIEM Tool Instance
These are the fields and selections needed to configure the plugin for integration with the SIEM tool. Please see the individual SIEM installation guides for guidance on what values to provide.
- Target SIEM System : Select the target SIEM tool from the list.
- SIEM Syslog Host: Enter the hostname or IP address of the SIEM instance that should receive the messages.
- SIEM Syslog Port: Enter the port used by the SIEM instance to receive syslog messages.
- SIEM Syslog Protocol: Select the appropriate protocol from the list.
- Events to Process: BeyondTrust session data can contain many different event types. All types are available; however, a subset may be desired in the SIEM tool. Select only the events you would like sent to the tool. Events matching unchecked event types are ignored.
On the BeyondTrust Middleware Engine server, in the <install dir>\Plugins\<integration>\Templates folder, there are multiple files ending with *.hbs. These files are used by the plugin to format the textual session report and exit surveys that are added to the corresponding ticket each time a BeyondTrust session ends or each time a survey is submitted. The templates can be edited if desired.
If changes need to be made to a template, it is a good idea to first back up the original in case the changes ever need to be reverted.
For additional information on Handlebars templates, see handlebarsjs.com.