Collect logs from CyberArk Privileged Access Security with Elastic Agent.
What is an Elastic integration?
This integration is powered by Elastic Agent. Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to our documentation for a detailed comparison between Beats and Elastic Agent.
Prefer to use Beats for this use case? See Filebeat modules for logs or Metricbeat modules for metrics.
See the integrations quick start guides to get started:
The CyberArk Privileged Access Security integration collects audit logs from CyberArk's Vault server.
The audit dataset receives Vault Audit logs for User and Safe activities over the syslog protocol.
Follow the steps under Security Information and Event Management (SIEM) Applications documentation to setup the integration:
Copy the elastic-json-v1.0.xsl XSL Translator file to
the Server\Syslog folder.
Sample syslog configuration for DBPARM.ini:
[SYSLOG]
UseLegacySyslogFormat=No
SyslogTranslatorFile=Syslog\elastic-json-v1.0.xsl
SyslogServerIP=<INSERT FILEBEAT IP HERE>
SyslogServerPort=<INSERT FILEBEAT PORT HERE>
SyslogServerProtocol=TCPFor proper timestamping of events, it's recommended to use the newer RFC5424 Syslog format
(UseLegacySyslogFormat=No). To avoid event loss, use TCP or TLS protocols instead of UDP.
An example event for audit looks as following:
{
"@timestamp": "2021-03-08T18:07:51.000Z",
"agent": {
"ephemeral_id": "0c6c824f-931a-418f-9535-22af6210c402",
"id": "584f3aea-648c-4e58-aba4-32b8f88d4396",
"name": "docker-fleet-agent",
"type": "filebeat",
"version": "8.0.0-beta1"
},
"cyberarkpas": {
"audit": {
"action": "Full Gateway Connection",
"desc": "Full Gateway Connection",
"gateway_station": "10.0.1.20",
"iso_timestamp": "2021-03-08T18:07:51Z",
"issuer": "Administrator",
"message": "Full Gateway Connection",
"rfc5424": true,
"severity": "Info",
"source_user": "PVWAGWUser",
"station": "127.0.0.1",
"timestamp": "Mar 08 10:07:51"
}
},
"data_stream": {
"dataset": "cyberarkpas.audit",
"namespace": "ep",
"type": "logs"
},
"destination": {
"address": "10.0.1.20",
"ip": "10.0.1.20",
"user": {
"name": "Administrator"
}
},
"ecs": {
"version": "8.7.0"
},
"elastic_agent": {
"id": "584f3aea-648c-4e58-aba4-32b8f88d4396",
"snapshot": false,
"version": "8.0.0-beta1"
},
"event": {
"action": "full gateway connection",
"agent_id_status": "verified",
"category": [
"network"
],
"code": "19",
"dataset": "cyberarkpas.audit",
"ingested": "2022-02-03T12:51:00Z",
"kind": "event",
"outcome": "success",
"severity": 2,
"timezone": "+00:00",
"type": [
"start"
]
},
"host": {
"name": "VAULT"
},
"input": {
"type": "udp"
},
"log": {
"source": {
"address": "172.19.0.7:35950"
},
"syslog": {
"priority": 5
}
},
"network": {
"direction": "internal"
},
"observer": {
"hostname": "VAULT",
"product": "Vault",
"vendor": "Cyber-Ark",
"version": "11.7.0000"
},
"related": {
"ip": [
"127.0.0.1",
"10.0.1.20"
],
"user": [
"PVWAGWUser",
"Administrator"
]
},
"source": {
"address": "127.0.0.1",
"ip": "127.0.0.1",
"user": {
"name": "PVWAGWUser"
}
},
"tags": [
"cyberarkpas-audit",
"forwarded"
],
"user": {
"name": "PVWAGWUser"
}
}Exported fields
Exported fields
| Field | Description | Type |
|---|---|---|
@timestamp | Event timestamp. | date |
cyberarkpas.audit.action | A description of the audit record. | keyword |
cyberarkpas.audit.ca_properties.address | keyword | |
cyberarkpas.audit.ca_properties.cpm_disabled | keyword | |
cyberarkpas.audit.ca_properties.cpm_error_details | keyword | |
cyberarkpas.audit.ca_properties.cpm_status | keyword | |
cyberarkpas.audit.ca_properties.creation_method | keyword | |
cyberarkpas.audit.ca_properties.customer | keyword | |
cyberarkpas.audit.ca_properties.database | keyword | |
cyberarkpas.audit.ca_properties.device_type | keyword | |
cyberarkpas.audit.ca_properties.dual_account_status | keyword | |
cyberarkpas.audit.ca_properties.group_name | keyword | |
cyberarkpas.audit.ca_properties.in_process | keyword | |
cyberarkpas.audit.ca_properties.index | keyword | |
cyberarkpas.audit.ca_properties.last_fail_date | keyword | |
cyberarkpas.audit.ca_properties.last_success_change | keyword | |
cyberarkpas.audit.ca_properties.last_success_reconciliation | keyword | |
cyberarkpas.audit.ca_properties.last_success_verification | keyword | |
cyberarkpas.audit.ca_properties.last_task | keyword | |
cyberarkpas.audit.ca_properties.logon_domain | keyword | |
cyberarkpas.audit.ca_properties.other | flattened | |
cyberarkpas.audit.ca_properties.policy_id | keyword | |
cyberarkpas.audit.ca_properties.port | keyword | |
cyberarkpas.audit.ca_properties.privcloud | keyword | |
cyberarkpas.audit.ca_properties.reset_immediately | keyword | |
cyberarkpas.audit.ca_properties.retries_count | keyword | |
cyberarkpas.audit.ca_properties.sequence_id | keyword | |
cyberarkpas.audit.ca_properties.tags | keyword | |
cyberarkpas.audit.ca_properties.user_dn | keyword | |
cyberarkpas.audit.ca_properties.user_name | keyword | |
cyberarkpas.audit.ca_properties.virtual_username | keyword | |
cyberarkpas.audit.category | The category name (for category-related operations). | keyword |
cyberarkpas.audit.desc | A static value that displays a description of the audit codes. | keyword |
cyberarkpas.audit.extra_details.ad_process_id | keyword | |
cyberarkpas.audit.extra_details.ad_process_name | keyword | |
cyberarkpas.audit.extra_details.application_type | keyword | |
cyberarkpas.audit.extra_details.command | keyword | |
cyberarkpas.audit.extra_details.connection_component_id | keyword | |
cyberarkpas.audit.extra_details.dst_host | keyword | |
cyberarkpas.audit.extra_details.logon_account | keyword | |
cyberarkpas.audit.extra_details.managed_account | keyword | |
cyberarkpas.audit.extra_details.other | flattened | |
cyberarkpas.audit.extra_details.process_id | keyword | |
cyberarkpas.audit.extra_details.process_name | keyword | |
cyberarkpas.audit.extra_details.protocol | keyword | |
cyberarkpas.audit.extra_details.psmid | keyword | |
cyberarkpas.audit.extra_details.session_duration | keyword | |
cyberarkpas.audit.extra_details.session_id | keyword | |
cyberarkpas.audit.extra_details.src_host | keyword | |
cyberarkpas.audit.extra_details.username | keyword | |
cyberarkpas.audit.file | The name of the target file. | keyword |
cyberarkpas.audit.gateway_station | The IP of the web application machine (PVWA). | ip |
cyberarkpas.audit.hostname | The hostname, in upper case. | keyword |
cyberarkpas.audit.iso_timestamp | The timestamp, in ISO Timestamp format (RFC 3339). | date |
cyberarkpas.audit.issuer | The Vault user who wrote the audit. This is usually the user who performed the operation. | keyword |
cyberarkpas.audit.location | The target Location (for Location operations). | keyword |
cyberarkpas.audit.message | A description of the audit records (same information as in the Desc field). | keyword |
cyberarkpas.audit.message_id | The code ID of the audit records. | keyword |
cyberarkpas.audit.product | A static value that represents the product. | keyword |
cyberarkpas.audit.pvwa_details | Specific details of the PVWA audit records. | flattened |
cyberarkpas.audit.raw | Raw XML for the original audit record. Only present when XSLT file has debugging enabled. | keyword |
cyberarkpas.audit.reason | The reason entered by the user. | text |
cyberarkpas.audit.rfc5424 | Whether the syslog format complies with RFC5424. | boolean |
cyberarkpas.audit.safe | The name of the target Safe. | keyword |
cyberarkpas.audit.severity | The severity of the audit records. | keyword |
cyberarkpas.audit.source_user | The name of the Vault user who performed the operation. | keyword |
cyberarkpas.audit.station | The IP from where the operation was performed. For PVWA sessions, this will be the real client machine IP. | ip |
cyberarkpas.audit.target_user | The name of the Vault user on which the operation was performed. | keyword |
cyberarkpas.audit.timestamp | The timestamp, in MMM DD HH:MM:SS format. | keyword |
cyberarkpas.audit.vendor | A static value that represents the vendor. | keyword |
cyberarkpas.audit.version | A static value that represents the version of the Vault. | keyword |
data_stream.dataset | Data stream dataset. | constant_keyword |
data_stream.namespace | Data stream namespace. | constant_keyword |
data_stream.type | Data stream type. | constant_keyword |
destination.address | Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the .address field. Then it should be duplicated to .ip or .domain, depending on which one it is. | keyword |
destination.as.number | Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. | long |
destination.as.organization.name | Organization name. | keyword |
destination.as.organization.name.text | Multi-field of destination.as.organization.name. | match_only_text |
destination.domain | The domain name of the destination system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. | keyword |
destination.geo.city_name | City name. | keyword |
destination.geo.continent_name | Name of the continent. | keyword |
destination.geo.country_iso_code | Country ISO code. | keyword |
destination.geo.country_name | Country name. | keyword |
destination.geo.location | Longitude and latitude. | geo_point |
destination.geo.region_iso_code | Region ISO code. | keyword |
destination.geo.region_name | Region name. | keyword |
destination.ip | IP address of the destination (IPv4 or IPv6). | ip |
destination.user.name | Short name or login of the user. | keyword |
destination.user.name.text | Multi-field of destination.user.name. | match_only_text |
ecs.version | ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword |
error.message | Error message. | match_only_text |
event.action | The action captured by the event. This describes the information in the event. It is more specific than event.category. Examples are group-add, process-started, file-created. The value is normally defined by the implementer. | keyword |
event.category | This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. event.category represents the "big buckets" of ECS categories. For example, filtering on event.category:process yields all events relating to process activity. This field is closely related to event.type, which is used as a subcategory. This field is an array. This will allow proper categorization of some events that fall in multiple categories. | keyword |
event.code | Identification code for this event, if one exists. Some event sources use event codes to identify messages unambiguously, regardless of message language or wording adjustments over time. An example of this is the Windows Event ID. | keyword |
event.dataset | Event dataset | constant_keyword |
event.duration | Duration of the event in nanoseconds. If event.start and event.end are known this value should be the difference between the end and start time. | long |
event.ingested | Timestamp when an event arrived in the central data store. This is different from @timestamp, which is when the event originally occurred. It's also different from event.created, which is meant to capture the first time an agent saw the event. In normal conditions, assuming no tampering, the timestamps should chronologically look like this: @timestamp < event.created < event.ingested. | date |
event.kind | This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. event.kind gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not. | keyword |
event.module | Name of the module this data is coming from. | constant_keyword |
event.original | Raw text message of entire event. Used to demonstrate log integrity or where the full log message (before splitting it up in multiple parts) may be required, e.g. for reindex. This field is not indexed and doc_values are disabled. It cannot be searched, but it can be retrieved from _source. If users wish to override this and index this field, please see Field data types in the Elasticsearch Reference. | keyword |
event.outcome | This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy. event.outcome simply denotes whether the event represents a success or a failure from the perspective of the entity that produced the event. Note that when a single transaction is described in multiple events, each event may populate different values of event.outcome, according to their perspective. Also note that in the case of a compound event (a single event that contains multiple logical events), this field should be populated with the value that best captures the overall success or failure from the perspective of the event producer. Further note that not all events will have an associated outcome. For example, this field is generally not populated for metric events, events with event.type:info, or any events for which an outcome does not make logical sense. | keyword |
event.reason | Reason why this event happened, according to the source. This describes the why of a particular action or outcome captured in the event. Where event.action captures the action from the event, event.reason describes why that action was taken. For example, a web proxy with an event.action which denied the request may also populate event.reason with the reason why (e.g. blocked site). | keyword |
event.severity | The numeric severity of the event according to your event source. What the different severity values mean can be different between sources and use cases. It's up to the implementer to make sure severities are consistent across events from the same source. The Syslog severity belongs in log.syslog.severity.code. event.severity is meant to represent the severity according to the event source (e.g. firewall, IDS). If the event source does not publish its own severity, you may optionally copy the log.syslog.severity.code to event.severity. | long |
event.timezone | This field should be populated when the event's timestamp does not include timezone information already (e.g. default Syslog timestamps). It's optional otherwise. Acceptable timezone formats are: a canonical ID (e.g. "Europe/Amsterdam"), abbreviated (e.g. "EST") or an HH:mm differential (e.g. "-05:00"). | keyword |
event.type | This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. event.type represents a categorization "sub-bucket" that, when used along with the event.category field values, enables filtering events down to a level appropriate for single visualization. This field is an array. This will allow proper categorization of some events that fall in multiple event types. | keyword |
file.path | Full path to the file, including the file name. It should include the drive letter, when appropriate. | keyword |
file.path.text | Multi-field of file.path. | match_only_text |
host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword |
input.type | Type of Filebeat input. | keyword |
log.file.path | Path to the log file. | keyword |
log.flags | Flags for the log file. | keyword |
log.offset | Offset of the entry in the log file. | long |
log.source.address | Source address from which the log event was read / sent from. | keyword |
log.syslog.priority | Syslog numeric priority of the event, if available. According to RFCs 5424 and 3164, the priority is 8 * facility + severity. This number is therefore expected to contain a value between 0 and 191. | long |
network.application | When a specific application or service is identified from network connection details (source/dest IPs, ports, certificates, or wire format), this field captures the application's or service's name. For example, the original event identifies the network connection being from a specific web service in a https network connection, like facebook or twitter. The field value must be normalized to lowercase for querying. | keyword |
network.direction | Direction of the network traffic. When mapping events from a host-based monitoring context, populate this field from the host's point of view, using the values "ingress" or "egress". When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of the network perimeter, using the values "inbound", "outbound", "internal" or "external". Note that "internal" is not crossing perimeter boundaries, and is meant to describe communication between two hosts within the perimeter. Note also that "external" is meant to describe traffic between two hosts that are external to the perimeter. This could for example be useful for ISPs or VPN service providers. | keyword |
observer.hostname | Hostname of the observer. | keyword |
observer.product | The product name of the observer. | keyword |
observer.type | The type of the observer the data is coming from. There is no predefined list of observer types. Some examples are forwarder, firewall, ids, ips, proxy, poller, sensor, APM server. | keyword |
observer.vendor | Vendor name of the observer. | keyword |
observer.version | Observer version. | keyword |
process.name | Process name. Sometimes called program name or similar. | keyword |
process.name.text | Multi-field of process.name. | match_only_text |
process.pid | Process id. | long |
related.ip | All of the IPs seen on your event. | ip |
related.user | All the user names or other user identifiers seen on the event. | keyword |
service.type | The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch. | keyword |
source.address | Some event source addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the .address field. Then it should be duplicated to .ip or .domain, depending on which one it is. | keyword |
source.as.number | Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. | long |
source.as.organization.name | Organization name. | keyword |
source.as.organization.name.text | Multi-field of source.as.organization.name. | match_only_text |
source.geo.city_name | City name. | keyword |
source.geo.continent_name | Name of the continent. | keyword |
source.geo.country_iso_code | Country ISO code. | keyword |
source.geo.country_name | Country name. | keyword |
source.geo.location | Longitude and latitude. | geo_point |
source.geo.region_iso_code | Region ISO code. | keyword |
source.geo.region_name | Region name. | keyword |
source.ip | IP address of the source (IPv4 or IPv6). | ip |
source.user.name | Short name or login of the user. | keyword |
source.user.name.text | Multi-field of source.user.name. | match_only_text |
tags | List of keywords used to tag each event. | keyword |
user.name | Short name or login of the user. | keyword |
user.name.text | Multi-field of user.name. | match_only_text |
user.target.name | Short name or login of the user. | keyword |
user.target.name.text | Multi-field of user.target.name. | match_only_text |
| Version | Details |
|---|---|
2.10.0 | Enhancement View pull request Update package to ECS 8.7.0. |
2.9.1 | Enhancement View pull request Added categories and/or subcategories. |
2.9.0 | Enhancement View pull request Update package to ECS 8.6.0. |
2.8.0 | Enhancement View pull request Add udp_options to the UDP input. |
2.7.0 | Enhancement View pull request Update package to ECS 8.5.0. |
2.6.2 | Bug fix View pull request Remove duplicate field. |
2.6.1 | Enhancement View pull request Use ECS geo.location definition. |
2.6.0 | Enhancement View pull request Update package to ECS 8.4.0 |
2.5.1 | Enhancement View pull request Update package name and description to align with standard wording |
2.5.0 | Enhancement View pull request Update package to ECS 8.3.0. |
2.4.2 | Bug fix View pull request Fix broken file paths configuration variable |
2.4.1 | Enhancement View pull request Update to readme. added link to vendor documentation |
2.4.0 | Enhancement View pull request Update to ECS 8.2 |
2.3.2 | Bug fix View pull request Fix error ingesting events with a single entry in the CAProperties field |
2.3.1 | Enhancement View pull request Add documentation for multi-fields Bug fix View pull request Remove duplicated definition of event.dataset field. |
2.3.0 | Enhancement View pull request Update to ECS 8.0 |
2.2.2 | Bug fix View pull request Regenerate test files using the new GeoIP database |
2.2.1 | Bug fix View pull request Change test public IPs to the supported subset |
2.2.0 | Enhancement View pull request Add 8.0.0 version constraint |
2.1.4 | Enhancement View pull request Uniform with guidelines |
2.1.3 | Enhancement View pull request Remove dash from title for consistency with brand. |
2.1.2 | Enhancement View pull request Update Title and Description. |
2.1.1 | Bug fix View pull request Fix logic that checks for the 'forwarded' tag |
2.1.0 | Enhancement View pull request Update to ECS 1.12.0 |
2.0.0 | Enhancement View pull request make GA |
1.2.3 | Enhancement View pull request Convert to generated ECS fields |
1.2.2 | Enhancement View pull request update to ECS 1.11.0 |
1.2.1 | Enhancement View pull request Escape special characters in docs |
1.2.0 | Enhancement View pull request Update integration description |
1.1.0 | Enhancement View pull request Set "event.module" and "event.dataset" |
1.0.1 | Enhancement View pull request updating ECS version and adding event.original options |
1.0.0 | Enhancement View pull request initial release |