Aqua Security (Server)
Aqua Security (Server) is an on-premises container security tool that provides workload protection and security for containers, Kubernetes, and serverless applications. You can bring container, host, and security data from Aqua into Brinqa to construct a unified view of your attack surface, thus strengthening your cybersecurity posture.
This document details the information you must provide for the connector to authenticate with Aqua Server and how to obtain that information from Aqua. See create a data integration for step-by-step instructions on setting up the integration.
The Aqua Server connector differs from the Aqua SaaS connector only in its authentication method. Instead of an API key and API secret, the Aqua Server connector uses a username and password. The underlying APIs, data retrieved, operation options, and data mappings remain the same as the Aqua SaaS connector.
Required connection settings
When setting up a data integration, select Aqua Server from the Connector drop-down. If you cannot find the connector in the drop-down, make sure you have installed it first. You must provide the following information to authenticate Aqua with Brinqa:
-
Server URL: The API Server URL. The default URL format is
http://<server_name>.net:8080. -
Username and Password: The username and password associated with the Aqua user, which must have permissions to log in to the API server and return data.
Aqua role and permissionsThe Auditor role is a read-only role and is considered to be the minimum role needed to read and retrieve data from the Aqua API. For additional information, see Aqua Platform documentation on creating users and roles and permissions.
Additional settings
The Aqua Server connector contains additional options for specific configuration:
-
Page size: The maximum number of records to get per API request. The default setting is 100. It is not recommended to go over 100.
-
Parallel requests: The maximum number of parallel API requests. The default setting is 4.
-
Skip certificate verification: Select this option to allow for untrusted certificates.
Types of data to retrieve
The Aqua Server connector can retrieve the following types of data from the Aqua API:
Table 1: Data retrieved from Aqua
| Connector Object | Required | Maps to Data Model |
|---|---|---|
| Container | Yes | Container |
| Container Image | Yes | Container Image |
| Host | Yes | Host |
| Vulnerability | Yes | Vulnerability |
| Vulnerability Definition | Yes | Vulnerability Definition |
For detailed steps on how to view the data retrieved from Aqua in the Brinqa Platform, see How to view your data.
Data lifecycle management (DLM) strategy
The following table details the DLM strategy for the Aqua SaaS connector:
Table 2: Aqua Server DLM strategy
| Connector Object | Inactivity Condition | Purge Policy | Summary |
|---|---|---|---|
| Container | LAST_SEEN NOT IN LAST 7 DAYS | 30 days after inactivity | Uses the LAST_SEEN attribute to identify containers that are inactive within the last 7 days, and then purges the records after 30 days of inactivity. |
| Container Image | LAST_SEEN NOT IN LAST 7 DAYS | 30 days after inactivity | Uses the LAST_SEEN attribute to identify container images that are inactive within the last 7 days, and then purges the records after 30 days of inactivity. |
| Host | LAST_SEEN NOT IN LAST 7 DAYS | 30 days after inactivity | Uses the LAST_SEEN attribute to identify hosts that are inactive within the last 7 days, and then purges the records after 30 days of inactivity. |
| Vulnerability | LAST_CAPTURED NOT IN LAST 7 DAYS | 30 days after inactivity | Uses the LAST_CAPTURED attribute to identify vulnerabilities that are inactive within the last 7 days, and then purges the records after 30 days of inactivity. |
Operation options
The Aqua Server connector supports the following operation options. See connector operation options for information about how to apply them.
Table 3: Aqua connector operation options
| Connector Object | Option | All Possible values | Description | Example |
|---|---|---|---|---|
| Container | name | Any container name | Retrieves only containers with the specified name. | Key: name Value: kubernetes. This key and value combination only retrieves containers named kubernetes. |
| registry | Any container registry | Retrieves only containers from the specified registry. | Key: registry Value: docker. This key and value combination only retrieves containers from the docker registry. | |
| repository | Any container repository | Retrieves only containers from the specified repository. | Key: repository Value: angular-spring. This key and value combination only retrieves containers form the angular-spring repository. | |
| Container Image | name | Any container image name | Retrieves only container images with the specified name. | Key: name Value: alpine/openssl:latest. This key and value combination only retrieves container images named alpine/openssl:latest. |
| registry | Any container image registry | Retrieves only container images from the specified registry. | Key: registry Value: docker hub. This key and value combination only retrieves container images from the docker hub registry. | |
| repository | Any container image repository | Retrieves only container images from the specified repository. | Key: repository Value: angular-spring. The key and value combination only retrieves container images from the angular-spring repository. | |
| Host | name | Any host name | Retrieves only hosts with the specified name. | Key: name Value: webserver01. This key and value combination only retrieves hosts names webserver01. |
| registry | Any host registry | Retrieves only hosts from the specified registry. | Key registry Value: docker. This key and value combination only retrieves hosts from the docker registry. | |
| repository | Any host repository | Retrieves only hosts from the specified repository. | Key: repository Value: alpine/openssl. This key and value combination only retrieves hosts from the alpine/openssl repository. | |
| Vulnerability | include_vpatch_info | 1 | Retrieves suppressed findings from Aqua. | Key: include_vpatch_info Value: 1. This key and value combination retrieves suppressed findings from Aqua. |
| name | Any container image name | Retrieves only vulnerabilities from the specified container image name. | Key: name Value: docker.io. This key and value combination only retrieves vulnerabilities associated with docker.io container image. | |
| registry | Any container image registry | Retrieves only vulnerabilities from the specified container image registry. | Key: registry Value: harbor. This key and value combination only retrieves vulnerabilities from the harbor container image registry. | |
| repository | Any container image repository. | Retrieves only vulnerabilities from the specified container image repository. | Key: repository Value: alpine. This key and value combination only retrieves vulnerabilities from the alpine container image repository. |
The option keys and values are case-sensitive as they are shown in this documentation.
APIs
The Aqua Server connector uses the Aqua Enterprise API v2. Specifically, it uses the following endpoints:
Table 4: Aqua API Endpoints
| Connector Object | API Endpoints |
|---|---|
| Container | GET /api/v2/containers |
| Container Image | GET /api/v2/images/names |
GET /api/v2/images/ | |
| Host | GET /api/v2/infrastructure |
| Vulnerability | GET /api/v2/risks/vulnerabilities/exporters/jobs |
GET /api/v2/risks/vulnerabilities/exports/export | |
GET /api/v2/risks/vulnerabilities/exporters/stream | |
| Vulnerability Definition | GET /api/v2/risks/vulnerabilities/exporters/jobs |
GET /api/v2/risks/vulnerabilities/exports/export | |
GET /api/v2/risks/vulnerabilities/exporters/stream |
Changelog
The Aqua Server connector has undergone the following changes:
Table 5: Aqua Server connector changelog
| Version | Description |
|---|---|
| 4.0.2 | Enhanced the connector to retrieve suppressed findings from Aqua. As a result, the following operation option has been added to the Vulnerability object: include_vpatch_info |
| 4.0.1 | Added the HAS_RUNNING_WORKLOADS and RUNNING_WORKLOADS_COUNT attributes to the Vulnerability object. |
| 4.0.0 | Transitioned the Aqua Server connector to fully use the Aqua Enterprise API v2 to enhance performance and reliability. |
| 3.1.3 | Added support for Data lifecycle management to the Container, Container Image, Host, and Vulnerability objects. |
| 3.1.2 | Fixed an issue where the Vulnerability Definition object sync was failing. |
| 3.1.1 | No change. |
| 3.1.0 | No change. |
| 3.0.3 | Fixed an issue where Container Images were not correctly parsing Docker labels, preventing these labels from being added to the tags. |
| 3.0.2 | Added two new attributes, EXPLOITABILITY and EXPLOIT_TYPE, to the Vulnerability Definition object. |
| 3.0.0 | Initial Integration+ release. |