Collect SecureAuth Identity Platform logs
This document explains how to ingest SecureAuth Identity Platform logs to Google Security Operations using the Bindplane agent.
SecureAuth Identity Platform is a single sign-on and identity management solution that generates syslog messages for authentication events, session activity, access control decisions, and audit trails. The parser extracts fields from syslog and XML-formatted logs using grok patterns and maps them to the Unified Data Model (UDM).
Before you begin
Make sure you have the following prerequisites:
- A Google SecOps instance
- Windows Server 2016 or later, or Linux host with
systemd - Network connectivity between the Bindplane agent and the SecureAuth Identity Platform
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- Privileged access to SecureAuth
Get Google SecOps ingestion authentication file
- Sign in to the Google SecOps console.
- Go to SIEM Settings > Collection Agents.
- Download the Ingestion Authentication File.
Save the file securely on the system where Bindplane will be installed.
Get Google SecOps customer ID
- Sign in to the Google SecOps console.
- Go to SIEM Settings > Profile.
Copy and save the Customer ID from the Organization Details section.
Install the Bindplane agent
Install the Bindplane agent on your Windows or Linux operating system according to the following instructions.
Windows installation
- Open Command Prompt or PowerShell as an administrator.
Run the following command:
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quietWait for the installation to complete.
Verify the installation by running:
sc query observiq-otel-collectorThe service should show as RUNNING.
Linux installation
- Open a terminal with root or sudo privileges.
Run the following command:
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.shWait for the installation to complete.
Verify the installation by running:
sudo systemctl status observiq-otel-collectorThe service should show as active (running).
Additional installation resources
For additional installation options and troubleshooting, see the Bindplane agent installation guide.
Configure the syslog and send to Google SecOps
Locate the configuration file
Linux:
sudo nano /opt/observiq-otel-collector/config.yamlWindows:
notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
Edit the configuration file
Replace the entire contents of
config.yamlwith the following configuration:receivers: udplog: listen_address: "0.0.0.0:514" exporters: chronicle/secureauth_sso: compression: gzip creds_file_path: '/etc/bindplane-agent/ingestion-auth.json' customer_id: '<customer_id>' endpoint: malachiteingestion-pa.googleapis.com log_type: SECUREAUTH_SSO raw_log_field: body service: pipelines: logs/secureauth_sso_to_chronicle: receivers: - udplog exporters: - chronicle/secureauth_sso
Configuration parameters
Replace the following placeholders:
Receiver configuration:
listen_address: IP address and port to listen on:0.0.0.0to listen on all interfaces (recommended)- Port
514is the standard syslog port (requires root on Linux; use1514for non-root)
Exporter configuration:
creds_file_path: Full path to ingestion authentication file:- Linux:
/etc/bindplane-agent/ingestion-auth.json - Windows:
C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- Linux:
customer_id: Customer ID copied from the Google SecOps consoleendpoint: Regional endpoint URL:- US:
malachiteingestion-pa.googleapis.com - Europe:
europe-malachiteingestion-pa.googleapis.com - Asia:
asia-southeast1-malachiteingestion-pa.googleapis.com - See Regional Endpoints for complete list
- US:
Save the configuration file
- After editing, save the file:
- Linux: Press
Ctrl+O, thenEnter, thenCtrl+X - Windows: Click File > Save
- Linux: Press
Restart the Bindplane agent to apply the changes
To restart the Bindplane agent in Linux, run the following command:
sudo systemctl restart observiq-otel-collectorVerify the service is running:
sudo systemctl status observiq-otel-collectorCheck logs for errors:
sudo journalctl -u observiq-otel-collector -f
To restart the Bindplane agent in Windows, choose one of the following options:
Command Prompt or PowerShell as administrator:
net stop observiq-otel-collector && net start observiq-otel-collectorServices console:
- Press
Win+R, typeservices.msc, and press Enter. - Locate observIQ OpenTelemetry Collector.
- Right-click and select Restart.
Verify the service is running:
sc query observiq-otel-collectorCheck logs for errors:
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
- Press
Configure SecureAuth Identity Platform
- Sign in to the SecureAuth Identity console as an administrator.
- Select Logs.
- Provide the following configuration details in the Log options section:
- Log instance ID: Enter the log instance ID, the Application Name or the realm name (for example,
SecureAuth1). - Audit logs: Select the Syslog checkbox.
- Error logs: Select the Syslog checkbox.
- Syslog Server: Enter the IP address of your Bindplane agent.
- Syslog Port: Enter the Bindplane agent port number (for example,
514). - Syslog RFC spec: Select RFC 5424.
- Log instance ID: Enter the log instance ID, the Application Name or the realm name (for example,
- Click Save.
UDM mapping table
| Log field | UDM mapping | Logic |
|---|---|---|
| action_msg | read_only_udm.target.process.command_line | Value of action_msg field |
| Appliance | read_only_udm.principal.domain.name | Value of Appliance field |
| Appliance | read_only_udm.target.administrative_domain | Value of Appliance field |
| BrowserSession | read_only_udm.network.session_id | Value of BrowserSession field |
| cat | read_only_udm.metadata.product_event_type | Value of cat field |
| Category | read_only_udm.metadata.product_event_type | Value of Category field |
| cn1 | security_result.severity | Mapped based on the value of cn1 when cn1Label is 'Priority': 1 - HIGH, 2 - MEDIUM, 3 or 4 - LOW |
| Company | read_only_udm.additional.fields.value.string_value | Value of Company field |
| cs1 | read_only_udm.network.session_id | Value of cs1 field when cs1Label is 'BrowserSession' |
| cs3 | read_only_udm.additional.fields.value.string_value | Value of cs3 field when cs3Label is 'CompanyName' |
| dst | read_only_udm.target.ip | Value of dst field |
| domain | read_only_udm.principal.domain.name | Value of domain field |
| dvc | read_only_udm.intermediary.ip | Value of dvc field |
| EventID | read_only_udm.metadata.product_log_id | Value of EventID field |
| HostName | read_only_udm.principal.hostname | Value of HostName field when grok fails to match IP address |
| HostName | read_only_udm.principal.ip | Value of HostName field when grok matches IP address |
| ip | read_only_udm.principal.ip | Value of ip field |
| Message | read_only_udm.metadata.description | Value of Message field |
| Message | security_result.description | Value of Message field |
| nat_ip | read_only_udm.principal.nat_ip | Value of nat_ip field |
| Priority | security_result.severity | Mapped based on the value of Priority: 1 - HIGH, 2 - MEDIUM, 3 or 4 - LOW |
| SAMLConsumerURL | read_only_udm.target.url | Value of SAMLConsumerURL field |
| sec_msg | security_result.description | Value of sec_msg field |
| SecureAuthIdPAppliance | read_only_udm.target.administrative_domain | Value of SecureAuthIdPAppliance field |
| SecureAuthIdPApplianceMachineName | read_only_udm.target.hostname | Value of SecureAuthIdPApplianceMachineName field |
| SecureAuthIdPDestinationSiteUrl | read_only_udm.target.url | Value of SecureAuthIdPDestinationSiteUrl field |
| SecureAuthIdPProductType | read_only_udm.additional.fields.value.string_value | Value of SecureAuthIdPProductType field |
| session | read_only_udm.network.session_id | Value of session field |
| spid | read_only_udm.target.process.pid | Value of spid field |
| src | read_only_udm.principal.ip | Value of src field |
| suser | read_only_udm.target.user.userid | Value of suser field |
| UserAgent | read_only_udm.network.http.user_agent | Value of UserAgent field |
| UserHostAddress | read_only_udm.principal.nat_ip | Value of UserHostAddress field |
| UserHostAddress | read_only_udm.target.ip | Value of UserHostAddress field |
| UserID | read_only_udm.principal.user.userid | Value of UserID field |
| Version | read_only_udm.metadata.product_version | Value of Version field |
| read_only_udm.additional.fields.key | Hardcoded value - 'CompanyName' | |
| read_only_udm.additional.fields.key | Hardcoded value - 'Company' | |
| read_only_udm.additional.fields.key | Hardcoded value - 'SecureAuthIdPProductType' | |
| read_only_udm.extensions.auth.type | Hardcoded value - 'SSO' | |
| read_only_udm.metadata.event_type | 'USER_LOGIN' if SecureAuthIdPAuthGuiMode == 0 and auth_result == Success, 'USER_CHANGE_PERMISSIONS' if SecureAuthIdPAuthGuiMode == 0 and auth_result ==WS-Trust success., 'USER_LOGOUT' if SecureAuthIdPAuthGuiMode == 0 and auth_result == Session Aborted, 'NETWORK_CONNECTION' if UserHostAddress != and `HostName` !=, 'STATUS_UPDATE' if ip != or `HostName` !=, 'USER_UNCATEGORIZED' if UserHostAddress != and `HostName` == and UserID != ``, otherwise - 'GENERIC_EVENT' |
|
| read_only_udm.metadata.log_type | Hardcoded value - 'SECUREAUTH_SSO' | |
| read_only_udm.metadata.product_name | Hardcoded value - 'SECUREAUTH_SSO' | |
| read_only_udm.metadata.vendor_name | Hardcoded value - 'SECUREAUTH_SSO' | |
| read_only_udm.target.user.email_addresses | Value of user_email field when not_email is false |
|
| security_result.severity | 'HIGH' if cn1Label == Priority and cn1 == 1, 'MEDIUM' if cn1Label == Priority and cn1 == 2, 'LOW' if cn1Label == Priority and cn1 in [3, 4], 'HIGH' if Priority == 1, 'MEDIUM' if Priority == 2, 'LOW' if Priority in [3, 4] |
Need more help? Get answers from Community members and Google SecOps professionals.