Zero Networks Integration
editZero Networks Integration
editVersion |
1.16.0 (View all) |
Compatible Kibana version(s) |
8.13.0 or higher |
Supported Serverless project types |
Security |
Subscription level |
Basic |
Level of support |
Partner |
Zero Networks is used by numerous orgazations to microsegment the network and apply MFA anywhere.
The Zero Networks integration uses Zero Networks' API to retrieve audit events and ingest them into Elasticsearch. This allows you to search, observe, and visualize the Zero Networks audit events through Elasticsearch.
The Elastic agent running this integration interacts with Zero Networks' infrastructure using their APIs to retrieve audit logs for an environment.
Data streams
editThe Zero Networks integration collects one type of data streams: logs.
Logs help you keep a record of events happening in Zero Networks. Log data streams collected by the Zero Networks integration include Audit events.
Requirements
editYou need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
Other requirements including:
- Zero Networks API Token with Read access
Setup
editFor step-by-step instructions on how to set up an integration, see the Getting started guide.
Get an API Token
edit- Log into the Zero Networks portal.
- Click Setting.
- Click API under Integrations.
- Click Add new token.
- Enter a Token Name such as Elastic Integration. Set the Expiry to 36 Months. Click Add.
- Copy the generated token for later use.
Enabling the integration in Elastic
edit- In Kibana go to Management > Integrations.
- In the "Search for integrations" search bar type Zero Networks.
- Click on "Zero Networks" integration from the search results.
- Click on Add Zero Networks button to add the Zero Networks integration.
Configure Zero Networks Audit logs data stream
editEnter values "API Token".
- API Token copied from earlier steps.
Some operating systems may not have the root CA installed. You can download the USERTrust RSA Certification Authority and install it. As a work around, not recommended, you can set verification_mode: none in the SSL box under Settings by clicking Advanced Options.
Logs reference
editAudt
editThe Audit
data stream provides events from Zero Networks of the following types: audit.
Example
An example event for audit
looks as following:
{ 	"@timestamp": [ 	 "2023-03-22T14:57:23.356Z" 	], 	"agent.ephemeral_id": [ 	 "01887fa8-409b-44a1-aa70-fa9cc4f2fd90" 	], 	"agent.id": [ 	 "55518990-e6d4-4350-b447-88837a15d1d2" 	], 	"agent.name": [ 	 "docker-fleet-agent" 	], 	"agent.type": [ 	 "filebeat" 	], 	"agent.version": [ 	 "8.6.2" 	], 	"data_stream.dataset": [ 	 "zeronetworks.audit" 	], 	"data_stream.namespace": [ 	 "default" 	], 	"data_stream.type": [ 	 "logs" 	], 	"ecs.version": [ 	 "8.0.0" 	], 	"elastic_agent.id": [ 	 "55518990-e6d4-4350-b447-88837a15d1d2" 	], 	"elastic_agent.snapshot": [ 	 false 	], 	"elastic_agent.version": [ 	 "8.6.2" 	], 	"event.action": [ 	 "API Token created" 	], 	"event.agent_id_status": [ 	 "verified" 	], 	"event.category": [ 	 "configuration" 	], 	"event.code": [ 	 "25" 	], 	"event.created": [ 	 "2023-03-24T14:45:14.459Z" 	], 	"event.dataset": [ 	 "zeronetworks.audit" 	], 	"event.id": [ 	 "+Ipxg6VvICbeFz5QoqS1i3GZETE=" 	], 	"event.ingested": [ 	 "2023-03-24T14:45:15.000Z" 	], 	"event.kind": [ 	 "event" 	], 	"event.module": [ 	 "zeronetworks" 	], 	"event.original": [ 	 "{\"auditType\":25,\"destinationEntitiesList\":[{\"id\":\"m:6454ff4dd25ebda5279fd4823e5e1d026e2ae996\",\"name\":\"elastic\"}],\"details\":\"{\\\"name\\\":\\\"elastic\\\",\\\"clientId\\\":\\\"m:6454ff4dd25ebda5279fd4823e5e1d026e2ae996\\\",\\\"expiry\\\":\\\"2025-03-22T14:57:23.000Z\\\",\\\"issuedAt\\\":\\\"2023-03-22T14:57:23.000Z\\\",\\\"scope\\\":5,\\\"audience\\\":\\\"portal.zeronetworks.com\\\",\\\"issuer\\\":\\\"zeronetworks.com/api/v1/access-token\\\",\\\"type\\\":\\\"JWT\\\"}\",\"enforcementSource\":4,\"isoTimestamp\":\"2023-03-22T14:57:23.356Z\",\"parentObjectId\":\"\",\"performedBy\":{\"id\":\"39cc28f6-7bba-4310-95e6-a7e7189a3ed5\",\"name\":\"Nicholas DiCola\"},\"reportedObjectId\":\"m:6454ff4dd25ebda5279fd4823e5e1d026e2ae996\",\"timestamp\":1679497043356,\"userRole\":1}" 	], 	"event.outcome": [ 	 "success" 	], 	"event.type": [ 	 "info" 	], 	"input.type": [ 	 "httpjson" 	], 	"related.user": [ 	 "39cc28f6-7bba-4310-95e6-a7e7189a3ed5", 	 "Nicholas DiCola" 	], 	"tags": [ 	 "forwarded", 	 "zeronetworks-audit", 	 "preserve_original_event" 	], 	"user.full_name": [ 	 "Nicholas DiCola" 	], 	"user.id": [ 	 "39cc28f6-7bba-4310-95e6-a7e7189a3ed5" 	], 	"zeronetworks.audit.destinationEntitiesList.id": [ 	 "m:6454ff4dd25ebda5279fd4823e5e1d026e2ae996" 	], 	"zeronetworks.audit.destinationEntitiesList.name": [ 	 "elastic" 	], 	"zeronetworks.audit.details.audience": [ 	 "portal.zeronetworks.com" 	], 	"zeronetworks.audit.details.clientId": [ 	 "m:6454ff4dd25ebda5279fd4823e5e1d026e2ae996" 	], 	"zeronetworks.audit.details.expiry": [ 	 "2025-03-22T14:57:23.000Z" 	], 	"zeronetworks.audit.details.issuedAt": [ 	 "2023-03-22T14:57:23.000Z" 	], 	"zeronetworks.audit.details.issuer": [ 	 "zeronetworks.com/api/v1/access-token" 	], 	"zeronetworks.audit.details.name": [ 	 "elastic" 	], 	"zeronetworks.audit.details.scope": [ 	 5 	], 	"zeronetworks.audit.details.type": [ 	 "JWT" 	], 	"zeronetworks.audit.enforcementSource": [ 	 4 	], 	"zeronetworks.audit.reportedObjectId": [ 	 "m:6454ff4dd25ebda5279fd4823e5e1d026e2ae996" 	], 	"zeronetworks.audit.userRole": [ 	 1 	] }
Exported fields
editField | Description | Type |
---|---|---|
@timestamp |
Event timestamp. |
date |
cloud.account.id |
The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. |
keyword |
cloud.availability_zone |
Availability zone in which this host, resource, or service is located. |
keyword |
cloud.instance.id |
Instance ID of the host machine. |
keyword |
cloud.instance.name |
Instance name of the host machine. |
keyword |
cloud.machine.type |
Machine type of the host machine. |
keyword |
cloud.project.id |
The cloud project identifier. Examples: Google Cloud Project id, Azure Project id. |
keyword |
cloud.provider |
Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. |
keyword |
cloud.region |
Region in which this host, resource, or service is located. |
keyword |
container.id |
Unique container id. |
keyword |
container.image.name |
Name of the image the container was built on. |
keyword |
container.labels |
Image labels. |
object |
container.name |
Container name. |
keyword |
data_stream.dataset |
Data stream dataset name. |
constant_keyword |
data_stream.namespace |
Data stream namespace. |
constant_keyword |
data_stream.type |
Data stream type. |
constant_keyword |
ecs.version |
ECS version this event conforms to. |
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 |
keyword |
event.code |
The audity type captured by the event |
integer |
event.category |
This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. |
keyword |
event.created |
Event creation time |
date |
event.dataset |
Event dataset |
constant_keyword |
event.id |
Unique ID to describe the event. |
keyword |
event.ingested |
Timestamp when an event arrived in the central data store. This is different from |
date |
event.kind |
This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. |
keyword |
event.module |
Event module |
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 |
keyword |
event.outcome |
This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy. |
keyword |
event.type |
This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. |
keyword |
host.architecture |
Operating system architecture. |
keyword |
host.containerized |
If the host is a container. |
boolean |
host.domain |
Name of the domain of which the host is a member. For example, on Windows this could be the host’s Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host’s LDAP provider. |
keyword |
host.hostname |
Hostname of the host. It normally contains what the |
keyword |
host.id |
Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of |
keyword |
host.ip |
Host ip addresses. |
ip |
host.mac |
Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. |
keyword |
host.name |
Name of the host. It can contain what |
keyword |
host.os.build |
OS build information. |
keyword |
host.os.codename |
OS codename, if any. |
keyword |
host.os.family |
OS family (such as redhat, debian, freebsd, windows). |
keyword |
host.os.kernel |
Operating system kernel version as a raw string. |
keyword |
host.os.name |
Operating system name, without the version. |
keyword |
host.os.platform |
Operating system platform (such centos, ubuntu, windows). |
keyword |
host.os.version |
Operating system version as a raw string. |
keyword |
host.type |
Type of host. For Cloud providers this can be the machine type like |
keyword |
input.type |
Type of Filebeat input. |
keyword |
related.user |
All the user names or other user identifiers seen on the event. |
keyword |
zeronetworks.audit.destinationEntitiesList.id |
The |
keyword |
zeronetworks.audit.destinationEntitiesList.name |
The |
keyword |
zeronetworks.audit.details.* |
Various fields for properties of the audit |
keyword |
zeronetworks.audit.enforcementsource |
The |
integer |
zeronetworks.audit.userrole |
The |
integer |
zeronetworks.audit.userrolename |
The |
keyword |
tags |
List of keywords used to tag each event. |
keyword |
user.full_name |
User’s full name, if available. |
keyword |
user.id |
Unique identifier of the user. |
keyword |
Changelog
editChangelog
Version | Details | Kibana version(s) |
---|---|---|
1.16.0 |
Enhancement (View pull request) |
— |
1.15.1 |
Bug fix (View pull request) |
8.13.0 or higher |
1.15.0 |
Enhancement (View pull request) |
8.13.0 or higher |
1.14.0 |
Enhancement (View pull request) |
8.12.0 or higher |
1.13.0 |
Enhancement (View pull request) |
8.12.0 or higher |
1.12.0 |
Enhancement (View pull request) |
8.12.0 or higher |
1.11.1 |
Enhancement (View pull request) |
8.6.2 or higher |
1.11.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.10.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.9.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.8.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.7.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.6.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.5.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.4.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.3.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.2.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.1.0 |
Enhancement (View pull request) |
8.6.2 or higher |
1.0.0 |
Enhancement (View pull request) |
8.6.2 or higher |
0.4.0 |
Enhancement (View pull request) |
— |
0.3.0 |
Enhancement (View pull request) |
— |
0.2.1 |
Bug fix (View pull request) |
— |
0.2.0 |
Enhancement (View pull request) |
— |
0.1.0 |
Enhancement (View pull request) |
— |